diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json new file mode 100644 index 000000000..b0e38abda --- /dev/null +++ b/.config/dotnet-tools.json @@ -0,0 +1,5 @@ +{ + "version": 1, + "isRoot": true, + "tools": {} +} \ No newline at end of file diff --git a/.github/workflows/README.md b/.github/workflows/README.md new file mode 100644 index 000000000..5308df437 --- /dev/null +++ b/.github/workflows/README.md @@ -0,0 +1,79 @@ +## CI/CD Workflows + +The repository uses multiple GitHub Actions workflows. What runs and when: + +### 1) Build Solution (`.github/workflows/build.yml`) + +- **Triggers**: push and pull_request to `v2_release`, `v2_develop` (ignores `**.md`); supports `workflow_call` +- **Runner/timeout**: `ubuntu-latest`, 10 minutes +- **Steps**: +- Checkout and setup .NET 8.x GA +- `dotnet restore` +- Build Debug: `dotnet build --configuration Debug --no-restore -property:NoWarn=0618%3B0612` +- Build Release (library): `dotnet build Terminal.Gui/Terminal.Gui.csproj --configuration Release --no-incremental --force -property:NoWarn=0618%3B0612` +- Pack Release: `dotnet pack Terminal.Gui/Terminal.Gui.csproj --configuration Release --output ./local_packages -property:NoWarn=0618%3B0612` +- Restore NativeAot/SelfContained examples, then restore solution again +- Build Release for `Examples/NativeAot` and `Examples/SelfContained` +- Build Release solution +- Upload artifacts named `build-artifacts`, retention 1 day + +### 2) Build & Run Unit Tests (`.github/workflows/unit-tests.yml`) + +- **Triggers**: push and pull_request to `v2_release`, `v2_develop` (ignores `**.md`) +- **Matrix**: Ubuntu/Windows/macOS +- **Timeout**: 15 minutes per job +- **Process**: +1. Calls build workflow to build solution once +2. Downloads build artifacts +3. Runs `dotnet restore` (required for `--no-build` to work) +4. **Performance optimizations**: + - Disables Windows Defender on Windows runners (significant speedup) + - Collects code coverage **only on Linux** (ubuntu-latest) for performance + - Windows and macOS skip coverage collection to reduce test time + - Increased blame-hang-timeout to 120s for Windows/macOS (60s for Linux) +5. Runs two test jobs: + - **Non-parallel UnitTests**: `Tests/UnitTests` with blame/diag flags; `xunit.stopOnFail=false` + - **Parallel UnitTestsParallelizable**: `Tests/UnitTestsParallelizable` with blame/diag flags; `xunit.stopOnFail=false` +6. Uploads test logs and diagnostic data from all runners +7. **Uploads code coverage to Codecov only from Linux runner** + +**Test results**: All tests output to unified `TestResults/` directory at repository root + +### 3) Build & Run Integration Tests (`.github/workflows/integration-tests.yml`) + +- **Triggers**: push and pull_request to `v2_release`, `v2_develop` (ignores `**.md`) +- **Matrix**: Ubuntu/Windows/macOS +- **Timeout**: 15 minutes +- **Process**: +1. Calls build workflow +2. Downloads build artifacts +3. Runs `dotnet restore` +4. **Performance optimizations** (same as unit tests): + - Disables Windows Defender on Windows runners + - Collects code coverage **only on Linux** + - Increased blame-hang-timeout to 120s for Windows/macOS +5. Runs IntegrationTests with blame/diag flags; `xunit.stopOnFail=true` +6. Uploads logs per-OS +7. **Uploads coverage to Codecov only from Linux runner** + +### 4) Publish to NuGet (`.github/workflows/publish.yml`) + +- **Triggers**: push to `v2_release`, `v2_develop`, and tags `v*`(ignores `**.md`) +- Uses GitVersion to compute SemVer, builds Release, packs with symbols, and pushes to NuGet.org using `NUGET_API_KEY` + +### 5) Build and publish API docs (`.github/workflows/api-docs.yml`) + +- **Triggers**: push to `v1_release` and `v2_develop` +- Builds DocFX site on Windows and deploys to GitHub Pages when `ref_name` is `v2_release` or `v2_develop` + + +### Replicating CI Locally + +```bash +# Full CI sequence: +dotnet restore +dotnet build --configuration Debug --no-restore +dotnet test Tests/UnitTests --no-build --verbosity normal +dotnet test Tests/UnitTestsParallelizable --no-build --verbosity normal +dotnet build --configuration Release --no-restore +``` diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml index 4488bb645..5200800cf 100644 --- a/.github/workflows/unit-tests.yml +++ b/.github/workflows/unit-tests.yml @@ -120,7 +120,7 @@ jobs: matrix: os: [ ubuntu-latest, windows-latest, macos-latest ] - timeout-minutes: 15 + timeout-minutes: 60 steps: - name: Checkout code @@ -154,35 +154,81 @@ jobs: shell: bash run: echo "VSTEST_DUMP_PATH=logs/UnitTestsParallelizable/${{ runner.os }}/" >> $GITHUB_ENV - - name: Run UnitTestsParallelizable + - name: Run UnitTestsParallelizable (10 iterations with varying parallelization) shell: bash run: | - if [ "${{ runner.os }}" == "Linux" ]; then - # Run with coverage on Linux only - dotnet test Tests/UnitTestsParallelizable \ - --no-build \ - --verbosity normal \ - --collect:"XPlat Code Coverage" \ - --settings Tests/UnitTests/runsettings.coverage.xml \ - --diag:logs/UnitTestsParallelizable/${{ runner.os }}/logs.txt \ - --blame \ - --blame-crash \ - --blame-hang \ - --blame-hang-timeout 60s \ - --blame-crash-collect-always - else - # Run without coverage on Windows/macOS for speed - dotnet test Tests/UnitTestsParallelizable \ - --no-build \ - --verbosity normal \ - --settings Tests/UnitTestsParallelizable/runsettings.xml \ - --diag:logs/UnitTestsParallelizable/${{ runner.os }}/logs.txt \ - --blame \ - --blame-crash \ - --blame-hang \ - --blame-hang-timeout 60s \ - --blame-crash-collect-always - fi + # Run tests 3 times with different parallelization settings to expose concurrency issues + for RUN in {1..3}; do + echo "============================================" + echo "Starting test run $RUN of 3" + echo "============================================" + + # Use a combination of run number and timestamp to create different execution patterns + SEED=$((1000 + $RUN + $(date +%s) % 1000)) + echo "Using randomization seed: $SEED" + + # Vary the xUnit parallelization based on run number to expose race conditions + # Runs 1-3: Default parallelization (2x CPU cores) + # Runs 4-6: Max parallelization (unlimited) + # Runs 7-9: Single threaded (1) + # Run 10: Random (1-4 threads) + if [ $RUN -le 3 ]; then + XUNIT_MAX_PARALLEL_THREADS="2x" + echo "Run $RUN: Using default parallelization (2x)" + elif [ $RUN -le 6 ]; then + XUNIT_MAX_PARALLEL_THREADS="unlimited" + echo "Run $RUN: Using maximum parallelization (unlimited)" + elif [ $RUN -le 9 ]; then + XUNIT_MAX_PARALLEL_THREADS="1" + echo "Run $RUN: Using single-threaded execution" + else + # Random parallelization based on seed + PROC_COUNT=$(( ($SEED % 4) + 1 )) + XUNIT_MAX_PARALLEL_THREADS="$PROC_COUNT" + echo "Run $RUN: Using random parallelization with $PROC_COUNT threads" + fi + + # Run tests with or without coverage based on OS and run number + if [ "${{ runner.os }}" == "Linux" ] && [ $RUN -eq 1 ]; then + echo "Run $RUN: Running with coverage collection" + dotnet test Tests/UnitTestsParallelizable \ + --no-build \ + --verbosity normal \ + --collect:"XPlat Code Coverage" \ + --settings Tests/UnitTests/runsettings.coverage.xml \ + --diag:logs/UnitTestsParallelizable/${{ runner.os }}/run${RUN}-logs.txt \ + --blame \ + --blame-crash \ + --blame-hang \ + --blame-hang-timeout 60s \ + --blame-crash-collect-always \ + -- xUnit.MaxParallelThreads=${XUNIT_MAX_PARALLEL_THREADS} + else + dotnet test Tests/UnitTestsParallelizable \ + --no-build \ + --verbosity normal \ + --settings Tests/UnitTestsParallelizable/runsettings.xml \ + --diag:logs/UnitTestsParallelizable/${{ runner.os }}/run${RUN}-logs.txt \ + --blame \ + --blame-crash \ + --blame-hang \ + --blame-hang-timeout 60s \ + --blame-crash-collect-always \ + -- xUnit.MaxParallelThreads=${XUNIT_MAX_PARALLEL_THREADS} + fi + + if [ $? -ne 0 ]; then + echo "ERROR: Test run $RUN failed!" + exit 1 + fi + + echo "Test run $RUN completed successfully" + echo "" + done + + echo "============================================" + echo "All 10 test runs completed successfully!" + echo "============================================" - name: Upload UnitTestsParallelizable Logs if: always() diff --git a/.gitignore b/.gitignore index cdec09ec2..79eff65ea 100644 --- a/.gitignore +++ b/.gitignore @@ -73,3 +73,4 @@ log.* !/Tests/coverage/.gitkeep # keep folder in repo /Tests/report/ *.cobertura.xml +/docfx/docs/migratingfromv1.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e985e560..0f24d1c6e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,19 +7,16 @@ Welcome! This guide provides everything you need to know to contribute effective ## Table of Contents - [Project Overview](#project-overview) -- [Building and Testing](#building-and-testing) +- [Key Architecture Concepts](#key-architecture-concepts) - [Coding Conventions](#coding-conventions) +- [Building and Testing](#building-and-testing) - [Testing Requirements](#testing-requirements) - [API Documentation Requirements](#api-documentation-requirements) - [Pull Request Guidelines](#pull-request-guidelines) - [CI/CD Workflows](#cicd-workflows) - [Repository Structure](#repository-structure) - [Branching Model](#branching-model) -- [Key Architecture Concepts](#key-architecture-concepts) - [What NOT to Do](#what-not-to-do) -- [Additional Resources](#additional-resources) - ---- ## Project Overview @@ -32,8 +29,18 @@ Welcome! This guide provides everything you need to know to contribute effective - **Version**: v2 (Alpha), v1 (maintenance mode) - **Branching**: GitFlow model (v2_develop is default/active development) ---- +## Key Architecture Concepts +**⚠️ CRITICAL - AI Agents MUST understand these concepts before starting work.** + +- **Application Lifecycle** - How `Application.Init`, `Application.Run`, and `Application.Shutdown` work - [Application Deep Dive](./docfx/docs/application.md) +- **Cancellable Workflow Patern** - [CWP Deep Dive](./docfx/docs/cancellable-work-pattern.md) +- **View Hierarchy** - Understanding `View`, `Runnable`, `Window`, and view containment - [View Deep Dive](./docfx/docs/View.md) +- **Layout System** - Pos, Dim, and automatic layout - [Layout System](./docfx/docs/layout.md) +- **Event System** - How keyboard, mouse, and application events flow - [Events Deep Dive](./docfx/docs/events.md) +- **Driver Architecture** - How console drivers abstract platform differences - [Drivers](./docfx/docs/drivers.md) +- **Drawing Model** - How rendering works with Attributes, Colors, and Glyphs - [Drawing Deep Dive](./docfx/docs/drivers.md) + ## Building and Testing ### Required Tools @@ -89,28 +96,18 @@ Welcome! This guide provides everything you need to know to contribute effective ### Common Build Issues -#### Issue: Build Warnings -- **Expected**: None warnings (~100 currently). -- **Action**: Don't add new warnings; fix warnings in code you modify - #### Issue: NativeAot/SelfContained Build + - **Solution**: Restore these projects explicitly: ```bash dotnet restore ./Examples/NativeAot/NativeAot.csproj -f dotnet restore ./Examples/SelfContained/SelfContained.csproj -f ``` -### Running Examples - -**UICatalog** (comprehensive demo app): -```bash -dotnet run --project Examples/UICatalog/UICatalog.csproj -``` - ---- - ## Coding Conventions +**⚠️ CRITICAL - These rules MUST be followed in ALL new or modified code** + ### Code Style Tenets 1. **Six-Year-Old Reading Level** - Readability over terseness @@ -161,8 +158,6 @@ dotnet run --project Examples/UICatalog/UICatalog.csproj **⚠️ CRITICAL - These conventions apply to ALL code - production code, test code, examples, and samples.** ---- - ## Testing Requirements ### Code Coverage @@ -178,19 +173,17 @@ dotnet run --project Examples/UICatalog/UICatalog.csproj ### Test Patterns -- **Parallelizable tests preferred** - Add new tests to `UnitTestsParallelizable` when possible -- **Avoid static dependencies** - Don't use `Application.Init`, `ConfigurationManager` in tests -- **Don't use `[AutoInitShutdown]`** - Legacy pattern, being phased out - **Make tests granular** - Each test should cover smallest area possible - Follow existing test patterns in respective test projects +- **Avoid adding new tests to the `UnitTests` Project** - Make them parallelizable and add them to `UnitTests.Parallelizable` +- **Avoid static dependencies** - DO NOT use the legacy/static `Application` API or `ConfigurationManager` in tests unless the tests explicitly test related functionality. +- **Don't use `[AutoInitShutdown]` or `[SetupFakeApplication]`** - Legacy pattern, being phased out ### Test Configuration - `xunit.runner.json` - xUnit configuration - `coverlet.runsettings` - Coverage settings (OpenCover format) ---- - ## API Documentation Requirements **All public APIs MUST have XML documentation:** @@ -202,16 +195,15 @@ dotnet run --project Examples/UICatalog/UICatalog.csproj - Complex topics → `docfx/docs/*.md` files - Proper English and grammar - Clear, concise, complete. Use imperative mood. ---- - ## Pull Request Guidelines ### PR Requirements +- **ALWAYS** include instructions for pulling down locally at end of Description + - **Title**: "Fixes #issue. Terse description". If multiple issues, list all, separated by commas (e.g. "Fixes #123, #456. Terse description") - **Description**: - Include "- Fixes #issue" for each issue near the top - - **ALWAYS** include instructions for pulling down locally at end of Description - Suggest user setup a remote named `copilot` pointing to your fork - Example: ```markdown @@ -220,99 +212,14 @@ dotnet run --project Examples/UICatalog/UICatalog.csproj git fetch copilot git checkout copilot/ ``` -- **Coding Style**: Follow all coding conventions in this document for new and modified code - **Tests**: Add tests for new functionality (see [Testing Requirements](#testing-requirements)) - **Coverage**: Maintain or increase code coverage - **Scenarios**: Update UICatalog scenarios when adding features - **Warnings**: **CRITICAL - PRs must not introduce any new warnings** - Any file modified in a PR that currently generates warnings **MUST** be fixed to remove those warnings - Exception: Warnings caused by `[Obsolete]` attributes can remain - - Expected baseline: ~326 warnings (mostly nullable reference warnings, unused variables, xUnit suggestions) - Action: Before submitting a PR, verify your changes don't add new warnings and fix any warnings in files you modify ---- - -## CI/CD Workflows - -The repository uses multiple GitHub Actions workflows. What runs and when: - -### 1) Build Solution (`.github/workflows/build.yml`) - -- **Triggers**: push and pull_request to `v2_release`, `v2_develop` (ignores `**.md`); supports `workflow_call` -- **Runner/timeout**: `ubuntu-latest`, 10 minutes -- **Steps**: -- Checkout and setup .NET 8.x GA -- `dotnet restore` -- Build Debug: `dotnet build --configuration Debug --no-restore -property:NoWarn=0618%3B0612` -- Build Release (library): `dotnet build Terminal.Gui/Terminal.Gui.csproj --configuration Release --no-incremental --force -property:NoWarn=0618%3B0612` -- Pack Release: `dotnet pack Terminal.Gui/Terminal.Gui.csproj --configuration Release --output ./local_packages -property:NoWarn=0618%3B0612` -- Restore NativeAot/SelfContained examples, then restore solution again -- Build Release for `Examples/NativeAot` and `Examples/SelfContained` -- Build Release solution -- Upload artifacts named `build-artifacts`, retention 1 day - -### 2) Build & Run Unit Tests (`.github/workflows/unit-tests.yml`) - -- **Triggers**: push and pull_request to `v2_release`, `v2_develop` (ignores `**.md`) -- **Matrix**: Ubuntu/Windows/macOS -- **Timeout**: 15 minutes per job -- **Process**: -1. Calls build workflow to build solution once -2. Downloads build artifacts -3. Runs `dotnet restore` (required for `--no-build` to work) -4. **Performance optimizations**: - - Disables Windows Defender on Windows runners (significant speedup) - - Collects code coverage **only on Linux** (ubuntu-latest) for performance - - Windows and macOS skip coverage collection to reduce test time - - Increased blame-hang-timeout to 120s for Windows/macOS (60s for Linux) -5. Runs two test jobs: - - **Non-parallel UnitTests**: `Tests/UnitTests` with blame/diag flags; `xunit.stopOnFail=false` - - **Parallel UnitTestsParallelizable**: `Tests/UnitTestsParallelizable` with blame/diag flags; `xunit.stopOnFail=false` -6. Uploads test logs and diagnostic data from all runners -7. **Uploads code coverage to Codecov only from Linux runner** - -**Test results**: All tests output to unified `TestResults/` directory at repository root - -### 3) Build & Run Integration Tests (`.github/workflows/integration-tests.yml`) - -- **Triggers**: push and pull_request to `v2_release`, `v2_develop` (ignores `**.md`) -- **Matrix**: Ubuntu/Windows/macOS -- **Timeout**: 15 minutes -- **Process**: -1. Calls build workflow -2. Downloads build artifacts -3. Runs `dotnet restore` -4. **Performance optimizations** (same as unit tests): - - Disables Windows Defender on Windows runners - - Collects code coverage **only on Linux** - - Increased blame-hang-timeout to 120s for Windows/macOS -5. Runs IntegrationTests with blame/diag flags; `xunit.stopOnFail=true` -6. Uploads logs per-OS -7. **Uploads coverage to Codecov only from Linux runner** - -### 4) Publish to NuGet (`.github/workflows/publish.yml`) - -- **Triggers**: push to `v2_release`, `v2_develop`, and tags `v*`(ignores `**.md`) -- Uses GitVersion to compute SemVer, builds Release, packs with symbols, and pushes to NuGet.org using `NUGET_API_KEY` - -### 5) Build and publish API docs (`.github/workflows/api-docs.yml`) - -- **Triggers**: push to `v1_release` and `v2_develop` -- Builds DocFX site on Windows and deploys to GitHub Pages when `ref_name` is `v2_release` or `v2_develop` - - -### Replicating CI Locally - -```bash -# Full CI sequence: -dotnet restore -dotnet build --configuration Debug --no-restore -dotnet test Tests/UnitTests --no-build --verbosity normal -dotnet test Tests/UnitTestsParallelizable --no-build --verbosity normal -dotnet build --configuration Release --no-restore -``` - ---- ## Repository Structure @@ -364,7 +271,6 @@ dotnet build --configuration Release --no-restore **`/.github/workflows/`** - CI/CD pipelines (see [CI/CD Workflows](#cicd-workflows)) ---- ## Branching Model @@ -374,31 +280,6 @@ dotnet build --configuration Release --no-restore - `v2_release` - Stable releases, matches NuGet - `v1_develop`, `v1_release` - Legacy v1 (maintenance only) ---- - -## Key Architecture Concepts - -**⚠️ CRITICAL - Contributors should understand these concepts before starting work.** - -See `/docfx/docs/` for deep dives on: - -- **Application Lifecycle** - How `Application.Init`, `Application.Run`, and `Application.Shutdown` work -- **View Hierarchy** - Understanding `View`, `Toplevel`, `Window`, and view containment -- **Layout System** - Pos, Dim, and automatic layout -- **Event System** - How keyboard, mouse, and application events flow -- **Driver Architecture** - How console drivers abstract platform differences -- **Drawing Model** - How rendering works with Attributes, Colors, and Glyphs - -Key documentation: -- [View Documentation](https://gui-cs.github.io/Terminal.Gui/docs/View.html) -- [Events Deep Dive](https://gui-cs.github.io/Terminal.Gui/docs/events.html) -- [Layout System](https://gui-cs.github.io/Terminal.Gui/docs/layout.html) -- [Keyboard Handling](https://gui-cs.github.io/Terminal.Gui/docs/keyboard.html) -- [Mouse Support](https://gui-cs.github.io/Terminal.Gui/docs/mouse.html) -- [Drivers](https://gui-cs.github.io/Terminal.Gui/docs/drivers.html) - ---- - ## What NOT to Do - ❌ Don't add new linters/formatters (use existing) @@ -412,17 +293,4 @@ Key documentation: - ❌ **Don't use redundant type names with `new`** (**ALWAYS PREFER** target-typed `new ()`) - ❌ **Don't introduce new warnings** (fix warnings in files you modify; exception: `[Obsolete]` warnings) ---- - -## Additional Resources - -- **Full Documentation**: https://gui-cs.github.io/Terminal.Gui -- **API Reference**: https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.App.html -- **Deep Dives**: `/docfx/docs/` directory -- **Getting Started**: https://gui-cs.github.io/Terminal.Gui/docs/getting-started.html -- **Migrating from v1 to v2**: https://gui-cs.github.io/Terminal.Gui/docs/migratingfromv1.html -- **Showcase**: https://gui-cs.github.io/Terminal.Gui/docs/showcase.html - ---- - **Thank you for contributing to Terminal.Gui!** 🎉 diff --git a/Directory.Packages.props b/Directory.Packages.props index d62a1d298..2fdb4633e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -18,7 +18,7 @@ - + diff --git a/Examples/CommunityToolkitExample/LoginView.cs b/Examples/CommunityToolkitExample/LoginView.cs index 70ec87f07..8a2f0cf38 100644 --- a/Examples/CommunityToolkitExample/LoginView.cs +++ b/Examples/CommunityToolkitExample/LoginView.cs @@ -64,8 +64,6 @@ internal partial class LoginView : IRecipient> } } SetText (); - // BUGBUG: This should not be needed: - Application.LayoutAndDraw (); } private void SetText () diff --git a/Examples/CommunityToolkitExample/LoginViewModel.cs b/Examples/CommunityToolkitExample/LoginViewModel.cs index bdec99519..af7d594c3 100644 --- a/Examples/CommunityToolkitExample/LoginViewModel.cs +++ b/Examples/CommunityToolkitExample/LoginViewModel.cs @@ -12,7 +12,7 @@ internal partial class LoginViewModel : ObservableObject private const string INVALID_LOGIN_MESSAGE = "Please enter a valid user name and password."; private const string LOGGING_IN_PROGRESS_MESSAGE = "Logging in..."; private const string VALID_LOGIN_MESSAGE = "The input is valid!"; - + [ObservableProperty] private bool _canLogin; @@ -28,7 +28,7 @@ internal partial class LoginViewModel : ObservableObject [ObservableProperty] private string _usernameLengthMessage; - + [ObservableProperty] private Scheme? _validationScheme; @@ -105,7 +105,7 @@ internal partial class LoginViewModel : ObservableObject { switch (loginAction) { - case LoginActions.Clear: + case LoginActions.Clear: LoginProgressMessage = message; ValidationMessage = INVALID_LOGIN_MESSAGE; ValidationScheme = SchemeManager.GetScheme ("Error"); @@ -115,7 +115,7 @@ internal partial class LoginViewModel : ObservableObject break; case LoginActions.Validation: ValidationMessage = CanLogin ? VALID_LOGIN_MESSAGE : INVALID_LOGIN_MESSAGE; - ValidationScheme = CanLogin ? SchemeManager.GetScheme ("Base") : SchemeManager.GetScheme("Error"); + ValidationScheme = CanLogin ? SchemeManager.GetScheme ("Base") : SchemeManager.GetScheme ("Error"); break; } WeakReferenceMessenger.Default.Send (new Message { Value = loginAction }); diff --git a/Examples/CommunityToolkitExample/Message.cs b/Examples/CommunityToolkitExample/Message.cs index f0e8ad530..fbd85604f 100644 --- a/Examples/CommunityToolkitExample/Message.cs +++ b/Examples/CommunityToolkitExample/Message.cs @@ -1,5 +1,4 @@ namespace CommunityToolkitExample; - internal class Message { public T? Value { get; set; } diff --git a/Examples/CommunityToolkitExample/Program.cs b/Examples/CommunityToolkitExample/Program.cs index 265c979aa..75ada5665 100644 --- a/Examples/CommunityToolkitExample/Program.cs +++ b/Examples/CommunityToolkitExample/Program.cs @@ -1,8 +1,6 @@ using Microsoft.Extensions.DependencyInjection; -using Terminal.Gui.Configuration; using Terminal.Gui.App; -using Terminal.Gui.ViewBase; - +using Terminal.Gui.Configuration; namespace CommunityToolkitExample; @@ -14,10 +12,10 @@ public static class Program { ConfigurationManager.Enable (ConfigLocations.All); Services = ConfigureServices (); - Application.Init (); - Application.Run (Services.GetRequiredService ()); - Application.Top?.Dispose (); - Application.Shutdown (); + using IApplication app = Application.Create (); + app.Init (); + using var loginView = Services.GetRequiredService (); + app.Run (loginView); } private static IServiceProvider ConfigureServices () @@ -25,6 +23,7 @@ public static class Program var services = new ServiceCollection (); services.AddTransient (); services.AddTransient (); + return services.BuildServiceProvider (); } -} \ No newline at end of file +} diff --git a/Examples/CommunityToolkitExample/README.md b/Examples/CommunityToolkitExample/README.md index 908ae592b..1f7d5d877 100644 --- a/Examples/CommunityToolkitExample/README.md +++ b/Examples/CommunityToolkitExample/README.md @@ -6,9 +6,10 @@ Right away we use IoC to load our views and view models. ``` csharp // As a public property for access further in the application if needed. -public static IServiceProvider Services { get; private set; } +public static IServiceProvider? Services { get; private set; } ... // In Main +ConfigurationManager.Enable (ConfigLocations.All); Services = ConfigureServices (); ... private static IServiceProvider ConfigureServices () @@ -20,16 +21,19 @@ private static IServiceProvider ConfigureServices () } ``` -Now, we start the app and get our main view. +Now, we start the app using the modern Terminal.Gui model and get our main view. ``` csharp -Application.Run (Services.GetRequiredService ()); +using IApplication app = Application.Create (); +app.Init (); +using var loginView = Services.GetRequiredService (); +app.Run (loginView); ``` Our view implements `IRecipient` to demonstrate the use of the `WeakReferenceMessenger`. The binding of the view events is then created. ``` csharp -internal partial class LoginView : IRecipient> +internal partial class LoginView : IRecipient> { public LoginView (LoginViewModel viewModel) { @@ -41,15 +45,16 @@ internal partial class LoginView : IRecipient> passwordInput.TextChanged += (_, _) => { ViewModel.Password = passwordInput.Text; - SetText (); }; - loginButton.Accept += (_, _) => + loginButton.Accepting += (_, e) => { if (!ViewModel.CanLogin) { return; } ViewModel.LoginCommand.Execute (null); + // When Accepting is handled, set e.Handled to true to prevent further processing. + e.Handled = true; }; ... - // Let the view model know the view is intialized. + // Let the view model know the view is initialized. Initialized += (_, _) => { ViewModel.Initialized (); }; } ... @@ -101,54 +106,53 @@ The use of `WeakReferenceMessenger` provides one method of signaling the view fr ... private async Task Login () { - SendMessage (LoginAction.LoginProgress, LOGGING_IN_PROGRESS_MESSAGE); + SendMessage (LoginActions.LoginProgress, LOGGING_IN_PROGRESS_MESSAGE); await Task.Delay (TimeSpan.FromSeconds (1)); Clear (); } -private void SendMessage (LoginAction loginAction, string message = "") +private void SendMessage (LoginActions loginAction, string message = "") { switch (loginAction) { - case LoginAction.LoginProgress: + case LoginActions.LoginProgress: LoginProgressMessage = message; break; - case LoginAction.Validation: + case LoginActions.Validation: ValidationMessage = CanLogin ? VALID_LOGIN_MESSAGE : INVALID_LOGIN_MESSAGE; - ValidationScheme = CanLogin ? Colors.Schemes ["Base"] : Colors.Schemes ["Error"]; + ValidationScheme = CanLogin ? SchemeManager.GetScheme ("Base") : SchemeManager.GetScheme ("Error"); break; } - WeakReferenceMessenger.Default.Send (new Message { Value = loginAction }); + WeakReferenceMessenger.Default.Send (new Message { Value = loginAction }); } private void ValidateLogin () { CanLogin = !string.IsNullOrEmpty (Username) && !string.IsNullOrEmpty (Password); - SendMessage (LoginAction.Validation); + SendMessage (LoginActions.Validation); } ... ``` -And the view's `Receive` function which provides an `Application.Refresh()` call to update the UI immediately. +The view's `Receive` function updates the UI based on messages from the view model. In the modern Terminal.Gui model, UI updates are automatically refreshed, so no manual `Application.Refresh()` call is needed. ``` csharp -public void Receive (Message message) +public void Receive (Message message) { switch (message.Value) { - case LoginAction.LoginProgress: + case LoginActions.LoginProgress: { loginProgressLabel.Text = ViewModel.LoginProgressMessage; break; } - case LoginAction.Validation: + case LoginActions.Validation: { validationLabel.Text = ViewModel.ValidationMessage; - validationLabel.Scheme = ViewModel.ValidationScheme; + validationLabel.SetScheme (ViewModel.ValidationScheme); break; } } - SetText(); - Application.Refresh (); + SetText (); } ``` diff --git a/Examples/Example/Example.cs b/Examples/Example/Example.cs index 82cd60d6e..9d3fd863f 100644 --- a/Examples/Example/Example.cs +++ b/Examples/Example/Example.cs @@ -3,30 +3,28 @@ // This is a simple example application. For the full range of functionality // see the UICatalog project -using Terminal.Gui.Configuration; using Terminal.Gui.App; -using Terminal.Gui.Drawing; +using Terminal.Gui.Configuration; using Terminal.Gui.ViewBase; using Terminal.Gui.Views; -using Attribute = Terminal.Gui.Drawing.Attribute; // Override the default configuration for the application to use the Light theme -//ConfigurationManager.RuntimeConfig = """{ "Theme": "Light" }"""; -ConfigurationManager.Enable(ConfigLocations.All); +ConfigurationManager.RuntimeConfig = """{ "Theme": "Light" }"""; +ConfigurationManager.Enable (ConfigLocations.All); +IApplication app = Application.Create (); +app.Run (); -Application.Run ().Dispose (); - -// Before the application exits, reset Terminal.Gui for clean shutdown -Application.Shutdown (); +// Dispose the app to clean up and enable Console.WriteLine below +app.Dispose (); // To see this output on the screen it must be done after shutdown, // which restores the previous screen. Console.WriteLine ($@"Username: {ExampleWindow.UserName}"); // Defines a top-level window with border and title -public class ExampleWindow : Window +public sealed class ExampleWindow : Window { public static string UserName { get; set; } @@ -74,39 +72,32 @@ public class ExampleWindow : Window // When login button is clicked display a message popup btnLogin.Accepting += (s, e) => - { - if (userNameText.Text == "admin" && passwordText.Text == "password") - { - MessageBox.Query ("Logging In", "Login Successful", "Ok"); - UserName = userNameText.Text; - Application.RequestStop (); - } - else - { - MessageBox.ErrorQuery ("Logging In", "Incorrect username or password", "Ok"); - } - // When Accepting is handled, set e.Handled to true to prevent further processing. - e.Handled = true; - }; + { + if (userNameText.Text == "admin" && passwordText.Text == "password") + { + MessageBox.Query (App, "Logging In", "Login Successful", "Ok"); + UserName = userNameText.Text; + Application.RequestStop (); + } + else + { + MessageBox.ErrorQuery (App, "Logging In", "Incorrect username or password", "Ok"); + } + + // When Accepting is handled, set e.Handled to true to prevent further processing. + e.Handled = true; + }; // Add the views to the Window Add (usernameLabel, userNameText, passwordLabel, passwordText, btnLogin); - ListView lv = new ListView () + var lv = new ListView { - Y = Pos.AnchorEnd(), - Height= Dim.Auto(), - Width = Dim.Auto() + Y = Pos.AnchorEnd (), + Height = Dim.Auto (), + Width = Dim.Auto () }; lv.SetSource (["One", "Two", "Three", "Four"]); Add (lv); } - - public override void EndInit () - { - base.EndInit (); - // Set the theme to "Anders" if it exists, otherwise use "Default" - ThemeManager.Theme = ThemeManager.GetThemeNames ().FirstOrDefault (x => x == "Anders") ?? "Default"; - } } - diff --git a/Examples/Example/README.md b/Examples/Example/README.md index 2cb0a9870..f1de23be5 100644 --- a/Examples/Example/README.md +++ b/Examples/Example/README.md @@ -1,11 +1,8 @@ # Terminal.Gui C# Example -This example shows how to use the Terminal.Gui library to create a simple GUI application in C#. +This example shows how to use the Terminal.Gui library to create a simple TUI application in C#. This is the same code found in the Terminal.Gui README.md file. To explore the full range of functionality in Terminal.Gui, see the [UICatalog](../UICatalog) project -See [README.md](https://github.com/gui-cs/Terminal.Gui) for a list of all Terminal.Gui samples. - -Note, the old `demo.cs` example has been deleted because it was not a very good example. It can still be found in the [git history](https://github.com/gui-cs/Terminal.Gui/tree/v1.8.2). \ No newline at end of file diff --git a/Examples/FluentExample/FluentExample.csproj b/Examples/FluentExample/FluentExample.csproj new file mode 100644 index 000000000..2086af6ed --- /dev/null +++ b/Examples/FluentExample/FluentExample.csproj @@ -0,0 +1,11 @@ + + + Exe + net8.0 + preview + enable + + + + + diff --git a/Examples/FluentExample/Program.cs b/Examples/FluentExample/Program.cs new file mode 100644 index 000000000..026a98134 --- /dev/null +++ b/Examples/FluentExample/Program.cs @@ -0,0 +1,109 @@ +// Fluent API example demonstrating IRunnable with automatic disposal and result extraction + +using Terminal.Gui.App; +using Terminal.Gui.Drawing; +using Terminal.Gui.ViewBase; +using Terminal.Gui.Views; + +IApplication? app = Application.Create () + .Init () + .Run (); + +// Run the application with fluent API - automatically creates, runs, and disposes the runnable +Color? result = app.GetResult () as Color?; + +// Shut down the app with Dispose before we can use Console.WriteLine +app.Dispose (); + +if (result is { }) +{ + Console.WriteLine (@$"Selected Color: {result}"); +} +else +{ + Console.WriteLine (@"No color selected"); +} + +/// +/// A runnable view that allows the user to select a color. +/// Demonstrates the Runnable with type pattern with automatic disposal. +/// +public class ColorPickerView : Runnable +{ + public ColorPickerView () + { + Title = "Select a Color (Esc to quit)"; + BorderStyle = LineStyle.Single; + Height = Dim.Auto (); + Width = Dim.Auto (); + + // Add instructions + var instructions = new Label + { + Text = "Use arrow keys to select a color, Enter to accept", + X = Pos.Center (), + Y = 0 + }; + + // Create color picker + ColorPicker colorPicker = new () + { + X = Pos.Center (), + Y = Pos.Bottom (instructions), + Style = new ColorPickerStyle () + { + ShowColorName = true, + ShowTextFields = true + } + }; + colorPicker.ApplyStyleChanges (); + + // Create OK button + Button okButton = new () + { + Title = "_OK", + X = Pos.Align (Alignment.Center), + Y = Pos.AnchorEnd (), + IsDefault = true + }; + + okButton.Accepting += (s, e) => + { + // Extract result before stopping + Result = colorPicker.SelectedColor; + RequestStop (); + e.Handled = true; + }; + + // Create Cancel button + Button cancelButton = new () + { + Title = "_Cancel", + X = Pos.Align (Alignment.Center), + Y = Pos.AnchorEnd () + }; + + cancelButton.Accepting += (s, e) => + { + // Don't set result - leave as null + RequestStop (); + e.Handled = true; + }; + + // Add views + Add (instructions, colorPicker, okButton, cancelButton); + } + + protected override bool OnIsRunningChanging (bool oldIsRunning, bool newIsRunning) + { + // Alternative place to extract result before stopping + // This is called before the view is removed from the stack + if (!newIsRunning && Result is null) + { + // User pressed Esc - could extract current selection here + //Result = SelectedColor; + } + + return base.OnIsRunningChanging (oldIsRunning, newIsRunning); + } +} diff --git a/Examples/NativeAot/Program.cs b/Examples/NativeAot/Program.cs index 3de9bfeec..501adb2ed 100644 --- a/Examples/NativeAot/Program.cs +++ b/Examples/NativeAot/Program.cs @@ -101,13 +101,13 @@ public class ExampleWindow : Window { if (userNameText.Text == "admin" && passwordText.Text == "password") { - MessageBox.Query ("Logging In", "Login Successful", "Ok"); + MessageBox.Query (App, "Logging In", "Login Successful", "Ok"); UserName = userNameText.Text; Application.RequestStop (); } else { - MessageBox.ErrorQuery ("Logging In", "Incorrect username or password", "Ok"); + MessageBox.ErrorQuery (App, "Logging In", "Incorrect username or password", "Ok"); } // Anytime Accepting is handled, make sure to set e.Handled to true. e.Handled = true; diff --git a/Examples/ReactiveExample/Program.cs b/Examples/ReactiveExample/Program.cs index 910d1f4a4..e70611afc 100644 --- a/Examples/ReactiveExample/Program.cs +++ b/Examples/ReactiveExample/Program.cs @@ -1,9 +1,7 @@ using System.Reactive.Concurrency; using ReactiveUI; -using ReactiveUI.SourceGenerators; -using Terminal.Gui.Configuration; using Terminal.Gui.App; -using Terminal.Gui.ViewBase; +using Terminal.Gui.Configuration; namespace ReactiveExample; @@ -12,11 +10,12 @@ public static class Program private static void Main (string [] args) { ConfigurationManager.Enable (ConfigLocations.All); - Application.Init (); - RxApp.MainThreadScheduler = TerminalScheduler.Default; + using IApplication app = Application.Create (); + app.Init (); + RxApp.MainThreadScheduler = new TerminalScheduler (app); RxApp.TaskpoolScheduler = TaskPoolScheduler.Default; - Application.Run (new LoginView (new LoginViewModel ())); - Application.Top.Dispose (); - Application.Shutdown (); + var loginView = new LoginView (new ()); + app.Run (loginView); + loginView.Dispose (); } } diff --git a/Examples/ReactiveExample/README.md b/Examples/ReactiveExample/README.md index 9e7dae7fd..62fbcd0e7 100644 --- a/Examples/ReactiveExample/README.md +++ b/Examples/ReactiveExample/README.md @@ -7,10 +7,14 @@ This is a sample app that shows how to use `System.Reactive` and `ReactiveUI` wi 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 -Application.Init (); -RxApp.MainThreadScheduler = TerminalScheduler.Default; +ConfigurationManager.Enable (ConfigLocations.All); +using IApplication app = Application.Create (); +app.Init (); +RxApp.MainThreadScheduler = new TerminalScheduler (app); RxApp.TaskpoolScheduler = TaskPoolScheduler.Default; -Application.Run (new RootView (new RootViewModel ())); +var loginView = new LoginView (new ()); +app.Run (loginView); +loginView.Dispose (); ``` 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` updated from a background thread, and you wish to update the UI with `TValue`s received from that observable. @@ -43,6 +47,6 @@ If you combine `OneWay` and `OneWayToSource` data bindings, you get `TwoWay` dat // 'clearButton' is 'Button' clearButton .Events () - .Clicked + .Accepting .InvokeCommand (ViewModel, x => x.Clear); ``` \ No newline at end of file diff --git a/Examples/ReactiveExample/TerminalScheduler.cs b/Examples/ReactiveExample/TerminalScheduler.cs index 9c8286722..7de5d93f0 100644 --- a/Examples/ReactiveExample/TerminalScheduler.cs +++ b/Examples/ReactiveExample/TerminalScheduler.cs @@ -1,4 +1,4 @@ -using System; +#nullable enable using System.Reactive.Concurrency; using System.Reactive.Disposables; using Terminal.Gui.App; @@ -7,8 +7,9 @@ namespace ReactiveExample; public class TerminalScheduler : LocalScheduler { - public static readonly TerminalScheduler Default = new (); - private TerminalScheduler () { } + public TerminalScheduler (IApplication? application) { _application = application; } + + private readonly IApplication? _application = null; public override IDisposable Schedule ( TState state, @@ -21,15 +22,15 @@ public class TerminalScheduler : LocalScheduler var composite = new CompositeDisposable (2); var cancellation = new CancellationDisposable (); - Application.Invoke ( - () => - { - if (!cancellation.Token.IsCancellationRequested) - { - composite.Add (action (this, state)); - } - } - ); + _application?.Invoke ( + (_) => + { + if (!cancellation.Token.IsCancellationRequested) + { + composite.Add (action (this, state)); + } + } + ); composite.Add (cancellation); return composite; @@ -39,16 +40,22 @@ public class TerminalScheduler : LocalScheduler { var composite = new CompositeDisposable (2); - object timeout = Application.AddTimeout ( - dueTime, - () => - { - composite.Add (action (this, state)); + object? timeout = _application?.AddTimeout ( + dueTime, + () => + { + composite.Add (action (this, state)); - return false; - } - ); - composite.Add (Disposable.Create (() => Application.RemoveTimeout (timeout))); + return false; + } + ); + composite.Add (Disposable.Create (() => + { + if (timeout is { }) + { + _application?.RemoveTimeout (timeout); + } + })); return composite; } diff --git a/Examples/ReactiveExample/ViewExtensions.cs b/Examples/ReactiveExample/ViewExtensions.cs index f1f639900..b58ec9919 100644 --- a/Examples/ReactiveExample/ViewExtensions.cs +++ b/Examples/ReactiveExample/ViewExtensions.cs @@ -1,5 +1,4 @@ -using System; -using Terminal.Gui.ViewBase; +using Terminal.Gui.ViewBase; using Terminal.Gui.Views; namespace ReactiveExample; diff --git a/Examples/RunnableWrapperExample/Program.cs b/Examples/RunnableWrapperExample/Program.cs new file mode 100644 index 000000000..1eb5e9e11 --- /dev/null +++ b/Examples/RunnableWrapperExample/Program.cs @@ -0,0 +1,168 @@ +// Example demonstrating how to make ANY View runnable without implementing IRunnable + +using Terminal.Gui.App; +using Terminal.Gui.Drawing; +using Terminal.Gui.ViewBase; +using Terminal.Gui.Views; + +IApplication app = Application.Create (); +app.Init (); + +// Example 1: Use extension method with result extraction +var textField = new TextField { Width = 40, Text = "Default text" }; +textField.Title = "Enter your name"; +textField.BorderStyle = LineStyle.Single; + +RunnableWrapper textRunnable = textField.AsRunnable (tf => tf.Text); +app.Run (textRunnable); + +if (textRunnable.Result is { } name) +{ + MessageBox.Query (app, "Result", $"You entered: {name}", "OK"); +} +else +{ + MessageBox.Query (app, "Result", "Canceled", "OK"); +} + +textRunnable.Dispose (); + +// Example 2: Use IApplication.RunView() for one-liner +Color selectedColor = app.RunView ( + new ColorPicker + { + Title = "Pick a Color", + BorderStyle = LineStyle.Single + }, + cp => cp.SelectedColor); + +MessageBox.Query (app, "Result", $"Selected color: {selectedColor}", "OK"); + +// Example 3: FlagSelector with typed enum result +FlagSelector flagSelector = new() +{ + Title = "Choose Styles", + BorderStyle = LineStyle.Single +}; + +RunnableWrapper, SelectorStyles?> flagsRunnable = flagSelector.AsRunnable (fs => fs.Value); +app.Run (flagsRunnable); + +MessageBox.Query (app, "Result", $"Selected styles: {flagsRunnable.Result}", "OK"); +flagsRunnable.Dispose (); + +// Example 4: Any View without result extraction +var label = new Label +{ + Text = "Press Esc to continue...", + X = Pos.Center (), + Y = Pos.Center () +}; + +RunnableWrapper labelRunnable = label.AsRunnable (); +app.Run (labelRunnable); + +// Can still access the wrapped view +MessageBox.Query (app, "Result", $"Label text was: {labelRunnable.WrappedView.Text}", "OK"); +labelRunnable.Dispose (); + +// Example 5: Complex custom View made runnable +View formView = CreateCustomForm (); +RunnableWrapper formRunnable = formView.AsRunnable (ExtractFormData); + +app.Run (formRunnable); + +if (formRunnable.Result is { } formData) +{ + MessageBox.Query ( + app, + "Form Results", + $"Name: {formData.Name}\nAge: {formData.Age}\nAgreed: {formData.Agreed}", + "OK"); +} + +formRunnable.Dispose (); + +app.Dispose (); + +// Helper method to create a custom form +View CreateCustomForm () +{ + var form = new View + { + Title = "User Information", + BorderStyle = LineStyle.Single, + Width = 50, + Height = 10 + }; + + var nameField = new TextField + { + Id = "nameField", + X = 10, + Y = 1, + Width = 30 + }; + + var ageField = new TextField + { + Id = "ageField", + X = 10, + Y = 3, + Width = 10 + }; + + var agreeCheckbox = new CheckBox + { + Id = "agreeCheckbox", + Title = "I agree to terms", + X = 10, + Y = 5 + }; + + var okButton = new Button + { + Title = "OK", + X = Pos.Center (), + Y = 7, + IsDefault = true + }; + + okButton.Accepting += (s, e) => + { + form.App?.RequestStop (); + e.Handled = true; + }; + + form.Add (new Label { Text = "Name:", X = 2, Y = 1 }); + form.Add (nameField); + form.Add (new Label { Text = "Age:", X = 2, Y = 3 }); + form.Add (ageField); + form.Add (agreeCheckbox); + form.Add (okButton); + + return form; +} + +// Helper method to extract data from the custom form +FormData ExtractFormData (View form) +{ + var nameField = form.SubViews.FirstOrDefault (v => v.Id == "nameField") as TextField; + var ageField = form.SubViews.FirstOrDefault (v => v.Id == "ageField") as TextField; + var agreeCheckbox = form.SubViews.FirstOrDefault (v => v.Id == "agreeCheckbox") as CheckBox; + + return new() + { + Name = nameField?.Text ?? string.Empty, + Age = int.TryParse (ageField?.Text, out int age) ? age : 0, + Agreed = agreeCheckbox?.CheckedState == CheckState.Checked + }; +} + +// Result type for custom form +internal record FormData +{ + public string Name { get; init; } = string.Empty; + public int Age { get; init; } + public bool Agreed { get; init; } +} diff --git a/Examples/RunnableWrapperExample/RunnableWrapperExample.csproj b/Examples/RunnableWrapperExample/RunnableWrapperExample.csproj new file mode 100644 index 000000000..7e34acedb --- /dev/null +++ b/Examples/RunnableWrapperExample/RunnableWrapperExample.csproj @@ -0,0 +1,15 @@ + + + + Exe + net8.0 + enable + enable + latest + + + + + + + diff --git a/Examples/SelfContained/Program.cs b/Examples/SelfContained/Program.cs index 02109bf3a..319ae859f 100644 --- a/Examples/SelfContained/Program.cs +++ b/Examples/SelfContained/Program.cs @@ -5,6 +5,7 @@ using System.Diagnostics.CodeAnalysis; using System.Globalization; using Terminal.Gui.Configuration; using Terminal.Gui.App; +using Terminal.Gui.Drawing; using Terminal.Gui.ViewBase; using Terminal.Gui.Views; @@ -16,7 +17,9 @@ public static class Program private static void Main (string [] args) { ConfigurationManager.Enable (ConfigLocations.All); - Application.Init (); + + IApplication app = Application.Create (); + app.Init (); #region The code in this region is not intended for use in a self-contained single-file. It's just here to make sure there is no functionality break with localization in Terminal.Gui using single-file @@ -33,28 +36,25 @@ public static class Program #endregion - ExampleWindow app = new (); - Application.Run (app); + using ExampleWindow exampleWindow = new (); + string? userName = app.Run (exampleWindow) as string; - // Dispose the app object before shutdown + + // Shutdown the application in order to free resources and clean up the terminal app.Dispose (); - // Before the application exits, reset Terminal.Gui for clean shutdown - Application.Shutdown (); - // To see this output on the screen it must be done after shutdown, // which restores the previous screen. - Console.WriteLine ($@"Username: {ExampleWindow.UserName}"); + Console.WriteLine ($@"Username: {userName}"); } } // Defines a top-level window with border and title -public class ExampleWindow : Window +public class ExampleWindow : Runnable { - public static string? UserName; - public ExampleWindow () { + BorderStyle = LineStyle.Single; Title = $"Example App ({Application.QuitKey} to quit)"; // Create input components and labels @@ -100,13 +100,13 @@ public class ExampleWindow : Window { if (userNameText.Text == "admin" && passwordText.Text == "password") { - MessageBox.Query ("Logging In", "Login Successful", "Ok"); - UserName = userNameText.Text; - Application.RequestStop (); + MessageBox.Query (App, "Logging In", "Login Successful", "Ok"); + Result = userNameText.Text; + App?.RequestStop (); } else { - MessageBox.ErrorQuery ("Logging In", "Incorrect username or password", "Ok"); + MessageBox.ErrorQuery (App, "Logging In", "Incorrect username or password", "Ok"); } // When Accepting is handled, set e.Handled to true to prevent further processing. e.Handled = true; diff --git a/Examples/SelfContained/README.md b/Examples/SelfContained/README.md index f4bd041ee..e7c147aa6 100644 --- a/Examples/SelfContained/README.md +++ b/Examples/SelfContained/README.md @@ -2,6 +2,32 @@ This project aims to test the `Terminal.Gui` library to create a simple `self-contained` `single-file` GUI application in C#, ensuring that all its features are available. +## Modern Terminal.Gui API + +This example uses the modern Terminal.Gui application model: + +```csharp +ConfigurationManager.Enable (ConfigLocations.All); + +IApplication app = Application.Create (); +app.Init (); + +using ExampleWindow exampleWindow = new (); +string? userName = app.Run (exampleWindow) as string; + +app.Dispose (); + +Console.WriteLine ($@"Username: {userName}"); +``` + +Key aspects of the modern model: +- Use `Application.Create()` to create an `IApplication` instance +- Call `app.Init()` to initialize the application +- Use `app.Run(view)` to run views with proper resource management +- Call `app.Dispose()` to clean up resources and restore the terminal +- Event handling uses `Accepting` event instead of legacy `Accept` event +- Set `e.Handled = true` in event handlers to prevent further processing + With `Debug` the `.csproj` is used and with `Release` the latest `nuget package` is used, either in `Solution Configurations` or in `Profile Publish`. To publish the self-contained single file in `Debug` or `Release` mode, it is not necessary to select it in the `Solution Configurations`, just choose the `Debug` or `Release` configuration in the `Publish Profile`. diff --git a/Examples/UICatalog/README.md b/Examples/UICatalog/README.md index c9c810f42..ac9b37e09 100644 --- a/Examples/UICatalog/README.md +++ b/Examples/UICatalog/README.md @@ -80,7 +80,7 @@ The default `Window` shows the Scenario name and supports exiting the Scenario t ![screenshot](generic_screenshot.png) -To build a more advanced scenario, where control of the `Toplevel` and `Window` is needed (e.g. for scenarios using `MenuBar` or `StatusBar`), simply use `Application.Top` per normal Terminal.Gui programming, as seen in the `Notepad` scenario. +To build a more advanced scenario, where control of the `Runnable` and `Window` is needed (e.g. for scenarios using `MenuBar` or `StatusBar`), simply use `Application.Top` per normal Terminal.Gui programming, as seen in the `Notepad` scenario. For complete control, the `Init` and `Run` overrides can be implemented. The `base.Init` creates `Win`. The `base.Run` simply calls `Application.Run(Application.Top)`. diff --git a/Examples/UICatalog/Resources/config.json b/Examples/UICatalog/Resources/config.json index 916743d23..74586e878 100644 --- a/Examples/UICatalog/Resources/config.json +++ b/Examples/UICatalog/Resources/config.json @@ -11,7 +11,7 @@ "Hot Dog Stand": { "Schemes": [ { - "Toplevel": { + "Runnable": { "Normal": { "Foreground": "Black", "Background": "#FFFF00" @@ -86,7 +86,7 @@ "Menu": { "Normal": { "Foreground": "Black", - "Background": "WHite" + "Background": "White" }, "Focus": { "Foreground": "White", @@ -136,22 +136,21 @@ { "UI Catalog Theme": { "Window.DefaultShadow": "Transparent", + "Button.DefaultShadow": "None", "CheckBox.DefaultHighlightStates": "In, Pressed, PressedOutside", "MessageBox.DefaultButtonAlignment": "Start", "StatusBar.DefaultSeparatorLineStyle": "Single", "Dialog.DefaultMinimumWidth": 80, - "MessageBox.DefaultBorderStyle": "Dotted", "NerdFonts.Enable": false, "MessageBox.DefaultMinimumWidth": 0, "Window.DefaultBorderStyle": "Double", "Dialog.DefaultShadow": "Opaque", "Dialog.DefaultButtonAlignment": "Start", - "Button.DefaultShadow": "Transparent", "FrameView.DefaultBorderStyle": "Double", "MessageBox.DefaultMinimumHeight": 0, "Button.DefaultHighlightStates": "In, Pressed", - "Menuv2.DefaultBorderStyle": "Heavy", - "MenuBarv2.DefaultBorderStyle": "Heavy", + "Menu.DefaultBorderStyle": "Heavy", + "MenuBar.DefaultBorderStyle": "Heavy", "Schemes": [ { "UI Catalog Scheme": { @@ -178,7 +177,7 @@ } }, { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "DarkGray", "Background": "White" diff --git a/Examples/UICatalog/Scenario.cs b/Examples/UICatalog/Scenario.cs index 76fc5dc2a..bcf0b1cb1 100644 --- a/Examples/UICatalog/Scenario.cs +++ b/Examples/UICatalog/Scenario.cs @@ -67,7 +67,7 @@ namespace UICatalog; /// }; /// /// var button = new Button { X = Pos.Center (), Y = Pos.Center (), Text = "Press me!" }; -/// button.Accept += (s, e) => MessageBox.ErrorQuery ("Error", "You pressed the button!", "Ok"); +/// button.Accept += (s, e) => MessageBox.ErrorQuery (App, "Error", "You pressed the button!", "Ok"); /// appWindow.Add (button); /// /// // Run - Start the application. @@ -210,18 +210,20 @@ public class Scenario : IDisposable void OnClearedContents (object? sender, EventArgs args) => BenchmarkResults.ClearedContentCount++; } - private void OnApplicationOnIteration (object? s, IterationEventArgs a) + private void OnApplicationOnIteration (object? s, EventArgs a) { BenchmarkResults.IterationCount++; if (BenchmarkResults.IterationCount > BENCHMARK_MAX_NATURAL_ITERATIONS + (_demoKeys!.Count * BENCHMARK_KEY_PACING)) { - Application.RequestStop (); + a.Value?.RequestStop (); } } + // BUGBUG: This is incompatible with modals. This should be using the new equivalent of Runnable.Ready + // BUGBUG: which will be IsRunningChanged with newIsRunning == true private void OnApplicationSessionBegun (object? sender, SessionTokenEventArgs e) { - SubscribeAllSubViews (Application.Top!); + SubscribeAllSubViews (Application.TopRunnableView!); _demoKeys = GetDemoKeyStrokes (); @@ -241,7 +243,7 @@ public class Scenario : IDisposable return; - // Get a list of all subviews under Application.Top (and their subviews, etc.) + // Get a list of all subviews under Application.TopRunnable (and their subviews, etc.) // and subscribe to their DrawComplete event void SubscribeAllSubViews (View view) { diff --git a/Examples/UICatalog/Scenarios/Adornments.cs b/Examples/UICatalog/Scenarios/Adornments.cs index 938d23a53..6dd491f65 100644 --- a/Examples/UICatalog/Scenarios/Adornments.cs +++ b/Examples/UICatalog/Scenarios/Adornments.cs @@ -11,7 +11,7 @@ public class Adornments : Scenario { Application.Init (); - Window app = new () + Window appWindow = new () { Title = GetQuitKeyAndName (), BorderStyle = LineStyle.None @@ -28,7 +28,7 @@ public class Adornments : Scenario editor.Border!.Thickness = new (1, 2, 1, 1); - app.Add (editor); + appWindow.Add (editor); var window = new Window { @@ -38,7 +38,7 @@ public class Adornments : Scenario Width = Dim.Fill (Dim.Func (_ => editor.Frame.Width)), Height = Dim.Fill () }; - app.Add (window); + appWindow.Add (window); var tf1 = new TextField { Width = 10, Text = "TextField" }; var color = new ColorPicker16 { Title = "BG", BoxHeight = 1, BoxWidth = 1, X = Pos.AnchorEnd () }; @@ -60,7 +60,7 @@ public class Adornments : Scenario var button = new Button { X = Pos.Center (), Y = Pos.Center (), Text = "Press me!" }; button.Accepting += (s, e) => - MessageBox.Query (20, 7, "Hi", $"Am I a {window.GetType ().Name}?", "Yes", "No"); + MessageBox.Query (appWindow.App, 20, 7, "Hi", $"Am I a {window.GetType ().Name}?", "Yes", "No"); var label = new TextView { @@ -121,7 +121,7 @@ public class Adornments : Scenario Text = "text (Y = 1)", CanFocus = true }; - textFieldInPadding.Accepting += (s, e) => MessageBox.Query (20, 7, "TextField", textFieldInPadding.Text, "Ok"); + textFieldInPadding.Accepting += (s, e) => MessageBox.Query (appWindow.App, 20, 7, "TextField", textFieldInPadding.Text, "Ok"); window.Padding.Add (textFieldInPadding); var btnButtonInPadding = new Button @@ -132,7 +132,7 @@ public class Adornments : Scenario CanFocus = true, HighlightStates = MouseState.None, }; - btnButtonInPadding.Accepting += (s, e) => MessageBox.Query (20, 7, "Hi", "Button in Padding Pressed!", "Ok"); + btnButtonInPadding.Accepting += (s, e) => MessageBox.Query (appWindow.App, 20, 7, "Hi", "Button in Padding Pressed!", "Ok"); btnButtonInPadding.BorderStyle = LineStyle.Dashed; btnButtonInPadding.Border!.Thickness = new (1, 1, 1, 1); window.Padding.Add (btnButtonInPadding); @@ -155,8 +155,8 @@ public class Adornments : Scenario editor.AutoSelectSuperView = window; editor.AutoSelectAdornments = true; - Application.Run (app); - app.Dispose (); + Application.Run (appWindow); + appWindow.Dispose (); Application.Shutdown (); } diff --git a/Examples/UICatalog/Scenarios/AllViewsTester.cs b/Examples/UICatalog/Scenarios/AllViewsTester.cs index c3695121e..8c89b4eb5 100644 --- a/Examples/UICatalog/Scenarios/AllViewsTester.cs +++ b/Examples/UICatalog/Scenarios/AllViewsTester.cs @@ -28,7 +28,7 @@ public class AllViewsTester : Scenario public override void Main () { - // Don't create a sub-win (Scenario.Win); just use Application.Top + // Don't create a sub-win (Scenario.Win); just use Application.TopRunnable Application.Init (); var app = new Window @@ -65,7 +65,7 @@ public class AllViewsTester : Scenario // Dispose existing current View, if any DisposeCurrentView (); - CreateCurrentView (_viewClasses.Values.ToArray () [_classListView.SelectedItem]); + CreateCurrentView (_viewClasses.Values.ToArray () [_classListView.SelectedItem.Value]); // Force ViewToEdit to be the view and not a subview if (_adornmentsEditor is { }) @@ -220,6 +220,13 @@ public class AllViewsTester : Scenario { Debug.Assert (_curView is null); + // Skip RunnableWrapper types as they have generic constraints that cannot be satisfied + if (type.IsGenericType && type.GetGenericTypeDefinition().Name.StartsWith("RunnableWrapper")) + { + Logging.Warning ($"Cannot create an instance of {type.Name} because it is a RunnableWrapper with unsatisfiable generic constraints."); + return; + } + // If we are to create a generic Type if (type.IsGenericType) { diff --git a/Examples/UICatalog/Scenarios/AnimationScenario/AnimationScenario.cs b/Examples/UICatalog/Scenarios/AnimationScenario/AnimationScenario.cs index e058ea4bf..a35453970 100644 --- a/Examples/UICatalog/Scenarios/AnimationScenario/AnimationScenario.cs +++ b/Examples/UICatalog/Scenarios/AnimationScenario/AnimationScenario.cs @@ -78,7 +78,7 @@ public class AnimationScenario : Scenario if (!f.Exists) { Debug.WriteLine ($"Could not find {f.FullName}"); - MessageBox.ErrorQuery ("Could not find gif", $"Could not find\n{f.FullName}", "Ok"); + MessageBox.ErrorQuery (_imageView?.App, "Could not find gif", $"Could not find\n{f.FullName}", "Ok"); return; } @@ -92,7 +92,7 @@ public class AnimationScenario : Scenario { // When updating from a Thread/Task always use Invoke Application.Invoke ( - () => + (_) => { _imageView.NextFrame (); _imageView.SetNeedsDraw (); diff --git a/Examples/UICatalog/Scenarios/AnsiRequestsScenario.cs b/Examples/UICatalog/Scenarios/AnsiRequestsScenario.cs index ad4f881ba..a8d7c72ad 100644 --- a/Examples/UICatalog/Scenarios/AnsiRequestsScenario.cs +++ b/Examples/UICatalog/Scenarios/AnsiRequestsScenario.cs @@ -1,6 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Linq; +#nullable enable using System.Text; namespace UICatalog.Scenarios; @@ -9,16 +7,19 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("Tests")] public sealed class AnsiEscapeSequenceRequests : Scenario { - private GraphView _graphView; + private GraphView? _graphView; - private ScatterSeries _sentSeries; - private ScatterSeries _answeredSeries; + private ScatterSeries? _sentSeries; + private ScatterSeries? _answeredSeries; private readonly List _sends = new (); private readonly object _lockAnswers = new object (); private readonly Dictionary _answers = new (); - private Label _lblSummary; + private Label? _lblSummary; + + private object? _updateTimeoutToken; + private object? _sendDarTimeoutToken; public override void Main () { @@ -32,7 +33,7 @@ public sealed class AnsiEscapeSequenceRequests : Scenario CanFocus = true }; - Tab single = new Tab (); + Tab single = new (); single.DisplayText = "Single"; single.View = BuildSingleTab (); @@ -57,6 +58,8 @@ public sealed class AnsiEscapeSequenceRequests : Scenario single.View.Dispose (); appWindow.Dispose (); + Application.RemoveTimeout (_updateTimeoutToken!); + Application.RemoveTimeout (_sendDarTimeoutToken!); // Shutdown - Calling Application.Shutdown is required. Application.Shutdown (); } @@ -70,7 +73,7 @@ public sealed class AnsiEscapeSequenceRequests : Scenario CanFocus = true }; - w.Padding.Thickness = new (1); + w!.Padding!.Thickness = new (1); var scrRequests = new List { @@ -103,7 +106,7 @@ public sealed class AnsiEscapeSequenceRequests : Scenario } var selAnsiEscapeSequenceRequestName = scrRequests [cbRequests.SelectedItem]; - AnsiEscapeSequence selAnsiEscapeSequenceRequest = null; + AnsiEscapeSequence? selAnsiEscapeSequenceRequest = null; switch (selAnsiEscapeSequenceRequestName) { @@ -163,12 +166,12 @@ public sealed class AnsiEscapeSequenceRequests : Scenario Value = string.IsNullOrEmpty (tfValue.Text) ? null : tfValue.Text }; - Application.Driver.QueueAnsiRequest ( + Application.Driver?.QueueAnsiRequest ( new () { Request = ansiEscapeSequenceRequest.Request, Terminator = ansiEscapeSequenceRequest.Terminator, - ResponseReceived = (s) => OnSuccess (s, tvResponse, tvError, tvValue, tvTerminator, lblSuccess), + ResponseReceived = (s) => OnSuccess (s!, tvResponse, tvError, tvValue, tvTerminator, lblSuccess), Abandoned = () => OnFail (tvResponse, tvError, tvValue, tvTerminator, lblSuccess) }); }; @@ -218,21 +221,21 @@ public sealed class AnsiEscapeSequenceRequests : Scenario Width = Dim.Fill () }; - Application.AddTimeout ( - TimeSpan.FromMilliseconds (1000), - () => - { - lock (_lockAnswers) - { - UpdateGraph (); + _updateTimeoutToken = Application.AddTimeout ( + TimeSpan.FromMilliseconds (1000), + () => + { + lock (_lockAnswers) + { + UpdateGraph (); - UpdateResponses (); - } + UpdateResponses (); + } - return true; - }); + return true; + }); var tv = new TextView () { @@ -266,28 +269,28 @@ public sealed class AnsiEscapeSequenceRequests : Scenario int lastSendTime = Environment.TickCount; object lockObj = new object (); - Application.AddTimeout ( - TimeSpan.FromMilliseconds (50), - () => - { - lock (lockObj) - { - if (cbDar.Value > 0) - { - int interval = 1000 / cbDar.Value; // Calculate the desired interval in milliseconds - int currentTime = Environment.TickCount; // Current system time in milliseconds + _sendDarTimeoutToken = Application.AddTimeout ( + TimeSpan.FromMilliseconds (50), + () => + { + lock (lockObj) + { + if (cbDar.Value > 0) + { + int interval = 1000 / cbDar.Value; // Calculate the desired interval in milliseconds + int currentTime = Environment.TickCount; // Current system time in milliseconds - // Check if the time elapsed since the last send is greater than the interval - if (currentTime - lastSendTime >= interval) - { - SendDar (); // Send the request - lastSendTime = currentTime; // Update the last send time - } - } - } + // Check if the time elapsed since the last send is greater than the interval + if (currentTime - lastSendTime >= interval) + { + SendDar (); // Send the request + lastSendTime = currentTime; // Update the last send time + } + } + } - return true; - }); + return true; + }); _graphView = new GraphView () @@ -318,7 +321,7 @@ public sealed class AnsiEscapeSequenceRequests : Scenario } private void UpdateResponses () { - _lblSummary.Text = GetSummary (); + _lblSummary!.Text = GetSummary (); _lblSummary.SetNeedsDraw (); } @@ -340,8 +343,8 @@ public sealed class AnsiEscapeSequenceRequests : Scenario private void SetupGraph () { - _graphView.Series.Add (_sentSeries = new ScatterSeries ()); - _graphView.Series.Add (_answeredSeries = new ScatterSeries ()); + _graphView!.Series.Add (_sentSeries = new ScatterSeries ()); + _graphView!.Series.Add (_answeredSeries = new ScatterSeries ()); _sentSeries.Fill = new GraphCellToRender (new Rune ('.'), new Attribute (ColorName16.BrightGreen, ColorName16.Black)); _answeredSeries.Fill = new GraphCellToRender (new Rune ('.'), new Attribute (ColorName16.BrightRed, ColorName16.Black)); @@ -358,17 +361,17 @@ public sealed class AnsiEscapeSequenceRequests : Scenario private void UpdateGraph () { - _sentSeries.Points = _sends + _sentSeries!.Points = _sends .GroupBy (ToSeconds) .Select (g => new PointF (g.Key, g.Count ())) .ToList (); - _answeredSeries.Points = _answers.Keys + _answeredSeries!.Points = _answers.Keys .GroupBy (ToSeconds) .Select (g => new PointF (g.Key, g.Count ())) .ToList (); // _graphView.ScrollOffset = new PointF(,0); - _graphView.SetNeedsDraw (); + _graphView!.SetNeedsDraw (); } @@ -379,13 +382,13 @@ public sealed class AnsiEscapeSequenceRequests : Scenario private void SendDar () { - Application.Driver.QueueAnsiRequest ( - new () - { - Request = EscSeqUtils.CSI_SendDeviceAttributes.Request, - Terminator = EscSeqUtils.CSI_SendDeviceAttributes.Terminator, - ResponseReceived = HandleResponse - }); + Application.Driver?.QueueAnsiRequest ( + new () + { + Request = EscSeqUtils.CSI_SendDeviceAttributes.Request, + Terminator = EscSeqUtils.CSI_SendDeviceAttributes.Terminator, + ResponseReceived = HandleResponse! + }); _sends.Add (DateTime.Now); } diff --git a/Examples/UICatalog/Scenarios/Arrangement.cs b/Examples/UICatalog/Scenarios/Arrangement.cs index 7b261db6b..35c658527 100644 --- a/Examples/UICatalog/Scenarios/Arrangement.cs +++ b/Examples/UICatalog/Scenarios/Arrangement.cs @@ -183,9 +183,9 @@ public class Arrangement : Scenario datePicker.SetScheme (new Scheme ( new Attribute ( - SchemeManager.GetScheme (Schemes.Toplevel).Normal.Foreground.GetBrighterColor (), - SchemeManager.GetScheme (Schemes.Toplevel).Normal.Background.GetBrighterColor (), - SchemeManager.GetScheme (Schemes.Toplevel).Normal.Style))); + SchemeManager.GetScheme (Schemes.Runnable).Normal.Foreground.GetBrighterColor (), + SchemeManager.GetScheme (Schemes.Runnable).Normal.Background.GetBrighterColor (), + SchemeManager.GetScheme (Schemes.Runnable).Normal.Style))); TransparentView transparentView = new () { @@ -237,7 +237,7 @@ public class Arrangement : Scenario Width = Dim.Auto (minimumContentDim: 15), Height = Dim.Auto (minimumContentDim: 3), Title = $"Overlapped{id} _{GetNextHotKey ()}", - SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Toplevel), + SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Runnable), Id = $"Overlapped{id}", ShadowStyle = ShadowStyle.Transparent, BorderStyle = LineStyle.Double, diff --git a/Examples/UICatalog/Scenarios/Bars.cs b/Examples/UICatalog/Scenarios/Bars.cs index 50153f07d..19a561631 100644 --- a/Examples/UICatalog/Scenarios/Bars.cs +++ b/Examples/UICatalog/Scenarios/Bars.cs @@ -14,9 +14,9 @@ public class Bars : Scenario public override void Main () { Application.Init (); - Toplevel app = new (); + Runnable app = new (); - app.Loaded += App_Loaded; + app.IsModalChanged += App_Loaded; Application.Run (app); app.Dispose (); @@ -28,7 +28,7 @@ public class Bars : Scenario // QuitKey and it only sticks if changed after init private void App_Loaded (object sender, EventArgs e) { - Application.Top!.Title = GetQuitKeyAndName (); + Application.TopRunnableView!.Title = GetQuitKeyAndName (); ObservableCollection eventSource = new (); ListView eventLog = new ListView () @@ -37,11 +37,11 @@ public class Bars : Scenario X = Pos.AnchorEnd (), Width = Dim.Auto (), Height = Dim.Fill (), // Make room for some wide things - SchemeName = "Toplevel", + SchemeName = "Runnable", Source = new ListWrapper (eventSource) }; eventLog.Border!.Thickness = new (0, 1, 0, 0); - Application.Top.Add (eventLog); + Application.TopRunnableView.Add (eventLog); FrameView menuBarLikeExamples = new () { @@ -51,7 +51,7 @@ public class Bars : Scenario Width = Dim.Fill () - Dim.Width (eventLog), Height = Dim.Percent(33), }; - Application.Top.Add (menuBarLikeExamples); + Application.TopRunnableView.Add (menuBarLikeExamples); Label label = new Label () { @@ -80,7 +80,7 @@ public class Bars : Scenario }; menuBarLikeExamples.Add (label); - //bar = new MenuBarv2 + //bar = new MenuBar //{ // Id = "menuBar", // X = Pos.Right (label), @@ -98,7 +98,7 @@ public class Bars : Scenario Width = Dim.Fill () - Dim.Width (eventLog), Height = Dim.Percent (33), }; - Application.Top.Add (menuLikeExamples); + Application.TopRunnableView.Add (menuLikeExamples); label = new Label () { @@ -128,7 +128,7 @@ public class Bars : Scenario }; menuLikeExamples.Add (label); - bar = new Menuv2 + bar = new Menu { Id = "menu", X = Pos.Left (label), @@ -147,7 +147,7 @@ public class Bars : Scenario }; menuLikeExamples.Add (label); - Menuv2 popOverMenu = new Menuv2 + Menu popOverMenu = new Menu { Id = "popupMenu", X = Pos.Left (label), @@ -212,7 +212,7 @@ public class Bars : Scenario Width = Dim.Width (menuLikeExamples), Height = Dim.Percent (33), }; - Application.Top.Add (statusBarLikeExamples); + Application.TopRunnableView.Add (statusBarLikeExamples); label = new Label () { @@ -249,7 +249,7 @@ public class Bars : Scenario ConfigStatusBar (bar); statusBarLikeExamples.Add (bar); - foreach (FrameView frameView in Application.Top.SubViews.Where (f => f is FrameView)!) + foreach (FrameView frameView in Application.TopRunnableView.SubViews.Where (f => f is FrameView)!) { foreach (Bar barView in frameView.SubViews.Where (b => b is Bar)!) { @@ -269,8 +269,8 @@ public class Bars : Scenario //private void SetupContentMenu () //{ - // Application.Top.Add (new Label { Text = "Right Click for Context Menu", X = Pos.Center (), Y = 4 }); - // Application.Top.MouseClick += ShowContextMenu; + // Application.TopRunnable.Add (new Label { Text = "Right Click for Context Menu", X = Pos.Center (), Y = 4 }); + // Application.TopRunnable.MouseClick += ShowContextMenu; //} //private void ShowContextMenu (object s, MouseEventEventArgs e) @@ -309,7 +309,7 @@ public class Bars : Scenario // new TimeSpan (0), // () => // { - // MessageBox.Query ("File", "New"); + // MessageBox.Query (App, "File", "New"); // return false; // }); @@ -331,7 +331,7 @@ public class Bars : Scenario // new TimeSpan (0), // () => // { - // MessageBox.Query ("File", "Open"); + // MessageBox.Query (App, "File", "Open"); // return false; // }); @@ -353,7 +353,7 @@ public class Bars : Scenario // new TimeSpan (0), // () => // { - // MessageBox.Query ("File", "Save"); + // MessageBox.Query (App, "File", "Save"); // return false; // }); @@ -375,7 +375,7 @@ public class Bars : Scenario // new TimeSpan (0), // () => // { - // MessageBox.Query ("File", "Save As"); + // MessageBox.Query (App, "File", "Save As"); // return false; // }); @@ -383,7 +383,7 @@ public class Bars : Scenario // contextMenu.Add (newMenu, open, save, saveAs); - // contextMenu.KeyBindings.Add (Key.Esc, Command.QuitToplevel); + // contextMenu.KeyBindings.Add (Key.Esc, Command.Quit); // contextMenu.Initialized += Menu_Initialized; @@ -555,7 +555,7 @@ public class Bars : Scenario return; - void Button_Clicked (object sender, EventArgs e) { MessageBox.Query ("Hi", $"You clicked {sender}"); } + void Button_Clicked (object sender, EventArgs e) { MessageBox.Query ((sender as View)?.App, "Hi", $"You clicked {sender}"); } } diff --git a/Examples/UICatalog/Scenarios/Buttons.cs b/Examples/UICatalog/Scenarios/Buttons.cs index f2ea4572f..f0078564a 100644 --- a/Examples/UICatalog/Scenarios/Buttons.cs +++ b/Examples/UICatalog/Scenarios/Buttons.cs @@ -59,7 +59,7 @@ public class Buttons : Scenario if (e.Handled) { - MessageBox.ErrorQuery ("Error", "This button is no longer the Quit button; the Swap Default button is.", "_Ok"); + MessageBox.ErrorQuery ((s as View)?.App, "Error", "This button is no longer the Quit button; the Swap Default button is.", "_Ok"); } }; main.Add (swapButton); @@ -69,7 +69,7 @@ public class Buttons : Scenario button.Accepting += (s, e) => { string btnText = button.Text; - MessageBox.Query ("Message", $"Did you click {txt}?", "Yes", "No"); + MessageBox.Query ((s as View)?.App, "Message", $"Did you click {txt}?", "Yes", "No"); e.Handled = true; }; } @@ -112,7 +112,7 @@ public class Buttons : Scenario ); button.Accepting += (s, e) => { - MessageBox.Query ("Message", "Question?", "Yes", "No"); + MessageBox.Query ((s as View)?.App, "Message", "Question?", "Yes", "No"); e.Handled = true; }; @@ -294,7 +294,7 @@ public class Buttons : Scenario X = 2, Y = Pos.Bottom (osAlignment) + 1, Width = Dim.Width (computedFrame) - 2, - SchemeName = "TopLevel", + SchemeName = "Runnable", Text = mhkb }; moveHotKeyBtn.Accepting += (s, e) => @@ -311,7 +311,7 @@ public class Buttons : Scenario X = Pos.Left (absoluteFrame) + 1, Y = Pos.Bottom (osAlignment) + 1, Width = Dim.Width (absoluteFrame) - 2, - SchemeName = "TopLevel", + SchemeName = "Runnable", Text = muhkb }; moveUnicodeHotKeyBtn.Accepting += (s, e) => diff --git a/Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs b/Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs index 3028eb4ee..fba9130e3 100644 --- a/Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs +++ b/Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs @@ -176,13 +176,13 @@ public class CharacterMap : Scenario top.Add (_categoryList); - var menu = new MenuBarv2 + var menu = new MenuBar { Menus = [ new ( "_File", - new MenuItemv2 [] + new MenuItem [] { new ( "_Quit", @@ -337,14 +337,14 @@ public class CharacterMap : Scenario ); } - private MenuItemv2 CreateMenuShowWidth () + private MenuItem CreateMenuShowWidth () { CheckBox cb = new () { Title = "_Show Glyph Width", CheckedState = _charMap!.ShowGlyphWidths ? CheckState.Checked : CheckState.None }; - var item = new MenuItemv2 { CommandView = cb }; + var item = new MenuItem { CommandView = cb }; item.Action += () => { @@ -357,7 +357,7 @@ public class CharacterMap : Scenario return item; } - private MenuItemv2 CreateMenuUnicodeCategorySelector () + private MenuItem CreateMenuUnicodeCategorySelector () { // First option is "All" (no filter), followed by all UnicodeCategory names string [] allCategoryNames = Enum.GetNames (); diff --git a/Examples/UICatalog/Scenarios/ChineseUI.cs b/Examples/UICatalog/Scenarios/ChineseUI.cs index cc80c7ea9..26545dc8b 100644 --- a/Examples/UICatalog/Scenarios/ChineseUI.cs +++ b/Examples/UICatalog/Scenarios/ChineseUI.cs @@ -32,8 +32,9 @@ public class ChineseUI : Scenario btn.Accepting += (s, e) => { - int result = MessageBox.Query ( - "Confirm", + int? result = MessageBox.Query ( + (s as View)?.App, + "Confirm", "Are you sure you want to quit ui?", 0, "Yes", diff --git a/Examples/UICatalog/Scenarios/ClassExplorer.cs b/Examples/UICatalog/Scenarios/ClassExplorer.cs index efcb0ceeb..14c87e387 100644 --- a/Examples/UICatalog/Scenarios/ClassExplorer.cs +++ b/Examples/UICatalog/Scenarios/ClassExplorer.cs @@ -1,6 +1,5 @@ -using System; -using System.Collections.Generic; -using System.Linq; +#nullable enable + using System.Reflection; using System.Text; @@ -11,63 +10,45 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("TreeView")] public class ClassExplorer : Scenario { - private MenuItem _highlightModelTextOnly; - private MenuItem _miShowPrivate; - private TextView _textView; - private TreeView _treeView; + private CheckBox? _highlightModelTextOnlyCheckBox; + private CheckBox? _showPrivateCheckBox; + private TextView? _textView; + private TreeView? _treeView; public override void Main () { Application.Init (); - var top = new Toplevel (); - var menu = new MenuBar - { - Menus = - [ - new MenuBarItem ("_File", new MenuItem [] { new ("_Quit", "", () => Quit ()) }), - new MenuBarItem ( - "_View", - new [] - { - _miShowPrivate = - new MenuItem ( - "_Include Private", - "", - () => ShowPrivate () - ) { Checked = false, CheckType = MenuItemCheckStyle.Checked }, - new ("_Expand All", "", () => _treeView.ExpandAll ()), - new ("_Collapse All", "", () => _treeView.CollapseAll ()) - } - ), - new MenuBarItem ( - "_Style", - new [] - { - _highlightModelTextOnly = new MenuItem ( - "_Highlight Model Text Only", - "", - () => OnCheckHighlightModelTextOnly () - ) { CheckType = MenuItemCheckStyle.Checked } - } - ) - ] - }; - top.Add (menu); - - var win = new Window + Window win = new () { Title = GetName (), - Y = Pos.Bottom (menu) + BorderStyle = LineStyle.None }; - _treeView = new TreeView { X = 0, Y = 1, Width = Dim.Percent (50), Height = Dim.Fill () }; + // MenuBar + MenuBar menuBar = new (); - var lblSearch = new Label { Text = "Search" }; - var tfSearch = new TextField { Width = 20, X = Pos.Right (lblSearch) }; + // Search controls + Label lblSearch = new () + { + Y = Pos.Bottom (menuBar), + Title = "Search:" + }; - win.Add (lblSearch); - win.Add (tfSearch); + TextField tfSearch = new () + { + Y = Pos.Top (lblSearch), + X = Pos.Right (lblSearch) + 1, + Width = 20 + }; + + // TreeView + _treeView = new () + { + Y = Pos.Bottom (lblSearch), + Width = Dim.Percent (50), + Height = Dim.Fill () + }; TreeViewTextFilter filter = new (_treeView); _treeView.Filter = filter; @@ -76,7 +57,7 @@ public class ClassExplorer : Scenario { filter.Text = tfSearch.Text; - if (_treeView.SelectedObject != null) + if (_treeView.SelectedObject is { }) { _treeView.EnsureVisible (_treeView.SelectedObject); } @@ -87,111 +68,146 @@ public class ClassExplorer : Scenario _treeView.TreeBuilder = new DelegateTreeBuilder (ChildGetter, CanExpand); _treeView.SelectionChanged += TreeView_SelectionChanged; - win.Add (_treeView); + // TextView for details + _textView = new () + { + X = Pos.Right (_treeView), + Y = Pos.Top (_treeView), + Width = Dim.Fill (), + Height = Dim.Fill (), + ReadOnly = true, + }; - _textView = new TextView { X = Pos.Right (_treeView), Y = 0, Width = Dim.Fill (), Height = Dim.Fill () }; + // Menu setup + _showPrivateCheckBox = new () + { + Title = "_Include Private" + }; + _showPrivateCheckBox.CheckedStateChanged += (s, e) => ShowPrivate (); - win.Add (_textView); + _highlightModelTextOnlyCheckBox = new () + { + Title = "_Highlight Model Text Only" + }; + _highlightModelTextOnlyCheckBox.CheckedStateChanged += (s, e) => OnCheckHighlightModelTextOnly (); - top.Add (win); + menuBar.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem + { + Title = "_Quit", + Action = Quit + } + ] + ) + ); - Application.Run (top); - top.Dispose (); + menuBar.Add ( + new MenuBarItem ( + "_View", + [ + new MenuItem + { + CommandView = _showPrivateCheckBox + }, + new MenuItem + { + Title = "_Expand All", + Action = () => _treeView?.ExpandAll () + }, + new MenuItem + { + Title = "_Collapse All", + Action = () => _treeView?.CollapseAll () + } + ] + ) + ); + + menuBar.Add ( + new MenuBarItem ( + "_Style", + [ + new MenuItem + { + CommandView = _highlightModelTextOnlyCheckBox + } + ] + ) + ); + + // Add views in order of visual appearance + win.Add (menuBar, lblSearch, tfSearch, _treeView, _textView); + + Application.Run (win); + win.Dispose (); Application.Shutdown (); } - private bool CanExpand (object arg) { return arg is Assembly || arg is Type || arg is ShowForType; } + private bool CanExpand (object arg) => arg is Assembly or Type or ShowForType; private IEnumerable ChildGetter (object arg) { try { - if (arg is Assembly a) - { - return a.GetTypes (); - } - - if (arg is Type t) - { - // Note that here we cannot simply return the enum values as the same object cannot appear under multiple branches - return Enum.GetValues (typeof (Showable)) - .Cast () - - // Although we new the Type every time the delegate is called state is preserved because the class has appropriate equality members - .Select (v => new ShowForType (v, t)); - } - - if (arg is ShowForType show) - { - switch (show.ToShow) - { - case Showable.Properties: - return show.Type.GetProperties (GetFlags ()); - case Showable.Constructors: - return show.Type.GetConstructors (GetFlags ()); - case Showable.Events: - return show.Type.GetEvents (GetFlags ()); - case Showable.Fields: - return show.Type.GetFields (GetFlags ()); - case Showable.Methods: - return show.Type.GetMethods (GetFlags ()); - } - } + return arg switch + { + Assembly assembly => assembly.GetTypes (), + Type type => Enum.GetValues (typeof (Showable)) + .Cast () + .Select (v => new ShowForType (v, type)), + ShowForType show => show.ToShow switch + { + Showable.Properties => show.Type.GetProperties (GetFlags ()), + Showable.Constructors => show.Type.GetConstructors (GetFlags ()), + Showable.Events => show.Type.GetEvents (GetFlags ()), + Showable.Fields => show.Type.GetFields (GetFlags ()), + Showable.Methods => show.Type.GetMethods (GetFlags ()), + _ => Enumerable.Empty () + }, + _ => Enumerable.Empty () + }; } catch (Exception) { return Enumerable.Empty (); } - - return Enumerable.Empty (); } - private BindingFlags GetFlags () - { - if (_miShowPrivate.Checked == true) - { - return BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic; - } - - return BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public; - } + private BindingFlags GetFlags () => + _showPrivateCheckBox?.CheckedState == CheckState.Checked + ? BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic + : BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public; private string GetRepresentation (object model) { try { - if (model is Assembly ass) - { - return ass.GetName ().Name; - } - - if (model is PropertyInfo p) - { - return p.Name; - } - - if (model is FieldInfo f) - { - return f.Name; - } - - if (model is EventInfo ei) - { - return ei.Name; - } + return model switch + { + Assembly assembly => assembly.GetName ().Name ?? string.Empty, + PropertyInfo propertyInfo => propertyInfo.Name, + FieldInfo fieldInfo => fieldInfo.Name, + EventInfo eventInfo => eventInfo.Name, + _ => model.ToString () ?? string.Empty + }; } catch (Exception ex) { return ex.Message; } - - return model.ToString (); } private void OnCheckHighlightModelTextOnly () { - _treeView.Style.HighlightModelTextOnly = !_treeView.Style.HighlightModelTextOnly; - _highlightModelTextOnly.Checked = _treeView.Style.HighlightModelTextOnly; + if (_treeView is null) + { + return; + } + + _treeView.Style.HighlightModelTextOnly = _highlightModelTextOnlyCheckBox?.CheckedState == CheckState.Checked; _treeView.SetNeedsDraw (); } @@ -199,17 +215,21 @@ public class ClassExplorer : Scenario private void ShowPrivate () { - _miShowPrivate.Checked = !_miShowPrivate.Checked; - _treeView.RebuildTree (); - _treeView.SetFocus (); + _treeView?.RebuildTree (); + _treeView?.SetFocus (); } - private void TreeView_SelectionChanged (object sender, SelectionChangedEventArgs e) + private void TreeView_SelectionChanged (object? sender, SelectionChangedEventArgs e) { - object val = e.NewValue; + if (_treeView is null || _textView is null) + { + return; + } + + object? val = e.NewValue; object [] all = _treeView.GetAllSelectedObjects ().ToArray (); - if (val == null || val is ShowForType) + if (val is null or ShowForType) { return; } @@ -218,69 +238,73 @@ public class ClassExplorer : Scenario { if (all.Length > 1) { - _textView.Text = all.Length + " Objects"; + _textView.Text = $"{all.Length} Objects"; } else { - var sb = new StringBuilder (); + StringBuilder sb = new (); - // tell the user about the currently selected tree node - sb.AppendLine (e.NewValue.GetType ().Name); + sb.AppendLine (e.NewValue?.GetType ().Name ?? string.Empty); - if (val is Assembly ass) + switch (val) { - sb.AppendLine ($"Location:{ass.Location}"); - sb.AppendLine ($"FullName:{ass.FullName}"); - } + case Assembly assembly: + sb.AppendLine ($"Location:{assembly.Location}"); + sb.AppendLine ($"FullName:{assembly.FullName}"); - if (val is PropertyInfo p) - { - sb.AppendLine ($"Name:{p.Name}"); - sb.AppendLine ($"Type:{p.PropertyType}"); - sb.AppendLine ($"CanWrite:{p.CanWrite}"); - sb.AppendLine ($"CanRead:{p.CanRead}"); - } + break; - if (val is FieldInfo f) - { - sb.AppendLine ($"Name:{f.Name}"); - sb.AppendLine ($"Type:{f.FieldType}"); - } + case PropertyInfo propertyInfo: + sb.AppendLine ($"Name:{propertyInfo.Name}"); + sb.AppendLine ($"Type:{propertyInfo.PropertyType}"); + sb.AppendLine ($"CanWrite:{propertyInfo.CanWrite}"); + sb.AppendLine ($"CanRead:{propertyInfo.CanRead}"); - if (val is EventInfo ev) - { - sb.AppendLine ($"Name:{ev.Name}"); - sb.AppendLine ("Parameters:"); + break; - foreach (ParameterInfo parameter in ev.EventHandlerType.GetMethod ("Invoke") - .GetParameters ()) - { - sb.AppendLine ($" {parameter.ParameterType} {parameter.Name}"); - } - } + case FieldInfo fieldInfo: + sb.AppendLine ($"Name:{fieldInfo.Name}"); + sb.AppendLine ($"Type:{fieldInfo.FieldType}"); - if (val is MethodInfo method) - { - sb.AppendLine ($"Name:{method.Name}"); - sb.AppendLine ($"IsPublic:{method.IsPublic}"); - sb.AppendLine ($"IsStatic:{method.IsStatic}"); - sb.AppendLine ($"Parameters:{(method.GetParameters ().Any () ? "" : "None")}"); + break; - foreach (ParameterInfo parameter in method.GetParameters ()) - { - sb.AppendLine ($" {parameter.ParameterType} {parameter.Name}"); - } - } + case EventInfo eventInfo: + sb.AppendLine ($"Name:{eventInfo.Name}"); + sb.AppendLine ("Parameters:"); - if (val is ConstructorInfo ctor) - { - sb.AppendLine ($"Name:{ctor.Name}"); - sb.AppendLine ($"Parameters:{(ctor.GetParameters ().Any () ? "" : "None")}"); + if (eventInfo.EventHandlerType?.GetMethod ("Invoke") is { } invokeMethod) + { + foreach (ParameterInfo parameter in invokeMethod.GetParameters ()) + { + sb.AppendLine ($" {parameter.ParameterType} {parameter.Name}"); + } + } - foreach (ParameterInfo parameter in ctor.GetParameters ()) - { - sb.AppendLine ($" {parameter.ParameterType} {parameter.Name}"); - } + break; + + case MethodInfo methodInfo: + sb.AppendLine ($"Name:{methodInfo.Name}"); + sb.AppendLine ($"IsPublic:{methodInfo.IsPublic}"); + sb.AppendLine ($"IsStatic:{methodInfo.IsStatic}"); + sb.AppendLine ($"Parameters:{(methodInfo.GetParameters ().Length > 0 ? string.Empty : "None")}"); + + foreach (ParameterInfo parameter in methodInfo.GetParameters ()) + { + sb.AppendLine ($" {parameter.ParameterType} {parameter.Name}"); + } + + break; + + case ConstructorInfo constructorInfo: + sb.AppendLine ($"Name:{constructorInfo.Name}"); + sb.AppendLine ($"Parameters:{(constructorInfo.GetParameters ().Length > 0 ? string.Empty : "None")}"); + + foreach (ParameterInfo parameter in constructorInfo.GetParameters ()) + { + sb.AppendLine ($" {parameter.ParameterType} {parameter.Name}"); + } + + break; } _textView.Text = sb.ToString ().Replace ("\r\n", "\n"); @@ -303,7 +327,7 @@ public class ClassExplorer : Scenario Methods } - private class ShowForType + private sealed class ShowForType { public ShowForType (Showable toShow, Type type) { @@ -314,13 +338,11 @@ public class ClassExplorer : Scenario public Showable ToShow { get; } public Type Type { get; } - // Make sure to implement Equals methods on your objects if you intend to return new instances every time in ChildGetter - public override bool Equals (object obj) - { - return obj is ShowForType type && EqualityComparer.Default.Equals (Type, type.Type) && ToShow == type.ToShow; - } + public override bool Equals (object? obj) => + obj is ShowForType type && EqualityComparer.Default.Equals (Type, type.Type) && ToShow == type.ToShow; - public override int GetHashCode () { return HashCode.Combine (Type, ToShow); } - public override string ToString () { return ToShow.ToString (); } + public override int GetHashCode () => HashCode.Combine (Type, ToShow); + + public override string ToString () => ToShow.ToString (); } } diff --git a/Examples/UICatalog/Scenarios/Clipping.cs b/Examples/UICatalog/Scenarios/Clipping.cs index b9bb47528..2dcd549ed 100644 --- a/Examples/UICatalog/Scenarios/Clipping.cs +++ b/Examples/UICatalog/Scenarios/Clipping.cs @@ -118,7 +118,7 @@ public class Clipping : Scenario Height = Dim.Auto (minimumContentDim: 4), Width = Dim.Auto (minimumContentDim: 14), Title = $"Overlapped{id} _{GetNextHotKey ()}", - SchemeName = SchemeManager.SchemesToSchemeName(Schemes.Toplevel), + SchemeName = SchemeManager.SchemesToSchemeName(Schemes.Runnable), Id = $"Overlapped{id}", ShadowStyle = ShadowStyle.Transparent, BorderStyle = LineStyle.Double, diff --git a/Examples/UICatalog/Scenarios/CollectionNavigatorTester.cs b/Examples/UICatalog/Scenarios/CollectionNavigatorTester.cs index 2c2dc89ed..1516647d9 100644 --- a/Examples/UICatalog/Scenarios/CollectionNavigatorTester.cs +++ b/Examples/UICatalog/Scenarios/CollectionNavigatorTester.cs @@ -1,14 +1,13 @@ -using System; -using System.Collections.Generic; +#nullable enable + using System.Collections.ObjectModel; -using System.Linq; namespace UICatalog.Scenarios; [ScenarioMetadata ( - "Collection Navigator", - "Demonstrates keyboard navigation in ListView & TreeView (CollectionNavigator)." - )] + "Collection Navigator", + "Demonstrates keyboard navigation in ListView & TreeView (CollectionNavigator)." + )] [ScenarioCategory ("Controls")] [ScenarioCategory ("ListView")] [ScenarioCategory ("TreeView")] @@ -16,120 +15,165 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("Mouse and Keyboard")] public class CollectionNavigatorTester : Scenario { - private ObservableCollection _items = new ObservableCollection (new ObservableCollection () - { - "a", - "b", - "bb", - "c", - "ccc", - "ccc", - "cccc", - "ddd", - "dddd", - "dddd", - "ddddd", - "dddddd", - "ddddddd", - "this", - "this is a test", - "this was a test", - "this and", - "that and that", - "the", - "think", - "thunk", - "thunks", - "zip", - "zap", - "zoo", - "@jack", - "@sign", - "@at", - "@ateme", - "n@", - "n@brown", - ".net", - "$100.00", - "$101.00", - "$101.10", - "$101.11", - "$200.00", - "$210.99", - "$$", - "apricot", - "arm", - "丗丙业丞", - "丗丙丛", - "text", - "egg", - "candle", - " <- space", - "\t<- tab", - "\n<- newline", - "\r<- formfeed", - "q", - "quit", - "quitter" - }.ToList ()); + private ObservableCollection _items = new ( + [ + "a", + "b", + "bb", + "c", + "ccc", + "ccc", + "cccc", + "ddd", + "dddd", + "dddd", + "ddddd", + "dddddd", + "ddddddd", + "this", + "this is a test", + "this was a test", + "this and", + "that and that", + "the", + "think", + "thunk", + "thunks", + "zip", + "zap", + "zoo", + "@jack", + "@sign", + "@at", + "@ateme", + "n@", + "n@brown", + ".net", + "$100.00", + "$101.00", + "$101.10", + "$101.11", + "$200.00", + "$210.99", + "$$", + "apricot", + "arm", + "丗丙业丞", + "丗丙丛", + "text", + "egg", + "candle", + " <- space", + "\t<- tab", + "\n<- newline", + "\r<- formfeed", + "q", + "quit", + "quitter" + ] + ); - private Toplevel top; - private ListView _listView; - private TreeView _treeView; + private Window? _top; + private ListView? _listView; + private TreeView? _treeView; + private CheckBox? _allowMarkingCheckBox; + private CheckBox? _allowMultiSelectionCheckBox; - // Don't create a Window, just return the top-level view public override void Main () { Application.Init (); - top = new Toplevel { SchemeName = "Base" }; - var allowMarking = new MenuItem ("Allow _Marking", "", null) + Window top = new () { - CheckType = MenuItemCheckStyle.Checked, Checked = false + SchemeName = "Base" }; - allowMarking.Action = () => allowMarking.Checked = _listView.AllowsMarking = !_listView.AllowsMarking; + _top = top; - var allowMultiSelection = new MenuItem ("Allow Multi _Selection", "", null) + // MenuBar + MenuBar menu = new (); + + _allowMarkingCheckBox = new () { - CheckType = MenuItemCheckStyle.Checked, Checked = false + Title = "Allow _Marking" }; - allowMultiSelection.Action = () => - allowMultiSelection.Checked = - _listView.AllowsMultipleSelection = !_listView.AllowsMultipleSelection; - allowMultiSelection.CanExecute = () => (bool)allowMarking.Checked; + _allowMarkingCheckBox.CheckedStateChanged += (s, e) => + { + if (_listView is { }) + { + _listView.AllowsMarking = _allowMarkingCheckBox.CheckedState == CheckState.Checked; + } - var menu = new MenuBar + if (_allowMultiSelectionCheckBox is { }) + { + _allowMultiSelectionCheckBox.Enabled = _allowMarkingCheckBox.CheckedState == CheckState.Checked; + } + }; + + _allowMultiSelectionCheckBox = new () { - Menus = - [ - new MenuBarItem ( - "_Configure", - new [] - { - allowMarking, - allowMultiSelection, - null, - new ( - "_Quit", - $"{Application.QuitKey}", - () => Quit (), - null, - null, - (KeyCode)Application.QuitKey - ) - } - ), - new MenuBarItem ("_Quit", $"{Application.QuitKey}", () => Quit ()) - ] + Title = "Allow Multi _Selection", + Enabled = false }; + _allowMultiSelectionCheckBox.CheckedStateChanged += (s, e) => + { + if (_listView is { }) + { + _listView.AllowsMultipleSelection = + _allowMultiSelectionCheckBox.CheckedState == CheckState.Checked; + } + }; + + menu.Add ( + new MenuBarItem ( + "_Configure", + [ + new MenuItem + { + CommandView = _allowMarkingCheckBox + }, + new MenuItem + { + CommandView = _allowMultiSelectionCheckBox + }, + new MenuItem + { + Title = "_Quit", + Key = Application.QuitKey, + Action = Quit + } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "_Quit", + [ + new MenuItem + { + Title = "_Quit", + Key = Application.QuitKey, + Action = Quit + } + ] + ) + ); + top.Add (menu); _items = new (_items.OrderBy (i => i, StringComparer.OrdinalIgnoreCase)); CreateListView (); - var vsep = new Line { Orientation = Orientation.Vertical, X = Pos.Right (_listView), Y = 1, Height = Dim.Fill () }; + + Line vsep = new () + { + Orientation = Orientation.Vertical, + X = Pos.Right (_listView!), + Y = 1, + Height = Dim.Fill () + }; top.Add (vsep); CreateTreeView (); @@ -140,7 +184,12 @@ public class CollectionNavigatorTester : Scenario private void CreateListView () { - var label = new Label + if (_top is null) + { + return; + } + + Label label = new () { Text = "ListView", TextAlignment = Alignment.Center, @@ -149,9 +198,9 @@ public class CollectionNavigatorTester : Scenario Width = Dim.Percent (50), Height = 1 }; - top.Add (label); + _top.Add (label); - _listView = new ListView + _listView = new () { X = 0, Y = Pos.Bottom (label), @@ -160,7 +209,7 @@ public class CollectionNavigatorTester : Scenario AllowsMarking = false, AllowsMultipleSelection = false }; - top.Add (_listView); + _top.Add (_listView); _listView.SetSource (_items); @@ -169,7 +218,12 @@ public class CollectionNavigatorTester : Scenario private void CreateTreeView () { - var label = new Label + if (_top is null || _listView is null) + { + return; + } + + Label label = new () { Text = "TreeView", TextAlignment = Alignment.Center, @@ -178,23 +232,26 @@ public class CollectionNavigatorTester : Scenario Width = Dim.Percent (50), Height = 1 }; - top.Add (label); + _top.Add (label); - _treeView = new TreeView + _treeView = new () { - X = Pos.Right (_listView) + 1, Y = Pos.Bottom (label), Width = Dim.Fill (), Height = Dim.Fill () + X = Pos.Right (_listView) + 1, + Y = Pos.Bottom (label), + Width = Dim.Fill (), + Height = Dim.Fill () }; _treeView.Style.HighlightModelTextOnly = true; - top.Add (_treeView); + _top.Add (_treeView); - var root = new TreeNode ("IsLetterOrDigit examples"); + TreeNode root = new ("IsLetterOrDigit examples"); root.Children = _items.Where (i => char.IsLetterOrDigit (i [0])) .Select (i => new TreeNode (i)) .Cast () .ToList (); _treeView.AddObject (root); - root = new TreeNode ("Non-IsLetterOrDigit examples"); + root = new ("Non-IsLetterOrDigit examples"); root.Children = _items.Where (i => !char.IsLetterOrDigit (i [0])) .Select (i => new TreeNode (i)) diff --git a/Examples/UICatalog/Scenarios/ColorPicker.cs b/Examples/UICatalog/Scenarios/ColorPicker.cs index 61b71d093..69ae48660 100644 --- a/Examples/UICatalog/Scenarios/ColorPicker.cs +++ b/Examples/UICatalog/Scenarios/ColorPicker.cs @@ -3,7 +3,7 @@ using System.Collections.Generic; namespace UICatalog.Scenarios; -[ScenarioMetadata ("ColorPicker", "Color Picker.")] +[ScenarioMetadata ("ColorPicker", "Color Picker and TrueColor demonstration.")] [ScenarioCategory ("Colors")] [ScenarioCategory ("Controls")] public class ColorPickers : Scenario @@ -220,6 +220,33 @@ public class ColorPickers : Scenario }; app.Add (cbShowName); + var lblDriverName = new Label + { + Y = Pos.Bottom (cbShowName) + 1, Text = $"Driver is `{Application.Driver?.GetName ()}`:" + }; + bool canTrueColor = Application.Driver?.SupportsTrueColor ?? false; + + var cbSupportsTrueColor = new CheckBox + { + X = Pos.Right (lblDriverName) + 1, + Y = Pos.Top (lblDriverName), + CheckedState = canTrueColor ? CheckState.Checked : CheckState.UnChecked, + CanFocus = false, + Enabled = false, + Text = "SupportsTrueColor" + }; + app.Add (cbSupportsTrueColor); + + var cbUseTrueColor = new CheckBox + { + X = Pos.Right (cbSupportsTrueColor) + 1, + Y = Pos.Top (lblDriverName), + CheckedState = Application.Force16Colors ? CheckState.Checked : CheckState.UnChecked, + Enabled = canTrueColor, + Text = "Force16Colors" + }; + cbUseTrueColor.CheckedStateChanging += (_, evt) => { Application.Force16Colors = evt.Result == CheckState.Checked; }; + app.Add (lblDriverName, cbSupportsTrueColor, cbUseTrueColor); // Set default colors. foregroundColorPicker.SelectedColor = _demoView.SuperView!.GetAttributeForRole (VisualRole.Normal).Foreground.GetClosestNamedColor16 (); backgroundColorPicker.SelectedColor = _demoView.SuperView.GetAttributeForRole (VisualRole.Normal).Background.GetClosestNamedColor16 (); diff --git a/Examples/UICatalog/Scenarios/CombiningMarks.cs b/Examples/UICatalog/Scenarios/CombiningMarks.cs index 7d8437a23..4ffa787b9 100644 --- a/Examples/UICatalog/Scenarios/CombiningMarks.cs +++ b/Examples/UICatalog/Scenarios/CombiningMarks.cs @@ -8,15 +8,16 @@ public class CombiningMarks : Scenario public override void Main () { Application.Init (); - var top = new Toplevel (); + var top = new Runnable (); top.DrawComplete += (s, e) => { // Forces reset _lineColsOffset because we're dealing with direct draw - Application.Top!.SetNeedsDraw (); + Application.TopRunnableView!.SetNeedsDraw (); var i = -1; - top.AddStr ("Terminal.Gui only supports combining marks that normalize. See Issue #2616."); + top.Move (0, ++i); + top.AddStr ("Terminal.Gui supports all combining sequences that can be rendered as an unique grapheme."); top.Move (0, ++i); top.AddStr ("\u0301<- \"\\u0301\" using AddStr."); top.Move (0, ++i); @@ -38,7 +39,7 @@ public class CombiningMarks : Scenario top.AddRune ('\u0301'); top.AddRune ('\u0328'); top.AddRune (']'); - top.AddStr ("<- \"[a\\u0301\\u0301\\u0328]\" using AddRune for each."); + top.AddStr ("<- \"[a\\u0301\\u0301\\u0328]\" using AddRune for each. Avoid use AddRune for combining sequences because may result with empty blocks at end."); top.Move (0, ++i); top.AddStr ("[a\u0301\u0301\u0328]<- \"[a\\u0301\\u0301\\u0328]\" using AddStr."); top.Move (0, ++i); @@ -58,9 +59,9 @@ public class CombiningMarks : Scenario top.Move (0, ++i); top.AddStr ("From now on we are using TextFormatter"); TextFormatter tf = new () { Text = "[e\u0301\u0301\u0328]<- \"[e\\u0301\\u0301\\u0328]\" using TextFormatter." }; - tf.Draw (new (0, ++i, tf.Text.Length, 1), top.GetAttributeForRole (VisualRole.Normal), top.GetAttributeForRole (VisualRole.Normal)); + tf.Draw (driver: Application.Driver, screen: new (0, ++i, tf.Text.Length, 1), normalColor: top.GetAttributeForRole (VisualRole.Normal), hotColor: top.GetAttributeForRole (VisualRole.Normal)); tf.Text = "[e\u0328\u0301]<- \"[e\\u0328\\u0301]\" using TextFormatter."; - tf.Draw (new (0, ++i, tf.Text.Length, 1), top.GetAttributeForRole (VisualRole.Normal), top.GetAttributeForRole (VisualRole.Normal)); + tf.Draw (driver: Application.Driver, screen: new (0, ++i, tf.Text.Length, 1), normalColor: top.GetAttributeForRole (VisualRole.Normal), hotColor: top.GetAttributeForRole (VisualRole.Normal)); i++; top.Move (0, ++i); top.AddStr ("From now on we are using Surrogate pairs with combining diacritics"); @@ -82,6 +83,16 @@ public class CombiningMarks : Scenario top.AddStr ("[\U0001F468\U0001F469\U0001F9D2]<- \"[\\U0001F468\\U0001F469\\U0001F9D2]\" using AddStr."); top.Move (0, ++i); top.AddStr ("[\U0001F468\u200D\U0001F469\u200D\U0001F9D2]<- \"[\\U0001F468\\u200D\\U0001F469\\u200D\\U0001F9D2]\" using AddStr."); + top.Move (0, ++i); + top.AddStr ("[\U0001F468\u200D\U0001F469\u200D\U0001F467\u200D\U0001F466]<- \"[\\U0001F468\\u200D\\U0001F469\\u200D\\U0001F467\\u200D\\U0001F466]\" using AddStr."); + top.Move (0, ++i); + top.AddStr ("[\u0e32\u0e33]<- \"[\\u0e32\\u0e33]\" using AddStr."); + top.Move (0, ++i); + top.AddStr ("[\U0001F469\u200D\u2764\uFE0F\u200D\U0001F48B\u200D\U0001F468]<- \"[\\U0001F469\\u200D\\u2764\\uFE0F\\u200D\\U0001F48B\\u200D\\U0001F468]\" using AddStr."); + top.Move (0, ++i); + top.AddStr ("[\u0061\uFE20\u0065\uFE21]<- \"[\\u0061\\uFE20\\u0065\\uFE21]\" using AddStr."); + top.Move (0, ++i); + top.AddStr ("[\u1100\uD7B0]<- \"[\\u1100\\uD7B0]\" using AddStr."); }; Application.Run (top); diff --git a/Examples/UICatalog/Scenarios/ComboBoxIteration.cs b/Examples/UICatalog/Scenarios/ComboBoxIteration.cs index 9440f37f3..6e4cb9443 100644 --- a/Examples/UICatalog/Scenarios/ComboBoxIteration.cs +++ b/Examples/UICatalog/Scenarios/ComboBoxIteration.cs @@ -25,7 +25,7 @@ public class ComboBoxIteration : Scenario var lbComboBox = new Label { - SchemeName = "TopLevel", + SchemeName = "Runnable", X = Pos.Right (lbListView) + 1, Width = Dim.Percent (40) }; @@ -42,8 +42,8 @@ public class ComboBoxIteration : Scenario listview.SelectedItemChanged += (s, e) => { - lbListView.Text = items [e.Item]; - comboBox.SelectedItem = e.Item; + lbListView.Text = items [e.Item!.Value]; + comboBox.SelectedItem = e.Item.Value; }; comboBox.SelectedItemChanged += (sender, text) => diff --git a/Examples/UICatalog/Scenarios/ComputedLayout.cs b/Examples/UICatalog/Scenarios/ComputedLayout.cs index 6a2320f91..1cfe67fce 100644 --- a/Examples/UICatalog/Scenarios/ComputedLayout.cs +++ b/Examples/UICatalog/Scenarios/ComputedLayout.cs @@ -280,7 +280,7 @@ public class ComputedLayout : Scenario Y = Pos.Percent (50), Width = Dim.Percent (80), Height = Dim.Percent (10), - SchemeName = "TopLevel" + SchemeName = "Runnable" }; textView.Text = diff --git a/Examples/UICatalog/Scenarios/ConfigurationEditor.cs b/Examples/UICatalog/Scenarios/ConfigurationEditor.cs index a5beca9e9..5fba97bcc 100644 --- a/Examples/UICatalog/Scenarios/ConfigurationEditor.cs +++ b/Examples/UICatalog/Scenarios/ConfigurationEditor.cs @@ -60,7 +60,7 @@ public class ConfigurationEditor : Scenario win.Add (_tabView, statusBar); - win.Loaded += (s, a) => + win.IsModalChanged += (s, a) => { Open (); }; @@ -75,7 +75,7 @@ public class ConfigurationEditor : Scenario void ConfigurationManagerOnApplied (object? sender, ConfigurationManagerEventArgs e) { - Application.Top?.SetNeedsDraw (); + Application.TopRunnableView?.SetNeedsDraw (); } } public void Save () @@ -153,9 +153,9 @@ public class ConfigurationEditor : Scenario continue; } - int result = MessageBox.Query ( + int? result = MessageBox.Query (editor?.App, "Save Changes", - $"Save changes to {editor.FileInfo!.Name}", + $"Save changes to {editor?.FileInfo!.Name}", "_Yes", "_No", "_Cancel" @@ -164,7 +164,7 @@ public class ConfigurationEditor : Scenario switch (result) { case 0: - editor.Save (); + editor?.Save (); break; diff --git a/Examples/UICatalog/Scenarios/ContextMenus.cs b/Examples/UICatalog/Scenarios/ContextMenus.cs index 141392f29..4ed0f02c8 100644 --- a/Examples/UICatalog/Scenarios/ContextMenus.cs +++ b/Examples/UICatalog/Scenarios/ContextMenus.cs @@ -1,5 +1,7 @@ -using System.Globalization; +#nullable enable +using System.Globalization; using JetBrains.Annotations; +// ReSharper disable AccessToDisposedClosure namespace UICatalog.Scenarios; @@ -7,70 +9,33 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("Menus")] public class ContextMenus : Scenario { - [CanBeNull] - private PopoverMenu _winContextMenu; - private TextField _tfTopLeft, _tfTopRight, _tfMiddle, _tfBottomLeft, _tfBottomRight; - private readonly List _cultureInfos = Application.SupportedCultures; + private PopoverMenu? _winContextMenu; + private TextField? _tfTopLeft, _tfTopRight, _tfMiddle, _tfBottomLeft, _tfBottomRight; + private readonly List? _cultureInfos = Application.SupportedCultures; private readonly Key _winContextMenuKey = Key.Space.WithCtrl; + private Window? _appWindow; + public override void Main () { // Init Application.Init (); // Setup - Create a top-level application window and configure it. - Window appWindow = new () + _appWindow = new () { Title = GetQuitKeyAndName (), Arrangement = ViewArrangement.Fixed, - SchemeName = "Toplevel" + SchemeName = "Runnable" }; - var text = "Context Menu"; - var width = 20; - - CreateWinContextMenu (); - - var label = new Label - { - X = Pos.Center (), Y = 1, Text = $"Press '{_winContextMenuKey}' to open the Window context menu." - }; - appWindow.Add (label); - - label = new () - { - X = Pos.Center (), - Y = Pos.Bottom (label), - Text = $"Press '{PopoverMenu.DefaultKey}' to open the TextField context menu." - }; - appWindow.Add (label); - - _tfTopLeft = new () { Id = "_tfTopLeft", Width = width, Text = text }; - appWindow.Add (_tfTopLeft); - - _tfTopRight = new () { Id = "_tfTopRight", X = Pos.AnchorEnd (width), Width = width, Text = text }; - appWindow.Add (_tfTopRight); - - _tfMiddle = new () { Id = "_tfMiddle", X = Pos.Center (), Y = Pos.Center (), Width = width, Text = text }; - appWindow.Add (_tfMiddle); - - _tfBottomLeft = new () { Id = "_tfBottomLeft", Y = Pos.AnchorEnd (1), Width = width, Text = text }; - appWindow.Add (_tfBottomLeft); - - _tfBottomRight = new () { Id = "_tfBottomRight", X = Pos.AnchorEnd (width), Y = Pos.AnchorEnd (1), Width = width, Text = text }; - appWindow.Add (_tfBottomRight); - - appWindow.KeyDown += OnAppWindowOnKeyDown; - appWindow.MouseClick += OnAppWindowOnMouseClick; - - CultureInfo originalCulture = Thread.CurrentThread.CurrentUICulture; - appWindow.Closed += (s, e) => { Thread.CurrentThread.CurrentUICulture = originalCulture; }; + _appWindow.Initialized += AppWindowOnInitialized; // Run - Start the application. - Application.Run (appWindow); - appWindow.Dispose (); - appWindow.KeyDown -= OnAppWindowOnKeyDown; - appWindow.MouseClick -= OnAppWindowOnMouseClick; + Application.Run (_appWindow); + _appWindow.Dispose (); + _appWindow.KeyDown -= OnAppWindowOnKeyDown; + _appWindow.MouseClick -= OnAppWindowOnMouseClick; _winContextMenu?.Dispose (); // Shutdown - Calling Application.Shutdown is required. @@ -78,7 +43,55 @@ public class ContextMenus : Scenario return; - void OnAppWindowOnMouseClick (object s, MouseEventArgs e) + void AppWindowOnInitialized (object? sender, EventArgs e) + { + + var text = "Context Menu"; + var width = 20; + + CreateWinContextMenu (ApplicationImpl.Instance); + + var label = new Label + { + X = Pos.Center (), Y = 1, Text = $"Press '{_winContextMenuKey}' to open the Window context menu." + }; + _appWindow.Add (label); + + label = new () + { + X = Pos.Center (), + Y = Pos.Bottom (label), + Text = $"Press '{PopoverMenu.DefaultKey}' to open the TextField context menu." + }; + _appWindow.Add (label); + + _tfTopLeft = new () { Id = "_tfTopLeft", Width = width, Text = text }; + _appWindow.Add (_tfTopLeft); + + _tfTopRight = new () { Id = "_tfTopRight", X = Pos.AnchorEnd (width), Width = width, Text = text }; + _appWindow.Add (_tfTopRight); + + _tfMiddle = new () { Id = "_tfMiddle", X = Pos.Center (), Y = Pos.Center (), Width = width, Text = text }; + _appWindow.Add (_tfMiddle); + + _tfBottomLeft = new () { Id = "_tfBottomLeft", Y = Pos.AnchorEnd (1), Width = width, Text = text }; + _appWindow.Add (_tfBottomLeft); + + _tfBottomRight = new () { Id = "_tfBottomRight", X = Pos.AnchorEnd (width), Y = Pos.AnchorEnd (1), Width = width, Text = text }; + _appWindow.Add (_tfBottomRight); + + _appWindow.KeyDown += OnAppWindowOnKeyDown; + _appWindow.MouseClick += OnAppWindowOnMouseClick; + + CultureInfo originalCulture = Thread.CurrentThread.CurrentUICulture; + _appWindow.IsRunningChanged += (s, e) => { + if (!e.Value) + { + Thread.CurrentThread.CurrentUICulture = originalCulture; + } }; + } + + void OnAppWindowOnMouseClick (object? s, MouseEventArgs e) { if (e.Flags == MouseFlags.Button3Clicked) { @@ -88,7 +101,7 @@ public class ContextMenus : Scenario } } - void OnAppWindowOnKeyDown (object s, Key e) + void OnAppWindowOnKeyDown (object? s, Key e) { if (e == _winContextMenuKey) { @@ -99,27 +112,21 @@ public class ContextMenus : Scenario } } - private void CreateWinContextMenu () + private void CreateWinContextMenu (IApplication? app) { - if (_winContextMenu is { }) - { - _winContextMenu.Dispose (); - _winContextMenu = null; - } - _winContextMenu = new ( [ - new MenuItemv2 + new MenuItem { Title = "C_ultures", SubMenu = GetSupportedCultureMenu (), }, new Line (), - new MenuItemv2 + new MenuItem { Title = "_Configuration...", HelpText = "Show configuration", - Action = () => MessageBox.Query ( + Action = () => MessageBox.Query (app, 50, 10, "Configuration", @@ -127,17 +134,17 @@ public class ContextMenus : Scenario "Ok" ) }, - new MenuItemv2 + new MenuItem { Title = "M_ore options", SubMenu = new ( [ - new MenuItemv2 + new MenuItem { Title = "_Setup...", HelpText = "Perform setup", Action = () => MessageBox - .Query ( + .Query (app, 50, 10, "Setup", @@ -146,12 +153,12 @@ public class ContextMenus : Scenario ), Key = Key.T.WithCtrl }, - new MenuItemv2 + new MenuItem { Title = "_Maintenance...", HelpText = "Maintenance mode", Action = () => MessageBox - .Query ( + .Query (app, 50, 10, "Maintenance", @@ -162,7 +169,7 @@ public class ContextMenus : Scenario ]) }, new Line (), - new MenuItemv2 + new MenuItem { Title = "_Quit", Action = () => Application.RequestStop () @@ -171,16 +178,17 @@ public class ContextMenus : Scenario { Key = _winContextMenuKey }; + Application.Popover?.Register (_winContextMenu); } - private Menuv2 GetSupportedCultureMenu () + private Menu GetSupportedCultureMenu () { - List supportedCultures = []; + List supportedCultures = []; int index = -1; - foreach (CultureInfo c in _cultureInfos) + foreach (CultureInfo c in _cultureInfos!) { - MenuItemv2 culture = new (); + MenuItem culture = new (); culture.CommandView = new CheckBox { CanFocus = false }; @@ -211,17 +219,17 @@ public class ContextMenus : Scenario supportedCultures.Add (culture); } - Menuv2 menu = new (supportedCultures.ToArray ()); + Menu menu = new (supportedCultures.ToArray ()); return menu; - void CreateAction (List cultures, MenuItemv2 culture) + void CreateAction (List cultures, MenuItem culture) { culture.Action += () => { Thread.CurrentThread.CurrentUICulture = new (culture.HelpText); - foreach (MenuItemv2 item in cultures) + foreach (MenuItem item in cultures) { ((CheckBox)item.CommandView).CheckedState = Thread.CurrentThread.CurrentUICulture.Name == item.HelpText ? CheckState.Checked : CheckState.UnChecked; diff --git a/Examples/UICatalog/Scenarios/CsvEditor.cs b/Examples/UICatalog/Scenarios/CsvEditor.cs index 609cb4e06..aad85f6aa 100644 --- a/Examples/UICatalog/Scenarios/CsvEditor.cs +++ b/Examples/UICatalog/Scenarios/CsvEditor.cs @@ -1,8 +1,7 @@ -using System; +#nullable enable + using System.Data; using System.Globalization; -using System.IO; -using System.Linq; using System.Text.RegularExpressions; using CsvHelper; @@ -14,99 +13,37 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("Controls")] [ScenarioCategory ("Dialogs")] [ScenarioCategory ("Text and Formatting")] -[ScenarioCategory ("Dialogs")] [ScenarioCategory ("Arrangement")] [ScenarioCategory ("Files and IO")] public class CsvEditor : Scenario { - private string _currentFile; - private DataTable _currentTable; - private MenuItem _miCentered; - private MenuItem _miLeft; - private MenuItem _miRight; - private TextField _selectedCellTextField; - private TableView _tableView; + private string? _currentFile; + private DataTable? _currentTable; + private CheckBox? _miCenteredCheckBox; + private CheckBox? _miLeftCheckBox; + private CheckBox? _miRightCheckBox; + private TextField? _selectedCellTextField; + private TableView? _tableView; public override void Main () { - // Init Application.Init (); - // Setup - Create a top-level application window and configure it. - Toplevel appWindow = new () + Window appWindow = new () { - Title = $"{GetName ()}" + Title = GetName () }; - //appWindow.Height = Dim.Fill (1); // status bar + // MenuBar + MenuBar menu = new (); - _tableView = new () { X = 0, Y = 1, Width = Dim.Fill (), Height = Dim.Fill (2) }; - - var fileMenu = new MenuBarItem ( - "_File", - new MenuItem [] - { - new ("_Open CSV", "", () => Open ()), - new ("_Save", "", () => Save ()), - new ("_Quit", "Quits The App", () => Quit ()) - } - ); - - //fileMenu.Help = "Help"; - var menu = new MenuBar + _tableView = new () { - Menus = - [ - fileMenu, - new ( - "_Edit", - new MenuItem [] - { - new ("_New Column", "", () => AddColumn ()), - new ("_New Row", "", () => AddRow ()), - new ( - "_Rename Column", - "", - () => RenameColumn () - ), - new ("_Delete Column", "", () => DeleteColum ()), - new ("_Move Column", "", () => MoveColumn ()), - new ("_Move Row", "", () => MoveRow ()), - new ("_Sort Asc", "", () => Sort (true)), - new ("_Sort Desc", "", () => Sort (false)) - } - ), - new ( - "_View", - new [] - { - _miLeft = new ( - "_Align Left", - "", - () => Align (Alignment.Start) - ), - _miRight = new ( - "_Align Right", - "", - () => Align (Alignment.End) - ), - _miCentered = new ( - "_Align Centered", - "", - () => Align (Alignment.Center) - ), - - // Format requires hard typed data table, when we read a CSV everything is untyped (string) so this only works for new columns in this demo - _miCentered = new ( - "_Set Format Pattern", - "", - () => SetFormat () - ) - } - ) - ] + X = 0, + Y = Pos.Bottom (menu), + Width = Dim.Fill (), + Height = Dim.Fill (1) }; - appWindow.Add (menu); _selectedCellTextField = new () { @@ -116,57 +53,169 @@ public class CsvEditor : Scenario }; _selectedCellTextField.TextChanged += SelectedCellLabel_TextChanged; - var statusBar = new StatusBar ( - [ - new (Application.QuitKey, "Quit", Quit, "Quit!"), - new (Key.O.WithCtrl, "Open", Open, "Open a file."), - new (Key.S.WithCtrl, "Save", Save, "Save current."), - new () - { - HelpText = "Cell:", - CommandView = _selectedCellTextField, - AlignmentModes = AlignmentModes.StartToEnd | AlignmentModes.IgnoreFirstOrLast, - Enabled = false - } - ]) + // StatusBar + StatusBar statusBar = new ( + [ + new (Application.QuitKey, "Quit", Quit, "Quit!"), + new (Key.O.WithCtrl, "Open", Open, "Open a file."), + new (Key.S.WithCtrl, "Save", Save, "Save current."), + new () + { + HelpText = "Cell:", + CommandView = _selectedCellTextField, + AlignmentModes = AlignmentModes.StartToEnd | AlignmentModes.IgnoreFirstOrLast, + Enabled = false + } + ] + ) { AlignmentModes = AlignmentModes.IgnoreFirstOrLast }; - appWindow.Add (statusBar); - appWindow.Add (_tableView); + // Setup menu checkboxes for alignment + _miLeftCheckBox = new () + { + Title = "_Align Left" + }; + _miLeftCheckBox.CheckedStateChanged += (s, e) => Align (Alignment.Start); + + _miRightCheckBox = new () + { + Title = "_Align Right" + }; + _miRightCheckBox.CheckedStateChanged += (s, e) => Align (Alignment.End); + + _miCenteredCheckBox = new () + { + Title = "_Align Centered" + }; + _miCenteredCheckBox.CheckedStateChanged += (s, e) => Align (Alignment.Center); + + MenuBarItem fileMenu = new ( + "_File", + [ + new MenuItem + { + Title = "_Open CSV", + Action = Open + }, + new MenuItem + { + Title = "_Save", + Action = Save + }, + new MenuItem + { + Title = "_Quit", + HelpText = "Quits The App", + Action = Quit + } + ] + ); + + menu.Add (fileMenu); + + menu.Add ( + new MenuBarItem ( + "_Edit", + [ + new MenuItem + { + Title = "_New Column", + Action = AddColumn + }, + new MenuItem + { + Title = "_New Row", + Action = AddRow + }, + new MenuItem + { + Title = "_Rename Column", + Action = RenameColumn + }, + new MenuItem + { + Title = "_Delete Column", + Action = DeleteColum + }, + new MenuItem + { + Title = "_Move Column", + Action = MoveColumn + }, + new MenuItem + { + Title = "_Move Row", + Action = MoveRow + }, + new MenuItem + { + Title = "_Sort Asc", + Action = () => Sort (true) + }, + new MenuItem + { + Title = "_Sort Desc", + Action = () => Sort (false) + } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "_View", + [ + new MenuItem + { + CommandView = _miLeftCheckBox + }, + new MenuItem + { + CommandView = _miRightCheckBox + }, + new MenuItem + { + CommandView = _miCenteredCheckBox + }, + new MenuItem + { + Title = "_Set Format Pattern", + Action = SetFormat + } + ] + ) + ); + + appWindow.Add (menu, _tableView, statusBar); _tableView.SelectedCellChanged += OnSelectedCellChanged; _tableView.CellActivated += EditCurrentCell; _tableView.KeyDown += TableViewKeyPress; - //SetupScrollBar (); - - // Run - Start the application. Application.Run (appWindow); appWindow.Dispose (); - - // Shutdown - Calling Application.Shutdown is required. Application.Shutdown (); } private void AddColumn () { - if (NoTableLoaded ()) + if (NoTableLoaded () || _tableView is null || _currentTable is null) { return; } if (GetText ("Enter column name", "Name:", "", out string colName)) { - var col = new DataColumn (colName); + DataColumn col = new (colName); int newColIdx = Math.Min ( Math.Max (0, _tableView.SelectedColumn + 1), _tableView.Table.Columns ); - int result = MessageBox.Query ( + int? result = MessageBox.Query (ApplicationImpl.Instance, "Column Type", "Pick a data type for the column", "Date", @@ -176,7 +225,7 @@ public class CsvEditor : Scenario "Cancel" ); - if (result <= -1 || result >= 4) + if (result is null || result >= 4) { return; } @@ -209,7 +258,7 @@ public class CsvEditor : Scenario private void AddRow () { - if (NoTableLoaded ()) + if (NoTableLoaded () || _currentTable is null || _tableView is null) { return; } @@ -224,7 +273,7 @@ public class CsvEditor : Scenario private void Align (Alignment newAlignment) { - if (NoTableLoaded ()) + if (NoTableLoaded () || _tableView is null) { return; } @@ -232,31 +281,34 @@ public class CsvEditor : Scenario ColumnStyle style = _tableView.Style.GetOrCreateColumnStyle (_tableView.SelectedColumn); style.Alignment = newAlignment; - _miLeft.Checked = style.Alignment == Alignment.Start; - _miRight.Checked = style.Alignment == Alignment.End; - _miCentered.Checked = style.Alignment == Alignment.Center; + if (_miLeftCheckBox is { }) + { + _miLeftCheckBox.CheckedState = style.Alignment == Alignment.Start ? CheckState.Checked : CheckState.UnChecked; + } + + if (_miRightCheckBox is { }) + { + _miRightCheckBox.CheckedState = style.Alignment == Alignment.End ? CheckState.Checked : CheckState.UnChecked; + } + + if (_miCenteredCheckBox is { }) + { + _miCenteredCheckBox.CheckedState = style.Alignment == Alignment.Center ? CheckState.Checked : CheckState.UnChecked; + } _tableView.Update (); } - private void ClearColumnStyles () - { - _tableView.Style.ColumnStyles.Clear (); - _tableView.Update (); - } - - private void CloseExample () { _tableView.Table = null; } - private void DeleteColum () { - if (NoTableLoaded ()) + if (NoTableLoaded () || _tableView is null || _currentTable is null) { return; } if (_tableView.SelectedColumn == -1) { - MessageBox.ErrorQuery ("No Column", "No column selected", "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "No Column", "No column selected", "Ok"); return; } @@ -268,20 +320,20 @@ public class CsvEditor : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery ("Could not remove column", ex.Message, "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Could not remove column", ex.Message, "Ok"); } } - private void EditCurrentCell (object sender, CellActivatedEventArgs e) + private void EditCurrentCell (object? sender, CellActivatedEventArgs e) { - if (e.Table == null) + if (e.Table is null || _currentTable is null || _tableView is null) { return; } var oldValue = _currentTable.Rows [e.Row] [e.Col].ToString (); - if (GetText ("Enter new value", _currentTable.Columns [e.Col].ColumnName, oldValue, out string newText)) + if (GetText ("Enter new value", _currentTable.Columns [e.Col].ColumnName, oldValue ?? "", out string newText)) { try { @@ -290,7 +342,7 @@ public class CsvEditor : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery (60, 20, "Failed to set text", ex.Message, "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, 60, 20, "Failed to set text", ex.Message, "Ok"); } _tableView.Update (); @@ -301,20 +353,20 @@ public class CsvEditor : Scenario { var okPressed = false; - var ok = new Button { Text = "Ok", IsDefault = true }; + Button ok = new () { Text = "Ok", IsDefault = true }; ok.Accepting += (s, e) => - { - okPressed = true; - Application.RequestStop (); - }; - var cancel = new Button { Text = "Cancel" }; + { + okPressed = true; + Application.RequestStop (); + }; + Button cancel = new () { Text = "Cancel" }; cancel.Accepting += (s, e) => { Application.RequestStop (); }; - var d = new Dialog { Title = title, Buttons = [ok, cancel] }; + Dialog d = new () { Title = title, Buttons = [ok, cancel] }; - var lbl = new Label { X = 0, Y = 1, Text = label }; + Label lbl = new () { X = 0, Y = 1, Text = label }; - var tf = new TextField { Text = initialText, X = 0, Y = 2, Width = Dim.Fill () }; + TextField tf = new () { Text = initialText, X = 0, Y = 2, Width = Dim.Fill () }; d.Add (lbl, tf); tf.SetFocus (); @@ -322,21 +374,21 @@ public class CsvEditor : Scenario Application.Run (d); d.Dispose (); - enteredText = okPressed ? tf.Text : null; + enteredText = okPressed ? tf.Text : string.Empty; return okPressed; } private void MoveColumn () { - if (NoTableLoaded ()) + if (NoTableLoaded () || _currentTable is null || _tableView is null) { return; } if (_tableView.SelectedColumn == -1) { - MessageBox.ErrorQuery ("No Column", "No column selected", "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "No Column", "No column selected", "Ok"); return; } @@ -361,20 +413,20 @@ public class CsvEditor : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery ("Error moving column", ex.Message, "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Error moving column", ex.Message, "Ok"); } } private void MoveRow () { - if (NoTableLoaded ()) + if (NoTableLoaded () || _currentTable is null || _tableView is null) { return; } if (_tableView.SelectedRow == -1) { - MessageBox.ErrorQuery ("No Rows", "No row selected", "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "No Rows", "No row selected", "Ok"); return; } @@ -394,7 +446,7 @@ public class CsvEditor : Scenario return; } - object [] arrayItems = currentRow.ItemArray; + object? [] arrayItems = currentRow.ItemArray; _currentTable.Rows.Remove (currentRow); // Removing and Inserting the same DataRow seems to result in it loosing its values so we have to create a new instance @@ -410,15 +462,15 @@ public class CsvEditor : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery ("Error moving column", ex.Message, "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Error moving column", ex.Message, "Ok"); } } private bool NoTableLoaded () { - if (_tableView.Table == null) + if (_tableView?.Table is null) { - MessageBox.ErrorQuery ("No Table Loaded", "No table has currently be opened", "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "No Table Loaded", "No table has currently be opened", "Ok"); return true; } @@ -426,31 +478,47 @@ public class CsvEditor : Scenario return false; } - private void OnSelectedCellChanged (object sender, SelectedCellChangedEventArgs e) + private void OnSelectedCellChanged (object? sender, SelectedCellChangedEventArgs e) { + if (_selectedCellTextField is null || _tableView is null) + { + return; + } + // only update the text box if the user is not manually editing it if (!_selectedCellTextField.HasFocus) { _selectedCellTextField.Text = $"{_tableView.SelectedRow},{_tableView.SelectedColumn}"; } - if (_tableView.Table == null || _tableView.SelectedColumn == -1) + if (_tableView.Table is null || _tableView.SelectedColumn == -1) { return; } - ColumnStyle style = _tableView.Style.GetColumnStyleIfAny (_tableView.SelectedColumn); + ColumnStyle? style = _tableView.Style.GetColumnStyleIfAny (_tableView.SelectedColumn); - _miLeft.Checked = style?.Alignment == Alignment.Start; - _miRight.Checked = style?.Alignment == Alignment.End; - _miCentered.Checked = style?.Alignment == Alignment.Center; + if (_miLeftCheckBox is { }) + { + _miLeftCheckBox.CheckedState = style?.Alignment == Alignment.Start ? CheckState.Checked : CheckState.UnChecked; + } + + if (_miRightCheckBox is { }) + { + _miRightCheckBox.CheckedState = style?.Alignment == Alignment.End ? CheckState.Checked : CheckState.UnChecked; + } + + if (_miCenteredCheckBox is { }) + { + _miCenteredCheckBox.CheckedState = style?.Alignment == Alignment.Center ? CheckState.Checked : CheckState.UnChecked; + } } private void Open () { - var ofd = new FileDialog + FileDialog ofd = new () { - AllowedTypes = new () { new AllowedType ("Comma Separated Values", ".csv") } + AllowedTypes = [new AllowedType ("Comma Separated Values", ".csv")] }; ofd.Style.OkButtonText = "Open"; @@ -471,13 +539,13 @@ public class CsvEditor : Scenario try { - using var reader = new CsvReader (File.OpenText (filename), CultureInfo.InvariantCulture); + using CsvReader reader = new (File.OpenText (filename), CultureInfo.InvariantCulture); - var dt = new DataTable (); + DataTable dt = new (); reader.Read (); - if (reader.ReadHeader ()) + if (reader.ReadHeader () && reader.HeaderRecord is { }) { foreach (string h in reader.HeaderRecord) { @@ -501,12 +569,20 @@ public class CsvEditor : Scenario // Only set the current filename if we successfully loaded the entire file _currentFile = filename; - _selectedCellTextField.SuperView.Enabled = true; - Application.Top.Title = $"{GetName ()} - {Path.GetFileName (_currentFile)}"; + + if (_selectedCellTextField?.SuperView is { }) + { + _selectedCellTextField.SuperView.Enabled = true; + } + + if (Application.TopRunnableView is { }) + { + Application.TopRunnableView.Title = $"{GetName ()} - {Path.GetFileName (_currentFile)}"; + } } catch (Exception ex) { - MessageBox.ErrorQuery ( + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Open Failed", $"Error on line {lineNumber}{Environment.NewLine}{ex.Message}", "Ok" @@ -518,7 +594,7 @@ public class CsvEditor : Scenario private void RenameColumn () { - if (NoTableLoaded ()) + if (NoTableLoaded () || _currentTable is null || _tableView is null) { return; } @@ -534,17 +610,17 @@ public class CsvEditor : Scenario private void Save () { - if (_tableView.Table == null || string.IsNullOrWhiteSpace (_currentFile)) + if (_tableView?.Table is null || string.IsNullOrWhiteSpace (_currentFile) || _currentTable is null) { - MessageBox.ErrorQuery ("No file loaded", "No file is currently loaded", "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "No file loaded", "No file is currently loaded", "Ok"); return; } - using var writer = new CsvWriter ( - new StreamWriter (File.OpenWrite (_currentFile)), - CultureInfo.InvariantCulture - ); + using CsvWriter writer = new ( + new StreamWriter (File.OpenWrite (_currentFile)), + CultureInfo.InvariantCulture + ); foreach (string col in _currentTable.Columns.Cast ().Select (c => c.ColumnName)) { @@ -555,7 +631,7 @@ public class CsvEditor : Scenario foreach (DataRow row in _currentTable.Rows) { - foreach (object item in row.ItemArray) + foreach (object? item in row.ItemArray) { writer.WriteField (item); } @@ -564,8 +640,13 @@ public class CsvEditor : Scenario } } - private void SelectedCellLabel_TextChanged (object sender, EventArgs e) + private void SelectedCellLabel_TextChanged (object? sender, EventArgs e) { + if (_selectedCellTextField is null || _tableView is null) + { + return; + } + // if user is in the text control and editing the selected cell if (!_selectedCellTextField.HasFocus) { @@ -577,14 +658,14 @@ public class CsvEditor : Scenario if (match.Success) { - _tableView.SelectedColumn = int.Parse (match.Groups [1].Value); - _tableView.SelectedRow = int.Parse (match.Groups [2].Value); + _tableView.SelectedColumn = int.Parse (match.Groups [2].Value); + _tableView.SelectedRow = int.Parse (match.Groups [1].Value); } } private void SetFormat () { - if (NoTableLoaded ()) + if (NoTableLoaded () || _currentTable is null || _tableView is null) { return; } @@ -593,7 +674,7 @@ public class CsvEditor : Scenario if (col.DataType == typeof (string)) { - MessageBox.ErrorQuery ( + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Cannot Format Column", "String columns cannot be Formatted, try adding a new column to the table with a date/numerical Type", "Ok" @@ -611,53 +692,26 @@ public class CsvEditor : Scenario } } - private void SetTable (DataTable dataTable) { _tableView.Table = new DataTableSource (_currentTable = dataTable); } + private void SetTable (DataTable dataTable) + { + if (_tableView is null) + { + return; + } - //private void SetupScrollBar () - //{ - // var scrollBar = new ScrollBarView (_tableView, true); - - // scrollBar.ChangedPosition += (s, e) => - // { - // _tableView.RowOffset = scrollBar.Position; - - // if (_tableView.RowOffset != scrollBar.Position) - // { - // scrollBar.Position = _tableView.RowOffset; - // } - - // _tableView.SetNeedsDraw (); - // }; - // /* - // scrollBar.OtherScrollBarView.ChangedPosition += (s,e) => { - // tableView.LeftItem = scrollBar.OtherScrollBarView.Position; - // if (tableView.LeftItem != scrollBar.OtherScrollBarView.Position) { - // scrollBar.OtherScrollBarView.Position = tableView.LeftItem; - // } - // tableView.SetNeedsDraw (); - // };*/ - - // _tableView.DrawingContent += (s, e) => - // { - // scrollBar.Size = _tableView.Table?.Rows ?? 0; - // scrollBar.Position = _tableView.RowOffset; - - // //scrollBar.OtherScrollBarView.Size = tableView.Maxlength - 1; - // //scrollBar.OtherScrollBarView.Position = tableView.LeftItem; - // scrollBar.Refresh (); - // }; - //} + _tableView.Table = new DataTableSource (_currentTable = dataTable); + } private void Sort (bool asc) { - if (NoTableLoaded ()) + if (NoTableLoaded () || _currentTable is null || _tableView is null) { return; } if (_tableView.SelectedColumn == -1) { - MessageBox.ErrorQuery ("No Column", "No column selected", "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "No Column", "No column selected", "Ok"); return; } @@ -668,9 +722,14 @@ public class CsvEditor : Scenario SetTable (_currentTable.DefaultView.ToTable ()); } - private void TableViewKeyPress (object sender, Key e) + private void TableViewKeyPress (object? sender, Key e) { - if (e.KeyCode == KeyCode.Delete) + if (_currentTable is null || _tableView is null) + { + return; + } + + if (e.KeyCode == Key.Delete) { if (_tableView.FullRowSelect) { diff --git a/Examples/UICatalog/Scenarios/Dialogs.cs b/Examples/UICatalog/Scenarios/Dialogs.cs index e7fd1ac77..fb4a4fbd6 100644 --- a/Examples/UICatalog/Scenarios/Dialogs.cs +++ b/Examples/UICatalog/Scenarios/Dialogs.cs @@ -266,7 +266,7 @@ public class Dialogs : Scenario { Title = titleEdit.Text, Text = "Dialog Text", - ButtonAlignment = (Alignment)Enum.Parse (typeof (Alignment), alignmentGroup.Labels! [(int)alignmentGroup.Value!.Value] [1..]), + ButtonAlignment = (Alignment)Enum.Parse (typeof (Alignment), alignmentGroup.Labels! [(int)alignmentGroup.Value!.Value] [0..]), Buttons = buttons.ToArray () }; @@ -340,7 +340,13 @@ public class Dialogs : Scenario }; dialog.Add (addChar); - dialog.Closed += (s, e) => { buttonPressedLabel.Text = $"{clicked}"; }; + dialog.IsRunningChanged += (s, e) => + { + if (!e.Value) + { + buttonPressedLabel.Text = $"{clicked}"; + } + }; } catch (FormatException) { diff --git a/Examples/UICatalog/Scenarios/DynamicMenuBar.cs b/Examples/UICatalog/Scenarios/DynamicMenuBar.cs deleted file mode 100644 index 2687b4f6c..000000000 --- a/Examples/UICatalog/Scenarios/DynamicMenuBar.cs +++ /dev/null @@ -1,1413 +0,0 @@ -using System.Collections.ObjectModel; -using System.ComponentModel; -using System.Reflection; -using System.Runtime.CompilerServices; -using System.Text; - -#pragma warning disable CS0618 // Type or member is obsolete - -namespace UICatalog.Scenarios; - -[ScenarioMetadata ("Dynamic MenuBar", "Demonstrates how to change a MenuBar dynamically.")] -[ScenarioCategory ("Arrangement")] -[ScenarioCategory ("Menus")] -public class DynamicMenuBar : Scenario -{ - public override void Main () - { - // Init - Application.Init (); - - // Setup - Create a top-level application window and configure it. - DynamicMenuBarSample appWindow = new () - { - Title = GetQuitKeyAndName () - }; - - // Run - Start the application. - Application.Run (appWindow); - appWindow.Dispose (); - - // Shutdown - Calling Application.Shutdown is required. - Application.Shutdown (); - } - - public class Binding - { - private readonly PropertyInfo _sourceBindingProperty; - private readonly object _sourceDataContext; - private readonly IValueConverter _valueConverter; - - public Binding ( - View source, - string sourcePropertyName, - View target, - string targetPropertyName, - IValueConverter valueConverter = null - ) - { - Target = target; - Source = source; - SourcePropertyName = sourcePropertyName; - TargetPropertyName = targetPropertyName; - _sourceDataContext = Source.GetType ().GetProperty ("DataContext").GetValue (Source); - _sourceBindingProperty = _sourceDataContext.GetType ().GetProperty (SourcePropertyName); - _valueConverter = valueConverter; - UpdateTarget (); - - var notifier = (INotifyPropertyChanged)_sourceDataContext; - - if (notifier != null) - { - notifier.PropertyChanged += (s, e) => - { - if (e.PropertyName == SourcePropertyName) - { - UpdateTarget (); - } - }; - } - } - - public View Source { get; } - public string SourcePropertyName { get; } - public View Target { get; } - public string TargetPropertyName { get; } - - private void UpdateTarget () - { - try - { - object sourceValue = _sourceBindingProperty.GetValue (_sourceDataContext); - - if (sourceValue == null) - { - return; - } - - object finalValue = _valueConverter?.Convert (sourceValue) ?? sourceValue; - - PropertyInfo targetProperty = Target.GetType ().GetProperty (TargetPropertyName); - targetProperty.SetValue (Target, finalValue); - } - catch (Exception ex) - { - MessageBox.ErrorQuery ("Binding Error", $"Binding failed: {ex}.", "Ok"); - } - } - } - - public class DynamicMenuBarDetails : FrameView - { - private bool _hasParent; - private MenuItem _menuItem; - - public DynamicMenuBarDetails (MenuItem menuItem = null, bool hasParent = false) : this () - { - _menuItem = menuItem; - _hasParent = hasParent; - Title = menuItem == null ? "Adding New Menu." : "Editing Menu."; - } - - public DynamicMenuBarDetails () - { - var lblTitle = new Label { Y = 1, Text = "Title:" }; - Add (lblTitle); - - TextTitle = new () { X = Pos.Right (lblTitle) + 2, Y = Pos.Top (lblTitle), Width = Dim.Fill () }; - Add (TextTitle); - - var lblHelp = new Label { X = Pos.Left (lblTitle), Y = Pos.Bottom (lblTitle) + 1, Text = "Help:" }; - Add (lblHelp); - - TextHelp = new () { X = Pos.Left (TextTitle), Y = Pos.Top (lblHelp), Width = Dim.Fill () }; - Add (TextHelp); - - var lblAction = new Label { X = Pos.Left (lblTitle), Y = Pos.Bottom (lblHelp) + 1, Text = "Action:" }; - Add (lblAction); - - TextAction = new () - { - X = Pos.Left (TextTitle), Y = Pos.Top (lblAction), Width = Dim.Fill (), Height = 5 - }; - Add (TextAction); - - var lblHotKey = new Label { X = Pos.Left (lblTitle), Y = Pos.Bottom (lblAction) + 5, Text = "HotKey:" }; - Add (lblHotKey); - - TextHotKey = new () - { - X = Pos.Left (TextTitle), Y = Pos.Bottom (lblAction) + 5, Width = 2, ReadOnly = true - }; - - TextHotKey.TextChanging += (s, e) => - { - if (!string.IsNullOrEmpty (e.Result) && char.IsLower (e.Result [0])) - { - e.Result = e.Result.ToUpper (); - } - }; - TextHotKey.TextChanged += (s, _) => TextHotKey.SelectAll (); - TextHotKey.SelectAll (); - Add (TextHotKey); - - CkbIsTopLevel = new () - { - X = Pos.Left (lblTitle), Y = Pos.Bottom (lblHotKey) + 1, Text = "IsTopLevel" - }; - Add (CkbIsTopLevel); - - CkbSubMenu = new () - { - X = Pos.Left (lblTitle), - Y = Pos.Bottom (CkbIsTopLevel), - CheckedState = (_menuItem == null ? !_hasParent : HasSubMenus (_menuItem)) ? CheckState.Checked : CheckState.UnChecked, - Text = "Has sub-menus" - }; - Add (CkbSubMenu); - - CkbNullCheck = new () - { - X = Pos.Left (lblTitle), Y = Pos.Bottom (CkbSubMenu), Text = "Allow null checked" - }; - Add (CkbNullCheck); - - var rChkLabels = new [] { "NoCheck", "Checked", "Radio" }; - - OsChkStyle = new () - { - X = Pos.Left (lblTitle), Y = Pos.Bottom (CkbSubMenu) + 1, Labels = rChkLabels - }; - Add (OsChkStyle); - - var lblShortcut = new Label - { - X = Pos.Right (CkbSubMenu) + 10, Y = Pos.Top (CkbSubMenu), Text = "Shortcut:" - }; - Add (lblShortcut); - - TextShortcutKey = new () - { - X = Pos.X (lblShortcut), Y = Pos.Bottom (lblShortcut), Width = Dim.Fill (), ReadOnly = true - }; - - TextShortcutKey.KeyDown += (s, e) => - { - TextShortcutKey.Text = e.ToString (); - - }; - - Add (TextShortcutKey); - - var btnShortcut = new Button - { - X = Pos.X (lblShortcut), Y = Pos.Bottom (TextShortcutKey) + 1, Text = "Clear Shortcut" - }; - btnShortcut.Accepting += (s, e) => { TextShortcutKey.Text = ""; }; - Add (btnShortcut); - - CkbIsTopLevel.CheckedStateChanging += (s, e) => - { - if ((_menuItem != null && _menuItem.Parent != null && e.Result == CheckState.Checked) - || (_menuItem == null && _hasParent && e.Result == CheckState.Checked)) - { - MessageBox.ErrorQuery ( - "Invalid IsTopLevel", - "Only menu bar can have top level menu item!", - "Ok" - ); - e.Handled = true; - - return; - } - - if (e.Result == CheckState.Checked) - { - CkbSubMenu.CheckedState = CheckState.UnChecked; - CkbSubMenu.SetNeedsDraw (); - TextHelp.Enabled = true; - TextAction.Enabled = true; - TextShortcutKey.Enabled = true; - } - else - { - if ((_menuItem == null && !_hasParent) || _menuItem.Parent == null) - { - CkbSubMenu.CheckedState = CheckState.Checked; - CkbSubMenu.SetNeedsDraw (); - TextShortcutKey.Enabled = false; - } - - TextHelp.Text = ""; - TextHelp.Enabled = false; - TextAction.Text = ""; - - TextShortcutKey.Enabled = - e.Result == CheckState.Checked && CkbSubMenu.CheckedState == CheckState.UnChecked; - } - }; - - CkbSubMenu.CheckedStateChanged += (s, e) => - { - if (e.Value == CheckState.Checked) - { - CkbIsTopLevel.CheckedState = CheckState.UnChecked; - CkbIsTopLevel.SetNeedsDraw (); - TextHelp.Text = ""; - TextHelp.Enabled = false; - TextAction.Text = ""; - TextAction.Enabled = false; - TextShortcutKey.Text = ""; - TextShortcutKey.Enabled = false; - } - else - { - if (!_hasParent) - { - CkbIsTopLevel.CheckedState = CheckState.Checked; - CkbIsTopLevel.SetNeedsDraw (); - TextShortcutKey.Enabled = true; - } - - TextHelp.Enabled = true; - TextAction.Enabled = true; - - if (_hasParent) - { - TextShortcutKey.Enabled = CkbIsTopLevel.CheckedState == CheckState.UnChecked - && e.Value == CheckState.UnChecked; - } - } - }; - - CkbNullCheck.CheckedStateChanged += (s, e) => - { - if (_menuItem != null) - { - _menuItem.AllowNullChecked = e.Value == CheckState.Checked; - } - }; - - //Add (_frmMenuDetails); - } - - public CheckBox CkbIsTopLevel { get; } - public CheckBox CkbNullCheck { get; } - public CheckBox CkbSubMenu { get; } - public OptionSelector OsChkStyle { get; } - public TextView TextAction { get; } - public TextField TextHelp { get; } - public TextField TextHotKey { get; } - public TextField TextShortcutKey { get; } - public TextField TextTitle { get; } - - public Action CreateAction (MenuItem menuItem, DynamicMenuItem item) - { - switch (menuItem.CheckType) - { - case MenuItemCheckStyle.NoCheck: - return () => MessageBox.ErrorQuery (item.Title, item.Action, "Ok"); - case MenuItemCheckStyle.Checked: - return menuItem.ToggleChecked; - case MenuItemCheckStyle.Radio: - break; - } - - return () => - { - menuItem.Checked = true; - var parent = menuItem?.Parent as MenuBarItem; - - if (parent != null) - { - MenuItem [] childrens = parent.Children; - - for (var i = 0; i < childrens.Length; i++) - { - MenuItem child = childrens [i]; - - if (child != menuItem) - { - child.Checked = false; - } - } - } - }; - } - - public void EditMenuBarItem (MenuItem menuItem) - { - if (menuItem == null) - { - _hasParent = false; - Enabled = false; - CleanEditMenuBarItem (); - - return; - } - - _hasParent = menuItem.Parent != null; - Enabled = true; - _menuItem = menuItem; - TextTitle.Text = menuItem?.Title ?? ""; - TextHelp.Text = menuItem?.Help ?? ""; - - TextAction.Text = menuItem.Action != null - ? GetTargetAction (menuItem.Action) - : string.Empty; - TextHotKey.Text = menuItem?.HotKey != Key.Empty ? menuItem.HotKey.ToString () : ""; - CkbIsTopLevel.CheckedState = IsTopLevel (menuItem) ? CheckState.Checked : CheckState.UnChecked; - CkbSubMenu.CheckedState = HasSubMenus (menuItem) ? CheckState.Checked : CheckState.UnChecked; - CkbNullCheck.CheckedState = menuItem.AllowNullChecked ? CheckState.Checked : CheckState.UnChecked; - TextHelp.Enabled = CkbSubMenu.CheckedState == CheckState.UnChecked; - TextAction.Enabled = CkbSubMenu.CheckedState == CheckState.UnChecked; - OsChkStyle.Value = (int)(menuItem?.CheckType ?? MenuItemCheckStyle.NoCheck); - TextShortcutKey.Text = menuItem?.ShortcutTag ?? ""; - - TextShortcutKey.Enabled = CkbIsTopLevel.CheckedState == CheckState.Checked && CkbSubMenu.CheckedState == CheckState.UnChecked - || CkbIsTopLevel.CheckedState == CheckState.UnChecked && CkbSubMenu.CheckedState == CheckState.UnChecked; - } - - public DynamicMenuItem EnterMenuItem () - { - var valid = false; - - if (_menuItem == null) - { - var m = new DynamicMenuItem (); - TextTitle.Text = m.Title; - TextHelp.Text = m.Help; - TextAction.Text = m.Action; - TextHotKey.Text = m.HotKey ?? string.Empty; - CkbIsTopLevel.CheckedState = CheckState.UnChecked; - CkbSubMenu.CheckedState = !_hasParent ? CheckState.Checked : CheckState.UnChecked; - CkbNullCheck.CheckedState = CheckState.UnChecked; - TextHelp.Enabled = _hasParent; - TextAction.Enabled = _hasParent; - TextShortcutKey.Enabled = _hasParent; - } - else - { - EditMenuBarItem (_menuItem); - } - - var btnOk = new Button { IsDefault = true, Text = "Ok" }; - - btnOk.Accepting += (s, e) => - { - if (string.IsNullOrEmpty (TextTitle.Text)) - { - MessageBox.ErrorQuery ("Invalid title", "Must enter a valid title!.", "Ok"); - } - else - { - valid = true; - Application.RequestStop (); - } - }; - var btnCancel = new Button { Text = "Cancel" }; - - btnCancel.Accepting += (s, e) => - { - TextTitle.Text = string.Empty; - Application.RequestStop (); - }; - - var dialog = new Dialog - { Title = "Enter the menu details.", Buttons = [btnOk, btnCancel], Height = Dim.Auto (DimAutoStyle.Content, 23, Application.Screen.Height) }; - - Width = Dim.Fill (); - Height = Dim.Fill () - 2; - dialog.Add (this); - TextTitle.SetFocus (); - TextTitle.CursorPosition = TextTitle.Text.Length; - Application.Run (dialog); - dialog.Dispose (); - - if (valid) - { - return new () - { - Title = TextTitle.Text, - Help = TextHelp.Text, - Action = TextAction.Text, - HotKey = TextHotKey.Text, - IsTopLevel = CkbIsTopLevel?.CheckedState == CheckState.Checked, - HasSubMenu = CkbSubMenu?.CheckedState == CheckState.Checked, - CheckStyle = OsChkStyle.Value == 0 ? MenuItemCheckStyle.NoCheck : - OsChkStyle.Value == 1 ? MenuItemCheckStyle.Checked : - MenuItemCheckStyle.Radio, - ShortcutKey = TextShortcutKey.Text, - AllowNullChecked = CkbNullCheck?.CheckedState == CheckState.Checked, - }; - } - - return null; - } - - public void UpdateParent (ref MenuItem menuItem) - { - var parent = menuItem.Parent as MenuBarItem; - int idx = parent.GetChildrenIndex (menuItem); - - if (!(menuItem is MenuBarItem)) - { - menuItem = new MenuBarItem (menuItem.Title, new MenuItem [] { }, menuItem.Parent); - - if (idx > -1) - { - parent.Children [idx] = menuItem; - } - } - else - { - menuItem = new ( - menuItem.Title, - menuItem.Help, - CreateAction (menuItem, new ()), - null, - menuItem.Parent - ); - - if (idx > -1) - { - parent.Children [idx] = menuItem; - } - } - } - - private void CleanEditMenuBarItem () - { - TextTitle.Text = ""; - TextHelp.Text = ""; - TextAction.Text = ""; - TextHotKey.Text = ""; - CkbIsTopLevel.CheckedState = CheckState.UnChecked; - CkbSubMenu.CheckedState = CheckState.UnChecked; - OsChkStyle.Value = (int)MenuItemCheckStyle.NoCheck; - TextShortcutKey.Text = ""; - } - - private string GetTargetAction (Action action) - { - object me = action.Target; - - if (me == null) - { - throw new ArgumentException (); - } - - var v = new object (); - - foreach (FieldInfo field in me.GetType ().GetFields ()) - { - if (field.Name == "item") - { - v = field.GetValue (me); - } - } - - return v == null || !(v is DynamicMenuItem item) ? string.Empty : item.Action; - } - - private bool HasSubMenus (MenuItem menuItem) - { - var menuBarItem = menuItem as MenuBarItem; - - if (menuBarItem != null && menuBarItem.Children != null && (menuBarItem.Children.Length > 0 || menuBarItem.Action == null)) - { - return true; - } - - return false; - } - - private bool IsTopLevel (MenuItem menuItem) - { - var topLevel = menuItem as MenuBarItem; - - if (topLevel != null && topLevel.Parent == null && (topLevel.Children == null || topLevel.Children.Length == 0) && topLevel.Action != null) - { - return true; - } - - return false; - } - } - - public class DynamicMenuBarSample : Window - { - private readonly ListView _lstMenus; - private MenuItem _currentEditMenuBarItem; - private MenuItem _currentMenuBarItem; - private int _currentSelectedMenuBar; - private MenuBar _menuBar; - - public DynamicMenuBarSample () - { - DataContext = new (); - - var frmDelimiter = new FrameView - { - X = Pos.Center (), - Y = 3, - Width = 25, - Height = 4, - Title = "Shortcut Delimiter:" - }; - - var txtDelimiter = new TextField - { - X = Pos.Center (), Width = 2, Text = Key.Separator.ToString () - }; - - - var frmMenu = new FrameView { Y = 7, Width = Dim.Percent (50), Height = Dim.Fill (), Title = "Menus:" }; - - var btnAddMenuBar = new Button { Y = 1, Text = "Add a MenuBar" }; - frmMenu.Add (btnAddMenuBar); - - var btnMenuBarUp = new Button { X = Pos.Center (), Text = Glyphs.UpArrow.ToString () }; - frmMenu.Add (btnMenuBarUp); - - var btnMenuBarDown = new Button { X = Pos.Center (), Y = Pos.Bottom (btnMenuBarUp), Text = Glyphs.DownArrow.ToString () }; - frmMenu.Add (btnMenuBarDown); - - var btnRemoveMenuBar = new Button { Y = 1, Text = "Remove a MenuBar" }; - - btnRemoveMenuBar.X = Pos.AnchorEnd (0) - (Pos.Right (btnRemoveMenuBar) - Pos.Left (btnRemoveMenuBar)); - frmMenu.Add (btnRemoveMenuBar); - - var btnPrevious = new Button - { - X = Pos.Left (btnAddMenuBar), Y = Pos.Top (btnAddMenuBar) + 2, Text = Glyphs.LeftArrow.ToString () - }; - frmMenu.Add (btnPrevious); - - var btnAdd = new Button { Y = Pos.Top (btnPrevious) + 2, Text = " Add " }; - btnAdd.X = Pos.AnchorEnd (); - frmMenu.Add (btnAdd); - - var btnNext = new Button { X = Pos.X (btnAdd), Y = Pos.Top (btnPrevious), Text = Glyphs.RightArrow.ToString () }; - frmMenu.Add (btnNext); - - var lblMenuBar = new Label - { - SchemeName = "Dialog", - TextAlignment = Alignment.Center, - X = Pos.Right (btnPrevious) + 1, - Y = Pos.Top (btnPrevious), - - Width = Dim.Fill () - Dim.Func (_ => btnAdd.Frame.Width + 1), - Height = 1 - }; - - lblMenuBar.TextChanged += (s, e) => - { - if (lblMenuBar.Text.Contains ("_")) - { - lblMenuBar.Text = lblMenuBar.Text.Replace ("_", ""); - } - }; - frmMenu.Add (lblMenuBar); - lblMenuBar.WantMousePositionReports = true; - lblMenuBar.CanFocus = true; - - var lblParent = new Label - { - TextAlignment = Alignment.Center, - X = Pos.Right (btnPrevious) + 1, - Y = Pos.Top (btnPrevious) + 1, - - Width = Dim.Fill () - Dim.Width (btnAdd) - 1 - }; - frmMenu.Add (lblParent); - - var btnPreviowsParent = new Button - { - X = Pos.Left (btnAddMenuBar), Y = Pos.Top (btnPrevious) + 1, Text = ".." - }; - frmMenu.Add (btnPreviowsParent); - - _lstMenus = new () - { - SchemeName = "Dialog", - X = Pos.Right (btnPrevious) + 1, - Y = Pos.Top (btnPrevious) + 2, - Width = lblMenuBar.Width, - Height = Dim.Fill (), - Source = new ListWrapper ([]) - }; - frmMenu.Add (_lstMenus); - - //lblMenuBar.TabIndex = btnPrevious.TabIndex + 1; - //_lstMenus.TabIndex = lblMenuBar.TabIndex + 1; - //btnNext.TabIndex = _lstMenus.TabIndex + 1; - //btnAdd.TabIndex = btnNext.TabIndex + 1; - - var btnRemove = new Button { X = Pos.Left (btnAdd), Y = Pos.Top (btnAdd) + 1, Text = "Remove" }; - frmMenu.Add (btnRemove); - - var btnUp = new Button { X = Pos.Right (_lstMenus) + 2, Y = Pos.Top (btnRemove) + 2, Text = Glyphs.UpArrow.ToString () }; - frmMenu.Add (btnUp); - - var btnDown = new Button { X = Pos.Right (_lstMenus) + 2, Y = Pos.Top (btnUp) + 1, Text = Glyphs.DownArrow.ToString () }; - frmMenu.Add (btnDown); - - Add (frmMenu); - - var frmMenuDetails = new DynamicMenuBarDetails - { - X = Pos.Right (frmMenu), - Y = Pos.Top (frmMenu), - Width = Dim.Fill (), - Height = Dim.Fill (2), - Title = "Menu Details:" - }; - Add (frmMenuDetails); - - btnMenuBarUp.Accepting += (s, e) => - { - int i = _currentSelectedMenuBar; - - MenuBarItem menuItem = _menuBar != null && _menuBar.Menus.Length > 0 - ? _menuBar.Menus [i] - : null; - - if (menuItem != null) - { - MenuBarItem [] menus = _menuBar.Menus; - - if (i > 0) - { - menus [i] = menus [i - 1]; - menus [i - 1] = menuItem; - _currentSelectedMenuBar = i - 1; - _menuBar.SetNeedsDraw (); - } - } - }; - - btnMenuBarDown.Accepting += (s, e) => - { - int i = _currentSelectedMenuBar; - - MenuBarItem menuItem = _menuBar != null && _menuBar.Menus.Length > 0 - ? _menuBar.Menus [i] - : null; - - if (menuItem != null) - { - MenuBarItem [] menus = _menuBar.Menus; - - if (i < menus.Length - 1) - { - menus [i] = menus [i + 1]; - menus [i + 1] = menuItem; - _currentSelectedMenuBar = i + 1; - _menuBar.SetNeedsDraw (); - } - } - }; - - btnUp.Accepting += (s, e) => - { - int i = _lstMenus.SelectedItem; - MenuItem menuItem = DataContext.Menus.Count > 0 ? DataContext.Menus [i].MenuItem : null; - - if (menuItem != null) - { - MenuItem [] childrens = ((MenuBarItem)_currentMenuBarItem).Children; - - if (i > 0) - { - childrens [i] = childrens [i - 1]; - childrens [i - 1] = menuItem; - DataContext.Menus [i] = DataContext.Menus [i - 1]; - - DataContext.Menus [i - 1] = - new () { Title = menuItem.Title, MenuItem = menuItem }; - _lstMenus.SelectedItem = i - 1; - } - } - }; - - btnDown.Accepting += (s, e) => - { - int i = _lstMenus.SelectedItem; - MenuItem menuItem = DataContext.Menus.Count > 0 ? DataContext.Menus [i].MenuItem : null; - - if (menuItem != null) - { - MenuItem [] childrens = ((MenuBarItem)_currentMenuBarItem).Children; - - if (i < childrens.Length - 1) - { - childrens [i] = childrens [i + 1]; - childrens [i + 1] = menuItem; - DataContext.Menus [i] = DataContext.Menus [i + 1]; - - DataContext.Menus [i + 1] = - new () { Title = menuItem.Title, MenuItem = menuItem }; - _lstMenus.SelectedItem = i + 1; - } - } - }; - - btnPreviowsParent.Accepting += (s, e) => - { - if (_currentMenuBarItem != null && _currentMenuBarItem.Parent != null) - { - MenuItem mi = _currentMenuBarItem; - _currentMenuBarItem = _currentMenuBarItem.Parent as MenuBarItem; - SetListViewSource (_currentMenuBarItem, true); - int i = ((MenuBarItem)_currentMenuBarItem).GetChildrenIndex (mi); - - if (i > -1) - { - _lstMenus.SelectedItem = i; - } - - if (_currentMenuBarItem.Parent != null) - { - DataContext.Parent = _currentMenuBarItem.Title; - } - else - { - DataContext.Parent = string.Empty; - } - } - else - { - DataContext.Parent = string.Empty; - } - }; - - var btnOk = new Button { X = Pos.Right (frmMenu) + 20, Y = Pos.Bottom (frmMenuDetails), Text = "Ok" }; - Add (btnOk); - - var btnCancel = new Button { X = Pos.Right (btnOk) + 3, Y = Pos.Top (btnOk), Text = "Cancel" }; - btnCancel.Accepting += (s, e) => { SetFrameDetails (_currentEditMenuBarItem); }; - Add (btnCancel); - - txtDelimiter.TextChanging += (s, e) => - { - if (!string.IsNullOrEmpty (e.Result)) - { - Key.Separator = e.Result.ToRunes () [0]; - } - else - { - e.Handled = true; - txtDelimiter.SelectAll (); - } - }; - txtDelimiter.TextChanged += (s, _) => - { - txtDelimiter.SelectAll (); - SetFrameDetails (); - }; - frmDelimiter.Add (txtDelimiter); - txtDelimiter.SelectAll (); - Add (frmDelimiter); - - _lstMenus.SelectedItemChanged += (s, e) => { SetFrameDetails (); }; - - btnOk.Accepting += (s, e) => - { - if (string.IsNullOrEmpty (frmMenuDetails.TextTitle.Text) && _currentEditMenuBarItem != null) - { - MessageBox.ErrorQuery ("Invalid title", "Must enter a valid title!.", "Ok"); - } - else if (_currentEditMenuBarItem != null) - { - var menuItem = new DynamicMenuItem - { - Title = frmMenuDetails.TextTitle.Text, - Help = frmMenuDetails.TextHelp.Text, - Action = frmMenuDetails.TextAction.Text, - HotKey = frmMenuDetails.TextHotKey.Text, - IsTopLevel = frmMenuDetails.CkbIsTopLevel?.CheckedState == CheckState.Checked, - HasSubMenu = frmMenuDetails.CkbSubMenu?.CheckedState == CheckState.Checked, - CheckStyle = frmMenuDetails.OsChkStyle.Value == 0 - ? MenuItemCheckStyle.NoCheck - : frmMenuDetails.OsChkStyle.Value == 1 - ? MenuItemCheckStyle.Checked - : MenuItemCheckStyle.Radio, - ShortcutKey = frmMenuDetails.TextShortcutKey.Text - }; - UpdateMenuItem (_currentEditMenuBarItem, menuItem, _lstMenus.SelectedItem); - } - }; - - btnAdd.Accepting += (s, e) => - { - if (MenuBar == null) - { - MessageBox.ErrorQuery ("Menu Bar Error", "Must add a MenuBar first!", "Ok"); - btnAddMenuBar.SetFocus (); - - return; - } - - var frameDetails = new DynamicMenuBarDetails (null, _currentMenuBarItem != null); - DynamicMenuItem item = frameDetails.EnterMenuItem (); - - if (item == null) - { - return; - } - - if (_currentMenuBarItem is not MenuBarItem) - { - var parent = _currentMenuBarItem.Parent as MenuBarItem; - int idx = parent.GetChildrenIndex (_currentMenuBarItem); - - _currentMenuBarItem = new MenuBarItem ( - _currentMenuBarItem.Title, - new MenuItem [] { }, - _currentMenuBarItem.Parent - ); - _currentMenuBarItem.CheckType = item.CheckStyle; - parent.Children [idx] = _currentMenuBarItem; - } - else - { - MenuItem newMenu = CreateNewMenu (item, _currentMenuBarItem); - var menuBarItem = _currentMenuBarItem as MenuBarItem; - menuBarItem.AddMenuBarItem (MenuBar, newMenu); - - - DataContext.Menus.Add (new () { Title = newMenu.Title, MenuItem = newMenu }); - _lstMenus.MoveDown (); - } - }; - - btnRemove.Accepting += (s, e) => - { - MenuItem menuItem = (DataContext.Menus.Count > 0 && _lstMenus.SelectedItem > -1 - ? DataContext.Menus [_lstMenus.SelectedItem].MenuItem - : _currentEditMenuBarItem); - - if (menuItem != null) - { - menuItem.RemoveMenuItem (); - - if (_currentEditMenuBarItem == menuItem) - { - _currentEditMenuBarItem = null; - - if (menuItem.Parent is null) - { - _currentSelectedMenuBar = Math.Max (Math.Min (_currentSelectedMenuBar, _menuBar.Menus.Length - 1), 0); - } - - SelectCurrentMenuBarItem (); - } - - if (_lstMenus.SelectedItem > -1) - { - DataContext.Menus?.RemoveAt (_lstMenus.SelectedItem); - } - - if (_lstMenus.Source.Count > 0 && _lstMenus.SelectedItem > _lstMenus.Source.Count - 1) - { - _lstMenus.SelectedItem = _lstMenus.Source.Count - 1; - } - - if (_menuBar.Menus.Length == 0) - { - RemoveMenuBar (); - } - - _lstMenus.SetNeedsDraw (); - SetFrameDetails (); - } - }; - - _lstMenus.OpenSelectedItem += (s, e) => - { - _currentMenuBarItem = DataContext.Menus [e.Item].MenuItem; - - if (!(_currentMenuBarItem is MenuBarItem)) - { - MessageBox.ErrorQuery ("Menu Open Error", "Must allows sub menus first!", "Ok"); - - return; - } - - DataContext.Parent = _currentMenuBarItem.Title; - DataContext.Menus = new (); - SetListViewSource (_currentMenuBarItem, true); - MenuItem menuBarItem = DataContext.Menus.Count > 0 ? DataContext.Menus [0].MenuItem : null; - SetFrameDetails (menuBarItem); - }; - - _lstMenus.HasFocusChanging += (s, e) => - { - MenuItem menuBarItem = _lstMenus.SelectedItem > -1 && DataContext.Menus.Count > 0 - ? DataContext.Menus [_lstMenus.SelectedItem].MenuItem - : null; - SetFrameDetails (menuBarItem); - }; - - btnNext.Accepting += (s, e) => - { - if (_menuBar != null && _currentSelectedMenuBar + 1 < _menuBar.Menus.Length) - { - _currentSelectedMenuBar++; - } - - SelectCurrentMenuBarItem (); - }; - - btnPrevious.Accepting += (s, e) => - { - if (_currentSelectedMenuBar - 1 > -1) - { - _currentSelectedMenuBar--; - } - - SelectCurrentMenuBarItem (); - }; - - lblMenuBar.HasFocusChanging += (s, e) => - { - if (_menuBar?.Menus != null) - { - _currentMenuBarItem = _menuBar.Menus [_currentSelectedMenuBar]; - SetFrameDetails (_menuBar.Menus [_currentSelectedMenuBar]); - } - }; - - btnAddMenuBar.Accepting += (s, e) => - { - var frameDetails = new DynamicMenuBarDetails (null); - DynamicMenuItem item = frameDetails.EnterMenuItem (); - - if (item == null) - { - return; - } - - if (MenuBar == null) - { - _menuBar = new (); - Add (_menuBar); - } - - var newMenu = CreateNewMenu (item) as MenuBarItem; - newMenu.AddMenuBarItem (MenuBar); - - _currentMenuBarItem = newMenu; - _currentMenuBarItem.CheckType = item.CheckStyle; - - if (Key.TryParse (item.ShortcutKey, out Key key)) - { - _currentMenuBarItem.ShortcutKey = key; - } - - _currentSelectedMenuBar = _menuBar.Menus.Length - 1; - _menuBar.Menus [_currentSelectedMenuBar] = newMenu; - lblMenuBar.Text = newMenu.Title; - SetListViewSource (_currentMenuBarItem, true); - SetFrameDetails (_menuBar.Menus [_currentSelectedMenuBar]); - _menuBar.SetNeedsDraw (); - }; - - btnRemoveMenuBar.Accepting += (s, e) => - { - if (_menuBar == null) - { - return; - } - - if (_menuBar != null && _menuBar.Menus.Length > 0) - { - _currentMenuBarItem.RemoveMenuItem (); - - - - if (_currentSelectedMenuBar - 1 >= 0 && _menuBar.Menus.Length > 0) - { - _currentSelectedMenuBar--; - } - - _currentMenuBarItem = _menuBar.Menus?.Length > 0 - ? _menuBar.Menus [_currentSelectedMenuBar] - : null; - } - - RemoveMenuBar (); - - SetListViewSource (_currentMenuBarItem, true); - SetFrameDetails (); - }; - - void RemoveMenuBar () - { - if (MenuBar != null && _currentMenuBarItem == null && _menuBar.Menus.Length == 0) - { - Remove (_menuBar); - _menuBar.Dispose (); - _menuBar = null; - DataContext.Menus = new (); - _currentMenuBarItem = null; - _currentSelectedMenuBar = -1; - lblMenuBar.Text = string.Empty; - } - else - { - lblMenuBar.Text = _menuBar.Menus [_currentSelectedMenuBar].Title; - } - } - - SetFrameDetails (); - - var ustringConverter = new UStringValueConverter (); - ListWrapperConverter listWrapperConverter = new ListWrapperConverter (); - - var bdgMenuBar = new Binding (this, "MenuBar", lblMenuBar, "Text", ustringConverter); - var bdgParent = new Binding (this, "Parent", lblParent, "Text", ustringConverter); - var bdgMenus = new Binding (this, "Menus", _lstMenus, "Source", listWrapperConverter); - - void SetFrameDetails (MenuItem menuBarItem = null) - { - MenuItem menuItem; - - if (menuBarItem == null) - { - menuItem = _lstMenus.SelectedItem > -1 && DataContext.Menus.Count > 0 - ? DataContext.Menus [_lstMenus.SelectedItem].MenuItem - : _currentEditMenuBarItem; - } - else - { - menuItem = menuBarItem; - } - - _currentEditMenuBarItem = menuItem; - frmMenuDetails.EditMenuBarItem (menuItem); - bool f = btnOk.Enabled == frmMenuDetails.Enabled; - - if (!f) - { - btnOk.Enabled = frmMenuDetails.Enabled; - btnCancel.Enabled = frmMenuDetails.Enabled; - } - } - - void SelectCurrentMenuBarItem () - { - MenuBarItem menuBarItem = null; - - if (_menuBar?.Menus is { Length: > 0 }) - { - menuBarItem = _menuBar.Menus [_currentSelectedMenuBar]; - lblMenuBar.Text = menuBarItem.Title; - } - - SetFrameDetails (menuBarItem); - _currentMenuBarItem = menuBarItem; - DataContext.Menus = new (); - SetListViewSource (_currentMenuBarItem, true); - lblParent.Text = string.Empty; - - if (_currentMenuBarItem is null) - { - lblMenuBar.Text = string.Empty; - } - } - - void SetListViewSource (MenuItem currentMenuBarItem, bool fill = false) - { - DataContext.Menus = []; - var menuBarItem = currentMenuBarItem as MenuBarItem; - - if (menuBarItem != null && menuBarItem?.Children == null) - { - return; - } - - if (!fill) - { - return; - } - - if (menuBarItem != null) - { - foreach (MenuItem child in menuBarItem?.Children) - { - var m = new DynamicMenuItemList { Title = child.Title, MenuItem = child }; - DataContext.Menus.Add (m); - } - } - } - - MenuItem CreateNewMenu (DynamicMenuItem item, MenuItem parent = null) - { - MenuItem newMenu; - - if (item.HasSubMenu) - { - newMenu = new MenuBarItem (item.Title, new MenuItem [] { }, parent); - } - else if (parent != null) - { - newMenu = new (item.Title, item.Help, null, null, parent); - newMenu.CheckType = item.CheckStyle; - newMenu.Action = frmMenuDetails.CreateAction (newMenu, item); - - if (Key.TryParse (item.ShortcutKey, out Key key)) - { - newMenu.ShortcutKey = key; - } - newMenu.AllowNullChecked = item.AllowNullChecked; - } - else if (item.IsTopLevel) - { - newMenu = new MenuBarItem (item.Title, item.Help, null); - newMenu.Action = frmMenuDetails.CreateAction (newMenu, item); - - if (Key.TryParse (item.ShortcutKey, out Key key)) - { - newMenu.ShortcutKey = key; - } - } - else - { - newMenu = new MenuBarItem (item.Title, item.Help, null); - - ((MenuBarItem)newMenu).Children [0].Action = - frmMenuDetails.CreateAction (newMenu, item); - - if (Key.TryParse (item.ShortcutKey, out Key key)) - { - ((MenuBarItem)newMenu).Children [0].ShortcutKey = key; - } - } - - return newMenu; - } - - void UpdateMenuItem (MenuItem currentEditMenuBarItem, DynamicMenuItem menuItem, int index) - { - currentEditMenuBarItem.Title = menuItem.Title; - currentEditMenuBarItem.Help = menuItem.Help; - currentEditMenuBarItem.CheckType = menuItem.CheckStyle; - - if (currentEditMenuBarItem.Parent is MenuBarItem parent - && parent.Children.Length == 1 - && currentEditMenuBarItem.CheckType == MenuItemCheckStyle.Radio) - { - currentEditMenuBarItem.Checked = true; - } - - if (menuItem.IsTopLevel && currentEditMenuBarItem is MenuBarItem) - { - ((MenuBarItem)currentEditMenuBarItem).Children = null; - - currentEditMenuBarItem.Action = - frmMenuDetails.CreateAction (currentEditMenuBarItem, menuItem); - - if (Key.TryParse (menuItem.ShortcutKey, out Key key)) - { - currentEditMenuBarItem.ShortcutKey = key; - } - - SetListViewSource (currentEditMenuBarItem, true); - } - else if (menuItem.HasSubMenu) - { - currentEditMenuBarItem.Action = null; - - if (currentEditMenuBarItem is MenuBarItem && ((MenuBarItem)currentEditMenuBarItem).Children == null) - { - ((MenuBarItem)currentEditMenuBarItem).Children = new MenuItem [] { }; - } - else if (currentEditMenuBarItem.Parent != null) - { - frmMenuDetails.UpdateParent (ref currentEditMenuBarItem); - } - else - { - currentEditMenuBarItem = - new MenuBarItem ( - currentEditMenuBarItem.Title, - new MenuItem [] { }, - currentEditMenuBarItem.Parent - ); - } - - SetListViewSource (currentEditMenuBarItem, true); - } - else if (currentEditMenuBarItem is MenuBarItem && currentEditMenuBarItem.Parent != null) - { - frmMenuDetails.UpdateParent (ref currentEditMenuBarItem); - - currentEditMenuBarItem = new ( - menuItem.Title, - menuItem.Help, - frmMenuDetails.CreateAction (currentEditMenuBarItem, menuItem), - null, - currentEditMenuBarItem.Parent - ); - } - else - { - if (currentEditMenuBarItem is MenuBarItem) - { - ((MenuBarItem)currentEditMenuBarItem).Children = null; - DataContext.Menus = new (); - } - - currentEditMenuBarItem.Action = - frmMenuDetails.CreateAction (currentEditMenuBarItem, menuItem); - - if (Key.TryParse (menuItem.ShortcutKey, out Key key)) - { - currentEditMenuBarItem.ShortcutKey = key; - } - } - - if (currentEditMenuBarItem.Parent == null) - { - DataContext.MenuBar = currentEditMenuBarItem.Title; - } - else - { - if (DataContext.Menus.Count == 0) - { - DataContext.Menus.Add ( - new () - { - Title = currentEditMenuBarItem.Title, MenuItem = currentEditMenuBarItem - } - ); - } - - DataContext.Menus [index] = - new () - { - Title = currentEditMenuBarItem.Title, MenuItem = currentEditMenuBarItem - }; - } - - currentEditMenuBarItem.CheckType = menuItem.CheckStyle; - SetFrameDetails (currentEditMenuBarItem); - } - - //_frmMenuDetails.Initialized += (s, e) => _frmMenuDetails.Enabled = false; - } - - public DynamicMenuItemModel DataContext { get; set; } - } - - public class DynamicMenuItem - { - public string Action { get; set; } = string.Empty; - public bool AllowNullChecked { get; set; } - public MenuItemCheckStyle CheckStyle { get; set; } - public bool HasSubMenu { get; set; } - public string Help { get; set; } = string.Empty; - public bool IsTopLevel { get; set; } - public string HotKey { get; set; } - public string ShortcutKey { get; set; } - public string Title { get; set; } = "_New"; - } - - public class DynamicMenuItemList - { - public MenuItem MenuItem { get; set; } - public string Title { get; set; } - public override string ToString () { return $"{Title}, {MenuItem.HotKey}, {MenuItem.ShortcutKey} "; } - } - - public class DynamicMenuItemModel : INotifyPropertyChanged - { - private string _menuBar; - private ObservableCollection _menus; - private string _parent; - public DynamicMenuItemModel () { Menus = []; } - - public string MenuBar - { - get => _menuBar; - set - { - if (value == _menuBar) - { - return; - } - - _menuBar = value; - - PropertyChanged?.Invoke ( - this, - new (GetPropertyName ()) - ); - } - } - - public ObservableCollection Menus - { - get => _menus; - set - { - if (value == _menus) - { - return; - } - - _menus = value; - - PropertyChanged?.Invoke ( - this, - new (GetPropertyName ()) - ); - } - } - - public string Parent - { - get => _parent; - set - { - if (value == _parent) - { - return; - } - - _parent = value; - - PropertyChanged?.Invoke ( - this, - new (GetPropertyName ()) - ); - } - } - - public event PropertyChangedEventHandler PropertyChanged; - public string GetPropertyName ([CallerMemberName] string propertyName = null) { return propertyName; } - } - - public interface IValueConverter - { - object Convert (object value, object parameter = null); - } - - public class ListWrapperConverter : IValueConverter - { - public object Convert (object value, object parameter = null) { return new ListWrapper ((ObservableCollection)value); } - } - - public class UStringValueConverter : IValueConverter - { - public object Convert (object value, object parameter = null) - { - byte [] data = Encoding.ASCII.GetBytes (value.ToString () ?? string.Empty); - - return StringExtensions.ToString (data); - } - } -} diff --git a/Examples/UICatalog/Scenarios/DynamicStatusBar.cs b/Examples/UICatalog/Scenarios/DynamicStatusBar.cs index de110d0c6..ac558f22a 100644 --- a/Examples/UICatalog/Scenarios/DynamicStatusBar.cs +++ b/Examples/UICatalog/Scenarios/DynamicStatusBar.cs @@ -15,7 +15,7 @@ public class DynamicStatusBar : Scenario public override void Main () { Application.Init (); - Application.Run ().Dispose (); + Application.Run (); Application.Shutdown (); } @@ -79,7 +79,7 @@ public class DynamicStatusBar : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery ("Binding Error", $"Binding failed: {ex}.", "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Binding Error", $"Binding failed: {ex}.", "Ok"); } } } @@ -140,7 +140,7 @@ public class DynamicStatusBar : Scenario public TextView TextAction { get; } public TextField TextShortcut { get; } public TextField TextTitle { get; } - public Action CreateAction (DynamicStatusItem item) { return () => MessageBox.ErrorQuery (item.Title, item.Action, "Ok"); } + public Action CreateAction (DynamicStatusItem item) { return () => MessageBox.ErrorQuery (ApplicationImpl.Instance, item.Title, item.Action, "Ok"); } public void EditStatusItem (Shortcut statusItem) { @@ -184,7 +184,7 @@ public class DynamicStatusBar : Scenario { if (string.IsNullOrEmpty (TextTitle.Text)) { - MessageBox.ErrorQuery ("Invalid title", "Must enter a valid title!.", "Ok"); + MessageBox.ErrorQuery (App, "Invalid title", "Must enter a valid title!.", "Ok"); } else { @@ -200,7 +200,7 @@ public class DynamicStatusBar : Scenario TextTitle.Text = string.Empty; Application.RequestStop (); }; - var dialog = new Dialog { Title = "Enter the menu details.", Buttons = [btnOk, btnCancel], Height = Dim.Auto (DimAutoStyle.Content, 17, Application.Screen.Height) }; + var dialog = new Dialog { Title = "Enter the menu details.", Buttons = [btnOk, btnCancel], Height = Dim.Auto (DimAutoStyle.Content, 17, App?.Screen.Height) }; Width = Dim.Fill (); Height = Dim.Fill () - 2; @@ -312,7 +312,12 @@ public class DynamicStatusBar : Scenario btnUp.Accepting += (s, e) => { - int i = _lstItems.SelectedItem; + if (_lstItems.SelectedItem is null) + { + return; + } + int i = _lstItems.SelectedItem.Value; + Shortcut statusItem = DataContext.Items.Count > 0 ? DataContext.Items [i].Shortcut : null; if (statusItem != null) @@ -335,7 +340,12 @@ public class DynamicStatusBar : Scenario btnDown.Accepting += (s, e) => { - int i = _lstItems.SelectedItem; + if (_lstItems.SelectedItem is null) + { + return; + } + int i = _lstItems.SelectedItem.Value; + Shortcut statusItem = DataContext.Items.Count > 0 ? DataContext.Items [i].Shortcut : null; if (statusItem != null) @@ -372,18 +382,21 @@ public class DynamicStatusBar : Scenario { if (string.IsNullOrEmpty (frmStatusBarDetails.TextTitle.Text) && _currentEditStatusItem != null) { - MessageBox.ErrorQuery ("Invalid title", "Must enter a valid title!.", "Ok"); + MessageBox.ErrorQuery (App, "Invalid title", "Must enter a valid title!.", "Ok"); } else if (_currentEditStatusItem != null) { - var statusItem = new DynamicStatusItem { Title = frmStatusBarDetails.TextTitle.Text, Action = frmStatusBarDetails.TextAction.Text, Shortcut = frmStatusBarDetails.TextShortcut.Text }; - UpdateStatusItem (_currentEditStatusItem, statusItem, _lstItems.SelectedItem); + + if (_lstItems.SelectedItem is { } selectedItem) + { + UpdateStatusItem (_currentEditStatusItem, statusItem, selectedItem); + } } }; @@ -420,14 +433,14 @@ public class DynamicStatusBar : Scenario btnRemove.Accepting += (s, e) => { Shortcut statusItem = DataContext.Items.Count > 0 - ? DataContext.Items [_lstItems.SelectedItem].Shortcut + ? DataContext.Items [_lstItems.SelectedItem.Value].Shortcut : null; if (statusItem != null) { _statusBar.RemoveShortcut (_currentSelectedStatusBar); statusItem.Dispose (); - DataContext.Items.RemoveAt (_lstItems.SelectedItem); + DataContext.Items.RemoveAt (_lstItems.SelectedItem.Value); if (_lstItems.Source.Count > 0 && _lstItems.SelectedItem > _lstItems.Source.Count - 1) { @@ -442,7 +455,7 @@ public class DynamicStatusBar : Scenario _lstItems.HasFocusChanging += (s, e) => { Shortcut statusItem = DataContext.Items.Count > 0 - ? DataContext.Items [_lstItems.SelectedItem].Shortcut + ? DataContext.Items [_lstItems.SelectedItem.Value].Shortcut : null; SetFrameDetails (statusItem); }; @@ -489,7 +502,7 @@ public class DynamicStatusBar : Scenario if (statusItem == null) { newStatusItem = DataContext.Items.Count > 0 - ? DataContext.Items [_lstItems.SelectedItem].Shortcut + ? DataContext.Items [_lstItems.SelectedItem.Value].Shortcut : null; } else diff --git a/Examples/UICatalog/Scenarios/Editor.cs b/Examples/UICatalog/Scenarios/Editor.cs index b005fec55..857663577 100644 --- a/Examples/UICatalog/Scenarios/Editor.cs +++ b/Examples/UICatalog/Scenarios/Editor.cs @@ -1,13 +1,9 @@ -using System; -using System.Collections.Generic; +#nullable enable + using System.Diagnostics; using System.Globalization; -using System.IO; -using System.Linq; using System.Text; using System.Text.RegularExpressions; -using System.Threading; -using static UICatalog.Scenarios.DynamicMenuBar; namespace UICatalog.Scenarios; @@ -21,319 +17,191 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("Menus")] public class Editor : Scenario { - private Window _appWindow; - private List _cultureInfos; + private Window? _appWindow; + private List? _cultureInfos; private string _fileName = "demo.txt"; private bool _forceMinimumPosToZero = true; private bool _matchCase; private bool _matchWholeWord; - private MenuItem _miForceMinimumPosToZero; - private byte [] _originalText; + private CheckBox? _miForceMinimumPosToZeroCheckBox; + private byte []? _originalText; private bool _saved = true; - private TabView _tabView; - private string _textToFind; - private string _textToReplace; - private TextView _textView; - private FindReplaceWindow _findReplaceWindow; + private TabView? _tabView; + private string _textToFind = string.Empty; + private string _textToReplace = string.Empty; + private TextView? _textView; + private FindReplaceWindow? _findReplaceWindow; public override void Main () { - // Init Application.Init (); - // Setup - Create a top-level application window and configure it. _appWindow = new () { - //Title = GetQuitKeyAndName (), Title = _fileName ?? "Untitled", BorderStyle = LineStyle.None }; - _cultureInfos = Application.SupportedCultures; + _cultureInfos = Application.SupportedCultures?.ToList (); _textView = new () { X = 0, Y = 1, Width = Dim.Fill (), - Height = Dim.Fill (1), + Height = Dim.Fill (1) }; - CreateDemoFile (_fileName); + CreateDemoFile (_fileName!); LoadFile (); _appWindow.Add (_textView); - var menu = new MenuBar - { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new ("_New", "", () => New ()), - new ("_Open", "", () => Open ()), - new ("_Save", "", () => Save ()), - new ("_Save As", "", () => SaveAs ()), - new ("_Close", "", () => CloseFile ()), - null, - new ("_Quit", "", () => Quit ()) - } - ), - new ( - "_Edit", - new MenuItem [] - { - new ( - "_Copy", - "", - () => Copy (), - null, - null, - KeyCode.CtrlMask | KeyCode.C - ), - new ( - "C_ut", - "", - () => Cut (), - null, - null, - KeyCode.CtrlMask | KeyCode.W - ), - new ( - "_Paste", - "", - () => Paste (), - null, - null, - KeyCode.CtrlMask | KeyCode.Y - ), - null, - new ( - "_Find", - "", - () => Find (), - null, - null, - KeyCode.CtrlMask | KeyCode.S - ), - new ( - "Find _Next", - "", - () => FindNext (), - null, - null, - KeyCode.CtrlMask - | KeyCode.ShiftMask - | KeyCode.S - ), - new ( - "Find P_revious", - "", - () => FindPrevious (), - null, - null, - KeyCode.CtrlMask - | KeyCode.ShiftMask - | KeyCode.AltMask - | KeyCode.S - ), - new ( - "_Replace", - "", - () => Replace (), - null, - null, - KeyCode.CtrlMask | KeyCode.R - ), - new ( - "Replace Ne_xt", - "", - () => ReplaceNext (), - null, - null, - KeyCode.CtrlMask - | KeyCode.ShiftMask - | KeyCode.R - ), - new ( - "Replace Pre_vious", - "", - () => ReplacePrevious (), - null, - null, - KeyCode.CtrlMask - | KeyCode.ShiftMask - | KeyCode.AltMask - | KeyCode.R - ), - new ( - "Replace _All", - "", - () => ReplaceAll (), - null, - null, - KeyCode.CtrlMask - | KeyCode.ShiftMask - | KeyCode.AltMask - | KeyCode.A - ), - null, - new ( - "_Select All", - "", - () => SelectAll (), - null, - null, - KeyCode.CtrlMask | KeyCode.T - ) - } - ), - new ("_ScrollBarView", CreateKeepChecked ()), - new ("_Cursor", CreateCursorRadio ()), - new ( - "Forma_t", - new [] - { - CreateWrapChecked (), - CreateAutocomplete (), - CreateAllowsTabChecked (), - CreateReadOnlyChecked (), - CreateUseSameRuneTypeForWords (), - CreateSelectWordOnlyOnDoubleClick (), - new MenuItem ( - "Colors", - "", - () => _textView.PromptForColors (), - null, - null, - KeyCode.CtrlMask | KeyCode.L - ) - } - ), - new ( - "_Responder", - new [] { CreateCanFocusChecked (), CreateEnabledChecked (), CreateVisibleChecked () } - ), - new ( - "Conte_xtMenu", - new [] - { - _miForceMinimumPosToZero = new ( - "ForceMinimumPosTo_Zero", - "", - () => - { - //_miForceMinimumPosToZero.Checked = - // _forceMinimumPosToZero = - // !_forceMinimumPosToZero; + // MenuBar + MenuBar menu = new (); - //_textView.ContextMenu.ForceMinimumPosToZero = - // _forceMinimumPosToZero; - } - ) - { - CheckType = MenuItemCheckStyle.Checked, - Checked = _forceMinimumPosToZero - }, - new MenuBarItem ("_Languages", GetSupportedCultures ()) - } - ) - ] + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem { Title = "_New", Action = () => New () }, + new MenuItem { Title = "_Open", Action = Open }, + new MenuItem { Title = "_Save", Action = () => Save () }, + new MenuItem { Title = "_Save As", Action = () => SaveAs () }, + new MenuItem { Title = "_Close", Action = CloseFile }, + new MenuItem { Title = "_Quit", Action = Quit } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "_Edit", + [ + new MenuItem { Title = "_Copy", Key = Key.C.WithCtrl, Action = Copy }, + new MenuItem { Title = "C_ut", Key = Key.W.WithCtrl, Action = Cut }, + new MenuItem { Title = "_Paste", Key = Key.Y.WithCtrl, Action = Paste }, + new MenuItem { Title = "_Find", Key = Key.S.WithCtrl, Action = Find }, + new MenuItem { Title = "Find _Next", Key = Key.S.WithCtrl.WithShift, Action = FindNext }, + new MenuItem { Title = "Find P_revious", Key = Key.S.WithCtrl.WithShift.WithAlt, Action = FindPrevious }, + new MenuItem { Title = "_Replace", Key = Key.R.WithCtrl, Action = Replace }, + new MenuItem { Title = "Replace Ne_xt", Key = Key.R.WithCtrl.WithShift, Action = ReplaceNext }, + new MenuItem { Title = "Replace Pre_vious", Key = Key.R.WithCtrl.WithShift.WithAlt, Action = ReplacePrevious }, + new MenuItem { Title = "Replace _All", Key = Key.A.WithCtrl.WithShift.WithAlt, Action = ReplaceAll }, + new MenuItem { Title = "_Select All", Key = Key.T.WithCtrl, Action = SelectAll } + ] + ) + ); + + menu.Add (new MenuBarItem ("_ScrollBars", CreateScrollBarsMenu ())); + menu.Add (new MenuBarItem ("_Cursor", CreateCursorRadio ())); + + menu.Add ( + new MenuBarItem ( + "Forma_t", + [ + CreateWrapChecked (), + CreateAutocomplete (), + CreateAllowsTabChecked (), + CreateReadOnlyChecked (), + CreateUseSameRuneTypeForWords (), + CreateSelectWordOnlyOnDoubleClick (), + new MenuItem { Title = "Colors", Key = Key.L.WithCtrl, Action = () => _textView?.PromptForColors () } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "_View", + [CreateCanFocusChecked (), CreateEnabledChecked (), CreateVisibleChecked ()] + ) + ); + + _miForceMinimumPosToZeroCheckBox = new () + { + Title = "ForceMinimumPosTo_Zero", + CheckedState = _forceMinimumPosToZero ? CheckState.Checked : CheckState.UnChecked }; + _miForceMinimumPosToZeroCheckBox.CheckedStateChanging += (s, e) => + { + _forceMinimumPosToZero = e.Result == CheckState.Checked; + + // Note: PopoverMenu.ForceMinimumPosToZero property doesn't exist in v2 + // if (_textView?.ContextMenu is { }) + // { + // _textView.ContextMenu.ForceMinimumPosToZero = _forceMinimumPosToZero; + // } + }; + + menu.Add ( + new MenuBarItem ( + "Conte_xtMenu", + [ + new MenuItem { CommandView = _miForceMinimumPosToZeroCheckBox }, + new MenuBarItem ("_Languages", GetSupportedCultures ()) + ] + ) + ); + _appWindow.Add (menu); - var siCursorPosition = new Shortcut (KeyCode.Null, "", null); + Shortcut siCursorPosition = new (Key.Empty, "", null); - var statusBar = new StatusBar ( - new [] - { - new (Application.QuitKey, $"Quit", Quit), - new (Key.F2, "Open", Open), - new (Key.F3, "Save", () => Save ()), - new (Key.F4, "Save As", () => SaveAs ()), - new (Key.Empty, $"OS Clipboard IsSupported : {Clipboard.IsSupported}", null), - siCursorPosition, - } - ) + StatusBar statusBar = new ( + [ + new (Application.QuitKey, "Quit", Quit), + new (Key.F2, "Open", Open), + new (Key.F3, "Save", () => Save ()), + new (Key.F4, "Save As", () => SaveAs ()), + new (Key.Empty, $"OS Clipboard IsSupported : {Application.Clipboard!.IsSupported}", null), + siCursorPosition + ] + ) { AlignmentModes = AlignmentModes.StartToEnd | AlignmentModes.IgnoreFirstOrLast }; _textView.VerticalScrollBar.AutoShow = false; - _textView.UnwrappedCursorPosition += (s, e) => - { - siCursorPosition.Title = $"Ln {e.Y + 1}, Col {e.X + 1}"; - }; + + _textView.UnwrappedCursorPosition += (s, e) => { siCursorPosition.Title = $"Ln {e.Y + 1}, Col {e.X + 1}"; }; _appWindow.Add (statusBar); - //_scrollBar = new (_textView, true); - - //_scrollBar.ChangedPosition += (s, e) => - // { - // _textView.TopRow = _scrollBar.Position; - - // if (_textView.TopRow != _scrollBar.Position) - // { - // _scrollBar.Position = _textView.TopRow; - // } - - // _textView.SetNeedsDraw (); - // }; - - //_scrollBar.OtherScrollBarView.ChangedPosition += (s, e) => - // { - // _textView.LeftColumn = _scrollBar.OtherScrollBarView.Position; - - // if (_textView.LeftColumn != _scrollBar.OtherScrollBarView.Position) - // { - // _scrollBar.OtherScrollBarView.Position = _textView.LeftColumn; - // } - - // _textView.SetNeedsDraw (); - // }; - - //_textView.DrawingContent += (s, e) => - // { - // _scrollBar.Size = _textView.Lines; - // _scrollBar.Position = _textView.TopRow; - - // if (_scrollBar.OtherScrollBarView != null) - // { - // _scrollBar.OtherScrollBarView.Size = _textView.Maxlength; - // _scrollBar.OtherScrollBarView.Position = _textView.LeftColumn; - // } - // }; - - - _appWindow.Closed += (s, e) => Thread.CurrentThread.CurrentUICulture = new ("en-US"); + _appWindow.IsRunningChanged += (s, e) => + { + if (!e.Value) + { + // BUGBUG: This should restore the original culture info + Thread.CurrentThread.CurrentUICulture = new ("en-US"); + } + }; CreateFindReplace (); - // Run - Start the application. Application.Run (_appWindow); _appWindow.Dispose (); - - // Shutdown - Calling Application.Shutdown is required. Application.Shutdown (); - } private bool CanCloseFile () { + if (_textView is null || _originalText is null || _appWindow is null) + { + return true; + } + if (_textView.Text == Encoding.Unicode.GetString (_originalText)) { - //System.Diagnostics.Debug.Assert (!_textView.IsDirty); return true; } Debug.Assert (_textView.IsDirty); - int r = MessageBox.ErrorQuery ( + int? r = MessageBox.ErrorQuery ( + ApplicationImpl.Instance, "Save File", $"Do you want save changes in {_appWindow.Title}?", "Yes", @@ -356,7 +224,7 @@ public class Editor : Scenario private void CloseFile () { - if (!CanCloseFile ()) + if (!CanCloseFile () || _textView is null) { return; } @@ -368,12 +236,17 @@ public class Editor : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery ("Error", ex.Message, "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Error", ex.Message, "Ok"); } } private void ContinueFind (bool next = true, bool replace = false) { + if (_textView is null) + { + return; + } + if (!replace && string.IsNullOrEmpty (_textToFind)) { Find (); @@ -383,7 +256,7 @@ public class Editor : Scenario if (replace && (string.IsNullOrEmpty (_textToFind) - || (_findReplaceWindow == null && string.IsNullOrEmpty (_textToReplace)))) + || (_findReplaceWindow is null && string.IsNullOrEmpty (_textToReplace)))) { Replace (); @@ -442,11 +315,11 @@ public class Editor : Scenario if (!found) { - MessageBox.Query ("Find", $"The following specified text was not found: '{_textToFind}'", "Ok"); + MessageBox.Query (ApplicationImpl.Instance, "Find", $"The following specified text was not found: '{_textToFind}'", "Ok"); } else if (gaveFullTurn) { - MessageBox.Query ( + MessageBox.Query (ApplicationImpl.Instance, "Find", $"No more occurrences were found for the following specified text: '{_textToFind}'", "Ok" @@ -454,204 +327,466 @@ public class Editor : Scenario } } - private void Copy () + private void Copy () { _textView?.Copy (); } + + private MenuItem [] CreateScrollBarsMenu () { - if (_textView != null) + if (_textView is null) { - _textView.Copy (); + return []; } + + List menuItems = []; + + // Vertical ScrollBar AutoShow + CheckBox verticalAutoShowCheckBox = new () + { + Title = "_Vertical ScrollBar AutoShow", + CheckedState = _textView.VerticalScrollBar.AutoShow ? CheckState.Checked : CheckState.UnChecked + }; + + verticalAutoShowCheckBox.CheckedStateChanged += (s, e) => + { + _textView.VerticalScrollBar.AutoShow = verticalAutoShowCheckBox.CheckedState == CheckState.Checked; + }; + + MenuItem verticalItem = new () { CommandView = verticalAutoShowCheckBox }; + + verticalItem.Accepting += (s, e) => + { + verticalAutoShowCheckBox.AdvanceCheckState (); + e.Handled = true; + }; + + menuItems.Add (verticalItem); + + // Horizontal ScrollBar AutoShow + CheckBox horizontalAutoShowCheckBox = new () + { + Title = "_Horizontal ScrollBar AutoShow", + CheckedState = _textView.HorizontalScrollBar.AutoShow ? CheckState.Checked : CheckState.UnChecked + }; + + horizontalAutoShowCheckBox.CheckedStateChanged += (s, e) => + { + _textView.HorizontalScrollBar.AutoShow = horizontalAutoShowCheckBox.CheckedState == CheckState.Checked; + }; + + MenuItem horizontalItem = new () { CommandView = horizontalAutoShowCheckBox }; + + horizontalItem.Accepting += (s, e) => + { + horizontalAutoShowCheckBox.AdvanceCheckState (); + e.Handled = true; + }; + + menuItems.Add (horizontalItem); + + return [.. menuItems]; } - private MenuItem CreateAllowsTabChecked () + private MenuItem [] CreateCursorRadio () { - var item = new MenuItem { Title = "Allows Tab" }; - item.CheckType |= MenuItemCheckStyle.Checked; - item.Checked = _textView.AllowsTab; - item.Action += () => { _textView.AllowsTab = (bool)(item.Checked = !item.Checked); }; + if (_textView is null) + { + return []; + } + + List menuItems = []; + List radioGroup = []; + + void AddRadioItem (string title, CursorVisibility visibility) + { + CheckBox checkBox = new () + { + Title = title, + CheckedState = _textView.CursorVisibility == visibility ? CheckState.Checked : CheckState.UnChecked + }; + + radioGroup.Add (checkBox); + + checkBox.CheckedStateChanging += (s, e) => + { + if (e.Result == CheckState.Checked) + { + _textView.CursorVisibility = visibility; + + foreach (CheckBox cb in radioGroup) + { + if (cb != checkBox) + { + cb.CheckedState = CheckState.UnChecked; + } + } + } + }; + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; + + menuItems.Add (item); + } + + AddRadioItem ("_Invisible", CursorVisibility.Invisible); + AddRadioItem ("_Box", CursorVisibility.Box); + AddRadioItem ("_Underline", CursorVisibility.Underline); + + menuItems.Add (new () { Title = "" }); + menuItems.Add (new () { Title = "xTerm :" }); + menuItems.Add (new () { Title = "" }); + + AddRadioItem (" _Default", CursorVisibility.Default); + AddRadioItem (" _Vertical", CursorVisibility.Vertical); + AddRadioItem (" V_ertical Fix", CursorVisibility.VerticalFix); + AddRadioItem (" B_ox Fix", CursorVisibility.BoxFix); + AddRadioItem (" U_nderline Fix", CursorVisibility.UnderlineFix); + + return [.. menuItems]; + } + + private MenuItem [] GetSupportedCultures () + { + if (_cultureInfos is null) + { + return []; + } + + List supportedCultures = []; + List allCheckBoxes = []; + int index = -1; + + void CreateCultureMenuItem (string title, string cultureName, bool isChecked) + { + CheckBox checkBox = new () + { + Title = title, + CheckedState = isChecked ? CheckState.Checked : CheckState.UnChecked + }; + + allCheckBoxes.Add (checkBox); + + checkBox.CheckedStateChanging += (s, e) => + { + if (e.Result == CheckState.Checked) + { + Thread.CurrentThread.CurrentUICulture = new (cultureName); + + foreach (CheckBox cb in allCheckBoxes) + { + cb.CheckedState = cb == checkBox ? CheckState.Checked : CheckState.UnChecked; + } + } + }; + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; + + supportedCultures.Add (item); + } + + foreach (CultureInfo c in _cultureInfos) + { + if (index == -1) + { + CreateCultureMenuItem ("_English", "en-US", Thread.CurrentThread.CurrentUICulture.Name == "en-US"); + index++; + } + + CreateCultureMenuItem ($"_{c.Parent.EnglishName}", c.Name, Thread.CurrentThread.CurrentUICulture.Name == c.Name); + } + + return [.. supportedCultures]; + } + + private MenuItem CreateWrapChecked () + { + if (_textView is null) + { + return new () { Title = "Word Wrap" }; + } + + CheckBox checkBox = new () + { + Title = "Word Wrap", + CheckedState = _textView.WordWrap ? CheckState.Checked : CheckState.UnChecked + }; + + checkBox.CheckedStateChanged += (s, e) => { _textView.WordWrap = checkBox.CheckedState == CheckState.Checked; }; + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; return item; } private MenuItem CreateAutocomplete () { - var singleWordGenerator = new SingleWordSuggestionGenerator (); + if (_textView is null) + { + return new () { Title = "Autocomplete" }; + } + + SingleWordSuggestionGenerator singleWordGenerator = new (); _textView.Autocomplete.SuggestionGenerator = singleWordGenerator; - var auto = new MenuItem (); - auto.Title = "Autocomplete"; - auto.CheckType |= MenuItemCheckStyle.Checked; - auto.Checked = false; + CheckBox checkBox = new () + { + Title = "Autocomplete", + CheckedState = CheckState.UnChecked + }; - auto.Action += () => - { - if ((bool)(auto.Checked = !auto.Checked)) - { - // setup autocomplete with all words currently in the editor - singleWordGenerator.AllSuggestions = - Regex.Matches (_textView.Text, "\\w+") - .Select (s => s.Value) - .Distinct () - .ToList (); - } - else - { - singleWordGenerator.AllSuggestions.Clear (); - } - }; + checkBox.CheckedStateChanged += (s, e) => + { + if (checkBox.CheckedState == CheckState.Checked) + { + singleWordGenerator.AllSuggestions = + Regex.Matches (_textView.Text, "\\w+") + .Select (s => s.Value) + .Distinct () + .ToList (); + } + else + { + singleWordGenerator.AllSuggestions.Clear (); + } + }; - return auto; - } + MenuItem item = new () { CommandView = checkBox }; - private MenuItem CreateCanFocusChecked () - { - var item = new MenuItem { Title = "CanFocus" }; - item.CheckType |= MenuItemCheckStyle.Checked; - item.Checked = _textView.CanFocus; - - item.Action += () => - { - _textView.CanFocus = (bool)(item.Checked = !item.Checked); - - if (_textView.CanFocus) - { - _textView.SetFocus (); - } - }; + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; return item; } - private MenuItem [] CreateCursorRadio () + private MenuItem CreateAllowsTabChecked () { - List menuItems = new (); - - menuItems.Add ( - new ("_Invisible", "", () => SetCursor (CursorVisibility.Invisible)) - { - CheckType = MenuItemCheckStyle.Radio, - Checked = _textView.CursorVisibility - == CursorVisibility.Invisible - } - ); - - menuItems.Add ( - new ("_Box", "", () => SetCursor (CursorVisibility.Box)) - { - CheckType = MenuItemCheckStyle.Radio, - Checked = _textView.CursorVisibility == CursorVisibility.Box - } - ); - - menuItems.Add ( - new ("_Underline", "", () => SetCursor (CursorVisibility.Underline)) - { - CheckType = MenuItemCheckStyle.Radio, - Checked = _textView.CursorVisibility - == CursorVisibility.Underline - } - ); - menuItems.Add (new ("", "", () => { }, () => false)); - menuItems.Add (new ("xTerm :", "", () => { }, () => false)); - menuItems.Add (new ("", "", () => { }, () => false)); - - menuItems.Add ( - new (" _Default", "", () => SetCursor (CursorVisibility.Default)) - { - CheckType = MenuItemCheckStyle.Radio, - Checked = _textView.CursorVisibility - == CursorVisibility.Default - } - ); - - menuItems.Add ( - new (" _Vertical", "", () => SetCursor (CursorVisibility.Vertical)) - { - CheckType = MenuItemCheckStyle.Radio, - Checked = _textView.CursorVisibility - == CursorVisibility.Vertical - } - ); - - menuItems.Add ( - new (" V_ertical Fix", "", () => SetCursor (CursorVisibility.VerticalFix)) - { - CheckType = MenuItemCheckStyle.Radio, - Checked = _textView.CursorVisibility == CursorVisibility.VerticalFix - } - ); - - menuItems.Add ( - new (" B_ox Fix", "", () => SetCursor (CursorVisibility.BoxFix)) - { - CheckType = MenuItemCheckStyle.Radio, - Checked = _textView.CursorVisibility - == CursorVisibility.BoxFix - } - ); - - menuItems.Add ( - new (" U_nderline Fix", "", () => SetCursor (CursorVisibility.UnderlineFix)) - { - CheckType = MenuItemCheckStyle.Radio, - Checked = _textView.CursorVisibility == CursorVisibility.UnderlineFix - } - ); - - void SetCursor (CursorVisibility visibility) + if (_textView is null) { - _textView.CursorVisibility = visibility; - var title = ""; - - switch (visibility) - { - case CursorVisibility.Default: - title = " _Default"; - - break; - case CursorVisibility.Invisible: - title = "_Invisible"; - - break; - case CursorVisibility.Underline: - title = "_Underline"; - - break; - case CursorVisibility.UnderlineFix: - title = " U_nderline Fix"; - - break; - case CursorVisibility.Vertical: - title = " _Vertical"; - - break; - case CursorVisibility.VerticalFix: - title = " V_ertical Fix"; - - break; - case CursorVisibility.Box: - title = "_Box"; - - break; - case CursorVisibility.BoxFix: - title = " B_ox Fix"; - - break; - } - - foreach (MenuItem menuItem in menuItems) - { - menuItem.Checked = menuItem.Title.Equals (title) && visibility == _textView.CursorVisibility; - } + return new () { Title = "Allows Tab" }; } - return menuItems.ToArray (); + CheckBox checkBox = new () + { + Title = "Allows Tab", + CheckedState = _textView.AllowsTab ? CheckState.Checked : CheckState.UnChecked + }; + + checkBox.CheckedStateChanged += (s, e) => { _textView.AllowsTab = checkBox.CheckedState == CheckState.Checked; }; + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; + + return item; + } + + private MenuItem CreateReadOnlyChecked () + { + if (_textView is null) + { + return new () { Title = "Read Only" }; + } + + CheckBox checkBox = new () + { + Title = "Read Only", + CheckedState = _textView.ReadOnly ? CheckState.Checked : CheckState.UnChecked + }; + + checkBox.CheckedStateChanged += (s, e) => { _textView.ReadOnly = checkBox.CheckedState == CheckState.Checked; }; + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; + + return item; + } + + private MenuItem CreateUseSameRuneTypeForWords () + { + if (_textView is null) + { + return new () { Title = "UseSameRuneTypeForWords" }; + } + + CheckBox checkBox = new () + { + Title = "UseSameRuneTypeForWords", + CheckedState = _textView.UseSameRuneTypeForWords ? CheckState.Checked : CheckState.UnChecked + }; + + checkBox.CheckedStateChanged += (s, e) => { _textView.UseSameRuneTypeForWords = checkBox.CheckedState == CheckState.Checked; }; + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; + + return item; + } + + private MenuItem CreateSelectWordOnlyOnDoubleClick () + { + if (_textView is null) + { + return new () { Title = "SelectWordOnlyOnDoubleClick" }; + } + + CheckBox checkBox = new () + { + Title = "SelectWordOnlyOnDoubleClick", + CheckedState = _textView.SelectWordOnlyOnDoubleClick ? CheckState.Checked : CheckState.UnChecked + }; + + checkBox.CheckedStateChanged += (s, e) => { _textView.SelectWordOnlyOnDoubleClick = checkBox.CheckedState == CheckState.Checked; }; + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; + + return item; + } + + private MenuItem CreateCanFocusChecked () + { + if (_textView is null) + { + return new () { Title = "CanFocus" }; + } + + CheckBox checkBox = new () + { + Title = "CanFocus", + CheckedState = _textView.CanFocus ? CheckState.Checked : CheckState.UnChecked + }; + + checkBox.CheckedStateChanged += (s, e) => + { + _textView.CanFocus = checkBox.CheckedState == CheckState.Checked; + + if (_textView.CanFocus) + { + _textView.SetFocus (); + } + }; + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; + + return item; + } + + private MenuItem CreateEnabledChecked () + { + if (_textView is null) + { + return new () { Title = "Enabled" }; + } + + CheckBox checkBox = new () + { + Title = "Enabled", + CheckedState = _textView.Enabled ? CheckState.Checked : CheckState.UnChecked + }; + + checkBox.CheckedStateChanged += (s, e) => + { + _textView.Enabled = checkBox.CheckedState == CheckState.Checked; + + if (_textView.Enabled) + { + _textView.SetFocus (); + } + }; + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; + + return item; + } + + private MenuItem CreateVisibleChecked () + { + if (_textView is null) + { + return new () { Title = "Visible" }; + } + + CheckBox checkBox = new () + { + Title = "Visible", + CheckedState = _textView.Visible ? CheckState.Checked : CheckState.UnChecked + }; + + checkBox.CheckedStateChanged += (s, e) => + { + _textView.Visible = checkBox.CheckedState == CheckState.Checked; + + if (_textView.Visible) + { + _textView.SetFocus (); + } + }; + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; + + return item; } private void CreateDemoFile (string fileName) { - var sb = new StringBuilder (); + StringBuilder sb = new (); - // FIXED: BUGBUG: #279 TextView does not know how to deal with \r\n, only \r sb.Append ("Hello world.\n"); sb.Append ("This is a test of the Emergency Broadcast System.\n"); @@ -667,341 +802,33 @@ public class Editor : Scenario sw.Close (); } - private MenuItem CreateEnabledChecked () - { - var item = new MenuItem { Title = "Enabled" }; - item.CheckType |= MenuItemCheckStyle.Checked; - item.Checked = _textView.Enabled; - - item.Action += () => - { - _textView.Enabled = (bool)(item.Checked = !item.Checked); - - if (_textView.Enabled) - { - _textView.SetFocus (); - } - }; - - return item; - } - - private class FindReplaceWindow : Window - { - private TextView _textView; - public FindReplaceWindow (TextView textView) - { - Title = "Find and Replace"; - - _textView = textView; - X = Pos.AnchorEnd () - 1; - Y = 2; - Width = 57; - Height = 11; - Arrangement = ViewArrangement.Movable; - - KeyBindings.Add (Key.Esc, Command.Cancel); - AddCommand (Command.Cancel, () => - { - Visible = false; - - return true; - }); - VisibleChanged += FindReplaceWindow_VisibleChanged; - Initialized += FindReplaceWindow_Initialized; - - //var btnCancel = new Button - //{ - // X = Pos.AnchorEnd (), - // Y = Pos.AnchorEnd (), - // Text = "Cancel" - //}; - //btnCancel.Accept += (s, e) => { Visible = false; }; - //Add (btnCancel); - } - - private void FindReplaceWindow_VisibleChanged (object sender, EventArgs e) - { - if (Visible == false) - { - _textView.SetFocus (); - } - else - { - FocusDeepest (NavigationDirection.Forward, null); - } - } - - private void FindReplaceWindow_Initialized (object sender, EventArgs e) - { - Border.LineStyle = LineStyle.Dashed; - Border.Thickness = new (0, 1, 0, 0); - } - } - - private void ShowFindReplace (bool isFind = true) - { - _findReplaceWindow.Visible = true; - _findReplaceWindow.SuperView.MoveSubViewToStart (_findReplaceWindow); - _tabView.SetFocus (); - _tabView.SelectedTab = isFind ? _tabView.Tabs.ToArray () [0] : _tabView.Tabs.ToArray () [1]; - _tabView.SelectedTab.View.FocusDeepest (NavigationDirection.Forward, null); - } - - private void CreateFindReplace () - { - _findReplaceWindow = new (_textView); - _tabView = new () - { - X = 0, Y = 0, - Width = Dim.Fill (), Height = Dim.Fill (0) - }; - - _tabView.AddTab (new () { DisplayText = "Find", View = CreateFindTab () }, true); - _tabView.AddTab (new () { DisplayText = "Replace", View = CreateReplaceTab () }, false); - _tabView.SelectedTabChanged += (s, e) => _tabView.SelectedTab.View.FocusDeepest (NavigationDirection.Forward, null); - _findReplaceWindow.Add (_tabView); - -// _tabView.SelectedTab.View.FocusLast (null); // Hack to get the first tab to be focused - _findReplaceWindow.Visible = false; - _appWindow.Add (_findReplaceWindow); - } - - private MenuItem [] CreateKeepChecked () - { - var item = new MenuItem (); - item.Title = "Keep Content Always In Viewport"; - item.CheckType |= MenuItemCheckStyle.Checked; - item.Checked = true; - //item.Action += () => _scrollBar.KeepContentAlwaysInViewport = (bool)(item.Checked = !item.Checked); - - return new [] { item }; - } - - private MenuItem CreateSelectWordOnlyOnDoubleClick () - { - var item = new MenuItem { Title = "SelectWordOnlyOnDoubleClick" }; - item.CheckType |= MenuItemCheckStyle.Checked; - item.Checked = _textView.SelectWordOnlyOnDoubleClick; - item.Action += () => _textView.SelectWordOnlyOnDoubleClick = (bool)(item.Checked = !item.Checked); - - return item; - } - - private MenuItem CreateUseSameRuneTypeForWords () - { - var item = new MenuItem { Title = "UseSameRuneTypeForWords" }; - item.CheckType |= MenuItemCheckStyle.Checked; - item.Checked = _textView.UseSameRuneTypeForWords; - item.Action += () => _textView.UseSameRuneTypeForWords = (bool)(item.Checked = !item.Checked); - - return item; - } - - private MenuItem CreateReadOnlyChecked () - { - var item = new MenuItem { Title = "Read Only" }; - item.CheckType |= MenuItemCheckStyle.Checked; - item.Checked = _textView.ReadOnly; - item.Action += () => _textView.ReadOnly = (bool)(item.Checked = !item.Checked); - - return item; - } - - private MenuItem CreateVisibleChecked () - { - var item = new MenuItem { Title = "Visible" }; - item.CheckType |= MenuItemCheckStyle.Checked; - item.Checked = _textView.Visible; - - item.Action += () => - { - _textView.Visible = (bool)(item.Checked = !item.Checked); - - if (_textView.Visible) - { - _textView.SetFocus (); - } - }; - - return item; - } - - private MenuItem CreateWrapChecked () - { - var item = new MenuItem { Title = "Word Wrap" }; - item.CheckType |= MenuItemCheckStyle.Checked; - item.Checked = _textView.WordWrap; - - item.Action += () => - { - _textView.WordWrap = (bool)(item.Checked = !item.Checked); - - if (_textView.WordWrap) - { - //_scrollBar.OtherScrollBarView.ShowScrollIndicator = false; - } - }; - - return item; - } - - private void Cut () - { - if (_textView != null) - { - _textView.Cut (); - } - } - - private void Find () { ShowFindReplace (true); } - private void FindNext () { ContinueFind (); } - private void FindPrevious () { ContinueFind (false); } - - private View CreateFindTab () - { - var d = new View () - { - Width = Dim.Fill (), - Height = Dim.Fill () - }; - - int lblWidth = "Replace:".Length; - - var label = new Label - { - Width = lblWidth, - TextAlignment = Alignment.End, - - Text = "Find:" - }; - d.Add (label); - - SetFindText (); - - var txtToFind = new TextField - { - X = Pos.Right (label) + 1, - Y = Pos.Top (label), - Width = Dim.Fill (1), - Text = _textToFind - }; - txtToFind.HasFocusChanging += (s, e) => txtToFind.Text = _textToFind; - d.Add (txtToFind); - - var btnFindNext = new Button - { - X = Pos.Align (Alignment.Center), - Y = Pos.AnchorEnd (), - Enabled = !string.IsNullOrEmpty (txtToFind.Text), - IsDefault = true, - - Text = "Find _Next" - }; - btnFindNext.Accepting += (s, e) => FindNext (); - d.Add (btnFindNext); - - var btnFindPrevious = new Button - { - X = Pos.Align (Alignment.Center), - Y = Pos.AnchorEnd (), - Enabled = !string.IsNullOrEmpty (txtToFind.Text), - Text = "Find _Previous" - }; - btnFindPrevious.Accepting += (s, e) => FindPrevious (); - d.Add (btnFindPrevious); - - txtToFind.TextChanged += (s, e) => - { - _textToFind = txtToFind.Text; - _textView.FindTextChanged (); - btnFindNext.Enabled = !string.IsNullOrEmpty (txtToFind.Text); - btnFindPrevious.Enabled = !string.IsNullOrEmpty (txtToFind.Text); - }; - - var ckbMatchCase = new CheckBox - { - X = 0, Y = Pos.Top (txtToFind) + 2, CheckedState = _matchCase ? CheckState.Checked : CheckState.UnChecked, Text = "Match c_ase" - }; - ckbMatchCase.CheckedStateChanging += (s, e) => _matchCase = e.Result == CheckState.Checked; - d.Add (ckbMatchCase); - - var ckbMatchWholeWord = new CheckBox - { - X = 0, Y = Pos.Top (ckbMatchCase) + 1, CheckedState = _matchWholeWord ? CheckState.Checked : CheckState.UnChecked, Text = "Match _whole word" - }; - ckbMatchWholeWord.CheckedStateChanging += (s, e) => _matchWholeWord = e.Result == CheckState.Checked; - d.Add (ckbMatchWholeWord); - return d; - } - - private MenuItem [] GetSupportedCultures () - { - List supportedCultures = new (); - int index = -1; - - foreach (CultureInfo c in _cultureInfos) - { - var culture = new MenuItem { CheckType = MenuItemCheckStyle.Checked }; - - if (index == -1) - { - culture.Title = "_English"; - culture.Help = "en-US"; - culture.Checked = Thread.CurrentThread.CurrentUICulture.Name == "en-US"; - CreateAction (supportedCultures, culture); - supportedCultures.Add (culture); - index++; - culture = new () { CheckType = MenuItemCheckStyle.Checked }; - } - - culture.Title = $"_{c.Parent.EnglishName}"; - culture.Help = c.Name; - culture.Checked = Thread.CurrentThread.CurrentUICulture.Name == c.Name; - CreateAction (supportedCultures, culture); - supportedCultures.Add (culture); - } - - return supportedCultures.ToArray (); - - void CreateAction (List supportedCultures, MenuItem culture) - { - culture.Action += () => - { - Thread.CurrentThread.CurrentUICulture = new (culture.Help); - culture.Checked = true; - - foreach (MenuItem item in supportedCultures) - { - item.Checked = item.Help == Thread.CurrentThread.CurrentUICulture.Name; - } - }; - } - } - private void LoadFile () { - if (_fileName != null) + if (_fileName is null || _textView is null || _appWindow is null) { - // FIXED: BUGBUG: #452 TextView.LoadFile keeps file open and provides no way of closing it - _textView.Load (_fileName); - - //_textView.Text = System.IO.File.ReadAllText (_fileName); - _originalText = Encoding.Unicode.GetBytes (_textView.Text); - _appWindow.Title = _fileName; - _saved = true; + return; } + + _textView.Load (_fileName); + _originalText = Encoding.Unicode.GetBytes (_textView.Text); + _appWindow.Title = _fileName; + _saved = true; } private void New (bool checkChanges = true) { + if (_appWindow is null || _textView is null) + { + return; + } + if (checkChanges && !CanCloseFile ()) { return; } _appWindow.Title = "Untitled.txt"; - _fileName = null; + _fileName = null!; _originalText = new MemoryStream ().ToArray (); _textView.Text = Encoding.Unicode.GetString (_originalText); } @@ -1013,8 +840,8 @@ public class Editor : Scenario return; } - List aTypes = new () - { + List aTypes = + [ new AllowedType ( "Text", ".txt;.bin;.xml;.json", @@ -1024,8 +851,9 @@ public class Editor : Scenario ".json" ), new AllowedTypeAny () - }; - var d = new OpenDialog { Title = "Open", AllowedTypes = aTypes, AllowsMultipleSelection = false }; + ]; + + OpenDialog d = new () { Title = "Open", AllowedTypes = aTypes, AllowsMultipleSelection = false }; Application.Run (d); if (!d.Canceled && d.FilePaths.Count > 0) @@ -1037,13 +865,7 @@ public class Editor : Scenario d.Dispose (); } - private void Paste () - { - if (_textView != null) - { - _textView.Paste (); - } - } + private void Paste () { _textView?.Paste (); } private void Quit () { @@ -1059,7 +881,12 @@ public class Editor : Scenario private void ReplaceAll () { - if (string.IsNullOrEmpty (_textToFind) || (string.IsNullOrEmpty (_textToReplace) && _findReplaceWindow == null)) + if (_textView is null) + { + return; + } + + if (string.IsNullOrEmpty (_textToFind) || (string.IsNullOrEmpty (_textToReplace) && _findReplaceWindow is null)) { Replace (); @@ -1068,7 +895,7 @@ public class Editor : Scenario if (_textView.ReplaceAllText (_textToFind, _matchCase, _matchWholeWord, _textToReplace)) { - MessageBox.Query ( + MessageBox.Query (ApplicationImpl.Instance, "Replace All", $"All occurrences were replaced for the following specified text: '{_textToReplace}'", "Ok" @@ -1076,7 +903,7 @@ public class Editor : Scenario } else { - MessageBox.Query ( + MessageBox.Query (ApplicationImpl.Instance, "Replace All", $"None of the following specified text was found: '{_textToFind}'", "Ok" @@ -1087,9 +914,14 @@ public class Editor : Scenario private void ReplaceNext () { ContinueFind (true, true); } private void ReplacePrevious () { ContinueFind (false, true); } - private View CreateReplaceTab () + private View CreateFindTab () { - var d = new View () + if (_textView is null) + { + return new (); + } + + View d = new () { Width = Dim.Fill (), Height = Dim.Fill () @@ -1097,7 +929,7 @@ public class Editor : Scenario int lblWidth = "Replace:".Length; - var label = new Label + Label label = new () { Width = lblWidth, TextAlignment = Alignment.End, @@ -1107,17 +939,104 @@ public class Editor : Scenario SetFindText (); - var txtToFind = new TextField + TextField txtToFind = new () { X = Pos.Right (label) + 1, Y = Pos.Top (label), Width = Dim.Fill (1), Text = _textToFind }; - txtToFind.HasFocusChanging += (s, e) => txtToFind.Text = _textToFind; + txtToFind.HasFocusChanging += (s, e) => { txtToFind.Text = _textToFind; }; d.Add (txtToFind); - var btnFindNext = new Button + Button btnFindNext = new () + { + X = Pos.Align (Alignment.Center), + Y = Pos.AnchorEnd (), + Enabled = !string.IsNullOrEmpty (txtToFind.Text), + IsDefault = true, + Text = "Find _Next" + }; + btnFindNext.Accepting += (s, e) => { FindNext (); }; + d.Add (btnFindNext); + + Button btnFindPrevious = new () + { + X = Pos.Align (Alignment.Center), + Y = Pos.AnchorEnd (), + Enabled = !string.IsNullOrEmpty (txtToFind.Text), + Text = "Find _Previous" + }; + btnFindPrevious.Accepting += (s, e) => { FindPrevious (); }; + d.Add (btnFindPrevious); + + txtToFind.TextChanged += (s, e) => + { + _textToFind = txtToFind.Text; + _textView.FindTextChanged (); + btnFindNext.Enabled = !string.IsNullOrEmpty (txtToFind.Text); + btnFindPrevious.Enabled = !string.IsNullOrEmpty (txtToFind.Text); + }; + + CheckBox ckbMatchCase = new () + { + X = 0, + Y = Pos.Top (txtToFind) + 2, + CheckedState = _matchCase ? CheckState.Checked : CheckState.UnChecked, + Text = "Match c_ase" + }; + ckbMatchCase.CheckedStateChanging += (s, e) => { _matchCase = e.Result == CheckState.Checked; }; + d.Add (ckbMatchCase); + + CheckBox ckbMatchWholeWord = new () + { + X = 0, + Y = Pos.Top (ckbMatchCase) + 1, + CheckedState = _matchWholeWord ? CheckState.Checked : CheckState.UnChecked, + Text = "Match _whole word" + }; + ckbMatchWholeWord.CheckedStateChanging += (s, e) => { _matchWholeWord = e.Result == CheckState.Checked; }; + d.Add (ckbMatchWholeWord); + + return d; + } + + private View CreateReplaceTab () + { + if (_textView is null) + { + return new (); + } + + View d = new () + { + Width = Dim.Fill (), + Height = Dim.Fill () + }; + + int lblWidth = "Replace:".Length; + + Label label = new () + { + Width = lblWidth, + TextAlignment = Alignment.End, + Text = "Find:" + }; + d.Add (label); + + SetFindText (); + + TextField txtToFind = new () + { + X = Pos.Right (label) + 1, + Y = Pos.Top (label), + Width = Dim.Fill (1), + Text = _textToFind + }; + txtToFind.HasFocusChanging += (s, e) => { txtToFind.Text = _textToFind; }; + d.Add (txtToFind); + + Button btnFindNext = new () { X = Pos.Align (Alignment.Center), Y = Pos.AnchorEnd (), @@ -1125,7 +1044,7 @@ public class Editor : Scenario IsDefault = true, Text = "Replace _Next" }; - btnFindNext.Accepting += (s, e) => ReplaceNext (); + btnFindNext.Accepting += (s, e) => { ReplaceNext (); }; d.Add (btnFindNext); label = new () @@ -1138,34 +1057,34 @@ public class Editor : Scenario SetFindText (); - var txtToReplace = new TextField + TextField txtToReplace = new () { X = Pos.Right (label) + 1, Y = Pos.Top (label), Width = Dim.Fill (1), Text = _textToReplace }; - txtToReplace.TextChanged += (s, e) => _textToReplace = txtToReplace.Text; + txtToReplace.TextChanged += (s, e) => { _textToReplace = txtToReplace.Text; }; d.Add (txtToReplace); - var btnFindPrevious = new Button + Button btnFindPrevious = new () { X = Pos.Align (Alignment.Center), Y = Pos.AnchorEnd (), Enabled = !string.IsNullOrEmpty (txtToFind.Text), Text = "Replace _Previous" }; - btnFindPrevious.Accepting += (s, e) => ReplacePrevious (); + btnFindPrevious.Accepting += (s, e) => { ReplacePrevious (); }; d.Add (btnFindPrevious); - var btnReplaceAll = new Button + Button btnReplaceAll = new () { X = Pos.Align (Alignment.Center), Y = Pos.AnchorEnd (), Enabled = !string.IsNullOrEmpty (txtToFind.Text), Text = "Replace _All" }; - btnReplaceAll.Accepting += (s, e) => ReplaceAll (); + btnReplaceAll.Accepting += (s, e) => { ReplaceAll (); }; d.Add (btnReplaceAll); txtToFind.TextChanged += (s, e) => @@ -1177,18 +1096,24 @@ public class Editor : Scenario btnReplaceAll.Enabled = !string.IsNullOrEmpty (txtToFind.Text); }; - var ckbMatchCase = new CheckBox + CheckBox ckbMatchCase = new () { - X = 0, Y = Pos.Top (txtToFind) + 2, CheckedState = _matchCase ? CheckState.Checked : CheckState.UnChecked, Text = "Match c_ase" + X = 0, + Y = Pos.Top (txtToFind) + 2, + CheckedState = _matchCase ? CheckState.Checked : CheckState.UnChecked, + Text = "Match c_ase" }; - ckbMatchCase.CheckedStateChanging += (s, e) => _matchCase = e.Result == CheckState.Checked; + ckbMatchCase.CheckedStateChanging += (s, e) => { _matchCase = e.Result == CheckState.Checked; }; d.Add (ckbMatchCase); - var ckbMatchWholeWord = new CheckBox + CheckBox ckbMatchWholeWord = new () { - X = 0, Y = Pos.Top (ckbMatchCase) + 1, CheckedState = _matchWholeWord ? CheckState.Checked : CheckState.UnChecked, Text = "Match _whole word" + X = 0, + Y = Pos.Top (ckbMatchCase) + 1, + CheckedState = _matchWholeWord ? CheckState.Checked : CheckState.UnChecked, + Text = "Match _whole word" }; - ckbMatchWholeWord.CheckedStateChanging += (s, e) => _matchWholeWord = e.Result == CheckState.Checked; + ckbMatchWholeWord.CheckedStateChanging += (s, e) => { _matchWholeWord = e.Result == CheckState.Checked; }; d.Add (ckbMatchWholeWord); return d; @@ -1196,10 +1121,8 @@ public class Editor : Scenario private bool Save () { - if (_fileName != null) + if (_fileName is { } && _appWindow is { }) { - // FIXED: BUGBUG: #279 TextView does not know how to deal with \r\n, only \r - // As a result files saved on Windows and then read back will show invalid chars. return SaveFile (_appWindow.Title, _fileName); } @@ -1208,11 +1131,18 @@ public class Editor : Scenario private bool SaveAs () { - List aTypes = new () + if (_appWindow is null) { - new AllowedType ("Text Files", ".txt", ".bin", ".xml"), new AllowedTypeAny () - }; - var sd = new SaveDialog { Title = "Save file", AllowedTypes = aTypes }; + return false; + } + + List aTypes = + [ + new AllowedType ("Text Files", ".txt", ".bin", ".xml"), + new AllowedTypeAny () + ]; + + SaveDialog sd = new () { Title = "Save file", AllowedTypes = aTypes }; sd.Path = _appWindow.Title; Application.Run (sd); @@ -1225,7 +1155,7 @@ public class Editor : Scenario { if (File.Exists (path)) { - if (MessageBox.Query ( + if (MessageBox.Query (ApplicationImpl.Instance, "Save File", "File already exists. Overwrite any way?", "No", @@ -1251,6 +1181,11 @@ public class Editor : Scenario private bool SaveFile (string title, string file) { + if (_appWindow is null || _textView is null) + { + return false; + } + try { _appWindow.Title = title; @@ -1259,11 +1194,11 @@ public class Editor : Scenario _originalText = Encoding.Unicode.GetBytes (_textView.Text); _saved = true; _textView.ClearHistoryChanges (); - MessageBox.Query ("Save File", "File was successfully saved.", "Ok"); + MessageBox.Query (ApplicationImpl.Instance, "Save File", "File was successfully saved.", "Ok"); } catch (Exception ex) { - MessageBox.ErrorQuery ("Error", ex.Message, "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Error", ex.Message, "Ok"); return false; } @@ -1271,13 +1206,121 @@ public class Editor : Scenario return true; } - private void SelectAll () { _textView.SelectAll (); } + private void SelectAll () { _textView?.SelectAll (); } private void SetFindText () { + if (_textView is null) + { + return; + } + _textToFind = !string.IsNullOrEmpty (_textView.SelectedText) ? _textView.SelectedText : string.IsNullOrEmpty (_textToFind) ? "" : _textToFind; _textToReplace = string.IsNullOrEmpty (_textToReplace) ? "" : _textToReplace; } + + private void Cut () { _textView?.Cut (); } + + private void Find () { ShowFindReplace (); } + private void FindNext () { ContinueFind (); } + private void FindPrevious () { ContinueFind (false); } + + private void ShowFindReplace (bool isFind = true) + { + if (_findReplaceWindow is null || _tabView is null) + { + return; + } + + _findReplaceWindow.Visible = true; + _findReplaceWindow.SuperView?.MoveSubViewToStart (_findReplaceWindow); + _tabView.SetFocus (); + _tabView.SelectedTab = isFind ? _tabView.Tabs.ToArray () [0] : _tabView.Tabs.ToArray () [1]; + _tabView.SelectedTab?.View?.FocusDeepest (NavigationDirection.Forward, null); + } + + private void CreateFindReplace () + { + if (_textView is null || _appWindow is null) + { + return; + } + + _findReplaceWindow = new (_textView); + + _tabView = new () + { + X = 0, + Y = 0, + Width = Dim.Fill (), + Height = Dim.Fill (0) + }; + + _tabView.AddTab (new () { DisplayText = "Find", View = CreateFindTab () }, true); + _tabView.AddTab (new () { DisplayText = "Replace", View = CreateReplaceTab () }, false); + + _tabView.SelectedTabChanged += (s, e) => { _tabView.SelectedTab?.View?.FocusDeepest (NavigationDirection.Forward, null); }; + + _findReplaceWindow.Add (_tabView); + _findReplaceWindow.Visible = false; + _appWindow.Add (_findReplaceWindow); + } + + private class FindReplaceWindow : Window + { + private readonly TextView _textView; + + public FindReplaceWindow (TextView textView) + { + Title = "Find and Replace"; + + _textView = textView; + X = Pos.AnchorEnd () - 1; + Y = 2; + Width = 57; + Height = 11; + Arrangement = ViewArrangement.Movable; + + KeyBindings.Add (Key.Esc, Command.Cancel); + + AddCommand ( + Command.Cancel, + () => + { + Visible = false; + + return true; + }); + + VisibleChanged += FindReplaceWindow_VisibleChanged; + Initialized += FindReplaceWindow_Initialized; + } + + private void FindReplaceWindow_Initialized (object? sender, EventArgs e) + { + if (Border is { }) + { + Border.LineStyle = LineStyle.Dashed; + Border.Thickness = new (0, 1, 0, 0); + } + } + + private void FindReplaceWindow_VisibleChanged (object? sender, EventArgs e) + { + if (!Visible) + { + _textView.SetFocus (); + } + else + { + FocusDeepest (NavigationDirection.Forward, null); + } + } + } } + + + + diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/AllViewsView.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/AllViewsView.cs index 862cc2083..f8f78ac6f 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/AllViewsView.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/AllViewsView.cs @@ -4,6 +4,7 @@ namespace UICatalog.Scenarios; public class AllViewsView : View { private const int MAX_VIEW_FRAME_HEIGHT = 25; + public AllViewsView () { CanFocus = true; @@ -24,6 +25,7 @@ public class AllViewsView : View AddCommand (Command.Down, () => ScrollVertical (1)); AddCommand (Command.PageUp, () => ScrollVertical (-SubViews.OfType ().First ().Frame.Height)); AddCommand (Command.PageDown, () => ScrollVertical (SubViews.OfType ().First ().Frame.Height)); + AddCommand ( Command.Start, () => @@ -32,6 +34,7 @@ public class AllViewsView : View return true; }); + AddCommand ( Command.End, () => @@ -65,12 +68,12 @@ public class AllViewsView : View MouseBindings.Add (MouseFlags.WheeledRight, Command.ScrollRight); } - /// + /// public override void EndInit () { base.EndInit (); - var allClasses = GetAllViewClassesCollection (); + List allClasses = GetAllViewClassesCollection (); View? previousView = null; @@ -95,19 +98,6 @@ public class AllViewsView : View } } - private static List GetAllViewClassesCollection () - { - List types = typeof (View).Assembly.GetTypes () - .Where ( - myType => myType is { IsClass: true, IsAbstract: false, IsPublic: true } - && myType.IsSubclassOf (typeof (View))) - .ToList (); - - types.Add (typeof (View)); - - return types; - } - private View? CreateView (Type type) { // If we are to create a generic Type @@ -125,12 +115,32 @@ public class AllViewsView : View } else { - typeArguments.Add (typeof (object)); + // Check if the generic parameter has constraints + Type [] constraints = arg.GetGenericParameterConstraints (); + + if (constraints.Length > 0) + { + // Use the first constraint type to satisfy the constraint + typeArguments.Add (constraints [0]); + } + else + { + typeArguments.Add (typeof (object)); + } } } // And change what type we are instantiating from MyClass to MyClass or MyClass - type = type.MakeGenericType (typeArguments.ToArray ()); + try + { + type = type.MakeGenericType (typeArguments.ToArray ()); + } + catch (ArgumentException ex) + { + Logging.Warning ($"Cannot create generic type {type} with arguments [{string.Join (", ", typeArguments.Select (t => t.Name))}]: {ex.Message}"); + + return null; + } } // Ensure the type does not contain any generic parameters @@ -164,6 +174,18 @@ public class AllViewsView : View return view; } + private static List GetAllViewClassesCollection () + { + List types = typeof (View).Assembly.GetTypes () + .Where (myType => myType is { IsClass: true, IsAbstract: false, IsPublic: true } + && myType.IsSubclassOf (typeof (View))) + .ToList (); + + types.Add (typeof (View)); + + return types; + } + private void OnViewInitialized (object? sender, EventArgs e) { if (sender is not View view) diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ArrangementEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ArrangementEditor.cs index 334450fbb..a9702d39c 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/ArrangementEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/ArrangementEditor.cs @@ -45,7 +45,7 @@ public sealed class ArrangementEditor : EditorBase if (ViewToEdit.Arrangement.HasFlag (ViewArrangement.Overlapped)) { ViewToEdit.ShadowStyle = ShadowStyle.Transparent; - ViewToEdit.SchemeName = "Toplevel"; + ViewToEdit.SchemeName = "Runnable"; } else { diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/DimEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/DimEditor.cs index ff372ecc7..7f1f795c9 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/DimEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/DimEditor.cs @@ -157,7 +157,7 @@ public class DimEditor : EditorBase } catch (Exception e) { - MessageBox.ErrorQuery ("Exception", e.Message, "Ok"); + MessageBox.ErrorQuery (App, "Exception", e.Message, "Ok"); } } } diff --git a/Examples/UICatalog/Scenarios/EditorsAndHelpers/PosEditor.cs b/Examples/UICatalog/Scenarios/EditorsAndHelpers/PosEditor.cs index 45f0ab950..467b54756 100644 --- a/Examples/UICatalog/Scenarios/EditorsAndHelpers/PosEditor.cs +++ b/Examples/UICatalog/Scenarios/EditorsAndHelpers/PosEditor.cs @@ -160,7 +160,7 @@ public class PosEditor : EditorBase } catch (Exception e) { - MessageBox.ErrorQuery ("Exception", e.Message, "Ok"); + MessageBox.ErrorQuery (App, "Exception", e.Message, "Ok"); } } } diff --git a/Examples/UICatalog/Scenarios/FileDialogExamples.cs b/Examples/UICatalog/Scenarios/FileDialogExamples.cs index 290e4a432..4621356f1 100644 --- a/Examples/UICatalog/Scenarios/FileDialogExamples.cs +++ b/Examples/UICatalog/Scenarios/FileDialogExamples.cs @@ -133,7 +133,7 @@ public class FileDialogExamples : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery ("Error", ex.ToString (), "_Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Error", ex.ToString (), "_Ok"); } finally { @@ -153,7 +153,7 @@ public class FileDialogExamples : Scenario { if (File.Exists (e.Dialog.Path)) { - int result = MessageBox.Query ("Overwrite?", "File already exists", "_Yes", "_No"); + int? result = MessageBox.Query (ApplicationImpl.Instance, "Overwrite?", "File already exists", "_Yes", "_No"); e.Cancel = result == 1; } } @@ -243,12 +243,12 @@ public class FileDialogExamples : Scenario IReadOnlyList multiSelected = fd.MultiSelected; string path = fd.Path; - // This needs to be disposed before opening other toplevel + // This needs to be disposed before opening other runnable fd.Dispose (); if (canceled) { - MessageBox.Query ( + MessageBox.Query (ApplicationImpl.Instance, "Canceled", "You canceled navigation and did not pick anything", "Ok" @@ -256,7 +256,7 @@ public class FileDialogExamples : Scenario } else if (_cbAllowMultipleSelection.CheckedState == CheckState.Checked) { - MessageBox.Query ( + MessageBox.Query (ApplicationImpl.Instance, "Chosen!", "You chose:" + Environment.NewLine + string.Join (Environment.NewLine, multiSelected.Select (m => m)), "Ok" @@ -264,7 +264,7 @@ public class FileDialogExamples : Scenario } else { - MessageBox.Query ( + MessageBox.Query (ApplicationImpl.Instance, "Chosen!", "You chose:" + Environment.NewLine + path, "Ok" diff --git a/Examples/UICatalog/Scenarios/Generic.cs b/Examples/UICatalog/Scenarios/Generic.cs index f0da0dd53..a8c3c7266 100644 --- a/Examples/UICatalog/Scenarios/Generic.cs +++ b/Examples/UICatalog/Scenarios/Generic.cs @@ -29,7 +29,7 @@ public sealed class Generic : Scenario { // When Accepting is handled, set e.Handled to true to prevent further processing. e.Handled = true; - MessageBox.ErrorQuery ("Error", "You pressed the button!", "_Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Error", "You pressed the button!", "_Ok"); }; appWindow.Add (button); diff --git a/Examples/UICatalog/Scenarios/GraphViewExample.cs b/Examples/UICatalog/Scenarios/GraphViewExample.cs index 5dcd5df40..203896e68 100644 --- a/Examples/UICatalog/Scenarios/GraphViewExample.cs +++ b/Examples/UICatalog/Scenarios/GraphViewExample.cs @@ -1,9 +1,6 @@ -using System; -using System.Collections.Generic; -using System.ComponentModel; -using System.Linq; +#nullable enable + using System.Text; -using Application = Terminal.Gui.App.Application; namespace UICatalog.Scenarios; @@ -13,144 +10,53 @@ namespace UICatalog.Scenarios; public class GraphViewExample : Scenario { private readonly Thickness _thickness = new (1, 1, 1, 1); - private TextView _about; + private TextView? _about; private int _currentGraph; - private Action [] _graphs; - private GraphView _graphView; - private MenuItem _miDiags; - private MenuItem _miShowBorder; + private Action []? _graphs; + private GraphView? _graphView; + private CheckBox? _diagCheckBox; + private CheckBox? _showBorderCheckBox; private ViewDiagnosticFlags _viewDiagnostics; public override void Main () { Application.Init (); - Toplevel app = new (); - _graphs = new [] + Window app = new () { - () => SetupPeriodicTableScatterPlot (), //0 - () => SetupLifeExpectancyBarGraph (true), //1 - () => SetupLifeExpectancyBarGraph (false), //2 - () => SetupPopulationPyramid (), //3 - () => SetupLineGraph (), //4 - () => SetupSineWave (), //5 - () => SetupDisco (), //6 - () => MultiBarGraph () //7 + BorderStyle = LineStyle.None }; - var menu = new MenuBar - { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new ( - "Scatter _Plot", - "", - () => _graphs [_currentGraph = - 0] () - ), - new ( - "_V Bar Graph", - "", - () => _graphs [_currentGraph = - 1] () - ), - new ( - "_H Bar Graph", - "", - () => _graphs [_currentGraph = - 2] () - ), - new ( - "P_opulation Pyramid", - "", - () => _graphs [_currentGraph = - 3] () - ), - new ( - "_Line Graph", - "", - () => _graphs [_currentGraph = - 4] () - ), - new ( - "Sine _Wave", - "", - () => _graphs [_currentGraph = - 5] () - ), - new ( - "Silent _Disco", - "", - () => _graphs [_currentGraph = - 6] () - ), - new ( - "_Multi Bar Graph", - "", - () => _graphs [_currentGraph = - 7] () - ), - new ("_Quit", "", () => Quit ()) - } - ), - new ( - "_View", - new [] - { - new ("Zoom _In", "", () => Zoom (0.5f)), - new ("Zoom _Out", "", () => Zoom (2f)), - new ("MarginLeft++", "", () => Margin (true, true)), - new ("MarginLeft--", "", () => Margin (true, false)), - new ("MarginBottom++", "", () => Margin (false, true)), - new ("MarginBottom--", "", () => Margin (false, false)), - _miShowBorder = new ( - "_Enable Margin, Border, and Padding", - "", - () => ShowBorder () - ) - { - Checked = true, - CheckType = MenuItemCheckStyle - .Checked - }, - _miDiags = new ( - "_Diagnostics", - "", - () => ToggleDiagnostics () - ) - { - Checked = View.Diagnostics - == (ViewDiagnosticFlags - .Thickness - | ViewDiagnosticFlags - .Ruler), - CheckType = MenuItemCheckStyle.Checked - } - } - ) - ] - }; - app.Add (menu); + _graphs = + [ + SetupPeriodicTableScatterPlot, + () => SetupLifeExpectancyBarGraph (true), + () => SetupLifeExpectancyBarGraph (false), + SetupPopulationPyramid, + SetupLineGraph, + SetupSineWave, + SetupDisco, + MultiBarGraph + ]; + // MenuBar + MenuBar menu = new (); + + // GraphView _graphView = new () { X = 0, - Y = 1, + Y = Pos.Bottom (menu), Width = Dim.Percent (70), Height = Dim.Fill (1), BorderStyle = LineStyle.Single }; _graphView.Border!.Thickness = _thickness; _graphView.Margin!.Thickness = _thickness; - _graphView.Padding.Thickness = _thickness; + _graphView.Padding!.Thickness = _thickness; - app.Add (_graphView); - - var frameRight = new FrameView + // About TextView + FrameView frameRight = new () { X = Pos.Right (_graphView), Y = Pos.Top (_graphView), @@ -159,23 +65,24 @@ public class GraphViewExample : Scenario Title = "About" }; - frameRight.Add ( - _about = new () { Width = Dim.Fill (), Height = Dim.Fill (), ReadOnly = true } - ); + _about = new () + { + Width = Dim.Fill (), + Height = Dim.Fill (), + ReadOnly = true + }; + frameRight.Add (_about); - app.Add (frameRight); + // StatusBar + StatusBar statusBar = new ( + [ + new (Key.G.WithCtrl, "Next Graph", () => _graphs! [_currentGraph++ % _graphs.Length] ()), + new (Key.PageUp, "Zoom In", () => Zoom (0.5f)), + new (Key.PageDown, "Zoom Out", () => Zoom (2f)) + ] + ); - var statusBar = new StatusBar ( - new Shortcut [] - { - new (Key.G.WithCtrl, "Next Graph", () => _graphs [_currentGraph++ % _graphs.Length] ()), - new (Key.PageUp, "Zoom In", () => Zoom (0.5f)), - new (Key.PageDown, "Zoom Out", () => Zoom (2f)) - } - ); - app.Add (statusBar); - - var diagShortcut = new Shortcut + Shortcut? diagShortcut = new () { Key = Key.F10, CommandView = new CheckBox @@ -184,7 +91,128 @@ public class GraphViewExample : Scenario CanFocus = false } }; - statusBar.Add (diagShortcut).Accepting += DiagShortcut_Accept; + + statusBar.Add (diagShortcut); + diagShortcut.Accepting += DiagShortcut_Accept; + + // Menu setup + _showBorderCheckBox = new () + { + Title = "_Enable Margin, Border, and Padding", + CheckedState = CheckState.Checked + }; + _showBorderCheckBox.CheckedStateChanged += (s, e) => ShowBorder (); + + _diagCheckBox = new () + { + Title = "_Diagnostics", + CheckedState = View.Diagnostics == (ViewDiagnosticFlags.Thickness | ViewDiagnosticFlags.Ruler) + ? CheckState.Checked + : CheckState.UnChecked + }; + _diagCheckBox.CheckedStateChanged += (s, e) => ToggleDiagnostics (); + + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem + { + Title = "Scatter _Plot", + Action = () => _graphs [_currentGraph = 0] () + }, + new MenuItem + { + Title = "_V Bar Graph", + Action = () => _graphs [_currentGraph = 1] () + }, + new MenuItem + { + Title = "_H Bar Graph", + Action = () => _graphs [_currentGraph = 2] () + }, + new MenuItem + { + Title = "P_opulation Pyramid", + Action = () => _graphs [_currentGraph = 3] () + }, + new MenuItem + { + Title = "_Line Graph", + Action = () => _graphs [_currentGraph = 4] () + }, + new MenuItem + { + Title = "Sine _Wave", + Action = () => _graphs [_currentGraph = 5] () + }, + new MenuItem + { + Title = "Silent _Disco", + Action = () => _graphs [_currentGraph = 6] () + }, + new MenuItem + { + Title = "_Multi Bar Graph", + Action = () => _graphs [_currentGraph = 7] () + }, + new MenuItem + { + Title = "_Quit", + Action = Quit + } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "_View", + [ + new MenuItem + { + Title = "Zoom _In", + Action = () => Zoom (0.5f) + }, + new MenuItem + { + Title = "Zoom _Out", + Action = () => Zoom (2f) + }, + new MenuItem + { + Title = "MarginLeft++", + Action = () => Margin (true, true) + }, + new MenuItem + { + Title = "MarginLeft--", + Action = () => Margin (true, false) + }, + new MenuItem + { + Title = "MarginBottom++", + Action = () => Margin (false, true) + }, + new MenuItem + { + Title = "MarginBottom--", + Action = () => Margin (false, false) + }, + new MenuItem + { + CommandView = _showBorderCheckBox + }, + new MenuItem + { + CommandView = _diagCheckBox + } + ] + ) + ); + + // Add views in order of visual appearance + app.Add (menu, _graphView, frameRight, statusBar); _graphs [_currentGraph++ % _graphs.Length] (); @@ -195,29 +223,31 @@ public class GraphViewExample : Scenario Application.Shutdown (); } - private void DiagShortcut_Accept (object sender, CommandEventArgs e) + private void DiagShortcut_Accept (object? sender, CommandEventArgs e) { ToggleDiagnostics (); if (sender is Shortcut shortcut && shortcut.CommandView is CheckBox checkBox) { - checkBox.CheckedState = _miDiags.Checked ?? false ? CheckState.Checked : CheckState.UnChecked; + checkBox.CheckedState = _diagCheckBox?.CheckedState ?? CheckState.UnChecked; } } private void ToggleDiagnostics () { - _miDiags.Checked = !_miDiags.Checked; - - View.Diagnostics = _miDiags.Checked == true - ? ViewDiagnosticFlags.Thickness - | ViewDiagnosticFlags.Ruler + View.Diagnostics = _diagCheckBox?.CheckedState == CheckState.Checked + ? ViewDiagnosticFlags.Thickness | ViewDiagnosticFlags.Ruler : ViewDiagnosticFlags.Off; Application.LayoutAndDraw (); } private void Margin (bool left, bool increase) { + if (_graphView is null) + { + return; + } + if (left) { _graphView.MarginLeft = (uint)Math.Max (0, _graphView.MarginLeft + (increase ? 1 : -1)); @@ -232,6 +262,11 @@ public class GraphViewExample : Scenario private void MultiBarGraph () { + if (_graphView is null || _about is null) + { + return; + } + _graphView.Reset (); _graphView.Title = "Multi Bar"; @@ -241,14 +276,14 @@ public class GraphViewExample : Scenario Color fore = _graphView.GetAttributeForRole (VisualRole.Normal).Foreground == Color.Black ? Color.White : _graphView.GetAttributeForRole (VisualRole.Normal).Foreground; - var black = new Attribute (fore, Color.Black); - var cyan = new Attribute (Color.BrightCyan, Color.Black); - var magenta = new Attribute (Color.BrightMagenta, Color.Black); - var red = new Attribute (Color.BrightRed, Color.Black); + Attribute black = new (fore, Color.Black); + Attribute cyan = new (Color.BrightCyan, Color.Black); + Attribute magenta = new (Color.BrightMagenta, Color.Black); + Attribute red = new (Color.BrightRed, Color.Black); _graphView.GraphColor = black; - var series = new MultiBarSeries (3, 1, 0.25f, new [] { magenta, cyan, red }); + MultiBarSeries series = new (3, 1, 0.25f, [magenta, cyan, red]); Rune stiple = Glyphs.Stipple; @@ -277,20 +312,20 @@ public class GraphViewExample : Scenario _graphView.AxisY.Minimum = 0; - var legend = new LegendAnnotation (new (_graphView.Viewport.Width - 20, 0, 20, 5)); + LegendAnnotation legend = new (new (_graphView.Viewport.Width - 20, 0, 20, 5)); legend.AddEntry ( - new (stiple, series.SubSeries.ElementAt (0).OverrideBarColor), + new (stiple, series.SubSeries.ElementAt (0).OverrideBarColor ?? black), "Lower Third" ); legend.AddEntry ( - new (stiple, series.SubSeries.ElementAt (1).OverrideBarColor), + new (stiple, series.SubSeries.ElementAt (1).OverrideBarColor ?? cyan), "Middle Third" ); legend.AddEntry ( - new (stiple, series.SubSeries.ElementAt (2).OverrideBarColor), + new (stiple, series.SubSeries.ElementAt (2).OverrideBarColor ?? red), "Upper Third" ); _graphView.Annotations.Add (legend); @@ -300,6 +335,11 @@ public class GraphViewExample : Scenario private void SetupDisco () { + if (_graphView is null || _about is null) + { + return; + } + _graphView.Reset (); _graphView.Title = "Graphic Equalizer"; @@ -308,11 +348,11 @@ public class GraphViewExample : Scenario _graphView.GraphColor = new Attribute (Color.White, Color.Black); - var stiple = new GraphCellToRender ((Rune)'\u2593'); + GraphCellToRender stiple = new ((Rune)'\u2593'); - var r = new Random (); - var series = new DiscoBarSeries (); - List bars = new (); + Random r = new (); + DiscoBarSeries series = new (); + List bars = []; Func genSample = () => { @@ -323,16 +363,13 @@ public class GraphViewExample : Scenario { bars.Add ( new (null, stiple, r.Next (0, 100)) - { - //ColorGetter = colorDelegate - } ); } - _graphView.SetNeedsDraw (); + _graphView?.SetNeedsDraw (); // while the equaliser is showing - return _graphView.Series.Contains (series); + return _graphView is { } && _graphView.Series.Contains (series); }; Application.AddTimeout (TimeSpan.FromMilliseconds (250), genSample); @@ -351,120 +388,45 @@ public class GraphViewExample : Scenario _graphView.SetNeedsDraw (); } - /* - Country,Both,Male,Female - -"Switzerland",83.4,81.8,85.1 -"South Korea",83.3,80.3,86.1 -"Singapore",83.2,81,85.5 -"Spain",83.2,80.7,85.7 -"Cyprus",83.1,81.1,85.1 -"Australia",83,81.3,84.8 -"Italy",83,80.9,84.9 -"Norway",83,81.2,84.7 -"Israel",82.6,80.8,84.4 -"France",82.5,79.8,85.1 -"Luxembourg",82.4,80.6,84.2 -"Sweden",82.4,80.8,84 -"Iceland",82.3,80.8,83.9 -"Canada",82.2,80.4,84.1 -"New Zealand",82,80.4,83.5 -"Malta,81.9",79.9,83.8 -"Ireland",81.8,80.2,83.5 -"Netherlands",81.8,80.4,83.1 -"Germany",81.7,78.7,84.8 -"Austria",81.6,79.4,83.8 -"Finland",81.6,79.2,84 -"Portugal",81.6,78.6,84.4 -"Belgium",81.4,79.3,83.5 -"United Kingdom",81.4,79.8,83 -"Denmark",81.3,79.6,83 -"Slovenia",81.3,78.6,84.1 -"Greece",81.1,78.6,83.6 -"Kuwait",81,79.3,83.9 -"Costa Rica",80.8,78.3,83.4*/ private void SetupLifeExpectancyBarGraph (bool verticalBars) { + if (_graphView is null || _about is null) + { + return; + } + _graphView.Reset (); _graphView.Title = $"Life Expectancy - {(verticalBars ? "Vertical" : "Horizontal")}"; _about.Text = "This graph shows the life expectancy at birth of a range of countries"; - var softStiple = new GraphCellToRender ((Rune)'\u2591'); - var mediumStiple = new GraphCellToRender ((Rune)'\u2592'); + GraphCellToRender softStiple = new ((Rune)'\u2591'); + GraphCellToRender mediumStiple = new ((Rune)'\u2592'); - var barSeries = new BarSeries + BarSeries barSeries = new () { - Bars = new () - { + Bars = + [ new ("Switzerland", softStiple, 83.4f), - new ( - "South Korea", - !verticalBars - ? mediumStiple - : softStiple, - 83.3f - ), + new ("South Korea", !verticalBars ? mediumStiple : softStiple, 83.3f), new ("Singapore", softStiple, 83.2f), - new ( - "Spain", - !verticalBars - ? mediumStiple - : softStiple, - 83.2f - ), + new ("Spain", !verticalBars ? mediumStiple : softStiple, 83.2f), new ("Cyprus", softStiple, 83.1f), - new ( - "Australia", - !verticalBars - ? mediumStiple - : softStiple, - 83 - ), + new ("Australia", !verticalBars ? mediumStiple : softStiple, 83), new ("Italy", softStiple, 83), - new ( - "Norway", - !verticalBars - ? mediumStiple - : softStiple, - 83 - ), + new ("Norway", !verticalBars ? mediumStiple : softStiple, 83), new ("Israel", softStiple, 82.6f), - new ( - "France", - !verticalBars - ? mediumStiple - : softStiple, - 82.5f - ), + new ("France", !verticalBars ? mediumStiple : softStiple, 82.5f), new ("Luxembourg", softStiple, 82.4f), - new ( - "Sweden", - !verticalBars - ? mediumStiple - : softStiple, - 82.4f - ), + new ("Sweden", !verticalBars ? mediumStiple : softStiple, 82.4f), new ("Iceland", softStiple, 82.3f), - new ( - "Canada", - !verticalBars - ? mediumStiple - : softStiple, - 82.2f - ), + new ("Canada", !verticalBars ? mediumStiple : softStiple, 82.2f), new ("New Zealand", softStiple, 82), - new ( - "Malta", - !verticalBars - ? mediumStiple - : softStiple, - 81.9f - ), + new ("Malta", !verticalBars ? mediumStiple : softStiple, 81.9f), new ("Ireland", softStiple, 81.8f) - } + ] }; _graphView.Series.Add (barSeries); @@ -526,50 +488,62 @@ public class GraphViewExample : Scenario private void SetupLineGraph () { + if (_graphView is null || _about is null) + { + return; + } + _graphView.Reset (); _graphView.Title = "Line"; _about.Text = "This graph shows random points"; - var black = new Attribute (_graphView.GetAttributeForRole (VisualRole.Normal).Foreground, Color.Black, _graphView.GetAttributeForRole (VisualRole.Normal).Style); - var cyan = new Attribute (Color.BrightCyan, Color.Black); - var magenta = new Attribute (Color.BrightMagenta, Color.Black); - var red = new Attribute (Color.BrightRed, Color.Black); + Attribute black = new ( + _graphView.GetAttributeForRole (VisualRole.Normal).Foreground, + Color.Black, + _graphView.GetAttributeForRole (VisualRole.Normal).Style); + Attribute cyan = new (Color.BrightCyan, Color.Black); + Attribute magenta = new (Color.BrightMagenta, Color.Black); + Attribute red = new (Color.BrightRed, Color.Black); _graphView.GraphColor = black; - List randomPoints = new (); + List randomPoints = []; - var r = new Random (); + Random r = new (); for (var i = 0; i < 10; i++) { randomPoints.Add (new (r.Next (100), r.Next (100))); } - var points = new ScatterSeries { Points = randomPoints }; + ScatterSeries points = new () { Points = randomPoints }; - var line = new PathAnnotation + PathAnnotation line = new () { - LineColor = cyan, Points = randomPoints.OrderBy (p => p.X).ToList (), BeforeSeries = true + LineColor = cyan, + Points = randomPoints.OrderBy (p => p.X).ToList (), + BeforeSeries = true }; _graphView.Series.Add (points); _graphView.Annotations.Add (line); - randomPoints = new (); + randomPoints = []; for (var i = 0; i < 10; i++) { randomPoints.Add (new (r.Next (100), r.Next (100))); } - var points2 = new ScatterSeries { Points = randomPoints, Fill = new ((Rune)'x', red) }; + ScatterSeries points2 = new () { Points = randomPoints, Fill = new ((Rune)'x', red) }; - var line2 = new PathAnnotation + PathAnnotation line2 = new () { - LineColor = magenta, Points = randomPoints.OrderBy (p => p.X).ToList (), BeforeSeries = true + LineColor = magenta, + Points = randomPoints.OrderBy (p => p.X).ToList (), + BeforeSeries = true }; _graphView.Series.Add (points2); @@ -609,6 +583,11 @@ public class GraphViewExample : Scenario private void SetupPeriodicTableScatterPlot () { + if (_graphView is null || _about is null) + { + return; + } + _graphView.Reset (); _graphView.Title = "Scatter Plot"; @@ -620,8 +599,8 @@ public class GraphViewExample : Scenario _graphView.Series.Add ( new ScatterSeries { - Points = new () - { + Points = + [ new (1, 1.007f), new (2, 4.002f), new (3, 6.941f), @@ -737,7 +716,7 @@ public class GraphViewExample : Scenario new (116, 292), new (117, 295), new (118, 294) - } + ] } ); @@ -764,29 +743,10 @@ public class GraphViewExample : Scenario private void SetupPopulationPyramid () { - /* - Age,M,F -0-4,2009363,1915127 -5-9,2108550,2011016 -10-14,2022370,1933970 -15-19,1880611,1805522 -20-24,2072674,2001966 -25-29,2275138,2208929 -30-34,2361054,2345774 -35-39,2279836,2308360 -40-44,2148253,2159877 -45-49,2128343,2167778 -50-54,2281421,2353119 -55-59,2232388,2306537 -60-64,1919839,1985177 -65-69,1647391,1734370 -70-74,1624635,1763853 -75-79,1137438,1304709 -80-84,766956,969611 -85-89,438663,638892 -90-94,169952,320625 -95-99,34524,95559 -100+,3016,12818*/ + if (_graphView is null || _about is null) + { + return; + } _about.Text = "This graph shows population of each age divided by gender"; @@ -816,16 +776,16 @@ public class GraphViewExample : Scenario _graphView.AxisY.ShowLabelsEvery = 0; _graphView.AxisY.Minimum = 0; - var stiple = new GraphCellToRender (Glyphs.Stipple); + GraphCellToRender stiple = new (Glyphs.Stipple); // Bars in 2 directions // Males (negative to make the bars go left) - var malesSeries = new BarSeries + BarSeries malesSeries = new () { Orientation = Orientation.Horizontal, - Bars = new () - { + Bars = + [ new ("0-4", stiple, -2009363), new ("5-9", stiple, -2108550), new ("10-14", stiple, -2022370), @@ -847,16 +807,16 @@ public class GraphViewExample : Scenario new ("90-94", stiple, -169952), new ("95-99", stiple, -34524), new ("100+", stiple, -3016) - } + ] }; _graphView.Series.Add (malesSeries); // Females - var femalesSeries = new BarSeries + BarSeries femalesSeries = new () { Orientation = Orientation.Horizontal, - Bars = new () - { + Bars = + [ new ("0-4", stiple, 1915127), new ("5-9", stiple, 2011016), new ("10-14", stiple, 1933970), @@ -878,11 +838,11 @@ public class GraphViewExample : Scenario new ("90-94", stiple, 320625), new ("95-99", stiple, 95559), new ("100+", stiple, 12818) - } + ] }; - var softStiple = new GraphCellToRender ((Rune)'\u2591'); - var mediumStiple = new GraphCellToRender ((Rune)'\u2592'); + GraphCellToRender softStiple = new ((Rune)'\u2591'); + GraphCellToRender mediumStiple = new ((Rune)'\u2592'); for (var i = 0; i < malesSeries.Bars.Count; i++) { @@ -903,14 +863,19 @@ public class GraphViewExample : Scenario private void SetupSineWave () { + if (_graphView is null || _about is null) + { + return; + } + _graphView.Reset (); _graphView.Title = "Sine Wave"; _about.Text = "This graph shows a sine wave"; - var points = new ScatterSeries (); - var line = new PathAnnotation (); + ScatterSeries points = new (); + PathAnnotation line = new (); // Draw line first so it does not draw over top of points or axis labels line.BeforeSeries = true; @@ -950,25 +915,33 @@ public class GraphViewExample : Scenario private void ShowBorder () { - _miShowBorder.Checked = !_miShowBorder.Checked; + if (_graphView is null) + { + return; + } - if (_miShowBorder.Checked == true) + if (_showBorderCheckBox?.CheckedState == CheckState.Checked) { _graphView.BorderStyle = LineStyle.Single; _graphView.Border!.Thickness = _thickness; _graphView.Margin!.Thickness = _thickness; - _graphView.Padding.Thickness = _thickness; + _graphView.Padding!.Thickness = _thickness; } else { _graphView.BorderStyle = LineStyle.None; _graphView.Margin!.Thickness = Thickness.Empty; - _graphView.Padding.Thickness = Thickness.Empty; + _graphView.Padding!.Thickness = Thickness.Empty; } } private void Zoom (float factor) { + if (_graphView is null) + { + return; + } + _graphView.CellSize = new ( _graphView.CellSize.X * factor, _graphView.CellSize.Y * factor @@ -980,7 +953,7 @@ public class GraphViewExample : Scenario _graphView.SetNeedsDraw (); } - private class DiscoBarSeries : BarSeries + private sealed class DiscoBarSeries : BarSeries { private readonly Attribute _brightgreen; private readonly Attribute _brightred; @@ -999,35 +972,22 @@ public class GraphViewExample : Scenario protected override void DrawBarLine (GraphView graph, Point start, Point end, BarSeriesBar beingDrawn) { - IDriver driver = Application.Driver; - int x = start.X; for (int y = end.Y; y <= start.Y; y++) { float height = graph.ScreenToGraphSpace (x, y).Y; - if (height >= 85) - { - graph.SetAttribute (_red); - } - else if (height >= 66) - { - graph.SetAttribute (_brightred); - } - else if (height >= 45) - { - graph.SetAttribute (_brightyellow); - } - else if (height >= 25) - { - graph.SetAttribute (_brightgreen); - } - else - { - graph.SetAttribute (_green); - } + Attribute attr = height switch + { + >= 85 => _red, + >= 66 => _brightred, + >= 45 => _brightyellow, + >= 25 => _brightgreen, + _ => _green + }; + graph.SetAttribute (attr); graph.AddRune (x, y, beingDrawn.Fill.Rune); } } diff --git a/Examples/UICatalog/Scenarios/HexEditor.cs b/Examples/UICatalog/Scenarios/HexEditor.cs index 9b13e1656..fdd4b5e83 100644 --- a/Examples/UICatalog/Scenarios/HexEditor.cs +++ b/Examples/UICatalog/Scenarios/HexEditor.cs @@ -14,7 +14,7 @@ public class HexEditor : Scenario { private string? _fileName; private HexView? _hexView; - private MenuItemv2? _miReadOnly; + private MenuItem? _miReadOnly; private bool _saved = true; private Shortcut? _scAddress; private Shortcut? _scInfo; @@ -49,13 +49,13 @@ public class HexEditor : Scenario app.Add (_hexView); - var menu = new MenuBarv2 + var menu = new MenuBar { Menus = [ new ( "_File", - new MenuItemv2 [] + new MenuItem [] { new ("_New", "", New), new ("_Open", "", Open), @@ -66,7 +66,7 @@ public class HexEditor : Scenario ), new ( "_Edit", - new MenuItemv2 [] + new MenuItem [] { new ("_Copy", "", Copy), new ("C_ut", "", Cut), @@ -75,7 +75,7 @@ public class HexEditor : Scenario ), new ( "_Options", - new MenuItemv2 [] + new MenuItem [] { _miReadOnly = new ( "_Read Only", @@ -181,7 +181,7 @@ public class HexEditor : Scenario } } - private void Copy () { MessageBox.ErrorQuery ("Not Implemented", "Functionality not yet implemented.", "Ok"); } + private void Copy () { MessageBox.ErrorQuery (ApplicationImpl.Instance, "Not Implemented", "Functionality not yet implemented.", "Ok"); } private void CreateDemoFile (string fileName) { @@ -208,7 +208,7 @@ public class HexEditor : Scenario ms.Close (); } - private void Cut () { MessageBox.ErrorQuery ("Not Implemented", "Functionality not yet implemented.", "Ok"); } + private void Cut () { MessageBox.ErrorQuery (ApplicationImpl.Instance, "Not Implemented", "Functionality not yet implemented.", "Ok"); } private Stream LoadFile () { @@ -216,7 +216,7 @@ public class HexEditor : Scenario if (!_saved && _hexView!.Edits.Count > 0 && _hexView.Source is {}) { - if (MessageBox.ErrorQuery ( + if (MessageBox.ErrorQuery (ApplicationImpl.Instance, "Save", "The changes were not saved. Want to open without saving?", "_Yes", @@ -267,7 +267,7 @@ public class HexEditor : Scenario d.Dispose (); } - private void Paste () { MessageBox.ErrorQuery ("Not Implemented", "Functionality not yet implemented.", "_Ok"); } + private void Paste () { MessageBox.ErrorQuery (ApplicationImpl.Instance, "Not Implemented", "Functionality not yet implemented.", "_Ok"); } private void Quit () { Application.RequestStop (); } private void Save () diff --git a/Examples/UICatalog/Scenarios/Images.cs b/Examples/UICatalog/Scenarios/Images.cs index 488f595a7..5791166cb 100644 --- a/Examples/UICatalog/Scenarios/Images.cs +++ b/Examples/UICatalog/Scenarios/Images.cs @@ -151,7 +151,7 @@ public class Images : Scenario _win.Add (_tabView); // Start trying to detect sixel support - var sixelSupportDetector = new SixelSupportDetector (); + var sixelSupportDetector = new SixelSupportDetector (Application.Driver); sixelSupportDetector.Detect (UpdateSixelSupportState); Application.Run (_win); @@ -183,7 +183,7 @@ public class Images : Scenario if (!_sixelSupportResult.SupportsTransparency) { - if (MessageBox.Query ( + if (MessageBox.Query (ApplicationImpl.Instance, "Transparency Not Supported", "It looks like your terminal does not support transparent sixel backgrounds. Do you want to try anyway?", "Yes", @@ -288,7 +288,7 @@ public class Images : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery ("Could not open file", ex.Message, "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Could not open file", ex.Message, "Ok"); return; } @@ -492,7 +492,7 @@ public class Images : Scenario { if (_imageView.FullResImage == null) { - MessageBox.Query ("No Image Loaded", "You must first open an image. Use the 'Open Image' button above.", "Ok"); + MessageBox.Query (ApplicationImpl.Instance, "No Image Loaded", "You must first open an image. Use the 'Open Image' button above.", "Ok"); return; } diff --git a/Examples/UICatalog/Scenarios/InteractiveTree.cs b/Examples/UICatalog/Scenarios/InteractiveTree.cs index c3b414901..d90af1fa4 100644 --- a/Examples/UICatalog/Scenarios/InteractiveTree.cs +++ b/Examples/UICatalog/Scenarios/InteractiveTree.cs @@ -1,4 +1,4 @@ -using System.Linq; +#nullable enable namespace UICatalog.Scenarios; @@ -7,46 +7,54 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("TreeView")] public class InteractiveTree : Scenario { - private TreeView _treeView; + private TreeView? _treeView; public override void Main () { Application.Init (); - var appWindow = new Toplevel () + + Window appWindow = new () { Title = GetName (), + BorderStyle = LineStyle.None }; - var menu = new MenuBar - { - Menus = - [ - new ("_File", new MenuItem [] { new ("_Quit", "", Quit) }) - ] - }; - appWindow.Add (menu); + // MenuBar + MenuBar menu = new (); + + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem + { + Title = "_Quit", + Action = Quit + } + ] + ) + ); _treeView = new () { X = 0, - Y = 1, + Y = Pos.Bottom (menu), Width = Dim.Fill (), Height = Dim.Fill (1) }; _treeView.KeyDown += TreeView_KeyPress; - appWindow.Add (_treeView); + // StatusBar + StatusBar statusBar = new ( + [ + new (Application.QuitKey, "Quit", Quit), + new (Key.C.WithCtrl, "Add Child", AddChildNode), + new (Key.T.WithCtrl, "Add Root", AddRootNode), + new (Key.R.WithCtrl, "Rename Node", RenameNode) + ] + ); - var statusBar = new StatusBar ( - new Shortcut [] - { - new (Application.QuitKey, "Quit", Quit), - new (Key.C.WithCtrl, "Add Child", AddChildNode), - new (Key.T.WithCtrl, "Add Root", AddRootNode), - new (Key.R.WithCtrl, "Rename Node", RenameNode) - } - ); - appWindow.Add (statusBar); + appWindow.Add (menu, _treeView, statusBar); Application.Run (appWindow); appWindow.Dispose (); @@ -55,9 +63,14 @@ public class InteractiveTree : Scenario private void AddChildNode () { - ITreeNode node = _treeView.SelectedObject; + if (_treeView is null) + { + return; + } - if (node != null) + ITreeNode? node = _treeView.SelectedObject; + + if (node is { }) { if (GetText ("Text", "Enter text for node:", "", out string entered)) { @@ -69,6 +82,11 @@ public class InteractiveTree : Scenario private void AddRootNode () { + if (_treeView is null) + { + return; + } + if (GetText ("Text", "Enter text for node:", "", out string entered)) { _treeView.AddObject (new TreeNode (entered)); @@ -79,20 +97,20 @@ public class InteractiveTree : Scenario { var okPressed = false; - var ok = new Button { Text = "Ok", IsDefault = true }; + Button ok = new () { Text = "Ok", IsDefault = true }; ok.Accepting += (s, e) => - { - okPressed = true; - Application.RequestStop (); - }; - var cancel = new Button { Text = "Cancel" }; + { + okPressed = true; + Application.RequestStop (); + }; + Button cancel = new () { Text = "Cancel" }; cancel.Accepting += (s, e) => Application.RequestStop (); - var d = new Dialog { Title = title, Buttons = [ok, cancel] }; + Dialog d = new () { Title = title, Buttons = [ok, cancel] }; - var lbl = new Label { X = 0, Y = 1, Text = label }; + Label lbl = new () { X = 0, Y = 1, Text = label }; - var tf = new TextField { Text = initialText, X = 0, Y = 2, Width = Dim.Fill () }; + TextField tf = new () { Text = initialText, X = 0, Y = 2, Width = Dim.Fill () }; d.Add (lbl, tf); tf.SetFocus (); @@ -100,7 +118,7 @@ public class InteractiveTree : Scenario Application.Run (d); d.Dispose (); - enteredText = okPressed ? tf.Text : null; + enteredText = okPressed ? tf.Text : string.Empty; return okPressed; } @@ -109,9 +127,14 @@ public class InteractiveTree : Scenario private void RenameNode () { - ITreeNode node = _treeView.SelectedObject; + if (_treeView is null) + { + return; + } - if (node != null) + ITreeNode? node = _treeView.SelectedObject; + + if (node is { }) { if (GetText ("Text", "Enter text for node:", node.Text, out string entered)) { @@ -121,13 +144,18 @@ public class InteractiveTree : Scenario } } - private void TreeView_KeyPress (object sender, Key obj) + private void TreeView_KeyPress (object? sender, Key obj) { + if (_treeView is null) + { + return; + } + if (obj.KeyCode == Key.Delete) { - ITreeNode toDelete = _treeView.SelectedObject; + ITreeNode? toDelete = _treeView.SelectedObject; - if (toDelete == null) + if (toDelete is null) { return; } @@ -141,11 +169,11 @@ public class InteractiveTree : Scenario } else { - ITreeNode parent = _treeView.GetParent (toDelete); + ITreeNode? parent = _treeView.GetParent (toDelete); - if (parent == null) + if (parent is null) { - MessageBox.ErrorQuery ( + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Could not delete", $"Parent of '{toDelete}' was unexpectedly null", "Ok" diff --git a/Examples/UICatalog/Scenarios/KeyBindings.cs b/Examples/UICatalog/Scenarios/KeyBindings.cs index f68e67f17..635aa6f6e 100644 --- a/Examples/UICatalog/Scenarios/KeyBindings.cs +++ b/Examples/UICatalog/Scenarios/KeyBindings.cs @@ -164,17 +164,17 @@ public class KeyBindingsDemo : View AddCommand (Command.Save, ctx => { - MessageBox.Query ($"{ctx.Command}", $"Ctx: {ctx}", buttons: "Ok"); + MessageBox.Query (ApplicationImpl.Instance, $"{ctx.Command}", $"Ctx: {ctx}", buttons: "Ok"); return true; }); AddCommand (Command.New, ctx => { - MessageBox.Query ($"{ctx.Command}", $"Ctx: {ctx}", buttons: "Ok"); + MessageBox.Query (ApplicationImpl.Instance, $"{ctx.Command}", $"Ctx: {ctx}", buttons: "Ok"); return true; }); AddCommand (Command.HotKey, ctx => { - MessageBox.Query ($"{ctx.Command}", $"Ctx: {ctx}\nCommand: {ctx.Command}", buttons: "Ok"); + MessageBox.Query (ApplicationImpl.Instance, $"{ctx.Command}", $"Ctx: {ctx}\nCommand: {ctx.Command}", buttons: "Ok"); SetFocus (); return true; }); @@ -189,7 +189,7 @@ public class KeyBindingsDemo : View { return false; } - MessageBox.Query ($"{keyCommandContext.Binding}", $"Key: {keyCommandContext.Binding.Key}\nCommand: {ctx.Command}", buttons: "Ok"); + MessageBox.Query (ApplicationImpl.Instance, $"{keyCommandContext.Binding}", $"Key: {keyCommandContext.Binding.Key}\nCommand: {ctx.Command}", buttons: "Ok"); Application.RequestStop (); return true; }); diff --git a/Examples/UICatalog/Scenarios/Keys.cs b/Examples/UICatalog/Scenarios/Keys.cs index 0c17a15f8..49b9ccc70 100644 --- a/Examples/UICatalog/Scenarios/Keys.cs +++ b/Examples/UICatalog/Scenarios/Keys.cs @@ -86,7 +86,7 @@ public class Keys : Scenario Height = Dim.Fill (), Source = new ListWrapper (keyList) }; - appKeyListView.SchemeName = "TopLevel"; + appKeyListView.SchemeName = "Runnable"; win.Add (appKeyListView); // View key events... @@ -114,7 +114,7 @@ public class Keys : Scenario Height = Dim.Fill (), Source = new ListWrapper (keyDownList) }; - appKeyListView.SchemeName = "TopLevel"; + appKeyListView.SchemeName = "Runnable"; win.Add (onKeyDownListView); // KeyDownNotHandled @@ -134,7 +134,7 @@ public class Keys : Scenario Height = Dim.Fill (), Source = new ListWrapper (keyDownNotHandledList) }; - appKeyListView.SchemeName = "TopLevel"; + appKeyListView.SchemeName = "Runnable"; win.Add (onKeyDownNotHandledListView); @@ -155,7 +155,7 @@ public class Keys : Scenario Height = Dim.Fill (), Source = new ListWrapper (swallowedList) }; - appKeyListView.SchemeName = "TopLevel"; + appKeyListView.SchemeName = "Runnable"; win.Add (onSwallowedListView); Application.Driver!.InputProcessor.AnsiSequenceSwallowed += (s, e) => { swallowedList.Add (e.Replace ("\x1b", "Esc")); }; diff --git a/Examples/UICatalog/Scenarios/LineCanvasExperiment.cs b/Examples/UICatalog/Scenarios/LineCanvasExperiment.cs index 6a826e4be..37cd0777d 100644 --- a/Examples/UICatalog/Scenarios/LineCanvasExperiment.cs +++ b/Examples/UICatalog/Scenarios/LineCanvasExperiment.cs @@ -101,7 +101,7 @@ public class LineCanvasExperiment : Scenario // Width = view4.Width, // Height = 5, - // //Scheme = Colors.Schemes ["TopLevel"], + // //Scheme = Colors.Schemes ["Runnable"], // SuperViewRendersLineCanvas = true, // BorderStyle = LineStyle.Double //}; diff --git a/Examples/UICatalog/Scenarios/LineDrawing.cs b/Examples/UICatalog/Scenarios/LineDrawing.cs index cbc8dd27b..217aea27b 100644 --- a/Examples/UICatalog/Scenarios/LineDrawing.cs +++ b/Examples/UICatalog/Scenarios/LineDrawing.cs @@ -284,7 +284,7 @@ public class DrawingArea : View SetCurrentAttribute (c.Value.Value.Attribute ?? GetAttributeForRole (VisualRole.Normal)); // TODO: #2616 - Support combining sequences that don't normalize - AddRune (c.Key.X, c.Key.Y, c.Value.Value.Rune); + AddStr (c.Key.X, c.Key.Y, c.Value.Value.Grapheme); } } } diff --git a/Examples/UICatalog/Scenarios/ListColumns.cs b/Examples/UICatalog/Scenarios/ListColumns.cs index 5861acaad..d300b4163 100644 --- a/Examples/UICatalog/Scenarios/ListColumns.cs +++ b/Examples/UICatalog/Scenarios/ListColumns.cs @@ -1,6 +1,6 @@ -using System; +#nullable enable + using System.Collections; -using System.Collections.Generic; using System.Data; namespace UICatalog.Scenarios; @@ -13,19 +13,19 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("Scrolling")] public class ListColumns : Scenario { - private Scheme _alternatingScheme; - private DataTable _currentTable; - private TableView _listColView; - private MenuItem _miAlternatingColors; - private MenuItem _miAlwaysUseNormalColorForVerticalCellLines; - private MenuItem _miBottomline; - private MenuItem _miCellLines; - private MenuItem _miCursor; - private MenuItem _miExpandLastColumn; - private MenuItem _miOrientVertical; - private MenuItem _miScrollParallel; - private MenuItem _miSmoothScrolling; - private MenuItem _miTopline; + private Scheme? _alternatingScheme; + private DataTable? _currentTable; + private TableView? _listColView; + private CheckBox? _alternatingColorsCheckBox; + private CheckBox? _alwaysUseNormalColorForVerticalCellLinesCheckBox; + private CheckBox? _bottomlineCheckBox; + private CheckBox? _cellLinesCheckBox; + private CheckBox? _cursorCheckBox; + private CheckBox? _expandLastColumnCheckBox; + private CheckBox? _orientVerticalCheckBox; + private CheckBox? _scrollParallelCheckBox; + private CheckBox? _smoothScrollingCheckBox; + private CheckBox? _toplineCheckBox; /// /// Builds a simple list in which values are the index. This helps testing that scrolling etc is working @@ -35,7 +35,7 @@ public class ListColumns : Scenario /// public static IList BuildSimpleList (int items) { - List list = new (); + List list = []; for (var i = 0; i < items; i++) { @@ -47,20 +47,22 @@ public class ListColumns : Scenario public override void Main () { - // Init Application.Init (); - // Setup - Create a top-level application window and configure it. - Toplevel top = new (); Window appWindow = new () { - Title = GetQuitKeyAndName () + Title = GetQuitKeyAndName (), + BorderStyle = LineStyle.None }; + // MenuBar + MenuBar menuBar = new (); + _listColView = new () { + Y = Pos.Bottom(menuBar), Width = Dim.Fill (), - Height = Dim.Fill (), + Height = Dim.Fill (1), Style = new () { ShowHeaders = false, @@ -70,178 +72,43 @@ public class ListColumns : Scenario ExpandLastColumn = false } }; - var listColStyle = new ListColumnStyle (); + ListColumnStyle listColStyle = new (); - var menu = new MenuBar - { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new ( - "Open_BigListExample", - "", - () => OpenSimpleList (true) - ), - new ( - "Open_SmListExample", - "", - () => OpenSimpleList (false) - ), - new ( - "_CloseExample", - "", - () => CloseExample () - ), - new ("_Quit", "", () => Quit ()) - } - ), - new ( - "_View", - new [] - { - _miTopline = - new ("_TopLine", "", () => ToggleTopline ()) - { - Checked = _listColView.Style - .ShowHorizontalHeaderOverline, - CheckType = MenuItemCheckStyle.Checked - }, - _miBottomline = new ( - "_BottomLine", - "", - () => ToggleBottomline () - ) - { - Checked = _listColView.Style - .ShowHorizontalBottomline, - CheckType = MenuItemCheckStyle.Checked - }, - _miCellLines = new ( - "_CellLines", - "", - () => ToggleCellLines () - ) - { - Checked = _listColView.Style - .ShowVerticalCellLines, - CheckType = MenuItemCheckStyle.Checked - }, - _miExpandLastColumn = new ( - "_ExpandLastColumn", - "", - () => ToggleExpandLastColumn () - ) - { - Checked = _listColView.Style.ExpandLastColumn, - CheckType = MenuItemCheckStyle.Checked - }, - _miAlwaysUseNormalColorForVerticalCellLines = - new ( - "_AlwaysUseNormalColorForVerticalCellLines", - "", - () => - ToggleAlwaysUseNormalColorForVerticalCellLines () - ) - { - Checked = _listColView.Style - .AlwaysUseNormalColorForVerticalCellLines, - CheckType = MenuItemCheckStyle.Checked - }, - _miSmoothScrolling = new ( - "_SmoothHorizontalScrolling", - "", - () => ToggleSmoothScrolling () - ) - { - Checked = _listColView.Style - .SmoothHorizontalScrolling, - CheckType = MenuItemCheckStyle.Checked - }, - _miAlternatingColors = new ( - "Alternating Colors", - "", - () => ToggleAlternatingColors () - ) { CheckType = MenuItemCheckStyle.Checked }, - _miCursor = new ( - "Invert Selected Cell First Character", - "", - () => - ToggleInvertSelectedCellFirstCharacter () - ) - { - Checked = _listColView.Style - .InvertSelectedCellFirstCharacter, - CheckType = MenuItemCheckStyle.Checked - } - } - ), - new ( - "_List", - new [] - { - //new MenuItem ("_Hide Headers", "", HideHeaders), - _miOrientVertical = new ( - "_OrientVertical", - "", - () => ToggleVerticalOrientation () - ) - { - Checked = listColStyle.Orientation - == Orientation.Vertical, - CheckType = MenuItemCheckStyle.Checked - }, - _miScrollParallel = new ( - "_ScrollParallel", - "", - () => ToggleScrollParallel () - ) - { - Checked = listColStyle.ScrollParallel, - CheckType = MenuItemCheckStyle.Checked - }, - new ("Set _Max Cell Width", "", SetListMaxWidth), - new ("Set Mi_n Cell Width", "", SetListMinWidth) - } - ) - ] - }; - var statusBar = new StatusBar ( - new Shortcut [] - { - new (Key.F2, "OpenBigListEx", () => OpenSimpleList (true)), - new (Key.F3, "CloseExample", CloseExample), - new (Key.F4, "OpenSmListEx", () => OpenSimpleList (false)), - new (Application.QuitKey, "Quit", Quit) - } - ); - appWindow.Add (_listColView); + // Status Bar + StatusBar statusBar = new ( + [ + new (Key.F2, "OpenBigListEx", () => OpenSimpleList (true)), + new (Key.F3, "CloseExample", CloseExample), + new (Key.F4, "OpenSmListEx", () => OpenSimpleList (false)), + new (Application.QuitKey, "Quit", Quit) + ] + ); - var selectedCellLabel = new Label + // Selected cell label + Label selectedCellLabel = new () { X = 0, Y = Pos.Bottom (_listColView), Text = "0,0", - Width = Dim.Fill (), TextAlignment = Alignment.End }; - appWindow.Add (selectedCellLabel); - - _listColView.SelectedCellChanged += (s, e) => { selectedCellLabel.Text = $"{_listColView.SelectedRow},{_listColView.SelectedColumn}"; }; + _listColView.SelectedCellChanged += (s, e) => + { + if (_listColView is { }) + { + selectedCellLabel.Text = $"{_listColView.SelectedRow},{_listColView.SelectedColumn}"; + } + }; _listColView.KeyDown += TableViewKeyPress; - //SetupScrollBar (); - _alternatingScheme = new () { - Disabled = appWindow.GetAttributeForRole(VisualRole.Disabled), + Disabled = appWindow.GetAttributeForRole (VisualRole.Disabled), HotFocus = appWindow.GetAttributeForRole (VisualRole.HotFocus), - Focus = appWindow.GetAttributeForRole(VisualRole.Focus), + Focus = appWindow.GetAttributeForRole (VisualRole.Focus), Normal = new (Color.White, Color.BrightBlue) }; @@ -250,37 +117,210 @@ public class ListColumns : Scenario _listColView.KeyBindings.ReplaceCommands (Key.Space, Command.Accept); - top.Add (menu, appWindow, statusBar); - appWindow.Y = 1; - appWindow.Height = Dim.Fill(Dim.Func (_ => statusBar.Frame.Height)); + // Setup menu checkboxes + _toplineCheckBox = new () + { + Title = "_TopLine", + CheckedState = _listColView.Style.ShowHorizontalHeaderOverline ? CheckState.Checked : CheckState.UnChecked + }; + _toplineCheckBox.CheckedStateChanged += (s, e) => ToggleTopline (); - // Run - Start the application. - Application.Run (top); - top.Dispose (); + _bottomlineCheckBox = new () + { + Title = "_BottomLine", + CheckedState = _listColView.Style.ShowHorizontalBottomline ? CheckState.Checked : CheckState.UnChecked + }; + _bottomlineCheckBox.CheckedStateChanged += (s, e) => ToggleBottomline (); - // Shutdown - Calling Application.Shutdown is required. + _cellLinesCheckBox = new () + { + Title = "_CellLines", + CheckedState = _listColView.Style.ShowVerticalCellLines ? CheckState.Checked : CheckState.UnChecked + }; + _cellLinesCheckBox.CheckedStateChanged += (s, e) => ToggleCellLines (); + + _expandLastColumnCheckBox = new () + { + Title = "_ExpandLastColumn", + CheckedState = _listColView.Style.ExpandLastColumn ? CheckState.Checked : CheckState.UnChecked + }; + _expandLastColumnCheckBox.CheckedStateChanged += (s, e) => ToggleExpandLastColumn (); + + _alwaysUseNormalColorForVerticalCellLinesCheckBox = new () + { + Title = "_AlwaysUseNormalColorForVerticalCellLines", + CheckedState = _listColView.Style.AlwaysUseNormalColorForVerticalCellLines ? CheckState.Checked : CheckState.UnChecked + }; + _alwaysUseNormalColorForVerticalCellLinesCheckBox.CheckedStateChanged += (s, e) => ToggleAlwaysUseNormalColorForVerticalCellLines (); + + _smoothScrollingCheckBox = new () + { + Title = "_SmoothHorizontalScrolling", + CheckedState = _listColView.Style.SmoothHorizontalScrolling ? CheckState.Checked : CheckState.UnChecked + }; + _smoothScrollingCheckBox.CheckedStateChanged += (s, e) => ToggleSmoothScrolling (); + + _alternatingColorsCheckBox = new () + { + Title = "Alternating Colors" + }; + _alternatingColorsCheckBox.CheckedStateChanged += (s, e) => ToggleAlternatingColors (); + + _cursorCheckBox = new () + { + Title = "Invert Selected Cell First Character", + CheckedState = _listColView.Style.InvertSelectedCellFirstCharacter ? CheckState.Checked : CheckState.UnChecked + }; + _cursorCheckBox.CheckedStateChanged += (s, e) => ToggleInvertSelectedCellFirstCharacter (); + + _orientVerticalCheckBox = new () + { + Title = "_OrientVertical", + CheckedState = listColStyle.Orientation == Orientation.Vertical ? CheckState.Checked : CheckState.UnChecked + }; + _orientVerticalCheckBox.CheckedStateChanged += (s, e) => ToggleVerticalOrientation (); + + _scrollParallelCheckBox = new () + { + Title = "_ScrollParallel", + CheckedState = listColStyle.ScrollParallel ? CheckState.Checked : CheckState.UnChecked + }; + _scrollParallelCheckBox.CheckedStateChanged += (s, e) => ToggleScrollParallel (); + + menuBar.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem + { + Title = "Open_BigListExample", + Action = () => OpenSimpleList (true) + }, + new MenuItem + { + Title = "Open_SmListExample", + Action = () => OpenSimpleList (false) + }, + new MenuItem + { + Title = "_CloseExample", + Action = CloseExample + }, + new MenuItem + { + Title = "_Quit", + Action = Quit + } + ] + ) + ); + + menuBar.Add ( + new MenuBarItem ( + "_View", + [ + new MenuItem + { + CommandView = _toplineCheckBox + }, + new MenuItem + { + CommandView = _bottomlineCheckBox + }, + new MenuItem + { + CommandView = _cellLinesCheckBox + }, + new MenuItem + { + CommandView = _expandLastColumnCheckBox + }, + new MenuItem + { + CommandView = _alwaysUseNormalColorForVerticalCellLinesCheckBox + }, + new MenuItem + { + CommandView = _smoothScrollingCheckBox + }, + new MenuItem + { + CommandView = _alternatingColorsCheckBox + }, + new MenuItem + { + CommandView = _cursorCheckBox + } + ] + ) + ); + + menuBar.Add ( + new MenuBarItem ( + "_List", + [ + new MenuItem + { + CommandView = _orientVerticalCheckBox + }, + new MenuItem + { + CommandView = _scrollParallelCheckBox + }, + new MenuItem + { + Title = "Set _Max Cell Width", + Action = SetListMaxWidth + }, + new MenuItem + { + Title = "Set Mi_n Cell Width", + Action = SetListMinWidth + } + ] + ) + ); + + // Add views in order of visual appearance + appWindow.Add (menuBar, _listColView, selectedCellLabel, statusBar); + + Application.Run (appWindow); + appWindow.Dispose (); Application.Shutdown (); } - private void CloseExample () { _listColView.Table = null; } + private void CloseExample () + { + if (_listColView is { }) + { + _listColView.Table = null; + } + } + private void OpenSimpleList (bool big) { SetTable (BuildSimpleList (big ? 1023 : 31)); } + private void Quit () { Application.RequestStop (); } private void RunListWidthDialog (string prompt, Action setter, Func getter) { + if (_listColView is null) + { + return; + } + var accepted = false; - var ok = new Button { Text = "Ok", IsDefault = true }; + Button ok = new () { Text = "Ok", IsDefault = true }; ok.Accepting += (s, e) => - { - accepted = true; - Application.RequestStop (); - }; - var cancel = new Button { Text = "Cancel" }; + { + accepted = true; + Application.RequestStop (); + }; + Button cancel = new () { Text = "Cancel" }; cancel.Accepting += (s, e) => { Application.RequestStop (); }; - var d = new Dialog { Title = prompt, Buttons = [ok, cancel] }; + Dialog d = new () { Title = prompt, Buttons = [ok, cancel] }; - var tf = new TextField { Text = getter (_listColView).ToString (), X = 0, Y = 0, Width = Dim.Fill () }; + TextField tf = new () { Text = getter (_listColView).ToString (), X = 0, Y = 0, Width = Dim.Fill () }; d.Add (tf); tf.SetFocus (); @@ -296,7 +336,7 @@ public class ListColumns : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery (60, 20, "Failed to set", ex.Message, "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, 60, 20, "Failed to set", ex.Message, "Ok"); } } } @@ -304,63 +344,37 @@ public class ListColumns : Scenario private void SetListMaxWidth () { RunListWidthDialog ("MaxCellWidth", (s, v) => s.MaxCellWidth = v, s => s.MaxCellWidth); - _listColView.SetNeedsDraw (); + _listColView?.SetNeedsDraw (); } private void SetListMinWidth () { RunListWidthDialog ("MinCellWidth", (s, v) => s.MinCellWidth = v, s => s.MinCellWidth); - _listColView.SetNeedsDraw (); + _listColView?.SetNeedsDraw (); } private void SetTable (IList list) { + if (_listColView is null) + { + return; + } + _listColView.Table = new ListTableSource (list, _listColView); - if ((ListTableSource)_listColView.Table != null) + if (_listColView.Table is ListTableSource listTableSource) { - _currentTable = ((ListTableSource)_listColView.Table).DataTable; + _currentTable = listTableSource.DataTable; } } - //private void SetupScrollBar () - //{ - // var scrollBar = new ScrollBarView (_listColView, true); // (listColView, true, true); - - // scrollBar.ChangedPosition += (s, e) => - // { - // _listColView.RowOffset = scrollBar.Position; - - // if (_listColView.RowOffset != scrollBar.Position) - // { - // scrollBar.Position = _listColView.RowOffset; - // } - - // _listColView.SetNeedsDraw (); - // }; - // /* - // scrollBar.OtherScrollBarView.ChangedPosition += (s,e) => { - // listColView.ColumnOffset = scrollBar.OtherScrollBarView.Position; - // if (listColView.ColumnOffset != scrollBar.OtherScrollBarView.Position) { - // scrollBar.OtherScrollBarView.Position = listColView.ColumnOffset; - // } - // listColView.SetNeedsDraw (); - // }; - // */ - - // _listColView.DrawingContent += (s, e) => - // { - // scrollBar.Size = _listColView.Table?.Rows ?? 0; - // scrollBar.Position = _listColView.RowOffset; - - // //scrollBar.OtherScrollBarView.Size = listColView.Table?.Columns - 1 ?? 0; - // //scrollBar.OtherScrollBarView.Position = listColView.ColumnOffset; - // scrollBar.Refresh (); - // }; - //} - - private void TableViewKeyPress (object sender, Key e) + private void TableViewKeyPress (object? sender, Key e) { + if (_currentTable is null || _listColView is null) + { + return; + } + if (e.KeyCode == Key.Delete) { // set all selected cells to null @@ -376,12 +390,14 @@ public class ListColumns : Scenario private void ToggleAlternatingColors () { - //toggle menu item - _miAlternatingColors.Checked = !_miAlternatingColors.Checked; - - if (_miAlternatingColors.Checked == true) + if (_listColView is null || _alternatingColorsCheckBox is null) { - _listColView.Style.RowColorGetter = a => { return a.RowIndex % 2 == 0 ? _alternatingScheme : null; }; + return; + } + + if (_alternatingColorsCheckBox.CheckedState == CheckState.Checked) + { + _listColView.Style.RowColorGetter = a => a.RowIndex % 2 == 0 ? _alternatingScheme : null; } else { @@ -393,81 +409,106 @@ public class ListColumns : Scenario private void ToggleAlwaysUseNormalColorForVerticalCellLines () { - _miAlwaysUseNormalColorForVerticalCellLines.Checked = - !_miAlwaysUseNormalColorForVerticalCellLines.Checked; + if (_listColView is null || _alwaysUseNormalColorForVerticalCellLinesCheckBox is null) + { + return; + } _listColView.Style.AlwaysUseNormalColorForVerticalCellLines = - (bool)_miAlwaysUseNormalColorForVerticalCellLines.Checked; + _alwaysUseNormalColorForVerticalCellLinesCheckBox.CheckedState == CheckState.Checked; _listColView.Update (); } private void ToggleBottomline () { - _miBottomline.Checked = !_miBottomline.Checked; - _listColView.Style.ShowHorizontalBottomline = (bool)_miBottomline.Checked; + if (_listColView is null || _bottomlineCheckBox is null) + { + return; + } + + _listColView.Style.ShowHorizontalBottomline = _bottomlineCheckBox.CheckedState == CheckState.Checked; _listColView.Update (); } private void ToggleCellLines () { - _miCellLines.Checked = !_miCellLines.Checked; - _listColView.Style.ShowVerticalCellLines = (bool)_miCellLines.Checked; + if (_listColView is null || _cellLinesCheckBox is null) + { + return; + } + + _listColView.Style.ShowVerticalCellLines = _cellLinesCheckBox.CheckedState == CheckState.Checked; _listColView.Update (); } private void ToggleExpandLastColumn () { - _miExpandLastColumn.Checked = !_miExpandLastColumn.Checked; - _listColView.Style.ExpandLastColumn = (bool)_miExpandLastColumn.Checked; + if (_listColView is null || _expandLastColumnCheckBox is null) + { + return; + } + + _listColView.Style.ExpandLastColumn = _expandLastColumnCheckBox.CheckedState == CheckState.Checked; _listColView.Update (); } private void ToggleInvertSelectedCellFirstCharacter () { - //toggle menu item - _miCursor.Checked = !_miCursor.Checked; - _listColView.Style.InvertSelectedCellFirstCharacter = (bool)_miCursor.Checked; + if (_listColView is null || _cursorCheckBox is null) + { + return; + } + + _listColView.Style.InvertSelectedCellFirstCharacter = _cursorCheckBox.CheckedState == CheckState.Checked; _listColView.SetNeedsDraw (); } private void ToggleScrollParallel () { - _miScrollParallel.Checked = !_miScrollParallel.Checked; - - if ((ListTableSource)_listColView.Table != null) + if (_listColView?.Table is not ListTableSource listTableSource || _scrollParallelCheckBox is null) { - ((ListTableSource)_listColView.Table).Style.ScrollParallel = (bool)_miScrollParallel.Checked; - _listColView.SetNeedsDraw (); + return; } + + listTableSource.Style.ScrollParallel = _scrollParallelCheckBox.CheckedState == CheckState.Checked; + _listColView.SetNeedsDraw (); } private void ToggleSmoothScrolling () { - _miSmoothScrolling.Checked = !_miSmoothScrolling.Checked; - _listColView.Style.SmoothHorizontalScrolling = (bool)_miSmoothScrolling.Checked; + if (_listColView is null || _smoothScrollingCheckBox is null) + { + return; + } + + _listColView.Style.SmoothHorizontalScrolling = _smoothScrollingCheckBox.CheckedState == CheckState.Checked; _listColView.Update (); } private void ToggleTopline () { - _miTopline.Checked = !_miTopline.Checked; - _listColView.Style.ShowHorizontalHeaderOverline = (bool)_miTopline.Checked; + if (_listColView is null || _toplineCheckBox is null) + { + return; + } + + _listColView.Style.ShowHorizontalHeaderOverline = _toplineCheckBox.CheckedState == CheckState.Checked; _listColView.Update (); } private void ToggleVerticalOrientation () { - _miOrientVertical.Checked = !_miOrientVertical.Checked; - - if ((ListTableSource)_listColView.Table != null) + if (_listColView?.Table is not ListTableSource listTableSource || _orientVerticalCheckBox is null) { - ((ListTableSource)_listColView.Table).Style.Orientation = (bool)_miOrientVertical.Checked - ? Orientation.Vertical - : Orientation.Horizontal; - _listColView.SetNeedsDraw (); + return; } + + listTableSource.Style.Orientation = _orientVerticalCheckBox.CheckedState == CheckState.Checked + ? Orientation.Vertical + : Orientation.Horizontal; + _listColView.SetNeedsDraw (); } } diff --git a/Examples/UICatalog/Scenarios/ListViewWithSelection.cs b/Examples/UICatalog/Scenarios/ListViewWithSelection.cs index 874d061a5..dd6ac2bf4 100644 --- a/Examples/UICatalog/Scenarios/ListViewWithSelection.cs +++ b/Examples/UICatalog/Scenarios/ListViewWithSelection.cs @@ -98,7 +98,7 @@ public class ListViewWithSelection : Scenario Height = Dim.Fill (), Source = new ListWrapper (_eventList) }; - _eventListView.SchemeName = "TopLevel"; + _eventListView.SchemeName = "Runnable"; _appWindow.Add (_eventListView); _listView.SelectedItemChanged += (s, a) => LogEvent (s as View, a, "SelectedItemChanged"); @@ -237,7 +237,7 @@ public class ListViewWithSelection : Scenario int col, int line, int width, - int start = 0 + int viewportX = 0 ) { container.Move (col, line); @@ -247,7 +247,7 @@ public class ListViewWithSelection : Scenario string.Format ("{{0,{0}}}", -_nameColumnWidth), Scenarios [item].GetName () ); - RenderUstr (container, $"{s} ({Scenarios [item].GetDescription ()})", col, line, width, start); + RenderUstr (container, $"{s} ({Scenarios [item].GetDescription ()})", col, line, width, viewportX); } public void SetMark (int item, bool value) @@ -288,10 +288,10 @@ public class ListViewWithSelection : Scenario } // A slightly adapted method from: https://github.com/gui-cs/Terminal.Gui/blob/fc1faba7452ccbdf49028ac49f0c9f0f42bbae91/Terminal.Gui/Views/ListView.cs#L433-L461 - private void RenderUstr (View view, string ustr, int col, int line, int width, int start = 0) + private void RenderUstr (View view, string ustr, int col, int line, int width, int viewportX = 0) { var used = 0; - int index = start; + int index = viewportX; while (index < ustr.Length) { diff --git a/Examples/UICatalog/Scenarios/ListsAndCombos.cs b/Examples/UICatalog/Scenarios/ListsAndCombos.cs index dba1adc73..186b147aa 100644 --- a/Examples/UICatalog/Scenarios/ListsAndCombos.cs +++ b/Examples/UICatalog/Scenarios/ListsAndCombos.cs @@ -35,7 +35,7 @@ public class ListsAndCombos : Scenario // ListView var lbListView = new Label { - SchemeName = "TopLevel", + SchemeName = "Runnable", X = 0, Width = Dim.Percent (40), @@ -50,7 +50,7 @@ public class ListsAndCombos : Scenario Width = Dim.Percent (40), Source = new ListWrapper (items) }; - listview.SelectedItemChanged += (s, e) => lbListView.Text = items [listview.SelectedItem]; + listview.SelectedItemChanged += (s, e) => lbListView.Text = items [listview.SelectedItem.Value]; win.Add (lbListView, listview); //var scrollBar = new ScrollBarView (listview, true); @@ -91,7 +91,7 @@ public class ListsAndCombos : Scenario // ComboBox var lbComboBox = new Label { - SchemeName = "TopLevel", + SchemeName = "Runnable", X = Pos.Right (lbListView) + 1, Width = Dim.Percent (40), diff --git a/Examples/UICatalog/Scenarios/Localization.cs b/Examples/UICatalog/Scenarios/Localization.cs index 229800f5e..c7eee617b 100644 --- a/Examples/UICatalog/Scenarios/Localization.cs +++ b/Examples/UICatalog/Scenarios/Localization.cs @@ -1,7 +1,6 @@ -using System; +#nullable enable + using System.Globalization; -using System.Linq; -using System.Threading; namespace UICatalog.Scenarios; @@ -10,11 +9,11 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("Tests")] public class Localization : Scenario { - private CheckBox _allowAnyCheckBox; - private string [] _cultureInfoNameSource; - private CultureInfo [] _cultureInfoSource; + private CheckBox? _allowAnyCheckBox; + private string []? _cultureInfoNameSource; + private CultureInfo []? _cultureInfoSource; private OpenMode _currentOpenMode = OpenMode.File; - private ComboBox _languageComboBox; + private ComboBox? _languageComboBox; public CultureInfo CurrentCulture { get; private set; } = Thread.CurrentThread.CurrentUICulture; public void Quit () @@ -25,6 +24,11 @@ public class Localization : Scenario public void SetCulture (CultureInfo culture) { + if (_languageComboBox is null || _cultureInfoSource is null) + { + return; + } + if (_cultureInfoSource [_languageComboBox.SelectedItem] != culture) { _languageComboBox.SelectedItem = Array.IndexOf (_cultureInfoSource, culture); @@ -43,70 +47,67 @@ public class Localization : Scenario public override void Main () { Application.Init (); - var top = new Toplevel (); - var win = new Window { Title = GetQuitKeyAndName () }; - _cultureInfoSource = Application.SupportedCultures.Append (CultureInfo.InvariantCulture).ToArray (); - _cultureInfoNameSource = Application.SupportedCultures.Select (c => $"{c.NativeName} ({c.Name})") + Window win = new () + { + Title = GetQuitKeyAndName (), + BorderStyle = LineStyle.None + }; + + _cultureInfoSource = Application.SupportedCultures!.Append (CultureInfo.InvariantCulture).ToArray (); + + _cultureInfoNameSource = Application.SupportedCultures!.Select (c => $"{c.NativeName} ({c.Name})") .Append ("Invariant") .ToArray (); - MenuItem [] languageMenus = Application.SupportedCultures - .Select ( - c => new MenuItem ( - $"{c.NativeName} ({c.Name})", - "", - () => SetCulture (c) - ) + MenuItem [] languageMenus = Application.SupportedCultures! + .Select (c => new MenuItem + { + Title = $"{c.NativeName} ({c.Name})", + Action = () => SetCulture (c) + } ) .Concat ( - new MenuItem [] - { - null, - new ( - "Invariant", - "", - () => - SetCulture ( - CultureInfo - .InvariantCulture - ) - ) - } + [ + new () + { + Title = "Invariant", + Action = () => SetCulture (CultureInfo.InvariantCulture) + } + ] ) .ToArray (); - var menu = new MenuBar - { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new MenuBarItem ( - "_Language", - languageMenus - ), - null, - new ("_Quit", "", Quit) - } - ) - ] - }; - top.Add (menu); + // MenuBar + MenuBar menu = new (); - var selectLanguageLabel = new Label + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuBarItem ( + "_Language", + languageMenus + ), + new MenuItem + { + Title = "_Quit", + Action = Quit + } + ] + ) + ); + + Label selectLanguageLabel = new () { X = 2, - Y = 1, - + Y = Pos.Bottom (menu) + 1, Width = Dim.Fill (2), Text = "Please select a language." }; win.Add (selectLanguageLabel); - _languageComboBox = new() + _languageComboBox = new () { X = 2, Y = Pos.Bottom (selectLanguageLabel) + 1, @@ -120,11 +121,10 @@ public class Localization : Scenario _languageComboBox.SelectedItemChanged += LanguageComboBox_SelectChanged; win.Add (_languageComboBox); - var textAndFileDialogLabel = new Label + Label textAndFileDialogLabel = new () { X = 2, Y = Pos.Top (_languageComboBox) + 3, - Width = Dim.Fill (2), Height = 1, Text = @@ -132,13 +132,16 @@ public class Localization : Scenario }; win.Add (textAndFileDialogLabel); - var textField = new TextView + TextView textField = new () { - X = 2, Y = Pos.Bottom (textAndFileDialogLabel) + 1, Width = Dim.Fill (32), Height = 1 + X = 2, + Y = Pos.Bottom (textAndFileDialogLabel) + 1, + Width = Dim.Fill (32), + Height = 1 }; win.Add (textField); - _allowAnyCheckBox = new() + _allowAnyCheckBox = new () { X = Pos.Right (textField) + 1, Y = Pos.Bottom (textAndFileDialogLabel) + 1, @@ -147,46 +150,53 @@ public class Localization : Scenario }; win.Add (_allowAnyCheckBox); - var openDialogButton = new Button + Button openDialogButton = new () { - X = Pos.Right (_allowAnyCheckBox) + 1, Y = Pos.Bottom (textAndFileDialogLabel) + 1, Text = "Open" + X = Pos.Right (_allowAnyCheckBox) + 1, + Y = Pos.Bottom (textAndFileDialogLabel) + 1, + Text = "Open" }; openDialogButton.Accepting += (sender, e) => ShowFileDialog (false); win.Add (openDialogButton); - var saveDialogButton = new Button + Button saveDialogButton = new () { - X = Pos.Right (openDialogButton) + 1, Y = Pos.Bottom (textAndFileDialogLabel) + 1, Text = "Save" + X = Pos.Right (openDialogButton) + 1, + Y = Pos.Bottom (textAndFileDialogLabel) + 1, + Text = "Save" }; saveDialogButton.Accepting += (sender, e) => ShowFileDialog (true); win.Add (saveDialogButton); - var wizardLabel = new Label + Label wizardLabel = new () { X = 2, Y = Pos.Bottom (textField) + 1, - Width = Dim.Fill (2), Text = "Click the button to open a wizard." }; win.Add (wizardLabel); - var wizardButton = new Button { X = 2, Y = Pos.Bottom (wizardLabel) + 1, Text = "Open _wizard" }; + Button wizardButton = new () { X = 2, Y = Pos.Bottom (wizardLabel) + 1, Text = "Open _wizard" }; wizardButton.Accepting += (sender, e) => ShowWizard (); win.Add (wizardButton); - win.Unloaded += (sender, e) => Quit (); + win.IsRunningChanged += (sender, e) => Quit (); - win.Y = Pos.Bottom (menu); - top.Add (win); + win.Add (menu); - Application.Run (top); - top.Dispose (); + Application.Run (win); + win.Dispose (); Application.Shutdown (); } public void ShowFileDialog (bool isSaveFile) { + if (_allowAnyCheckBox is null) + { + return; + } + FileDialog dialog = isSaveFile ? new SaveDialog () : new OpenDialog { OpenMode = _currentOpenMode }; dialog.AllowedTypes = @@ -213,16 +223,21 @@ public class Localization : Scenario public void ShowWizard () { - var wizard = new Wizard { Height = 8, Width = 36, Title = "The wizard" }; - wizard.AddStep (new() { HelpText = "Wizard first step" }); - wizard.AddStep (new() { HelpText = "Wizard step 2", NextButtonText = ">>> (_N)" }); - wizard.AddStep (new() { HelpText = "Wizard last step" }); + Wizard wizard = new () { Height = 8, Width = 36, Title = "The wizard" }; + wizard.AddStep (new () { HelpText = "Wizard first step" }); + wizard.AddStep (new () { HelpText = "Wizard step 2", NextButtonText = ">>> (_N)" }); + wizard.AddStep (new () { HelpText = "Wizard last step" }); Application.Run (wizard); wizard.Dispose (); } - private void LanguageComboBox_SelectChanged (object sender, ListViewItemEventArgs e) + private void LanguageComboBox_SelectChanged (object? sender, ListViewItemEventArgs e) { + if (_cultureInfoNameSource is null || _cultureInfoSource is null) + { + return; + } + if (e.Value is string cultureName) { int index = Array.IndexOf (_cultureInfoNameSource, cultureName); diff --git a/Examples/UICatalog/Scenarios/Mazing.cs b/Examples/UICatalog/Scenarios/Mazing.cs index 01bbc41a4..6d7a08d6f 100644 --- a/Examples/UICatalog/Scenarios/Mazing.cs +++ b/Examples/UICatalog/Scenarios/Mazing.cs @@ -9,7 +9,7 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("Games")] public class Mazing : Scenario { - private Toplevel? _top; + private Window? _top; private MazeGenerator? _m; private List? _potions; @@ -33,17 +33,17 @@ public class Mazing : Scenario _top.KeyBindings.Add (Key.CursorDown, Command.Down); // Changing the key-bindings of a View is not allowed, however, - // by default, Toplevel doesn't bind any of our movement keys, so + // by default, Runnable doesn't bind any of our movement keys, so // we can take advantage of the CommandNotBound event to handle them // - // An alternative implementation would be to create a TopLevel subclass that + // An alternative implementation would be to create a Runnable subclass that // calls AddCommand/KeyBindings.Add in the constructor. See the Snake game scenario // for an example. _top.CommandNotBound += TopCommandNotBound; _top.DrawingContent += (s, _) => { - if (s is not Toplevel top) + if (s is not Runnable top) { return; } @@ -171,7 +171,7 @@ public class Mazing : Scenario if (_m.PlayerHp <= 0) { _message = "You died!"; - Application.Top!.SetNeedsDraw (); // trigger redraw + Application.TopRunnableView!.SetNeedsDraw (); // trigger redraw _dead = true; return; // Stop further action if dead @@ -190,7 +190,7 @@ public class Mazing : Scenario _message = string.Empty; } - Application.Top!.SetNeedsDraw (); // trigger redraw + Application.TopRunnableView!.SetNeedsDraw (); // trigger redraw } // Optional win condition: @@ -200,7 +200,7 @@ public class Mazing : Scenario _m = new (); // Generate a new maze _m.PlayerHp = hp; GenerateNpcs (); - Application.Top!.SetNeedsDraw (); // trigger redraw + Application.TopRunnableView!.SetNeedsDraw (); // trigger redraw } } } diff --git a/Examples/UICatalog/Scenarios/MenuBarScenario.cs b/Examples/UICatalog/Scenarios/MenuBarScenario.cs deleted file mode 100644 index e61438767..000000000 --- a/Examples/UICatalog/Scenarios/MenuBarScenario.cs +++ /dev/null @@ -1,135 +0,0 @@ -using System; -using static System.Runtime.InteropServices.JavaScript.JSType; - -namespace UICatalog.Scenarios; - -[ScenarioMetadata ("MenuBar", "Demonstrates the MenuBar using the demo menu.")] -[ScenarioCategory ("Controls")] -[ScenarioCategory ("Menus")] -public class MenuBarScenario : Scenario -{ - private Label _currentMenuBarItem; - private Label _currentMenuItem; - private Label _focusedView; - private Label _lastAction; - private Label _lastKey; - - public override void Main () - { - // Init - Application.Init (); - - // Setup - Create a top-level application window and configure it. - Window appWindow = new () - { - Title = GetQuitKeyAndName (), - BorderStyle = LineStyle.None - }; - - MenuItem mbiCurrent = null; - MenuItem miCurrent = null; - - var label = new Label { X = 0, Y = 10, Text = "Last Key: " }; - appWindow.Add (label); - - _lastKey = new Label { X = Pos.Right (label), Y = Pos.Top (label), Text = "" }; - - appWindow.Add (_lastKey); - label = new Label { X = 0, Y = Pos.Bottom (label), Text = "Current MenuBarItem: " }; - appWindow.Add (label); - - _currentMenuBarItem = new Label { X = Pos.Right (label), Y = Pos.Top (label), Text = "" }; - appWindow.Add (_currentMenuBarItem); - - label = new Label { X = 0, Y = Pos.Bottom (label), Text = "Current MenuItem: " }; - appWindow.Add (label); - - _currentMenuItem = new Label { X = Pos.Right (label), Y = Pos.Top (label), Text = "" }; - appWindow.Add (_currentMenuItem); - - label = new Label { X = 0, Y = Pos.Bottom (label), Text = "Last Action: " }; - appWindow.Add (label); - - _lastAction = new Label { X = Pos.Right (label), Y = Pos.Top (label), Text = "" }; - appWindow.Add (_lastAction); - - label = new Label { X = 0, Y = Pos.Bottom (label), Text = "Focused View: " }; - appWindow.Add (label); - - _focusedView = new Label { X = Pos.Right (label), Y = Pos.Top (label), Text = "" }; - appWindow.Add (_focusedView); - - MenuBar menuBar = new MenuBar (); - menuBar.UseKeysUpDownAsKeysLeftRight = true; - menuBar.Key = KeyCode.F9; - menuBar.Title = "TestMenuBar"; - - bool FnAction (string s) - { - _lastAction.Text = s; - - return true; - } - - // Declare a variable for the function - Func fnActionVariable = FnAction; - - menuBar.EnableForDesign (ref fnActionVariable); - - menuBar.MenuOpening += (s, e) => - { - mbiCurrent = e.CurrentMenu; - SetCurrentMenuBarItem (mbiCurrent); - SetCurrentMenuItem (miCurrent); - _lastAction.Text = string.Empty; - }; - - menuBar.MenuOpened += (s, e) => - { - miCurrent = e.MenuItem; - SetCurrentMenuBarItem (mbiCurrent); - SetCurrentMenuItem (miCurrent); - }; - - menuBar.MenuClosing += (s, e) => - { - mbiCurrent = null; - miCurrent = null; - SetCurrentMenuBarItem (mbiCurrent); - SetCurrentMenuItem (miCurrent); - }; - - Application.KeyDown += (s, e) => - { - _lastAction.Text = string.Empty; - _lastKey.Text = e.ToString (); - }; - - // There's no focus change event, so this is a bit of a hack. - menuBar.SubViewsLaidOut += (s, e) => { _focusedView.Text = appWindow.MostFocused?.ToString () ?? "None"; }; - - var openBtn = new Button { X = Pos.Center (), Y = 4, Text = "_Open Menu", IsDefault = true }; - openBtn.Accepting += (s, e) => { menuBar.OpenMenu (); }; - appWindow.Add (openBtn); - - var hideBtn = new Button { X = Pos.Center (), Y = Pos.Bottom (openBtn), Text = "Toggle Menu._Visible" }; - hideBtn.Accepting += (s, e) => { menuBar.Visible = !menuBar.Visible; }; - appWindow.Add (hideBtn); - - var enableBtn = new Button { X = Pos.Center (), Y = Pos.Bottom (hideBtn), Text = "_Toggle Menu.Enable" }; - enableBtn.Accepting += (s, e) => { menuBar.Enabled = !menuBar.Enabled; }; - appWindow.Add (enableBtn); - - appWindow.Add (menuBar); - - // Run - Start the application. - Application.Run (appWindow); - appWindow.Dispose (); - - // Shutdown - Calling Application.Shutdown is required. - Application.Shutdown (); - } - - private void SetCurrentMenuBarItem (MenuItem mbi) { _currentMenuBarItem.Text = mbi != null ? mbi.Title : "Closed"; } - private void SetCurrentMenuItem (MenuItem mi) { _currentMenuItem.Text = mi != null ? mi.Title : "None"; } -} diff --git a/Examples/UICatalog/Scenarios/Menus.cs b/Examples/UICatalog/Scenarios/Menus.cs index 70f67f6e2..7733e0584 100644 --- a/Examples/UICatalog/Scenarios/Menus.cs +++ b/Examples/UICatalog/Scenarios/Menus.cs @@ -21,7 +21,7 @@ public class Menus : Scenario Logging.Logger = CreateLogger (); Application.Init (); - Toplevel app = new (); + Runnable app = new (); app.Title = GetQuitKeyAndName (); ObservableCollection eventSource = new (); @@ -32,7 +32,7 @@ public class Menus : Scenario X = Pos.AnchorEnd (), Width = Dim.Auto (), Height = Dim.Fill (), // Make room for some wide things - SchemeName = "TopLevel", + SchemeName = "Runnable", Source = new ListWrapper (eventSource) }; eventLog.Border!.Thickness = new (0, 1, 0, 0); @@ -121,7 +121,7 @@ public class Menus : Scenario Command.Cancel, ctx => { - if (Application.Popover?.GetActivePopover () as PopoverMenu is { Visible: true } visiblePopover) + if (App?.Popover?.GetActivePopover () as PopoverMenu is { Visible: true } visiblePopover) { visiblePopover.Visible = false; } @@ -189,7 +189,7 @@ public class Menus : Scenario Application.KeyBindings.Remove (Key.F5); Application.KeyBindings.Add (Key.F5, this, Command.Edit); - var menuBar = new MenuBarv2 + var menuBar = new MenuBar { Title = "MenuHost MenuBar" }; @@ -257,7 +257,7 @@ public class Menus : Scenario menuBar.Accepted += (o, args) => { - if (args.Context?.Source is MenuItemv2 mi && mi.CommandView == enableOverwriteMenuItemCb) + if (args.Context?.Source is MenuItem mi && mi.CommandView == enableOverwriteMenuItemCb) { Logging.Debug ($"menuBar.Accepted: {args.Context.Source?.Title}"); @@ -302,7 +302,7 @@ public class Menus : Scenario menuBar.Accepted += (o, args) => { - if (args.Context?.Source is MenuItemv2 mi && mi.CommandView == editModeMenuItemCb) + if (args.Context?.Source is MenuItem mi && mi.CommandView == editModeMenuItemCb) { Logging.Debug ($"menuBar.Accepted: {args.Context.Source?.Title}"); diff --git a/Examples/UICatalog/Scenarios/MessageBoxes.cs b/Examples/UICatalog/Scenarios/MessageBoxes.cs index c8356a86a..fcb6488ee 100644 --- a/Examples/UICatalog/Scenarios/MessageBoxes.cs +++ b/Examples/UICatalog/Scenarios/MessageBoxes.cs @@ -251,7 +251,7 @@ public class MessageBoxes : Scenario { buttonPressedLabel.Text = $"{MessageBox.Query ( - width, + ApplicationImpl.Instance, width, height, titleEdit.Text, messageEdit.Text, @@ -263,14 +263,14 @@ public class MessageBoxes : Scenario else { buttonPressedLabel.Text = - $"{MessageBox.ErrorQuery ( - width, - height, - titleEdit.Text, - messageEdit.Text, - defaultButton, - ckbWrapMessage.CheckedState == CheckState.Checked, - btns.ToArray () + $"{MessageBox.ErrorQuery (ApplicationImpl.Instance, + width, + height, + titleEdit.Text, + messageEdit.Text, + defaultButton, + ckbWrapMessage.CheckedState == CheckState.Checked, + btns.ToArray () )}"; } } diff --git a/Examples/UICatalog/Scenarios/Mouse.cs b/Examples/UICatalog/Scenarios/Mouse.cs index cb047614c..d56b3e82a 100644 --- a/Examples/UICatalog/Scenarios/Mouse.cs +++ b/Examples/UICatalog/Scenarios/Mouse.cs @@ -247,7 +247,7 @@ public class Mouse : Scenario Y = Pos.Bottom (label), Width = 50, Height = Dim.Fill (), - SchemeName = "TopLevel", + SchemeName = "Runnable", Source = new ListWrapper (appLogList) }; win.Add (label, appLog); @@ -278,7 +278,7 @@ public class Mouse : Scenario Y = Pos.Bottom (label), Width = Dim.Percent (50), Height = Dim.Fill (), - SchemeName = "TopLevel", + SchemeName = "Runnable", Source = new ListWrapper (winLogList) }; win.Add (label, winLog); diff --git a/Examples/UICatalog/Scenarios/MultiColouredTable.cs b/Examples/UICatalog/Scenarios/MultiColouredTable.cs index cf013f86c..5bac4e125 100644 --- a/Examples/UICatalog/Scenarios/MultiColouredTable.cs +++ b/Examples/UICatalog/Scenarios/MultiColouredTable.cs @@ -1,4 +1,5 @@ -using System; +#nullable enable + using System.Data; using System.Text; @@ -10,40 +11,49 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("TableView")] public class MultiColouredTable : Scenario { - private DataTable _table; - private TableViewColors _tableView; + private DataTable? _table; + private TableViewColors? _tableView; public override void Main () { - // Init Application.Init (); - // Setup - Create a top-level application window and configure it. - Toplevel appWindow = new () + Window appWindow = new () { - Title = GetQuitKeyAndName () + Title = GetQuitKeyAndName (), + BorderStyle = LineStyle.None, }; - _tableView = new () { X = 0, Y = 1, Width = Dim.Fill (), Height = Dim.Fill (1) }; + // MenuBar + var menu = new MenuBar (); - var menu = new MenuBar - { - Menus = - [ - new ("_File", new MenuItem [] { new ("_Quit", "", Quit) }) - ] - }; - appWindow.Add (menu); + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem + { + Title = "_Quit", + Action = Quit + } + ] + ) + ); - var statusBar = new StatusBar (new Shortcut [] { new (Application.QuitKey, "Quit", Quit) }); + _tableView = new () { X = 0, Y = Pos.Bottom (menu), Width = Dim.Fill (), Height = Dim.Fill (1) }; - appWindow.Add (statusBar); + // StatusBar + var statusBar = new StatusBar ( + [ + new (Application.QuitKey, "Quit", Quit) + ] + ); - appWindow.Add (_tableView); + appWindow.Add (menu, _tableView, statusBar); _tableView.CellActivated += EditCurrentCell; - var dt = new DataTable (); + DataTable dt = new (); dt.Columns.Add ("Col1"); dt.Columns.Add ("Col2"); @@ -54,34 +64,33 @@ public class MultiColouredTable : Scenario dt.Rows.Add (DBNull.Value, DBNull.Value); dt.Rows.Add (DBNull.Value, DBNull.Value); - _tableView.SetScheme (new () - { - Disabled = appWindow.GetAttributeForRole (VisualRole.Disabled), - HotFocus = appWindow.GetAttributeForRole (VisualRole.HotFocus), - Focus = appWindow.GetAttributeForRole (VisualRole.Focus), - Normal = new (Color.DarkGray, Color.Black) - }); + _tableView.SetScheme ( + new () + { + Disabled = appWindow.GetAttributeForRole (VisualRole.Disabled), + HotFocus = appWindow.GetAttributeForRole (VisualRole.HotFocus), + Focus = appWindow.GetAttributeForRole (VisualRole.Focus), + Normal = new (Color.DarkGray, Color.Black) + } + ); _tableView.Table = new DataTableSource (_table = dt); - // Run - Start the application. Application.Run (appWindow); appWindow.Dispose (); - - // Shutdown - Calling Application.Shutdown is required. Application.Shutdown (); } - private void EditCurrentCell (object sender, CellActivatedEventArgs e) + private void EditCurrentCell (object? sender, CellActivatedEventArgs e) { - if (e.Table == null) + if (e.Table is null || _table is null || _tableView is null) { return; } var oldValue = e.Table [e.Row, e.Col].ToString (); - if (GetText ("Enter new value", e.Table.ColumnNames [e.Col], oldValue, out string newText)) + if (GetText ("Enter new value", e.Table.ColumnNames [e.Col], oldValue ?? "", out string newText)) { try { @@ -90,7 +99,7 @@ public class MultiColouredTable : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery (60, 20, "Failed to set text", ex.Message, "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, 60, 20, "Failed to set text", ex.Message, "Ok"); } _tableView.Update (); @@ -101,20 +110,20 @@ public class MultiColouredTable : Scenario { var okPressed = false; - var ok = new Button { Text = "Ok", IsDefault = true }; + Button ok = new () { Text = "Ok", IsDefault = true }; ok.Accepting += (s, e) => - { - okPressed = true; - Application.RequestStop (); - }; - var cancel = new Button { Text = "Cancel" }; + { + okPressed = true; + Application.RequestStop (); + }; + Button cancel = new () { Text = "Cancel" }; cancel.Accepting += (s, e) => { Application.RequestStop (); }; - var d = new Dialog { Title = title, Buttons = [ok, cancel] }; + Dialog d = new () { Title = title, Buttons = [ok, cancel] }; - var lbl = new Label { X = 0, Y = 1, Text = label }; + Label lbl = new () { X = 0, Y = 1, Text = label }; - var tf = new TextField { Text = initialText, X = 0, Y = 2, Width = Dim.Fill () }; + TextField tf = new () { Text = initialText, X = 0, Y = 2, Width = Dim.Fill () }; d.Add (lbl, tf); tf.SetFocus (); @@ -122,7 +131,7 @@ public class MultiColouredTable : Scenario Application.Run (d); d.Dispose (); - enteredText = okPressed ? tf.Text : null; + enteredText = okPressed ? tf.Text : string.Empty; return okPressed; } @@ -155,20 +164,20 @@ public class MultiColouredTable : Scenario break; case 1: SetAttribute ( - new ( - Color.BrightRed, - cellColor.Background - ) - ); + new ( + Color.BrightRed, + cellColor.Background + ) + ); break; case 2: SetAttribute ( - new ( - Color.BrightYellow, - cellColor.Background - ) - ); + new ( + Color.BrightYellow, + cellColor.Background + ) + ); break; case 3: @@ -177,29 +186,29 @@ public class MultiColouredTable : Scenario break; case 4: SetAttribute ( - new ( - Color.BrightGreen, - cellColor.Background - ) - ); + new ( + Color.BrightGreen, + cellColor.Background + ) + ); break; case 5: SetAttribute ( - new ( - Color.BrightBlue, - cellColor.Background - ) - ); + new ( + Color.BrightBlue, + cellColor.Background + ) + ); break; case 6: SetAttribute ( - new ( - Color.BrightCyan, - cellColor.Background - ) - ); + new ( + Color.BrightCyan, + cellColor.Background + ) + ); break; case 7: diff --git a/Examples/UICatalog/Scenarios/Navigation.cs b/Examples/UICatalog/Scenarios/Navigation.cs index 7ce1d3317..7c78ef359 100644 --- a/Examples/UICatalog/Scenarios/Navigation.cs +++ b/Examples/UICatalog/Scenarios/Navigation.cs @@ -59,7 +59,7 @@ public class Navigation : Scenario Y = 0, Title = $"TopButton _{GetNextHotKey ()}" }; - button.Accepting += (sender, args) => MessageBox.Query ("hi", button.Title, "_Ok"); + button.Accepting += (sender, args) => MessageBox.Query (ApplicationImpl.Instance, "hi", button.Title, "_Ok"); testFrame.Add (button); @@ -180,7 +180,7 @@ public class Navigation : Scenario X = 1, Y = 7, Id = "datePicker", - SchemeName = "TopLevel", + SchemeName = "Runnable", ShadowStyle = ShadowStyle.Transparent, BorderStyle = LineStyle.Double, CanFocus = true, // Can't drag without this? BUGBUG @@ -210,7 +210,7 @@ public class Navigation : Scenario return; - void OnApplicationIteration (object sender, IterationEventArgs args) + void OnApplicationIteration (object sender, EventArgs args) { if (progressBar.Fraction == 1.0) { @@ -219,7 +219,7 @@ public class Navigation : Scenario progressBar.Fraction += 0.01f; - Application.Invoke (() => { }); + Application.Invoke ((_) => { }); } void ColorPicker_ColorChanged (object sender, ResultEventArgs e) @@ -237,7 +237,7 @@ public class Navigation : Scenario Height = Dim.Auto (), Width = Dim.Auto (), Title = $"Overlapped{id} _{GetNextHotKey ()}", - SchemeName = "TopLevel", + SchemeName = "Runnable", Id = $"Overlapped{id}", ShadowStyle = ShadowStyle.Transparent, BorderStyle = LineStyle.Double, diff --git a/Examples/UICatalog/Scenarios/Notepad.cs b/Examples/UICatalog/Scenarios/Notepad.cs index 996702298..f597f2fad 100644 --- a/Examples/UICatalog/Scenarios/Notepad.cs +++ b/Examples/UICatalog/Scenarios/Notepad.cs @@ -1,4 +1,5 @@ #nullable enable + namespace UICatalog.Scenarios; [ScenarioMetadata ("Notepad", "Multi-tab text editor using the TabView control.")] @@ -16,41 +17,65 @@ public class Notepad : Scenario { Application.Init (); - Toplevel top = new (); - - var menu = new MenuBar + Window top = new () { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new ( - "_New", - "", - () => New (), - null, - null, - KeyCode.N - | KeyCode.CtrlMask - | KeyCode.AltMask - ), - new ("_Open", "", Open), - new ("_Save", "", Save), - new ("Save _As", "", () => SaveAs ()), - new ("_Close", "", Close), - new ("_Quit", "", Quit) - } - ), - new ( - "_About", - "", - () => MessageBox.Query ("Notepad", "About Notepad...", "Ok") - ) - ] + BorderStyle = LineStyle.None, }; - top.Add (menu); + + // MenuBar + MenuBar menu = new (); + + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem + { + Title = "_New", + Key = Key.N.WithCtrl.WithAlt, + Action = New + }, + new MenuItem + { + Title = "_Open", + Action = Open + }, + new MenuItem + { + Title = "_Save", + Action = Save + }, + new MenuItem + { + Title = "Save _As", + Action = () => SaveAs () + }, + new MenuItem + { + Title = "_Close", + Action = Close + }, + new MenuItem + { + Title = "_Quit", + Action = Quit + } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "_About", + [ + new MenuItem + { + Title = "_About", + Action = () => MessageBox.Query (ApplicationImpl.Instance, "Notepad", "About Notepad...", "Ok") + } + ] + ) + ); _tabView = CreateNewTabView (); @@ -58,84 +83,85 @@ public class Notepad : Scenario _tabView.ApplyStyleChanges (); _tabView.X = 0; - _tabView.Y = 1; + _tabView.Y = Pos.Bottom (menu); _tabView.Width = Dim.Fill (); _tabView.Height = Dim.Fill (1); - top.Add (_tabView); LenShortcut = new (Key.Empty, "Len: ", null); - var statusBar = new StatusBar ( - [ - new (Application.QuitKey, "Quit", Quit), - new (Key.F2, "Open", Open), - new (Key.F1, "New", New), - new (Key.F3, "Save", Save), - new (Key.F6, "Close", Close), - LenShortcut - ] - ) + // StatusBar + StatusBar statusBar = new ( + [ + new (Application.QuitKey, "Quit", Quit), + new (Key.F2, "Open", Open), + new (Key.F1, "New", New), + new (Key.F3, "Save", Save), + new (Key.F6, "Close", Close), + LenShortcut + ] + ) { AlignmentModes = AlignmentModes.IgnoreFirstOrLast }; - top.Add (statusBar); + + top.Add (menu, _tabView, statusBar); _focusedTabView = _tabView; _tabView.SelectedTabChanged += TabView_SelectedTabChanged; _tabView.HasFocusChanging += (s, e) => _focusedTabView = _tabView; - top.Ready += (s, e) => + top.IsModalChanged += (s, e) => { - New (); - LenShortcut.Title = $"Len:{_focusedTabView.Text?.Length ?? 0}"; + if (e.Value) + { + New (); + LenShortcut.Title = $"Len:{_focusedTabView?.Text?.Length ?? 0}"; + } }; Application.Run (top); top.Dispose (); - Application.Shutdown (); } - public void Save () { Save (_focusedTabView!, _focusedTabView!.SelectedTab!); } + public void Save () + { + if (_focusedTabView?.SelectedTab is { }) + { + Save (_focusedTabView, _focusedTabView.SelectedTab); + } + } public void Save (TabView tabViewToSave, Tab tabToSave) { - var tab = tabToSave as OpenedFile; - - if (tab == null) + if (tabToSave is not OpenedFile tab) { return; } - if (tab.File == null) + if (tab.File is null) { SaveAs (); } + else + { + tab.Save (); + } - tab.Save (); tabViewToSave.SetNeedsDraw (); } public bool SaveAs () { - var tab = _focusedTabView!.SelectedTab as OpenedFile; - - if (tab == null) + if (_focusedTabView?.SelectedTab is not OpenedFile tab) { return false; } - var fd = new SaveDialog (); + SaveDialog fd = new (); Application.Run (fd); - if (string.IsNullOrWhiteSpace (fd.Path)) - { - fd.Dispose (); - - return false; - } - - if (fd.Canceled) + if (string.IsNullOrWhiteSpace (fd.Path) || fd.Canceled) { fd.Dispose (); @@ -151,13 +177,17 @@ public class Notepad : Scenario return true; } - private void Close () { Close (_focusedTabView!, _focusedTabView!.SelectedTab!); } + private void Close () + { + if (_focusedTabView?.SelectedTab is { }) + { + Close (_focusedTabView, _focusedTabView.SelectedTab); + } + } private void Close (TabView tv, Tab tabToClose) { - var tab = tabToClose as OpenedFile; - - if (tab == null) + if (tabToClose is not OpenedFile tab) { return; } @@ -166,15 +196,15 @@ public class Notepad : Scenario if (tab.UnsavedChanges) { - int result = MessageBox.Query ( - "Save Changes", - $"Save changes to {tab.Text.TrimEnd ('*')}", - "Yes", - "No", - "Cancel" + int? result = MessageBox.Query (ApplicationImpl.Instance, + "Save Changes", + $"Save changes to {tab.Text.TrimEnd ('*')}", + "Yes", + "No", + "Cancel" ); - if (result == -1 || result == 2) + if (result is null || result == 2) { // user cancelled return; @@ -182,7 +212,7 @@ public class Notepad : Scenario if (result == 0) { - if (tab.File == null) + if (tab.File is null) { SaveAs (); } @@ -207,7 +237,7 @@ public class Notepad : Scenario private TabView CreateNewTabView () { - var tv = new TabView { X = 0, Y = 0, Width = Dim.Fill (), Height = Dim.Fill () }; + TabView tv = new () { X = 0, Y = 0, Width = Dim.Fill (), Height = Dim.Fill () }; tv.TabClicked += TabView_TabClicked; tv.SelectedTabChanged += TabView_SelectedTabChanged; @@ -220,7 +250,7 @@ public class Notepad : Scenario private void Open () { - var open = new OpenDialog { Title = "Open", AllowsMultipleSelection = true }; + OpenDialog open = new () { Title = "Open", AllowsMultipleSelection = true }; Application.Run (open); @@ -246,21 +276,29 @@ public class Notepad : Scenario /// Creates a new tab with initial text /// File that was read or null if a new blank document /// - private void Open (FileInfo fileInfo, string tabName) + private void Open (FileInfo? fileInfo, string tabName) { - var tab = new OpenedFile (this) { DisplayText = tabName, File = fileInfo }; + if (_focusedTabView is null) + { + return; + } + + OpenedFile tab = new (this) { DisplayText = tabName, File = fileInfo }; tab.View = tab.CreateTextView (fileInfo); tab.SavedText = tab.View.Text; - tab.RegisterTextViewEvents (_focusedTabView!); + tab.RegisterTextViewEvents (_focusedTabView); - _focusedTabView!.AddTab (tab, true); + _focusedTabView.AddTab (tab, true); } private void Quit () { Application.RequestStop (); } private void TabView_SelectedTabChanged (object? sender, TabChangedEventArgs e) { - LenShortcut!.Title = $"Len:{e.NewTab?.View?.Text?.Length ?? 0}"; + if (LenShortcut is { }) + { + LenShortcut.Title = $"Len:{e.NewTab?.View?.Text?.Length ?? 0}"; + } e.NewTab?.View?.SetFocus (); } @@ -275,30 +313,33 @@ public class Notepad : Scenario View [] items; - if (e.Tab == null) + if (e.Tab is null) { - items = [new MenuItemv2 ("Open", "", Open)]; + items = [new MenuItem { Title = "Open", Action = Open }]; } else { var tv = (TabView)sender!; - var t = (OpenedFile)e.Tab; items = [ - new MenuItemv2 ("Save", "", () => Save (_focusedTabView!, e.Tab)), - new MenuItemv2 ("Close", "", () => Close (tv, e.Tab)) + new MenuItem { Title = "Save", Action = () => Save (_focusedTabView!, e.Tab) }, + new MenuItem { Title = "Close", Action = () => Close (tv, e.Tab) } ]; - - PopoverMenu? contextMenu = new (items); - - // Registering with the PopoverManager will ensure that the context menu is closed when the view is no longer focused - // and the context menu is disposed when it is closed. - Application.Popover?.Register (contextMenu); - contextMenu?.MakeVisible (e.MouseEvent.ScreenPosition); - - e.MouseEvent.Handled = true; } + + PopoverMenu contextMenu = new (items); + + // Registering with the PopoverManager will ensure that the context menu is closed when the view is no longer focused + // and the context menu is disposed when it is closed. + if (sender is TabView tabView && tabView.App?.Popover is { }) + { + tabView.App.Popover.Register (contextMenu); + } + + contextMenu.MakeVisible (e.MouseEvent.ScreenPosition); + + e.MouseEvent.Handled = true; } private class OpenedFile (Notepad notepad) : Tab @@ -307,8 +348,8 @@ public class Notepad : Scenario public OpenedFile CloneTo (TabView other) { - var newTab = new OpenedFile (_notepad) { DisplayText = base.Text, File = File }; - newTab.View = newTab.CreateTextView (newTab.File!); + OpenedFile newTab = new (_notepad) { DisplayText = Text, File = File }; + newTab.View = newTab.CreateTextView (newTab.File); newTab.SavedText = newTab.View.Text; newTab.RegisterTextViewEvents (other); other.AddTab (newTab, true); @@ -340,7 +381,10 @@ public class Notepad : Scenario public void RegisterTextViewEvents (TabView parent) { - var textView = (TextView)View!; + if (View is not TextView textView) + { + return; + } // when user makes changes rename tab to indicate unsaved textView.ContentsChanged += (s, k) => @@ -363,25 +407,27 @@ public class Notepad : Scenario } } - _notepad.LenShortcut!.Title = $"Len:{textView.Text.Length}"; + if (_notepad.LenShortcut is { }) + { + _notepad.LenShortcut.Title = $"Len:{textView.Text.Length}"; + } }; } /// The text of the tab the last time it was saved - /// public string? SavedText { get; set; } - public bool UnsavedChanges => !string.Equals (SavedText, View!.Text); + public bool UnsavedChanges => View is { } && !string.Equals (SavedText, View.Text); internal void Save () { - string newText = View!.Text; - - if (File is null || string.IsNullOrWhiteSpace (File.FullName)) + if (View is null || File is null || string.IsNullOrWhiteSpace (File.FullName)) { return; } + string newText = View.Text; + System.IO.File.WriteAllText (File.FullName, newText); SavedText = newText; diff --git a/Examples/UICatalog/Scenarios/PosAlignDemo.cs b/Examples/UICatalog/Scenarios/PosAlignDemo.cs index 714155bff..5f99a04e5 100644 --- a/Examples/UICatalog/Scenarios/PosAlignDemo.cs +++ b/Examples/UICatalog/Scenarios/PosAlignDemo.cs @@ -20,7 +20,7 @@ public sealed class PosAlignDemo : Scenario Title = $"{Application.QuitKey} to Quit - Scenario: {GetName ()} - {GetDescription ()}" }; - SetupControls (appWindow, Dimension.Width, Schemes.Toplevel); + SetupControls (appWindow, Dimension.Width, Schemes.Runnable); SetupControls (appWindow, Dimension.Height, Schemes.Error); diff --git a/Examples/UICatalog/Scenarios/Progress.cs b/Examples/UICatalog/Scenarios/Progress.cs index 4696c160c..0e3af66c4 100644 --- a/Examples/UICatalog/Scenarios/Progress.cs +++ b/Examples/UICatalog/Scenarios/Progress.cs @@ -43,7 +43,7 @@ public class Progress : Scenario { // Note the check for Mainloop being valid. System.Timers can run after they are Disposed. // This code must be defensive for that. - Application.Invoke (() => systemTimerDemo.Pulse ()); + Application.Invoke ((_) => systemTimerDemo.Pulse ()); }, null, 0, diff --git a/Examples/UICatalog/Scenarios/ProgressBarStyles.cs b/Examples/UICatalog/Scenarios/ProgressBarStyles.cs index aafc12f99..6fbab174d 100644 --- a/Examples/UICatalog/Scenarios/ProgressBarStyles.cs +++ b/Examples/UICatalog/Scenarios/ProgressBarStyles.cs @@ -27,7 +27,7 @@ public class ProgressBarStyles : Scenario { Application.Init (); - Window app = new () + Window win = new () { Title = GetQuitKeyAndName (), BorderStyle = LineStyle.Single, }; @@ -38,7 +38,7 @@ public class ProgressBarStyles : Scenario ShowViewIdentifier = true }; - app.Add (editor); + win.Add (editor); View container = new () { @@ -47,7 +47,7 @@ public class ProgressBarStyles : Scenario Width = Dim.Fill (), Height = Dim.Fill (), }; - app.Add (container); + win.Add (container); const float fractionStep = 0.01F; @@ -278,8 +278,8 @@ public class ProgressBarStyles : Scenario - app.Initialized += App_Initialized; - app.Unloaded += App_Unloaded; + win.Initialized += Win_Initialized; + win.IsRunningChanged += Win_IsRunningChanged; _pulseTimer = new Timer ( _ => @@ -292,14 +292,18 @@ public class ProgressBarStyles : Scenario 0, 300 ); - Application.Run (app); - app.Dispose (); + Application.Run (win); + win.Dispose (); Application.Shutdown (); return; - void App_Unloaded (object sender, EventArgs args) + void Win_IsRunningChanged (object sender, EventArgs args) { + if (args.Value) + { + return; + } if (_fractionTimer != null) { _fractionTimer.Dispose (); @@ -312,11 +316,11 @@ public class ProgressBarStyles : Scenario _pulseTimer = null; } - app.Unloaded -= App_Unloaded; + win.IsRunningChanged -= Win_IsRunningChanged; } } - private void App_Initialized (object sender, EventArgs e) + private void Win_Initialized (object sender, EventArgs e) { _pbList.SelectedItem = 0; } diff --git a/Examples/UICatalog/Scenarios/RegionScenario.cs b/Examples/UICatalog/Scenarios/RegionScenario.cs index dea5d5f0a..495d90d6a 100644 --- a/Examples/UICatalog/Scenarios/RegionScenario.cs +++ b/Examples/UICatalog/Scenarios/RegionScenario.cs @@ -24,31 +24,31 @@ public class RegionScenario : Scenario { Application.Init (); - Window app = new () + Window appWindow = new () { Title = GetQuitKeyAndName (), TabStop = TabBehavior.TabGroup }; - app.Padding!.Thickness = new (1); + appWindow.Padding!.Thickness = new (1); var tools = new ToolsView { Title = "Tools", X = Pos.AnchorEnd (), Y = 2 }; - tools.CurrentAttribute = app.GetAttributeForRole (VisualRole.HotNormal); + tools.CurrentAttribute = appWindow.GetAttributeForRole (VisualRole.HotNormal); tools.SetStyle += b => { _drawStyle = b; - app.SetNeedsDraw (); + appWindow.SetNeedsDraw (); }; tools.RegionOpChanged += (s, e) => { _regionOp = e; }; //tools.AddLayer += () => canvas.AddLayer (); - app.Add (tools); + appWindow.Add (tools); // Add drag handling to window - app.MouseEvent += (s, e) => + appWindow.MouseEvent += (s, e) => { if (e.Flags.HasFlag (MouseFlags.Button1Pressed)) { @@ -62,7 +62,7 @@ public class RegionScenario : Scenario // Drag if (_isDragging && _dragStart.HasValue) { - app.SetNeedsDraw (); + appWindow.SetNeedsDraw (); } } } @@ -77,31 +77,31 @@ public class RegionScenario : Scenario _dragStart = null; } - app.SetNeedsDraw (); + appWindow.SetNeedsDraw (); } }; // Draw the regions - app.DrawingContent += (s, e) => + appWindow.DrawingContent += (s, e) => { // Draw all regions with single line style //_region.FillRectangles (_attribute.Value, _fillRune); switch (_drawStyle) { case RegionDrawStyles.FillOnly: - _region.FillRectangles (tools.CurrentAttribute!.Value, _previewFillRune); + _region.FillRectangles (appWindow.App?.Driver, tools.CurrentAttribute!.Value, _previewFillRune); break; case RegionDrawStyles.InnerBoundaries: - _region.DrawBoundaries (app.LineCanvas, LineStyle.Single, tools.CurrentAttribute); - _region.FillRectangles (tools.CurrentAttribute!.Value, (Rune)' '); + _region.DrawBoundaries (appWindow.LineCanvas, LineStyle.Single, tools.CurrentAttribute); + _region.FillRectangles (appWindow.App?.Driver, tools.CurrentAttribute!.Value, (Rune)' '); break; case RegionDrawStyles.OuterBoundary: - _region.DrawOuterBoundary (app.LineCanvas, LineStyle.Single, tools.CurrentAttribute); - _region.FillRectangles (tools.CurrentAttribute!.Value, (Rune)' '); + _region.DrawOuterBoundary (appWindow.LineCanvas, LineStyle.Single, tools.CurrentAttribute); + _region.FillRectangles (appWindow.App?.Driver, tools.CurrentAttribute!.Value, (Rune)' '); break; } @@ -109,14 +109,14 @@ public class RegionScenario : Scenario // If currently dragging, draw preview rectangle if (_isDragging && _dragStart.HasValue) { - Point currentMousePos = Application.GetLastMousePosition ()!.Value; + Point currentMousePos = appWindow.App!.Mouse.LastMousePosition!.Value; Rectangle previewRect = GetRectFromPoints (_dragStart.Value, currentMousePos); var previewRegion = new Region (previewRect); - previewRegion.FillRectangles (tools.CurrentAttribute!.Value, (Rune)' '); + previewRegion.FillRectangles (appWindow.App.Driver, tools.CurrentAttribute!.Value, (Rune)' '); previewRegion.DrawBoundaries ( - app.LineCanvas, + appWindow.LineCanvas, LineStyle.Dashed, new ( tools.CurrentAttribute!.Value.Foreground.GetBrighterColor (), @@ -124,10 +124,10 @@ public class RegionScenario : Scenario } }; - Application.Run (app); + Application.Run (appWindow); // Clean up - app.Dispose (); + appWindow.Dispose (); Application.Shutdown (); } diff --git a/Examples/UICatalog/Scenarios/RunTExample.cs b/Examples/UICatalog/Scenarios/RunTExample.cs index 6e4cfa1d7..1d5f4e5a5 100644 --- a/Examples/UICatalog/Scenarios/RunTExample.cs +++ b/Examples/UICatalog/Scenarios/RunTExample.cs @@ -8,7 +8,7 @@ public class RunTExample : Scenario public override void Main () { // No need to call Init if Application.Run is used - Application.Run ().Dispose (); + Application.Run (); Application.Shutdown (); } @@ -63,12 +63,12 @@ public class RunTExample : Scenario { if (_usernameText.Text == "admin" && passwordText.Text == "password") { - MessageBox.Query ("Login Successful", $"Username: {_usernameText.Text}", "Ok"); - Application.RequestStop (); + MessageBox.Query (App, "Login Successful", $"Username: {_usernameText.Text}", "Ok"); + App?.RequestStop (); } else { - MessageBox.ErrorQuery ( + MessageBox.ErrorQuery (App, "Error Logging In", "Incorrect username or password (hint: admin/password)", "Ok" diff --git a/Examples/UICatalog/Scenarios/RuneWidthGreaterThanOne.cs b/Examples/UICatalog/Scenarios/RuneWidthGreaterThanOne.cs index a10fd6ca8..23f2e63fa 100644 --- a/Examples/UICatalog/Scenarios/RuneWidthGreaterThanOne.cs +++ b/Examples/UICatalog/Scenarios/RuneWidthGreaterThanOne.cs @@ -1,4 +1,6 @@ -using System; +#nullable enable + +using System; namespace UICatalog.Scenarios; @@ -8,99 +10,173 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("Tests")] public class RuneWidthGreaterThanOne : Scenario { - private Button _button; - private Label _label; - private Label _labelR; - private Label _labelV; - private string _lastRunesUsed; - private TextField _text; - private Window _win; + private Button? _button; + private Label? _label; + private Label? _labelR; + private Label? _labelV; + private string? _lastRunesUsed; + private TextField? _text; + private Window? _win; public override void Main () { Application.Init (); - Toplevel topLevel = new (); - - var menu = new MenuBar + // Window (top-level) + Window win = new () { - Menus = - [ - new MenuBarItem ( - "Padding", - new MenuItem [] - { - new ( - "With Padding", - "", - () => _win.Padding.Thickness = - new Thickness (1) - ), - new ( - "Without Padding", - "", - () => _win.Padding.Thickness = - new Thickness (0) - ) - } - ), - new MenuBarItem ( - "BorderStyle", - new MenuItem [] - { - new ( - "Single", - "", - () => _win.BorderStyle = LineStyle.Single - ), - new ( - "None", - "", - () => _win.BorderStyle = LineStyle.None - ) - } - ), - new MenuBarItem ( - "Runes length", - new MenuItem [] - { - new ("Wide", "", WideRunes), - new ("Narrow", "", NarrowRunes), - new ("Mixed", "", MixedRunes) - } - ) - ] + X = 5, + Y = 5, + Width = Dim.Fill (22), + Height = Dim.Fill (5), + Arrangement = ViewArrangement.Overlapped | ViewArrangement.Movable + }; + _win = win; + + // MenuBar + MenuBar menu = new (); + + // Controls + _label = new () + { + X = Pos.Center (), + Y = 1 }; - _label = new Label + _text = new () { - X = Pos.Center (), Y = 1, + X = Pos.Center (), + Y = 3, + Width = 20 }; - _text = new TextField { X = Pos.Center (), Y = 3, Width = 20 }; - _button = new Button { X = Pos.Center (), Y = 5 }; - _labelR = new Label { X = Pos.AnchorEnd (30), Y = 18 }; - _labelV = new Label + _button = new () { - TextDirection = TextDirection.TopBottom_LeftRight, X = Pos.AnchorEnd (30), Y = Pos.Bottom (_labelR) + X = Pos.Center (), + Y = 5 }; - _win = new Window { X = 5, Y = 5, Width = Dim.Fill (22), Height = Dim.Fill (5) }; - _win.Add (_label, _text, _button, _labelR, _labelV); - topLevel.Add (menu, _win); + + _labelR = new () + { + X = Pos.AnchorEnd (30), + Y = 18 + }; + + _labelV = new () + { + TextDirection = TextDirection.TopBottom_LeftRight, + X = Pos.AnchorEnd (30), + Y = Pos.Bottom (_labelR) + }; + + menu.Add ( + new MenuBarItem ( + "Padding", + [ + new MenuItem + { + Title = "With Padding", + Action = () => + { + if (_win is { }) + { + _win.Padding!.Thickness = new (1); + } + } + }, + new MenuItem + { + Title = "Without Padding", + Action = () => + { + if (_win is { }) + { + _win.Padding!.Thickness = new (0); + } + } + } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "BorderStyle", + [ + new MenuItem + { + Title = "Single", + Action = () => + { + if (_win is { }) + { + _win.BorderStyle = LineStyle.Single; + } + } + }, + new MenuItem + { + Title = "None", + Action = () => + { + if (_win is { }) + { + _win.BorderStyle = LineStyle.None; + } + } + } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "Runes length", + [ + new MenuItem + { + Title = "Wide", + Action = WideRunes + }, + new MenuItem + { + Title = "Narrow", + Action = NarrowRunes + }, + new MenuItem + { + Title = "Mixed", + Action = MixedRunes + } + ] + ) + ); + + // Add views in order of visual appearance + win.Add (menu, _label, _text, _button, _labelR, _labelV); WideRunes (); - //NarrowRunes (); - //MixedRunes (); - Application.Run (topLevel); - topLevel.Dispose (); + Application.Run (win); + win.Dispose (); Application.Shutdown (); } - private void MixedMessage (object sender, EventArgs e) { MessageBox.Query ("Say Hello 你", $"Hello {_text.Text}", "Ok"); } + private void MixedMessage (object? sender, EventArgs e) + { + if (_text is { }) + { + MessageBox.Query (ApplicationImpl.Instance, "Say Hello 你", $"Hello {_text.Text}", "Ok"); + } + } private void MixedRunes () { + if (_label is null || _text is null || _button is null || _labelR is null || _labelV is null || _win is null) + { + return; + } + UnsetClickedEvent (); _label.Text = "Enter your name 你:"; _text.Text = "gui.cs 你:"; @@ -117,10 +193,21 @@ public class RuneWidthGreaterThanOne : Scenario Application.LayoutAndDraw (); } - private void NarrowMessage (object sender, EventArgs e) { MessageBox.Query ("Say Hello", $"Hello {_text.Text}", "Ok"); } + private void NarrowMessage (object? sender, EventArgs e) + { + if (_text is { }) + { + MessageBox.Query (ApplicationImpl.Instance, "Say Hello", $"Hello {_text.Text}", "Ok"); + } + } private void NarrowRunes () { + if (_label is null || _text is null || _button is null || _labelR is null || _labelV is null || _win is null) + { + return; + } + UnsetClickedEvent (); _label.Text = "Enter your name:"; _text.Text = "gui.cs"; @@ -139,6 +226,11 @@ public class RuneWidthGreaterThanOne : Scenario private void UnsetClickedEvent () { + if (_button is null) + { + return; + } + switch (_lastRunesUsed) { case "Narrow": @@ -156,10 +248,21 @@ public class RuneWidthGreaterThanOne : Scenario } } - private void WideMessage (object sender, EventArgs e) { MessageBox.Query ("こんにちはと言う", $"こんにちは {_text.Text}", "Ok"); } + private void WideMessage (object? sender, EventArgs e) + { + if (_text is { }) + { + MessageBox.Query (ApplicationImpl.Instance, "こんにちはと言う", $"こんにちは {_text.Text}", "Ok"); + } + } private void WideRunes () { + if (_label is null || _text is null || _button is null || _labelR is null || _labelV is null || _win is null) + { + return; + } + UnsetClickedEvent (); _label.Text = "あなたの名前を入力してください："; _text.Text = "ティラミス"; @@ -175,4 +278,4 @@ public class RuneWidthGreaterThanOne : Scenario _lastRunesUsed = "Wide"; Application.LayoutAndDraw (); } -} +} \ No newline at end of file diff --git a/Examples/UICatalog/Scenarios/Scrolling.cs b/Examples/UICatalog/Scenarios/Scrolling.cs index b79964596..a503538e7 100644 --- a/Examples/UICatalog/Scenarios/Scrolling.cs +++ b/Examples/UICatalog/Scenarios/Scrolling.cs @@ -16,13 +16,13 @@ public class Scrolling : Scenario { Application.Init (); - var app = new Window + var win = new Window { Title = GetQuitKeyAndName () }; var label = new Label { X = 0, Y = 0 }; - app.Add (label); + win.Add (label); var demoView = new AllViewsView { @@ -42,7 +42,7 @@ public class Scrolling : Scenario $"{demoView}\nContentSize: {demoView.GetContentSize ()}\nViewport.Location: {demoView.Viewport.Location}"; }; - app.Add (demoView); + win.Add (demoView); var hCheckBox = new CheckBox { @@ -51,7 +51,7 @@ public class Scrolling : Scenario Text = "_HorizontalScrollBar.Visible", CheckedState = demoView.HorizontalScrollBar.Visible ? CheckState.Checked : CheckState.UnChecked }; - app.Add (hCheckBox); + win.Add (hCheckBox); hCheckBox.CheckedStateChanged += (sender, args) => { demoView.HorizontalScrollBar.Visible = args.Value == CheckState.Checked; }; var vCheckBox = new CheckBox @@ -61,7 +61,7 @@ public class Scrolling : Scenario Text = "_VerticalScrollBar.Visible", CheckedState = demoView.VerticalScrollBar.Visible ? CheckState.Checked : CheckState.UnChecked }; - app.Add (vCheckBox); + win.Add (vCheckBox); vCheckBox.CheckedStateChanged += (sender, args) => { demoView.VerticalScrollBar.Visible = args.Value == CheckState.Checked; }; var ahCheckBox = new CheckBox @@ -77,7 +77,7 @@ public class Scrolling : Scenario demoView.HorizontalScrollBar.AutoShow = e.Result == CheckState.Checked; demoView.VerticalScrollBar.AutoShow = e.Result == CheckState.Checked; }; - app.Add (ahCheckBox); + win.Add (ahCheckBox); demoView.VerticalScrollBar.VisibleChanging += (sender, args) => { vCheckBox.CheckedState = args.NewValue ? CheckState.Checked : CheckState.UnChecked; }; @@ -92,19 +92,19 @@ public class Scrolling : Scenario X = Pos.Center (), Y = Pos.AnchorEnd (), Width = Dim.Fill () }; - app.Add (progress); + win.Add (progress); - app.Initialized += AppOnInitialized; - app.Unloaded += AppUnloaded; + win.Initialized += WinOnInitialized; + win.IsRunningChanged += WinIsRunningChanged; - Application.Run (app); - app.Unloaded -= AppUnloaded; - app.Dispose (); + Application.Run (win); + win.IsRunningChanged -= WinIsRunningChanged; + win.Dispose (); Application.Shutdown (); return; - void AppOnInitialized (object? sender, EventArgs e) + void WinOnInitialized (object? sender, EventArgs e) { bool TimerFn () { @@ -116,9 +116,9 @@ public class Scrolling : Scenario _progressTimer = Application.AddTimeout (TimeSpan.FromMilliseconds (200), TimerFn); } - void AppUnloaded (object? sender, EventArgs args) + void WinIsRunningChanged (object? sender, EventArgs args) { - if (_progressTimer is { }) + if (!args.Value && _progressTimer is { }) { Application.RemoveTimeout (_progressTimer); _progressTimer = null; diff --git a/Examples/UICatalog/Scenarios/Shortcuts.cs b/Examples/UICatalog/Scenarios/Shortcuts.cs index 712b69acf..a2e241c6c 100644 --- a/Examples/UICatalog/Scenarios/Shortcuts.cs +++ b/Examples/UICatalog/Scenarios/Shortcuts.cs @@ -15,7 +15,7 @@ public class Shortcuts : Scenario var quitKey = Application.QuitKey; Window app = new (); - app.Loaded += App_Loaded; + app.IsModalChanged += App_Loaded; Application.Run (app); app.Dispose (); @@ -28,7 +28,7 @@ public class Shortcuts : Scenario private void App_Loaded (object? sender, EventArgs e) { Application.QuitKey = Key.F4.WithCtrl; - Application.Top!.Title = GetQuitKeyAndName (); + Application.TopRunnableView!.Title = GetQuitKeyAndName (); ObservableCollection eventSource = new (); @@ -38,7 +38,7 @@ public class Shortcuts : Scenario X = Pos.AnchorEnd (), Y = 0, Height = Dim.Fill (4), - SchemeName = "TopLevel", + SchemeName = "Runnable", Source = new ListWrapper (eventSource), BorderStyle = LineStyle.Double, Title = "E_vents" @@ -46,14 +46,14 @@ public class Shortcuts : Scenario eventLog.Width = Dim.Func ( _ => Math.Min ( - Application.Top.Viewport.Width / 2, + Application.TopRunnableView.Viewport.Width / 2, eventLog?.MaxLength + eventLog!.GetAdornmentsThickness ().Horizontal ?? 0)); eventLog.Width = Dim.Func ( _ => Math.Min ( eventLog.SuperView!.Viewport.Width / 2, eventLog?.MaxLength + eventLog!.GetAdornmentsThickness ().Horizontal ?? 0)); - Application.Top.Add (eventLog); + Application.TopRunnableView.Add (eventLog); var alignKeysShortcut = new Shortcut { @@ -86,7 +86,7 @@ public class Shortcuts : Scenario }; - Application.Top.Add (alignKeysShortcut); + Application.TopRunnableView.Add (alignKeysShortcut); var commandFirstShortcut = new Shortcut { @@ -115,7 +115,7 @@ public class Shortcuts : Scenario $"{commandFirstShortcut.Id}.CommandView.CheckedStateChanging: {cb.Text}"); eventLog.MoveDown (); - IEnumerable toAlign = Application.Top.SubViews.OfType (); + IEnumerable toAlign = Application.TopRunnableView.SubViews.OfType (); IEnumerable enumerable = toAlign as View [] ?? toAlign.ToArray (); foreach (View view in enumerable) @@ -134,7 +134,7 @@ public class Shortcuts : Scenario } }; - Application.Top.Add (commandFirstShortcut); + Application.TopRunnableView.Add (commandFirstShortcut); var canFocusShortcut = new Shortcut { @@ -159,7 +159,7 @@ public class Shortcuts : Scenario SetCanFocus (e.Result == CheckState.Checked); } }; - Application.Top.Add (canFocusShortcut); + Application.TopRunnableView.Add (canFocusShortcut); var appShortcut = new Shortcut { @@ -173,7 +173,7 @@ public class Shortcuts : Scenario BindKeyToApplication = true }; - Application.Top.Add (appShortcut); + Application.TopRunnableView.Add (appShortcut); var buttonShortcut = new Shortcut { @@ -193,7 +193,7 @@ public class Shortcuts : Scenario var button = (Button)buttonShortcut.CommandView; buttonShortcut.Accepting += Button_Clicked; - Application.Top.Add (buttonShortcut); + Application.TopRunnableView.Add (buttonShortcut); var optionSelectorShortcut = new Shortcut { @@ -221,7 +221,7 @@ public class Shortcuts : Scenario } }; - Application.Top.Add (optionSelectorShortcut); + Application.TopRunnableView.Add (optionSelectorShortcut); var sliderShortcut = new Shortcut { @@ -248,7 +248,7 @@ public class Shortcuts : Scenario eventLog.MoveDown (); }; - Application.Top.Add (sliderShortcut); + Application.TopRunnableView.Add (sliderShortcut); ListView listView = new ListView () { @@ -270,7 +270,7 @@ public class Shortcuts : Scenario Key = Key.F5.WithCtrl, }; - Application.Top.Add (listViewShortcut); + Application.TopRunnableView.Add (listViewShortcut); var noCommandShortcut = new Shortcut { @@ -282,7 +282,7 @@ public class Shortcuts : Scenario Key = Key.D0 }; - Application.Top.Add (noCommandShortcut); + Application.TopRunnableView.Add (noCommandShortcut); var noKeyShortcut = new Shortcut { @@ -295,7 +295,7 @@ public class Shortcuts : Scenario HelpText = "Keyless" }; - Application.Top.Add (noKeyShortcut); + Application.TopRunnableView.Add (noKeyShortcut); var noHelpShortcut = new Shortcut { @@ -308,7 +308,7 @@ public class Shortcuts : Scenario HelpText = "" }; - Application.Top.Add (noHelpShortcut); + Application.TopRunnableView.Add (noHelpShortcut); noHelpShortcut.SetFocus (); var framedShortcut = new Shortcut @@ -339,8 +339,8 @@ public class Shortcuts : Scenario framedShortcut.KeyView.SchemeName = framedShortcut.KeyView.SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Base); } - framedShortcut.SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Toplevel); - Application.Top.Add (framedShortcut); + framedShortcut.SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Runnable); + Application.TopRunnableView.Add (framedShortcut); // Horizontal var progressShortcut = new Shortcut @@ -387,7 +387,7 @@ public class Shortcuts : Scenario }; timer.Start (); - Application.Top.Add (progressShortcut); + Application.TopRunnableView.Add (progressShortcut); var textField = new TextField { @@ -408,7 +408,7 @@ public class Shortcuts : Scenario }; textField.CanFocus = true; - Application.Top.Add (textFieldShortcut); + Application.TopRunnableView.Add (textFieldShortcut); var bgColorShortcut = new Shortcut { @@ -450,19 +450,19 @@ public class Shortcuts : Scenario eventSource.Add ($"ColorChanged: {o.GetType ().Name} - {args.Result}"); eventLog.MoveDown (); - Application.Top.SetScheme ( - new (Application.Top.GetScheme ()) + Application.TopRunnableView.SetScheme ( + new (Application.TopRunnableView.GetScheme ()) { Normal = new ( - Application.Top!.GetAttributeForRole (VisualRole.Normal).Foreground, + Application.TopRunnableView!.GetAttributeForRole (VisualRole.Normal).Foreground, args.Result, - Application.Top!.GetAttributeForRole (VisualRole.Normal).Style) + Application.TopRunnableView!.GetAttributeForRole (VisualRole.Normal).Style) }); } }; bgColorShortcut.CommandView = bgColor; - Application.Top.Add (bgColorShortcut); + Application.TopRunnableView.Add (bgColorShortcut); var appQuitShortcut = new Shortcut { @@ -476,9 +476,9 @@ public class Shortcuts : Scenario }; appQuitShortcut.Accepting += (o, args) => { Application.RequestStop (); }; - Application.Top.Add (appQuitShortcut); + Application.TopRunnableView.Add (appQuitShortcut); - foreach (Shortcut shortcut in Application.Top.SubViews.OfType ()) + foreach (Shortcut shortcut in Application.TopRunnableView.SubViews.OfType ()) { shortcut.Selecting += (o, args) => { @@ -529,7 +529,7 @@ public class Shortcuts : Scenario void SetCanFocus (bool canFocus) { - foreach (Shortcut peer in Application.Top!.SubViews.OfType ()) + foreach (Shortcut peer in Application.TopRunnableView!.SubViews.OfType ()) { if (peer.CanFocus) { @@ -542,7 +542,7 @@ public class Shortcuts : Scenario { var max = 0; - IEnumerable toAlign = Application.Top!.SubViews.OfType ().Where(s => !s.Y.Has(out _)).Cast(); + IEnumerable toAlign = Application.TopRunnableView!.SubViews.OfType ().Where(s => !s.Y.Has(out _)).Cast(); IEnumerable enumerable = toAlign as Shortcut [] ?? toAlign.ToArray (); if (align) @@ -566,6 +566,6 @@ public class Shortcuts : Scenario { e.Handled = true; var view = sender as View; - MessageBox.Query ("Hi", $"You clicked {view?.Text}", "_Ok"); + MessageBox.Query ((sender as View)?.App, "Hi", $"You clicked {view?.Text}", "_Ok"); } } diff --git a/Examples/UICatalog/Scenarios/SingleBackgroundWorker.cs b/Examples/UICatalog/Scenarios/SingleBackgroundWorker.cs index 62c35ac40..424523c00 100644 --- a/Examples/UICatalog/Scenarios/SingleBackgroundWorker.cs +++ b/Examples/UICatalog/Scenarios/SingleBackgroundWorker.cs @@ -1,12 +1,11 @@ -using System; -using System.Collections.Generic; +#nullable enable + using System.Collections.ObjectModel; using System.ComponentModel; -using System.Threading; namespace UICatalog.Scenarios; -[ScenarioMetadata ("Single BackgroundWorker", "A single BackgroundWorker threading opening another Toplevel")] +[ScenarioMetadata ("Single BackgroundWorker", "A single BackgroundWorker threading opening another Runnable")] [ScenarioCategory ("Threading")] [ScenarioCategory ("Arrangement")] [ScenarioCategory ("Runnable")] @@ -14,58 +13,56 @@ public class SingleBackgroundWorker : Scenario { public override void Main () { - Application.Run ().Dispose (); + Application.Run (); Application.Shutdown (); } - public class MainApp : Toplevel + public class MainApp : Window { private readonly ListView _listLog; private readonly ObservableCollection _log = []; private DateTime? _startStaging; - private BackgroundWorker _worker; + private BackgroundWorker? _worker; public MainApp () { - var menu = new MenuBar - { - Menus = - [ - new ( - "_Options", - new MenuItem [] - { - new ( - "_Run Worker", - "", - () => RunWorker (), - null, - null, - KeyCode.CtrlMask | KeyCode.R - ), - null, - new ( - "_Quit", - "", - () => Application.RequestStop (), - null, - null, - Application.QuitKey - ) - } - ) - ] - }; + BorderStyle = LineStyle.None; + // MenuBar + MenuBar menu = new (); - var statusBar = new StatusBar ( - [ - new (Application.QuitKey, "Quit", () => Application.RequestStop ()), - new (Key.R.WithCtrl, "Run Worker", RunWorker) - ]); + menu.Add ( + new MenuBarItem ( + "_Options", + [ + new MenuItem + { + Title = "_Run Worker", + Key = Key.R.WithCtrl, + Action = RunWorker + }, + new MenuItem + { + Title = "_Quit", + Key = Application.QuitKey, + Action = () => Application.RequestStop () + } + ] + ) + ); - var workerLogTop = new Toplevel + // StatusBar + StatusBar statusBar = new ( + [ + new (Application.QuitKey, "Quit", () => Application.RequestStop ()), + new (Key.R.WithCtrl, "Run Worker", RunWorker) + ] + ); + + Window workerLogTop = new () { - Title = "Worker Log Top" + Title = "Worker Log Top", + Y = Pos.Bottom (menu), + Height = Dim.Fill (1) }; workerLogTop.Add ( @@ -82,9 +79,6 @@ public class SingleBackgroundWorker : Scenario }; workerLogTop.Add (_listLog); - workerLogTop.Y = 1; - workerLogTop.Height = Dim.Fill (Dim.Func (_ => statusBar.Frame.Height)); - Add (menu, workerLogTop, statusBar); Title = "MainApp"; } @@ -93,11 +87,11 @@ public class SingleBackgroundWorker : Scenario { _worker = new () { WorkerSupportsCancellation = true }; - var cancel = new Button { Text = "Cancel Worker" }; + Button cancel = new () { Text = "Cancel Worker" }; cancel.Accepting += (s, e) => { - if (_worker == null) + if (_worker is null) { _log.Add ($"Worker is not running at {DateTime.Now}!"); _listLog.SetNeedsDraw (); @@ -116,9 +110,10 @@ public class SingleBackgroundWorker : Scenario _log.Add ($"Worker is started at {_startStaging}.{_startStaging:fff}"); _listLog.SetNeedsDraw (); - var md = new Dialog + Dialog md = new () { - Title = $"Running Worker started at {_startStaging}.{_startStaging:fff}", Buttons = [cancel] + Title = $"Running Worker started at {_startStaging}.{_startStaging:fff}", + Buttons = [cancel] }; md.Add ( @@ -127,7 +122,7 @@ public class SingleBackgroundWorker : Scenario _worker.DoWork += (s, e) => { - List stageResult = new (); + List stageResult = []; for (var i = 0; i < 200; i++) { @@ -135,7 +130,7 @@ public class SingleBackgroundWorker : Scenario e.Result = stageResult; Thread.Sleep (1); - if (_worker.CancellationPending) + if (_worker?.CancellationPending == true) { e.Cancel = true; @@ -152,7 +147,7 @@ public class SingleBackgroundWorker : Scenario Application.RequestStop (); } - if (e.Error != null) + if (e.Error is { }) { // Failed _log.Add ( @@ -177,14 +172,22 @@ public class SingleBackgroundWorker : Scenario _listLog.SetNeedsDraw (); Application.LayoutAndDraw (); - var builderUI = - new StagingUIController (_startStaging, e.Result as ObservableCollection); - Toplevel top = Application.Top; - top.Visible = false; - Application.Top.Visible = false; + StagingUIController builderUI = + new (_startStaging, e.Result as ObservableCollection); + View? top = Application.TopRunnableView; + + if (top is { }) + { + top.Visible = false; + } + builderUI.Load (); builderUI.Dispose (); - top.Visible = true; + + if (top is { }) + { + top.Visible = true; + } } _worker = null; @@ -197,13 +200,15 @@ public class SingleBackgroundWorker : Scenario public class StagingUIController : Window { - private Toplevel _top; + private Runnable? _top; - public StagingUIController (DateTime? start, ObservableCollection list) + public StagingUIController (DateTime? start, ObservableCollection? list) { _top = new () { - Title = "_top", Width = Dim.Fill (), Height = Dim.Fill (), Modal = true + Title = "_top", + Width = Dim.Fill (), + Height = Dim.Fill (), }; _top.KeyDown += (s, e) => @@ -218,7 +223,7 @@ public class SingleBackgroundWorker : Scenario bool Close () { - int n = MessageBox.Query ( + int? n = MessageBox.Query (App, 50, 7, "Close Window.", @@ -230,74 +235,78 @@ public class SingleBackgroundWorker : Scenario return n == 0; } - var menu = new MenuBar - { - Menus = - [ - new ( - "_Stage", - new MenuItem [] - { - new ( - "_Close", - "", - () => - { - if (Close ()) - { - Application.RequestStop (); - } - }, - null, - null, - KeyCode.CtrlMask | KeyCode.C - ) - } - ) - ] - }; + // MenuBar + MenuBar menu = new (); + + menu.Add ( + new MenuBarItem ( + "_Stage", + [ + new MenuItem + { + Title = "_Close", + Key = Key.C.WithCtrl, + Action = () => + { + if (Close ()) + { + App?.RequestStop (); + } + } + } + ] + ) + ); _top.Add (menu); - var statusBar = new StatusBar ( - [ - new ( - Key.C.WithCtrl, - "Close", - () => + // StatusBar + StatusBar statusBar = new ( + [ + new ( + Key.C.WithCtrl, + "Close", + () => + { + if (Close ()) { - if (Close ()) - { - Application.RequestStop (); - } + App?.RequestStop (); } - ) - ]); + } + ) + ] + ); _top.Add (statusBar); - Y = 1; + Y = Pos.Bottom (menu); Height = Dim.Fill (1); Title = $"Worker started at {start}.{start:fff}"; SchemeName = "Base"; - Add ( - new ListView - { - X = 0, - Y = 0, - Width = Dim.Fill (), - Height = Dim.Fill (), - Source = new ListWrapper (list) - } - ); + if (list is { }) + { + Add ( + new ListView + { + X = 0, + Y = 0, + Width = Dim.Fill (), + Height = Dim.Fill (), + Source = new ListWrapper (list) + } + ); + } _top.Add (this); } public void Load () { - Application.Run (_top); - _top.Dispose (); - _top = null; + if (_top is { }) + { + App?.Run (_top); + _top.Dispose (); + _top = null; + } } } } diff --git a/Examples/UICatalog/Scenarios/Sliders.cs b/Examples/UICatalog/Scenarios/Sliders.cs index fae50c015..d23eae48d 100644 --- a/Examples/UICatalog/Scenarios/Sliders.cs +++ b/Examples/UICatalog/Scenarios/Sliders.cs @@ -86,17 +86,17 @@ public class Sliders : Scenario { if (single.Orientation == Orientation.Horizontal) { - single.Style.SpaceChar = new () { Rune = Glyphs.HLine }; - single.Style.OptionChar = new () { Rune = Glyphs.HLine }; + single.Style.SpaceChar = new () { Grapheme = Glyphs.HLine.ToString () }; + single.Style.OptionChar = new () { Grapheme = Glyphs.HLine.ToString () }; } else { - single.Style.SpaceChar = new () { Rune = Glyphs.VLine }; - single.Style.OptionChar = new () { Rune = Glyphs.VLine }; + single.Style.SpaceChar = new () { Grapheme = Glyphs.VLine.ToString () }; + single.Style.OptionChar = new () { Grapheme = Glyphs.VLine.ToString () }; } }; - single.Style.SetChar = new () { Rune = Glyphs.ContinuousMeterSegment }; - single.Style.DragChar = new () { Rune = Glyphs.ContinuousMeterSegment }; + single.Style.SetChar = new () { Grapheme = Glyphs.ContinuousMeterSegment.ToString () }; + single.Style.DragChar = new () { Grapheme = Glyphs.ContinuousMeterSegment.ToString () }; v.Add (single); @@ -257,7 +257,7 @@ public class Sliders : Scenario { s.Orientation = Orientation.Horizontal; - s.Style.SpaceChar = new () { Rune = Glyphs.HLine }; + s.Style.SpaceChar = new () { Grapheme = Glyphs.HLine.ToString () }; if (prev == null) { @@ -275,7 +275,7 @@ public class Sliders : Scenario { s.Orientation = Orientation.Vertical; - s.Style.SpaceChar = new () { Rune = Glyphs.VLine }; + s.Style.SpaceChar = new () { Grapheme = Glyphs.VLine.ToString () }; if (prev == null) { @@ -590,7 +590,7 @@ public class Sliders : Scenario Y = Pos.Bottom (spacingOptions), Width = Dim.Fill (), Height = Dim.Fill (), - SchemeName = "TopLevel", + SchemeName = "Runnable", Source = new ListWrapper (eventSource) }; configView.Add (eventLog); diff --git a/Examples/UICatalog/Scenarios/SpinnerStyles.cs b/Examples/UICatalog/Scenarios/SpinnerStyles.cs index e9e923ae7..020f12368 100644 --- a/Examples/UICatalog/Scenarios/SpinnerStyles.cs +++ b/Examples/UICatalog/Scenarios/SpinnerStyles.cs @@ -14,7 +14,7 @@ public class SpinnerViewStyles : Scenario { Application.Init (); - Window app = new () + Window win = new () { Title = GetQuitKeyAndName () }; @@ -40,7 +40,7 @@ public class SpinnerViewStyles : Scenario //Title = "Preview", BorderStyle = LineStyle.Single }; - app.Add (preview); + win.Add (preview); var spinner = new SpinnerView { X = Pos.Center (), Y = 0 }; preview.Add (spinner); @@ -54,7 +54,7 @@ public class SpinnerViewStyles : Scenario CheckedState = CheckState.Checked, Text = "Ascii Only" }; - app.Add (ckbAscii); + win.Add (ckbAscii); var ckbNoSpecial = new CheckBox { @@ -64,28 +64,28 @@ public class SpinnerViewStyles : Scenario CheckedState = CheckState.Checked, Text = "No Special" }; - app.Add (ckbNoSpecial); + win.Add (ckbNoSpecial); var ckbReverse = new CheckBox { X = Pos.Center () - 22, Y = Pos.Bottom (preview) + 1, CheckedState = CheckState.UnChecked, Text = "Reverse" }; - app.Add (ckbReverse); + win.Add (ckbReverse); var ckbBounce = new CheckBox { X = Pos.Right (ckbReverse) + 2, Y = Pos.Bottom (preview) + 1, CheckedState = CheckState.UnChecked, Text = "Bounce" }; - app.Add (ckbBounce); + win.Add (ckbBounce); var delayLabel = new Label { X = Pos.Right (ckbBounce) + 2, Y = Pos.Bottom (preview) + 1, Text = "Delay:" }; - app.Add (delayLabel); + win.Add (delayLabel); var delayField = new TextField { X = Pos.Right (delayLabel), Y = Pos.Bottom (preview) + 1, Width = 5, Text = DEFAULT_DELAY.ToString () }; - app.Add (delayField); + win.Add (delayField); delayField.TextChanged += (s, e) => { @@ -96,13 +96,13 @@ public class SpinnerViewStyles : Scenario }; var customLabel = new Label { X = Pos.Right (delayField) + 2, Y = Pos.Bottom (preview) + 1, Text = "Custom:" }; - app.Add (customLabel); + win.Add (customLabel); var customField = new TextField { X = Pos.Right (customLabel), Y = Pos.Bottom (preview) + 1, Width = 12, Text = DEFAULT_CUSTOM }; - app.Add (customField); + win.Add (customField); string [] styleArray = styleDict.Select (e => e.Value.Key).ToArray (); @@ -117,7 +117,7 @@ public class SpinnerViewStyles : Scenario }; styles.SetSource (new ObservableCollection (styleArray)); styles.SelectedItem = 0; // SpinnerStyle.Custom; - app.Add (styles); + win.Add (styles); SetCustom (); customField.TextChanged += (s, e) => @@ -153,7 +153,7 @@ public class SpinnerViewStyles : Scenario else { spinner.Visible = true; - spinner.Style = (SpinnerStyle)Activator.CreateInstance (styleDict [e.Item].Value); + spinner.Style = (SpinnerStyle)Activator.CreateInstance (styleDict [e.Item.Value].Value); delayField.Text = spinner.SpinDelay.ToString (); ckbBounce.CheckedState = spinner.SpinBounce ? CheckState.Checked : CheckState.UnChecked; ckbNoSpecial.CheckedState = !spinner.HasSpecialCharacters ? CheckState.Checked : CheckState.UnChecked; @@ -166,7 +166,7 @@ public class SpinnerViewStyles : Scenario ckbBounce.CheckedStateChanging += (s, e) => { spinner.SpinBounce = e.Result == CheckState.Checked; }; - app.Unloaded += App_Unloaded; + win.IsRunningChanged += WinIsRunningChanged; void SetCustom () { @@ -199,23 +199,23 @@ public class SpinnerViewStyles : Scenario } } - void App_Unloaded (object sender, EventArgs args) + void WinIsRunningChanged (object sender, EventArgs args) { - if (spinner is {}) + if (!args.Value && spinner is {}) { spinner.Dispose (); spinner = null; } } - Application.Run (app); - app.Unloaded -= App_Unloaded; + Application.Run (win); + win.IsRunningChanged -= WinIsRunningChanged; if (spinner is { }) { spinner.Dispose (); spinner = null; } - app.Dispose (); + win.Dispose (); Application.Shutdown (); } diff --git a/Examples/UICatalog/Scenarios/SyntaxHighlighting.cs b/Examples/UICatalog/Scenarios/SyntaxHighlighting.cs index 7b0c05462..c1f5c49c5 100644 --- a/Examples/UICatalog/Scenarios/SyntaxHighlighting.cs +++ b/Examples/UICatalog/Scenarios/SyntaxHighlighting.cs @@ -1,8 +1,4 @@ -using System; -using System.Collections.Generic; -using System.ComponentModel; -using System.IO; -using System.Linq; +using System.ComponentModel; using System.Reflection; using System.Text; using System.Text.Json; @@ -88,7 +84,6 @@ public class SyntaxHighlighting : Scenario private Attribute _blue; private Attribute _green; private Attribute _magenta; - private MenuItem _miWrap; private TextView _textView; private Attribute _white; @@ -99,7 +94,7 @@ public class SyntaxHighlighting : Scenario /// The type of object to read from the file. /// The file path to read the object instance from. /// Returns a new instance of the object read from the Json file. - public static T ReadFromJsonFile (string filePath) where T : new() + public static T ReadFromJsonFile (string filePath) where T : new () { TextReader reader = null; @@ -125,48 +120,28 @@ public class SyntaxHighlighting : Scenario Application.Init (); // Setup - Create a top-level application window and configure it. - Toplevel appWindow = new (); + Runnable appWindow = new (); + + var menu = new MenuBar (); + + MenuItem wrapMenuItem = CreateWordWrapMenuItem (); + + menu.Add ( + new MenuBarItem ( + "_TextView", + [ + wrapMenuItem, + new Line (), + new MenuItem { Title = "_Syntax Highlighting", Action = ApplySyntaxHighlighting }, + new Line (), + new MenuItem { Title = "_Load Text Cells", Action = ApplyLoadCells }, + new MenuItem { Title = "_Save Text Cells", Action = SaveCells }, + new Line (), + new MenuItem { Title = "_Quit", Action = Quit } + ] + ) + ); - var menu = new MenuBar - { - Menus = - [ - new ( - "_TextView", - new [] - { - _miWrap = new ( - "_Word Wrap", - "", - () => WordWrap () - ) - { - CheckType = MenuItemCheckStyle - .Checked - }, - null, - new ( - "_Syntax Highlighting", - "", - () => ApplySyntaxHighlighting () - ), - null, - new ( - "_Load Rune Cells", - "", - () => ApplyLoadCells () - ), - new ( - "_Save Rune Cells", - "", - () => SaveCells () - ), - null, - new ("_Quit", "", () => Quit ()) - } - ) - ] - }; appWindow.Add (menu); _textView = new () @@ -192,6 +167,33 @@ public class SyntaxHighlighting : Scenario Application.Shutdown (); } + private MenuItem CreateWordWrapMenuItem () + { + CheckBox checkBox = new () + { + Title = "_Word Wrap", + CheckedState = _textView?.WordWrap == true ? CheckState.Checked : CheckState.UnChecked + }; + + checkBox.CheckedStateChanged += (s, e) => + { + if (_textView is { }) + { + _textView.WordWrap = checkBox.CheckedState == CheckState.Checked; + } + }; + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; + + return item; + } + /// /// Writes the given object instance to a Json file. /// Object type must have a parameterless constructor. @@ -211,7 +213,7 @@ public class SyntaxHighlighting : Scenario /// If false the file will be overwritten if it already exists. If true the contents will be appended /// to the file. /// - public static void WriteToJsonFile (string filePath, T objectToWrite, bool append = false) where T : new() + public static void WriteToJsonFile (string filePath, T objectToWrite, bool append = false) where T : new () { TextWriter writer = null; @@ -240,12 +242,9 @@ public class SyntaxHighlighting : Scenario { string csName = color.Key; - foreach (Rune rune in csName.EnumerateRunes ()) - { - cells.Add (new () { Rune = rune, Attribute = color.Value.Normal }); - } + cells.AddRange (Cell.ToCellList (csName, color.Value.Normal)); - cells.Add (new () { Rune = (Rune)'\n', Attribute = color.Value.Focus }); + cells.Add (new () { Grapheme = "\n", Attribute = color.Value.Focus }); } if (File.Exists (_path)) @@ -266,10 +265,10 @@ public class SyntaxHighlighting : Scenario { ClearAllEvents (); - _green = new Attribute (Color.Green, Color.Black); - _blue = new Attribute (Color.Blue, Color.Black); - _magenta = new Attribute (Color.Magenta, Color.Black); - _white = new Attribute (Color.White, Color.Black); + _green = new (Color.Green, Color.Black); + _blue = new (Color.Blue, Color.Black); + _magenta = new (Color.Magenta, Color.Black); + _white = new (Color.White, Color.Black); _textView.SetScheme (new () { Focus = _white }); _textView.Text = @@ -290,7 +289,7 @@ public class SyntaxHighlighting : Scenario _textView.InheritsPreviousAttribute = false; } - private bool ContainsPosition (Match m, int pos) { return pos >= m.Index && pos < m.Index + m.Length; } + private bool ContainsPosition (Match m, int pos) => pos >= m.Index && pos < m.Index + m.Length; private void HighlightTextBasedOnKeywords () { @@ -388,12 +387,6 @@ public class SyntaxHighlighting : Scenario List> cells = _textView.GetAllLines (); WriteToJsonFile (_path, cells); } - - private void WordWrap () - { - _miWrap.Checked = !_miWrap.Checked; - _textView.WordWrap = (bool)_miWrap.Checked; - } } public static class EventExtensions diff --git a/Examples/UICatalog/Scenarios/TabViewExample.cs b/Examples/UICatalog/Scenarios/TabViewExample.cs index 30f55d5f4..71eede3a6 100644 --- a/Examples/UICatalog/Scenarios/TabViewExample.cs +++ b/Examples/UICatalog/Scenarios/TabViewExample.cs @@ -1,4 +1,6 @@ -using System.Linq; +#nullable enable + +using System.Linq; using System.Text; namespace UICatalog.Scenarios; @@ -8,85 +10,41 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("TabView")] public class TabViewExample : Scenario { - private MenuItem _miShowBorder; - private MenuItem _miShowTabViewBorder; - private MenuItem _miShowTopLine; - private MenuItem _miTabsOnBottom; - private TabView _tabView; + private CheckBox? _miShowBorderCheckBox; + private CheckBox? _miShowTabViewBorderCheckBox; + private CheckBox? _miShowTopLineCheckBox; + private CheckBox? _miTabsOnBottomCheckBox; + private TabView? _tabView; public override void Main () { - // Init Application.Init (); - // Setup - Create a top-level application window and configure it. - Toplevel appWindow = new (); - - var menu = new MenuBar + Window appWindow = new () { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new ("_Add Blank Tab", "", AddBlankTab), - new ( - "_Clear SelectedTab", - "", - () => _tabView.SelectedTab = null - ), - new ("_Quit", "", Quit) - } - ), - new ( - "_View", - new [] - { - _miShowTopLine = - new ("_Show Top Line", "", ShowTopLine) - { - Checked = true, CheckType = MenuItemCheckStyle.Checked - }, - _miShowBorder = - new ("_Show Border", "", ShowBorder) - { - Checked = true, CheckType = MenuItemCheckStyle.Checked - }, - _miTabsOnBottom = - new ("_Tabs On Bottom", "", SetTabsOnBottom) - { - Checked = false, CheckType = MenuItemCheckStyle.Checked - }, - _miShowTabViewBorder = - new ( - "_Show TabView Border", - "", - ShowTabViewBorder - ) { Checked = true, CheckType = MenuItemCheckStyle.Checked } - } - ) - ] + BorderStyle = LineStyle.None }; - appWindow.Add (menu); - _tabView = new() + // MenuBar + MenuBar menu = new (); + + _tabView = new () { Title = "_Tab View", X = 0, - Y = 1, + Y = Pos.Bottom (menu), Width = 60, Height = 20, BorderStyle = LineStyle.Single }; - _tabView.AddTab (new() { DisplayText = "Tab_1", View = new Label { Text = "hodor!" } }, false); - _tabView.AddTab (new() { DisplayText = "Tab_2", View = new TextField { Text = "durdur", Width = 10 } }, false); - _tabView.AddTab (new() { DisplayText = "_Interactive Tab", View = GetInteractiveTab () }, false); - _tabView.AddTab (new() { DisplayText = "Big Text", View = GetBigTextFileTab () }, false); + _tabView.AddTab (new () { DisplayText = "Tab_1", View = new Label { Text = "hodor!" } }, false); + _tabView.AddTab (new () { DisplayText = "Tab_2", View = new TextField { Text = "durdur", Width = 10 } }, false); + _tabView.AddTab (new () { DisplayText = "_Interactive Tab", View = GetInteractiveTab () }, false); + _tabView.AddTab (new () { DisplayText = "Big Text", View = GetBigTextFileTab () }, false); _tabView.AddTab ( - new() + new () { DisplayText = "Long name Tab, I mean seriously long. Like you would not believe how long this tab's name is its just too much really woooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooowwww thats long", @@ -100,15 +58,16 @@ public class TabViewExample : Scenario ); _tabView.AddTab ( - new() + new () { - DisplayText = "Les Mise" + '\u0301' + "rables", View = new Label { Text = "This tab name is unicode" } + DisplayText = "Les Mise" + '\u0301' + "rables", + View = new Label { Text = "This tab name is unicode" } }, false ); _tabView.AddTab ( - new() + new () { DisplayText = "Les Mise" + '\u0328' + '\u0301' + "rables", View = new Label @@ -123,19 +82,17 @@ public class TabViewExample : Scenario for (var i = 0; i < 100; i++) { _tabView.AddTab ( - new() { DisplayText = $"Tab{i}", View = new Label { Text = $"Welcome to tab {i}" } }, + new () { DisplayText = $"Tab{i}", View = new Label { Text = $"Welcome to tab {i}" } }, false ); } _tabView.SelectedTab = _tabView.Tabs.First (); - appWindow.Add (_tabView); - - var frameRight = new View + View frameRight = new () { X = Pos.Right (_tabView), - Y = 1, + Y = Pos.Top (_tabView), Width = Dim.Fill (), Height = Dim.Fill (1), Title = "_About", @@ -147,16 +104,15 @@ public class TabViewExample : Scenario frameRight.Add ( new TextView { - Text = "This demos the tabs control\nSwitch between tabs using cursor keys.\nThis TextView has AllowsTab = false, so tab should nav too.", + Text = + "This demos the tabs control\nSwitch between tabs using cursor keys.\nThis TextView has AllowsTab = false, so tab should nav too.", Width = Dim.Fill (), Height = Dim.Fill (), - AllowsTab = false, + AllowsTab = false } ); - appWindow.Add (frameRight); - - var frameBelow = new View + View frameBelow = new () { X = 0, Y = Pos.Bottom (_tabView), @@ -166,7 +122,6 @@ public class TabViewExample : Scenario BorderStyle = LineStyle.Single, TabStop = TabBehavior.TabStop, CanFocus = true - }; frameBelow.Add ( @@ -175,31 +130,112 @@ public class TabViewExample : Scenario Text = "This frame exists to check that you can still tab here\nand that the tab control doesn't overspill it's bounds\nAllowsTab is true.", Width = Dim.Fill (), - Height = Dim.Fill (), + Height = Dim.Fill () } ); - appWindow.Add (frameBelow); + // StatusBar + StatusBar statusBar = new ( + [ + new (Application.QuitKey, "Quit", Quit) + ] + ); - var statusBar = new StatusBar ([new (Application.QuitKey, "Quit", Quit)]); - appWindow.Add (statusBar); + // Setup menu checkboxes + _miShowTopLineCheckBox = new () + { + Title = "_Show Top Line", + CheckedState = CheckState.Checked + }; + _miShowTopLineCheckBox.CheckedStateChanged += (s, e) => ShowTopLine (); + + _miShowBorderCheckBox = new () + { + Title = "_Show Border", + CheckedState = CheckState.Checked + }; + _miShowBorderCheckBox.CheckedStateChanged += (s, e) => ShowBorder (); + + _miTabsOnBottomCheckBox = new () + { + Title = "_Tabs On Bottom" + }; + _miTabsOnBottomCheckBox.CheckedStateChanged += (s, e) => SetTabsOnBottom (); + + _miShowTabViewBorderCheckBox = new () + { + Title = "_Show TabView Border", + CheckedState = CheckState.Checked + }; + _miShowTabViewBorderCheckBox.CheckedStateChanged += (s, e) => ShowTabViewBorder (); + + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem + { + Title = "_Add Blank Tab", + Action = AddBlankTab + }, + new MenuItem + { + Title = "_Clear SelectedTab", + Action = () => + { + if (_tabView is { }) + { + _tabView.SelectedTab = null; + } + } + }, + new MenuItem + { + Title = "_Quit", + Action = Quit + } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "_View", + [ + new MenuItem + { + CommandView = _miShowTopLineCheckBox + }, + new MenuItem + { + CommandView = _miShowBorderCheckBox + }, + new MenuItem + { + CommandView = _miTabsOnBottomCheckBox + }, + new MenuItem + { + CommandView = _miShowTabViewBorderCheckBox + } + ] + ) + ); + + appWindow.Add (menu, _tabView, frameRight, frameBelow, statusBar); - // Run - Start the application. Application.Run (appWindow); - appWindow.Dispose (); - - // Shutdown - Calling Application.Shutdown is required. Application.Shutdown (); } - private void AddBlankTab () { _tabView.AddTab (new (), false); } + private void AddBlankTab () { _tabView?.AddTab (new (), false); } private View GetBigTextFileTab () { - var text = new TextView { Width = Dim.Fill (), Height = Dim.Fill () }; + TextView text = new () { Width = Dim.Fill (), Height = Dim.Fill () }; - var sb = new StringBuilder (); + StringBuilder sb = new (); for (var y = 0; y < 300; y++) { @@ -218,21 +254,22 @@ public class TabViewExample : Scenario private View GetInteractiveTab () { - var interactiveTab = new View + View interactiveTab = new () { - Width = Dim.Fill (), Height = Dim.Fill (), + Width = Dim.Fill (), + Height = Dim.Fill (), CanFocus = true }; - var lblName = new Label { Text = "Name:" }; + Label lblName = new () { Text = "Name:" }; interactiveTab.Add (lblName); - var tbName = new TextField { X = Pos.Right (lblName), Width = 10 }; + TextField tbName = new () { X = Pos.Right (lblName), Width = 10 }; interactiveTab.Add (tbName); - var lblAddr = new Label { Y = 1, Text = "Address:" }; + Label lblAddr = new () { Y = 1, Text = "Address:" }; interactiveTab.Add (lblAddr); - var tbAddr = new TextField { X = Pos.Right (lblAddr), Y = 1, Width = 10 }; + TextField tbAddr = new () { X = Pos.Right (lblAddr), Y = 1, Width = 10 }; interactiveTab.Add (tbAddr); return interactiveTab; @@ -242,35 +279,47 @@ public class TabViewExample : Scenario private void SetTabsOnBottom () { - _miTabsOnBottom.Checked = !_miTabsOnBottom.Checked; + if (_tabView is null || _miTabsOnBottomCheckBox is null) + { + return; + } - _tabView.Style.TabsOnBottom = (bool)_miTabsOnBottom.Checked; + _tabView.Style.TabsOnBottom = _miTabsOnBottomCheckBox.CheckedState == CheckState.Checked; _tabView.ApplyStyleChanges (); } private void ShowBorder () { - _miShowBorder.Checked = !_miShowBorder.Checked; + if (_tabView is null || _miShowBorderCheckBox is null) + { + return; + } - _tabView.Style.ShowBorder = (bool)_miShowBorder.Checked; + _tabView.Style.ShowBorder = _miShowBorderCheckBox.CheckedState == CheckState.Checked; _tabView.ApplyStyleChanges (); } private void ShowTabViewBorder () { - _miShowTabViewBorder.Checked = !_miShowTabViewBorder.Checked; + if (_tabView is null || _miShowTabViewBorderCheckBox is null) + { + return; + } - _tabView.BorderStyle = _miShowTabViewBorder.Checked == true - ? _tabView.BorderStyle = LineStyle.Single + _tabView.BorderStyle = _miShowTabViewBorderCheckBox.CheckedState == CheckState.Checked + ? LineStyle.Single : LineStyle.None; _tabView.ApplyStyleChanges (); } private void ShowTopLine () { - _miShowTopLine.Checked = !_miShowTopLine.Checked; + if (_tabView is null || _miShowTopLineCheckBox is null) + { + return; + } - _tabView.Style.ShowTopLine = (bool)_miShowTopLine.Checked; + _tabView.Style.ShowTopLine = _miShowTopLineCheckBox.CheckedState == CheckState.Checked; _tabView.ApplyStyleChanges (); } } diff --git a/Examples/UICatalog/Scenarios/TableEditor.cs b/Examples/UICatalog/Scenarios/TableEditor.cs index 84d7644b9..4880f4c95 100644 --- a/Examples/UICatalog/Scenarios/TableEditor.cs +++ b/Examples/UICatalog/Scenarios/TableEditor.cs @@ -1,4 +1,4 @@ -#nullable enable +#nullable enable using System.Data; using System.Globalization; using System.Text; @@ -458,22 +458,6 @@ public class TableEditor : Scenario private Scheme? _alternatingScheme; private DataTable? _currentTable; - private MenuItem? _miAlternatingColors; - private MenuItem? _miAlwaysShowHeaders; - private MenuItem? _miAlwaysUseNormalColorForVerticalCellLines; - private MenuItem? _miBottomline; - private MenuItem? _miCellLines; - private MenuItem? _miCheckboxes; - private MenuItem? _miCursor; - private MenuItem? _miExpandLastColumn; - private MenuItem? _miFullRowSelect; - private MenuItem? _miHeaderMidline; - private MenuItem? _miHeaderOverline; - private MenuItem? _miHeaderUnderline; - private MenuItem? _miRadioboxes; - private MenuItem? _miShowHeaders; - private MenuItem? _miShowHorizontalScrollIndicators; - private MenuItem? _miSmoothScrolling; private Scheme? _redScheme; private Scheme? _redSchemeAlt; private TableView? _tableView; @@ -515,243 +499,42 @@ public class TableEditor : Scenario Application.Init (); // Setup - Create a top-level application window and configure it. - Toplevel appWindow = new (); + Runnable appWindow = new (); _tableView = new () { X = 0, Y = 1, Width = Dim.Fill (), Height = Dim.Fill (1) }; - var menu = new MenuBar - { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new ( - "_OpenBigExample", - "", - () => OpenExample (true) - ), - new ( - "_OpenSmallExample", - "", - () => OpenExample (false) - ), - new ( - "OpenCharacter_Map", - "", - () => OpenUnicodeMap () - ), - new ( - "OpenTreeExample", - "", - () => OpenTreeExample () - ), - new ( - "_CloseExample", - "", - () => CloseExample () - ), - new ("_Quit", "", () => Quit ()) - } - ), - new ( - "_View", - new [] - { - _miShowHeaders = - new ( - "_ShowHeaders", - "", - () => ToggleShowHeaders () - ) - { - Checked = _tableView!.Style.ShowHeaders, - CheckType = MenuItemCheckStyle.Checked - }, - _miAlwaysShowHeaders = - new ( - "_AlwaysShowHeaders", - "", - () => ToggleAlwaysShowHeaders () - ) - { - Checked = _tableView!.Style.AlwaysShowHeaders, - CheckType = MenuItemCheckStyle.Checked - }, - _miHeaderOverline = - new ( - "_HeaderOverLine", - "", - () => ToggleOverline () - ) - { - Checked = _tableView!.Style - .ShowHorizontalHeaderOverline, - CheckType = MenuItemCheckStyle.Checked - }, - _miHeaderMidline = new ( - "_HeaderMidLine", - "", - () => ToggleHeaderMidline () - ) - { - Checked = _tableView!.Style - .ShowVerticalHeaderLines, - CheckType = MenuItemCheckStyle.Checked - }, - _miHeaderUnderline = new ( - "_HeaderUnderLine", - "", - () => ToggleUnderline () - ) - { - Checked = _tableView!.Style - .ShowHorizontalHeaderUnderline, - CheckType = MenuItemCheckStyle.Checked - }, - _miBottomline = new ( - "_BottomLine", - "", - () => ToggleBottomline () - ) - { - Checked = _tableView!.Style - .ShowHorizontalBottomline, - CheckType = MenuItemCheckStyle - .Checked - }, - _miShowHorizontalScrollIndicators = - new ( - "_HorizontalScrollIndicators", - "", - () => - ToggleHorizontalScrollIndicators () - ) - { - Checked = _tableView!.Style - .ShowHorizontalScrollIndicators, - CheckType = MenuItemCheckStyle.Checked - }, - _miFullRowSelect = new ( - "_FullRowSelect", - "", - () => ToggleFullRowSelect () - ) - { - Checked = _tableView!.FullRowSelect, - CheckType = MenuItemCheckStyle.Checked - }, - _miCellLines = new ( - "_CellLines", - "", - () => ToggleCellLines () - ) - { - Checked = _tableView!.Style - .ShowVerticalCellLines, - CheckType = MenuItemCheckStyle - .Checked - }, - _miExpandLastColumn = - new ( - "_ExpandLastColumn", - "", - () => ToggleExpandLastColumn () - ) - { - Checked = _tableView!.Style.ExpandLastColumn, - CheckType = MenuItemCheckStyle.Checked - }, - _miAlwaysUseNormalColorForVerticalCellLines = - new ( - "_AlwaysUseNormalColorForVerticalCellLines", - "", - () => - ToggleAlwaysUseNormalColorForVerticalCellLines () - ) - { - Checked = _tableView!.Style - .AlwaysUseNormalColorForVerticalCellLines, - CheckType = MenuItemCheckStyle.Checked - }, - _miSmoothScrolling = - new ( - "_SmoothHorizontalScrolling", - "", - () => ToggleSmoothScrolling () - ) - { - Checked = _tableView!.Style - .SmoothHorizontalScrolling, - CheckType = MenuItemCheckStyle.Checked - }, - new ("_AllLines", "", () => ToggleAllCellLines ()), - new ("_NoLines", "", () => ToggleNoCellLines ()), - _miCheckboxes = new ( - "_Checkboxes", - "", - () => ToggleCheckboxes (false) - ) - { - Checked = false, - CheckType = MenuItemCheckStyle.Checked - }, - _miRadioboxes = new ( - "_Radioboxes", - "", - () => ToggleCheckboxes (true) - ) - { - Checked = false, - CheckType = MenuItemCheckStyle.Checked - }, - _miAlternatingColors = - new ( - "Alternating Colors", - "", - () => ToggleAlternatingColors () - ) { CheckType = MenuItemCheckStyle.Checked }, - _miCursor = - new ( - "Invert Selected Cell First Character", - "", - () => - ToggleInvertSelectedCellFirstCharacter () - ) - { - Checked = _tableView!.Style - .InvertSelectedCellFirstCharacter, - CheckType = MenuItemCheckStyle.Checked - }, - new ( - "_ClearColumnStyles", - "", - () => ClearColumnStyles () - ), - new ("Sho_w All Columns", "", () => ShowAllColumns ()) - } - ), - new ( - "_Column", - new MenuItem [] - { - new ("_Set Max Width", "", SetMaxWidth), - new ("_Set Min Width", "", SetMinWidth), - new ( - "_Set MinAcceptableWidth", - "", - SetMinAcceptableWidth - ), - new ( - "_Set All MinAcceptableWidth=1", - "", - SetMinAcceptableWidthToOne - ) - } - ) - ] - }; + var menu = new MenuBar (); + + // File menu + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem { Title = "_OpenBigExample", Action = () => OpenExample (true) }, + new MenuItem { Title = "_OpenSmallExample", Action = () => OpenExample (false) }, + new MenuItem { Title = "OpenCharacter_Map", Action = OpenUnicodeMap }, + new MenuItem { Title = "OpenTreeExample", Action = OpenTreeExample }, + new MenuItem { Title = "_CloseExample", Action = CloseExample }, + new MenuItem { Title = "_Quit", Action = Quit } + ] + ) + ); + + // View menu - created with helper method due to complexity + menu.Add (CreateViewMenu ()); + + // Column menu + menu.Add ( + new MenuBarItem ( + "_Column", + [ + new MenuItem { Title = "_Set Max Width", Action = SetMaxWidth }, + new MenuItem { Title = "_Set Min Width", Action = SetMinWidth }, + new MenuItem { Title = "_Set MinAcceptableWidth", Action = SetMinAcceptableWidth }, + new MenuItem { Title = "_Set All MinAcceptableWidth=1", Action = SetMinAcceptableWidthToOne } + ] + ) + ); appWindow.Add (menu); @@ -828,28 +611,28 @@ public class TableEditor : Scenario // if user clicks the mouse in TableView _tableView!.MouseClick += (s, e) => - { - if (_currentTable == null) - { - return; - } + { + if (_currentTable == null) + { + return; + } - _tableView!.ScreenToCell (e.Position, out int? clickedCol); + _tableView!.ScreenToCell (e.Position, out int? clickedCol); - if (clickedCol != null) - { - if (e.Flags.HasFlag (MouseFlags.Button1Clicked)) - { - // left click in a header - SortColumn (clickedCol.Value); - } - else if (e.Flags.HasFlag (MouseFlags.Button3Clicked)) - { - // right click in a header - ShowHeaderContextMenu (clickedCol.Value, e); - } - } - }; + if (clickedCol != null) + { + if (e.Flags.HasFlag (MouseFlags.Button1Clicked)) + { + // left click in a header + SortColumn (clickedCol.Value); + } + else if (e.Flags.HasFlag (MouseFlags.Button3Clicked)) + { + // right click in a header + ShowHeaderContextMenu (clickedCol.Value, e); + } + } + }; _tableView!.KeyBindings.ReplaceCommands (Key.Space, Command.Accept); @@ -861,6 +644,261 @@ public class TableEditor : Scenario Application.Shutdown (); } + private MenuBarItem CreateViewMenu () + { + // Store checkbox references for the toggle methods to access + Dictionary checkboxes = new (); + + MenuItem CreateCheckBoxMenuItem (string key, string title, bool initialState, Action onToggle) + { + CheckBox checkBox = new () + { + Title = title, + CheckedState = initialState ? CheckState.Checked : CheckState.UnChecked + }; + + checkBox.CheckedStateChanged += (s, e) => onToggle (checkBox.CheckedState == CheckState.Checked); + + MenuItem item = new () { CommandView = checkBox }; + + item.Accepting += (s, e) => + { + checkBox.AdvanceCheckState (); + e.Handled = true; + }; + + checkboxes [key] = checkBox; + + return item; + } + + return new ( + "_View", + [ + CreateCheckBoxMenuItem ( + "ShowHeaders", + "_ShowHeaders", + _tableView!.Style.ShowHeaders, + state => + { + _tableView!.Style.ShowHeaders = state; + _tableView!.Update (); + } + ), + CreateCheckBoxMenuItem ( + "AlwaysShowHeaders", + "_AlwaysShowHeaders", + _tableView!.Style.AlwaysShowHeaders, + state => + { + _tableView!.Style.AlwaysShowHeaders = state; + _tableView!.Update (); + } + ), + CreateCheckBoxMenuItem ( + "HeaderOverline", + "_HeaderOverLine", + _tableView!.Style.ShowHorizontalHeaderOverline, + state => + { + _tableView!.Style.ShowHorizontalHeaderOverline = state; + _tableView!.Update (); + } + ), + CreateCheckBoxMenuItem ( + "HeaderMidline", + "_HeaderMidLine", + _tableView!.Style.ShowVerticalHeaderLines, + state => + { + _tableView!.Style.ShowVerticalHeaderLines = state; + _tableView!.Update (); + } + ), + CreateCheckBoxMenuItem ( + "HeaderUnderline", + "_HeaderUnderLine", + _tableView!.Style.ShowHorizontalHeaderUnderline, + state => + { + _tableView!.Style.ShowHorizontalHeaderUnderline = state; + _tableView!.Update (); + } + ), + CreateCheckBoxMenuItem ( + "Bottomline", + "_BottomLine", + _tableView!.Style.ShowHorizontalBottomline, + state => + { + _tableView!.Style.ShowHorizontalBottomline = state; + _tableView!.Update (); + } + ), + CreateCheckBoxMenuItem ( + "HorizontalScrollIndicators", + "_HorizontalScrollIndicators", + _tableView!.Style.ShowHorizontalScrollIndicators, + state => + { + _tableView!.Style.ShowHorizontalScrollIndicators = state; + _tableView!.Update (); + } + ), + CreateCheckBoxMenuItem ( + "FullRowSelect", + "_FullRowSelect", + _tableView!.FullRowSelect, + state => + { + _tableView!.FullRowSelect = state; + _tableView!.Update (); + } + ), + CreateCheckBoxMenuItem ( + "CellLines", + "_CellLines", + _tableView!.Style.ShowVerticalCellLines, + state => + { + _tableView!.Style.ShowVerticalCellLines = state; + _tableView!.Update (); + } + ), + CreateCheckBoxMenuItem ( + "ExpandLastColumn", + "_ExpandLastColumn", + _tableView!.Style.ExpandLastColumn, + state => + { + _tableView!.Style.ExpandLastColumn = state; + _tableView!.Update (); + } + ), + CreateCheckBoxMenuItem ( + "AlwaysUseNormalColorForVerticalCellLines", + "_AlwaysUseNormalColorForVerticalCellLines", + _tableView!.Style.AlwaysUseNormalColorForVerticalCellLines, + state => + { + _tableView!.Style.AlwaysUseNormalColorForVerticalCellLines = state; + _tableView!.Update (); + } + ), + CreateCheckBoxMenuItem ( + "SmoothScrolling", + "_SmoothHorizontalScrolling", + _tableView!.Style.SmoothHorizontalScrolling, + state => + { + _tableView!.Style.SmoothHorizontalScrolling = state; + _tableView!.Update (); + } + ), + new MenuItem + { + Title = "_AllLines", + Action = () => + { + _tableView!.Style.ShowHorizontalHeaderOverline = true; + _tableView!.Style.ShowVerticalHeaderLines = true; + _tableView!.Style.ShowHorizontalHeaderUnderline = true; + _tableView!.Style.ShowVerticalCellLines = true; + + checkboxes ["HeaderOverline"].CheckedState = CheckState.Checked; + checkboxes ["HeaderMidline"].CheckedState = CheckState.Checked; + checkboxes ["HeaderUnderline"].CheckedState = CheckState.Checked; + checkboxes ["CellLines"].CheckedState = CheckState.Checked; + + _tableView!.Update (); + } + }, + new MenuItem + { + Title = "_NoLines", + Action = () => + { + _tableView!.Style.ShowHorizontalHeaderOverline = false; + _tableView!.Style.ShowVerticalHeaderLines = false; + _tableView!.Style.ShowHorizontalHeaderUnderline = false; + _tableView!.Style.ShowVerticalCellLines = false; + + checkboxes ["HeaderOverline"].CheckedState = CheckState.UnChecked; + checkboxes ["HeaderMidline"].CheckedState = CheckState.UnChecked; + checkboxes ["HeaderUnderline"].CheckedState = CheckState.UnChecked; + checkboxes ["CellLines"].CheckedState = CheckState.UnChecked; + + _tableView!.Update (); + } + }, + CreateCheckBoxMenuItem ( + "Checkboxes", + "_Checkboxes", + false, + state => + { + if (state) + { + ToggleCheckboxes (false); + checkboxes ["Radioboxes"].CheckedState = CheckState.UnChecked; + } + else if (HasCheckboxes ()) + { + ToggleCheckboxes (false); + } + } + ), + CreateCheckBoxMenuItem ( + "Radioboxes", + "_Radioboxes", + false, + state => + { + if (state) + { + ToggleCheckboxes (true); + checkboxes ["Checkboxes"].CheckedState = CheckState.UnChecked; + } + else if (HasCheckboxes ()) + { + ToggleCheckboxes (true); + } + } + ), + CreateCheckBoxMenuItem ( + "AlternatingColors", + "Alternating Colors", + false, + state => + { + if (state) + { + _tableView!.Style.RowColorGetter = a => { return a.RowIndex % 2 == 0 ? _alternatingScheme : null; }; + } + else + { + _tableView!.Style.RowColorGetter = null; + } + + _tableView!.SetNeedsDraw (); + } + ), + CreateCheckBoxMenuItem ( + "Cursor", + "Invert Selected Cell First Character", + _tableView!.Style.InvertSelectedCellFirstCharacter, + state => + { + _tableView!.Style.InvertSelectedCellFirstCharacter = state; + _tableView!.SetNeedsDraw (); + } + ), + new MenuItem { Title = "_ClearColumnStyles", Action = ClearColumnStyles }, + new MenuItem { Title = "Sho_w All Columns", Action = ShowAllColumns } + ] + ); + } + protected override void Dispose (bool disposing) { base.Dispose (disposing); @@ -988,7 +1026,7 @@ public class TableEditor : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery (60, 20, "Failed to set text", ex.Message, "Ok"); + MessageBox.ErrorQuery ((sender as View)?.App, 60, 20, "Failed to set text", ex.Message, "Ok"); } _tableView!.Update (); @@ -1078,7 +1116,7 @@ public class TableEditor : Scenario } private string GetUnicodeCategory (uint u) { return _ranges!.FirstOrDefault (r => u >= r.Start && u <= r.End)?.Category ?? "Unknown"; } - private bool HasCheckboxes () { return _tableView!.Table is CheckBoxTableSourceWrapperBase; } + private bool HasCheckboxes () => _tableView!.Table is CheckBoxTableSourceWrapperBase; private void HideColumn (int clickedCol) { @@ -1127,7 +1165,7 @@ public class TableEditor : Scenario } catch (Exception e) { - MessageBox.ErrorQuery ("Could not find local drives", e.Message, "Ok"); + MessageBox.ErrorQuery (_tableView?.App, "Could not find local drives", e.Message, "Ok"); } _tableView!.Table = source; @@ -1161,10 +1199,10 @@ public class TableEditor : Scenario ok.Accepting += (s, e) => { accepted = true; - Application.RequestStop (); + (s as View)?.App?.RequestStop (); }; var cancel = new Button { Text = "Cancel" }; - cancel.Accepting += (s, e) => { Application.RequestStop (); }; + cancel.Accepting += (s, e) => { (s as View)?.App?.RequestStop (); }; var d = new Dialog { @@ -1180,7 +1218,7 @@ public class TableEditor : Scenario d.Add (lbl, tf); tf.SetFocus (); - Application.Run (d); + _tableView.App?.Run (d); d.Dispose (); if (accepted) @@ -1191,7 +1229,7 @@ public class TableEditor : Scenario } catch (Exception ex) { - MessageBox.ErrorQuery (60, 20, "Failed to set", ex.Message, "Ok"); + MessageBox.ErrorQuery (_tableView.App, 60, 20, "Failed to set", ex.Message, "Ok"); } _tableView!.Update (); @@ -1236,7 +1274,6 @@ public class TableEditor : Scenario // color 0 and negative values red d <= 0.0000001 ? a.RowIndex % 2 == 0 - && _miAlternatingColors!.Checked == true ? _redSchemeAlt : _redScheme : @@ -1363,7 +1400,7 @@ public class TableEditor : Scenario // Registering with the PopoverManager will ensure that the context menu is closed when the view is no longer focused // and the context menu is disposed when it is closed. - Application.Popover?.Register (contextMenu); + e.View?.App!.Popover?.Register (contextMenu); contextMenu?.MakeVisible (new (e.ScreenPosition.X + 1, e.ScreenPosition.Y + 1)); } @@ -1414,7 +1451,7 @@ public class TableEditor : Scenario _tableView!.Update (); } - private string StripArrows (string columnName) { return columnName.Replace ($"{Glyphs.DownArrow}", "").Replace ($"{Glyphs.UpArrow}", ""); } + private string StripArrows (string columnName) => columnName.Replace ($"{Glyphs.DownArrow}", "").Replace ($"{Glyphs.UpArrow}", ""); private void TableViewKeyPress (object? sender, Key e) { @@ -1429,9 +1466,9 @@ public class TableEditor : Scenario { // Delete button deletes all rows when in full row mode foreach (int toRemove in _tableView!.GetAllSelectedCells () - .Select (p => p.Y) - .Distinct () - .OrderByDescending (i => i)) + .Select (p => p.Y) + .Distinct () + .OrderByDescending (i => i)) { _currentTable.Rows.RemoveAt (toRemove); } @@ -1450,70 +1487,6 @@ public class TableEditor : Scenario } } - private void ToggleAllCellLines () - { - _tableView!.Style.ShowHorizontalHeaderOverline = true; - _tableView!.Style.ShowVerticalHeaderLines = true; - _tableView!.Style.ShowHorizontalHeaderUnderline = true; - _tableView!.Style.ShowVerticalCellLines = true; - - _miHeaderOverline!.Checked = true; - _miHeaderMidline!.Checked = true; - _miHeaderUnderline!.Checked = true; - _miCellLines!.Checked = true; - - _tableView!.Update (); - } - - private void ToggleAlternatingColors () - { - //toggle menu item - _miAlternatingColors!.Checked = !_miAlternatingColors.Checked; - - if (_miAlternatingColors.Checked == true) - { - _tableView!.Style.RowColorGetter = a => { return a.RowIndex % 2 == 0 ? _alternatingScheme : null; }; - } - else - { - _tableView!.Style.RowColorGetter = null; - } - - _tableView!.SetNeedsDraw (); - } - - private void ToggleAlwaysShowHeaders () - { - _miAlwaysShowHeaders!.Checked = !_miAlwaysShowHeaders.Checked; - _tableView!.Style.AlwaysShowHeaders = (bool)_miAlwaysShowHeaders.Checked!; - _tableView!.Update (); - } - - private void ToggleAlwaysUseNormalColorForVerticalCellLines () - { - _miAlwaysUseNormalColorForVerticalCellLines!.Checked = - !_miAlwaysUseNormalColorForVerticalCellLines.Checked; - - _tableView!.Style.AlwaysUseNormalColorForVerticalCellLines = - (bool)_miAlwaysUseNormalColorForVerticalCellLines.Checked!; - - _tableView!.Update (); - } - - private void ToggleBottomline () - { - _miBottomline!.Checked = !_miBottomline.Checked; - _tableView!.Style.ShowHorizontalBottomline = (bool)_miBottomline.Checked!; - _tableView!.Update (); - } - - private void ToggleCellLines () - { - _miCellLines!.Checked = !_miCellLines.Checked; - _tableView!.Style.ShowVerticalCellLines = (bool)_miCellLines.Checked!; - _tableView!.Update (); - } - private void ToggleCheckboxes (bool radio) { if (_tableView!.Table is CheckBoxTableSourceWrapperBase wrapper) @@ -1521,9 +1494,6 @@ public class TableEditor : Scenario // unwrap it to remove check boxes _tableView!.Table = wrapper.Wrapping; - _miCheckboxes!.Checked = false; - _miRadioboxes!.Checked = false; - // if toggling off checkboxes/radio if (wrapper.UseRadioButtons == radio) { @@ -1550,98 +1520,6 @@ public class TableEditor : Scenario } _tableView!.Table = source; - - if (radio) - { - _miRadioboxes!.Checked = true; - _miCheckboxes!.Checked = false; - } - else - { - _miRadioboxes!.Checked = false; - _miCheckboxes!.Checked = true; - } - } - - private void ToggleExpandLastColumn () - { - _miExpandLastColumn!.Checked = !_miExpandLastColumn.Checked; - _tableView!.Style.ExpandLastColumn = (bool)_miExpandLastColumn.Checked!; - - _tableView!.Update (); - } - - private void ToggleFullRowSelect () - { - _miFullRowSelect!.Checked = !_miFullRowSelect.Checked; - _tableView!.FullRowSelect = (bool)_miFullRowSelect.Checked!; - _tableView!.Update (); - } - - private void ToggleHeaderMidline () - { - _miHeaderMidline!.Checked = !_miHeaderMidline.Checked; - _tableView!.Style.ShowVerticalHeaderLines = (bool)_miHeaderMidline.Checked!; - _tableView!.Update (); - } - - private void ToggleHorizontalScrollIndicators () - { - _miShowHorizontalScrollIndicators!.Checked = !_miShowHorizontalScrollIndicators.Checked; - _tableView!.Style.ShowHorizontalScrollIndicators = (bool)_miShowHorizontalScrollIndicators.Checked!; - _tableView!.Update (); - } - - private void ToggleInvertSelectedCellFirstCharacter () - { - //toggle menu item - _miCursor!.Checked = !_miCursor.Checked; - _tableView!.Style.InvertSelectedCellFirstCharacter = (bool)_miCursor.Checked!; - _tableView!.SetNeedsDraw (); - } - - private void ToggleNoCellLines () - { - _tableView!.Style.ShowHorizontalHeaderOverline = false; - _tableView!.Style.ShowVerticalHeaderLines = false; - _tableView!.Style.ShowHorizontalHeaderUnderline = false; - _tableView!.Style.ShowVerticalCellLines = false; - - _miHeaderOverline!.Checked = false; - _miHeaderMidline!.Checked = false; - _miHeaderUnderline!.Checked = false; - _miCellLines!.Checked = false; - - _tableView!.Update (); - } - - private void ToggleOverline () - { - _miHeaderOverline!.Checked = !_miHeaderOverline.Checked; - _tableView!.Style.ShowHorizontalHeaderOverline = (bool)_miHeaderOverline.Checked!; - _tableView!.Update (); - } - - private void ToggleShowHeaders () - { - _miShowHeaders!.Checked = !_miShowHeaders.Checked; - _tableView!.Style.ShowHeaders = (bool)_miShowHeaders.Checked!; - _tableView!.Update (); - } - - private void ToggleSmoothScrolling () - { - _miSmoothScrolling!.Checked = !_miSmoothScrolling.Checked; - _tableView!.Style.SmoothHorizontalScrolling = (bool)_miSmoothScrolling.Checked!; - - _tableView!.Update (); - } - - private void ToggleUnderline () - { - _miHeaderUnderline!.Checked = !_miHeaderUnderline.Checked; - _tableView!.Style.ShowHorizontalHeaderUnderline = (bool)_miHeaderUnderline.Checked!; - _tableView!.Update (); } private int ToTableCol (int col) @@ -1654,13 +1532,11 @@ public class TableEditor : Scenario return col; } - private string TrimArrows (string columnName) - { - return columnName.TrimEnd ( - (char)Glyphs.UpArrow.Value, - (char)Glyphs.DownArrow.Value - ); - } + private string TrimArrows (string columnName) => + columnName.TrimEnd ( + (char)Glyphs.UpArrow.Value, + (char)Glyphs.DownArrow.Value + ); public class UnicodeRange (uint start, uint end, string category) { diff --git a/Examples/UICatalog/Scenarios/TextEffectsScenario.cs b/Examples/UICatalog/Scenarios/TextEffectsScenario.cs index 15e9db4c6..ba25683e5 100644 --- a/Examples/UICatalog/Scenarios/TextEffectsScenario.cs +++ b/Examples/UICatalog/Scenarios/TextEffectsScenario.cs @@ -23,14 +23,11 @@ public class TextEffectsScenario : Scenario Title = "Text Effects Scenario" }; - w.Loaded += (s, e) => { SetupGradientLineCanvas (w, w.Frame.Size); }; + w.IsModalChanged += (s, e) => { SetupGradientLineCanvas (w, w.Frame.Size); }; - w.SizeChanging += (s, e) => + w.ViewportChanged += (s, e) => { - if (e.Size.HasValue) - { - SetupGradientLineCanvas (w, e.Size.Value); - } + SetupGradientLineCanvas (w, e.NewViewport.Size); }; w.SetScheme (new () diff --git a/Examples/UICatalog/Scenarios/TextFormatterDemo.cs b/Examples/UICatalog/Scenarios/TextFormatterDemo.cs index 08319eefb..885191c88 100644 --- a/Examples/UICatalog/Scenarios/TextFormatterDemo.cs +++ b/Examples/UICatalog/Scenarios/TextFormatterDemo.cs @@ -30,7 +30,7 @@ public class TextFormatterDemo : Scenario var blockText = new Label { - SchemeName = "TopLevel", + SchemeName = "Runnable", X = 0, Y = 0, diff --git a/Examples/UICatalog/Scenarios/TextStyles.cs b/Examples/UICatalog/Scenarios/TextStyles.cs index 92c9c723b..191e5c2bf 100644 --- a/Examples/UICatalog/Scenarios/TextStyles.cs +++ b/Examples/UICatalog/Scenarios/TextStyles.cs @@ -5,7 +5,7 @@ namespace UICatalog.Scenarios; [ScenarioMetadata ("Text Styles", "Shows Attribute.TextStyles including bold, italic, etc...")] [ScenarioCategory ("Text and Formatting")] [ScenarioCategory ("Colors")] -public sealed class TestStyles : Scenario +public sealed class TextStyles : Scenario { private CheckBox? _drawDirectly; diff --git a/Examples/UICatalog/Scenarios/TextViewAutocompletePopup.cs b/Examples/UICatalog/Scenarios/TextViewAutocompletePopup.cs index 934cc60f6..a48c9d683 100644 --- a/Examples/UICatalog/Scenarios/TextViewAutocompletePopup.cs +++ b/Examples/UICatalog/Scenarios/TextViewAutocompletePopup.cs @@ -1,4 +1,5 @@ -using System.Linq; +#nullable enable + using System.Text.RegularExpressions; namespace UICatalog.Scenarios; @@ -10,77 +11,63 @@ namespace UICatalog.Scenarios; public class TextViewAutocompletePopup : Scenario { private int _height = 10; - private MenuItem _miMultiline; - private MenuItem _miWrap; - private Shortcut _siMultiline; - private Shortcut _siWrap; - private TextView _textViewBottomLeft; - private TextView _textViewBottomRight; - private TextView _textViewCentered; - private TextView _textViewTopLeft; - private TextView _textViewTopRight; + private CheckBox? _miMultilineCheckBox; + private CheckBox? _miWrapCheckBox; + private Shortcut? _siMultiline; + private Shortcut? _siWrap; + private TextView? _textViewBottomLeft; + private TextView? _textViewBottomRight; + private TextView? _textViewCentered; + private TextView? _textViewTopLeft; + private TextView? _textViewTopRight; public override void Main () { - // Init Application.Init (); - // Setup - Create a top-level application window and configure it. - Toplevel appWindow = new (); + Window appWindow = new () + { + BorderStyle = LineStyle.None + }; var width = 20; var text = " jamp jemp jimp jomp jump"; - var menu = new MenuBar - { - Menus = - [ - new ( - "_File", - new [] - { - _miMultiline = - new ( - "_Multiline", - "", - () => Multiline () - ) { CheckType = MenuItemCheckStyle.Checked }, - _miWrap = new ( - "_Word Wrap", - "", - () => WordWrap () - ) { CheckType = MenuItemCheckStyle.Checked }, - new ("_Quit", "", () => Quit ()) - } - ) - ] - }; - appWindow.Add (menu); + // MenuBar + MenuBar menu = new (); - _textViewTopLeft = new() + _textViewTopLeft = new () { - Y = 1, - Width = width, Height = _height, Text = text + Y = Pos.Bottom (menu), + Width = width, + Height = _height, + Text = text }; _textViewTopLeft.DrawingContent += TextViewTopLeft_DrawContent; appWindow.Add (_textViewTopLeft); - _textViewTopRight = new() + _textViewTopRight = new () { - X = Pos.AnchorEnd (width), Y = 1, - Width = width, Height = _height, Text = text + X = Pos.AnchorEnd (width), + Y = Pos.Bottom (menu), + Width = width, + Height = _height, + Text = text }; _textViewTopRight.DrawingContent += TextViewTopRight_DrawContent; appWindow.Add (_textViewTopRight); - _textViewBottomLeft = new() + _textViewBottomLeft = new () { - Y = Pos.AnchorEnd (_height), Width = width, Height = _height, Text = text + Y = Pos.AnchorEnd (_height), + Width = width, + Height = _height, + Text = text }; _textViewBottomLeft.DrawingContent += TextViewBottomLeft_DrawContent; appWindow.Add (_textViewBottomLeft); - _textViewBottomRight = new() + _textViewBottomRight = new () { X = Pos.AnchorEnd (width), Y = Pos.AnchorEnd (_height), @@ -91,7 +78,7 @@ public class TextViewAutocompletePopup : Scenario _textViewBottomRight.DrawingContent += TextViewBottomRight_DrawContent; appWindow.Add (_textViewBottomRight); - _textViewCentered = new() + _textViewCentered = new () { X = Pos.Center (), Y = Pos.Center (), @@ -102,73 +89,170 @@ public class TextViewAutocompletePopup : Scenario _textViewCentered.DrawingContent += TextViewCentered_DrawContent; appWindow.Add (_textViewCentered); - _miMultiline.Checked = _textViewTopLeft.Multiline; - _miWrap.Checked = _textViewTopLeft.WordWrap; + // Setup menu checkboxes + _miMultilineCheckBox = new () + { + Title = "_Multiline", + CheckedState = _textViewTopLeft.Multiline ? CheckState.Checked : CheckState.UnChecked + }; + _miMultilineCheckBox.CheckedStateChanged += (s, e) => Multiline (); - var statusBar = new StatusBar ( - new [] + _miWrapCheckBox = new () + { + Title = "_Word Wrap", + CheckedState = _textViewTopLeft.WordWrap ? CheckState.Checked : CheckState.UnChecked + }; + _miWrapCheckBox.CheckedStateChanged += (s, e) => WordWrap (); + + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem { - new ( - Application.QuitKey, - "Quit", - () => Quit () - ), - _siMultiline = new (Key.Empty, "", null), - _siWrap = new (Key.Empty, "", null) + CommandView = _miMultilineCheckBox + }, + new MenuItem + { + CommandView = _miWrapCheckBox + }, + new MenuItem + { + Title = "_Quit", + Action = Quit } - ); - appWindow.Add (statusBar); + ] + ) + ); + + // StatusBar + _siMultiline = new (Key.Empty, "", null); + _siWrap = new (Key.Empty, "", null); + + StatusBar statusBar = new ( + [ + new ( + Application.QuitKey, + "Quit", + () => Quit () + ), + _siMultiline, + _siWrap + ] + ); + + appWindow.Add (menu, statusBar); appWindow.SubViewLayout += Win_LayoutStarted; - // Run - Start the application. Application.Run (appWindow); - appWindow.Dispose (); - - // Shutdown - Calling Application.Shutdown is required. Application.Shutdown (); } private void Multiline () { - _miMultiline.Checked = !_miMultiline.Checked; + if (_miMultilineCheckBox is null + || _textViewTopLeft is null + || _textViewTopRight is null + || _textViewBottomLeft is null + || _textViewBottomRight is null + || _textViewCentered is null) + { + return; + } + SetMultilineStatusText (); - _textViewTopLeft.Multiline = (bool)_miMultiline.Checked; - _textViewTopRight.Multiline = (bool)_miMultiline.Checked; - _textViewBottomLeft.Multiline = (bool)_miMultiline.Checked; - _textViewBottomRight.Multiline = (bool)_miMultiline.Checked; - _textViewCentered.Multiline = (bool)_miMultiline.Checked; + _textViewTopLeft.Multiline = _miMultilineCheckBox.CheckedState == CheckState.Checked; + _textViewTopRight.Multiline = _miMultilineCheckBox.CheckedState == CheckState.Checked; + _textViewBottomLeft.Multiline = _miMultilineCheckBox.CheckedState == CheckState.Checked; + _textViewBottomRight.Multiline = _miMultilineCheckBox.CheckedState == CheckState.Checked; + _textViewCentered.Multiline = _miMultilineCheckBox.CheckedState == CheckState.Checked; } private void Quit () { Application.RequestStop (); } private void SetAllSuggestions (TextView view) { - ((SingleWordSuggestionGenerator)view.Autocomplete.SuggestionGenerator).AllSuggestions = Regex - .Matches (view.Text, "\\w+") - .Select (s => s.Value) - .Distinct () - .ToList (); + if (view.Autocomplete.SuggestionGenerator is SingleWordSuggestionGenerator generator) + { + generator.AllSuggestions = Regex + .Matches (view.Text, "\\w+") + .Select (s => s.Value) + .Distinct () + .ToList (); + } } - private void SetMultilineStatusText () { _siMultiline.Title = $"Multiline: {_miMultiline.Checked}"; } - - private void SetWrapStatusText () { _siWrap.Title = $"WordWrap: {_miWrap.Checked}"; } - private void TextViewBottomLeft_DrawContent (object sender, DrawEventArgs e) { SetAllSuggestions (_textViewBottomLeft); } - private void TextViewBottomRight_DrawContent (object sender, DrawEventArgs e) { SetAllSuggestions (_textViewBottomRight); } - private void TextViewCentered_DrawContent (object sender, DrawEventArgs e) { SetAllSuggestions (_textViewCentered); } - private void TextViewTopLeft_DrawContent (object sender, DrawEventArgs e) { SetAllSuggestions (_textViewTopLeft); } - private void TextViewTopRight_DrawContent (object sender, DrawEventArgs e) { SetAllSuggestions (_textViewTopRight); } - - private void Win_LayoutStarted (object sender, LayoutEventArgs obj) + private void SetMultilineStatusText () { - _miMultiline.Checked = _textViewTopLeft.Multiline; - _miWrap.Checked = _textViewTopLeft.WordWrap; + if (_siMultiline is { } && _miMultilineCheckBox is { }) + { + _siMultiline.Title = $"Multiline: {_miMultilineCheckBox.CheckedState == CheckState.Checked}"; + } + } + + private void SetWrapStatusText () + { + if (_siWrap is { } && _miWrapCheckBox is { }) + { + _siWrap.Title = $"WordWrap: {_miWrapCheckBox.CheckedState == CheckState.Checked}"; + } + } + + private void TextViewBottomLeft_DrawContent (object? sender, DrawEventArgs e) + { + if (_textViewBottomLeft is { }) + { + SetAllSuggestions (_textViewBottomLeft); + } + } + + private void TextViewBottomRight_DrawContent (object? sender, DrawEventArgs e) + { + if (_textViewBottomRight is { }) + { + SetAllSuggestions (_textViewBottomRight); + } + } + + private void TextViewCentered_DrawContent (object? sender, DrawEventArgs e) + { + if (_textViewCentered is { }) + { + SetAllSuggestions (_textViewCentered); + } + } + + private void TextViewTopLeft_DrawContent (object? sender, DrawEventArgs e) + { + if (_textViewTopLeft is { }) + { + SetAllSuggestions (_textViewTopLeft); + } + } + + private void TextViewTopRight_DrawContent (object? sender, DrawEventArgs e) + { + if (_textViewTopRight is { }) + { + SetAllSuggestions (_textViewTopRight); + } + } + + private void Win_LayoutStarted (object? sender, LayoutEventArgs obj) + { + if (_textViewTopLeft is null || _miMultilineCheckBox is null || _miWrapCheckBox is null || _textViewBottomLeft is null || _textViewBottomRight is null) + { + return; + } + + _miMultilineCheckBox.CheckedState = _textViewTopLeft.Multiline ? CheckState.Checked : CheckState.UnChecked; + _miWrapCheckBox.CheckedState = _textViewTopLeft.WordWrap ? CheckState.Checked : CheckState.UnChecked; SetMultilineStatusText (); SetWrapStatusText (); - if (_miMultiline.Checked == true) + if (_miMultilineCheckBox.CheckedState == CheckState.Checked) { _height = 10; } @@ -182,13 +266,22 @@ public class TextViewAutocompletePopup : Scenario private void WordWrap () { - _miWrap.Checked = !_miWrap.Checked; - _textViewTopLeft.WordWrap = (bool)_miWrap.Checked; - _textViewTopRight.WordWrap = (bool)_miWrap.Checked; - _textViewBottomLeft.WordWrap = (bool)_miWrap.Checked; - _textViewBottomRight.WordWrap = (bool)_miWrap.Checked; - _textViewCentered.WordWrap = (bool)_miWrap.Checked; - _miWrap.Checked = _textViewTopLeft.WordWrap; + if (_miWrapCheckBox is null + || _textViewTopLeft is null + || _textViewTopRight is null + || _textViewBottomLeft is null + || _textViewBottomRight is null + || _textViewCentered is null) + { + return; + } + + _textViewTopLeft.WordWrap = _miWrapCheckBox.CheckedState == CheckState.Checked; + _textViewTopRight.WordWrap = _miWrapCheckBox.CheckedState == CheckState.Checked; + _textViewBottomLeft.WordWrap = _miWrapCheckBox.CheckedState == CheckState.Checked; + _textViewBottomRight.WordWrap = _miWrapCheckBox.CheckedState == CheckState.Checked; + _textViewCentered.WordWrap = _miWrapCheckBox.CheckedState == CheckState.Checked; + _miWrapCheckBox.CheckedState = _textViewTopLeft.WordWrap ? CheckState.Checked : CheckState.UnChecked; SetWrapStatusText (); } } diff --git a/Examples/UICatalog/Scenarios/Themes.cs b/Examples/UICatalog/Scenarios/Themes.cs index 6e4d676ea..31a30933c 100644 --- a/Examples/UICatalog/Scenarios/Themes.cs +++ b/Examples/UICatalog/Scenarios/Themes.cs @@ -129,7 +129,7 @@ public sealed class Themes : Scenario { if (_view is { }) { - Application.Top!.SchemeName = args.NewValue; + Application.TopRunnableView!.SchemeName = args.NewValue; if (_view.HasScheme) { @@ -160,11 +160,11 @@ public sealed class Themes : Scenario TabStop = TabBehavior.TabStop }; - allViewsView.FocusedChanged += (s, args) => + allViewsView.FocusedChanged += (s, a) => { allViewsView.Title = - $"All Views - Focused: {args.NewFocused.Title}"; - viewPropertiesEditor.ViewToEdit = args.NewFocused.SubViews.ElementAt(0); + $"All Views - Focused: {a.NewFocused?.Title}"; + viewPropertiesEditor.ViewToEdit = a.NewFocused?.SubViews.ElementAt(0); }; appWindow.Add (allViewsView); diff --git a/Examples/UICatalog/Scenarios/Threading.cs b/Examples/UICatalog/Scenarios/Threading.cs index dc97292b2..92ecf608c 100644 --- a/Examples/UICatalog/Scenarios/Threading.cs +++ b/Examples/UICatalog/Scenarios/Threading.cs @@ -75,7 +75,7 @@ public class Threading : Scenario Y = Pos.Y (_btnActionCancel) + 6, Width = 10, Height = 10, - SchemeName = "TopLevel" + SchemeName = "Runnable" }; win.Add (new Label { X = Pos.Right (_itemsList) + 10, Y = Pos.Y (_btnActionCancel) + 4, Text = "Task Logs:" }); @@ -86,7 +86,7 @@ public class Threading : Scenario Y = Pos.Y (_itemsList), Width = 50, Height = Dim.Fill (), - SchemeName = "TopLevel", + SchemeName = "Runnable", Source = new ListWrapper (_log) }; @@ -162,10 +162,10 @@ public class Threading : Scenario void Win_Loaded (object sender, EventArgs args) { _btnActionCancel.SetFocus (); - win.Loaded -= Win_Loaded; + win.IsModalChanged -= Win_Loaded; } - win.Loaded += Win_Loaded; + win.IsModalChanged += Win_Loaded; Application.Run (win); win.Dispose (); diff --git a/Examples/UICatalog/Scenarios/Transparent.cs b/Examples/UICatalog/Scenarios/Transparent.cs index 1b6f08df8..801372d2c 100644 --- a/Examples/UICatalog/Scenarios/Transparent.cs +++ b/Examples/UICatalog/Scenarios/Transparent.cs @@ -46,7 +46,7 @@ public sealed class Transparent : Scenario }; appButton.Accepting += (sender, args) => { - MessageBox.Query ("AppButton", "Transparency is cool!", "_Ok"); + MessageBox.Query ((sender as View)?.App, "AppButton", "Transparency is cool!", "_Ok"); args.Handled = true; }; appWindow.Add (appButton); @@ -106,7 +106,7 @@ public sealed class Transparent : Scenario }; button.Accepting += (sender, args) => { - MessageBox.Query ("Clicked!", "Button in Transparent View", "_Ok"); + MessageBox.Query (App, "Clicked!", "Button in Transparent View", "_Ok"); args.Handled = true; }; //button.Visible = false; diff --git a/Examples/UICatalog/Scenarios/TreeUseCases.cs b/Examples/UICatalog/Scenarios/TreeUseCases.cs index 4603b9e54..133288c81 100644 --- a/Examples/UICatalog/Scenarios/TreeUseCases.cs +++ b/Examples/UICatalog/Scenarios/TreeUseCases.cs @@ -1,3 +1,5 @@ +#nullable enable + using System.Collections.Generic; using System.Linq; @@ -8,76 +10,96 @@ namespace UICatalog.Scenarios; [ScenarioCategory ("TreeView")] public class TreeUseCases : Scenario { - private View _currentTree; + private View? _currentTree; public override void Main () { - // Init Application.Init (); - // Setup - Create a top-level application window and configure it. - Toplevel appWindow = new (); + Window appWindow = new (); - var menu = new MenuBar - { - Menus = + // MenuBar + MenuBar menu = new (); + + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem + { + Title = "_Quit", + Action = Quit + } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "_Scenarios", + [ + new MenuItem + { + Title = "_Simple Nodes", + Action = LoadSimpleNodes + }, + new MenuItem + { + Title = "_Rooms", + Action = LoadRooms + }, + new MenuItem + { + Title = "_Armies With Builder", + Action = () => LoadArmies (false) + }, + new MenuItem + { + Title = "_Armies With Delegate", + Action = () => LoadArmies (true) + } + ] + ) + ); + + // StatusBar + StatusBar statusBar = new ( [ - new MenuBarItem ("_File", new MenuItem [] { new ("_Quit", "", () => Quit ()) }), - new MenuBarItem ( - "_Scenarios", - new MenuItem [] - { - new ( - "_Simple Nodes", - "", - () => LoadSimpleNodes () - ), - new ("_Rooms", "", () => LoadRooms ()), - new ( - "_Armies With Builder", - "", - () => LoadArmies (false) - ), - new ( - "_Armies With Delegate", - "", - () => LoadArmies (true) - ) - } - ) + new (Application.QuitKey, "Quit", Quit) ] + ); + + appWindow.Add (menu, statusBar); + + appWindow.IsModalChanged += (sender, args) => + { + if (args.Value) + { + // Start with the most basic use case + LoadSimpleNodes (); + } }; - appWindow.Add (menu); - - var statusBar = new StatusBar ([new (Application.QuitKey, "Quit", Quit)]); - - appWindow.Add (statusBar); - - appWindow.Ready += (sender, args) => - // Start with the most basic use case - LoadSimpleNodes (); - - // Run - Start the application. Application.Run (appWindow); appWindow.Dispose (); - - // Shutdown - Calling Application.Shutdown is required. Application.Shutdown (); - } private void LoadArmies (bool useDelegate) { - var army1 = new Army + Army army1 = new () { Designation = "3rd Infantry", - Units = new List { new () { Name = "Orc" }, new () { Name = "Troll" }, new () { Name = "Goblin" } } + Units = [new () { Name = "Orc" }, new () { Name = "Troll" }, new () { Name = "Goblin" }] }; - if (_currentTree != null) + if (_currentTree is { }) { - Application.Top.Remove (_currentTree); + if (Application.TopRunnableView is { }) + { + Application.TopRunnableView.Remove (_currentTree); + } + _currentTree.Dispose (); } @@ -86,18 +108,21 @@ public class TreeUseCases : Scenario if (useDelegate) { tree.TreeBuilder = new DelegateTreeBuilder ( - o => - o is Army a - ? a.Units - : Enumerable.Empty () - ); + o => + o is Army a && a.Units is { } + ? a.Units + : Enumerable.Empty () + ); } else { tree.TreeBuilder = new GameObjectTreeBuilder (); } - Application.Top.Add (tree); + if (Application.TopRunnableView is { }) + { + Application.TopRunnableView.Add (tree); + } tree.AddObject (army1); @@ -106,24 +131,33 @@ public class TreeUseCases : Scenario private void LoadRooms () { - var myHouse = new House + House myHouse = new () { Address = "23 Nowhere Street", - Rooms = new List - { - new () { Name = "Ballroom" }, new () { Name = "Bedroom 1" }, new () { Name = "Bedroom 2" } - } + Rooms = + [ + new () { Name = "Ballroom" }, + new () { Name = "Bedroom 1" }, + new () { Name = "Bedroom 2" } + ] }; - if (_currentTree != null) + if (_currentTree is { }) { - Application.Top.Remove (_currentTree); + if (Application.TopRunnableView is { }) + { + Application.TopRunnableView.Remove (_currentTree); + } + _currentTree.Dispose (); } - var tree = new TreeView { X = 0, Y = 1, Width = Dim.Fill(), Height = Dim.Fill (1) }; + TreeView tree = new () { X = 0, Y = 1, Width = Dim.Fill (), Height = Dim.Fill (1) }; - Application.Top.Add (tree); + if (Application.TopRunnableView is { }) + { + Application.TopRunnableView.Add (tree); + } tree.AddObject (myHouse); @@ -132,21 +166,28 @@ public class TreeUseCases : Scenario private void LoadSimpleNodes () { - if (_currentTree != null) + if (_currentTree is { }) { - Application.Top.Remove (_currentTree); + if (Application.TopRunnableView is { }) + { + Application.TopRunnableView.Remove (_currentTree); + } + _currentTree.Dispose (); } - var tree = new TreeView { X = 0, Y = 1, Width = Dim.Fill (), Height = Dim.Fill (1) }; + TreeView tree = new () { X = 0, Y = 1, Width = Dim.Fill (), Height = Dim.Fill (1) }; - Application.Top.Add (tree); + if (Application.TopRunnableView is { }) + { + Application.TopRunnableView.Add (tree); + } - var root1 = new TreeNode ("Root1"); + TreeNode root1 = new ("Root1"); root1.Children.Add (new TreeNode ("Child1.1")); root1.Children.Add (new TreeNode ("Child1.2")); - var root2 = new TreeNode ("Root2"); + TreeNode root2 = new ("Root2"); root2.Children.Add (new TreeNode ("Child2.1")); root2.Children.Add (new TreeNode ("Child2.2")); @@ -156,17 +197,21 @@ public class TreeUseCases : Scenario _currentTree = tree; } - private void Quit () { Application.RequestStop (); } + private void Quit () + { + Application.RequestStop (); + } private class Army : GameObject { - public string Designation { get; set; } - public List Units { get; set; } + public string Designation { get; set; } = string.Empty; + public List Units { get; set; } = []; public override string ToString () { return Designation; } } private abstract class GameObject - { } + { + } private class GameObjectTreeBuilder : ITreeBuilder { @@ -175,7 +220,7 @@ public class TreeUseCases : Scenario public IEnumerable GetChildren (GameObject model) { - if (model is Army a) + if (model is Army a && a.Units is { }) { return a.Units; } @@ -184,15 +229,12 @@ public class TreeUseCases : Scenario } } - // Your data class private class House : TreeNode { - // Your properties - public string Address { get; set; } + public string Address { get; set; } = string.Empty; - // ITreeNode member: public override IList Children => Rooms.Cast ().ToList (); - public List Rooms { get; set; } + public List Rooms { get; set; } = []; public override string Text { @@ -203,7 +245,7 @@ public class TreeUseCases : Scenario private class Room : TreeNode { - public string Name { get; set; } + public string Name { get; set; } = string.Empty; public override string Text { @@ -214,7 +256,7 @@ public class TreeUseCases : Scenario private class Unit : GameObject { - public string Name { get; set; } + public string Name { get; set; } = string.Empty; public override string ToString () { return Name; } } } diff --git a/Examples/UICatalog/Scenarios/TreeViewFileSystem.cs b/Examples/UICatalog/Scenarios/TreeViewFileSystem.cs index 34540d5cc..64102a935 100644 --- a/Examples/UICatalog/Scenarios/TreeViewFileSystem.cs +++ b/Examples/UICatalog/Scenarios/TreeViewFileSystem.cs @@ -1,3 +1,5 @@ +#nullable enable + using System.IO.Abstractions; using System.Text; @@ -10,180 +12,51 @@ namespace UICatalog.Scenarios; public class TreeViewFileSystem : Scenario { private readonly FileSystemIconProvider _iconProvider = new (); - private DetailsFrame _detailsFrame; - private MenuItem _miArrowSymbols; - private MenuItem _miBasicIcons; - private MenuItem _miColoredSymbols; - private MenuItem _miCursor; - private MenuItem _miCustomColors; - private MenuItem _miFullPaths; - private MenuItem _miHighlightModelTextOnly; - private MenuItem _miInvertSymbols; - private MenuItem _miLeaveLastRow; - private MenuItem _miMultiSelect; - private MenuItem _miNerdIcons; - private MenuItem _miNoSymbols; - private MenuItem _miPlusMinus; - private MenuItem _miShowLines; - private MenuItem _miUnicodeIcons; + private DetailsFrame? _detailsFrame; + private CheckBox? _miArrowSymbolsCheckBox; + private CheckBox? _miBasicIconsCheckBox; + private CheckBox? _miColoredSymbolsCheckBox; + private CheckBox? _miCursorCheckBox; + private CheckBox? _miCustomColorsCheckBox; + private CheckBox? _miFullPathsCheckBox; + private CheckBox? _miHighlightModelTextOnlyCheckBox; + private CheckBox? _miInvertSymbolsCheckBox; + private CheckBox? _miLeaveLastRowCheckBox; + private CheckBox? _miMultiSelectCheckBox; + private CheckBox? _miNerdIconsCheckBox; + private CheckBox? _miNoSymbolsCheckBox; + private CheckBox? _miPlusMinusCheckBox; + private CheckBox? _miShowLinesCheckBox; + private CheckBox? _miUnicodeIconsCheckBox; /// A tree view where nodes are files and folders - private TreeView _treeViewFiles; + private TreeView? _treeViewFiles; public override void Main () { Application.Init (); - var win = new Window + Window win = new () { Title = GetName (), Y = 1, // menu Height = Dim.Fill () }; - var top = new Toplevel (); - var menu = new MenuBar - { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new ( - "_Quit", - $"{Application.QuitKey}", - () => Quit () - ) - } - ), - new ( - "_View", - new [] - { - _miFullPaths = - new ("_Full Paths", "", () => SetFullName ()) - { - Checked = false, CheckType = MenuItemCheckStyle.Checked - }, - _miMultiSelect = new ( - "_Multi Select", - "", - () => SetMultiSelect () - ) - { - Checked = true, - CheckType = MenuItemCheckStyle - .Checked - } - } - ), - new ( - "_Style", - new [] - { - _miShowLines = - new ("_Show Lines", "", () => ShowLines ()) - { - Checked = true, CheckType = MenuItemCheckStyle.Checked - }, - null /*separator*/, - _miPlusMinus = - new ( - "_Plus Minus Symbols", - "+ -", - () => SetExpandableSymbols ( - (Rune)'+', - (Rune)'-' - ) - ) { Checked = true, CheckType = MenuItemCheckStyle.Radio }, - _miArrowSymbols = - new ( - "_Arrow Symbols", - "> v", - () => SetExpandableSymbols ( - (Rune)'>', - (Rune)'v' - ) - ) { Checked = false, CheckType = MenuItemCheckStyle.Radio }, - _miNoSymbols = - new ( - "_No Symbols", - "", - () => SetExpandableSymbols ( - default (Rune), - null - ) - ) { Checked = false, CheckType = MenuItemCheckStyle.Radio }, - null /*separator*/, - _miColoredSymbols = - new ( - "_Colored Symbols", - "", - () => ShowColoredExpandableSymbols () - ) { Checked = false, CheckType = MenuItemCheckStyle.Checked }, - _miInvertSymbols = - new ( - "_Invert Symbols", - "", - () => InvertExpandableSymbols () - ) { Checked = false, CheckType = MenuItemCheckStyle.Checked }, - null /*separator*/, - _miBasicIcons = - new ("_Basic Icons", null, SetNoIcons) - { - Checked = false, CheckType = MenuItemCheckStyle.Radio - }, - _miUnicodeIcons = - new ("_Unicode Icons", null, SetUnicodeIcons) - { - Checked = false, CheckType = MenuItemCheckStyle.Radio - }, - _miNerdIcons = - new ("_Nerd Icons", null, SetNerdIcons) - { - Checked = false, CheckType = MenuItemCheckStyle.Radio - }, - null /*separator*/, - _miLeaveLastRow = - new ( - "_Leave Last Row", - "", - () => SetLeaveLastRow () - ) { Checked = true, CheckType = MenuItemCheckStyle.Checked }, - _miHighlightModelTextOnly = - new ( - "_Highlight Model Text Only", - "", - () => SetCheckHighlightModelTextOnly () - ) { Checked = false, CheckType = MenuItemCheckStyle.Checked }, - null /*separator*/, - _miCustomColors = - new ( - "C_ustom Colors Hidden Files", - "Yellow/Red", - () => SetCustomColors () - ) { Checked = false, CheckType = MenuItemCheckStyle.Checked }, - null /*separator*/, - _miCursor = new ( - "Curs_or (MultiSelect only)", - "", - () => SetCursor () - ) { Checked = false, CheckType = MenuItemCheckStyle.Checked } - } - ) - ] - }; - top.Add (menu); + // MenuBar + MenuBar menu = new (); - _treeViewFiles = new () { X = 0, Y = 0, Width = Dim.Percent (50), Height = Dim.Fill () }; + _treeViewFiles = new () { X = 0, Y = Pos.Bottom (menu), Width = Dim.Percent (50), Height = Dim.Fill () }; _treeViewFiles.DrawLine += TreeViewFiles_DrawLine; _treeViewFiles.VerticalScrollBar.AutoShow = false; _detailsFrame = new (_iconProvider) { - X = Pos.Right (_treeViewFiles), Y = 0, Width = Dim.Fill (), Height = Dim.Fill () + X = Pos.Right (_treeViewFiles), + Y = Pos.Top (_treeViewFiles), + Width = Dim.Fill (), + Height = Dim.Fill () }; win.Add (_detailsFrame); @@ -193,29 +66,214 @@ public class TreeViewFileSystem : Scenario SetupFileTree (); - win.Add (_treeViewFiles); - top.Add (win); + // Setup menu checkboxes + _miFullPathsCheckBox = new () + { + Title = "_Full Paths" + }; + _miFullPathsCheckBox.CheckedStateChanged += (s, e) => SetFullName (); + + _miMultiSelectCheckBox = new () + { + Title = "_Multi Select", + CheckedState = CheckState.Checked + }; + _miMultiSelectCheckBox.CheckedStateChanged += (s, e) => SetMultiSelect (); + + _miShowLinesCheckBox = new () + { + Title = "_Show Lines", + CheckedState = CheckState.Checked + }; + _miShowLinesCheckBox.CheckedStateChanged += (s, e) => ShowLines (); + + _miPlusMinusCheckBox = new () + { + Title = "_Plus Minus Symbols", + CheckedState = CheckState.Checked + }; + _miPlusMinusCheckBox.CheckedStateChanged += (s, e) => SetExpandableSymbols ((Rune)'+', (Rune)'-'); + + _miArrowSymbolsCheckBox = new () + { + Title = "_Arrow Symbols" + }; + _miArrowSymbolsCheckBox.CheckedStateChanged += (s, e) => SetExpandableSymbols ((Rune)'>', (Rune)'v'); + + _miNoSymbolsCheckBox = new () + { + Title = "_No Symbols" + }; + _miNoSymbolsCheckBox.CheckedStateChanged += (s, e) => SetExpandableSymbols (default (Rune), null); + + _miColoredSymbolsCheckBox = new () + { + Title = "_Colored Symbols" + }; + _miColoredSymbolsCheckBox.CheckedStateChanged += (s, e) => ShowColoredExpandableSymbols (); + + _miInvertSymbolsCheckBox = new () + { + Title = "_Invert Symbols" + }; + _miInvertSymbolsCheckBox.CheckedStateChanged += (s, e) => InvertExpandableSymbols (); + + _miBasicIconsCheckBox = new () + { + Title = "_Basic Icons" + }; + _miBasicIconsCheckBox.CheckedStateChanged += (s, e) => SetNoIcons (); + + _miUnicodeIconsCheckBox = new () + { + Title = "_Unicode Icons" + }; + _miUnicodeIconsCheckBox.CheckedStateChanged += (s, e) => SetUnicodeIcons (); + + _miNerdIconsCheckBox = new () + { + Title = "_Nerd Icons" + }; + _miNerdIconsCheckBox.CheckedStateChanged += (s, e) => SetNerdIcons (); + + _miLeaveLastRowCheckBox = new () + { + Title = "_Leave Last Row", + CheckedState = CheckState.Checked + }; + _miLeaveLastRowCheckBox.CheckedStateChanged += (s, e) => SetLeaveLastRow (); + + _miHighlightModelTextOnlyCheckBox = new () + { + Title = "_Highlight Model Text Only" + }; + _miHighlightModelTextOnlyCheckBox.CheckedStateChanged += (s, e) => SetCheckHighlightModelTextOnly (); + + _miCustomColorsCheckBox = new () + { + Title = "C_ustom Colors Hidden Files" + }; + _miCustomColorsCheckBox.CheckedStateChanged += (s, e) => SetCustomColors (); + + _miCursorCheckBox = new () + { + Title = "Curs_or (MultiSelect only)" + }; + _miCursorCheckBox.CheckedStateChanged += (s, e) => SetCursor (); + + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem + { + Title = "_Quit", + Key = Application.QuitKey, + Action = Quit + } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "_View", + [ + new MenuItem + { + CommandView = _miFullPathsCheckBox + }, + new MenuItem + { + CommandView = _miMultiSelectCheckBox + } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "_Style", + [ + new MenuItem + { + CommandView = _miShowLinesCheckBox + }, + new MenuItem + { + CommandView = _miPlusMinusCheckBox + }, + new MenuItem + { + CommandView = _miArrowSymbolsCheckBox + }, + new MenuItem + { + CommandView = _miNoSymbolsCheckBox + }, + new MenuItem + { + CommandView = _miColoredSymbolsCheckBox + }, + new MenuItem + { + CommandView = _miInvertSymbolsCheckBox + }, + new MenuItem + { + CommandView = _miBasicIconsCheckBox + }, + new MenuItem + { + CommandView = _miUnicodeIconsCheckBox + }, + new MenuItem + { + CommandView = _miNerdIconsCheckBox + }, + new MenuItem + { + CommandView = _miLeaveLastRowCheckBox + }, + new MenuItem + { + CommandView = _miHighlightModelTextOnlyCheckBox + }, + new MenuItem + { + CommandView = _miCustomColorsCheckBox + }, + new MenuItem + { + CommandView = _miCursorCheckBox + } + ] + ) + ); + + win.Add (menu, _treeViewFiles); _treeViewFiles.GoToFirst (); _treeViewFiles.Expand (); - //SetupScrollBar (); - _treeViewFiles.SetFocus (); UpdateIconCheckedness (); - Application.Run (top); - top.Dispose (); + Application.Run (win); + win.Dispose (); Application.Shutdown (); } - private string AspectGetter (IFileSystemInfo f) { return (_iconProvider.GetIconWithOptionalSpace (f) + f.Name).Trim (); } + private string AspectGetter (IFileSystemInfo f) => (_iconProvider.GetIconWithOptionalSpace (f) + f.Name).Trim (); private void InvertExpandableSymbols () { - _miInvertSymbols.Checked = !_miInvertSymbols.Checked; + if (_treeViewFiles is null || _miInvertSymbolsCheckBox is null) + { + return; + } - _treeViewFiles.Style.InvertExpandSymbolColors = (bool)_miInvertSymbols.Checked; + _treeViewFiles.Style.InvertExpandSymbolColors = _miInvertSymbolsCheckBox.CheckedState == CheckState.Checked; _treeViewFiles.SetNeedsDraw (); } @@ -223,24 +281,34 @@ public class TreeViewFileSystem : Scenario private void SetCheckHighlightModelTextOnly () { - _treeViewFiles.Style.HighlightModelTextOnly = !_treeViewFiles.Style.HighlightModelTextOnly; - _miHighlightModelTextOnly.Checked = _treeViewFiles.Style.HighlightModelTextOnly; + if (_treeViewFiles is null || _miHighlightModelTextOnlyCheckBox is null) + { + return; + } + + _treeViewFiles.Style.HighlightModelTextOnly = _miHighlightModelTextOnlyCheckBox.CheckedState == CheckState.Checked; _treeViewFiles.SetNeedsDraw (); } private void SetCursor () { - _miCursor.Checked = !_miCursor.Checked; + if (_treeViewFiles is null || _miCursorCheckBox is null) + { + return; + } _treeViewFiles.CursorVisibility = - _miCursor.Checked == true ? CursorVisibility.Default : CursorVisibility.Invisible; + _miCursorCheckBox.CheckedState == CheckState.Checked ? CursorVisibility.Default : CursorVisibility.Invisible; } private void SetCustomColors () { - _miCustomColors.Checked = !_miCustomColors.Checked; + if (_treeViewFiles is null || _miCustomColorsCheckBox is null) + { + return; + } - if (_miCustomColors.Checked == true) + if (_miCustomColorsCheckBox.CheckedState == CheckState.Checked) { _treeViewFiles.ColorGetter = m => { @@ -257,8 +325,6 @@ public class TreeViewFileSystem : Scenario _treeViewFiles.GetAttributeForRole (VisualRole.Normal).Background ) }; - - ; } if (m is IFileInfo && m.Attributes.HasFlag (FileAttributes.Hidden)) @@ -274,8 +340,6 @@ public class TreeViewFileSystem : Scenario _treeViewFiles.GetAttributeForRole (VisualRole.Normal).Background ) }; - - ; } return null; @@ -291,9 +355,25 @@ public class TreeViewFileSystem : Scenario private void SetExpandableSymbols (Rune expand, Rune? collapse) { - _miPlusMinus.Checked = expand.Value == '+'; - _miArrowSymbols.Checked = expand.Value == '>'; - _miNoSymbols.Checked = expand.Value == default (int); + if (_treeViewFiles is null) + { + return; + } + + if (_miPlusMinusCheckBox is { }) + { + _miPlusMinusCheckBox.CheckedState = expand.Value == '+' ? CheckState.Checked : CheckState.UnChecked; + } + + if (_miArrowSymbolsCheckBox is { }) + { + _miArrowSymbolsCheckBox.CheckedState = expand.Value == '>' ? CheckState.Checked : CheckState.UnChecked; + } + + if (_miNoSymbolsCheckBox is { }) + { + _miNoSymbolsCheckBox.CheckedState = expand.Value == default (int) ? CheckState.Checked : CheckState.UnChecked; + } _treeViewFiles.Style.ExpandableSymbol = expand; _treeViewFiles.Style.CollapseableSymbol = collapse; @@ -302,9 +382,12 @@ public class TreeViewFileSystem : Scenario private void SetFullName () { - _miFullPaths.Checked = !_miFullPaths.Checked; + if (_treeViewFiles is null || _miFullPathsCheckBox is null) + { + return; + } - if (_miFullPaths.Checked == true) + if (_miFullPathsCheckBox.CheckedState == CheckState.Checked) { _treeViewFiles.AspectGetter = f => f.FullName; } @@ -318,14 +401,22 @@ public class TreeViewFileSystem : Scenario private void SetLeaveLastRow () { - _miLeaveLastRow.Checked = !_miLeaveLastRow.Checked; - _treeViewFiles.Style.LeaveLastRow = (bool)_miLeaveLastRow.Checked; + if (_treeViewFiles is null || _miLeaveLastRowCheckBox is null) + { + return; + } + + _treeViewFiles.Style.LeaveLastRow = _miLeaveLastRowCheckBox.CheckedState == CheckState.Checked; } private void SetMultiSelect () { - _miMultiSelect.Checked = !_miMultiSelect.Checked; - _treeViewFiles.MultiSelect = (bool)_miMultiSelect.Checked; + if (_treeViewFiles is null || _miMultiSelectCheckBox is null) + { + return; + } + + _treeViewFiles.MultiSelect = _miMultiSelectCheckBox.CheckedState == CheckState.Checked; } private void SetNerdIcons () @@ -349,8 +440,13 @@ public class TreeViewFileSystem : Scenario private void SetupFileTree () { + if (_treeViewFiles is null) + { + return; + } + // setup how to build tree - var fs = new FileSystem (); + FileSystem fs = new (); IEnumerable rootDirs = DriveInfo.GetDrives ().Select (d => fs.DirectoryInfo.New (d.RootDirectory.FullName)); @@ -363,52 +459,14 @@ public class TreeViewFileSystem : Scenario _iconProvider.IsOpenGetter = _treeViewFiles.IsExpanded; } - //private void SetupScrollBar () - //{ - // // When using scroll bar leave the last row of the control free (for over-rendering with scroll bar) - // _treeViewFiles.Style.LeaveLastRow = true; - - // var scrollBar = new ScrollBarView (_treeViewFiles, true); - - // scrollBar.ChangedPosition += (s, e) => - // { - // _treeViewFiles.ScrollOffsetVertical = scrollBar.Position; - - // if (_treeViewFiles.ScrollOffsetVertical != scrollBar.Position) - // { - // scrollBar.Position = _treeViewFiles.ScrollOffsetVertical; - // } - - // _treeViewFiles.SetNeedsDraw (); - // }; - - // scrollBar.OtherScrollBarView.ChangedPosition += (s, e) => - // { - // _treeViewFiles.ScrollOffsetHorizontal = scrollBar.OtherScrollBarView.Position; - - // if (_treeViewFiles.ScrollOffsetHorizontal != scrollBar.OtherScrollBarView.Position) - // { - // scrollBar.OtherScrollBarView.Position = _treeViewFiles.ScrollOffsetHorizontal; - // } - - // _treeViewFiles.SetNeedsDraw (); - // }; - - // _treeViewFiles.DrawingContent += (s, e) => - // { - // scrollBar.Size = _treeViewFiles.ContentHeight; - // scrollBar.Position = _treeViewFiles.ScrollOffsetVertical; - // scrollBar.OtherScrollBarView.Size = _treeViewFiles.GetContentWidth (true); - // scrollBar.OtherScrollBarView.Position = _treeViewFiles.ScrollOffsetHorizontal; - // scrollBar.Refresh (); - // }; - //} - private void ShowColoredExpandableSymbols () { - _miColoredSymbols.Checked = !_miColoredSymbols.Checked; + if (_treeViewFiles is null || _miColoredSymbolsCheckBox is null) + { + return; + } - _treeViewFiles.Style.ColorExpandSymbol = (bool)_miColoredSymbols.Checked; + _treeViewFiles.Style.ColorExpandSymbol = _miColoredSymbolsCheckBox.CheckedState == CheckState.Checked; _treeViewFiles.SetNeedsDraw (); } @@ -418,22 +476,31 @@ public class TreeViewFileSystem : Scenario // Registering with the PopoverManager will ensure that the context menu is closed when the view is no longer focused // and the context menu is disposed when it is closed. - Application.Popover?.Register (contextMenu); + _detailsFrame?.App?.Popover?.Register (contextMenu); Application.Invoke (() => contextMenu?.MakeVisible (screenPoint)); } private void ShowLines () { - _miShowLines.Checked = !_miShowLines.Checked; + if (_treeViewFiles is null || _miShowLinesCheckBox is null) + { + return; + } - _treeViewFiles.Style.ShowBranchLines = (bool)_miShowLines.Checked!; + _treeViewFiles.Style.ShowBranchLines = _miShowLinesCheckBox.CheckedState == CheckState.Checked; _treeViewFiles.SetNeedsDraw (); } - private void ShowPropertiesOf (IFileSystemInfo fileSystemInfo) { _detailsFrame.FileInfo = fileSystemInfo; } + private void ShowPropertiesOf (IFileSystemInfo fileSystemInfo) + { + if (_detailsFrame is { }) + { + _detailsFrame.FileInfo = fileSystemInfo; + } + } - private void TreeViewFiles_DrawLine (object sender, DrawTreeViewLineEventArgs e) + private void TreeViewFiles_DrawLine (object? sender, DrawTreeViewLineEventArgs e) { // Render directory icons in yellow if (e.Model is IDirectoryInfo d) @@ -454,14 +521,19 @@ public class TreeViewFileSystem : Scenario } } - private void TreeViewFiles_KeyPress (object sender, Key obj) + private void TreeViewFiles_KeyPress (object? sender, Key obj) { + if (_treeViewFiles is null) + { + return; + } + if (obj.KeyCode == (KeyCode.R | KeyCode.CtrlMask)) { - IFileSystemInfo selected = _treeViewFiles.SelectedObject; + IFileSystemInfo? selected = _treeViewFiles.SelectedObject; // nothing is selected - if (selected == null) + if (selected is null) { return; } @@ -469,7 +541,7 @@ public class TreeViewFileSystem : Scenario int? location = _treeViewFiles.GetObjectRow (selected); //selected object is offscreen or somehow not found - if (location == null || location < 0 || location > _treeViewFiles.Frame.Height) + if (location is null || location < 0 || location > _treeViewFiles.Frame.Height) { return; } @@ -484,15 +556,20 @@ public class TreeViewFileSystem : Scenario } } - private void TreeViewFiles_MouseClick (object sender, MouseEventArgs obj) + private void TreeViewFiles_MouseClick (object? sender, MouseEventArgs obj) { + if (_treeViewFiles is null) + { + return; + } + // if user right clicks if (obj.Flags.HasFlag (MouseFlags.Button3Clicked)) { - IFileSystemInfo rightClicked = _treeViewFiles.GetObjectOnRow (obj.Position.Y); + IFileSystemInfo? rightClicked = _treeViewFiles.GetObjectOnRow (obj.Position.Y); // nothing was clicked - if (rightClicked == null) + if (rightClicked is null) { return; } @@ -507,20 +584,34 @@ public class TreeViewFileSystem : Scenario } } - private void TreeViewFiles_SelectionChanged (object sender, SelectionChangedEventArgs e) { ShowPropertiesOf (e.NewValue); } + private void TreeViewFiles_SelectionChanged (object? sender, SelectionChangedEventArgs e) { ShowPropertiesOf (e.NewValue); } private void UpdateIconCheckedness () { - _miBasicIcons.Checked = !_iconProvider.UseNerdIcons && !_iconProvider.UseUnicodeCharacters; - _miUnicodeIcons.Checked = _iconProvider.UseUnicodeCharacters; - _miNerdIcons.Checked = _iconProvider.UseNerdIcons; - _treeViewFiles.SetNeedsDraw (); + if (_miBasicIconsCheckBox is { }) + { + _miBasicIconsCheckBox.CheckedState = !_iconProvider.UseNerdIcons && !_iconProvider.UseUnicodeCharacters + ? CheckState.Checked + : CheckState.UnChecked; + } + + if (_miUnicodeIconsCheckBox is { }) + { + _miUnicodeIconsCheckBox.CheckedState = _iconProvider.UseUnicodeCharacters ? CheckState.Checked : CheckState.UnChecked; + } + + if (_miNerdIconsCheckBox is { }) + { + _miNerdIconsCheckBox.CheckedState = _iconProvider.UseNerdIcons ? CheckState.Checked : CheckState.UnChecked; + } + + _treeViewFiles?.SetNeedsDraw (); } private class DetailsFrame : FrameView { private readonly FileSystemIconProvider _iconProvider; - private IFileSystemInfo _fileInfo; + private IFileSystemInfo? _fileInfo; public DetailsFrame (FileSystemIconProvider iconProvider) { @@ -530,13 +621,13 @@ public class TreeViewFileSystem : Scenario _iconProvider = iconProvider; } - public IFileSystemInfo FileInfo + public IFileSystemInfo? FileInfo { get => _fileInfo; set { _fileInfo = value; - StringBuilder sb = null; + StringBuilder? sb = null; if (_fileInfo is IFileInfo f) { @@ -552,12 +643,12 @@ public class TreeViewFileSystem : Scenario { Title = $"{_iconProvider.GetIconWithOptionalSpace (dir)}{dir.Name}".Trim (); sb = new (); - sb.AppendLine ($"Path:\n {dir?.FullName}\n"); + sb.AppendLine ($"Path:\n {dir.FullName}\n"); sb.AppendLine ($"Modified:\n {dir.LastWriteTime}\n"); sb.AppendLine ($"Created:\n {dir.CreationTime}\n"); } - Text = sb.ToString (); + Text = sb?.ToString () ?? string.Empty; } } } diff --git a/Examples/UICatalog/Scenarios/TrueColors.cs b/Examples/UICatalog/Scenarios/TrueColors.cs deleted file mode 100644 index 43e52dec3..000000000 --- a/Examples/UICatalog/Scenarios/TrueColors.cs +++ /dev/null @@ -1,157 +0,0 @@ -using System; - -namespace UICatalog.Scenarios; - -[ScenarioMetadata ("True Colors", "Demonstration of true color support.")] -[ScenarioCategory ("Colors")] -public class TrueColors : Scenario -{ - public override void Main () - { - Application.Init (); - - Window app = new () - { - Title = GetQuitKeyAndName () - }; - - var x = 2; - var y = 1; - - bool canTrueColor = Application.Driver?.SupportsTrueColor ?? false; - - var lblDriverName = new Label - { - X = x, Y = y++, Text = $"Current driver is {Application.Driver?.GetType ().Name}" - }; - app.Add (lblDriverName); - y++; - - var cbSupportsTrueColor = new CheckBox - { - X = x, - Y = y++, - CheckedState = canTrueColor ? CheckState.Checked : CheckState.UnChecked, - CanFocus = false, - Enabled = false, - Text = "Driver supports true color " - }; - app.Add (cbSupportsTrueColor); - - var cbUseTrueColor = new CheckBox - { - X = x, - Y = y++, - CheckedState = Application.Force16Colors ? CheckState.Checked : CheckState.UnChecked, - Enabled = canTrueColor, - Text = "Force 16 colors" - }; - cbUseTrueColor.CheckedStateChanging += (_, evt) => { Application.Force16Colors = evt.Result == CheckState.Checked; }; - app.Add (cbUseTrueColor); - - y += 2; - SetupGradient ("Red gradient", x, ref y, i => new (i, 0)); - SetupGradient ("Green gradient", x, ref y, i => new (0, i)); - SetupGradient ("Blue gradient", x, ref y, i => new (0, 0, i)); - SetupGradient ("Yellow gradient", x, ref y, i => new (i, i)); - SetupGradient ("Magenta gradient", x, ref y, i => new (i, 0, i)); - SetupGradient ("Cyan gradient", x, ref y, i => new (0, i, i)); - SetupGradient ("Gray gradient", x, ref y, i => new (i, i, i)); - - app.Add ( - new Label { X = Pos.AnchorEnd (44), Y = 2, Text = "Mouse over to get the gradient view color:" } - ); - - app.Add ( - new Label { X = Pos.AnchorEnd (44), Y = 4, Text = "Red:" } - ); - - app.Add ( - new Label { X = Pos.AnchorEnd (44), Y = 5, Text = "Green:" } - ); - - app.Add ( - new Label { X = Pos.AnchorEnd (44), Y = 6, Text = "Blue:" } - ); - - app.Add ( - new Label { X = Pos.AnchorEnd (44), Y = 8, Text = "Darker:" } - ); - - app.Add ( - new Label { X = Pos.AnchorEnd (44), Y = 9, Text = "Lighter:" } - ); - - var lblRed = new Label { X = Pos.AnchorEnd (32), Y = 4, Text = "na" }; - app.Add (lblRed); - var lblGreen = new Label { X = Pos.AnchorEnd (32), Y = 5, Text = "na" }; - app.Add (lblGreen); - var lblBlue = new Label { X = Pos.AnchorEnd (32), Y = 6, Text = "na" }; - app.Add (lblBlue); - - var lblDarker = new Label { X = Pos.AnchorEnd (32), Y = 8, Text = " " }; - app.Add (lblDarker); - - var lblLighter = new Label { X = Pos.AnchorEnd (32), Y = 9, Text = " " }; - app.Add (lblLighter); - - Application.MouseEvent += (s, e) => - { - if (e.View == null) - { - return; - } - - if (e.Flags == MouseFlags.Button1Clicked) - { - Attribute normal = e.View.GetAttributeForRole (VisualRole.Normal); - - lblLighter.SetScheme (new (e.View.GetScheme ()) - { - Normal = new ( - normal.Foreground, - normal.Background.GetBrighterColor () - ) - }); - } - else - { - Attribute normal = e.View.GetAttributeForRole (VisualRole.Normal); - lblRed.Text = normal.Foreground.R.ToString (); - lblGreen.Text = normal.Foreground.G.ToString (); - lblBlue.Text = normal.Foreground.B.ToString (); - } - }; - Application.Run (app); - app.Dispose (); - - Application.Shutdown (); - - return; - - void SetupGradient (string name, int x, ref int y, Func colorFunc) - { - var gradient = new Label { X = x, Y = y++, Text = name }; - app.Add (gradient); - - for (int dx = x, i = 0; i <= 256; i += 4) - { - var l = new Label - { - X = dx++, - Y = y - }; - l.SetScheme (new () - { - Normal = new ( - colorFunc (Math.Clamp (i, 0, 255)), - colorFunc (Math.Clamp (i, 0, 255)) - ) - }); - app.Add (l); - } - - y += 2; - } - } -} diff --git a/Examples/UICatalog/Scenarios/Unicode.cs b/Examples/UICatalog/Scenarios/Unicode.cs index 412f982da..3fe347aec 100644 --- a/Examples/UICatalog/Scenarios/Unicode.cs +++ b/Examples/UICatalog/Scenarios/Unicode.cs @@ -1,5 +1,5 @@ -using System.Collections.ObjectModel; -using System.IO; +#nullable enable + using System.Text; namespace UICatalog.Scenarios; @@ -15,82 +15,75 @@ public class UnicodeInMenu : Scenario "Τὴ γλῶσσα μοῦ ἔδωσαν ἑλληνικὴ\nτὸ σπίτι φτωχικὸ στὶς ἀμμουδιὲς τοῦ Ὁμήρου.\nΜονάχη ἔγνοια ἡ γλῶσσα μου στὶς ἀμμουδιὲς τοῦ Ὁμήρου."; var gitString = - $"gui.cs 糊 (hú) { - Glyphs.IdenticalTo - } { - Glyphs.DownArrow - }18 { - Glyphs.UpArrow - }10 { - Glyphs.VerticalFourDots - }1 { - Glyphs.HorizontalEllipsis - }"; + $"gui.cs 糊 (hú) {Glyphs.IdenticalTo} {Glyphs.DownArrow}18 {Glyphs.UpArrow}10 {Glyphs.VerticalFourDots}1 {Glyphs.HorizontalEllipsis}"; - // Init Application.Init (); - // Setup - Create a top-level application window and configure it. Window appWindow = new () { - Title = GetQuitKeyAndName () + Title = GetQuitKeyAndName (), + BorderStyle = LineStyle.None }; - var menu = new MenuBar - { - Menus = - [ - new ( - "_Файл", - new MenuItem [] - { - new ( - "_Создать", - "Creates new file", - null - ), - new ("_Открыть", "", null), - new ("Со_хранить", "", null), - new ( - "_Выход", - "", - () => Application.RequestStop () - ) - } - ), - new ( - "_Edit", - new MenuItem [] - { - new ("_Copy", "", null), new ("C_ut", "", null), - new ("_糊", "hú (Paste)", null) - } - ) - ] - }; + // MenuBar + MenuBar menu = new (); + + menu.Add ( + new MenuBarItem ( + "_Файл", + [ + new MenuItem + { + Title = "_Создать", + HelpText = "Creates new file" + }, + new MenuItem + { + Title = "_Открыть" + }, + new MenuItem + { + Title = "Со_хранить" + }, + new MenuItem + { + Title = "_Выход", + Action = () => Application.RequestStop () + } + ] + ) + ); + + menu.Add ( + new MenuBarItem ( + "_Edit", + [ + new MenuItem + { + Title = "_Copy" + }, + new MenuItem + { + Title = "C_ut" + }, + new MenuItem + { + Title = "_糊", + HelpText = "hú (Paste)" + } + ] + ) + ); + appWindow.Add (menu); - var statusBar = new StatusBar ( - [ - new ( - Application.QuitKey, - "Выход", - () => Application.RequestStop () - ), - new (Key.F2, "Создать", null), - new (Key.F3, "Со_хранить", null) - ] - ); - appWindow.Add (statusBar); - - var label = new Label { X = 0, Y = 1, Text = "Label:" }; + Label label = new () { X = 0, Y = Pos.Bottom (menu), Text = "Label:" }; appWindow.Add (label); - var testlabel = new Label + Label testlabel = new () { X = 20, Y = Pos.Y (label), - Width = Dim.Percent (50), Text = gitString }; @@ -98,7 +91,8 @@ public class UnicodeInMenu : Scenario label = new () { X = Pos.X (label), Y = Pos.Bottom (label) + 1, Text = "Label (CanFocus):" }; appWindow.Add (label); - var sb = new StringBuilder (); + + StringBuilder sb = new (); sb.Append ('e'); sb.Append ('\u0301'); sb.Append ('\u0301'); @@ -107,64 +101,59 @@ public class UnicodeInMenu : Scenario { X = 20, Y = Pos.Y (label), - Width = Dim.Percent (50), CanFocus = true, HotKeySpecifier = new ('&'), Text = $"Should be [e with two accents, but isn't due to #2616]: [{sb}]" }; appWindow.Add (testlabel); + label = new () { X = Pos.X (label), Y = Pos.Bottom (label) + 1, Text = "Button:" }; appWindow.Add (label); - var button = new Button { X = 20, Y = Pos.Y (label), Text = "A123456789♥♦♣♠JQK" }; + + Button button = new () { X = 20, Y = Pos.Y (label), Text = "A123456789♥♦♣♠JQK" }; appWindow.Add (button); label = new () { X = Pos.X (label), Y = Pos.Bottom (label) + 1, Text = "CheckBox:" }; appWindow.Add (label); - var checkBox = new CheckBox + CheckBox checkBox = new () { X = 20, Y = Pos.Y (label), - Width = Dim.Percent (50), Height = 1, Text = gitString }; + appWindow.Add (checkBox); - var checkBoxRight = new CheckBox + CheckBox checkBoxRight = new () { X = 20, Y = Pos.Bottom (checkBox), - Width = Dim.Percent (50), Height = 1, TextAlignment = Alignment.End, Text = $"End - {gitString}" }; - appWindow.Add (checkBox, checkBoxRight); + appWindow.Add (checkBoxRight); - //label = new () { X = Pos.X (label), Y = Pos.Bottom (checkBoxRight) + 1, Text = "ComboBox:" }; - //appWindow.Add (label); - //var comboBox = new ComboBox { X = 20, Y = Pos.Y (label), Width = Dim.Percent (50) }; - //comboBox.SetSource (new ObservableCollection { gitString, "Со_хранить" }); - - //appWindow.Add (comboBox); - //comboBox.Text = gitString; - - label = new () { X = Pos.X (label), Y = Pos.Bottom (label) + 2, Text = "HexView:" }; + label = new () { X = Pos.X (label), Y = Pos.Bottom (checkBoxRight) + 2, Text = "HexView:" }; appWindow.Add (label); - var hexView = new HexView (new MemoryStream (Encoding.ASCII.GetBytes (gitString + " Со_хранить"))) + HexView hexView = new (new MemoryStream (Encoding.ASCII.GetBytes (gitString + " Со_хранить"))) { - X = 20, Y = Pos.Y (label), Width = Dim.Percent (60), Height = 5 + X = 20, + Y = Pos.Y (label), + Width = Dim.Percent (60), + Height = 5 }; appWindow.Add (hexView); label = new () { X = Pos.X (label), Y = Pos.Bottom (hexView) + 1, Text = "ListView:" }; appWindow.Add (label); - var listView = new ListView + ListView listView = new () { X = 20, Y = Pos.Y (label), @@ -179,28 +168,31 @@ public class UnicodeInMenu : Scenario label = new () { X = Pos.X (label), Y = Pos.Bottom (listView) + 1, Text = "OptionSelector:" }; appWindow.Add (label); - var optionSelector = new OptionSelector + OptionSelector optionSelector = new () { X = 20, Y = Pos.Y (label), Width = Dim.Percent (60), - Labels = new [] { "item #1", gitString, "Со_хранить", "𝔽𝕆𝕆𝔹𝔸ℝ" } + Labels = ["item #1", gitString, "Со_хранить", "𝔽𝕆𝕆𝔹𝔸ℝ"] }; appWindow.Add (optionSelector); label = new () { X = Pos.X (label), Y = Pos.Bottom (optionSelector) + 1, Text = "TextField:" }; appWindow.Add (label); - var textField = new TextField + TextField textField = new () { - X = 20, Y = Pos.Y (label), Width = Dim.Percent (60), Text = gitString + " = Со_хранить" + X = 20, + Y = Pos.Y (label), + Width = Dim.Percent (60), + Text = gitString + " = Со_хранить" }; appWindow.Add (textField); label = new () { X = Pos.X (label), Y = Pos.Bottom (textField) + 1, Text = "TextView:" }; appWindow.Add (label); - var textView = new TextView + TextView textView = new () { X = 20, Y = Pos.Y (label), @@ -210,12 +202,22 @@ public class UnicodeInMenu : Scenario }; appWindow.Add (textView); - // Run - Start the application. + // StatusBar + StatusBar statusBar = new ( + [ + new ( + Application.QuitKey, + "Выход", + () => Application.RequestStop () + ), + new (Key.F2, "Создать", null), + new (Key.F3, "Со_хранить", null) + ] + ); + appWindow.Add (statusBar); + Application.Run (appWindow); - appWindow.Dispose (); - - // Shutdown - Calling Application.Shutdown is required. Application.Shutdown (); } } diff --git a/Examples/UICatalog/Scenarios/ViewExperiments.cs b/Examples/UICatalog/Scenarios/ViewExperiments.cs index b7abf8588..c36fce3e7 100644 --- a/Examples/UICatalog/Scenarios/ViewExperiments.cs +++ b/Examples/UICatalog/Scenarios/ViewExperiments.cs @@ -75,15 +75,15 @@ public class ViewExperiments : Scenario Y = Pos.Center (), Title = $"_Close", }; - //popoverButton.Accepting += (sender, e) => Application.Popover!.Visible = false; + //popoverButton.Accepting += (sender, e) => App?.Popover!.Visible = false; popoverView.Add (popoverButton); button.Accepting += ButtonAccepting; void ButtonAccepting (object sender, CommandEventArgs e) { - //Application.Popover = popoverView; - //Application.Popover!.Visible = true; + //App?.Popover = popoverView; + //App?.Popover!.Visible = true; } testFrame.MouseClick += TestFrameOnMouseClick; @@ -94,8 +94,8 @@ public class ViewExperiments : Scenario { popoverView.X = e.ScreenPosition.X; popoverView.Y = e.ScreenPosition.Y; - //Application.Popover = popoverView; - //Application.Popover!.Visible = true; + //App?.Popover = popoverView; + //App?.Popover!.Visible = true; } } diff --git a/Examples/UICatalog/Scenarios/ViewportSettings.cs b/Examples/UICatalog/Scenarios/ViewportSettings.cs index 4e430171c..b4934a064 100644 --- a/Examples/UICatalog/Scenarios/ViewportSettings.cs +++ b/Examples/UICatalog/Scenarios/ViewportSettings.cs @@ -102,7 +102,7 @@ public class ViewportSettings : Scenario Title = GetQuitKeyAndName (), // Use a different colorscheme so ViewSettings.ClearContentOnly is obvious - SchemeName = "Toplevel", + SchemeName = "Runnable", BorderStyle = LineStyle.None }; @@ -169,13 +169,13 @@ public class ViewportSettings : Scenario }; charMap.Accepting += (s, e) => - MessageBox.Query (20, 7, "Hi", $"Am I a {view.GetType ().Name}?", "Yes", "No"); + MessageBox.Query ((s as View)?.App, 20, 7, "Hi", $"Am I a {view.GetType ().Name}?", "Yes", "No"); var buttonAnchored = new Button { X = Pos.AnchorEnd () - 10, Y = Pos.AnchorEnd () - 4, Text = "Bottom Rig_ht" }; - buttonAnchored.Accepting += (sender, args) => MessageBox.Query ("Hi", $"You pressed {((Button)sender)?.Text}", "_Ok"); + buttonAnchored.Accepting += (sender, args) => MessageBox.Query ((sender as View)?.App, "Hi", $"You pressed {((Button)sender)?.Text}", "_Ok"); view.Margin!.Data = "Margin"; view.Margin!.Thickness = new (0); diff --git a/Examples/UICatalog/Scenarios/WindowsAndFrameViews.cs b/Examples/UICatalog/Scenarios/WindowsAndFrameViews.cs index fcf57343a..4404f8008 100644 --- a/Examples/UICatalog/Scenarios/WindowsAndFrameViews.cs +++ b/Examples/UICatalog/Scenarios/WindowsAndFrameViews.cs @@ -16,9 +16,9 @@ public class WindowsAndFrameViews : Scenario Title = GetQuitKeyAndName () }; - static int About () + static int? About () { - return MessageBox.Query ( + return MessageBox.Query (ApplicationImpl.Instance, "About UI Catalog", "UI Catalog is a comprehensive sample library for Terminal.Gui", "Ok" @@ -69,7 +69,7 @@ public class WindowsAndFrameViews : Scenario // add it to our list listWin.Add (win); - // create 3 more Windows in a loop, adding them Application.Top + // create 3 more Windows in a loop, adding them Application.TopRunnable // Each with a // button // sub Window with @@ -99,7 +99,7 @@ public class WindowsAndFrameViews : Scenario }; pressMeButton.Accepting += (s, e) => - MessageBox.ErrorQuery (loopWin.Title, "Neat?", "Yes", "No"); + MessageBox.ErrorQuery ((s as View)?.App, loopWin.Title, "Neat?", "Yes", "No"); loopWin.Add (pressMeButton); var subWin = new Window diff --git a/Examples/UICatalog/Scenarios/WizardAsView.cs b/Examples/UICatalog/Scenarios/WizardAsView.cs index 65f417a82..6ce39b6f0 100644 --- a/Examples/UICatalog/Scenarios/WizardAsView.cs +++ b/Examples/UICatalog/Scenarios/WizardAsView.cs @@ -1,4 +1,5 @@ - +#nullable enable + namespace UICatalog.Scenarios; [ScenarioMetadata ("WizardAsView", "Shows using the Wizard class in an non-modal way")] @@ -9,65 +10,63 @@ public class WizardAsView : Scenario { Application.Init (); - var menu = new MenuBar - { - Menus = - [ - new MenuBarItem ( - "_File", - new MenuItem [] - { - new ( - "_Restart Configuration...", - "", - () => MessageBox.Query ( - "Wizaard", - "Are you sure you want to reset the Wizard and start over?", - "Ok", - "Cancel" - ) - ), - new ( - "Re_boot Server...", - "", - () => MessageBox.Query ( - "Wizaard", - "Are you sure you want to reboot the server start over?", - "Ok", - "Cancel" - ) - ), - new ( - "_Shutdown Server...", - "", - () => MessageBox.Query ( - "Wizaard", - "Are you sure you want to cancel setup and shutdown?", - "Ok", - "Cancel" - ) - ) - } - ) - ] - }; + // MenuBar + MenuBar menu = new (); - Toplevel topLevel = new (); - topLevel.Add (menu); + menu.Add ( + new MenuBarItem ( + "_File", + [ + new MenuItem + { + Title = "_Restart Configuration...", + Action = () => MessageBox.Query ( + ApplicationImpl.Instance, + "Wizard", + "Are you sure you want to reset the Wizard and start over?", + "Ok", + "Cancel" + ) + }, + new MenuItem + { + Title = "Re_boot Server...", + Action = () => MessageBox.Query ( + ApplicationImpl.Instance, + "Wizard", + "Are you sure you want to reboot the server start over?", + "Ok", + "Cancel" + ) + }, + new MenuItem + { + Title = "_Shutdown Server...", + Action = () => MessageBox.Query ( + ApplicationImpl.Instance, + "Wizard", + "Are you sure you want to cancel setup and shutdown?", + "Ok", + "Cancel" + ) + } + ] + ) + ); // No need for a Title because the border is disabled - var wizard = new Wizard + Wizard wizard = new () { X = 0, - Y = 0, + Y = Pos.Bottom (menu), Width = Dim.Fill (), Height = Dim.Fill (), ShadowStyle = ShadowStyle.None }; - // Set Mdoal to false to cause the Wizard class to render without a frame and + // Set Modal to false to cause the Wizard class to render without a frame and // behave like an non-modal View (vs. a modal/pop-up Window). - wizard.Modal = false; + // wizard.Modal = false; wizard.MovingBack += (s, args) => { @@ -84,13 +83,13 @@ public class WizardAsView : Scenario wizard.Finished += (s, args) => { //args.Cancel = true; - MessageBox.Query ("Setup Wizard", "Finished", "Ok"); + MessageBox.Query ((s as View)?.App, "Setup Wizard", "Finished", "Ok"); Application.RequestStop (); }; wizard.Cancelled += (s, args) => { - int btn = MessageBox.Query ("Setup Wizard", "Are you sure you want to cancel?", "Yes", "No"); + int? btn = MessageBox.Query ((s as View)?.App, "Setup Wizard", "Are you sure you want to cancel?", "Yes", "No"); args.Cancel = btn == 1; if (btn == 0) @@ -100,7 +99,7 @@ public class WizardAsView : Scenario }; // Add 1st step - var firstStep = new WizardStep { Title = "End User License Agreement" }; + WizardStep firstStep = new () { Title = "End User License Agreement" }; wizard.AddStep (firstStep); firstStep.NextButtonText = "Accept!"; @@ -108,48 +107,52 @@ public class WizardAsView : Scenario "This is the End User License Agreement.\n\n\n\n\n\nThis is a test of the emergency broadcast system. This is a test of the emergency broadcast system.\nThis is a test of the emergency broadcast system.\n\n\nThis is a test of the emergency broadcast system.\n\nThis is a test of the emergency broadcast system.\n\n\n\nThe end of the EULA."; // Add 2nd step - var secondStep = new WizardStep { Title = "Second Step" }; + WizardStep secondStep = new () { Title = "Second Step" }; wizard.AddStep (secondStep); secondStep.HelpText = "This is the help text for the Second Step.\n\nPress the button to change the Title.\n\nIf First Name is empty the step will prevent moving to the next step."; - var buttonLbl = new Label { Text = "Second Step Button: ", X = 0, Y = 0 }; + Label buttonLbl = new () { Text = "Second Step Button: ", X = 0, Y = 0 }; - var button = new Button + Button button = new () { - Text = "Press Me to Rename Step", X = Pos.Right (buttonLbl), Y = Pos.Top (buttonLbl) + Text = "Press Me to Rename Step", + X = Pos.Right (buttonLbl), + Y = Pos.Top (buttonLbl) }; button.Accepting += (s, e) => - { - secondStep.Title = "2nd Step"; + { + secondStep.Title = "2nd Step"; - MessageBox.Query ( - "Wizard Scenario", - "This Wizard Step's title was changed to '2nd Step'", - "Ok" - ); - }; + MessageBox.Query ((s as View)?.App, + "Wizard Scenario", + "This Wizard Step's title was changed to '2nd Step'", + "Ok" + ); + }; secondStep.Add (buttonLbl, button); - var lbl = new Label { Text = "First Name: ", X = Pos.Left (buttonLbl), Y = Pos.Bottom (buttonLbl) }; - var firstNameField = new TextField { Text = "Number", Width = 30, X = Pos.Right (lbl), Y = Pos.Top (lbl) }; + + Label lbl = new () { Text = "First Name: ", X = Pos.Left (buttonLbl), Y = Pos.Bottom (buttonLbl) }; + TextField firstNameField = new () { Text = "Number", Width = 30, X = Pos.Right (lbl), Y = Pos.Top (lbl) }; secondStep.Add (lbl, firstNameField); - lbl = new Label { Text = "Last Name: ", X = Pos.Left (buttonLbl), Y = Pos.Bottom (lbl) }; - var lastNameField = new TextField { Text = "Six", Width = 30, X = Pos.Right (lbl), Y = Pos.Top (lbl) }; + lbl = new () { Text = "Last Name: ", X = Pos.Left (buttonLbl), Y = Pos.Bottom (lbl) }; + TextField lastNameField = new () { Text = "Six", Width = 30, X = Pos.Right (lbl), Y = Pos.Top (lbl) }; secondStep.Add (lbl, lastNameField); // Add last step - var lastStep = new WizardStep { Title = "The last step" }; + WizardStep lastStep = new () { Title = "The last step" }; wizard.AddStep (lastStep); lastStep.HelpText = "The wizard is complete!\n\nPress the Finish button to continue.\n\nPressing Esc will cancel."; - wizard.Y = Pos.Bottom (menu); - topLevel.Add (wizard); - Application.Run (topLevel); - topLevel.Dispose (); + Window window = new (); + window.Add (menu, wizard); + + Application.Run (window); + window.Dispose (); Application.Shutdown (); } } diff --git a/Examples/UICatalog/Scenarios/Wizards.cs b/Examples/UICatalog/Scenarios/Wizards.cs index 6263093a4..c97591de3 100644 --- a/Examples/UICatalog/Scenarios/Wizards.cs +++ b/Examples/UICatalog/Scenarios/Wizards.cs @@ -1,13 +1,9 @@ -using System; -using System.Linq; - -namespace UICatalog.Scenarios; +namespace UICatalog.Scenarios; [ScenarioMetadata ("Wizards", "Demonstrates the Wizard class")] [ScenarioCategory ("Dialogs")] [ScenarioCategory ("Wizards")] [ScenarioCategory ("Runnable")] - public class Wizards : Scenario { public override void Main () @@ -85,10 +81,10 @@ public class Wizards : Scenario void Win_Loaded (object sender, EventArgs args) { frame.Height = widthEdit.Frame.Height + heightEdit.Frame.Height + titleEdit.Frame.Height + 2; - win.Loaded -= Win_Loaded; + win.IsModalChanged -= Win_Loaded; } - win.Loaded += Win_Loaded; + win.IsModalChanged += Win_Loaded; label = new () { @@ -108,267 +104,277 @@ public class Wizards : Scenario }; showWizardButton.Accepting += (s, e) => - { - try - { - var width = 0; - int.TryParse (widthEdit.Text, out width); - var height = 0; - int.TryParse (heightEdit.Text, out height); + { + try + { + var width = 0; + int.TryParse (widthEdit.Text, out width); + var height = 0; + int.TryParse (heightEdit.Text, out height); - if (width < 1 || height < 1) - { - MessageBox.ErrorQuery ( - "Nope", - "Height and width must be greater than 0 (much bigger)", - "Ok" - ); + if (width < 1 || height < 1) + { + MessageBox.ErrorQuery ( + (s as View)?.App, + "Nope", + "Height and width must be greater than 0 (much bigger)", + "Ok" + ); - return; - } + return; + } - actionLabel.Text = string.Empty; + actionLabel.Text = string.Empty; - var wizard = new Wizard { Title = titleEdit.Text, Width = width, Height = height }; + var wizard = new Wizard { Title = titleEdit.Text, Width = width, Height = height }; - wizard.MovingBack += (s, args) => - { - //args.Cancel = true; - actionLabel.Text = "Moving Back"; - }; + wizard.MovingBack += (s, args) => + { + //args.Cancel = true; + actionLabel.Text = "Moving Back"; + }; - wizard.MovingNext += (s, args) => - { - //args.Cancel = true; - actionLabel.Text = "Moving Next"; - }; + wizard.MovingNext += (s, args) => + { + //args.Cancel = true; + actionLabel.Text = "Moving Next"; + }; - wizard.Finished += (s, args) => - { - //args.Cancel = true; - actionLabel.Text = "Finished"; - }; + wizard.Finished += (s, args) => + { + //args.Cancel = true; + actionLabel.Text = "Finished"; + }; - wizard.Cancelled += (s, args) => - { - //args.Cancel = true; - actionLabel.Text = "Cancelled"; - }; - - // Add 1st step - var firstStep = new WizardStep { Title = "End User License Agreement" }; - firstStep.NextButtonText = "Accept!"; - - firstStep.HelpText = - "This is the End User License Agreement.\n\n\n\n\n\nThis is a test of the emergency broadcast system. This is a test of the emergency broadcast system.\nThis is a test of the emergency broadcast system.\n\n\nThis is a test of the emergency broadcast system.\n\nThis is a test of the emergency broadcast system.\n\n\n\nThe end of the EULA."; - - OptionSelector optionSelector = new () - { - Labels = ["_One", "_Two", "_3"] - }; - firstStep.Add (optionSelector); - - wizard.AddStep (firstStep); - - // Add 2nd step - var secondStep = new WizardStep { Title = "Second Step" }; - wizard.AddStep (secondStep); - - secondStep.HelpText = - "This is the help text for the Second Step.\n\nPress the button to change the Title.\n\nIf First Name is empty the step will prevent moving to the next step."; - - var buttonLbl = new Label { Text = "Second Step Button: ", X = 1, Y = 1 }; - - var button = new Button - { - Text = "Press Me to Rename Step", X = Pos.Right (buttonLbl), Y = Pos.Top (buttonLbl) - }; - - OptionSelector optionSelecor2 = new () - { - Labels = ["_A", "_B", "_C"], - Orientation = Orientation.Horizontal - }; - secondStep.Add (optionSelecor2); - - button.Accepting += (s, e) => - { - secondStep.Title = "2nd Step"; - - MessageBox.Query ( - "Wizard Scenario", - "This Wizard Step's title was changed to '2nd Step'" - ); - }; - secondStep.Add (buttonLbl, button); - var lbl = new Label { Text = "First Name: ", X = 1, Y = Pos.Bottom (buttonLbl) }; - - var firstNameField = - new TextField { Text = "Number", Width = 30, X = Pos.Right (lbl), Y = Pos.Top (lbl) }; - secondStep.Add (lbl, firstNameField); - lbl = new () { Text = "Last Name: ", X = 1, Y = Pos.Bottom (lbl) }; - var lastNameField = new TextField { Text = "Six", Width = 30, X = Pos.Right (lbl), Y = Pos.Top (lbl) }; - secondStep.Add (lbl, lastNameField); - - var thirdStepEnabledCeckBox = new CheckBox - { - Text = "Enable Step _3", - CheckedState = CheckState.UnChecked, - X = Pos.Left (lastNameField), - Y = Pos.Bottom (lastNameField) - }; - secondStep.Add (thirdStepEnabledCeckBox); - - // Add a frame - var frame = new FrameView - { - X = 0, - Y = Pos.Bottom (thirdStepEnabledCeckBox) + 2, - Width = Dim.Fill (), - Height = 4, - Title = "A Broken Frame (by Depeche Mode)", - TabStop = TabBehavior.NoStop - }; - frame.Add (new TextField { Text = "This is a TextField inside of the frame." }); - secondStep.Add (frame); - - wizard.StepChanging += (s, args) => + wizard.Cancelled += (s, args) => { - if (args.OldStep == secondStep && string.IsNullOrEmpty (firstNameField.Text)) - { - args.Cancel = true; - - int btn = MessageBox.ErrorQuery ( - "Second Step", - "You must enter a First Name to continue", - "Ok" - ); - } + //args.Cancel = true; + actionLabel.Text = "Cancelled"; }; - // Add 3rd (optional) step - var thirdStep = new WizardStep { Title = "Third Step (Optional)" }; - wizard.AddStep (thirdStep); + // Add 1st step + var firstStep = new WizardStep { Title = "End User License Agreement" }; + firstStep.NextButtonText = "Accept!"; - thirdStep.HelpText = - "This is step is optional (WizardStep.Enabled = false). Enable it with the checkbox in Step 2."; - var step3Label = new Label { Text = "This step is optional.", X = 0, Y = 0 }; - thirdStep.Add (step3Label); - var progLbl = new Label { Text = "Third Step ProgressBar: ", X = 1, Y = 10 }; + firstStep.HelpText = + "This is the End User License Agreement.\n\n\n\n\n\nThis is a test of the emergency broadcast system. This is a test of the emergency broadcast system.\nThis is a test of the emergency broadcast system.\n\n\nThis is a test of the emergency broadcast system.\n\nThis is a test of the emergency broadcast system.\n\n\n\nThe end of the EULA."; - var progressBar = new ProgressBar - { - X = Pos.Right (progLbl), Y = Pos.Top (progLbl), Width = 40, Fraction = 0.42F - }; - thirdStep.Add (progLbl, progressBar); - thirdStep.Enabled = thirdStepEnabledCeckBox.CheckedState == CheckState.Checked; - thirdStepEnabledCeckBox.CheckedStateChanged += (s, e) => { thirdStep.Enabled = thirdStepEnabledCeckBox.CheckedState == CheckState.Checked; }; + OptionSelector optionSelector = new () + { + Labels = ["_One", "_Two", "_3"] + }; + firstStep.Add (optionSelector); - // Add 4th step - var fourthStep = new WizardStep { Title = "Step Four" }; - wizard.AddStep (fourthStep); + wizard.AddStep (firstStep); - var someText = new TextView - { - Text = - "This step (Step Four) shows how to show/hide the Help pane. The step contains this TextView (but it's hard to tell it's a TextView because of Issue #1800).", - X = 0, - Y = 0, - Width = Dim.Fill (), - WordWrap = true, - AllowsTab = false, - SchemeName = "Base" - }; + // Add 2nd step + var secondStep = new WizardStep { Title = "Second Step" }; + wizard.AddStep (secondStep); - someText.Height = Dim.Fill ( - Dim.Func ( - v => someText.SuperView is { IsInitialized: true } - ? someText.SuperView.SubViews - .First (view => view.Y.Has (out _)) - .Frame.Height - : 1)); - var help = "This is helpful."; - fourthStep.Add (someText); + secondStep.HelpText = + "This is the help text for the Second Step.\n\nPress the button to change the Title.\n\nIf First Name is empty the step will prevent moving to the next step."; - var hideHelpBtn = new Button - { - Text = "Press me to show/hide help", - X = Pos.Center (), - Y = Pos.AnchorEnd () - }; + var buttonLbl = new Label { Text = "Second Step Button: ", X = 1, Y = 1 }; - hideHelpBtn.Accepting += (s, e) => - { - if (fourthStep.HelpText.Length > 0) + var button = new Button + { + Text = "Press Me to Rename Step", X = Pos.Right (buttonLbl), Y = Pos.Top (buttonLbl) + }; + + OptionSelector optionSelecor2 = new () + { + Labels = ["_A", "_B", "_C"], + Orientation = Orientation.Horizontal + }; + secondStep.Add (optionSelecor2); + + button.Accepting += (s, e) => + { + secondStep.Title = "2nd Step"; + + MessageBox.Query ( + (s as View)?.App, + "Wizard Scenario", + "This Wizard Step's title was changed to '2nd Step'" + ); + }; + secondStep.Add (buttonLbl, button); + var lbl = new Label { Text = "First Name: ", X = 1, Y = Pos.Bottom (buttonLbl) }; + + var firstNameField = + new TextField { Text = "Number", Width = 30, X = Pos.Right (lbl), Y = Pos.Top (lbl) }; + secondStep.Add (lbl, firstNameField); + lbl = new () { Text = "Last Name: ", X = 1, Y = Pos.Bottom (lbl) }; + var lastNameField = new TextField { Text = "Six", Width = 30, X = Pos.Right (lbl), Y = Pos.Top (lbl) }; + secondStep.Add (lbl, lastNameField); + + var thirdStepEnabledCeckBox = new CheckBox + { + Text = "Enable Step _3", + CheckedState = CheckState.UnChecked, + X = Pos.Left (lastNameField), + Y = Pos.Bottom (lastNameField) + }; + secondStep.Add (thirdStepEnabledCeckBox); + + // Add a frame + var frame = new FrameView + { + X = 0, + Y = Pos.Bottom (thirdStepEnabledCeckBox) + 2, + Width = Dim.Fill (), + Height = 4, + Title = "A Broken Frame (by Depeche Mode)", + TabStop = TabBehavior.NoStop + }; + frame.Add (new TextField { Text = "This is a TextField inside of the frame." }); + secondStep.Add (frame); + + wizard.StepChanging += (s, args) => { - fourthStep.HelpText = string.Empty; - } - else - { - fourthStep.HelpText = help; - } - }; - fourthStep.Add (hideHelpBtn); - fourthStep.NextButtonText = "_Go To Last Step"; - //var scrollBar = new ScrollBarView (someText, true); + if (args.OldStep == secondStep && string.IsNullOrEmpty (firstNameField.Text)) + { + args.Cancel = true; - //scrollBar.ChangedPosition += (s, e) => - // { - // someText.TopRow = scrollBar.Position; + int? btn = MessageBox.ErrorQuery ( + (s as View)?.App, + "Second Step", + "You must enter a First Name to continue", + "Ok" + ); + } + }; - // if (someText.TopRow != scrollBar.Position) - // { - // scrollBar.Position = someText.TopRow; - // } + // Add 3rd (optional) step + var thirdStep = new WizardStep { Title = "Third Step (Optional)" }; + wizard.AddStep (thirdStep); - // someText.SetNeedsDraw (); - // }; + thirdStep.HelpText = + "This is step is optional (WizardStep.Enabled = false). Enable it with the checkbox in Step 2."; + var step3Label = new Label { Text = "This step is optional.", X = 0, Y = 0 }; + thirdStep.Add (step3Label); + var progLbl = new Label { Text = "Third Step ProgressBar: ", X = 1, Y = 10 }; - //someText.DrawingContent += (s, e) => - // { - // scrollBar.Size = someText.Lines; - // scrollBar.Position = someText.TopRow; + var progressBar = new ProgressBar + { + X = Pos.Right (progLbl), Y = Pos.Top (progLbl), Width = 40, Fraction = 0.42F + }; + thirdStep.Add (progLbl, progressBar); + thirdStep.Enabled = thirdStepEnabledCeckBox.CheckedState == CheckState.Checked; - // if (scrollBar.OtherScrollBarView != null) - // { - // scrollBar.OtherScrollBarView.Size = someText.Maxlength; - // scrollBar.OtherScrollBarView.Position = someText.LeftColumn; - // } - // }; - //fourthStep.Add (scrollBar); + thirdStepEnabledCeckBox.CheckedStateChanged += (s, e) => + { + thirdStep.Enabled = + thirdStepEnabledCeckBox.CheckedState == CheckState.Checked; + }; - // Add last step - var lastStep = new WizardStep { Title = "The last step" }; - wizard.AddStep (lastStep); + // Add 4th step + var fourthStep = new WizardStep { Title = "Step Four" }; + wizard.AddStep (fourthStep); - lastStep.HelpText = - "The wizard is complete!\n\nPress the Finish button to continue.\n\nPressing ESC will cancel the wizard."; + var someText = new TextView + { + Text = + "This step (Step Four) shows how to show/hide the Help pane. The step contains this TextView (but it's hard to tell it's a TextView because of Issue #1800).", + X = 0, + Y = 0, + Width = Dim.Fill (), + WordWrap = true, + AllowsTab = false, + SchemeName = "Base" + }; - var finalFinalStepEnabledCeckBox = - new CheckBox { Text = "Enable _Final Final Step", CheckedState = CheckState.UnChecked, X = 0, Y = 1 }; - lastStep.Add (finalFinalStepEnabledCeckBox); + someText.Height = Dim.Fill ( + Dim.Func (v => someText.SuperView is { IsInitialized: true } + ? someText.SuperView.SubViews + .First (view => view.Y.Has (out _)) + .Frame.Height + : 1)); + var help = "This is helpful."; + fourthStep.Add (someText); - // Add an optional FINAL last step - var finalFinalStep = new WizardStep { Title = "The VERY last step" }; - wizard.AddStep (finalFinalStep); + var hideHelpBtn = new Button + { + Text = "Press me to show/hide help", + X = Pos.Center (), + Y = Pos.AnchorEnd () + }; - finalFinalStep.HelpText = - "This step only shows if it was enabled on the other last step."; - finalFinalStep.Enabled = thirdStepEnabledCeckBox.CheckedState == CheckState.Checked; + hideHelpBtn.Accepting += (s, e) => + { + if (fourthStep.HelpText.Length > 0) + { + fourthStep.HelpText = string.Empty; + } + else + { + fourthStep.HelpText = help; + } + }; + fourthStep.Add (hideHelpBtn); + fourthStep.NextButtonText = "_Go To Last Step"; - finalFinalStepEnabledCeckBox.CheckedStateChanged += (s, e) => - { - finalFinalStep.Enabled = finalFinalStepEnabledCeckBox.CheckedState == CheckState.Checked; - }; + //var scrollBar = new ScrollBarView (someText, true); - Application.Run (wizard); - wizard.Dispose (); - } - catch (FormatException) - { - actionLabel.Text = "Invalid Options"; - } - }; + //scrollBar.ChangedPosition += (s, e) => + // { + // someText.TopRow = scrollBar.Position; + + // if (someText.TopRow != scrollBar.Position) + // { + // scrollBar.Position = someText.TopRow; + // } + + // someText.SetNeedsDraw (); + // }; + + //someText.DrawingContent += (s, e) => + // { + // scrollBar.Size = someText.Lines; + // scrollBar.Position = someText.TopRow; + + // if (scrollBar.OtherScrollBarView != null) + // { + // scrollBar.OtherScrollBarView.Size = someText.Maxlength; + // scrollBar.OtherScrollBarView.Position = someText.LeftColumn; + // } + // }; + //fourthStep.Add (scrollBar); + + // Add last step + var lastStep = new WizardStep { Title = "The last step" }; + wizard.AddStep (lastStep); + + lastStep.HelpText = + "The wizard is complete!\n\nPress the Finish button to continue.\n\nPressing ESC will cancel the wizard."; + + var finalFinalStepEnabledCeckBox = + new CheckBox { Text = "Enable _Final Final Step", CheckedState = CheckState.UnChecked, X = 0, Y = 1 }; + lastStep.Add (finalFinalStepEnabledCeckBox); + + // Add an optional FINAL last step + var finalFinalStep = new WizardStep { Title = "The VERY last step" }; + wizard.AddStep (finalFinalStep); + + finalFinalStep.HelpText = + "This step only shows if it was enabled on the other last step."; + finalFinalStep.Enabled = thirdStepEnabledCeckBox.CheckedState == CheckState.Checked; + + finalFinalStepEnabledCeckBox.CheckedStateChanged += (s, e) => + { + finalFinalStep.Enabled = + finalFinalStepEnabledCeckBox.CheckedState + == CheckState.Checked; + }; + + Application.Run (wizard); + wizard.Dispose (); + } + catch (FormatException) + { + actionLabel.Text = "Invalid Options"; + } + }; win.Add (showWizardButton); Application.Run (win); @@ -376,8 +382,5 @@ public class Wizards : Scenario Application.Shutdown (); } - private void Wizard_StepChanged (object sender, StepChangeEventArgs e) - { - throw new NotImplementedException (); - } + private void Wizard_StepChanged (object sender, StepChangeEventArgs e) { throw new NotImplementedException (); } } diff --git a/Examples/UICatalog/UICatalog.cs b/Examples/UICatalog/UICatalog.cs index 6f7a37139..21634ac0b 100644 --- a/Examples/UICatalog/UICatalog.cs +++ b/Examples/UICatalog/UICatalog.cs @@ -55,7 +55,9 @@ namespace UICatalog; /// public class UICatalog { - private static string? _forceDriver = null; + private static string? _forceDriver; + private static string? _uiCatalogDriver; + private static string? _scenarioDriver; public static string LogFilePath { get; set; } = string.Empty; public static LoggingLevelSwitch LogLevelSwitch { get; } = new (); @@ -71,8 +73,8 @@ public class UICatalog CultureInfo.DefaultThreadCurrentUICulture = CultureInfo.GetCultureInfo ("en-US"); } - UICatalogTop.CachedScenarios = Scenario.GetScenarios (); - UICatalogTop.CachedCategories = Scenario.GetAllCategories (); + UICatalogRunnable.CachedScenarios = Scenario.GetScenarios (); + UICatalogRunnable.CachedCategories = Scenario.GetAllCategories (); // Process command line args @@ -134,7 +136,7 @@ public class UICatalog "The name of the Scenario to run. If not provided, the UI Catalog UI will be shown.", getDefaultValue: () => "none" ).FromAmong ( - UICatalogTop.CachedScenarios.Select (s => s.GetName ()) + UICatalogRunnable.CachedScenarios.Select (s => s.GetName ()) .Append ("none") .ToArray () ); @@ -194,6 +196,8 @@ public class UICatalog UICatalogMain (Options); + Debug.Assert (Application.ForceDriver == string.Empty); + return 0; } @@ -242,10 +246,10 @@ public class UICatalog /// /// Shows the UI Catalog selection UI. When the user selects a Scenario to run, the UI Catalog main app UI is - /// killed and the Scenario is run as though it were Application.Top. When the Scenario exits, this function exits. + /// killed and the Scenario is run as though it were Application.TopRunnable. When the Scenario exits, this function exits. /// /// - private static Scenario RunUICatalogTopLevel () + private static Scenario RunUICatalogRunnable () { // Run UI Catalog UI. When it exits, if _selectedScenario is != null then // a Scenario was selected. Otherwise, the user wants to quit UI Catalog. @@ -255,12 +259,13 @@ public class UICatalog Application.Init (driverName: _forceDriver); - var top = Application.Run (); - top.Dispose (); + _uiCatalogDriver = Application.Driver!.GetName (); + + Application.Run (); Application.Shutdown (); VerifyObjectsWereDisposed (); - return UICatalogTop.CachedSelectedScenario!; + return UICatalogRunnable.CachedSelectedScenario!; } [SuppressMessage ("Style", "IDE1006:Naming Styles", Justification = "")] @@ -269,7 +274,7 @@ public class UICatalog [SuppressMessage ("Style", "IDE1006:Naming Styles", Justification = "")] private static readonly FileSystemWatcher _homeDirWatcher = new (); - private static void StartConfigFileWatcher () + private static void StartConfigWatcher () { // Set up a file system watcher for `./.tui/` _currentDirWatcher.NotifyFilter = NotifyFilters.LastWrite; @@ -317,10 +322,19 @@ public class UICatalog //_homeDirWatcher.Created += ConfigFileChanged; _homeDirWatcher.EnableRaisingEvents = true; + + ThemeManager.ThemeChanged += ThemeManagerOnThemeChanged; } - private static void StopConfigFileWatcher () + private static void ThemeManagerOnThemeChanged (object? sender, EventArgs e) { + CM.Apply (); + } + + private static void StopConfigWatcher () + { + ThemeManager.ThemeChanged += ThemeManagerOnThemeChanged; + _currentDirWatcher.EnableRaisingEvents = false; _currentDirWatcher.Changed -= ConfigFileChanged; _currentDirWatcher.Created -= ConfigFileChanged; @@ -332,7 +346,7 @@ public class UICatalog private static void ConfigFileChanged (object sender, FileSystemEventArgs e) { - if (Application.Top == null) + if (Application.TopRunnableView == null) { return; } @@ -357,15 +371,15 @@ public class UICatalog ConfigurationManager.Enable (ConfigLocations.All); } - int item = UICatalogTop.CachedScenarios!.IndexOf ( - UICatalogTop.CachedScenarios!.FirstOrDefault ( + int item = UICatalogRunnable.CachedScenarios!.IndexOf ( + UICatalogRunnable.CachedScenarios!.FirstOrDefault ( s => s.GetName () .Equals (options.Scenario, StringComparison.OrdinalIgnoreCase) )!); - UICatalogTop.CachedSelectedScenario = (Scenario)Activator.CreateInstance (UICatalogTop.CachedScenarios [item].GetType ())!; + UICatalogRunnable.CachedSelectedScenario = (Scenario)Activator.CreateInstance (UICatalogRunnable.CachedScenarios [item].GetType ())!; - BenchmarkResults? results = RunScenario (UICatalogTop.CachedSelectedScenario, options.Benchmark); + BenchmarkResults? results = RunScenario (UICatalogRunnable.CachedSelectedScenario, options.Benchmark); if (results is { }) { @@ -398,10 +412,10 @@ public class UICatalog if (!Options.DontEnableConfigurationManagement) { ConfigurationManager.Enable (ConfigLocations.All); - StartConfigFileWatcher (); + StartConfigWatcher (); } - while (RunUICatalogTopLevel () is { } scenario) + while (RunUICatalogRunnable () is { } scenario) { #if DEBUG_IDISPOSABLE VerifyObjectsWereDisposed (); @@ -412,6 +426,8 @@ public class UICatalog Application.InitializedChanged += ApplicationOnInitializedChanged; #endif + Application.ForceDriver = _forceDriver; + scenario.Main (); scenario.Dispose (); @@ -430,6 +446,8 @@ public class UICatalog if (e.Value) { sw.Start (); + _scenarioDriver = Application.Driver!.GetName (); + Debug.Assert (_scenarioDriver == _uiCatalogDriver); } else { @@ -440,7 +458,7 @@ public class UICatalog #endif } - StopConfigFileWatcher (); + StopConfigWatcher (); VerifyObjectsWereDisposed (); } @@ -476,7 +494,7 @@ public class UICatalog var maxScenarios = 5; - foreach (Scenario s in UICatalogTop.CachedScenarios!) + foreach (Scenario s in UICatalogRunnable.CachedScenarios!) { resultsList.Add (RunScenario (s, true)!); maxScenarios--; @@ -635,7 +653,6 @@ public class UICatalog if (!View.EnableDebugIDisposableAsserts) { View.Instances.Clear (); - SessionToken.Instances.Clear (); return; } @@ -649,16 +666,6 @@ public class UICatalog } View.Instances.Clear (); - - // Validate there are no outstanding Application sessions - // after a scenario was selected to run. This proves the main UI Catalog - // 'app' closed cleanly. - foreach (SessionToken? inst in SessionToken.Instances) - { - Debug.Assert (inst.WasDisposed); - } - - SessionToken.Instances.Clear (); #endif } } diff --git a/Examples/UICatalog/UICatalog.csproj b/Examples/UICatalog/UICatalog.csproj index 0b529c499..88e916f9c 100644 --- a/Examples/UICatalog/UICatalog.csproj +++ b/Examples/UICatalog/UICatalog.csproj @@ -49,4 +49,5 @@ + \ No newline at end of file diff --git a/Examples/UICatalog/UICatalogTop.cs b/Examples/UICatalog/UICatalogRunnable.cs similarity index 92% rename from Examples/UICatalog/UICatalogTop.cs rename to Examples/UICatalog/UICatalogRunnable.cs index afec138a8..a163edab6 100644 --- a/Examples/UICatalog/UICatalogTop.cs +++ b/Examples/UICatalog/UICatalogRunnable.cs @@ -14,7 +14,7 @@ namespace UICatalog; /// This is the main UI Catalog app view. It is run fresh when the app loads (if a Scenario has not been passed on /// the command line) and each time a Scenario ends. /// -public class UICatalogTop : Toplevel +public class UICatalogRunnable : Runnable { // When a scenario is run, the main app is killed. The static // members are cached so that when the scenario exits the @@ -23,12 +23,12 @@ public class UICatalogTop : Toplevel // Note, we used to pass this to scenarios that run, but it just added complexity // So that was removed. But we still have this here to demonstrate how changing // the scheme works. - public static string? CachedTopLevelScheme { get; set; } + public static string? CachedRunnableScheme { get; set; } // Diagnostics private static ViewDiagnosticFlags _diagnosticFlags; - public UICatalogTop () + public UICatalogRunnable () { _diagnosticFlags = Diagnostics; @@ -39,22 +39,31 @@ public class UICatalogTop : Toplevel Add (_menuBar, _categoryList, _scenarioList, _statusBar); - Loaded += LoadedHandler; - Unloaded += UnloadedHandler; + IsModalChanged += IsModalChangedHandler; + IsRunningChanged += IsRunningChangedHandler; // Restore previous selections - _categoryList.SelectedItem = _cachedCategoryIndex; + if (_categoryList.Source?.Count > 0) { + _categoryList.SelectedItem = _cachedCategoryIndex ?? 0; + } else { + _categoryList.SelectedItem = null; + } _scenarioList.SelectedRow = _cachedScenarioIndex; - SchemeName = CachedTopLevelScheme = SchemeManager.SchemesToSchemeName (Schemes.Base); + SchemeName = CachedRunnableScheme = SchemeManager.SchemesToSchemeName (Schemes.Base); ConfigurationManager.Applied += ConfigAppliedHandler; } private static bool _isFirstRunning = true; - private void LoadedHandler (object? sender, EventArgs? args) + private void IsModalChangedHandler (object? sender, EventArgs args) { + if (!args.Value) + { + return; + } + if (_disableMouseCb is { }) { _disableMouseCb.CheckedState = Application.IsMouseDisabled ? CheckState.Checked : CheckState.UnChecked; @@ -81,20 +90,23 @@ public class UICatalogTop : Toplevel _statusBar.VisibleChanged += (s, e) => { ShowStatusBar = _statusBar.Visible; }; } - Loaded -= LoadedHandler; + IsModalChanged -= IsModalChangedHandler; _categoryList!.EnsureSelectedItemVisible (); _scenarioList.EnsureSelectedCellIsVisible (); } - private void UnloadedHandler (object? sender, EventArgs? args) + private void IsRunningChangedHandler (object? sender, EventArgs args) { - ConfigurationManager.Applied -= ConfigAppliedHandler; - Unloaded -= UnloadedHandler; + if (!args.Value) + { + ConfigurationManager.Applied -= ConfigAppliedHandler; + IsRunningChanged -= IsRunningChangedHandler; + } } #region MenuBar - private readonly MenuBarv2? _menuBar; + private readonly MenuBar? _menuBar; private CheckBox? _force16ColorsMenuItemCb; private OptionSelector? _themesSelector; private OptionSelector? _topSchemesSelector; @@ -102,14 +114,14 @@ public class UICatalogTop : Toplevel private FlagSelector? _diagnosticFlagsSelector; private CheckBox? _disableMouseCb; - private MenuBarv2 CreateMenuBar () + private MenuBar CreateMenuBar () { - MenuBarv2 menuBar = new ( + MenuBar menuBar = new ( [ new ( "_File", [ - new MenuItemv2 () + new MenuItem () { Title ="_Quit", HelpText = "Quit UI Catalog", @@ -124,22 +136,23 @@ public class UICatalogTop : Toplevel new ( "_Help", [ - new MenuItemv2 ( + new MenuItem ( "_Documentation", "API docs", () => OpenUrl ("https://gui-cs.github.io/Terminal.Gui"), Key.F1 ), - new MenuItemv2 ( + new MenuItem ( "_README", "Project readme", () => OpenUrl ("https://github.com/gui-cs/Terminal.Gui"), Key.F2 ), - new MenuItemv2 ( + new MenuItem ( "_About...", "About UI Catalog", () => MessageBox.Query ( + App, "", GetAboutBoxMessage (), wrapMessage: false, @@ -188,7 +201,7 @@ public class UICatalogTop : Toplevel }; menuItems.Add ( - new MenuItemv2 + new MenuItem { CommandView = _force16ColorsMenuItemCb }); @@ -211,9 +224,10 @@ public class UICatalogTop : Toplevel return; } ThemeManager.Theme = ThemeManager.GetThemeNames () [(int)args.Value]; + }; - var menuItem = new MenuItemv2 + var menuItem = new MenuItem { CommandView = _themesSelector, HelpText = "Cycle Through Themes", @@ -234,14 +248,14 @@ public class UICatalogTop : Toplevel { return; } - CachedTopLevelScheme = SchemeManager.GetSchemesForCurrentTheme ()!.Keys.ToArray () [(int)args.Value]; - SchemeName = CachedTopLevelScheme; + CachedRunnableScheme = SchemeManager.GetSchemesForCurrentTheme ()!.Keys.ToArray () [(int)args.Value]; + SchemeName = CachedRunnableScheme; SetNeedsDraw (); }; menuItem = new () { - Title = "Scheme for Toplevel", + Title = "Scheme for Runnable", SubMenu = new ( [ new () @@ -258,7 +272,7 @@ public class UICatalogTop : Toplevel } else { - menuItems.Add (new MenuItemv2 () + menuItems.Add (new MenuItem () { Title = "Configuration Manager is not Enabled", Enabled = false @@ -288,7 +302,7 @@ public class UICatalogTop : Toplevel }; menuItems.Add ( - new MenuItemv2 + new MenuItem { CommandView = _diagnosticFlagsSelector, HelpText = "View Diagnostics" @@ -308,7 +322,7 @@ public class UICatalogTop : Toplevel _disableMouseCb.CheckedStateChanged += (_, args) => { Application.IsMouseDisabled = args.Value == CheckState.Checked; }; menuItems.Add ( - new MenuItemv2 + new MenuItem { CommandView = _disableMouseCb, HelpText = "Disable Mouse" @@ -340,7 +354,7 @@ public class UICatalogTop : Toplevel }; menuItems.Add ( - new MenuItemv2 + new MenuItem { CommandView = _logLevelSelector, HelpText = "Cycle Through Log Levels", @@ -351,7 +365,7 @@ public class UICatalogTop : Toplevel menuItems.Add (new Line ()); menuItems.Add ( - new MenuItemv2 ( + new MenuItem ( "_Open Log Folder", string.Empty, () => OpenUrl (UICatalog.LOGFILE_LOCATION) @@ -386,12 +400,12 @@ public class UICatalogTop : Toplevel _topSchemesSelector.Labels = SchemeManager.GetSchemeNames ().ToArray (); _topSchemesSelector.Value = selectedScheme; - if (CachedTopLevelScheme is null || !SchemeManager.GetSchemeNames ().Contains (CachedTopLevelScheme)) + if (CachedRunnableScheme is null || !SchemeManager.GetSchemeNames ().Contains (CachedRunnableScheme)) { - CachedTopLevelScheme = SchemeManager.SchemesToSchemeName (Schemes.Base); + CachedRunnableScheme = SchemeManager.SchemesToSchemeName (Schemes.Base); } - int newSelectedItem = SchemeManager.GetSchemeNames ().IndexOf (CachedTopLevelScheme!); + int newSelectedItem = SchemeManager.GetSchemeNames ().IndexOf (CachedRunnableScheme!); // if the item is in bounds then select it if (newSelectedItem >= 0 && newSelectedItem < SchemeManager.GetSchemeNames ().Count) { @@ -509,7 +523,7 @@ public class UICatalogTop : Toplevel #region Category List private readonly ListView? _categoryList; - private static int _cachedCategoryIndex; + private static int? _cachedCategoryIndex; public static ObservableCollection? CachedCategories { get; set; } private ListView CreateCategoryList () @@ -539,7 +553,11 @@ public class UICatalogTop : Toplevel private void CategoryView_SelectedChanged (object? sender, ListViewItemEventArgs? e) { - string item = CachedCategories! [e!.Item]; + if (e is null or { Item: null }) + { + return; + } + string item = CachedCategories! [e.Item.Value]; ObservableCollection newScenarioList; if (e.Item == 0) @@ -676,7 +694,7 @@ public class UICatalogTop : Toplevel { UpdateThemesMenu (); - SchemeName = CachedTopLevelScheme; + SchemeName = CachedRunnableScheme; if (_shQuit is { }) { @@ -691,7 +709,7 @@ public class UICatalogTop : Toplevel _disableMouseCb!.CheckedState = Application.IsMouseDisabled ? CheckState.Checked : CheckState.UnChecked; _force16ColorsShortcutCb!.CheckedState = Application.Force16Colors ? CheckState.Checked : CheckState.UnChecked; - Application.Top?.SetNeedsDraw (); + Application.TopRunnableView?.SetNeedsDraw (); } private void ConfigAppliedHandler (object? sender, ConfigurationManagerEventArgs? a) { ConfigApplied (); } diff --git a/NULLABLE_VIEWS_REMAINING.md b/NULLABLE_VIEWS_REMAINING.md new file mode 100644 index 000000000..220e6933f --- /dev/null +++ b/NULLABLE_VIEWS_REMAINING.md @@ -0,0 +1,163 @@ +# View Subclasses Still With `#nullable disable` + +This document lists all View-related files in the `/Views` directory that still have `#nullable disable` set. + +**Total**: 121 files + +## Breakdown by Subdirectory + +### Autocomplete (8 files) +- Autocomplete/AppendAutocomplete.cs +- Autocomplete/AutocompleteBase.cs +- Autocomplete/AutocompleteContext.cs +- Autocomplete/AutocompleteFilepathContext.cs +- Autocomplete/IAutocomplete.cs +- Autocomplete/ISuggestionGenerator.cs +- Autocomplete/SingleWordSuggestionGenerator.cs +- Autocomplete/Suggestion.cs + +### CollectionNavigation (7 files) +- CollectionNavigation/CollectionNavigator.cs +- CollectionNavigation/CollectionNavigatorBase.cs +- CollectionNavigation/DefaultCollectionNavigatorMatcher.cs +- CollectionNavigation/ICollectionNavigator.cs +- CollectionNavigation/ICollectionNavigatorMatcher.cs +- CollectionNavigation/IListCollectionNavigator.cs +- CollectionNavigation/TableCollectionNavigator.cs + +### Color/ColorPicker (13 files) +- Color/BBar.cs +- Color/ColorBar.cs +- Color/ColorModelStrategy.cs +- Color/ColorPicker.16.cs +- Color/ColorPicker.Prompt.cs +- Color/ColorPicker.Style.cs +- Color/ColorPicker.cs +- Color/GBar.cs +- Color/HueBar.cs +- Color/IColorBar.cs +- Color/LightnessBar.cs +- Color/RBar.cs +- Color/SaturationBar.cs +- Color/ValueBar.cs + +### FileDialogs (10 files) +- FileDialogs/AllowedType.cs +- FileDialogs/DefaultFileOperations.cs +- FileDialogs/FileDialogCollectionNavigator.cs +- FileDialogs/FileDialogHistory.cs +- FileDialogs/FileDialogState.cs +- FileDialogs/FileDialogStyle.cs +- FileDialogs/FileDialogTableSource.cs +- FileDialogs/FilesSelectedEventArgs.cs +- FileDialogs/OpenDialog.cs +- FileDialogs/OpenMode.cs +- FileDialogs/SaveDialog.cs + +### GraphView (9 files) +- GraphView/Axis.cs +- GraphView/BarSeriesBar.cs +- GraphView/GraphCellToRender.cs +- GraphView/GraphView.cs +- GraphView/IAnnotation.cs +- GraphView/LegendAnnotation.cs +- GraphView/LineF.cs +- GraphView/PathAnnotation.cs +- GraphView/TextAnnotation.cs + +### Menu (3 files) +- Menu/MenuBarv2.cs +- Menu/Menuv2.cs +- Menu/PopoverMenu.cs + +### Menuv1 (4 files) +- Menuv1/MenuClosingEventArgs.cs +- Menuv1/MenuItemCheckStyle.cs +- Menuv1/MenuOpenedEventArgs.cs +- Menuv1/MenuOpeningEventArgs.cs + +### ScrollBar (2 files) +- ScrollBar/ScrollBar.cs +- ScrollBar/ScrollSlider.cs + +### Selectors (2 files) +- Selectors/FlagSelector.cs +- Selectors/SelectorStyles.cs + +### Slider (9 files) +- Slider/Slider.cs +- Slider/SliderAttributes.cs +- Slider/SliderConfiguration.cs +- Slider/SliderEventArgs.cs +- Slider/SliderOption.cs +- Slider/SliderOptionEventArgs.cs +- Slider/SliderStyle.cs +- Slider/SliderType.cs + +### SpinnerView (2 files) +- SpinnerView/SpinnerStyle.cs +- SpinnerView/SpinnerView.cs + +### TabView (4 files) +- TabView/Tab.cs +- TabView/TabChangedEventArgs.cs +- TabView/TabMouseEventArgs.cs +- TabView/TabStyle.cs + +### TableView (18 files) +- TableView/CellActivatedEventArgs.cs +- TableView/CellColorGetterArgs.cs +- TableView/CellToggledEventArgs.cs +- TableView/CheckBoxTableSourceWrapper.cs +- TableView/CheckBoxTableSourceWrapperByIndex.cs +- TableView/CheckBoxTableSourceWrapperByObject.cs +- TableView/ColumnStyle.cs +- TableView/DataTableSource.cs +- TableView/EnumerableTableSource.cs +- TableView/IEnumerableTableSource.cs +- TableView/ITableSource.cs +- TableView/ListColumnStyle.cs +- TableView/ListTableSource.cs +- TableView/RowColorGetterArgs.cs +- TableView/SelectedCellChangedEventArgs.cs +- TableView/TableSelection.cs +- TableView/TableStyle.cs +- TableView/TableView.cs +- TableView/TreeTableSource.cs + +### TextInput (11 files) +- TextInput/ContentsChangedEventArgs.cs +- TextInput/DateField.cs +- TextInput/HistoryTextItemEventArgs.cs +- TextInput/ITextValidateProvider.cs +- TextInput/NetMaskedTextProvider.cs +- TextInput/TextEditingLineStatus.cs +- TextInput/TextField.cs +- TextInput/TextRegexProvider.cs +- TextInput/TextValidateField.cs +- TextInput/TimeField.cs + +### TreeView (14 files) +- TreeView/AspectGetterDelegate.cs +- TreeView/Branch.cs +- TreeView/DelegateTreeBuilder.cs +- TreeView/DrawTreeViewLineEventArgs.cs +- TreeView/ITreeBuilder.cs +- TreeView/ITreeViewFilter.cs +- TreeView/ObjectActivatedEventArgs.cs +- TreeView/SelectionChangedEventArgs.cs +- TreeView/TreeBuilder.cs +- TreeView/TreeNode.cs +- TreeView/TreeNodeBuilder.cs +- TreeView/TreeStyle.cs +- TreeView/TreeView.cs +- TreeView/TreeViewTextFilter.cs + +### Wizard (3 files) +- Wizard/Wizard.cs +- Wizard/WizardEventArgs.cs +- Wizard/WizardStep.cs + +## Summary + +These 121 View-related files still have `#nullable disable` as they require additional work to be fully nullable-compliant. All other files in the Terminal.Gui library (outside of the Views directory) have been updated to support nullable reference types. diff --git a/PR_DESCRIPTION_UPDATED.md b/PR_DESCRIPTION_UPDATED.md new file mode 100644 index 000000000..8a653ba68 --- /dev/null +++ b/PR_DESCRIPTION_UPDATED.md @@ -0,0 +1,322 @@ +# Fixes #4329 - Major Architectural Improvements: API Rename, Nullable Types, and Application Decoupling + +## Overview + +This PR delivers **three major architectural improvements** to Terminal.Gui v2: + +1. **API Terminology Modernization** - Renamed confusing `Application.Top`/`TopLevels` to intuitive `Application.Current`/`Session Stack` +2. **Nullable Reference Types** - Enabled nullable for 143 non-View library files +3. **Application Decoupling** - Introduced `View.App` property to decouple View hierarchy from static Application class + +**Impact**: 561 files changed, 7,033 insertions(+), 2,736 deletions(-) across library, tests, and examples. + +--- + +## Part 1: API Terminology Modernization (Breaking Change) + +### Changes + +- **`Application.Top` → `Application.Current`** (684 occurrences across codebase) +- **`Application.TopLevels` → `Application.SessionStack`** (31 occurrences) +- Updated `IApplication` interface, `ApplicationImpl`, all tests, examples, and documentation + +### Rationale + +The old naming was ambiguous and inconsistent with .NET patterns: +- `Top` didn't clearly indicate "currently active/running view" +- `TopLevels` exposed implementation detail (it's a stack!) and didn't match `SessionToken` terminology + +New naming follows established patterns: +- `Current` matches `Thread.CurrentThread`, `HttpContext.Current`, `Synchronization Context.Current` +- `SessionStack` clearly describes both content (sessions) and structure (stack), aligning with `SessionToken` + +### Impact Statistics + +| Category | Files Changed | Occurrences Updated | +|----------|---------------|---------------------| +| Terminal.Gui library | 41 | 715 | +| Unit tests | 43 | 631 | +| Integration tests | 3 | 25 | +| Examples | 15 | 15 | +| Documentation | 3 | 14 | +| **Total** | **91** | **~800** | + +###Breaking Changes + +**All references must be updated:** +```csharp +// OLD (v1/early v2) +Application.Top?.SetNeedsDraw(); +foreach (var tl in Application.TopLevels) { } + +// NEW (v2 current) +Application.Current?.SetNeedsDraw(); +foreach (var tl in Application.SessionStack) { } +``` + +--- + +## Part 2: Nullable Reference Types Enabled + +### Changes + +**Phase 1** - Project Configuration (commit 439e161): +- Added `enable` to `Terminal.Gui.csproj` (project-wide default) +- Removed redundant `#nullable enable` from 37 files +- Added `#nullable disable` to 170 files not yet compliant + +**Phase 2** - Non-View Compliance (commit 06bd50d): +- **Removed `#nullable disable` from ALL 143 non-View library files** +- Build successful with 0 errors +- All core infrastructure now fully nullable-aware + +**Phase 3** - Cleanup (commits 97d9c7d, 49d4fb2): +- Fixed duplicate `#nullable` directives in 37 files +- All files now have clean, single nullable directive + +### Impact Statistics + +| Directory | Files Nullable-Enabled | +|-----------|------------------------| +| App/ | 25 ✅ | +| Configuration/ | 24 ✅ | +| ViewBase/ | 30 ✅ | +| Drivers/ | 25 ✅ | +| Drawing/ | 18 ✅ | +| FileServices/ | 7 ✅ | +| Input/ | 6 ✅ | +| Text/ | 5 ✅ | +| Resources/ | 3 ✅ | +| **Views/** | **121 ⏸️ (documented in NULLABLE_VIEWS_REMAINING.md)** | +| **Total Enabled** | **143 files** | + +### Remaining Work + +See [NULLABLE_VIEWS_REMAINING.md](./NULLABLE_VIEWS_REMAINING.md) for the 121 View subclass files still with `#nullable disable`. These require careful migration due to complex view hierarchies and will be addressed in a follow-up PR. + +--- + +## Part 3: Application Decoupling (MASSIVE Change) + +### Problem + +Prior to this PR, Views were tightly coupled to the **static** `Application` class: +- Direct static calls: `Application.Current`, `Application.Driver`, `Application.MainLoop` +- Made Views untestable in isolation +- Violated dependency inversion principle +- Prevented Views from working with different IApplication implementations + +### Solution: `View.App` Property + +Introduced `View.App` property that provides IApplication instance: + +```csharp +// Terminal.Gui/ViewBase/View.cs +public IApplication? App +{ + get => GetApp(); + internal set => _app = value; +} + +private IApplication? GetApp() +{ + // Walk up hierarchy to find IApplication + if (_app is { }) return _app; + if (SuperView is { }) return SuperView.App; + return Application.Instance; // Fallback to global +} +``` + +### Migration Pattern + +**Before** (tightly coupled): +```csharp +// Direct static dependency +Application.Driver.Move(x, y); +if (Application.Current == this) { } +Application.MainLoop.Invoke(() => { }); +``` + +**After** (decoupled via View.App): +```csharp +// Use injected IApplication instance +App?.Driver.Move(x, y); +if (App?.Current == this) { } +App?.MainLoop.Invoke(() => { }); +``` + +### Impact Statistics + +- **90 files changed** in decoupling commit (899fd76) +- **987 insertions, 728 deletions** +- Affects ViewBase, Views, Adornments, Input handling, Drawing + +### Benefits + +✅ **Testability**: Views can now be tested with mock IApplication +✅ **Flexibility**: Views work with any IApplication implementation +✅ **Cleaner Architecture**: Follows dependency injection pattern +✅ **Future-proof**: Enables multi-application scenarios +✅ **Maintainability**: Clearer dependencies, easier to refactor + +### Known Remaining Coupling + +After decoupling work, only **1 direct Application dependency** remains in ViewBase: +- `Border.Arrangement.cs`: Uses `Application.ArrangeKey` for hotkey binding + +Additional investigation areas for future work: +1. Some Views still reference Application for convenience (non-critical) +2. Test infrastructure may have residual static dependencies +3. Example applications use Application.Run (expected pattern) + +--- + +## Part 4: Test Infrastructure Improvements + +### New Test File: `ApplicationImplBeginEndTests.cs` + +Added **16 comprehensive tests** validating fragile Begin/End state management: + +**Critical Test Coverage:** +- `End_ThrowsArgumentException_WhenNotBalanced` - Ensures proper Begin/End pairing +- `End_RestoresCurrentToPreviousToplevel` - Validates Current property management +- `MultipleBeginEnd_MaintainsStackIntegrity` - Tests nested sessions (5 levels deep) + +**Additional Coverage:** +- Argument validation (null checks) +- SessionStack push/pop operations +- Current property state transitions +- Unique ID generation for toplevels +- SessionToken management +- ResetState cleanup behavior +- Toplevel activation/deactivation events + +### Test Quality Improvements + +All new tests follow best practices: +- Work directly with ApplicationImpl instances (no global Application pollution) +- Use try-finally blocks ensuring Shutdown() always called +- Properly dispose toplevels before Shutdown (satisfies DEBUG_IDISPOSABLE assertions) +- No redundant ResetState calls (Shutdown calls it internally) + +**Result**: All 16 new tests + all existing tests passing ✅ + +--- + +## Additional Changes + +### Merged from v2_develop + +- RunState → SessionToken terminology (precedent for this rename) +- Application.TopLevels visibility changed to public (made this rename more important) +- Legacy MainLoop infrastructure removed +- Driver architecture modernization +- Test infrastructure improvements + +### Documentation + +- Created 5 comprehensive terminology proposal documents in `docfx/docs/`: + - `terminology-index.md` - Navigation guide + - `terminology-proposal.md` - Complete analysis + - `terminology-proposal-summary.md` - Quick reference + - `terminology-diagrams.md` - 11 Mermaid diagrams + - `terminology-before-after.md` - Side-by-side examples +- Updated `navigation.md`, `config.md`, `migratingfromv1.md` +- Created `NULLABLE_VIEWS_REMAINING.md` - Tracks remaining nullable work + +--- + +## Testing + +- ✅ **Build**: Successful with 0 errors +- ✅ **Unit Tests**: All 16 new tests + all existing tests passing +- ✅ **Integration Tests**: Updated and passing +- ✅ **Examples**: UICatalog, ReactiveExample, CommunityToolkitExample all updated and functional +- ✅ **Documentation**: Builds successfully + +--- + +## Breaking Changes Summary + +### API Changes (Requires Code Updates) + +1. **`Application.Top` → `Application.Current`** + - All usages must be updated + - Affects any code accessing the currently running toplevel + +2. **`Application.TopLevels` → `Application.SessionStack`** + - All usages must be updated + - Affects code iterating over running sessions + +### Non-Breaking Changes + +- Nullable reference types: Improved type safety, no runtime changes +- View.App property: Additive, existing Application. * calls still work (for now) + +--- + +## Migration Guide + +### For Terminology Changes + +```bash +# Find and replace in your codebase +Application.Top → Application.Current +Application.TopLevels → Application.SessionStack +``` + +### For View.App Usage (Recommended, Not Required) + +When writing new View code or refactoring existing Views: + +```csharp +// Prefer (future-proof, testable) +App?.Driver.AddRune(rune); +if (App?.Current == this) { } + +// Over (works but tightly coupled) +Application.Driver.AddRune(rune); +if (Application.Current == this) { } +``` + +--- + +## Future Work + +### Nullable Types +- Enable nullable for remaining 121 View files +- Document nullable patterns for View subclass authors + +### Application Decoupling +- Remove last `Application.ArrangeKey` reference from Border +- Consider making View.App property public for advanced scenarios +- Add documentation on using View.App for testable Views + +### Tests +- Expand ApplicationImpl test coverage based on new patterns discovered +- Add tests for View.App hierarchy traversal + +--- + +## Pull Request Checklist + +- [x] I've named my PR in the form of "Fixes #issue. Terse description." +- [x] My code follows the style guidelines of Terminal.Gui +- [x] My code follows the Terminal.Gui library design guidelines +- [x] I ran `dotnet test` before commit +- [x] I have made corresponding changes to the API documentation +- [x] My changes generate no new warnings +- [x] I have checked my code and corrected any poor grammar or misspellings +- [x] I conducted basic QA to assure all features are working + +--- + +## Related Issues + +- Fixes #4329 - Rename/Clarify Application.Toplevels/Top Terminology +- Related to #2491 - Toplevel refactoring +- Fixes #4333 (duplicate/related issue) + +--- + +**Note**: This is a large, multi-faceted PR that delivers significant architectural improvements. The changes are well-tested and maintain backward compatibility except for the intentional breaking API rename. The work positions Terminal.Gui v2 for better testability, maintainability, and future enhancements. diff --git a/README.md b/README.md index f75b7ab0c..ea0b11f0a 100644 --- a/README.md +++ b/README.md @@ -6,27 +6,23 @@ # Terminal.Gui v2 -The premier toolkit for building rich console apps for Windows, the Mac, and Linux/Unix. +Cross-platform UI toolkit for building sophisticated terminal UI (TUI) applications on Windows, macOS, and Linux/Unix. ![logo](docfx/images/logo.png) -* The current, stable, release of Terminal.Gui v1 is [![Version](https://img.shields.io/nuget/v/Terminal.Gui.svg)](https://www.nuget.org/packages/Terminal.Gui). +* **v2 Alpha** (Current): ![NuGet Version](https://img.shields.io/nuget/vpre/Terminal.Gui) - Recommended for new projects +* **v1 (Legacy)**: [![Version](https://img.shields.io/nuget/v/Terminal.Gui.svg)](https://www.nuget.org/packages/Terminal.Gui) - Maintenance mode only -> :warning: **Note:** -> `v1` is in maintenance mode and we will only accept PRs for issues impacting existing functionality. - -* The current `Alpha` release of Terminal.Gui v2 is ![NuGet Version](https://img.shields.io/nuget/vpre/Terminal.Gui) - -> :warning: **Note:** -> Developers starting new TUI projects are encouraged to target `v2 Alpha`. The API is significantly changed, and significantly improved. There will be breaking changes in the API before Beta, but the core API is stable. +> **Important:** +> - **v1** is in maintenance mode - only critical bug fixes accepted +> - **v2 Alpha** is recommended for new projects - API is stable with comprehensive features +> - Breaking changes possible before Beta, but core architecture is solid ![Sample app](docfx/images/sample.gif) # Quick Start -Paste these commands into your favorite terminal on Windows, Mac, or Linux. This will install the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates), create a new "Hello World" TUI app, and run it. - -(Press `CTRL-Q` to exit the app) +Install the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates), create a new TUI app, and run it: ```powershell dotnet new --install Terminal.Gui.templates @@ -35,60 +31,100 @@ cd myproj dotnet run ``` -To run the UICatalog demo app that shows all the controls and features of the toolkit, use the following command: +Press `Esc` to exit (the default [QuitKey](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.App.Application.html#Terminal_Gui_App_Application_QuitKey)). + +Run the comprehensive [UI Catalog](Examples/UICatalog) demo to explore all controls: ```powershell dotnet run --project Examples/UICatalog/UICatalog.csproj ``` -There is also a [visual designer](https://github.com/gui-cs/TerminalGuiDesigner) (uses Terminal.Gui itself). +# Simple Example + +```csharp +using Terminal.Gui; + +using IApplication app = Application.Create (); +app.Init (); + +using Window window = new () { Title = "Hello World (Esc to quit)" }; +Label label = new () +{ + Text = "Hello, Terminal.Gui v2!", + X = Pos.Center (), + Y = Pos.Center () +}; +window.Add (label); + +app.Run (window); +``` + +See the [Examples](Examples/) directory for more. + +# Build Powerful Terminal Applications + +Terminal.Gui enables building sophisticated console applications with modern UIs: + +- **Rich Forms and Dialogs** - Text fields, buttons, checkboxes, radio buttons, and data validation +- **Interactive Data Views** - Tables, lists, and trees with sorting, filtering, and in-place editing +- **Visualizations** - Charts, graphs, progress indicators, and color pickers with TrueColor support +- **Text Editors** - Full-featured text editing with clipboard, undo/redo, and Unicode support +- **File Management** - File and directory browsers with search and filtering +- **Wizards and Multi-Step Processes** - Guided workflows with navigation and validation +- **System Monitoring Tools** - Real-time dashboards with scrollable, resizable views +- **Configuration UIs** - Settings editors with persistent themes and user preferences +- **Cross-Platform CLI Tools** - Consistent experience on Windows, macOS, and Linux +- **Server Management Interfaces** - SSH-compatible UIs for remote administration + +See the [Views Overview](https://gui-cs.github.io/Terminal.Gui/docs/views) for available controls and [What's New in v2](https://gui-cs.github.io/Terminal.Gui/docs/newinv2) for architectural improvements. # Documentation -The full developer documentation for Terminal.Gui is available at [gui-cs.github.io/Terminal.Gui](https://gui-cs.github.io/Terminal.Gui). +Comprehensive documentation is at [gui-cs.github.io/Terminal.Gui](https://gui-cs.github.io/Terminal.Gui). ## Getting Started -- [Getting Started](https://gui-cs.github.io/Terminal.Gui/docs/getting-started) - Quick start guide to create your first Terminal.Gui application -- [Migrating from v1 to v2](https://gui-cs.github.io/Terminal.Gui/docs/migratingfromv1) - Complete guide for upgrading existing applications -- [What's New in v2](https://gui-cs.github.io/Terminal.Gui/docs/newinv2) - Overview of new features and improvements +- **[Getting Started Guide](https://gui-cs.github.io/Terminal.Gui/docs/getting-started)** - First Terminal.Gui application +- **[API Reference](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.App.html)** - Complete API documentation +- **[What's New in v2](https://gui-cs.github.io/Terminal.Gui/docs/newinv2)** - New features and improvements -## API Reference +## Migration & Deep Dives -For detailed API documentation, see the [API Reference](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.App.html). +- **[Migrating from v1 to v2](https://gui-cs.github.io/Terminal.Gui/docs/migratingfromv1)** - Complete migration guide +- **[Application Architecture](https://gui-cs.github.io/Terminal.Gui/docs/application)** - Instance-based model and IRunnable pattern +- **[Layout System](https://gui-cs.github.io/Terminal.Gui/docs/layout)** - Positioning, sizing, and adornments +- **[Keyboard Handling](https://gui-cs.github.io/Terminal.Gui/docs/keyboard)** - Key bindings and commands +- **[View Documentation](https://gui-cs.github.io/Terminal.Gui/docs/View)** - View hierarchy and lifecycle +- **[Configuration](https://gui-cs.github.io/Terminal.Gui/docs/config)** - Themes and persistent settings + +See the [documentation index](https://gui-cs.github.io/Terminal.Gui/docs/index) for all topics. # Installing -Use NuGet to install the `Terminal.Gui` NuGet package: +## v2 Alpha (Recommended) -## v2 Alpha - -(Infrequently updated, but stable enough for production use) -``` +```powershell dotnet add package Terminal.Gui --version "2.0.0-alpha.*" ``` -## v2 Develop +## v2 Develop (Latest) -(Frequently updated, but may have breaking changes) -``` +```powershell dotnet add package Terminal.Gui --version "2.0.0-develop.*" ``` -## Legacy v1 +## v1 Legacy -``` -dotnet add package Terminal.Gui --version "1.* +```powershell +dotnet add package Terminal.Gui --version "1.*" ``` -Or, you can use the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates). +Or use the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates). # Contributing -See [CONTRIBUTING.md](CONTRIBUTING.md) for complete contribution guidelines. - -Debates on architecture and design can be found in Issues tagged with [design](https://github.com/gui-cs/Terminal.Gui/issues?q=is%3Aopen+is%3Aissue+label%3Av2+label%3Adesign). +Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md). # History -See [gui-cs](https://github.com/gui-cs/) for how this project came to be. +See [gui-cs](https://github.com/gui-cs/) for project history and origins. diff --git a/Scripts/Run-LocalCoverage.ps1 b/Scripts/Run-LocalCoverage.ps1 index 312b229a9..710bb26ea 100644 --- a/Scripts/Run-LocalCoverage.ps1 +++ b/Scripts/Run-LocalCoverage.ps1 @@ -26,8 +26,7 @@ dotnet test Tests/UnitTests ` --no-build ` --verbosity minimal ` --collect:"XPlat Code Coverage" ` - --settings Tests/UnitTests/runsettings.coverage.xml ` - --blame-hang-timeout 10s + --settings Tests/UnitTests/runsettings.coverage.xml # ------------------------------------------------------------ # 4. Run UNIT TESTS (parallel) diff --git a/Terminal.Gui/App/Application.Clipboard.cs b/Terminal.Gui/App/Application.Clipboard.cs new file mode 100644 index 000000000..22cc85907 --- /dev/null +++ b/Terminal.Gui/App/Application.Clipboard.cs @@ -0,0 +1,15 @@ +namespace Terminal.Gui.App; + +public static partial class Application // Clipboard handling +{ + /// + /// Gets the clipboard for the application. + /// + /// + /// + /// Provides access to the OS clipboard through the driver. + /// + /// + [Obsolete ("The legacy static Application object is going away. Use IApplication.Clipboard instead.")] + public static IClipboard? Clipboard => ApplicationImpl.Instance.Clipboard; +} diff --git a/Terminal.Gui/App/Application.Driver.cs b/Terminal.Gui/App/Application.Driver.cs index c08fb879f..427ba4de5 100644 --- a/Terminal.Gui/App/Application.Driver.cs +++ b/Terminal.Gui/App/Application.Driver.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics.CodeAnalysis; @@ -7,34 +6,59 @@ namespace Terminal.Gui.App; public static partial class Application // Driver abstractions { /// + [Obsolete ("The legacy static Application object is going away.")] public static IDriver? Driver { get => ApplicationImpl.Instance.Driver; internal set => ApplicationImpl.Instance.Driver = value; } + private static bool _force16Colors = false; // Resources/config.json overrides + /// [ConfigurationProperty (Scope = typeof (SettingsScope))] + [Obsolete ("The legacy static Application object is going away.")] public static bool Force16Colors { - get => ApplicationImpl.Instance.Force16Colors; - set => ApplicationImpl.Instance.Force16Colors = value; + get => _force16Colors; + set + { + bool oldValue = _force16Colors; + _force16Colors = value; + Force16ColorsChanged?.Invoke (null, new ValueChangedEventArgs (oldValue, _force16Colors)); + } } + /// Raised when changes. + public static event EventHandler>? Force16ColorsChanged; + + private static string _forceDriver = string.Empty; // Resources/config.json overrides + /// [ConfigurationProperty (Scope = typeof (SettingsScope))] + [Obsolete ("The legacy static Application object is going away.")] public static string ForceDriver { - get => ApplicationImpl.Instance.ForceDriver; - set => ApplicationImpl.Instance.ForceDriver = value; + get => _forceDriver; + set + { + string oldValue = _forceDriver; + _forceDriver = value; + ForceDriverChanged?.Invoke (null, new ValueChangedEventArgs (oldValue, _forceDriver)); + } } + /// Raised when changes. + public static event EventHandler>? ForceDriverChanged; + /// + [Obsolete ("The legacy static Application object is going away.")] public static List Sixel => ApplicationImpl.Instance.Sixel; /// Gets a list of types and type names that are available. /// [RequiresUnreferencedCode ("AOT")] + [Obsolete ("The legacy static Application object is going away.")] public static (List, List) GetDriverTypes () { // use reflection to get the list of drivers @@ -59,4 +83,4 @@ public static partial class Application // Driver abstractions return (driverTypes, driverTypeNames); } -} \ No newline at end of file +} diff --git a/Terminal.Gui/App/Application.Keyboard.cs b/Terminal.Gui/App/Application.Keyboard.cs index 1fa176a7d..9dbdde854 100644 --- a/Terminal.Gui/App/Application.Keyboard.cs +++ b/Terminal.Gui/App/Application.Keyboard.cs @@ -1,10 +1,9 @@ -#nullable enable - -namespace Terminal.Gui.App; +namespace Terminal.Gui.App; public static partial class Application // Keyboard handling { /// + [Obsolete ("The legacy static Application object is going away.")] public static IKeyboard Keyboard { get => ApplicationImpl.Instance.Keyboard; @@ -13,14 +12,9 @@ public static partial class Application // Keyboard handling } /// + [Obsolete ("The legacy static Application object is going away.")] public static bool RaiseKeyDownEvent (Key key) => ApplicationImpl.Instance.Keyboard.RaiseKeyDownEvent (key); - /// - public static bool? InvokeCommandsBoundToKey (Key key) => ApplicationImpl.Instance.Keyboard.InvokeCommandsBoundToKey (key); - - /// - public static bool? InvokeCommand (Command command, Key key, KeyBinding binding) => ApplicationImpl.Instance.Keyboard.InvokeCommand (command, key, binding); - /// /// Raised when the user presses a key. /// @@ -33,15 +27,14 @@ public static partial class Application // Keyboard handling /// and events. /// Fired after and before . /// + [Obsolete ("The legacy static Application object is going away.")] public static event EventHandler? KeyDown { add => ApplicationImpl.Instance.Keyboard.KeyDown += value; remove => ApplicationImpl.Instance.Keyboard.KeyDown -= value; } - /// - public static bool RaiseKeyUpEvent (Key key) => ApplicationImpl.Instance.Keyboard.RaiseKeyUpEvent (key); - /// + [Obsolete ("The legacy static Application object is going away.")] public static KeyBindings KeyBindings => ApplicationImpl.Instance.Keyboard.KeyBindings; } diff --git a/Terminal.Gui/App/Application.Lifecycle.cs b/Terminal.Gui/App/Application.Lifecycle.cs index 051d6b5c8..5262376ed 100644 --- a/Terminal.Gui/App/Application.Lifecycle.cs +++ b/Terminal.Gui/App/Application.Lifecycle.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Reflection; @@ -11,68 +10,51 @@ namespace Terminal.Gui.App; public static partial class Application // Lifecycle (Init/Shutdown) { + /// + /// Creates a new instance. + /// + /// + /// The recommended pattern is for developers to call Application.Create() and then use the returned + /// instance for all subsequent application operations. + /// + /// A new instance. + /// + /// Thrown if the legacy static Application model has already been used in this process. + /// + public static IApplication Create () + { + //Debug.Fail ("Application.Create() called"); + ApplicationImpl.MarkInstanceBasedModelUsed (); - /// Initializes a new instance of a Terminal.Gui Application. must be called when the application is closing. - /// Call this method once per instance (or after has been called). - /// - /// This function loads the right for the platform, Creates a . and - /// assigns it to - /// - /// - /// must be called when the application is closing (typically after - /// has returned) to ensure resources are cleaned up and - /// terminal settings - /// restored. - /// - /// - /// The function combines - /// and - /// into a single - /// call. An application can use without explicitly calling - /// . - /// - /// - /// The to use. If neither or - /// are specified the default driver for the platform will be used. - /// - /// - /// The short name (e.g. "dotnet", "windows", "unix", or "fake") of the - /// to use. If neither or are - /// specified the default driver for the platform will be used. - /// + return new ApplicationImpl (); + } + + /// [RequiresUnreferencedCode ("AOT")] [RequiresDynamicCode ("AOT")] - public static void Init (IDriver? driver = null, string? driverName = null) + [Obsolete ("The legacy static Application object is going away.")] + public static void Init (string? driverName = null) { - ApplicationImpl.Instance.Init (driver, driverName ?? ForceDriver); + //Debug.Fail ("Application.Init() called - parallelizable tests should not use legacy static Application model"); + ApplicationImpl.Instance.Init (driverName ?? ForceDriver); } /// /// Gets or sets the main thread ID for the application. /// + [Obsolete ("The legacy static Application object is going away.")] public static int? MainThreadId { - get => ((ApplicationImpl)ApplicationImpl.Instance).MainThreadId; - set => ((ApplicationImpl)ApplicationImpl.Instance).MainThreadId = value; + get => ApplicationImpl.Instance.MainThreadId; + internal set => ApplicationImpl.Instance.MainThreadId = value; } - /// Shutdown an application initialized with . - /// - /// Shutdown must be called for every call to or - /// to ensure all resources are cleaned - /// up (Disposed) - /// and terminal settings are restored. - /// - public static void Shutdown () => ApplicationImpl.Instance.Shutdown (); + /// + [Obsolete ("The legacy static Application object is going away.")] + public static void Shutdown () => ApplicationImpl.Instance.Dispose (); - /// - /// Gets whether the application has been initialized with and not yet shutdown with . - /// - /// - /// - /// The event is raised after the and methods have been called. - /// - /// + /// + [Obsolete ("The legacy static Application object is going away.")] public static bool Initialized { get => ApplicationImpl.Instance.Initialized; @@ -80,6 +62,7 @@ public static partial class Application // Lifecycle (Init/Shutdown) } /// + [Obsolete ("The legacy static Application object is going away.")] public static event EventHandler>? InitializedChanged { add => ApplicationImpl.Instance.InitializedChanged += value; @@ -91,5 +74,10 @@ public static partial class Application // Lifecycle (Init/Shutdown) // this in a function like this ensures we don't make mistakes in // guaranteeing that the state of this singleton is deterministic when Init // starts running and after Shutdown returns. - internal static void ResetState (bool ignoreDisposed = false) => ApplicationImpl.Instance?.ResetState (ignoreDisposed); + [Obsolete ("The legacy static Application object is going away.")] + internal static void ResetState (bool ignoreDisposed = false) + { + // Use the static reset method to bypass the fence check + ApplicationImpl.ResetStateStatic (ignoreDisposed); + } } diff --git a/Terminal.Gui/App/Application.Mouse.cs b/Terminal.Gui/App/Application.Mouse.cs index 659e07b1c..2ea9bb650 100644 --- a/Terminal.Gui/App/Application.Mouse.cs +++ b/Terminal.Gui/App/Application.Mouse.cs @@ -1,23 +1,28 @@ -#nullable enable using System.ComponentModel; namespace Terminal.Gui.App; public static partial class Application // Mouse handling { - /// - /// Gets the most recent position of the mouse. - /// - public static Point? GetLastMousePosition () { return Mouse.GetLastMousePosition (); } + private static bool _isMouseDisabled = false; // Resources/config.json overrides /// Disable or enable the mouse. The mouse is enabled by default. [ConfigurationProperty (Scope = typeof (SettingsScope))] + [Obsolete ("The legacy static Application object is going away.")] public static bool IsMouseDisabled { - get => Mouse.IsMouseDisabled; - set => Mouse.IsMouseDisabled = value; + get => _isMouseDisabled; + set + { + bool oldValue = _isMouseDisabled; + _isMouseDisabled = value; + IsMouseDisabledChanged?.Invoke (null, new ValueChangedEventArgs (oldValue, _isMouseDisabled)); + } } + /// Raised when changes. + public static event EventHandler>? IsMouseDisabledChanged; + /// /// Gets the instance that manages mouse event handling and state. /// @@ -26,12 +31,8 @@ public static partial class Application // Mouse handling /// This property provides access to mouse-related functionality in a way that supports /// parallel test execution by avoiding static state. /// - /// - /// New code should use Application.Mouse instead of the static properties and methods - /// for better testability. Legacy static properties like and - /// are retained for backward compatibility. - /// /// + [Obsolete ("The legacy static Application object is going away.")] public static IMouse Mouse => ApplicationImpl.Instance.Mouse; #pragma warning disable CS1574 // XML comment has cref attribute that could not be resolved @@ -54,6 +55,7 @@ public static partial class Application // Mouse handling /// Use this even to handle mouse events at the application level, before View-specific handling. /// /// + [Obsolete ("The legacy static Application object is going away.")] public static event EventHandler? MouseEvent { add => Mouse.MouseEvent += value; @@ -65,11 +67,13 @@ public static partial class Application // Mouse handling /// INTERNAL: Holds the non- views that are currently under the /// mouse. /// + [Obsolete ("The legacy static Application object is going away.")] internal static List CachedViewsUnderMouse => Mouse.CachedViewsUnderMouse; /// /// INTERNAL API: Holds the last mouse position. /// + [Obsolete ("The legacy static Application object is going away.")] internal static Point? LastMousePosition { get => Mouse.LastMousePosition; @@ -81,6 +85,7 @@ public static partial class Application // Mouse handling /// /// The position of the mouse. /// The most recent result from GetViewsUnderLocation(). + [Obsolete ("The legacy static Application object is going away.")] internal static void RaiseMouseEnterLeaveEvents (Point screenPosition, List currentViewsUnderMouse) { Mouse.RaiseMouseEnterLeaveEvents (screenPosition, currentViewsUnderMouse); @@ -92,6 +97,7 @@ public static partial class Application // Mouse handling /// /// This method can be used to simulate a mouse event, e.g. in unit tests. /// The mouse event with coordinates relative to the screen. + [Obsolete ("The legacy static Application object is going away.")] internal static void RaiseMouseEvent (MouseEventArgs mouseEvent) { Mouse.RaiseMouseEvent (mouseEvent); diff --git a/Terminal.Gui/App/Application.Navigation.cs b/Terminal.Gui/App/Application.Navigation.cs index b822a6027..031ebac1c 100644 --- a/Terminal.Gui/App/Application.Navigation.cs +++ b/Terminal.Gui/App/Application.Navigation.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; @@ -7,28 +6,49 @@ public static partial class Application // Navigation stuff /// /// Gets the instance for the current . /// + [Obsolete ("The legacy static Application object is going away.")] public static ApplicationNavigation? Navigation { get => ApplicationImpl.Instance.Navigation; internal set => ApplicationImpl.Instance.Navigation = value; } + private static Key _nextTabGroupKey = Key.F6; // Resources/config.json overrides + /// Alternative key to navigate forwards through views. Ctrl+Tab is the primary key. [ConfigurationProperty (Scope = typeof (SettingsScope))] public static Key NextTabGroupKey { - get => ApplicationImpl.Instance.Keyboard.NextTabGroupKey; - set => ApplicationImpl.Instance.Keyboard.NextTabGroupKey = value; + get => _nextTabGroupKey; + set + { + Key oldValue = _nextTabGroupKey; + _nextTabGroupKey = value; + NextTabGroupKeyChanged?.Invoke (null, new ValueChangedEventArgs (oldValue, _nextTabGroupKey)); + } } + /// Raised when changes. + public static event EventHandler>? NextTabGroupKeyChanged; + + private static Key _nextTabKey = Key.Tab; // Resources/config.json overrides + /// Alternative key to navigate forwards through views. Tab is the primary key. [ConfigurationProperty (Scope = typeof (SettingsScope))] public static Key NextTabKey { - get => ApplicationImpl.Instance.Keyboard.NextTabKey; - set => ApplicationImpl.Instance.Keyboard.NextTabKey = value; + get => _nextTabKey; + set + { + Key oldValue = _nextTabKey; + _nextTabKey = value; + NextTabKeyChanged?.Invoke (null, new ValueChangedEventArgs (oldValue, _nextTabKey)); + } } + /// Raised when changes. + public static event EventHandler>? NextTabKeyChanged; + /// /// Raised when the user releases a key. /// @@ -41,25 +61,46 @@ public static partial class Application // Navigation stuff /// and events. /// Fired after . /// + [Obsolete ("The legacy static Application object is going away.")] public static event EventHandler? KeyUp { add => ApplicationImpl.Instance.Keyboard.KeyUp += value; remove => ApplicationImpl.Instance.Keyboard.KeyUp -= value; } + private static Key _prevTabGroupKey = Key.F6.WithShift; // Resources/config.json overrides + /// Alternative key to navigate backwards through views. Shift+Ctrl+Tab is the primary key. [ConfigurationProperty (Scope = typeof (SettingsScope))] public static Key PrevTabGroupKey { - get => ApplicationImpl.Instance.Keyboard.PrevTabGroupKey; - set => ApplicationImpl.Instance.Keyboard.PrevTabGroupKey = value; + get => _prevTabGroupKey; + set + { + Key oldValue = _prevTabGroupKey; + _prevTabGroupKey = value; + PrevTabGroupKeyChanged?.Invoke (null, new ValueChangedEventArgs (oldValue, _prevTabGroupKey)); + } } + /// Raised when changes. + public static event EventHandler>? PrevTabGroupKeyChanged; + + private static Key _prevTabKey = Key.Tab.WithShift; // Resources/config.json overrides + /// Alternative key to navigate backwards through views. Shift+Tab is the primary key. [ConfigurationProperty (Scope = typeof (SettingsScope))] public static Key PrevTabKey { - get => ApplicationImpl.Instance.Keyboard.PrevTabKey; - set => ApplicationImpl.Instance.Keyboard.PrevTabKey = value; + get => _prevTabKey; + set + { + Key oldValue = _prevTabKey; + _prevTabKey = value; + PrevTabKeyChanged?.Invoke (null, new ValueChangedEventArgs (oldValue, _prevTabKey)); + } } + + /// Raised when changes. + public static event EventHandler>? PrevTabKeyChanged; } diff --git a/Terminal.Gui/App/Application.Popover.cs b/Terminal.Gui/App/Application.Popover.cs index 31522f80f..40eba8d4d 100644 --- a/Terminal.Gui/App/Application.Popover.cs +++ b/Terminal.Gui/App/Application.Popover.cs @@ -1,13 +1,13 @@ -#nullable enable namespace Terminal.Gui.App; public static partial class Application // Popover handling { /// Gets the Application manager. + [Obsolete ("The legacy static Application object is going away.")] public static ApplicationPopover? Popover { get => ApplicationImpl.Instance.Popover; internal set => ApplicationImpl.Instance.Popover = value; } -} \ No newline at end of file +} diff --git a/Terminal.Gui/App/Application.Run.cs b/Terminal.Gui/App/Application.Run.cs index 56206a997..9864e61b4 100644 --- a/Terminal.Gui/App/Application.Run.cs +++ b/Terminal.Gui/App/Application.Run.cs @@ -1,85 +1,115 @@ -#nullable enable using System.Diagnostics.CodeAnalysis; namespace Terminal.Gui.App; public static partial class Application // Run (Begin -> Run -> Layout/Draw -> End -> Stop) { + private static Key _quitKey = Key.Esc; // Resources/config.json overrides + /// Gets or sets the key to quit the application. [ConfigurationProperty (Scope = typeof (SettingsScope))] public static Key QuitKey { - get => ApplicationImpl.Instance.Keyboard.QuitKey; - set => ApplicationImpl.Instance.Keyboard.QuitKey = value; + get => _quitKey; + set + { + Key oldValue = _quitKey; + _quitKey = value; + QuitKeyChanged?.Invoke (null, new ValueChangedEventArgs (oldValue, _quitKey)); + } } + /// Raised when changes. + public static event EventHandler>? QuitKeyChanged; + + private static Key _arrangeKey = Key.F5.WithCtrl; // Resources/config.json overrides + /// Gets or sets the key to activate arranging views using the keyboard. [ConfigurationProperty (Scope = typeof (SettingsScope))] public static Key ArrangeKey { - get => ApplicationImpl.Instance.Keyboard.ArrangeKey; - set => ApplicationImpl.Instance.Keyboard.ArrangeKey = value; + get => _arrangeKey; + set + { + Key oldValue = _arrangeKey; + _arrangeKey = value; + ArrangeKeyChanged?.Invoke (null, new ValueChangedEventArgs (oldValue, _arrangeKey)); + } } - /// - public static SessionToken Begin (Toplevel toplevel) => ApplicationImpl.Instance.Begin (toplevel); + /// Raised when changes. + public static event EventHandler>? ArrangeKeyChanged; + + /// + [Obsolete ("The legacy static Application object is going away.")] + public static SessionToken Begin (IRunnable runnable) => ApplicationImpl.Instance.Begin (runnable)!; /// + [Obsolete ("The legacy static Application object is going away.")] public static bool PositionCursor () => ApplicationImpl.Instance.PositionCursor (); - /// + /// [RequiresUnreferencedCode ("AOT")] [RequiresDynamicCode ("AOT")] - public static Toplevel Run (Func? errorHandler = null, string? driver = null) => ApplicationImpl.Instance.Run (errorHandler, driver); + [Obsolete ("The legacy static Application object is going away.")] + public static IApplication Run (Func? errorHandler = null, string? driverName = null) + where TRunnable : IRunnable, new() => ApplicationImpl.Instance.Run (errorHandler, driverName); - /// - [RequiresUnreferencedCode ("AOT")] - [RequiresDynamicCode ("AOT")] - public static TView Run (Func? errorHandler = null, string? driver = null) - where TView : Toplevel, new() => ApplicationImpl.Instance.Run (errorHandler, driver); - - /// - public static void Run (Toplevel view, Func? errorHandler = null) => ApplicationImpl.Instance.Run (view, errorHandler); + /// + [Obsolete ("The legacy static Application object is going away.")] + public static void Run (IRunnable runnable, Func? errorHandler = null) => ApplicationImpl.Instance.Run (runnable, errorHandler); /// + [Obsolete ("The legacy static Application object is going away.")] public static object? AddTimeout (TimeSpan time, Func callback) => ApplicationImpl.Instance.AddTimeout (time, callback); /// + [Obsolete ("The legacy static Application object is going away.")] public static bool RemoveTimeout (object token) => ApplicationImpl.Instance.RemoveTimeout (token); /// /// - public static ITimedEvents? TimedEvents => ApplicationImpl.Instance?.TimedEvents; - /// + [Obsolete ("The legacy static Application object is going away.")] + public static ITimedEvents? TimedEvents => ApplicationImpl.Instance.TimedEvents; + + /// + [Obsolete ("The legacy static Application object is going away.")] + public static void Invoke (Action action) => ApplicationImpl.Instance.Invoke (action); + + /// + [Obsolete ("The legacy static Application object is going away.")] public static void Invoke (Action action) => ApplicationImpl.Instance.Invoke (action); /// + [Obsolete ("The legacy static Application object is going away.")] public static void LayoutAndDraw (bool forceRedraw = false) => ApplicationImpl.Instance.LayoutAndDraw (forceRedraw); /// + [Obsolete ("The legacy static Application object is going away.")] public static bool StopAfterFirstIteration { get => ApplicationImpl.Instance.StopAfterFirstIteration; set => ApplicationImpl.Instance.StopAfterFirstIteration = value; } - /// - public static void RequestStop (Toplevel? top = null) => ApplicationImpl.Instance.RequestStop (top); + /// + [Obsolete ("The legacy static Application object is going away.")] + public static void RequestStop (IRunnable? runnable = null) => ApplicationImpl.Instance.RequestStop (runnable); - /// + /// + [Obsolete ("The legacy static Application object is going away.")] public static void End (SessionToken sessionToken) => ApplicationImpl.Instance.End (sessionToken); - /// - internal static void RaiseIteration () => ApplicationImpl.Instance.RaiseIteration (); - /// - public static event EventHandler? Iteration + [Obsolete ("The legacy static Application object is going away.")] + public static event EventHandler>? Iteration { add => ApplicationImpl.Instance.Iteration += value; remove => ApplicationImpl.Instance.Iteration -= value; } /// + [Obsolete ("The legacy static Application object is going away.")] public static event EventHandler? SessionBegun { add => ApplicationImpl.Instance.SessionBegun += value; @@ -87,7 +117,8 @@ public static partial class Application // Run (Begin -> Run -> Layout/Draw -> E } /// - public static event EventHandler? SessionEnded + [Obsolete ("The legacy static Application object is going away.")] + public static event EventHandler? SessionEnded { add => ApplicationImpl.Instance.SessionEnded += value; remove => ApplicationImpl.Instance.SessionEnded -= value; diff --git a/Terminal.Gui/App/Application.Screen.cs b/Terminal.Gui/App/Application.Screen.cs index 2cc223cdb..6aeadb0b9 100644 --- a/Terminal.Gui/App/Application.Screen.cs +++ b/Terminal.Gui/App/Application.Screen.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; @@ -6,21 +5,16 @@ public static partial class Application // Screen related stuff; intended to hid { /// + [Obsolete ("The legacy static Application object is going away.")] public static Rectangle Screen { get => ApplicationImpl.Instance.Screen; set => ApplicationImpl.Instance.Screen = value; } - /// - public static event EventHandler>? ScreenChanged - { - add => ApplicationImpl.Instance.ScreenChanged += value; - remove => ApplicationImpl.Instance.ScreenChanged -= value; - } - /// + [Obsolete ("The legacy static Application object is going away.")] internal static bool ClearScreenNextIteration { get => ApplicationImpl.Instance.ClearScreenNextIteration; diff --git a/Terminal.Gui/App/Application.TopRunnable.cs b/Terminal.Gui/App/Application.TopRunnable.cs new file mode 100644 index 000000000..be0b83da7 --- /dev/null +++ b/Terminal.Gui/App/Application.TopRunnable.cs @@ -0,0 +1,16 @@ +using System.Collections.Concurrent; + +namespace Terminal.Gui.App; + +public static partial class Application // TopRunnable handling +{ + /// The that is on the top of the . + /// The top runnable. + [Obsolete ("The legacy static Application object is going away.")] + public static View? TopRunnableView => ApplicationImpl.Instance.TopRunnableView; + + /// The that is on the top of the . + /// The top runnable. + [Obsolete ("The legacy static Application object is going away.")] + public static IRunnable? TopRunnable => ApplicationImpl.Instance.TopRunnable; +} diff --git a/Terminal.Gui/App/Application.Toplevel.cs b/Terminal.Gui/App/Application.Toplevel.cs deleted file mode 100644 index e7c05e437..000000000 --- a/Terminal.Gui/App/Application.Toplevel.cs +++ /dev/null @@ -1,18 +0,0 @@ -#nullable enable -using System.Collections.Concurrent; - -namespace Terminal.Gui.App; - -public static partial class Application // Toplevel handling -{ - /// - public static ConcurrentStack TopLevels => ApplicationImpl.Instance.TopLevels; - - /// The that is currently active. - /// The top. - public static Toplevel? Top - { - get => ApplicationImpl.Instance.Top; - internal set => ApplicationImpl.Instance.Top = value; - } -} diff --git a/Terminal.Gui/App/Application.cs b/Terminal.Gui/App/Application.cs index bd3ccf7a3..7213e16be 100644 --- a/Terminal.Gui/App/Application.cs +++ b/Terminal.Gui/App/Application.cs @@ -1,8 +1,7 @@ -#nullable enable - // We use global using directives to simplify the code and avoid repetitive namespace declarations. // Put them here so they are available throughout the application. // Do not put them in AssemblyInfo.cs as it will break GitVersion's /updateassemblyinfo + global using Attribute = Terminal.Gui.Drawing.Attribute; global using Color = Terminal.Gui.Drawing.Color; global using CM = Terminal.Gui.Configuration.ConfigurationManager; @@ -16,7 +15,6 @@ global using Terminal.Gui.Drawing; global using Terminal.Gui.Text; global using Terminal.Gui.Resources; global using Terminal.Gui.FileServices; -using System.Diagnostics; using System.Globalization; using System.Reflection; using System.Resources; @@ -40,95 +38,31 @@ namespace Terminal.Gui.App; public static partial class Application { /// - /// Maximum number of iterations of the main loop (and hence draws) - /// to allow to occur per second. Defaults to > which is a 40ms sleep - /// after iteration (factoring in how long iteration took to run). - /// Note that not every iteration draws (see ). - /// Only affects v2 drivers. + /// Maximum number of iterations of the main loop (and hence draws) + /// to allow to occur per second. Defaults to > which is a 40ms sleep + /// after iteration (factoring in how long iteration took to run). + /// + /// Note that not every iteration draws (see ). + /// Only affects v2 drivers. + /// /// public static ushort MaximumIterationsPerSecond = DefaultMaximumIterationsPerSecond; /// - /// Default value for + /// Default value for /// public const ushort DefaultMaximumIterationsPerSecond = 25; - /// - /// Gets a string representation of the Application as rendered by . - /// - /// A string representation of the Application - public new static string ToString () - { - IDriver? driver = Driver; - - if (driver is null) - { - return string.Empty; - } - - return ToString (driver); - } - - /// - /// Gets a string representation of the Application rendered by the provided . - /// - /// The driver to use to render the contents. - /// A string representation of the Application - public static string ToString (IDriver? driver) - { - if (driver is null) - { - return string.Empty; - } - - var sb = new StringBuilder (); - - Cell [,] contents = driver?.Contents!; - - for (var r = 0; r < driver!.Rows; r++) - { - for (var c = 0; c < driver.Cols; c++) - { - Rune rune = contents [r, c].Rune; - - if (rune.DecodeSurrogatePair (out char []? sp)) - { - sb.Append (sp); - } - else - { - sb.Append ((char)rune.Value); - } - - if (rune.GetColumns () > 1) - { - c++; - } - - // See Issue #2616 - //foreach (var combMark in contents [r, c].CombiningMarks) { - // sb.Append ((char)combMark.Value); - //} - } - - sb.AppendLine (); - } - - return sb.ToString (); - } - /// Gets all cultures supported by the application without the invariant language. public static List? SupportedCultures { get; private set; } = GetSupportedCultures (); - internal static List GetAvailableCulturesFromEmbeddedResources () { ResourceManager rm = new (typeof (Strings)); CultureInfo [] cultures = CultureInfo.GetCultures (CultureTypes.AllCultures); - return cultures.Where ( - cultureInfo => + return cultures.Where (cultureInfo => !cultureInfo.Equals (CultureInfo.InvariantCulture) && rm.GetResourceSet (cultureInfo, true, false) is { } ) @@ -152,8 +86,7 @@ public static partial class Application if (cultures.Length > 1 && Directory.Exists (Path.Combine (assemblyLocation, "pt-PT"))) { // Return all culture for which satellite folder found with culture code. - return cultures.Where ( - cultureInfo => + return cultures.Where (cultureInfo => Directory.Exists (Path.Combine (assemblyLocation, cultureInfo.Name)) && File.Exists (Path.Combine (assemblyLocation, cultureInfo.Name, resourceFilename)) ) diff --git a/Terminal.Gui/App/ApplicationImpl.Driver.cs b/Terminal.Gui/App/ApplicationImpl.Driver.cs index 36679b2b0..edb6adcbd 100644 --- a/Terminal.Gui/App/ApplicationImpl.Driver.cs +++ b/Terminal.Gui/App/ApplicationImpl.Driver.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Concurrent; namespace Terminal.Gui.App; @@ -35,7 +34,7 @@ public partial class ApplicationImpl bool factoryIsFake = _componentFactory is IComponentFactory; // Then check driverName - bool nameIsWindows = driverName?.Contains ("win", StringComparison.OrdinalIgnoreCase) ?? false; + bool nameIsWindows = driverName?.Contains ("windows", StringComparison.OrdinalIgnoreCase) ?? false; bool nameIsDotNet = driverName?.Contains ("dotnet", StringComparison.OrdinalIgnoreCase) ?? false; bool nameIsUnix = driverName?.Contains ("unix", StringComparison.OrdinalIgnoreCase) ?? false; bool nameIsFake = driverName?.Contains ("fake", StringComparison.OrdinalIgnoreCase) ?? false; @@ -80,7 +79,7 @@ public partial class ApplicationImpl Logging.Trace ($"Created Subcomponents: {Coordinator}"); - Coordinator.StartInputTaskAsync ().Wait (); + Coordinator.StartInputTaskAsync (this).Wait (); if (Driver == null) { diff --git a/Terminal.Gui/App/ApplicationImpl.Lifecycle.cs b/Terminal.Gui/App/ApplicationImpl.Lifecycle.cs index 0a7795833..7cb701605 100644 --- a/Terminal.Gui/App/ApplicationImpl.Lifecycle.cs +++ b/Terminal.Gui/App/ApplicationImpl.Lifecycle.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; using System.Diagnostics.CodeAnalysis; @@ -6,6 +5,9 @@ namespace Terminal.Gui.App; public partial class ApplicationImpl { + /// + public int? MainThreadId { get; set; } + /// public bool Initialized { get; set; } @@ -15,7 +17,7 @@ public partial class ApplicationImpl /// [RequiresUnreferencedCode ("AOT")] [RequiresDynamicCode ("AOT")] - public void Init (IDriver? driver = null, string? driverName = null) + public IApplication Init (string? driverName = null) { if (Initialized) { @@ -24,6 +26,29 @@ public partial class ApplicationImpl throw new InvalidOperationException ("Init called multiple times without Shutdown"); } + // Thread-safe fence check: Ensure we're not mixing application models + // Use lock to make check-and-set atomic + lock (_modelUsageLock) + { + // If this is a legacy static instance and instance-based model was used, throw + if (this == _instance && ModelUsage == ApplicationModelUsage.InstanceBased) + { + throw new InvalidOperationException (ERROR_LEGACY_AFTER_MODERN); + } + + // If this is an instance-based instance and legacy static model was used, throw + if (this != _instance && ModelUsage == ApplicationModelUsage.LegacyStatic) + { + throw new InvalidOperationException (ERROR_MODERN_AFTER_LEGACY); + } + + // If no model has been set yet, set it now based on which instance this is + if (ModelUsage == ApplicationModelUsage.None) + { + ModelUsage = this == _instance ? ApplicationModelUsage.LegacyStatic : ApplicationModelUsage.InstanceBased; + } + } + if (!string.IsNullOrWhiteSpace (driverName)) { _driverName = driverName; @@ -34,36 +59,34 @@ public partial class ApplicationImpl _driverName = ForceDriver; } - Debug.Assert (Navigation is null); - Navigation = new (); + // Debug.Assert (Navigation is null); + // Navigation = new (); - Debug.Assert (Popover is null); - Popover = new (); + //Debug.Assert (Popover is null); + //Popover = new (); // Preserve existing keyboard settings if they exist bool hasExistingKeyboard = _keyboard is { }; - Key existingQuitKey = _keyboard?.QuitKey ?? Key.Esc; - Key existingArrangeKey = _keyboard?.ArrangeKey ?? Key.F5.WithCtrl; - Key existingNextTabKey = _keyboard?.NextTabKey ?? Key.Tab; - Key existingPrevTabKey = _keyboard?.PrevTabKey ?? Key.Tab.WithShift; - Key existingNextTabGroupKey = _keyboard?.NextTabGroupKey ?? Key.F6; - Key existingPrevTabGroupKey = _keyboard?.PrevTabGroupKey ?? Key.F6.WithShift; + Key existingQuitKey = _keyboard?.QuitKey ?? Application.QuitKey; + Key existingArrangeKey = _keyboard?.ArrangeKey ?? Application.ArrangeKey; + Key existingNextTabKey = _keyboard?.NextTabKey ?? Application.NextTabKey; + Key existingPrevTabKey = _keyboard?.PrevTabKey ?? Application.PrevTabKey; + Key existingNextTabGroupKey = _keyboard?.NextTabGroupKey ?? Application.NextTabGroupKey; + Key existingPrevTabGroupKey = _keyboard?.PrevTabGroupKey ?? Application.PrevTabGroupKey; // Reset keyboard to ensure fresh state with default bindings - _keyboard = new KeyboardImpl { Application = this }; + _keyboard = new KeyboardImpl { App = this }; - // Restore previously set keys if they existed and were different from defaults - if (hasExistingKeyboard) - { - _keyboard.QuitKey = existingQuitKey; - _keyboard.ArrangeKey = existingArrangeKey; - _keyboard.NextTabKey = existingNextTabKey; - _keyboard.PrevTabKey = existingPrevTabKey; - _keyboard.NextTabGroupKey = existingNextTabGroupKey; - _keyboard.PrevTabGroupKey = existingPrevTabGroupKey; - } + // Sync keys from Application static properties (or existing keyboard if it had custom values) + // This ensures we respect any Application.QuitKey etc changes made before Init() + _keyboard.QuitKey = existingQuitKey; + _keyboard.ArrangeKey = existingArrangeKey; + _keyboard.NextTabKey = existingNextTabKey; + _keyboard.PrevTabKey = existingPrevTabKey; + _keyboard.NextTabGroupKey = existingNextTabGroupKey; + _keyboard.PrevTabGroupKey = existingPrevTabGroupKey; - CreateDriver (driverName ?? _driverName); + CreateDriver (_driverName); Screen = Driver!.Screen; Initialized = true; @@ -72,10 +95,75 @@ public partial class ApplicationImpl SynchronizationContext.SetSynchronizationContext (new ()); MainThreadId = Thread.CurrentThread.ManagedThreadId; + + _result = null; + + return this; } - /// Shutdown an application initialized with . - public void Shutdown () + #region IDisposable Implementation + + private bool _disposed; + + /// + /// Disposes the application instance and releases all resources. + /// + /// + /// + /// This method implements the pattern and performs the same cleanup + /// as , but without returning a result. + /// + /// + /// After calling , use or + /// to retrieve the result from the last run session. + /// + /// + public void Dispose () + { + Dispose (true); + GC.SuppressFinalize (this); + } + + /// + /// Disposes the application instance and releases all resources. + /// + /// + /// if called from ; + /// if called from finalizer. + /// + protected virtual void Dispose (bool disposing) + { + if (_disposed) + { + return; + } + + if (disposing) + { + // Dispose managed resources + DisposeCore (); + } + + // For the singleton instance (legacy Application.Init/Shutdown pattern), + // we need to allow re-initialization after disposal. This enables: + // Application.Init() -> Application.Shutdown() -> Application.Init() + // For modern instance-based usage, this doesn't matter as new instances are created. + if (this == _instance) + { + // Reset disposed flag to allow re-initialization + _disposed = false; + } + else + { + // For instance-based usage, mark as disposed + _disposed = true; + } + } + + /// + /// Core disposal logic - same as Shutdown() but without returning result. + /// + private void DisposeCore () { // Stop the coordinator if running Coordinator?.Stop (); @@ -114,11 +202,142 @@ public partial class ApplicationImpl // Clear the event to prevent memory leaks InitializedChanged = null; - - // Create a new lazy instance for potential future Init - _lazyInstance = new (() => new ApplicationImpl ()); } + #endregion IDisposable Implementation + + /// Shutdown an application initialized with . + [Obsolete ("Use Dispose() or a using statement instead. This method will be removed in a future version.")] + public object? Shutdown () + { + // Shutdown is now just a wrapper around Dispose that returns the result + object? result = GetResult (); + Dispose (); + + return result; + } + + private object? _result; + + /// + public object? GetResult () => _result; + + /// + public void ResetState (bool ignoreDisposed = false) + { + // Shutdown is the bookend for Init. As such it needs to clean up all resources + // Init created. Apps that do any threading will need to code defensively for this. + // e.g. see Issue #537 + + // === 0. Stop all timers === + TimedEvents?.StopAll (); + + // === 1. Stop all running runnables === + foreach (SessionToken token in SessionStack!.Reverse ()) + { + if (token.Runnable is { }) + { + End (token); + } + } + + // === 2. Close and dispose popover === + if (Popover?.GetActivePopover () is View popover) + { + // This forcefully closes the popover; invoking Command.Quit would be more graceful + // but since this is shutdown, doing this is ok. + popover.Visible = false; + } + + // Any popovers added to Popover have their lifetime controlled by Popover + Popover?.Dispose (); + Popover = null; + + // === 3. Clean up runnables === + SessionStack?.Clear (); + +#if DEBUG_IDISPOSABLE + + // Don't dispose the TopRunnable. It's up to caller dispose it + if (View.EnableDebugIDisposableAsserts && !ignoreDisposed && TopRunnableView is { }) + { + Debug.Assert (TopRunnableView.WasDisposed, $"Title = {TopRunnableView.Title}, Id = {TopRunnableView.Id}"); + } +#endif + + // === 4. Clean up driver === + if (Driver is { }) + { + UnsubscribeDriverEvents (); + Driver?.End (); + Driver = null; + } + + // Reset screen + ResetScreen (); + _screen = null; + + // === 5. Clear run state === + Iteration = null; + SessionBegun = null; + SessionEnded = null; + StopAfterFirstIteration = false; + ClearScreenNextIteration = false; + + // === 6. Reset input systems === + // Dispose keyboard and mouse to unsubscribe from events + if (_keyboard is IDisposable keyboardDisposable) + { + keyboardDisposable.Dispose (); + } + + if (_mouse is IDisposable mouseDisposable) + { + mouseDisposable.Dispose (); + } + + // Mouse and Keyboard will be lazy-initialized on next access + _mouse = null; + _keyboard = null; + Mouse.ResetState (); + + // === 7. Clear navigation and screen state === + ScreenChanged = null; + + //Navigation = null; + + // === 8. Reset initialization state === + Initialized = false; + MainThreadId = null; + + // === 9. Clear graphics === + Sixel.Clear (); + + // === 10. Reset ForceDriver === + // Note: ForceDriver and Force16Colors are reset + // If they need to persist across Init/Shutdown cycles + // then the user of the library should manage that state + Force16Colors = false; + ForceDriver = string.Empty; + + // === 11. Reset synchronization context === + // IMPORTANT: Always reset sync context, even if not initialized + // This ensures cleanup works correctly even if Shutdown is called without Init + // Reset synchronization context to allow the user to run async/await, + // as the main loop has been ended, the synchronization context from + // gui.cs does no longer process any callbacks. See #1084 for more details: + // (https://github.com/gui-cs/Terminal.Gui/issues/1084). + SynchronizationContext.SetSynchronizationContext (null); + + // === 12. Unsubscribe from Application static property change events === + UnsubscribeApplicationEvents (); + } + + /// + /// Raises the event. + /// + internal void RaiseInitializedChanged (object sender, EventArgs e) { InitializedChanged?.Invoke (sender, e); } + #if DEBUG /// /// DEBUG ONLY: Asserts that an event has no remaining subscribers. @@ -149,103 +368,17 @@ public partial class ApplicationImpl } #endif - /// - public void ResetState (bool ignoreDisposed = false) - { - // Shutdown is the bookend for Init. As such it needs to clean up all resources - // Init created. Apps that do any threading will need to code defensively for this. - // e.g. see Issue #537 + // Event handlers for Application static property changes + private void OnForce16ColorsChanged (object? sender, ValueChangedEventArgs e) { Force16Colors = e.NewValue; } - // === 1. Stop all running toplevels === - foreach (Toplevel? t in TopLevels) - { - t!.Running = false; - } - - // === 2. Close and dispose popover === - if (Popover?.GetActivePopover () is View popover) - { - // This forcefully closes the popover; invoking Command.Quit would be more graceful - // but since this is shutdown, doing this is ok. - popover.Visible = false; - } - - Popover?.Dispose (); - Popover = null; - - // === 3. Clean up toplevels === - TopLevels.Clear (); - -#if DEBUG_IDISPOSABLE - - // Don't dispose the Top. It's up to caller dispose it - if (View.EnableDebugIDisposableAsserts && !ignoreDisposed && Top is { }) - { - Debug.Assert (Top.WasDisposed, $"Title = {Top.Title}, Id = {Top.Id}"); - - // If End wasn't called _CachedSessionTokenToplevel may be null - if (CachedSessionTokenToplevel is { }) - { - Debug.Assert (CachedSessionTokenToplevel.WasDisposed); - Debug.Assert (CachedSessionTokenToplevel == Top); - } - } -#endif - - Top = null; - CachedSessionTokenToplevel = null; - - // === 4. Clean up driver === - if (Driver is { }) - { - UnsubscribeDriverEvents (); - Driver?.End (); - Driver = null; - } - - // Reset screen - ResetScreen (); - _screen = null; - - // === 5. Clear run state === - Iteration = null; - SessionBegun = null; - SessionEnded = null; - StopAfterFirstIteration = false; - ClearScreenNextIteration = false; - - // === 6. Reset input systems === - // Mouse and Keyboard will be lazy-initialized on next access - _mouse = null; - _keyboard = null; - Mouse.ResetState (); - - // === 7. Clear navigation and screen state === - ScreenChanged = null; - Navigation = null; - - // === 8. Reset initialization state === - Initialized = false; - MainThreadId = null; - - // === 9. Clear graphics === - Sixel.Clear (); - - // === 10. Reset synchronization context === - // IMPORTANT: Always reset sync context, even if not initialized - // This ensures cleanup works correctly even if Shutdown is called without Init - // Reset synchronization context to allow the user to run async/await, - // as the main loop has been ended, the synchronization context from - // gui.cs does no longer process any callbacks. See #1084 for more details: - // (https://github.com/gui-cs/Terminal.Gui/issues/1084). - SynchronizationContext.SetSynchronizationContext (null); - - // Note: ForceDriver and Force16Colors are NOT reset; - // they need to persist across Init/Shutdown cycles - } + private void OnForceDriverChanged (object? sender, ValueChangedEventArgs e) { ForceDriver = e.NewValue; } /// - /// Raises the event. + /// Unsubscribes from Application static property change events. /// - internal void RaiseInitializedChanged (object sender, EventArgs e) { InitializedChanged?.Invoke (sender, e); } + private void UnsubscribeApplicationEvents () + { + Application.Force16ColorsChanged -= OnForce16ColorsChanged; + Application.ForceDriverChanged -= OnForceDriverChanged; + } } diff --git a/Terminal.Gui/App/ApplicationImpl.Run.cs b/Terminal.Gui/App/ApplicationImpl.Run.cs index fd0564e05..45ad59fab 100644 --- a/Terminal.Gui/App/ApplicationImpl.Run.cs +++ b/Terminal.Gui/App/ApplicationImpl.Run.cs @@ -1,312 +1,44 @@ -#nullable enable -using System.Diagnostics; +using System.Collections.Concurrent; using System.Diagnostics.CodeAnalysis; namespace Terminal.Gui.App; public partial class ApplicationImpl { - /// - /// INTERNAL: Gets or sets the managed thread ID of the application's main UI thread, which is set during - /// and used to determine if code is executing on the main thread. - /// - /// - /// The managed thread ID of the main UI thread, or if the application is not initialized. - /// - internal int? MainThreadId { get; set; } + // Lock object to protect session stack operations and cached state updates + private readonly object _sessionStackLock = new (); - #region Begin->Run->Stop->End + #region Session State - Stack and TopRunnable + + /// + public ConcurrentStack? SessionStack { get; } = new (); + + /// + public IRunnable? TopRunnable { get; private set; } + + /// + public View? TopRunnableView => TopRunnable as View; /// public event EventHandler? SessionBegun; /// - public event EventHandler? SessionEnded; + public event EventHandler? SessionEnded; - /// - public SessionToken Begin (Toplevel toplevel) - { - ArgumentNullException.ThrowIfNull (toplevel); + #endregion Session State - Stack and TopRunnable - // Ensure the mouse is ungrabbed. - if (Mouse.MouseGrabView is { }) - { - Mouse.UngrabMouse (); - } - - var rs = new SessionToken (toplevel); - -#if DEBUG_IDISPOSABLE - if (View.EnableDebugIDisposableAsserts && Top is { } && toplevel != Top && !TopLevels.Contains (Top)) - { - // This assertion confirm if the Top was already disposed - Debug.Assert (Top.WasDisposed); - Debug.Assert (Top == CachedSessionTokenToplevel); - } -#endif - - lock (TopLevels) - { - if (Top is { } && toplevel != Top && !TopLevels.Contains (Top)) - { - // If Top was already disposed and isn't on the Toplevels Stack, - // clean it up here if is the same as _CachedSessionTokenToplevel - if (Top == CachedSessionTokenToplevel) - { - Top = null; - } - else - { - // Probably this will never hit - throw new ObjectDisposedException (Top.GetType ().FullName); - } - } - - // BUGBUG: We should not depend on `Id` internally. - // BUGBUG: It is super unclear what this code does anyway. - if (string.IsNullOrEmpty (toplevel.Id)) - { - var count = 1; - var id = (TopLevels.Count + count).ToString (); - - while (TopLevels.Count > 0 && TopLevels.FirstOrDefault (x => x.Id == id) is { }) - { - count++; - id = (TopLevels.Count + count).ToString (); - } - - toplevel.Id = (TopLevels.Count + count).ToString (); - - TopLevels.Push (toplevel); - } - else - { - Toplevel? dup = TopLevels.FirstOrDefault (x => x.Id == toplevel.Id); - - if (dup is null) - { - TopLevels.Push (toplevel); - } - } - } - - if (Top is null) - { - Top = toplevel; - } - - if ((Top?.Modal == false && toplevel.Modal) - || (Top?.Modal == false && !toplevel.Modal) - || (Top?.Modal == true && toplevel.Modal)) - { - if (toplevel.Visible) - { - if (Top is { HasFocus: true }) - { - Top.HasFocus = false; - } - - // Force leave events for any entered views in the old Top - if (Mouse.GetLastMousePosition () is { }) - { - Mouse.RaiseMouseEnterLeaveEvents (Mouse.GetLastMousePosition ()!.Value, new ()); - } - - Top?.OnDeactivate (toplevel); - Toplevel previousTop = Top!; - - Top = toplevel; - Top.OnActivate (previousTop); - } - } - - // View implements ISupportInitializeNotification which is derived from ISupportInitialize - if (!toplevel.IsInitialized) - { - toplevel.BeginInit (); - toplevel.EndInit (); // Calls Layout - } - - // Try to set initial focus to any TabStop - if (!toplevel.HasFocus) - { - toplevel.SetFocus (); - } - - toplevel.OnLoaded (); - - Instance.LayoutAndDraw (true); - - if (PositionCursor ()) - { - Driver?.UpdateCursor (); - } - - SessionBegun?.Invoke (this, new (rs)); - - return rs; - } + #region Main Loop Iteration /// public bool StopAfterFirstIteration { get; set; } /// - public event EventHandler? Iteration; + public event EventHandler>? Iteration; /// - [RequiresUnreferencedCode ("AOT")] - [RequiresDynamicCode ("AOT")] - public Toplevel Run (Func? errorHandler = null, string? driver = null) { return Run (errorHandler, driver); } + public void RaiseIteration () { Iteration?.Invoke (null, new (this)); } - /// - [RequiresUnreferencedCode ("AOT")] - [RequiresDynamicCode ("AOT")] - public TView Run (Func? errorHandler = null, string? driver = null) - where TView : Toplevel, new () - { - if (!Initialized) - { - // Init() has NOT been called. Auto-initialize as per interface contract. - Init (null, driver); - } - - TView top = new (); - Run (top, errorHandler); - - return top; - } - - - /// - public void Run (Toplevel view, Func? errorHandler = null) - { - Logging.Information ($"Run '{view}'"); - ArgumentNullException.ThrowIfNull (view); - - if (!Initialized) - { - throw new NotInitializedException (nameof (Run)); - } - - if (Driver == null) - { - throw new InvalidOperationException ("Driver was inexplicably null when trying to Run view"); - } - - Top = view; - - SessionToken rs = Application.Begin (view); - - Top.Running = true; - - var firstIteration = true; - - while (TopLevels.TryPeek (out Toplevel? found) && found == view && view.Running) - { - if (Coordinator is null) - { - throw new ($"{nameof (IMainLoopCoordinator)} inexplicably became null during Run"); - } - - Coordinator.RunIteration (); - - if (StopAfterFirstIteration && firstIteration) - { - Logging.Information ("Run - Stopping after first iteration as requested"); - view.RequestStop (); - } - - firstIteration = false; - } - - Logging.Information ("Run - Calling End"); - Application.End (rs); - } - - /// - public void End (SessionToken sessionToken) - { - ArgumentNullException.ThrowIfNull (sessionToken); - - if (Popover?.GetActivePopover () as View is { Visible: true } visiblePopover) - { - ApplicationPopover.HideWithQuitCommand (visiblePopover); - } - - sessionToken.Toplevel.OnUnloaded (); - - // End the Session - // First, take it off the Toplevel Stack - if (TopLevels.TryPop (out Toplevel? topOfStack)) - { - if (topOfStack != sessionToken.Toplevel) - { - // If the top of the stack is not the SessionToken.Toplevel then - // this call to End is not balanced with the call to Begin that started the Session - throw new ArgumentException ("End must be balanced with calls to Begin"); - } - } - - // Notify that it is closing - sessionToken.Toplevel?.OnClosed (sessionToken.Toplevel); - - if (TopLevels.TryPeek (out Toplevel? newTop)) - { - Top = newTop; - Top?.SetNeedsDraw (); - } - - if (sessionToken.Toplevel is { HasFocus: true }) - { - sessionToken.Toplevel.HasFocus = false; - } - - if (Top is { HasFocus: false }) - { - Top.SetFocus (); - } - - CachedSessionTokenToplevel = sessionToken.Toplevel; - - sessionToken.Toplevel = null; - sessionToken.Dispose (); - - // BUGBUG: Why layout and draw here? This causes the screen to be cleared! - //LayoutAndDraw (true); - - SessionEnded?.Invoke (this, new (CachedSessionTokenToplevel)); - } - - /// - public void RequestStop () { RequestStop (null); } - - /// - public void RequestStop (Toplevel? top) - { - Logging.Trace ($"Top: '{(top is { } ? top : "null")}'"); - - top ??= Top; - - if (top == null) - { - return; - } - - ToplevelClosingEventArgs ev = new (top); - top.OnClosing (ev); - - if (ev.Cancel) - { - return; - } - - top.Running = false; - } - - /// - public void RaiseIteration () { Iteration?.Invoke (null, new ()); } - - #endregion Begin->Run->Stop->End + #endregion Main Loop Iteration #region Timeouts and Invoke @@ -316,18 +48,18 @@ public partial class ApplicationImpl public ITimedEvents? TimedEvents => _timedEvents; /// - public object AddTimeout (TimeSpan time, Func callback) { return _timedEvents.Add (time, callback); } + public object AddTimeout (TimeSpan time, Func callback) => _timedEvents.Add (time, callback); /// - public bool RemoveTimeout (object token) { return _timedEvents.Remove (token); } + public bool RemoveTimeout (object token) => _timedEvents.Remove (token); /// - public void Invoke (Action action) + public void Invoke (Action? action) { // If we are already on the main UI thread - if (Top is { Running: true } && MainThreadId == Thread.CurrentThread.ManagedThreadId) + if (TopRunnableView is IRunnable { IsRunning: true } && MainThreadId == Thread.CurrentThread.ManagedThreadId) { - action (); + action?.Invoke (this); return; } @@ -336,7 +68,29 @@ public partial class ApplicationImpl TimeSpan.Zero, () => { - action (); + action?.Invoke (this); + + return false; + } + ); + } + + /// + public void Invoke (Action action) + { + // If we are already on the main UI thread + if (TopRunnableView is IRunnable { IsRunning: true } && MainThreadId == Thread.CurrentThread.ManagedThreadId) + { + action?.Invoke (); + + return; + } + + _timedEvents.Add ( + TimeSpan.Zero, + () => + { + action?.Invoke (); return false; } @@ -344,4 +98,316 @@ public partial class ApplicationImpl } #endregion Timeouts and Invoke + + #region Session Lifecycle - Begin + + /// + public SessionToken? Begin (IRunnable runnable) + { + ArgumentNullException.ThrowIfNull (runnable); + + if (runnable.IsRunning) + { + throw new ArgumentException (@"The runnable is already running.", nameof (runnable)); + } + + // Create session token + SessionToken token = new (runnable); + + // Get old IsRunning value BEFORE any stack changes (safe - cached value) + bool oldIsRunning = runnable.IsRunning; + + // Raise IsRunningChanging OUTSIDE lock (false -> true) - can be canceled + if (runnable.RaiseIsRunningChanging (oldIsRunning, true)) + { + // Starting was canceled + return null; + } + + // Set the application reference in the runnable + runnable.SetApp (this); + + // Ensure the mouse is ungrabbed + Mouse.UngrabMouse (); + + IRunnable? previousTop = null; + + // CRITICAL SECTION - Atomic stack + cached state update + lock (_sessionStackLock) + { + // Get the previous top BEFORE pushing new token + if (SessionStack?.TryPeek (out SessionToken? previousToken) == true && previousToken?.Runnable is { }) + { + previousTop = previousToken.Runnable; + } + + if (previousTop == runnable) + { + throw new ArgumentOutOfRangeException (nameof (runnable), runnable, @"Attempt to Run the runnable that's already the top runnable."); + } + + // Push token onto SessionStack + SessionStack?.Push (token); + + TopRunnable = runnable; + + // Update cached state atomically - IsRunning and IsModal are now consistent + SessionBegun?.Invoke (this, new (token)); + runnable.SetIsRunning (true); + runnable.SetIsModal (true); + + // Previous top is no longer modal + if (previousTop != null) + { + previousTop.SetIsModal (false); + } + } + + // END CRITICAL SECTION - IsRunning/IsModal now thread-safe + + // Fire events AFTER lock released (avoid deadlocks in event handlers) + if (previousTop != null) + { + previousTop.RaiseIsModalChangedEvent (false); + } + + runnable.RaiseIsRunningChangedEvent (true); + runnable.RaiseIsModalChangedEvent (true); + + LayoutAndDraw (); + + return token; + } + + #endregion Session Lifecycle - Begin + + #region Session Lifecycle - Run + + /// + [RequiresUnreferencedCode ("AOT")] + [RequiresDynamicCode ("AOT")] + public IApplication Run (Func? errorHandler = null, string? driverName = null) + where TRunnable : IRunnable, new() + { + if (!Initialized) + { + // Init() has NOT been called. Auto-initialize as per interface contract. + Init (driverName); + } + + if (Driver is null) + { + throw new InvalidOperationException (@"Driver is null after Init."); + } + + TRunnable runnable = new (); + object? result = Run (runnable, errorHandler); + + // We created the runnable, so dispose it if it's disposable + if (runnable is IDisposable disposable) + { + disposable.Dispose (); + } + + return this; + } + + /// + public object? Run (IRunnable runnable, Func? errorHandler = null) + { + ArgumentNullException.ThrowIfNull (runnable); + + if (!Initialized) + { + throw new NotInitializedException (@"Init must be called before Run."); + } + + // Begin the session (adds to stack, raises IsRunningChanging/IsRunningChanged) + SessionToken? token; + + if (runnable.IsRunning) + { + // Find it on the stack + token = SessionStack?.FirstOrDefault (st => st.Runnable == runnable); + } + else + { + token = Begin (runnable); + } + + if (token is null) + { + Logging.Trace (@"Run - Begin session failed or was cancelled."); + + return null; + } + + try + { + // All runnables block until RequestStop() is called + RunLoop (runnable, errorHandler); + } + finally + { + // End the session (raises IsRunningChanging/IsRunningChanged, pops from stack) + End (token); + } + + return token.Result; + } + + private void RunLoop (IRunnable runnable, Func? errorHandler) + { + runnable.StopRequested = false; + + // Main loop - blocks until RequestStop() is called + // Note: IsRunning is now a cached property, safe to check each iteration + var firstIteration = true; + + while (runnable is { StopRequested: false, IsRunning: true }) + { + if (Coordinator is null) + { + throw new ($"{nameof (IMainLoopCoordinator)} inexplicably became null during Run"); + } + + try + { + // Process one iteration of the event loop + Coordinator.RunIteration (); + } + catch (Exception ex) + { + if (errorHandler is null || !errorHandler (ex)) + { + throw; + } + } + + if (StopAfterFirstIteration && firstIteration) + { + Logging.Information ("Run - Stopping after first iteration as requested"); + RequestStop (runnable); + } + + firstIteration = false; + } + } + + #endregion Session Lifecycle - Run + + #region Session Lifecycle - End + + /// + public void End (SessionToken token) + { + ArgumentNullException.ThrowIfNull (token); + + if (token.Runnable is null) + { + return; // Already ended + } + + // TODO: Move Poppover to utilize IRunnable arch; Get all refs to anyting + // TODO: View-related out of ApplicationImpl. + if (Popover?.GetActivePopover () as View is { Visible: true } visiblePopover) + { + ApplicationPopover.HideWithQuitCommand (visiblePopover); + } + + IRunnable runnable = token.Runnable; + + // Get old IsRunning value (safe - cached value) + bool oldIsRunning = runnable.IsRunning; + + // Raise IsRunningChanging OUTSIDE lock (true -> false) - can be canceled + // This is where Result should be extracted! + if (runnable.RaiseIsRunningChanging (oldIsRunning, false)) + { + // Stopping was canceled - do not proceed with End + return; + } + + bool wasModal = runnable.IsModal; + IRunnable? previousRunnable = null; + + // CRITICAL SECTION - Atomic stack + cached state update + lock (_sessionStackLock) + { + // Pop token from SessionStack + if (wasModal && SessionStack?.TryPop (out SessionToken? popped) == true && popped == token) + { + // Restore previous top runnable + if (SessionStack?.TryPeek (out SessionToken? previousToken) == true && previousToken?.Runnable is { }) + { + previousRunnable = previousToken.Runnable; + + // Previous runnable becomes modal again + previousRunnable.SetIsModal (true); + } + } + + // Update cached state atomically - IsRunning and IsModal are now consistent + runnable.SetIsRunning (false); + runnable.SetIsModal (false); + } + + // END CRITICAL SECTION - IsRunning/IsModal now thread-safe + + // Fire events AFTER lock released + if (wasModal) + { + runnable.RaiseIsModalChangedEvent (false); + } + + TopRunnable = null; + + if (previousRunnable != null) + { + TopRunnable = previousRunnable; + previousRunnable.RaiseIsModalChangedEvent (true); + } + + runnable.RaiseIsRunningChangedEvent (false); + + token.Result = runnable.Result; + + _result = token.Result; + + // Clear the Runnable from the token + token.Runnable = null; + SessionEnded?.Invoke (this, new (token)); + } + + #endregion Session Lifecycle - End + + #region Session Lifecycle - RequestStop + + /// + public void RequestStop () { RequestStop (null); } + + /// + public void RequestStop (IRunnable? runnable) + { + // Get the runnable to stop + if (runnable is null) + { + // Try to get from TopRunnable + if (TopRunnableView is IRunnable r) + { + runnable = r; + } + else + { + return; + } + } + + runnable.StopRequested = true; + + // Note: The End() method will be called from the finally block in Run() + // and that's where IsRunningChanging/IsRunningChanged will be raised + } + + #endregion Session Lifecycle - RequestStop } diff --git a/Terminal.Gui/App/ApplicationImpl.Screen.cs b/Terminal.Gui/App/ApplicationImpl.Screen.cs index 3c2f32cb6..07be5ff10 100644 --- a/Terminal.Gui/App/ApplicationImpl.Screen.cs +++ b/Terminal.Gui/App/ApplicationImpl.Screen.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; @@ -45,6 +44,11 @@ public partial class ApplicationImpl /// public bool PositionCursor () { + if (Driver is null) + { + return false; + } + // Find the most focused view and position the cursor there. View? mostFocused = Navigation?.GetFocused (); @@ -66,7 +70,7 @@ public partial class ApplicationImpl Rectangle mostFocusedViewport = mostFocused.ViewportToScreen (mostFocused.Viewport with { Location = Point.Empty }); Rectangle superViewViewport = - mostFocused.SuperView?.ViewportToScreen (mostFocused.SuperView.Viewport with { Location = Point.Empty }) ?? Driver!.Screen; + mostFocused.SuperView?.ViewportToScreen (mostFocused.SuperView.Viewport with { Location = Point.Empty }) ?? Driver.Screen; if (!superViewViewport.IntersectsWith (mostFocusedViewport)) { @@ -122,9 +126,8 @@ public partial class ApplicationImpl } /// - /// INTERNAL: Called when the application's size has changed. Sets the size of all s and fires - /// the - /// event. + /// INTERNAL: Called when the application's screen has changed. + /// Raises the event. /// /// The new screen size and position. private void RaiseScreenChangedEvent (Rectangle screen) @@ -133,13 +136,13 @@ public partial class ApplicationImpl ScreenChanged?.Invoke (this, new (screen)); - foreach (Toplevel t in TopLevels) + foreach (SessionToken t in SessionStack!) { - t.OnSizeChanging (new (screen.Size)); - t.SetNeedsLayout (); + if (t.Runnable is View runnableView) + { + runnableView.SetNeedsLayout (); + } } - - LayoutAndDraw (true); } private void Driver_SizeChanged (object? sender, SizeChangedEventArgs e) { RaiseScreenChangedEvent (new (new (0, 0), e.Size!.Value)); } @@ -147,7 +150,7 @@ public partial class ApplicationImpl /// public void LayoutAndDraw (bool forceRedraw = false) { - List tops = [.. TopLevels]; + List tops = [.. SessionStack!.Select(r => r.Runnable! as View)!]; if (Popover?.GetActivePopover () as View is { Visible: true } visiblePopover) { @@ -156,7 +159,7 @@ public partial class ApplicationImpl tops.Insert (0, visiblePopover); } - bool neededLayout = View.Layout (tops.ToArray ().Reverse (), Screen.Size); + bool neededLayout = View.Layout (tops.ToArray ().Reverse ()!, Screen.Size); if (ClearScreenNextIteration) { @@ -169,9 +172,13 @@ public partial class ApplicationImpl Driver?.ClearContents (); } - View.SetClipToScreen (); - View.Draw (tops, neededLayout || forceRedraw); - View.SetClipToScreen (); - Driver?.Refresh (); + if (Driver is { }) + { + Driver.Clip = new (Screen); + + View.Draw (views: tops!, neededLayout || forceRedraw); + Driver.Clip = new (Screen); + Driver?.Refresh (); + } } } diff --git a/Terminal.Gui/App/ApplicationImpl.cs b/Terminal.Gui/App/ApplicationImpl.cs index d3b0277ba..b92f388a2 100644 --- a/Terminal.Gui/App/ApplicationImpl.cs +++ b/Terminal.Gui/App/ApplicationImpl.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Concurrent; namespace Terminal.Gui.App; @@ -10,101 +9,230 @@ namespace Terminal.Gui.App; public partial class ApplicationImpl : IApplication { /// - /// Creates a new instance of the Application backend. + /// INTERNAL: Creates a new instance of the Application backend and subscribes to Application configuration property + /// events. /// - public ApplicationImpl () { } + internal ApplicationImpl () + { + // Subscribe to Application static property change events + Application.Force16ColorsChanged += OnForce16ColorsChanged; + Application.ForceDriverChanged += OnForceDriverChanged; + } /// /// INTERNAL: Creates a new instance of the Application backend. /// /// - internal ApplicationImpl (IComponentFactory componentFactory) { _componentFactory = componentFactory; } - - #region Singleton - - // Private static readonly Lazy instance of Application - private static Lazy _lazyInstance = new (() => new ApplicationImpl ()); - - /// - /// Change the singleton implementation, should not be called except before application - /// startup. This method lets you provide alternative implementations of core static gateway - /// methods of . - /// - /// - public static void ChangeInstance (IApplication? newApplication) { _lazyInstance = new (newApplication!); } - - /// - /// Gets the currently configured backend implementation of gateway methods. - /// Change to your own implementation by using (before init). - /// - public static IApplication Instance => _lazyInstance.Value; - - #endregion Singleton + internal ApplicationImpl (IComponentFactory componentFactory) : this () { _componentFactory = componentFactory; } private string? _driverName; + /// + public new string ToString () => Driver?.ToString () ?? string.Empty; - #region Input - - private IMouse? _mouse; + #region Singleton - Legacy Static Support /// - /// Handles mouse event state and processing. + /// Lock object for synchronizing access to ModelUsage and _instance. /// - public IMouse Mouse + private static readonly object _modelUsageLock = new (); + + /// + /// Tracks which application model has been used in this process. + /// + public static ApplicationModelUsage ModelUsage { get; private set; } = ApplicationModelUsage.None; + + /// + /// Error message for when trying to use modern model after legacy static model. + /// + internal const string ERROR_MODERN_AFTER_LEGACY = + "Cannot use modern instance-based model (Application.Create) after using legacy static Application model (Application.Init/ApplicationImpl.Instance). " + + "Use only one model per process."; + + /// + /// Error message for when trying to use legacy static model after modern model. + /// + internal const string ERROR_LEGACY_AFTER_MODERN = + "Cannot use legacy static Application model (Application.Init/ApplicationImpl.Instance) after using modern instance-based model (Application.Create). " + + "Use only one model per process."; + + /// + /// Configures the singleton instance of to use the specified backend implementation. + /// + /// + public static void SetInstance (IApplication? app) + { + lock (_modelUsageLock) + { + ModelUsage = ApplicationModelUsage.LegacyStatic; + _instance = app; + } + } + + // Private static readonly Lazy instance of Application + private static IApplication? _instance; + + /// + /// Gets the currently configured backend implementation of gateway methods. + /// + public static IApplication Instance { get { - if (_mouse is null) - { - _mouse = new MouseImpl { Application = this }; - } + //Debug.Fail ("ApplicationImpl.Instance accessed - parallelizable tests should not use legacy static Application model"); - return _mouse; + // Thread-safe: Use lock to make check-and-create atomic + lock (_modelUsageLock) + { + // If an instance already exists, return it without fence checking + // This allows for cleanup/reset operations + if (_instance is { }) + { + return _instance; + } + + // Check if the instance-based model has already been used + if (ModelUsage == ApplicationModelUsage.InstanceBased) + { + throw new InvalidOperationException (ERROR_LEGACY_AFTER_MODERN); + } + + // Mark the usage and create the instance + ModelUsage = ApplicationModelUsage.LegacyStatic; + + return _instance = new ApplicationImpl (); + } } - set => _mouse = value ?? throw new ArgumentNullException (nameof (value)); } - private IKeyboard? _keyboard; - private bool _stopAfterFirstIteration; + /// + /// INTERNAL: Marks that the instance-based model has been used. Called by Application.Create(). + /// + internal static void MarkInstanceBasedModelUsed () + { + lock (_modelUsageLock) + { + // Check if the legacy static model has already been initialized + if (ModelUsage == ApplicationModelUsage.LegacyStatic && _instance?.Initialized == true) + { + throw new InvalidOperationException (ERROR_MODERN_AFTER_LEGACY); + } + + ModelUsage = ApplicationModelUsage.InstanceBased; + } + } /// - /// Handles keyboard input and key bindings at the Application level + /// INTERNAL: Resets the model usage tracking. Only for testing purposes. /// + internal static void ResetModelUsageTracking () + { + lock (_modelUsageLock) + { + ModelUsage = ApplicationModelUsage.None; + _instance = null; + } + } + + /// + /// INTERNAL: Resets state without going through the fence-checked Instance property. + /// Used by Application.ResetState() to allow cleanup regardless of which model was used. + /// + internal static void ResetStateStatic (bool ignoreDisposed = false) + { + // If an instance exists, reset it + _instance?.ResetState (ignoreDisposed); + + // Reset Application static properties to their defaults + // This ensures tests start with clean state + Application.ForceDriver = string.Empty; + Application.Force16Colors = false; + Application.IsMouseDisabled = false; + Application.QuitKey = Key.Esc; + Application.ArrangeKey = Key.F5.WithCtrl; + Application.NextTabGroupKey = Key.F6; + Application.NextTabKey = Key.Tab; + Application.PrevTabGroupKey = Key.F6.WithShift; + Application.PrevTabKey = Key.Tab.WithShift; + + // Always reset the model tracking to allow tests to use either model after reset + ResetModelUsageTracking (); + } + + #endregion Singleton - Legacy Static Support + + #region Screen and Driver + + /// + public IClipboard? Clipboard => Driver?.Clipboard; + + #endregion Screen and Driver + + #region Keyboard + + private IKeyboard? _keyboard; + + /// public IKeyboard Keyboard { get { - if (_keyboard is null) - { - _keyboard = new KeyboardImpl { Application = this }; - } + _keyboard ??= new KeyboardImpl { App = this }; return _keyboard; } set => _keyboard = value ?? throw new ArgumentNullException (nameof (value)); } - #endregion Input + #endregion Keyboard - #region View Management + #region Mouse + + private IMouse? _mouse; /// - public ApplicationPopover? Popover { get; set; } + public IMouse Mouse + { + get + { + _mouse ??= new MouseImpl { App = this }; + + return _mouse; + } + set => _mouse = value ?? throw new ArgumentNullException (nameof (value)); + } + + #endregion Mouse + + #region Navigation and Popover + + private ApplicationNavigation? _navigation; /// - public ApplicationNavigation? Navigation { get; set; } + public ApplicationNavigation? Navigation + { + get + { + _navigation ??= new () { App = this }; + + return _navigation; + } + set => _navigation = value ?? throw new ArgumentNullException (nameof (value)); + } + + private ApplicationPopover? _popover; /// - public Toplevel? Top { get; set; } + public ApplicationPopover? Popover + { + get + { + _popover ??= new () { App = this }; - // BUGBUG: Technically, this is not the full lst of TopLevels. There be dragons here, e.g. see how Toplevel.Id is used. What + return _popover; + } + set => _popover = value; + } - /// - public ConcurrentStack TopLevels { get; } = new (); - - /// - public Toplevel? CachedSessionTokenToplevel { get; set; } - - #endregion View Management + #endregion Navigation and Popover } diff --git a/Terminal.Gui/App/ApplicationModelUsage.cs b/Terminal.Gui/App/ApplicationModelUsage.cs new file mode 100644 index 000000000..909291d70 --- /dev/null +++ b/Terminal.Gui/App/ApplicationModelUsage.cs @@ -0,0 +1,16 @@ +namespace Terminal.Gui.App; + +/// +/// Defines the different application usage models. +/// +public enum ApplicationModelUsage +{ + /// No model has been used yet. + None, + + /// Legacy static model (Application.Init/ApplicationImpl.Instance). + LegacyStatic, + + /// Modern instance-based model (Application.Create). + InstanceBased +} diff --git a/Terminal.Gui/App/ApplicationNavigation.cs b/Terminal.Gui/App/ApplicationNavigation.cs index 4a64b037b..871bd3691 100644 --- a/Terminal.Gui/App/ApplicationNavigation.cs +++ b/Terminal.Gui/App/ApplicationNavigation.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; @@ -14,9 +13,14 @@ public class ApplicationNavigation /// public ApplicationNavigation () { - // TODO: Move navigation key bindings here from AddApplicationKeyBindings + // TODO: Move navigation key bindings here from KeyboardImpl } + /// + /// The instance used by this instance. + /// + public IApplication? App { get; set; } + private View? _focused; /// @@ -105,10 +109,10 @@ public class ApplicationNavigation /// public bool AdvanceFocus (NavigationDirection direction, TabBehavior? behavior) { - if (Application.Popover?.GetActivePopover () as View is { Visible: true } visiblePopover) + if (App?.Popover?.GetActivePopover () as View is { Visible: true } visiblePopover) { return visiblePopover.AdvanceFocus (direction, behavior); } - return Application.Top is { } && Application.Top.AdvanceFocus (direction, behavior); + return App?.TopRunnableView is { } && App.TopRunnableView.AdvanceFocus (direction, behavior); } } diff --git a/Terminal.Gui/App/ApplicationPopover.cs b/Terminal.Gui/App/ApplicationPopover.cs index 69430dbab..a8d3ba00b 100644 --- a/Terminal.Gui/App/ApplicationPopover.cs +++ b/Terminal.Gui/App/ApplicationPopover.cs @@ -1,12 +1,11 @@ -#nullable enable using System.Diagnostics; namespace Terminal.Gui.App; /// -/// Helper class for support of views for . Held by -/// +/// Helper class for support of views for . Held by +/// /// public sealed class ApplicationPopover : IDisposable { @@ -15,6 +14,11 @@ public sealed class ApplicationPopover : IDisposable /// public ApplicationPopover () { } + /// + /// The instance used by this instance. + /// + public IApplication? App { get; set; } + private readonly List _popovers = []; /// @@ -35,10 +39,14 @@ public sealed class ApplicationPopover : IDisposable /// , after it has been registered. public IPopover? Register (IPopover? popover) { - if (popover is { } && !_popovers.Contains (popover)) + if (popover is { } && !IsRegistered (popover)) { - // When created, set IPopover.Toplevel to the current Application.Top - popover.Toplevel ??= Application.Top; + popover.Current ??= App?.TopRunnableView as IRunnable; + + if (popover is View popoverView) + { + popoverView.App = App; + } _popovers.Add (popover); } @@ -46,6 +54,13 @@ public sealed class ApplicationPopover : IDisposable return popover; } + /// + /// Indicates whether a popover has been registered or not. + /// + /// + /// + public bool IsRegistered (IPopover? popover) => popover is { } && _popovers.Contains (popover); + /// /// De-registers with the application. Use this to remove the popover and it's /// keyboard bindings from the application. @@ -59,7 +74,7 @@ public sealed class ApplicationPopover : IDisposable /// public bool DeRegister (IPopover? popover) { - if (popover is null || !_popovers.Contains (popover)) + if (popover is null || !IsRegistered (popover)) { return false; } @@ -100,9 +115,14 @@ public sealed class ApplicationPopover : IDisposable /// public void Show (IPopover? popover) { + if (!IsRegistered (popover)) + { + throw new InvalidOperationException (@"Popovers must be registered before being shown."); + } // If there's an existing popover, hide it. if (_activePopover is View popoverView) { + popoverView.App = App; popoverView.Visible = false; _activePopover = null; } @@ -120,9 +140,6 @@ public sealed class ApplicationPopover : IDisposable throw new InvalidOperationException ("Popovers must have a key binding for Command.Quit."); } - - Register (popover); - if (!newPopover.IsInitialized) { newPopover.BeginInit (); @@ -148,7 +165,7 @@ public sealed class ApplicationPopover : IDisposable { _activePopover = null; popoverView.Visible = false; - Application.Top?.SetNeedsDraw (); + popoverView.App?.TopRunnableView?.SetNeedsDraw (); } } @@ -177,7 +194,7 @@ public sealed class ApplicationPopover : IDisposable internal bool DispatchKeyDown (Key key) { // Do active first - Active gets all key down events. - var activePopover = GetActivePopover () as View; + View? activePopover = GetActivePopover () as View; if (activePopover is { Visible: true }) { @@ -197,13 +214,14 @@ public sealed class ApplicationPopover : IDisposable { if (popover == activePopover || popover is not View popoverView - || (popover.Toplevel is { } && popover.Toplevel != Application.Top)) + || (popover.Current is { } && popover.Current != App?.TopRunnableView)) { continue; } // hotKeyHandled = popoverView.InvokeCommandsBoundToHotKey (key); //Logging.Debug ($"Inactive - Calling NewKeyDownEvent ({key}) on {popoverView.Title}"); + popoverView.App ??= App; hotKeyHandled = popoverView.NewKeyDownEvent (key); if (hotKeyHandled is true) diff --git a/Terminal.Gui/App/ApplicationRunnableExtensions.cs b/Terminal.Gui/App/ApplicationRunnableExtensions.cs new file mode 100644 index 000000000..3eb03c081 --- /dev/null +++ b/Terminal.Gui/App/ApplicationRunnableExtensions.cs @@ -0,0 +1,158 @@ +namespace Terminal.Gui.App; + +/// +/// Extension methods for that enable running any as a runnable session. +/// +/// +/// These extensions provide convenience methods for wrapping views in +/// and running them in a single call, similar to how works. +/// +public static class ApplicationRunnableExtensions +{ + /// + /// Runs any View as a runnable session, extracting a typed result via a function. + /// + /// The type of view to run. + /// The type of result data to extract. + /// The application instance. Cannot be null. + /// The view to run as a blocking session. Cannot be null. + /// + /// Function that extracts the result from the view when stopping. + /// Called automatically when the runnable session ends. + /// + /// Optional handler for unhandled exceptions during the session. + /// The extracted result, or null if the session was canceled. + /// + /// Thrown if , , or is null. + /// + /// + /// + /// This method wraps the view in a , runs it as a blocking + /// session, and returns the extracted result. The wrapper is NOT disposed automatically; + /// the caller is responsible for disposal. + /// + /// + /// The result is extracted before the view is disposed, ensuring all data is still accessible. + /// + /// + /// + /// + /// var app = Application.Create(); + /// app.Init(); + /// + /// // Run a TextField and get the entered text + /// var text = app.RunView( + /// new TextField { Width = 40 }, + /// tf => tf.Text); + /// Console.WriteLine($"You entered: {text}"); + /// + /// // Run a ColorPicker and get the selected color + /// var color = app.RunView( + /// new ColorPicker(), + /// cp => cp.SelectedColor); + /// Console.WriteLine($"Selected color: {color}"); + /// + /// // Run a FlagSelector and get the selected flags + /// var flags = app.RunView( + /// new FlagSelector<SelectorStyles>(), + /// fs => fs.Value); + /// Console.WriteLine($"Selected styles: {flags}"); + /// + /// app.Shutdown(); + /// + /// + public static TResult? RunView ( + this IApplication app, + TView view, + Func resultExtractor, + Func? errorHandler = null) + where TView : View + { + if (app is null) + { + throw new ArgumentNullException (nameof (app)); + } + + if (view is null) + { + throw new ArgumentNullException (nameof (view)); + } + + if (resultExtractor is null) + { + throw new ArgumentNullException (nameof (resultExtractor)); + } + + var wrapper = new RunnableWrapper { WrappedView = view }; + + // Subscribe to IsRunningChanging to extract result when stopping + wrapper.IsRunningChanging += (s, e) => + { + if (!e.NewValue) // Stopping + { + wrapper.Result = resultExtractor (view); + } + }; + + app.Run (wrapper, errorHandler); + + return wrapper.Result; + } + + /// + /// Runs any View as a runnable session without result extraction. + /// + /// The type of view to run. + /// The application instance. Cannot be null. + /// The view to run as a blocking session. Cannot be null. + /// Optional handler for unhandled exceptions during the session. + /// The view that was run, allowing access to its state after the session ends. + /// Thrown if or is null. + /// + /// + /// This method wraps the view in a and runs it as a blocking + /// session. The wrapper is NOT disposed automatically; the caller is responsible for disposal. + /// + /// + /// Use this overload when you don't need automatic result extraction, but still want the view + /// to run as a blocking session. Access the view's properties directly after running. + /// + /// + /// + /// + /// var app = Application.Create(); + /// app.Init(); + /// + /// // Run a ColorPicker without automatic result extraction + /// var colorPicker = new ColorPicker(); + /// app.RunView(colorPicker); + /// + /// // Access the view's state directly + /// Console.WriteLine($"Selected: {colorPicker.SelectedColor}"); + /// + /// app.Shutdown(); + /// + /// + public static TView RunView ( + this IApplication app, + TView view, + Func? errorHandler = null) + where TView : View + { + if (app is null) + { + throw new ArgumentNullException (nameof (app)); + } + + if (view is null) + { + throw new ArgumentNullException (nameof (view)); + } + + var wrapper = new RunnableWrapper { WrappedView = view }; + + app.Run (wrapper, errorHandler); + + return view; + } +} diff --git a/Terminal.Gui/App/CWP/CWPEventHelper.cs b/Terminal.Gui/App/CWP/CWPEventHelper.cs index d85d184d5..4840a358c 100644 --- a/Terminal.Gui/App/CWP/CWPEventHelper.cs +++ b/Terminal.Gui/App/CWP/CWPEventHelper.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; using System; @@ -53,4 +52,4 @@ public static class CWPEventHelper eventHandler.Invoke (null, args); return args.Handled; } -} \ No newline at end of file +} diff --git a/Terminal.Gui/App/CWP/CWPPropertyHelper.cs b/Terminal.Gui/App/CWP/CWPPropertyHelper.cs index 2ea94ce97..09bcd7fa0 100644 --- a/Terminal.Gui/App/CWP/CWPPropertyHelper.cs +++ b/Terminal.Gui/App/CWP/CWPPropertyHelper.cs @@ -1,7 +1,5 @@ namespace Terminal.Gui.App; -#nullable enable - /// /// Provides helper methods for executing property change workflows in the Cancellable Work Pattern (CWP). /// diff --git a/Terminal.Gui/App/CWP/CWPWorkflowHelper.cs b/Terminal.Gui/App/CWP/CWPWorkflowHelper.cs index 401f17fb8..4c0328589 100644 --- a/Terminal.Gui/App/CWP/CWPWorkflowHelper.cs +++ b/Terminal.Gui/App/CWP/CWPWorkflowHelper.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; using System; @@ -126,4 +125,4 @@ public static class CWPWorkflowHelper } return args.Result!; } -} \ No newline at end of file +} diff --git a/Terminal.Gui/App/CWP/CancelEventArgs.cs b/Terminal.Gui/App/CWP/CancelEventArgs.cs index 7378b722a..422fa5323 100644 --- a/Terminal.Gui/App/CWP/CancelEventArgs.cs +++ b/Terminal.Gui/App/CWP/CancelEventArgs.cs @@ -1,4 +1,3 @@ -#nullable enable using System.ComponentModel; namespace Terminal.Gui.App; diff --git a/Terminal.Gui/App/CWP/EventArgs.cs b/Terminal.Gui/App/CWP/EventArgs.cs index fe7644264..edd1cc450 100644 --- a/Terminal.Gui/App/CWP/EventArgs.cs +++ b/Terminal.Gui/App/CWP/EventArgs.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; #pragma warning disable CS1711 diff --git a/Terminal.Gui/App/CWP/ResultEventArgs.cs b/Terminal.Gui/App/CWP/ResultEventArgs.cs index d75627c3b..e8a3f67c0 100644 --- a/Terminal.Gui/App/CWP/ResultEventArgs.cs +++ b/Terminal.Gui/App/CWP/ResultEventArgs.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; using System; @@ -42,4 +41,4 @@ public class ResultEventArgs Result = result; } } -#pragma warning restore CS1711 \ No newline at end of file +#pragma warning restore CS1711 diff --git a/Terminal.Gui/App/CWP/ValueChangedEventArgs.cs b/Terminal.Gui/App/CWP/ValueChangedEventArgs.cs index d04c42825..880c59245 100644 --- a/Terminal.Gui/App/CWP/ValueChangedEventArgs.cs +++ b/Terminal.Gui/App/CWP/ValueChangedEventArgs.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; /// diff --git a/Terminal.Gui/App/CWP/ValueChangingEventArgs.cs b/Terminal.Gui/App/CWP/ValueChangingEventArgs.cs index fed087b8c..15d4688b2 100644 --- a/Terminal.Gui/App/CWP/ValueChangingEventArgs.cs +++ b/Terminal.Gui/App/CWP/ValueChangingEventArgs.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; /// @@ -41,4 +40,4 @@ public class ValueChangingEventArgs CurrentValue = currentValue; NewValue = newValue; } -} \ No newline at end of file +} diff --git a/Terminal.Gui/App/Clipboard/Clipboard.cs b/Terminal.Gui/App/Clipboard/Clipboard.cs index f8cf39892..42472e414 100644 --- a/Terminal.Gui/App/Clipboard/Clipboard.cs +++ b/Terminal.Gui/App/Clipboard/Clipboard.cs @@ -1,8 +1,10 @@ -#nullable enable namespace Terminal.Gui.App; /// Provides cut, copy, and paste support for the OS clipboard. /// +/// +/// DEPRECATED: This static class is obsolete. Use instead. +/// /// On Windows, the class uses the Windows Clipboard APIs via P/Invoke. /// /// On Linux, when not running under Windows Subsystem for Linux (WSL), the class uses @@ -17,6 +19,7 @@ namespace Terminal.Gui.App; /// the Mac clipboard APIs vai P/Invoke. /// /// +[Obsolete ("Use IApplication.Clipboard instead. The static Clipboard class will be removed in a future release.")] public static class Clipboard { private static string? _contents = string.Empty; @@ -31,7 +34,7 @@ public static class Clipboard if (IsSupported) { // throw new InvalidOperationException ($"{Application.Driver?.GetType ().Name}.GetClipboardData returned null instead of string.Empty"); - string? clipData = Application.Driver?.Clipboard?.GetClipboardData () ?? string.Empty; + string clipData = Application.Driver?.Clipboard?.GetClipboardData () ?? string.Empty; _contents = clipData; } @@ -66,4 +69,32 @@ public static class Clipboard /// Returns true if the environmental dependencies are in place to interact with the OS clipboard. /// public static bool IsSupported => Application.Driver?.Clipboard?.IsSupported ?? false; -} \ No newline at end of file + + /// Gets the OS clipboard data if possible. + /// The clipboard data if successful. + /// if the clipboard data was retrieved successfully; otherwise, . + public static bool TryGetClipboardData (out string result) + { + result = string.Empty; + + if (IsSupported && Application.Driver?.Clipboard is { }) + { + return Application.Driver.Clipboard.TryGetClipboardData (out result); + } + + return false; + } + + /// Sets the OS clipboard data if possible. + /// The text to set. + /// if the clipboard data was set successfully; otherwise, . + public static bool TrySetClipboardData (string text) + { + if (IsSupported && Application.Driver?.Clipboard is { }) + { + return Application.Driver.Clipboard.TrySetClipboardData (text); + } + + return false; + } +} diff --git a/Terminal.Gui/App/Clipboard/ClipboardBase.cs b/Terminal.Gui/App/Clipboard/ClipboardBase.cs index 97cfec61e..46a1f26bf 100644 --- a/Terminal.Gui/App/Clipboard/ClipboardBase.cs +++ b/Terminal.Gui/App/Clipboard/ClipboardBase.cs @@ -1,3 +1,4 @@ +#nullable disable using System.Diagnostics; namespace Terminal.Gui.App; diff --git a/Terminal.Gui/App/Clipboard/ClipboardProcessRunner.cs b/Terminal.Gui/App/Clipboard/ClipboardProcessRunner.cs index 214b5337d..70c471d74 100644 --- a/Terminal.Gui/App/Clipboard/ClipboardProcessRunner.cs +++ b/Terminal.Gui/App/Clipboard/ClipboardProcessRunner.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; namespace Terminal.Gui.App; @@ -45,7 +44,6 @@ internal static class ClipboardProcessRunner CreateNoWindow = true }; - TaskCompletionSource eventHandled = new (); process.Start (); if (!string.IsNullOrEmpty (input)) diff --git a/Terminal.Gui/App/IApplication.cs b/Terminal.Gui/App/IApplication.cs index 64620f09e..4d0959a2f 100644 --- a/Terminal.Gui/App/IApplication.cs +++ b/Terminal.Gui/App/IApplication.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Collections.Concurrent; +using System.Collections.Concurrent; using System.Diagnostics.CodeAnalysis; namespace Terminal.Gui.App; @@ -8,70 +7,76 @@ namespace Terminal.Gui.App; /// Interface for instances that provide backing functionality to static /// gateway class . /// -public interface IApplication +/// +/// +/// Implements to support automatic resource cleanup via using statements. +/// Call or use a using statement to properly clean up resources. +/// +/// +public interface IApplication : IDisposable { - #region Keyboard + #region Lifecycle - App Initialization and Shutdown /// - /// Handles keyboard input and key bindings at the Application level. + /// Gets or sets the managed thread ID of the application's main UI thread, which is set during + /// and used to determine if code is executing on the main thread. /// - /// - /// - /// Provides access to keyboard state, key bindings, and keyboard event handling. Set during . - /// - /// - IKeyboard Keyboard { get; set; } - - #endregion Keyboard - - #region Mouse - - /// - /// Handles mouse event state and processing. - /// - /// - /// - /// Provides access to mouse state, mouse grabbing, and mouse event handling. Set during . - /// - /// - IMouse Mouse { get; set; } - - #endregion Mouse - - #region Initialization and Shutdown + /// + /// The managed thread ID of the main UI thread, or if the application is not initialized. + /// + public int? MainThreadId { get; internal set; } /// Initializes a new instance of Application. - /// - /// The to use. If neither or - /// are specified the default driver for the platform will be used. - /// /// /// The short name (e.g. "dotnet", "windows", "unix", or "fake") of the - /// to use. If neither or are - /// specified the default driver for the platform will be used. + /// to use. If not specified the default driver for the platform will be used. /// + /// This instance for fluent API chaining. /// - /// Call this method once per instance (or after has been called). + /// Call this method once per instance (or after has been called). /// /// This function loads the right for the platform, creates a main loop coordinator, /// initializes keyboard and mouse handlers, and subscribes to driver events. /// /// - /// must be called when the application is closing (typically after - /// has returned) to ensure resources are cleaned up and terminal settings restored. + /// must be called when the application is closing (typically after + /// has returned) to ensure all resources are cleaned up (disposed) and + /// terminal settings are restored. /// /// - /// The function combines and - /// into a single call. An application can use - /// without explicitly calling . + /// Supports fluent API with automatic resource management: + /// + /// + /// Recommended pattern (using statement): + /// + /// using (var app = Application.Create().Init()) + /// { + /// app.Run<MyDialog>(); + /// var result = app.GetResult<MyResultType>(); + /// } // app.Dispose() called automatically + /// + /// + /// + /// Alternative pattern (manual disposal): + /// + /// var app = Application.Create().Init(); + /// app.Run<MyDialog>(); + /// var result = app.GetResult<MyResultType>(); + /// app.Dispose(); // Must call explicitly + /// + /// + /// + /// Note: Runnables created by are automatically disposed when + /// that method returns. Runnables passed to + /// must be disposed by the caller. /// /// [RequiresUnreferencedCode ("AOT")] [RequiresDynamicCode ("AOT")] - public void Init (IDriver? driver = null, string? driverName = null); + public IApplication Init (string? driverName = null); /// - /// This event is raised after the and methods have been called. + /// This event is raised after the and methods have been called. /// /// /// Intended to support unit tests that need to know when the application has been initialized. @@ -81,110 +86,165 @@ public interface IApplication /// Gets or sets whether the application has been initialized. bool Initialized { get; set; } - /// Shutdown an application initialized with . - /// - /// Shutdown must be called for every call to or - /// to ensure all resources are cleaned - /// up (Disposed) and terminal settings are restored. - /// - public void Shutdown (); - /// - /// Resets the state of this instance. + /// INTERNAL: Resets the state of this instance. Called by Dispose. /// /// If true, ignores disposed state checks during reset. /// /// /// Encapsulates all setting of initial state for Application; having this in a function like this ensures we /// don't make mistakes in guaranteeing that the state of this singleton is deterministic when - /// starts running and after returns. + /// starts running and after returns. /// /// /// IMPORTANT: Ensure all property/fields are reset here. See Init_ResetState_Resets_Properties unit test. /// /// - public void ResetState (bool ignoreDisposed = false); + internal void ResetState (bool ignoreDisposed = false); - #endregion Initialization and Shutdown + #endregion App Initialization and Shutdown - #region Begin->Run->Iteration->Stop->End + #region Session Management - Begin->Run->Iteration->Stop->End /// - /// Building block API: Creates a and prepares the provided for - /// execution. Not usually called directly by applications. Use - /// instead. + /// Gets the stack of all active runnable session tokens. + /// Sessions execute serially - the top of stack is the currently modal session. /// - /// - /// The that needs to be passed to the method upon - /// completion. - /// - /// The to prepare execution for. /// /// - /// This method prepares the provided for running. It adds this to the - /// list of s, lays out the SubViews, focuses the first element, and draws the - /// on the screen. This is usually followed by starting the main loop, and then the + /// Session tokens are pushed onto the stack when is called and + /// popped when + /// completes. The stack grows during nested modal calls and + /// shrinks as they complete. + /// + /// + /// Only the top session () has exclusive keyboard/mouse input ( + /// = true). + /// All other sessions on the stack continue to be laid out, drawn, and receive iteration events ( + /// = true), + /// but they don't receive user input. + /// + /// + /// Stack during nested modals: + /// + /// RunnableSessionStack (top to bottom): + /// - MessageBox (TopRunnable, IsModal=true, IsRunning=true, has input) + /// - FileDialog (IsModal=false, IsRunning=true, continues to update/draw) + /// - MainWindow (IsModal=false, IsRunning=true, continues to update/draw) + /// + /// + /// + ConcurrentStack? SessionStack { get; } + + /// + /// Raised when has been called and has created a new . + /// + /// + /// If is , callers to + /// must also subscribe to and manually dispose of the token + /// when the application is done. + /// + public event EventHandler? SessionBegun; + + #region TopRunnable Properties + + /// Gets the Runnable that is on the top of the . + /// + /// + /// The top runnable in the session stack captures all mouse and keyboard input. + /// This is set by and cleared by . + /// + /// + IRunnable? TopRunnable { get; } + + /// Gets the View that is on the top of the . + /// + /// + /// This is a convenience property that casts to a . + /// + /// + View? TopRunnableView { get; } + + #endregion TopRunnable Properties + + /// + /// Building block API: Creates a and prepares the provided + /// for + /// execution. Not usually called directly by applications. Use + /// instead. + /// + /// The to prepare execution for. + /// + /// The that needs to be passed to the + /// method upon + /// completion. + /// + /// + /// + /// This method prepares the provided for running. It adds this to the + /// , lays out the SubViews, focuses the first element, and draws the + /// runnable on the screen. This is usually followed by starting the main loop, and then the /// method upon termination which will undo these changes. /// /// - /// Raises the event before returning. + /// Raises the , , + /// and events. /// /// - public SessionToken Begin (Toplevel toplevel); + /// The session token. if the operation was cancelled. + SessionToken? Begin (IRunnable runnable); /// - /// Runs a new Session creating a and calling . When the session is - /// stopped, will be called. + /// Runs a new Session with the provided runnable view. /// - /// Handler for any unhandled exceptions (resumes when returns true, rethrows when null). - /// - /// The driver name. If not specified the default driver for the platform will be used. Must be - /// if has already been called. - /// - /// The created . The caller is responsible for disposing this object. + /// The runnable to execute. + /// Optional handler for unhandled exceptions (resumes when returns true, rethrows when null). /// - /// Calling first is not needed as this function will initialize the application. /// - /// must be called when the application is closing (typically after Run has returned) to - /// ensure resources are cleaned up and terminal settings restored. + /// This method is used to start processing events for the main application, but it is also used to run other + /// modal views such as dialogs. /// /// - /// The caller is responsible for disposing the object returned by this method. + /// To make stop execution, call + /// or . + /// + /// + /// Calling is equivalent to calling + /// , followed by starting the main loop, and then calling + /// . + /// + /// + /// In RELEASE builds: When is any exceptions will be + /// rethrown. Otherwise, will be called. If + /// returns the main loop will resume; otherwise this method will exit. /// /// - [RequiresUnreferencedCode ("AOT")] - [RequiresDynamicCode ("AOT")] - public Toplevel Run (Func? errorHandler = null, string? driver = null); + object? Run (IRunnable runnable, Func? errorHandler = null); /// - /// Runs a new Session creating a -derived object of type - /// and calling . When the session is stopped, + /// Runs a new Session creating a -derived object of type + /// and calling . When the session is stopped, /// will be called. /// - /// The type of to create and run. + /// /// Handler for any unhandled exceptions (resumes when returns true, rethrows when null). - /// + /// /// The driver name. If not specified the default driver for the platform will be used. Must be /// if has already been called. /// - /// The created object. The caller is responsible for disposing this object. + /// + /// The created object. The caller is responsible for calling + /// on this + /// object. + /// /// /// /// This method is used to start processing events for the main application, but it is also used to run other /// modal s such as boxes. /// /// - /// To make stop execution, call - /// or . - /// - /// - /// Calling is equivalent to calling - /// , followed by starting the main loop, and then calling - /// . - /// - /// - /// When using or , - /// will be called automatically. + /// To make stop execution, call + /// or . /// /// /// In RELEASE builds: When is any exceptions will be @@ -192,7 +252,8 @@ public interface IApplication /// returns the main loop will resume; otherwise this method will exit. /// /// - /// must be called when the application is closing (typically after Run has returned) to + /// must be called when the application is closing (typically after Run has + /// returned) to /// ensure resources are cleaned up and terminal settings restored. /// /// @@ -206,48 +267,10 @@ public interface IApplication /// [RequiresUnreferencedCode ("AOT")] [RequiresDynamicCode ("AOT")] - public TView Run (Func? errorHandler = null, string? driver = null) - where TView : Toplevel, new (); + public IApplication Run (Func? errorHandler = null, string? driverName = null) + where TRunnable : IRunnable, new (); - /// - /// Runs a new Session using the provided view and calling - /// . - /// When the session is stopped, will be called.. - /// - /// The to run as a modal. - /// Handler for any unhandled exceptions (resumes when returns true, rethrows when null). - /// - /// - /// This method is used to start processing events for the main application, but it is also used to run other - /// modal s such as boxes. - /// - /// - /// To make stop execution, call - /// or . - /// - /// - /// Calling is equivalent to calling - /// , followed by starting the main loop, and then calling - /// . - /// - /// - /// When using or , - /// will be called automatically. - /// - /// - /// must be called when the application is closing (typically after Run has returned) to - /// ensure resources are cleaned up and terminal settings restored. - /// - /// - /// In RELEASE builds: When is any exceptions will be - /// rethrown. Otherwise, will be called. If - /// returns the main loop will resume; otherwise this method will exit. - /// - /// - /// The caller is responsible for disposing the object returned by this method. - /// - /// - public void Run (Toplevel view, Func? errorHandler = null); + #region Iteration & Invoke /// /// Raises the event. @@ -262,9 +285,23 @@ public interface IApplication /// /// This event is raised before input processing, timeout callbacks, and rendering occur each iteration. /// - /// See also and . + /// The event args contain the current application instance. /// - public event EventHandler? Iteration; + /// + /// + /// . + public event EventHandler>? Iteration; + + /// Runs on the main UI loop thread. + /// The action to be invoked on the main processing thread. + /// + /// + /// If called from the main thread, the action is executed immediately. Otherwise, it is queued via + /// with and will be executed on the next main loop + /// iteration. + /// + /// + void Invoke (Action? action); /// Runs on the main UI loop thread. /// The action to be invoked on the main processing thread. @@ -277,106 +314,119 @@ public interface IApplication /// void Invoke (Action action); - /// - /// Building block API: Ends a Session and completes the execution of a that was started with - /// . Not usually called directly by applications. - /// - /// will automatically call this method when the session is stopped. - /// - /// The returned by the method. - /// - /// - /// This method removes the from the stack, raises the - /// event, and disposes the . - /// - /// - public void End (SessionToken sessionToken); - - /// Requests that the currently running Session stop. The Session will stop after the current iteration completes. - /// - /// This will cause to return. - /// - /// This is equivalent to calling with as the parameter. - /// - /// - void RequestStop (); - - /// Requests that the currently running Session stop. The Session will stop after the current iteration completes. - /// - /// The to stop. If , stops the currently running . - /// - /// - /// This will cause to return. - /// - /// Calling is equivalent to setting the - /// property on the specified to . - /// - /// - void RequestStop (Toplevel? top); + #endregion Iteration & Invoke /// /// Set to to cause the session to stop running after first iteration. /// /// /// - /// Used primarily for unit testing. When , will be called + /// Used primarily for unit testing. When , will be + /// called /// automatically after the first main loop iteration. /// /// bool StopAfterFirstIteration { get; set; } - /// - /// Raised when has been called and has created a new . - /// + /// Requests that the currently running Session stop. The Session will stop after the current iteration completes. /// - /// If is , callers to - /// must also subscribe to and manually dispose of the token - /// when the application is done. + /// This will cause to return. + /// + /// This is equivalent to calling with as the + /// parameter. + /// /// - public event EventHandler? SessionBegun; + void RequestStop (); + + /// + /// Requests that the specified runnable session stop. + /// + /// + /// The runnable to stop. If , stops the current + /// . + /// + /// + /// + /// This will cause to return. + /// + /// + /// Raises , , + /// and events. + /// + /// + void RequestStop (IRunnable? runnable); + + /// + /// Building block API: Ends the session associated with the token and completes the execution of an + /// . + /// Not usually called directly by applications. + /// will automatically call this method when the session is stopped. + /// + /// + /// The returned by the + /// method. + /// + /// + /// + /// This method removes the from the , + /// raises the lifecycle events, and disposes the . + /// + /// + /// Raises , , + /// and events. + /// + /// + void End (SessionToken sessionToken); /// /// Raised when was called and the session is stopping. The event args contain a - /// reference to the - /// that was active during the session. This can be used to ensure the Toplevel is disposed of properly. + /// reference to the + /// that was active during the session. This can be used to ensure the Runnable is disposed of properly. /// /// - /// If is , callers to + /// If is , callers to /// must also subscribe to and manually dispose of the token /// when the application is done. /// - public event EventHandler? SessionEnded; + public event EventHandler? SessionEnded; - #endregion Begin->Run->Iteration->Stop->End + #endregion Session Management - Begin->Run->Iteration->Stop->End - #region Toplevel Management - - /// Gets or sets the current Toplevel. - /// - /// - /// This is set by and cleared by . - /// - /// - Toplevel? Top { get; set; } - - /// Gets the stack of all Toplevels. - /// - /// - /// Toplevels are added to this stack by and removed by - /// . - /// - /// - ConcurrentStack TopLevels { get; } + #region Result Management /// - /// Caches the Toplevel associated with the current Session. + /// Gets the result from the last or + /// call. /// - /// - /// Used internally to optimize Toplevel state transitions. - /// - Toplevel? CachedSessionTokenToplevel { get; set; } + /// + /// The result from the last run session, or if no session has been run or the result was null. + /// + object? GetResult (); - #endregion Toplevel Management + /// + /// Gets the result from the last or + /// call, cast to type . + /// + /// The expected result type. + /// + /// The result cast to , or if the result is null or cannot be cast. + /// + /// + /// + /// using (var app = Application.Create().Init()) + /// { + /// app.Run<ColorPickerDialog>(); + /// var selectedColor = app.GetResult<Color>(); + /// if (selectedColor.HasValue) + /// { + /// // Use the color + /// } + /// } + /// + /// + T? GetResult () where T : class => GetResult () as T; + + #endregion Result Management #region Screen and Driver @@ -388,6 +438,17 @@ public interface IApplication /// IDriver? Driver { get; set; } + /// + /// Gets the clipboard for this application instance. + /// + /// + /// + /// Provides access to the OS clipboard through the driver. Returns if + /// is not initialized. + /// + /// + IClipboard? Clipboard { get; } + /// /// Gets or sets whether will be forced to output only the 16 colors defined in /// . The default is , meaning 24-bit (TrueColor) colors will be @@ -428,7 +489,7 @@ public interface IApplication /// /// /// This is typically set to when a View's changes and that view - /// has no SuperView (e.g. when is moved or resized). + /// has no SuperView (e.g. when is moved or resized). /// /// /// Automatically reset to after processes it. @@ -444,10 +505,38 @@ public interface IApplication #endregion Screen and Driver + #region Keyboard + + /// + /// Handles keyboard input and key bindings at the Application level. + /// + /// + /// + /// Provides access to keyboard state, key bindings, and keyboard event handling. Set during . + /// + /// + IKeyboard Keyboard { get; set; } + + #endregion Keyboard + + #region Mouse + + /// + /// Handles mouse event state and processing. + /// + /// + /// + /// Provides access to mouse state, mouse grabbing, and mouse event handling. Set during . + /// + /// + IMouse Mouse { get; set; } + + #endregion Mouse + #region Layout and Drawing /// - /// Causes any Toplevels that need layout to be laid out, then draws any Toplevels that need display. Only Views + /// Causes any Runnables that need layout to be laid out, then draws any Runnables that need display. Only Views /// that need to be laid out (see ) will be laid out. Only Views that need to be drawn /// (see ) will be drawn. /// @@ -482,14 +571,6 @@ public interface IApplication #region Navigation and Popover - /// Gets or sets the popover manager. - /// - /// - /// Manages application-level popover views. Initialized during . - /// - /// - ApplicationPopover? Popover { get; set; } - /// Gets or sets the navigation manager. /// /// @@ -498,6 +579,14 @@ public interface IApplication /// ApplicationNavigation? Navigation { get; set; } + /// Gets or sets the popover manager. + /// + /// + /// Manages application-level popover views. Initialized during . + /// + /// + ApplicationPopover? Popover { get; set; } + #endregion Navigation and Popover #region Timeouts @@ -509,14 +598,17 @@ public interface IApplication /// returns , the timeout will stop and be removed. /// /// - /// A token that can be used to stop the timeout by calling . + /// Call with the returned value to stop the timeout. /// /// /// /// When the time specified passes, the callback will be invoked on the main UI thread. /// + /// + /// calls StopAll on to remove all timeouts. + /// /// - object AddTimeout (TimeSpan time, Func callback); + object? AddTimeout (TimeSpan time, Func callback); /// Removes a previously scheduled timeout. /// The token returned by . @@ -539,4 +631,10 @@ public interface IApplication ITimedEvents? TimedEvents { get; } #endregion Timeouts + + /// + /// Gets a string representation of the Application as rendered by . + /// + /// A string representation of the Application + public string ToString (); } diff --git a/Terminal.Gui/App/IPopover.cs b/Terminal.Gui/App/IPopover.cs index 7e86ffe77..be577b871 100644 --- a/Terminal.Gui/App/IPopover.cs +++ b/Terminal.Gui/App/IPopover.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; @@ -51,12 +50,12 @@ namespace Terminal.Gui.App; public interface IPopover { /// - /// Gets or sets the that this Popover is associated with. If null, it is not associated with - /// any Toplevel and will receive all keyboard - /// events from the . If set, it will only receive keyboard events the Toplevel would normally + /// Gets or sets the that this Popover is associated with. If null, it is not associated with + /// any Runnable and will receive all keyboard + /// events from the . If set, it will only receive keyboard events the Runnable would normally /// receive. - /// When is called, the is set to the current - /// if not already set. + /// When is called, the is set to the current + /// if not already set. /// - Toplevel? Toplevel { get; set; } + IRunnable? Current { get; set; } } diff --git a/Terminal.Gui/App/IterationEventArgs.cs b/Terminal.Gui/App/IterationEventArgs.cs deleted file mode 100644 index e0c98d2ab..000000000 --- a/Terminal.Gui/App/IterationEventArgs.cs +++ /dev/null @@ -1,5 +0,0 @@ -namespace Terminal.Gui.App; - -/// Event arguments for the event. -public class IterationEventArgs : EventArgs -{ } diff --git a/Terminal.Gui/App/Keyboard/IKeyboard.cs b/Terminal.Gui/App/Keyboard/IKeyboard.cs index d0fbd023e..404217308 100644 --- a/Terminal.Gui/App/Keyboard/IKeyboard.cs +++ b/Terminal.Gui/App/Keyboard/IKeyboard.cs @@ -1,10 +1,9 @@ -#nullable enable namespace Terminal.Gui.App; /// /// Defines a contract for managing keyboard input and key bindings at the Application level. /// -/// This interface decouples keyboard handling state from the static class, +/// This interface decouples keyboard handling state from the static class, /// enabling parallelizable unit tests and better testability. /// /// @@ -14,7 +13,7 @@ public interface IKeyboard /// Sets the application instance that this keyboard handler is associated with. /// This provides access to application state without coupling to static Application class. /// - IApplication? Application { get; set; } + IApplication? App { get; set; } /// /// Called when the user presses a key (by the ). Raises the cancelable diff --git a/Terminal.Gui/App/Keyboard/KeyboardImpl.cs b/Terminal.Gui/App/Keyboard/KeyboardImpl.cs index 0741f4c53..dbdd2d67c 100644 --- a/Terminal.Gui/App/Keyboard/KeyboardImpl.cs +++ b/Terminal.Gui/App/Keyboard/KeyboardImpl.cs @@ -1,34 +1,76 @@ -#nullable enable -using System.Diagnostics; +using System.Collections.Concurrent; namespace Terminal.Gui.App; /// /// INTERNAL: Implements to manage keyboard input and key bindings at the Application level. +/// This implementation is thread-safe for all public operations. /// -/// This implementation decouples keyboard handling state from the static class, +/// This implementation decouples keyboard handling state from the static class, /// enabling parallelizable unit tests and better testability. /// /// /// See for usage details. /// /// -internal class KeyboardImpl : IKeyboard +internal class KeyboardImpl : IKeyboard, IDisposable { - private Key _quitKey = Key.Esc; // Resources/config.json overrides - private Key _arrangeKey = Key.F5.WithCtrl; // Resources/config.json overrides - private Key _nextTabGroupKey = Key.F6; // Resources/config.json overrides - private Key _nextTabKey = Key.Tab; // Resources/config.json overrides - private Key _prevTabGroupKey = Key.F6.WithShift; // Resources/config.json overrides - private Key _prevTabKey = Key.Tab.WithShift; // Resources/config.json overrides + /// + /// Initializes keyboard bindings and subscribes to Application configuration property events. + /// + public KeyboardImpl () + { + // DON'T access Application static properties here - they trigger ApplicationImpl.Instance + // which sets ModelUsage to LegacyStatic, breaking parallel tests. + // These will be initialized from Application static properties in Init() or when accessed. + + // Initialize to reasonable defaults that match Application defaults + // These will be updated by property change events if Application properties change + _quitKey = Key.Esc; + _arrangeKey = Key.F5.WithCtrl; + _nextTabGroupKey = Key.F6; + _nextTabKey = Key.Tab; + _prevTabGroupKey = Key.F6.WithShift; + _prevTabKey = Key.Tab.WithShift; + + // Subscribe to Application static property change events + // so we get updated if they change + Application.QuitKeyChanged += OnQuitKeyChanged; + Application.ArrangeKeyChanged += OnArrangeKeyChanged; + Application.NextTabGroupKeyChanged += OnNextTabGroupKeyChanged; + Application.NextTabKeyChanged += OnNextTabKeyChanged; + Application.PrevTabGroupKeyChanged += OnPrevTabGroupKeyChanged; + Application.PrevTabKeyChanged += OnPrevTabKeyChanged; + + AddKeyBindings (); + } /// - /// Commands for Application. + /// Commands for Application. Thread-safe for concurrent access. /// - private readonly Dictionary _commandImplementations = new (); + private readonly ConcurrentDictionary _commandImplementations = new (); + + private Key _quitKey; + private Key _arrangeKey; + private Key _nextTabGroupKey; + private Key _nextTabKey; + private Key _prevTabGroupKey; + private Key _prevTabKey; /// - public IApplication? Application { get; set; } + public void Dispose () + { + // Unsubscribe from Application static property change events + Application.QuitKeyChanged -= OnQuitKeyChanged; + Application.ArrangeKeyChanged -= OnArrangeKeyChanged; + Application.NextTabGroupKeyChanged -= OnNextTabGroupKeyChanged; + Application.NextTabKeyChanged -= OnNextTabKeyChanged; + Application.PrevTabGroupKeyChanged -= OnPrevTabGroupKeyChanged; + Application.PrevTabKeyChanged -= OnPrevTabKeyChanged; + } + + /// + public IApplication? App { get; set; } /// public KeyBindings KeyBindings { get; internal set; } = new (null); @@ -105,20 +147,9 @@ internal class KeyboardImpl : IKeyboard /// public event EventHandler? KeyUp; - /// - /// Initializes keyboard bindings. - /// - public KeyboardImpl () - { - AddKeyBindings (); - } - /// public bool RaiseKeyDownEvent (Key key) { - //ebug.Assert (App.Application.MainThreadId == Thread.CurrentThread.ManagedThreadId); - //Logging.Debug ($"{key}"); - // TODO: Add a way to ignore certain keys, esp for debugging. //#if DEBUG // if (key == Key.Empty.WithAlt || key == Key.Empty.WithCtrl) @@ -136,23 +167,23 @@ internal class KeyboardImpl : IKeyboard return true; } - if (Application?.Popover?.DispatchKeyDown (key) is true) + if (App?.Popover?.DispatchKeyDown (key) is true) { return true; } - if (Application?.Top is null) + if (App?.TopRunnableView is null) { - if (Application?.TopLevels is { }) + if (App?.SessionStack is { }) { - foreach (Toplevel topLevel in Application.TopLevels.ToList ()) + foreach (IRunnable? runnable in App.SessionStack.Select(r => r.Runnable)) { - if (topLevel.NewKeyDownEvent (key)) + if (runnable is View view && view.NewKeyDownEvent (key)) { return true; } - if (topLevel.Modal) + if (runnable!.IsModal) { break; } @@ -161,14 +192,15 @@ internal class KeyboardImpl : IKeyboard } else { - if (Application.Top.NewKeyDownEvent (key)) + if (App.TopRunnableView.NewKeyDownEvent (key)) { return true; } } bool? commandHandled = InvokeCommandsBoundToKey (key); - if(commandHandled is true) + + if (commandHandled is true) { return true; } @@ -179,7 +211,7 @@ internal class KeyboardImpl : IKeyboard /// public bool RaiseKeyUpEvent (Key key) { - if (Application?.Initialized != true) + if (App?.Initialized != true) { return true; } @@ -191,19 +223,18 @@ internal class KeyboardImpl : IKeyboard return true; } - // TODO: Add Popover support - if (Application?.TopLevels is { }) + if (App?.SessionStack is { }) { - foreach (Toplevel topLevel in Application.TopLevels.ToList ()) + foreach (IRunnable? runnable in App.SessionStack.Select (r => r.Runnable)) { - if (topLevel.NewKeyUpEvent (key)) + if (runnable is View view && view.NewKeyUpEvent (key)) { return true; } - if (topLevel.Modal) + if (runnable!.IsModal) { break; } @@ -217,6 +248,7 @@ internal class KeyboardImpl : IKeyboard public bool? InvokeCommandsBoundToKey (Key key) { bool? handled = null; + // Invoke any Application-scoped KeyBindings. // The first view that handles the key will stop the loop. // foreach (KeyValuePair binding in KeyBindings.GetBindings (key)) @@ -267,6 +299,107 @@ internal class KeyboardImpl : IKeyboard return null; } + internal void AddKeyBindings () + { + _commandImplementations.Clear (); + + // Things Application knows how to do + AddCommand ( + Command.Quit, + () => + { + App?.RequestStop (); + + return true; + } + ); + + AddCommand ( + Command.Suspend, + () => + { + App?.Driver?.Suspend (); + + return true; + } + ); + + AddCommand ( + Command.NextTabStop, + () => App?.Navigation?.AdvanceFocus (NavigationDirection.Forward, TabBehavior.TabStop)); + + AddCommand ( + Command.PreviousTabStop, + () => App?.Navigation?.AdvanceFocus (NavigationDirection.Backward, TabBehavior.TabStop)); + + AddCommand ( + Command.NextTabGroup, + () => App?.Navigation?.AdvanceFocus (NavigationDirection.Forward, TabBehavior.TabGroup)); + + AddCommand ( + Command.PreviousTabGroup, + () => App?.Navigation?.AdvanceFocus (NavigationDirection.Backward, TabBehavior.TabGroup)); + + AddCommand ( + Command.Refresh, + () => + { + App?.LayoutAndDraw (true); + + return true; + } + ); + + AddCommand ( + Command.Arrange, + () => + { + View? viewToArrange = App?.Navigation?.GetFocused (); + + // Go up the superview hierarchy and find the first that is not ViewArrangement.Fixed + while (viewToArrange is { SuperView: { }, Arrangement: ViewArrangement.Fixed }) + { + viewToArrange = viewToArrange.SuperView; + } + + if (viewToArrange is { }) + { + return viewToArrange.Border?.EnterArrangeMode (ViewArrangement.Fixed); + } + + return false; + }); + + // Need to clear after setting the above to ensure actually clear + // because set_QuitKey etc. may call Add + //KeyBindings.Clear (); + + // Use ReplaceCommands instead of Add, because it's possible that + // during construction the Application static properties changed, and + // we added those keys already. + KeyBindings.ReplaceCommands (QuitKey, Command.Quit); + KeyBindings.ReplaceCommands (NextTabKey, Command.NextTabStop); + KeyBindings.ReplaceCommands (PrevTabKey, Command.PreviousTabStop); + KeyBindings.ReplaceCommands (NextTabGroupKey, Command.NextTabGroup); + KeyBindings.ReplaceCommands (PrevTabGroupKey, Command.PreviousTabGroup); + KeyBindings.ReplaceCommands (ArrangeKey, Command.Arrange); + + // TODO: Should these be configurable? + KeyBindings.ReplaceCommands (Key.CursorRight, Command.NextTabStop); + KeyBindings.ReplaceCommands (Key.CursorDown, Command.NextTabStop); + KeyBindings.ReplaceCommands (Key.CursorLeft, Command.PreviousTabStop); + KeyBindings.ReplaceCommands (Key.CursorUp, Command.PreviousTabStop); + + // TODO: Refresh Key should be configurable + KeyBindings.ReplaceCommands (Key.F5, Command.Refresh); + + // TODO: Suspend Key should be configurable + if (Environment.OSVersion.Platform == PlatformID.Unix) + { + KeyBindings.ReplaceCommands (Key.Z.WithCtrl, Command.Suspend); + } + } + /// /// /// Sets the function that will be invoked for a . @@ -285,100 +418,16 @@ internal class KeyboardImpl : IKeyboard /// The function. private void AddCommand (Command command, Func f) { _commandImplementations [command] = ctx => f (); } - internal void AddKeyBindings () - { - _commandImplementations.Clear (); + private void OnArrangeKeyChanged (object? sender, ValueChangedEventArgs e) { ArrangeKey = e.NewValue; } - // Things Application knows how to do - AddCommand ( - Command.Quit, - () => - { - Application?.RequestStop (); + private void OnNextTabGroupKeyChanged (object? sender, ValueChangedEventArgs e) { NextTabGroupKey = e.NewValue; } - return true; - } - ); - AddCommand ( - Command.Suspend, - () => - { - Application?.Driver?.Suspend (); + private void OnNextTabKeyChanged (object? sender, ValueChangedEventArgs e) { NextTabKey = e.NewValue; } - return true; - } - ); - AddCommand ( - Command.NextTabStop, - () => Application?.Navigation?.AdvanceFocus (NavigationDirection.Forward, TabBehavior.TabStop)); + private void OnPrevTabGroupKeyChanged (object? sender, ValueChangedEventArgs e) { PrevTabGroupKey = e.NewValue; } - AddCommand ( - Command.PreviousTabStop, - () => Application?.Navigation?.AdvanceFocus (NavigationDirection.Backward, TabBehavior.TabStop)); + private void OnPrevTabKeyChanged (object? sender, ValueChangedEventArgs e) { PrevTabKey = e.NewValue; } - AddCommand ( - Command.NextTabGroup, - () => Application?.Navigation?.AdvanceFocus (NavigationDirection.Forward, TabBehavior.TabGroup)); - - AddCommand ( - Command.PreviousTabGroup, - () => Application?.Navigation?.AdvanceFocus (NavigationDirection.Backward, TabBehavior.TabGroup)); - - AddCommand ( - Command.Refresh, - () => - { - Application?.LayoutAndDraw (true); - - return true; - } - ); - - AddCommand ( - Command.Arrange, - () => - { - View? viewToArrange = Application?.Navigation?.GetFocused (); - - // Go up the superview hierarchy and find the first that is not ViewArrangement.Fixed - while (viewToArrange is { SuperView: { }, Arrangement: ViewArrangement.Fixed }) - { - viewToArrange = viewToArrange.SuperView; - } - - if (viewToArrange is { }) - { - return viewToArrange.Border?.EnterArrangeMode (ViewArrangement.Fixed); - } - - return false; - }); - - //SetKeysToHardCodedDefaults (); - - // Need to clear after setting the above to ensure actually clear - // because set_QuitKey etc.. may call Add - KeyBindings.Clear (); - - KeyBindings.Add (QuitKey, Command.Quit); - KeyBindings.Add (NextTabKey, Command.NextTabStop); - KeyBindings.Add (PrevTabKey, Command.PreviousTabStop); - KeyBindings.Add (NextTabGroupKey, Command.NextTabGroup); - KeyBindings.Add (PrevTabGroupKey, Command.PreviousTabGroup); - KeyBindings.Add (ArrangeKey, Command.Arrange); - - KeyBindings.Add (Key.CursorRight, Command.NextTabStop); - KeyBindings.Add (Key.CursorDown, Command.NextTabStop); - KeyBindings.Add (Key.CursorLeft, Command.PreviousTabStop); - KeyBindings.Add (Key.CursorUp, Command.PreviousTabStop); - - // TODO: Refresh Key should be configurable - KeyBindings.Add (Key.F5, Command.Refresh); - - // TODO: Suspend Key should be configurable - if (Environment.OSVersion.Platform == PlatformID.Unix) - { - KeyBindings.Add (Key.Z.WithCtrl, Command.Suspend); - } - } + // Event handlers for Application static property changes + private void OnQuitKeyChanged (object? sender, ValueChangedEventArgs e) { QuitKey = e.NewValue; } } diff --git a/Terminal.Gui/App/MainLoop/ApplicationMainLoop.cs b/Terminal.Gui/App/MainLoop/ApplicationMainLoop.cs index 69a16bd49..a1a064103 100644 --- a/Terminal.Gui/App/MainLoop/ApplicationMainLoop.cs +++ b/Terminal.Gui/App/MainLoop/ApplicationMainLoop.cs @@ -1,8 +1,5 @@ -#nullable enable -using System; using System.Collections.Concurrent; using System.Diagnostics; -using Terminal.Gui.Drivers; namespace Terminal.Gui.App; @@ -30,6 +27,9 @@ public class ApplicationMainLoop : IApplicationMainLoop + public IApplication? App { get; private set; } + /// public ITimedEvents TimedEvents { @@ -81,11 +81,6 @@ public class ApplicationMainLoop : IApplicationMainLoop _sizeMonitor = value; } - /// - /// Handles raising events and setting required draw status etc when changes - /// - public IToplevelTransitionManager ToplevelTransitionManager = new ToplevelTransitionManager (); - /// /// Initializes the class with the provided subcomponents /// @@ -94,14 +89,17 @@ public class ApplicationMainLoop : IApplicationMainLoop /// /// + /// public void Initialize ( ITimedEvents timedEvents, ConcurrentQueue inputBuffer, IInputProcessor inputProcessor, IOutput consoleOutput, - IComponentFactory componentFactory + IComponentFactory componentFactory, + IApplication? app ) { + App = app; InputQueue = inputBuffer; Output = consoleOutput; InputProcessor = inputProcessor; @@ -116,10 +114,10 @@ public class ApplicationMainLoop : IApplicationMainLoop public void Iteration () { - Application.RaiseIteration (); + App?.RaiseIteration (); DateTime dt = DateTime.Now; - int timeAllowed = 1000 / Math.Max(1,(int)Application.MaximumIterationsPerSecond); + int timeAllowed = 1000 / Math.Max (1, (int)Application.MaximumIterationsPerSecond); IterationImpl (); @@ -139,14 +137,11 @@ public class ApplicationMainLoop : IApplicationMainLoop : IApplicationMainLoop : IApplicationMainLoop : IApplicationMainLoopType of raw input events processed by the loop, e.g. for cross-platform .NET driver public interface IApplicationMainLoop : IDisposable where TInputRecord : struct { + /// + /// The Application this loop is associated with. + /// + public IApplication? App { get; } + /// /// Gets the implementation that manages user-defined timeouts and periodic events. /// @@ -73,6 +77,7 @@ public interface IApplicationMainLoop : IDisposable where TInputRe /// The factory for creating driver-specific components. Used here to create the /// that tracks terminal size changes. /// + /// /// /// /// This method is called by during application startup @@ -98,7 +103,8 @@ public interface IApplicationMainLoop : IDisposable where TInputRe ConcurrentQueue inputQueue, IInputProcessor inputProcessor, IOutput output, - IComponentFactory componentFactory + IComponentFactory componentFactory, + IApplication? app ); /// diff --git a/Terminal.Gui/App/MainLoop/IMainLoopCoordinator.cs b/Terminal.Gui/App/MainLoop/IMainLoopCoordinator.cs index e08b2a742..c5321a2ea 100644 --- a/Terminal.Gui/App/MainLoop/IMainLoopCoordinator.cs +++ b/Terminal.Gui/App/MainLoop/IMainLoopCoordinator.cs @@ -16,6 +16,7 @@ public interface IMainLoopCoordinator /// /// Initializes all required subcomponents and starts the input thread. /// + /// /// /// This method: /// @@ -25,7 +26,7 @@ public interface IMainLoopCoordinator /// /// /// A task that completes when initialization is done - public Task StartInputTaskAsync (); + public Task StartInputTaskAsync (IApplication? app); /// /// Stops the input thread and performs cleanup. diff --git a/Terminal.Gui/App/MainLoop/MainLoopCoordinator.cs b/Terminal.Gui/App/MainLoop/MainLoopCoordinator.cs index 45fd2a7d3..58b54c94e 100644 --- a/Terminal.Gui/App/MainLoop/MainLoopCoordinator.cs +++ b/Terminal.Gui/App/MainLoop/MainLoopCoordinator.cs @@ -46,24 +46,25 @@ internal class MainLoopCoordinator : IMainLoopCoordinator where TI private readonly ITimedEvents _timedEvents; private readonly SemaphoreSlim _startupSemaphore = new (0, 1); - private IInput _input; - private Task _inputTask; - private IOutput _output; - private DriverImpl _driver; + private IInput? _input; + private Task? _inputTask; + private IOutput? _output; + private DriverImpl? _driver; private bool _stopCalled; /// /// Starts the input loop thread in separate task (returning immediately). /// - public async Task StartInputTaskAsync () + /// The instance that is running the input loop. + public async Task StartInputTaskAsync (IApplication? app) { Logging.Trace ("Booting... ()"); - _inputTask = Task.Run (RunInput); + _inputTask = Task.Run (() => RunInput (app)); // Main loop is now booted on same thread as rest of users application - BootMainLoop (); + BootMainLoop (app); // Wait asynchronously for the semaphore or task failure. Task waitForSemaphore = _startupSemaphore.WaitAsync (); @@ -107,13 +108,13 @@ internal class MainLoopCoordinator : IMainLoopCoordinator where TI _stopCalled = true; _runCancellationTokenSource.Cancel (); - _output.Dispose (); + _output?.Dispose (); // Wait for input infinite loop to exit - _inputTask.Wait (); + _inputTask?.Wait (); } - private void BootMainLoop () + private void BootMainLoop (IApplication? app) { //Logging.Trace ($"_inputProcessor: {_inputProcessor}, _output: {_output}, _componentFactory: {_componentFactory}"); @@ -121,13 +122,13 @@ internal class MainLoopCoordinator : IMainLoopCoordinator where TI { // Instance must be constructed on the thread in which it is used. _output = _componentFactory.CreateOutput (); - _loop.Initialize (_timedEvents, _inputQueue, _inputProcessor, _output, _componentFactory); + _loop.Initialize (_timedEvents, _inputQueue, _inputProcessor, _output, _componentFactory, app); - BuildDriverIfPossible (); + BuildDriverIfPossible (app); } } - private void BuildDriverIfPossible () + private void BuildDriverIfPossible (IApplication? app) { if (_input != null && _output != null) @@ -139,7 +140,7 @@ internal class MainLoopCoordinator : IMainLoopCoordinator where TI _loop.AnsiRequestScheduler, _loop.SizeMonitor); - Application.Driver = _driver; + app!.Driver = _driver; _startupSemaphore.Release (); Logging.Trace ($"Driver: _input: {_input}, _output: {_output}"); @@ -149,7 +150,8 @@ internal class MainLoopCoordinator : IMainLoopCoordinator where TI /// /// INTERNAL: Runs the IInput read loop on a new thread called the "Input Thread". /// - private void RunInput () + /// + private void RunInput (IApplication? app) { try { @@ -165,7 +167,7 @@ internal class MainLoopCoordinator : IMainLoopCoordinator where TI impl.InputImpl = _input; } - BuildDriverIfPossible (); + BuildDriverIfPossible (app); } try diff --git a/Terminal.Gui/App/MainLoop/MainLoopSyncContext.cs b/Terminal.Gui/App/MainLoop/MainLoopSyncContext.cs index f67f5ec81..b9375ccca 100644 --- a/Terminal.Gui/App/MainLoop/MainLoopSyncContext.cs +++ b/Terminal.Gui/App/MainLoop/MainLoopSyncContext.cs @@ -1,42 +1,43 @@ +#nullable disable namespace Terminal.Gui.App; -/// -/// provides the sync context set while executing code in Terminal.Gui, to let -/// users use async/await on their code -/// -internal sealed class MainLoopSyncContext : SynchronizationContext -{ - public override SynchronizationContext CreateCopy () { return new MainLoopSyncContext (); } +///// +///// provides the sync context set while executing code in Terminal.Gui, to let +///// users use async/await on their code +///// +//internal sealed class MainLoopSyncContext : SynchronizationContext +//{ +// public override SynchronizationContext CreateCopy () { return new MainLoopSyncContext (); } - public override void Post (SendOrPostCallback d, object state) - { - // Queue the task using the modern architecture - ApplicationImpl.Instance.Invoke (() => { d (state); }); - } +// public override void Post (SendOrPostCallback d, object state) +// { +// // Queue the task using the modern architecture +// ApplicationImpl.Instance.Invoke (() => { d (state); }); +// } - //_mainLoop.Driver.Wakeup (); - public override void Send (SendOrPostCallback d, object state) - { - if (Thread.CurrentThread.ManagedThreadId == Application.MainThreadId) - { - d (state); - } - else - { - var wasExecuted = false; +// //_mainLoop.Driver.Wakeup (); +// public override void Send (SendOrPostCallback d, object state) +// { +// if (Thread.CurrentThread.ManagedThreadId == Application.MainThreadId) +// { +// d (state); +// } +// else +// { +// var wasExecuted = false; - Application.Invoke ( - () => - { - d (state); - wasExecuted = true; - } - ); +// ApplicationImpl.Instance.Invoke ( +// () => +// { +// d (state); +// wasExecuted = true; +// } +// ); - while (!wasExecuted) - { - Thread.Sleep (15); - } - } - } -} +// while (!wasExecuted) +// { +// Thread.Sleep (15); +// } +// } +// } +//} diff --git a/Terminal.Gui/App/Mouse/IMouse.cs b/Terminal.Gui/App/Mouse/IMouse.cs index a4bc2c2e8..ed01dbf1b 100644 --- a/Terminal.Gui/App/Mouse/IMouse.cs +++ b/Terminal.Gui/App/Mouse/IMouse.cs @@ -1,4 +1,3 @@ -#nullable enable using System.ComponentModel; namespace Terminal.Gui.App; @@ -6,7 +5,7 @@ namespace Terminal.Gui.App; /// /// Defines a contract for mouse event handling and state management in a Terminal.Gui application. /// -/// This interface allows for decoupling of mouse-related functionality from the static class, +/// This interface allows for decoupling of mouse-related functionality from the static class, /// enabling better testability and parallel test execution. /// /// @@ -16,18 +15,13 @@ public interface IMouse : IMouseGrabHandler /// Sets the application instance that this mouse handler is associated with. /// This provides access to application state without coupling to static Application class. /// - IApplication? Application { get; set; } + IApplication? App { get; set; } /// /// Gets or sets the last known position of the mouse. /// Point? LastMousePosition { get; set; } - /// - /// Gets the most recent position of the mouse. - /// - Point? GetLastMousePosition (); - /// /// Gets or sets whether the mouse is disabled. The mouse is enabled by default. /// diff --git a/Terminal.Gui/App/Mouse/IMouseGrabHandler.cs b/Terminal.Gui/App/Mouse/IMouseGrabHandler.cs index 06fd0e626..31bdebeaf 100644 --- a/Terminal.Gui/App/Mouse/IMouseGrabHandler.cs +++ b/Terminal.Gui/App/Mouse/IMouseGrabHandler.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; /// diff --git a/Terminal.Gui/App/Mouse/MouseGrabHandler.cs b/Terminal.Gui/App/Mouse/MouseGrabHandler.cs index 3fe7ab689..175d371ed 100644 --- a/Terminal.Gui/App/Mouse/MouseGrabHandler.cs +++ b/Terminal.Gui/App/Mouse/MouseGrabHandler.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; /// diff --git a/Terminal.Gui/App/Mouse/MouseImpl.cs b/Terminal.Gui/App/Mouse/MouseImpl.cs index 78d662dde..7840df3fc 100644 --- a/Terminal.Gui/App/Mouse/MouseImpl.cs +++ b/Terminal.Gui/App/Mouse/MouseImpl.cs @@ -1,32 +1,37 @@ -#nullable enable using System.ComponentModel; -using System.Diagnostics; namespace Terminal.Gui.App; /// /// INTERNAL: Implements to manage mouse event handling and state. /// -/// This class holds all mouse-related state that was previously in the static class, +/// This class holds all mouse-related state that was previously in the static class, /// enabling better testability and parallel test execution. /// /// -internal class MouseImpl : IMouse +internal class MouseImpl : IMouse, IDisposable { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class and subscribes to Application configuration property events. /// - public MouseImpl () { } + public MouseImpl () + { + // Subscribe to Application static property change events + Application.IsMouseDisabledChanged += OnIsMouseDisabledChanged; + } + + private IApplication? _app; /// - public IApplication? Application { get; set; } + public IApplication? App + { + get => _app; + set => _app = value; + } /// public Point? LastMousePosition { get; set; } - /// - public Point? GetLastMousePosition () { return LastMousePosition; } - /// public bool IsMouseDisabled { get; set; } @@ -57,7 +62,7 @@ internal class MouseImpl : IMouse public void RaiseMouseEvent (MouseEventArgs mouseEvent) { //Debug.Assert (App.Application.MainThreadId == Thread.CurrentThread.ManagedThreadId); - if (Application?.Initialized is true) + if (App?.Initialized is true) { // LastMousePosition is only set if the application is initialized. LastMousePosition = mouseEvent.ScreenPosition; @@ -72,9 +77,9 @@ internal class MouseImpl : IMouse //Debug.Assert (mouseEvent.Position == mouseEvent.ScreenPosition); mouseEvent.Position = mouseEvent.ScreenPosition; - List currentViewsUnderMouse = View.GetViewsUnderLocation (mouseEvent.ScreenPosition, ViewportSettingsFlags.TransparentMouse); + List? currentViewsUnderMouse = App?.TopRunnableView?.GetViewsUnderLocation (mouseEvent.ScreenPosition, ViewportSettingsFlags.TransparentMouse); - View? deepestViewUnderMouse = currentViewsUnderMouse.LastOrDefault (); + View? deepestViewUnderMouse = currentViewsUnderMouse?.LastOrDefault (); if (deepestViewUnderMouse is { }) { @@ -96,7 +101,7 @@ internal class MouseImpl : IMouse // Dismiss the Popover if the user presses mouse outside of it if (mouseEvent.IsPressed - && Application?.Popover?.GetActivePopover () as View is { Visible: true } visiblePopover + && App?.Popover?.GetActivePopover () as View is { Visible: true } visiblePopover && View.IsInHierarchy (visiblePopover, deepestViewUnderMouse, includeAdornments: true) is false) { ApplicationPopover.HideWithQuitCommand (visiblePopover); @@ -119,9 +124,9 @@ internal class MouseImpl : IMouse return; } - // if the mouse is outside the Application.Top or Application.Popover hierarchy, we don't want to + // if the mouse is outside the Application.TopRunnable or Popover hierarchy, we don't want to // send the mouse event to the deepest view under the mouse. - if (!View.IsInHierarchy (Application?.Top, deepestViewUnderMouse, true) && !View.IsInHierarchy (Application?.Popover?.GetActivePopover () as View, deepestViewUnderMouse, true)) + if (!View.IsInHierarchy (App?.TopRunnableView, deepestViewUnderMouse, true) && !View.IsInHierarchy (App?.Popover?.GetActivePopover () as View, deepestViewUnderMouse, true)) { return; } @@ -161,7 +166,10 @@ internal class MouseImpl : IMouse return; } - RaiseMouseEnterLeaveEvents (viewMouseEvent.ScreenPosition, currentViewsUnderMouse); + if (currentViewsUnderMouse is { }) + { + RaiseMouseEnterLeaveEvents (viewMouseEvent.ScreenPosition, currentViewsUnderMouse); + } while (deepestViewUnderMouse.NewMouseEvent (viewMouseEvent) is not true && MouseGrabView is not { }) { @@ -256,6 +264,7 @@ internal class MouseImpl : IMouse // Do not clear LastMousePosition; Popover's require it to stay set with last mouse pos. CachedViewsUnderMouse.Clear (); MouseEvent = null; + MouseGrabView = null; } // Mouse grab functionality merged from MouseGrabHandler @@ -392,4 +401,17 @@ internal class MouseImpl : IMouse return false; } + + // Event handler for Application static property changes + private void OnIsMouseDisabledChanged (object? sender, ValueChangedEventArgs e) + { + IsMouseDisabled = e.NewValue; + } + + /// + public void Dispose () + { + // Unsubscribe from Application static property change events + Application.IsMouseDisabledChanged -= OnIsMouseDisabledChanged; + } } diff --git a/Terminal.Gui/App/PopoverBaseImpl.cs b/Terminal.Gui/App/PopoverBaseImpl.cs index 1e9aacb71..ff118df35 100644 --- a/Terminal.Gui/App/PopoverBaseImpl.cs +++ b/Terminal.Gui/App/PopoverBaseImpl.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; @@ -74,8 +73,18 @@ public abstract class PopoverBaseImpl : View, IPopover } } + private IRunnable? _current; + /// - public Toplevel? Toplevel { get; set; } + public IRunnable? Current + { + get => _current; + set + { + _current = value; + App ??= (_current as View)?.App; + } + } /// /// Called when the property is changing. @@ -100,14 +109,17 @@ public abstract class PopoverBaseImpl : View, IPopover { // Whenever visible is changing to true, we need to resize; // it's our only chance because we don't get laid out until we're visible - Layout (Application.Screen.Size); + if (App is { }) + { + Layout (App.Screen.Size); + } } else { // Whenever visible is changing to false, we need to reset the focus - if (ApplicationNavigation.IsInHierarchy (this, Application.Navigation?.GetFocused ())) + if (ApplicationNavigation.IsInHierarchy (this, App?.Navigation?.GetFocused ())) { - Application.Navigation?.SetFocused (Application.Top?.MostFocused); + App?.Navigation?.SetFocused (App?.TopRunnableView?.MostFocused); } } diff --git a/Terminal.Gui/App/Runnable/IRunnable.cs b/Terminal.Gui/App/Runnable/IRunnable.cs new file mode 100644 index 000000000..6b55454f4 --- /dev/null +++ b/Terminal.Gui/App/Runnable/IRunnable.cs @@ -0,0 +1,266 @@ +namespace Terminal.Gui.App; + +/// +/// Non-generic base interface for runnable views. Provides common members without type parameter. +/// +/// +/// +/// This interface enables storing heterogeneous runnables in collections (e.g., +/// ) +/// while preserving type safety at usage sites via . +/// +/// +/// Most code should use directly. This base interface is primarily +/// for framework infrastructure (session management, stacking, etc.). +/// +/// +/// A runnable view executes as a self-contained blocking session with its own lifecycle, +/// event loop iteration, and focus management./> +/// blocks until +/// is called. +/// +/// +/// This interface follows the Terminal.Gui Cancellable Work Pattern (CWP) for all lifecycle events. +/// +/// +/// +/// +public interface IRunnable +{ + #region Result + + /// + /// Gets or sets the result data extracted when the session was accepted, or if not accepted. + /// + /// + /// + /// This is the non-generic version of the result property. For type-safe access, cast to + /// or access the derived interface's Result property directly. + /// + /// + /// Implementations should set this in the method + /// (when stopping, i.e., newIsRunning == false) by extracting data from + /// views before they are disposed. + /// + /// + /// indicates the session was stopped without accepting (ESC key, close without action). + /// Non- contains the result data. + /// + /// + object? Result { get; set; } + + #endregion Result + + #region Running or not (added to/removed from RunnableSessionStack) + + /// + /// Sets the application context for this runnable. Called from . + /// + /// + void SetApp (IApplication app); + + /// + /// Gets whether this runnable session is currently running (i.e., on the + /// ). + /// + /// + /// + /// This property returns a cached value that is updated atomically when the runnable is added to or + /// removed from the session stack. The cached state ensures thread-safe access without race conditions. + /// + /// + /// Returns if this runnable is currently on the , + /// otherwise. + /// + /// + /// Runnables are added to the stack during and removed in + /// . + /// + /// + bool IsRunning { get; } + + /// + /// Sets the cached IsRunning state. Called by ApplicationImpl within the session stack lock. + /// This method is internal to the framework and should not be called by application code. + /// + /// The new IsRunning value. + void SetIsRunning (bool value); + + /// + /// Requests that this runnable session stop. + /// + public void RequestStop (); + + /// + /// Called by the framework to raise the event. + /// + /// The current value of . + /// The new value of (true = starting, false = stopping). + /// if the change was canceled; otherwise . + /// + /// + /// This method implements the Cancellable Work Pattern. It calls the protected virtual method first, + /// then raises the event if not canceled. + /// + /// + /// When is (stopping), this is the ideal place + /// for implementations to extract Result from views before the runnable is removed from the stack. + /// + /// + bool RaiseIsRunningChanging (bool oldIsRunning, bool newIsRunning); + + /// + /// Raised when is changing (e.g., when or + /// is called). + /// Can be canceled by setting `args.Cancel` to . + /// + /// + /// + /// Subscribe to this event to participate in the runnable lifecycle before state changes occur. + /// When is (stopping), + /// this is the ideal place to extract Result before views are disposed and to optionally + /// cancel the stop operation (e.g., prompt to save changes). + /// + /// + /// This event follows the Terminal.Gui Cancellable Work Pattern (CWP). + /// + /// + event EventHandler>? IsRunningChanging; + + /// + /// Called by the framework to raise the event. + /// + /// The new value of (true = started, false = stopped). + /// + /// This method is called after the state change has occurred and cannot be canceled. + /// + void RaiseIsRunningChangedEvent (bool newIsRunning); + + /// + /// Raised after has changed (after the runnable has been added to or removed from the + /// ). + /// + /// + /// + /// Subscribe to this event to perform post-state-change logic. When is + /// , + /// the runnable has started and is on the stack. When , the runnable has stopped and been + /// removed from the stack. + /// + /// + /// This event follows the Terminal.Gui Cancellable Work Pattern (CWP). + /// + /// + event EventHandler>? IsRunningChanged; + + #endregion Running or not (added to/removed from RunnableSessionStack) + + #region Modal or not (top of RunnableSessionStack or not) + + /// + /// Gets whether this runnable session is at the top of the and thus + /// exclusively receiving mouse and keyboard input. + /// + /// + /// + /// This property returns a cached value that is updated atomically when the runnable's modal state changes. + /// The cached state ensures thread-safe access without race conditions. + /// + /// + /// Returns if this runnable is at the top of the stack (i.e., this == app.TopRunnable), + /// otherwise. + /// + /// + /// The runnable at the top of the stack gets all mouse/keyboard input and thus is running "modally". + /// + /// + bool IsModal { get; } + + /// + /// Sets the cached IsModal state. Called by ApplicationImpl within the session stack lock. + /// This method is internal to the framework and should not be called by application code. + /// + /// The new IsModal value. + void SetIsModal (bool value); + + /// + /// Gets or sets whether a stop has been requested for this runnable session. + /// + bool StopRequested { get; set; } + + /// + /// Called by the framework to raise the event. + /// + /// The new value of (true = became modal/top, false = no longer modal). + /// + /// This method is called after the modal state change has occurred and cannot be canceled. + /// + void RaiseIsModalChangedEvent (bool newIsModal); + + /// + /// Raised after this runnable has become modal (top of stack) or ceased being modal. + /// + /// + /// + /// Subscribe to this event to perform post-activation logic (e.g., setting focus, updating UI state). + /// When is , the runnable became modal (top of + /// stack). + /// When , the runnable is no longer modal (another runnable is on top). + /// + /// + /// This event follows the Terminal.Gui Cancellable Work Pattern (CWP). + /// + /// + event EventHandler>? IsModalChanged; + + #endregion Modal or not (top of RunnableSessionStack or not) +} + +/// +/// Defines a view that can be run as an independent blocking session with , +/// returning a typed result. +/// +/// +/// The type of result data returned when the session completes. +/// Common types: for button indices, for file paths, +/// custom types for complex form data. +/// +/// +/// +/// A runnable view executes as a self-contained blocking session with its own lifecycle, +/// event loop iteration, and focus management. blocks until +/// is called. +/// +/// +/// When is , the session was stopped without being accepted +/// (e.g., ESC key pressed, window closed). When non-, it contains the result data +/// extracted in (when stopping) before views are disposed. +/// +/// +/// Implementing does not require deriving from any specific +/// base class or using . These are orthogonal concerns. +/// +/// +/// This interface follows the Terminal.Gui Cancellable Work Pattern (CWP) for all lifecycle events. +/// +/// +/// +/// +public interface IRunnable : IRunnable +{ + /// + /// Gets or sets the result data extracted when the session was accepted, or if not accepted. + /// + /// + /// + /// Implementations should set this in the method + /// (when stopping, i.e., newIsRunning == false) by extracting data from + /// views before they are disposed. + /// + /// + /// indicates the session was stopped without accepting (ESC key, close without action). + /// Non- contains the type-safe result data. + /// + /// + new TResult? Result { get; set; } +} diff --git a/Terminal.Gui/App/Runnable/SessionToken.cs b/Terminal.Gui/App/Runnable/SessionToken.cs new file mode 100644 index 000000000..38410facd --- /dev/null +++ b/Terminal.Gui/App/Runnable/SessionToken.cs @@ -0,0 +1,23 @@ +using System.Collections.Concurrent; + +namespace Terminal.Gui.App; + +/// +/// Represents a running session created by . +/// Wraps an instance and is stored in . +/// +public class SessionToken +{ + internal SessionToken (IRunnable runnable) { Runnable = runnable; } + + /// + /// Gets or sets the runnable associated with this session. + /// Set to by when the session completes. + /// + public IRunnable? Runnable { get; internal set; } + + /// + /// The result of the session. Typically set by the runnable in + /// + public object? Result { get; set; } +} diff --git a/Terminal.Gui/App/SessionTokenEventArgs.cs b/Terminal.Gui/App/Runnable/SessionTokenEventArgs.cs similarity index 100% rename from Terminal.Gui/App/SessionTokenEventArgs.cs rename to Terminal.Gui/App/Runnable/SessionTokenEventArgs.cs diff --git a/Terminal.Gui/App/SessionToken.cs b/Terminal.Gui/App/SessionToken.cs deleted file mode 100644 index d6466ed3f..000000000 --- a/Terminal.Gui/App/SessionToken.cs +++ /dev/null @@ -1,77 +0,0 @@ -using System.Collections.Concurrent; - -namespace Terminal.Gui.App; - -/// Defines a session token for a running . -public class SessionToken : IDisposable -{ - /// Initializes a new class. - /// - public SessionToken (Toplevel view) { Toplevel = view; } - - /// The belonging to this . - public Toplevel Toplevel { get; internal set; } - - /// Releases all resource used by the object. - /// Call when you are finished using the . - /// - /// method leaves the in an unusable state. After calling - /// , you must release all references to the so the garbage collector can - /// reclaim the memory that the was occupying. - /// - public void Dispose () - { - Dispose (true); - GC.SuppressFinalize (this); -#if DEBUG_IDISPOSABLE - WasDisposed = true; -#endif - } - - /// Releases all resource used by the object. - /// If set to we are disposing and should dispose held objects. - protected virtual void Dispose (bool disposing) - { - if (Toplevel is { } && disposing) - { - // Previously we were requiring Toplevel be disposed here. - // But that is not correct becaue `Begin` didn't create the TopLevel, `Init` did; thus - // disposing should be done by `Shutdown`, not `End`. - throw new InvalidOperationException ( - "Toplevel must be null before calling Application.SessionToken.Dispose" - ); - } - } - -#if DEBUG_IDISPOSABLE -#pragma warning disable CS0419 // Ambiguous reference in cref attribute - /// - /// Gets whether was called on this SessionToken or not. - /// For debug purposes to verify objects are being disposed properly. - /// Only valid when DEBUG_IDISPOSABLE is defined. - /// - public bool WasDisposed { get; private set; } - - /// - /// Gets the number of times was called on this object. - /// For debug purposes to verify objects are being disposed properly. - /// Only valid when DEBUG_IDISPOSABLE is defined. - /// - public int DisposedCount { get; private set; } = 0; - - /// - /// Gets the list of SessionToken objects that have been created and not yet disposed. - /// Note, this is a static property and will affect all SessionToken objects. - /// For debug purposes to verify objects are being disposed properly. - /// Only valid when DEBUG_IDISPOSABLE is defined. - /// - public static ConcurrentBag Instances { get; private set; } = []; - - /// Creates a new SessionToken object. - public SessionToken () - { - Instances.Add (this); - } -#pragma warning restore CS0419 // Ambiguous reference in cref attribute -#endif -} diff --git a/Terminal.Gui/App/Timeout/ITimedEvents.cs b/Terminal.Gui/App/Timeout/ITimedEvents.cs index aa9499520..376f71f51 100644 --- a/Terminal.Gui/App/Timeout/ITimedEvents.cs +++ b/Terminal.Gui/App/Timeout/ITimedEvents.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.App; /// @@ -49,4 +48,14 @@ public interface ITimedEvents /// for each timeout that is not actively executing. /// SortedList Timeouts { get; } + + /// + /// Gets the timeout for the specified event. + /// + /// The token of the event. + /// The for the event, or if the event is not found. + TimeSpan? GetTimeout (object token); + + /// Stops and removes all timed events. + void StopAll (); } diff --git a/Terminal.Gui/App/Timeout/LogarithmicTimeout.cs b/Terminal.Gui/App/Timeout/LogarithmicTimeout.cs index eacf09607..25690eb24 100644 --- a/Terminal.Gui/App/Timeout/LogarithmicTimeout.cs +++ b/Terminal.Gui/App/Timeout/LogarithmicTimeout.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.App; /// Implements a logarithmic increasing timeout. diff --git a/Terminal.Gui/App/Timeout/SmoothAcceleratingTimeout.cs b/Terminal.Gui/App/Timeout/SmoothAcceleratingTimeout.cs index 962ce4b19..7a11dcddc 100644 --- a/Terminal.Gui/App/Timeout/SmoothAcceleratingTimeout.cs +++ b/Terminal.Gui/App/Timeout/SmoothAcceleratingTimeout.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.App; /// diff --git a/Terminal.Gui/App/Timeout/TimedEvents.cs b/Terminal.Gui/App/Timeout/TimedEvents.cs index da1dcc5c0..09e008b51 100644 --- a/Terminal.Gui/App/Timeout/TimedEvents.cs +++ b/Terminal.Gui/App/Timeout/TimedEvents.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; namespace Terminal.Gui.App; @@ -145,6 +144,22 @@ public class TimedEvents : ITimedEvents return false; } + /// + public TimeSpan? GetTimeout (object token) + { + lock (_timeoutsLockToken) + { + int idx = _timeouts.IndexOfValue ((token as Timeout)!); + + if (idx == -1) + { + return null; + } + + return _timeouts.Values [idx].Span; + } + } + private void AddTimeout (TimeSpan time, Timeout timeout) { lock (_timeoutsLockToken) @@ -202,7 +217,7 @@ public class TimedEvents : ITimedEvents { if (k < now) { - if (timeout.Callback ()) + if (timeout.Callback! ()) { AddTimeout (timeout.Span, timeout); } @@ -216,4 +231,13 @@ public class TimedEvents : ITimedEvents } } } + + /// + public void StopAll () + { + lock (_timeoutsLockToken) + { + _timeouts.Clear (); + } + } } diff --git a/Terminal.Gui/App/Timeout/Timeout.cs b/Terminal.Gui/App/Timeout/Timeout.cs index c3054869f..226dc9e2f 100644 --- a/Terminal.Gui/App/Timeout/Timeout.cs +++ b/Terminal.Gui/App/Timeout/Timeout.cs @@ -20,7 +20,7 @@ public class Timeout /// rescheduled and invoked again after the same interval. /// If the callback returns , the timeout will be removed and not invoked again. /// - public Func Callback { get; set; } + public Func? Callback { get; set; } /// /// Gets or sets the time interval to wait before invoking the . diff --git a/Terminal.Gui/App/Toplevel/IToplevelTransitionManager.cs b/Terminal.Gui/App/Toplevel/IToplevelTransitionManager.cs deleted file mode 100644 index 7b69f8c9b..000000000 --- a/Terminal.Gui/App/Toplevel/IToplevelTransitionManager.cs +++ /dev/null @@ -1,20 +0,0 @@ -namespace Terminal.Gui.App; - -/// -/// Interface for class that handles bespoke behaviours that occur when application -/// top level changes. -/// -public interface IToplevelTransitionManager -{ - /// - /// Raises the event on the current top level - /// if it has not been raised before now. - /// - void RaiseReadyEventIfNeeded (); - - /// - /// Handles any state change needed when the application top changes e.g. - /// setting redraw flags - /// - void HandleTopMaybeChanging (); -} diff --git a/Terminal.Gui/App/Toplevel/ToplevelTransitionManager.cs b/Terminal.Gui/App/Toplevel/ToplevelTransitionManager.cs deleted file mode 100644 index 282dde040..000000000 --- a/Terminal.Gui/App/Toplevel/ToplevelTransitionManager.cs +++ /dev/null @@ -1,42 +0,0 @@ -#nullable enable -using Terminal.Gui.Drivers; - -namespace Terminal.Gui.App; - -/// -/// Handles bespoke behaviours that occur when application top level changes. -/// -public class ToplevelTransitionManager : IToplevelTransitionManager -{ - private readonly HashSet _readiedTopLevels = new (); - - private View? _lastTop; - - /// - public void RaiseReadyEventIfNeeded () - { - Toplevel? top = Application.Top; - - if (top != null && !_readiedTopLevels.Contains (top)) - { - top.OnReady (); - _readiedTopLevels.Add (top); - - // Views can be closed and opened and run again multiple times, see End_Does_Not_Dispose - top.Closed += (s, e) => _readiedTopLevels.Remove (top); - } - } - - /// - public void HandleTopMaybeChanging () - { - Toplevel? newTop = Application.Top; - - if (_lastTop != null && _lastTop != newTop && newTop != null) - { - newTop.SetNeedsDraw (); - } - - _lastTop = Application.Top; - } -} diff --git a/Terminal.Gui/Configuration/AppSettingsScope.cs b/Terminal.Gui/Configuration/AppSettingsScope.cs index 35594cacb..66c6af7f0 100644 --- a/Terminal.Gui/Configuration/AppSettingsScope.cs +++ b/Terminal.Gui/Configuration/AppSettingsScope.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Text.Json.Serialization; +using System.Text.Json.Serialization; namespace Terminal.Gui.Configuration; diff --git a/Terminal.Gui/Configuration/AttributeJsonConverter.cs b/Terminal.Gui/Configuration/AttributeJsonConverter.cs index 34ee281c5..2a00b556f 100644 --- a/Terminal.Gui/Configuration/AttributeJsonConverter.cs +++ b/Terminal.Gui/Configuration/AttributeJsonConverter.cs @@ -9,7 +9,7 @@ namespace Terminal.Gui.Configuration; internal class AttributeJsonConverter : JsonConverter { - private static AttributeJsonConverter _instance; + private static AttributeJsonConverter? _instance; /// public static AttributeJsonConverter Instance @@ -63,7 +63,7 @@ internal class AttributeJsonConverter : JsonConverter throw new JsonException ($"{propertyName}: Unexpected token when parsing Attribute: {reader.TokenType}."); } - propertyName = reader.GetString (); + propertyName = reader.GetString ()!; reader.Read (); var property = $"\"{reader.GetString ()}\""; diff --git a/Terminal.Gui/Configuration/ColorJsonConverter.cs b/Terminal.Gui/Configuration/ColorJsonConverter.cs index 70d6ca7e7..8959a9a10 100644 --- a/Terminal.Gui/Configuration/ColorJsonConverter.cs +++ b/Terminal.Gui/Configuration/ColorJsonConverter.cs @@ -15,7 +15,7 @@ namespace Terminal.Gui.Configuration; /// internal class ColorJsonConverter : JsonConverter { - private static ColorJsonConverter _instance; + private static ColorJsonConverter? _instance; /// Singleton public static ColorJsonConverter Instance diff --git a/Terminal.Gui/Configuration/ConcurrentDictionaryJsonConverter.cs b/Terminal.Gui/Configuration/ConcurrentDictionaryJsonConverter.cs index a33f9181a..a5d186184 100644 --- a/Terminal.Gui/Configuration/ConcurrentDictionaryJsonConverter.cs +++ b/Terminal.Gui/Configuration/ConcurrentDictionaryJsonConverter.cs @@ -1,3 +1,4 @@ +#nullable disable using System.Collections.Concurrent; using System.Diagnostics.CodeAnalysis; using System.Text.Json; diff --git a/Terminal.Gui/Configuration/ConfigLocations.cs b/Terminal.Gui/Configuration/ConfigLocations.cs index 8f348fa8c..c41aacde9 100644 --- a/Terminal.Gui/Configuration/ConfigLocations.cs +++ b/Terminal.Gui/Configuration/ConfigLocations.cs @@ -1,5 +1,4 @@ -#nullable enable -namespace Terminal.Gui.Configuration; +namespace Terminal.Gui.Configuration; /// /// Describes the location of the configuration settings. The constants can be combined (bitwise) to specify multiple diff --git a/Terminal.Gui/Configuration/ConfigProperty.cs b/Terminal.Gui/Configuration/ConfigProperty.cs index 0442a3b6f..0a5d7dc8f 100644 --- a/Terminal.Gui/Configuration/ConfigProperty.cs +++ b/Terminal.Gui/Configuration/ConfigProperty.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Collections.Concurrent; +using System.Collections.Concurrent; using System.Collections.Immutable; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; diff --git a/Terminal.Gui/Configuration/ConfigurationManager.cs b/Terminal.Gui/Configuration/ConfigurationManager.cs index 6f0364ad5..aa79c26e9 100644 --- a/Terminal.Gui/Configuration/ConfigurationManager.cs +++ b/Terminal.Gui/Configuration/ConfigurationManager.cs @@ -1,6 +1,4 @@ -#nullable enable - -using System.Collections.Frozen; +using System.Collections.Frozen; using System.Collections.Immutable; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; @@ -597,15 +595,53 @@ public static class ConfigurationManager TypeInfoResolver = SourceGenerationContext.Default }); + private static SourcesManager? _sourcesManager = new (); + private static readonly object _sourcesManagerLock = new (); + /// /// Gets the Sources Manager - manages the loading of configuration sources from files and resources. /// - public static SourcesManager? SourcesManager { get; internal set; } = new (); + public static SourcesManager? SourcesManager + { + get + { + lock (_sourcesManagerLock) + { + return _sourcesManager; + } + } + internal set + { + lock (_sourcesManagerLock) + { + _sourcesManager = value; + } + } + } + + private static string? _runtimeConfig = """{ }"""; + private static readonly object _runtimeConfigLock = new (); /// /// Gets or sets the in-memory config.json. See . /// - public static string? RuntimeConfig { get; set; } = """{ }"""; + public static string? RuntimeConfig + { + get + { + lock (_runtimeConfigLock) + { + return _runtimeConfig; + } + } + set + { + lock (_runtimeConfigLock) + { + _runtimeConfig = value; + } + } + } [SuppressMessage ("Style", "IDE1006:Naming Styles", Justification = "")] private static readonly string _configFilename = "config.json"; @@ -680,13 +716,32 @@ public static class ConfigurationManager [SuppressMessage ("Style", "IDE1006:Naming Styles", Justification = "")] internal static StringBuilder _jsonErrors = new (); + private static bool? _throwOnJsonErrors = false; + private static readonly object _throwOnJsonErrorsLock = new (); + /// /// Gets or sets whether the should throw an exception if it encounters an /// error on deserialization. If (the default), the error is logged and printed to the console /// when is called. /// [ConfigurationProperty (Scope = typeof (SettingsScope))] - public static bool? ThrowOnJsonErrors { get; set; } = false; + public static bool? ThrowOnJsonErrors + { + get + { + lock (_throwOnJsonErrorsLock) + { + return _throwOnJsonErrors; + } + } + set + { + lock (_throwOnJsonErrorsLock) + { + _throwOnJsonErrors = value; + } + } + } #pragma warning disable IDE1006 // Naming Styles private static readonly object _jsonErrorsLock = new (); @@ -760,8 +815,27 @@ public static class ConfigurationManager return JsonSerializer.Serialize (emptyScope, typeof (SettingsScope), SerializerContext!); } + private static string _appName = Assembly.GetEntryAssembly ()?.FullName?.Split (',') [0]?.Trim ()!; + private static readonly object _appNameLock = new (); + /// Name of the running application. By default, this property is set to the application's assembly name. - public static string AppName { get; set; } = Assembly.GetEntryAssembly ()?.FullName?.Split (',') [0]?.Trim ()!; + public static string AppName + { + get + { + lock (_appNameLock) + { + return _appName; + } + } + set + { + lock (_appNameLock) + { + _appName = value; + } + } + } /// /// INTERNAL: Retrieves all uninitialized configuration properties that belong to a specific scope from the cache. diff --git a/Terminal.Gui/Configuration/ConfigurationManagerEventArgs.cs b/Terminal.Gui/Configuration/ConfigurationManagerEventArgs.cs index 24a325ab7..ea03daff1 100644 --- a/Terminal.Gui/Configuration/ConfigurationManagerEventArgs.cs +++ b/Terminal.Gui/Configuration/ConfigurationManagerEventArgs.cs @@ -1,6 +1,4 @@ -#nullable enable - -namespace Terminal.Gui.Configuration; +namespace Terminal.Gui.Configuration; /// Event arguments for the events. public class ConfigurationManagerEventArgs : EventArgs diff --git a/Terminal.Gui/Configuration/ConfigurationManagerNotEnabledException.cs b/Terminal.Gui/Configuration/ConfigurationManagerNotEnabledException.cs index 45206c876..f9fc6b62e 100644 --- a/Terminal.Gui/Configuration/ConfigurationManagerNotEnabledException.cs +++ b/Terminal.Gui/Configuration/ConfigurationManagerNotEnabledException.cs @@ -1,5 +1,4 @@ -#nullable enable -namespace Terminal.Gui.Configuration; +namespace Terminal.Gui.Configuration; /// /// The exception that is thrown when a API is called but the configuration manager is not enabled. diff --git a/Terminal.Gui/Configuration/ConfigurationPropertyAttribute.cs b/Terminal.Gui/Configuration/ConfigurationPropertyAttribute.cs index 2f1218aa9..3911e9f88 100644 --- a/Terminal.Gui/Configuration/ConfigurationPropertyAttribute.cs +++ b/Terminal.Gui/Configuration/ConfigurationPropertyAttribute.cs @@ -1,6 +1,4 @@ -#nullable enable - -namespace Terminal.Gui.Configuration; +namespace Terminal.Gui.Configuration; /// An attribute indicating a property is managed by . /// diff --git a/Terminal.Gui/Configuration/DeepCloner.cs b/Terminal.Gui/Configuration/DeepCloner.cs index 0d918625c..3a6caec52 100644 --- a/Terminal.Gui/Configuration/DeepCloner.cs +++ b/Terminal.Gui/Configuration/DeepCloner.cs @@ -1,4 +1,4 @@ -#nullable enable + using System.Collections; using System.Collections.Concurrent; diff --git a/Terminal.Gui/Configuration/DictionaryJsonConverter.cs b/Terminal.Gui/Configuration/DictionaryJsonConverter.cs index bfd940d33..2cdbbfd48 100644 --- a/Terminal.Gui/Configuration/DictionaryJsonConverter.cs +++ b/Terminal.Gui/Configuration/DictionaryJsonConverter.cs @@ -1,4 +1,5 @@ -using System.Diagnostics.CodeAnalysis; +#nullable disable +using System.Diagnostics.CodeAnalysis; using System.Text.Json; using System.Text.Json.Serialization; diff --git a/Terminal.Gui/Configuration/KeyCodeJsonConverter.cs b/Terminal.Gui/Configuration/KeyCodeJsonConverter.cs index 04d8d9765..d69ea9479 100644 --- a/Terminal.Gui/Configuration/KeyCodeJsonConverter.cs +++ b/Terminal.Gui/Configuration/KeyCodeJsonConverter.cs @@ -1,4 +1,5 @@ -using System.Text.Json; +#nullable disable +using System.Text.Json; using System.Text.Json.Serialization; namespace Terminal.Gui.Configuration; diff --git a/Terminal.Gui/Configuration/KeyJsonConverter.cs b/Terminal.Gui/Configuration/KeyJsonConverter.cs index 01413c432..1e723c8b7 100644 --- a/Terminal.Gui/Configuration/KeyJsonConverter.cs +++ b/Terminal.Gui/Configuration/KeyJsonConverter.cs @@ -9,7 +9,7 @@ public class KeyJsonConverter : JsonConverter /// public override Key Read (ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { - return Key.TryParse (reader.GetString (), out Key key) ? key : Key.Empty; + return Key.TryParse (reader.GetString ()!, out Key key) ? key : Key.Empty; } /// diff --git a/Terminal.Gui/Configuration/RuneJsonConverter.cs b/Terminal.Gui/Configuration/RuneJsonConverter.cs index 8fc7f9f7b..48ec57518 100644 --- a/Terminal.Gui/Configuration/RuneJsonConverter.cs +++ b/Terminal.Gui/Configuration/RuneJsonConverter.cs @@ -26,7 +26,7 @@ internal class RuneJsonConverter : JsonConverter { case JsonTokenType.String: { - string value = reader.GetString (); + string? value = reader.GetString (); int first = RuneExtensions.MaxUnicodeCodePoint + 1; int second = RuneExtensions.MaxUnicodeCodePoint + 1; diff --git a/Terminal.Gui/Configuration/SchemeJsonConverter.cs b/Terminal.Gui/Configuration/SchemeJsonConverter.cs index cabeefacf..fe363dc54 100644 --- a/Terminal.Gui/Configuration/SchemeJsonConverter.cs +++ b/Terminal.Gui/Configuration/SchemeJsonConverter.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Diagnostics.CodeAnalysis; +using System.Diagnostics.CodeAnalysis; using System.Text.Json; using System.Text.Json.Serialization; diff --git a/Terminal.Gui/Configuration/SchemeManager.cs b/Terminal.Gui/Configuration/SchemeManager.cs index 4fa1fd809..0023a0824 100644 --- a/Terminal.Gui/Configuration/SchemeManager.cs +++ b/Terminal.Gui/Configuration/SchemeManager.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Collections.Immutable; +using System.Collections.Immutable; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Text.Json.Serialization; diff --git a/Terminal.Gui/Configuration/Scope.cs b/Terminal.Gui/Configuration/Scope.cs index 88d637264..a3fe4f069 100644 --- a/Terminal.Gui/Configuration/Scope.cs +++ b/Terminal.Gui/Configuration/Scope.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Collections.Concurrent; +using System.Collections.Concurrent; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; diff --git a/Terminal.Gui/Configuration/ScopeJsonConverter.cs b/Terminal.Gui/Configuration/ScopeJsonConverter.cs index 034e904ae..94ed04e8f 100644 --- a/Terminal.Gui/Configuration/ScopeJsonConverter.cs +++ b/Terminal.Gui/Configuration/ScopeJsonConverter.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Diagnostics.CodeAnalysis; +using System.Diagnostics.CodeAnalysis; using System.Reflection; using System.Text.Json; using System.Text.Json.Serialization; diff --git a/Terminal.Gui/Configuration/SettingsScope.cs b/Terminal.Gui/Configuration/SettingsScope.cs index 5feeb1131..de9dbdeb8 100644 --- a/Terminal.Gui/Configuration/SettingsScope.cs +++ b/Terminal.Gui/Configuration/SettingsScope.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Text.Json.Serialization; +using System.Text.Json.Serialization; namespace Terminal.Gui.Configuration; diff --git a/Terminal.Gui/Configuration/SourcesManager.cs b/Terminal.Gui/Configuration/SourcesManager.cs index 729086541..71c32ed36 100644 --- a/Terminal.Gui/Configuration/SourcesManager.cs +++ b/Terminal.Gui/Configuration/SourcesManager.cs @@ -1,4 +1,4 @@ -#nullable enable +using System.Collections.Concurrent; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Reflection; @@ -14,7 +14,7 @@ public class SourcesManager /// /// Provides a map from each of the to file system and resource paths that have been loaded by . /// - public Dictionary Sources { get; } = new (); + public ConcurrentDictionary Sources { get; } = new (); /// INTERNAL: Loads into the specified . /// The Settings Scope object that will be loaded into. @@ -63,11 +63,8 @@ public class SourcesManager internal void AddSource (ConfigLocations location, string source) { - if (!Sources.TryAdd (location, source)) - { - //Logging.Warning ($"{location} has already been added to Sources."); - Sources [location] = source; - } + // ConcurrentDictionary's AddOrUpdate is thread-safe + Sources.AddOrUpdate (location, source, (key, oldValue) => source); } diff --git a/Terminal.Gui/Configuration/ThemeManager.cs b/Terminal.Gui/Configuration/ThemeManager.cs index b184ba9ba..a234ac869 100644 --- a/Terminal.Gui/Configuration/ThemeManager.cs +++ b/Terminal.Gui/Configuration/ThemeManager.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Collections.Concurrent; +using System.Collections.Concurrent; using System.Collections.Immutable; using System.Diagnostics.CodeAnalysis; using System.Text.Json.Serialization; diff --git a/Terminal.Gui/Configuration/ThemeScope.cs b/Terminal.Gui/Configuration/ThemeScope.cs index 541cb80f6..753502bb4 100644 --- a/Terminal.Gui/Configuration/ThemeScope.cs +++ b/Terminal.Gui/Configuration/ThemeScope.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Text.Json.Serialization; +using System.Text.Json.Serialization; namespace Terminal.Gui.Configuration; @@ -16,7 +15,7 @@ namespace Terminal.Gui.Configuration; /// "Default": { /// "Schemes": [ /// { -/// "TopLevel": { +/// "Runnable": { /// "Normal": { /// "Foreground": "BrightGreen", /// "Background": "Black" diff --git a/Terminal.Gui/Drawing/Attribute.cs b/Terminal.Gui/Drawing/Attribute.cs index bc7005c41..0b794f20c 100644 --- a/Terminal.Gui/Drawing/Attribute.cs +++ b/Terminal.Gui/Drawing/Attribute.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Numerics; +using System.Numerics; using System.Text.Json.Serialization; namespace Terminal.Gui.Drawing; diff --git a/Terminal.Gui/Drawing/Cell.cs b/Terminal.Gui/Drawing/Cell.cs index e72a7837e..f7da577ad 100644 --- a/Terminal.Gui/Drawing/Cell.cs +++ b/Terminal.Gui/Drawing/Cell.cs @@ -1,81 +1,108 @@ -#nullable enable - - + namespace Terminal.Gui.Drawing; /// /// Represents a single row/column in a Terminal.Gui rendering surface (e.g. and /// ). /// -public record struct Cell (Attribute? Attribute = null, bool IsDirty = false, Rune Rune = default) +public record struct Cell (Attribute? Attribute = null, bool IsDirty = false, string Grapheme = "") { /// The attributes to use when drawing the Glyph. public Attribute? Attribute { get; set; } = Attribute; /// - /// Gets or sets a value indicating whether this has been modified since the + /// Gets or sets a value indicating whether this has been modified since the /// last time it was drawn. /// public bool IsDirty { get; set; } = IsDirty; - private Rune _rune = Rune; + private string _grapheme = Grapheme; - /// The character to display. If is , then is ignored. - public Rune Rune + /// + /// The single grapheme cluster to display from this cell. If is or + /// , then is ignored. + /// + public string Grapheme { - get => _rune; + readonly get => _grapheme; set { - _combiningMarks?.Clear (); - _rune = value; + if (GraphemeHelper.GetGraphemes(value).ToArray().Length > 1) + { + throw new InvalidOperationException ($"Only a single {nameof (Grapheme)} cluster is allowed per Cell."); + } + + if (!string.IsNullOrEmpty (value) && value.Length == 1 && char.IsSurrogate (value [0])) + { + throw new ArgumentException ($"Only valid Unicode scalar values are allowed in a single {nameof (Grapheme)} cluster."); + } + + try + { + _grapheme = !string.IsNullOrEmpty (value) && !value.IsNormalized (NormalizationForm.FormC) + ? value.Normalize (NormalizationForm.FormC) + : value; + } + catch (ArgumentException) + { + // leave text unnormalized + _grapheme = value; + } } } - private List? _combiningMarks; - /// - /// The combining marks for that when combined makes this Cell a combining sequence. If - /// empty, then is ignored. + /// The rune for or runes for that when combined makes this Cell a combining sequence. /// /// - /// Only valid in the rare case where is a combining sequence that could not be normalized to a - /// single Rune. + /// In the case where has more than one rune it is a combining sequence that is normalized to a + /// single Text which may occupies 1 or 2 columns. /// - internal IReadOnlyList CombiningMarks - { - // PERFORMANCE: Downside of the interface return type is that List struct enumerator cannot be utilized, i.e. enumerator is allocated. - // If enumeration is used heavily in the future then might be better to expose the List Enumerator directly via separate mechanism. - get - { - // Avoid unnecessary list allocation. - if (_combiningMarks == null) - { - return Array.Empty (); - } - return _combiningMarks; - } - } - - /// - /// Adds combining mark to the cell. - /// - /// The combining mark to add to the cell. - internal void AddCombiningMark (Rune combiningMark) - { - _combiningMarks ??= []; - _combiningMarks.Add (combiningMark); - } - - /// - /// Clears combining marks of the cell. - /// - internal void ClearCombiningMarks () - { - _combiningMarks?.Clear (); - } + public IReadOnlyList Runes => string.IsNullOrEmpty (Grapheme) ? [] : Grapheme.EnumerateRunes ().ToList (); /// - public override string ToString () { return $"['{Rune}':{Attribute}]"; } + public override string ToString () + { + string visibleText = EscapeControlAndInvisible (Grapheme); + + return $"[\"{visibleText}\":{Attribute}]"; + } + + private static string EscapeControlAndInvisible (string text) + { + if (string.IsNullOrEmpty (text)) + { + return ""; + } + + var sb = new StringBuilder (); + + foreach (var rune in text.EnumerateRunes ()) + { + switch (rune.Value) + { + case '\0': sb.Append ("␀"); break; + case '\t': sb.Append ("\\t"); break; + case '\r': sb.Append ("\\r"); break; + case '\n': sb.Append ("\\n"); break; + case '\f': sb.Append ("\\f"); break; + case '\v': sb.Append ("\\v"); break; + default: + if (char.IsControl ((char)rune.Value)) + { + // show as \uXXXX + sb.Append ($"\\u{rune.Value:X4}"); + } + else + { + sb.Append (rune); + } + break; + } + } + + return sb.ToString (); + } /// Converts the string into a . /// The string to convert. @@ -83,12 +110,8 @@ public record struct Cell (Attribute? Attribute = null, bool IsDirty = false, Ru /// public static List ToCellList (string str, Attribute? attribute = null) { - List cells = new (); - - foreach (Rune rune in str.EnumerateRunes ()) - { - cells.Add (new () { Rune = rune, Attribute = attribute }); - } + List cells = []; + cells.AddRange (GraphemeHelper.GetGraphemes (str).Select (grapheme => new Cell { Grapheme = grapheme, Attribute = attribute })); return cells; } @@ -101,9 +124,7 @@ public record struct Cell (Attribute? Attribute = null, bool IsDirty = false, Ru /// A for each line. public static List> StringToLinesOfCells (string content, Attribute? attribute = null) { - List cells = content.EnumerateRunes () - .Select (x => new Cell { Rune = x, Attribute = attribute }) - .ToList (); + List cells = ToCellList (content, attribute); return SplitNewLines (cells); } @@ -113,14 +134,14 @@ public record struct Cell (Attribute? Attribute = null, bool IsDirty = false, Ru /// public static string ToString (IEnumerable cells) { - var str = string.Empty; + StringBuilder sb = new (); foreach (Cell cell in cells) { - str += cell.Rune.ToString (); + sb.Append (cell.Grapheme); } - return str; + return sb.ToString (); } /// Converts a generic collection into a string. @@ -148,26 +169,19 @@ public record struct Cell (Attribute? Attribute = null, bool IsDirty = false, Ru internal static List StringToCells (string str, Attribute? attribute = null) { - List cells = []; - - foreach (Rune rune in str.ToRunes ()) - { - cells.Add (new () { Rune = rune, Attribute = attribute }); - } - - return cells; + return ToCellList (str, attribute); } - internal static List ToCells (IEnumerable runes, Attribute? attribute = null) + internal static List ToCells (IEnumerable strings, Attribute? attribute = null) { - List cells = new (); + StringBuilder sb = new (); - foreach (Rune rune in runes) + foreach (string str in strings) { - cells.Add (new () { Rune = rune, Attribute = attribute }); + sb.Append (str); } - return cells; + return ToCellList (sb.ToString (), attribute); } private static List> SplitNewLines (List cells) @@ -180,14 +194,15 @@ public record struct Cell (Attribute? Attribute = null, bool IsDirty = false, Ru // ASCII code 10 = Line Feed. for (; i < cells.Count; i++) { - if (cells [i].Rune.Value == 13) + if (cells [i].Grapheme.Length == 1 && cells [i].Grapheme [0] == 13) { hasCR = true; continue; } - if (cells [i].Rune.Value == 10) + if ((cells [i].Grapheme.Length == 1 && cells [i].Grapheme [0] == 10) + || cells [i].Grapheme == "\r\n") { if (i - start > 0) { diff --git a/Terminal.Gui/Drawing/Color/AnsiColorCode.cs b/Terminal.Gui/Drawing/Color/AnsiColorCode.cs index 56bc857a8..28d1fafb7 100644 --- a/Terminal.Gui/Drawing/Color/AnsiColorCode.cs +++ b/Terminal.Gui/Drawing/Color/AnsiColorCode.cs @@ -1,3 +1,4 @@ +// ReSharper disable InconsistentNaming namespace Terminal.Gui.Drawing; /// diff --git a/Terminal.Gui/Drawing/Color/AnsiColorNameResolver.cs b/Terminal.Gui/Drawing/Color/AnsiColorNameResolver.cs index aae4a6da5..5a0ebc827 100644 --- a/Terminal.Gui/Drawing/Color/AnsiColorNameResolver.cs +++ b/Terminal.Gui/Drawing/Color/AnsiColorNameResolver.cs @@ -1,5 +1,3 @@ -#nullable enable - using System.Collections.Immutable; using System.Diagnostics.CodeAnalysis; diff --git a/Terminal.Gui/Drawing/Color/Color.ColorExtensions.cs b/Terminal.Gui/Drawing/Color/Color.ColorExtensions.cs index 84e5f089a..a0b23b545 100644 --- a/Terminal.Gui/Drawing/Color/Color.ColorExtensions.cs +++ b/Terminal.Gui/Drawing/Color/Color.ColorExtensions.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Frozen; using ColorHelper; diff --git a/Terminal.Gui/Drawing/Color/Color.ColorParseException.cs b/Terminal.Gui/Drawing/Color/Color.ColorParseException.cs index 97595db04..ac1da5d5f 100644 --- a/Terminal.Gui/Drawing/Color/Color.ColorParseException.cs +++ b/Terminal.Gui/Drawing/Color/Color.ColorParseException.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics.CodeAnalysis; namespace Terminal.Gui.Drawing; diff --git a/Terminal.Gui/Drawing/Color/Color.Formatting.cs b/Terminal.Gui/Drawing/Color/Color.Formatting.cs index 15e0dccb9..89082867b 100644 --- a/Terminal.Gui/Drawing/Color/Color.Formatting.cs +++ b/Terminal.Gui/Drawing/Color/Color.Formatting.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics.CodeAnalysis; using System.Globalization; using System.Runtime.CompilerServices; diff --git a/Terminal.Gui/Drawing/Color/Color.Operators.cs b/Terminal.Gui/Drawing/Color/Color.Operators.cs index 831f32bab..b8d33bd4a 100644 --- a/Terminal.Gui/Drawing/Color/Color.Operators.cs +++ b/Terminal.Gui/Drawing/Color/Color.Operators.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics.Contracts; using System.Numerics; diff --git a/Terminal.Gui/Drawing/Color/Color.cs b/Terminal.Gui/Drawing/Color/Color.cs index 995249c13..e83a05a73 100644 --- a/Terminal.Gui/Drawing/Color/Color.cs +++ b/Terminal.Gui/Drawing/Color/Color.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Frozen; using System.Globalization; using System.Numerics; diff --git a/Terminal.Gui/Drawing/Color/ColorModel.cs b/Terminal.Gui/Drawing/Color/ColorModel.cs index 6af865a9c..158c03236 100644 --- a/Terminal.Gui/Drawing/Color/ColorModel.cs +++ b/Terminal.Gui/Drawing/Color/ColorModel.cs @@ -1,5 +1,3 @@ -#nullable enable - namespace Terminal.Gui.Drawing; /// diff --git a/Terminal.Gui/Drawing/Color/ColorStrings.cs b/Terminal.Gui/Drawing/Color/ColorStrings.cs index 705ea13e4..8f70c6a9e 100644 --- a/Terminal.Gui/Drawing/Color/ColorStrings.cs +++ b/Terminal.Gui/Drawing/Color/ColorStrings.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Globalization; namespace Terminal.Gui.Drawing; diff --git a/Terminal.Gui/Drawing/Color/IColorNameResolver.cs b/Terminal.Gui/Drawing/Color/IColorNameResolver.cs index 36881adb3..14e44718f 100644 --- a/Terminal.Gui/Drawing/Color/IColorNameResolver.cs +++ b/Terminal.Gui/Drawing/Color/IColorNameResolver.cs @@ -1,5 +1,3 @@ -#nullable enable - using System.Diagnostics.CodeAnalysis; namespace Terminal.Gui.Drawing; diff --git a/Terminal.Gui/Drawing/Color/ICustomColorFormatter.cs b/Terminal.Gui/Drawing/Color/ICustomColorFormatter.cs index 425a02441..3bcd14919 100644 --- a/Terminal.Gui/Drawing/Color/ICustomColorFormatter.cs +++ b/Terminal.Gui/Drawing/Color/ICustomColorFormatter.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drawing; /// An interface to support custom formatting and parsing of values. diff --git a/Terminal.Gui/Drawing/Color/MultiStandardColorNameResolver.cs b/Terminal.Gui/Drawing/Color/MultiStandardColorNameResolver.cs index d409950eb..36ed50910 100644 --- a/Terminal.Gui/Drawing/Color/MultiStandardColorNameResolver.cs +++ b/Terminal.Gui/Drawing/Color/MultiStandardColorNameResolver.cs @@ -1,5 +1,3 @@ -#nullable enable - using System.Collections.Frozen; using System.Collections.Immutable; using System.Diagnostics.CodeAnalysis; diff --git a/Terminal.Gui/Drawing/Color/StandardColors.cs b/Terminal.Gui/Drawing/Color/StandardColors.cs index 05adfdb30..9f17ac1ac 100644 --- a/Terminal.Gui/Drawing/Color/StandardColors.cs +++ b/Terminal.Gui/Drawing/Color/StandardColors.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Frozen; using System.Collections.Immutable; using System.Diagnostics.CodeAnalysis; @@ -6,75 +5,90 @@ using System.Diagnostics.CodeAnalysis; namespace Terminal.Gui.Drawing; /// -/// Helper class for transforming to and from enum. +/// Helper class for transforming to and from enum. /// internal static class StandardColors { - private static readonly ImmutableArray _names; - private static readonly FrozenDictionary _argbNameMap; + // Lazy initialization to avoid static constructor convoy effect in parallel scenarios + private static readonly Lazy> _names = new ( + NamesValueFactory, + LazyThreadSafetyMode.PublicationOnly); - static StandardColors () + private static ImmutableArray NamesValueFactory () { - // Populate based on names because enums with same numerical value - // are not otherwise distinguishable from each other. string [] standardNames = Enum.GetNames ().Order ().ToArray (); + return ImmutableArray.Create (standardNames); + } + + private static readonly Lazy> _argbNameMap = new ( + MapValueFactory, + LazyThreadSafetyMode.PublicationOnly); + + private static FrozenDictionary MapValueFactory () + { + string [] standardNames = Enum.GetNames () + .Order () + .ToArray (); Dictionary map = new (standardNames.Length); + foreach (string name in standardNames) { - StandardColor standardColor = Enum.Parse (name); + var standardColor = Enum.Parse (name); uint argb = GetArgb (standardColor); + // TODO: Collect aliases? _ = map.TryAdd (argb, name); } - _names = ImmutableArray.Create (standardNames); - _argbNameMap = map.ToFrozenDictionary (); + return map.ToFrozenDictionary (); } /// - /// Gets read-only list of the W3C colors in alphabetical order. + /// Gets read-only list of the W3C colors in alphabetical order. /// - public static IReadOnlyList GetColorNames () - { - return _names; - } + public static IReadOnlyList GetColorNames () => _names.Value; /// - /// Converts the given Standard (W3C+) color name to equivalent color value. + /// Converts the given Standard (W3C+) color name to equivalent color value. /// /// Standard (W3C+) color name. /// The successfully converted Standard (W3C+) color value. /// True if the conversion succeeded; otherwise false. public static bool TryParseColor (ReadOnlySpan name, out Color color) { - if (!Enum.TryParse (name, ignoreCase: true, out StandardColor standardColor) || + if (!Enum.TryParse (name, true, out StandardColor standardColor) + || + // Any numerical value converts to undefined enum value. !Enum.IsDefined (standardColor)) { - color = default; + color = default (Color); + return false; } uint argb = GetArgb (standardColor); - color = new Color (argb); + color = new (argb); + return true; } /// - /// Converts the given color value to a Standard (W3C+) color name. + /// Converts the given color value to a Standard (W3C+) color name. /// /// Color value to match Standard (W3C+)color. /// The successfully converted Standard (W3C+) color name. /// True if conversion succeeded; otherwise false. public static bool TryNameColor (Color color, [NotNullWhen (true)] out string? name) { - if (_argbNameMap.TryGetValue (color.Argb, out name)) + if (_argbNameMap.Value.TryGetValue (color.Argb, out name)) { return true; } name = null; + return false; } @@ -83,9 +97,10 @@ internal static class StandardColors const int ALPHA_SHIFT = 24; const uint ALPHA_MASK = 0xFFU << ALPHA_SHIFT; - int rgb = (int)standardColor; + var rgb = (int)standardColor; uint argb = (uint)rgb | ALPHA_MASK; + return argb; } } diff --git a/Terminal.Gui/Drawing/Color/StandardColorsNameResolver.cs b/Terminal.Gui/Drawing/Color/StandardColorsNameResolver.cs index daae80b9e..0c8a4257a 100644 --- a/Terminal.Gui/Drawing/Color/StandardColorsNameResolver.cs +++ b/Terminal.Gui/Drawing/Color/StandardColorsNameResolver.cs @@ -1,5 +1,3 @@ -#nullable enable - using System.Diagnostics.CodeAnalysis; namespace Terminal.Gui.Drawing; @@ -17,4 +15,4 @@ public class StandardColorsNameResolver : IColorNameResolver /// public bool TryNameColor (Color color, [NotNullWhen (true)] out string? name) => StandardColors.TryNameColor (color, out name); -} \ No newline at end of file +} diff --git a/Terminal.Gui/Drawing/Glyphs.cs b/Terminal.Gui/Drawing/Glyphs.cs index 28eb3a546..71336009d 100644 --- a/Terminal.Gui/Drawing/Glyphs.cs +++ b/Terminal.Gui/Drawing/Glyphs.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.Drawing; /// Defines the standard set of glyphs used to draw checkboxes, lines, borders, etc... diff --git a/Terminal.Gui/Drawing/GraphemeHelper.cs b/Terminal.Gui/Drawing/GraphemeHelper.cs new file mode 100644 index 000000000..4ae00148c --- /dev/null +++ b/Terminal.Gui/Drawing/GraphemeHelper.cs @@ -0,0 +1,49 @@ +using System.Globalization; + +namespace Terminal.Gui.Drawing; + +/// +/// Provides utility methods for enumerating Unicode grapheme clusters (user-perceived characters) +/// in a string. A grapheme cluster may consist of one or more values, +/// including combining marks or zero-width joiner (ZWJ) sequences such as emoji family groups. +/// +/// +/// +/// This helper uses to enumerate +/// text elements according to the Unicode Standard Annex #29 (UAX #29) rules for +/// extended grapheme clusters. +/// +/// +/// On legacy Windows consoles (e.g., cmd.exe, conhost.exe), complex grapheme +/// sequences such as ZWJ emoji or combining marks may not render correctly, even though +/// the underlying string data is valid. +/// +/// +/// For most accurate visual rendering, prefer modern terminals such as Windows Terminal +/// or Linux-based terminals with full Unicode and font support. +/// +/// +public static class GraphemeHelper +{ + /// + /// Enumerates extended grapheme clusters from a string. + /// Handles surrogate pairs, combining marks, and basic ZWJ sequences. + /// Safe for legacy consoles; memory representation is correct. + /// + public static IEnumerable GetGraphemes (string text) + { + if (string.IsNullOrEmpty (text)) + { + yield break; + } + + TextElementEnumerator enumerator = StringInfo.GetTextElementEnumerator (text); + + while (enumerator.MoveNext ()) + { + string element = enumerator.GetTextElement (); + + yield return element; + } + } +} diff --git a/Terminal.Gui/Drawing/LineCanvas/IntersectionDefinition.cs b/Terminal.Gui/Drawing/LineCanvas/IntersectionDefinition.cs index a03f8bca8..9f2c77df7 100644 --- a/Terminal.Gui/Drawing/LineCanvas/IntersectionDefinition.cs +++ b/Terminal.Gui/Drawing/LineCanvas/IntersectionDefinition.cs @@ -17,4 +17,4 @@ internal class IntersectionDefinition /// Defines how position relates to . internal IntersectionType Type { get; } -} \ No newline at end of file +} diff --git a/Terminal.Gui/Drawing/LineCanvas/IntersectionRuneType.cs b/Terminal.Gui/Drawing/LineCanvas/IntersectionRuneType.cs index b32310fa7..c3a0043f7 100644 --- a/Terminal.Gui/Drawing/LineCanvas/IntersectionRuneType.cs +++ b/Terminal.Gui/Drawing/LineCanvas/IntersectionRuneType.cs @@ -16,4 +16,4 @@ internal enum IntersectionRuneType Cross, HLine, VLine -} \ No newline at end of file +} diff --git a/Terminal.Gui/Drawing/LineCanvas/IntersectionType.cs b/Terminal.Gui/Drawing/LineCanvas/IntersectionType.cs index 87a051e55..e0cecf815 100644 --- a/Terminal.Gui/Drawing/LineCanvas/IntersectionType.cs +++ b/Terminal.Gui/Drawing/LineCanvas/IntersectionType.cs @@ -25,4 +25,4 @@ internal enum IntersectionType /// A line exists at this point who has 0 length Dot -} \ No newline at end of file +} diff --git a/Terminal.Gui/Drawing/LineCanvas/LineCanvas.cs b/Terminal.Gui/Drawing/LineCanvas/LineCanvas.cs index 637b61861..763467096 100644 --- a/Terminal.Gui/Drawing/LineCanvas/LineCanvas.cs +++ b/Terminal.Gui/Drawing/LineCanvas/LineCanvas.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Runtime.InteropServices; @@ -174,14 +173,14 @@ public class LineCanvas : IDisposable intersectionsBufferList.Clear (); foreach (var line in _lines) { - if (line.Intersects (x, y) is IntersectionDefinition intersect) + if (line.Intersects (x, y) is { } intersect) { intersectionsBufferList.Add (intersect); } } // Safe as long as the list is not modified while the span is in use. ReadOnlySpan intersects = CollectionsMarshal.AsSpan(intersectionsBufferList); - Cell? cell = GetCellForIntersects (Application.Driver, intersects); + Cell? cell = GetCellForIntersects (intersects); // TODO: Can we skip the whole nested looping if _exclusionRegion is null? if (cell is { } && _exclusionRegion?.Contains (x, y) is null or false) { @@ -218,12 +217,11 @@ public class LineCanvas : IDisposable for (int x = inArea.X; x < inArea.X + inArea.Width; x++) { IntersectionDefinition [] intersects = _lines - // ! nulls are filtered out by the next Where filter - .Select (l => l.Intersects (x, y)!) - .Where (i => i is not null) + .Select (l => l.Intersects (x, y)) + .OfType () // automatically filters nulls and casts .ToArray (); - Rune? rune = GetRuneForIntersects (Application.Driver, intersects); + Rune? rune = GetRuneForIntersects (intersects); if (rune is { } && _exclusionRegion?.Contains (x, y) is null or false) { @@ -402,7 +400,7 @@ public class LineCanvas : IDisposable // TODO: Add other resolvers }; - private Cell? GetCellForIntersects (IDriver? driver, ReadOnlySpan intersects) + private Cell? GetCellForIntersects (ReadOnlySpan intersects) { if (intersects.IsEmpty) { @@ -410,11 +408,11 @@ public class LineCanvas : IDisposable } var cell = new Cell (); - Rune? rune = GetRuneForIntersects (driver, intersects); + Rune? rune = GetRuneForIntersects (intersects); if (rune.HasValue) { - cell.Rune = rune.Value; + cell.Grapheme = rune.ToString ()!; } cell.Attribute = GetAttributeForIntersects (intersects); @@ -422,7 +420,7 @@ public class LineCanvas : IDisposable return cell; } - private Rune? GetRuneForIntersects (IDriver? driver, ReadOnlySpan intersects) + private Rune? GetRuneForIntersects (ReadOnlySpan intersects) { if (intersects.IsEmpty) { @@ -432,7 +430,7 @@ public class LineCanvas : IDisposable IntersectionRuneType runeType = GetRuneTypeForIntersects (intersects); if (_runeResolvers.TryGetValue (runeType, out IntersectionRuneResolver? resolver)) { - return resolver.GetRuneForIntersects (driver, intersects); + return resolver.GetRuneForIntersects (intersects); } // TODO: Remove these once we have all of the below ported to IntersectionRuneResolvers @@ -769,7 +767,7 @@ public class LineCanvas : IDisposable internal Rune _thickV; protected IntersectionRuneResolver () { SetGlyphs (); } - public Rune? GetRuneForIntersects (IDriver? driver, ReadOnlySpan intersects) + public Rune? GetRuneForIntersects (ReadOnlySpan intersects) { // Note that there aren't any glyphs for intersections of double lines with heavy lines diff --git a/Terminal.Gui/Drawing/LineCanvas/LineStyle.cs b/Terminal.Gui/Drawing/LineCanvas/LineStyle.cs index 9c8f234fe..9b93708db 100644 --- a/Terminal.Gui/Drawing/LineCanvas/LineStyle.cs +++ b/Terminal.Gui/Drawing/LineCanvas/LineStyle.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Text.Json.Serialization; namespace Terminal.Gui.Drawing; diff --git a/Terminal.Gui/Drawing/LineCanvas/StraightLine.cs b/Terminal.Gui/Drawing/LineCanvas/StraightLine.cs index 5e64c0b7a..b4f86665d 100644 --- a/Terminal.Gui/Drawing/LineCanvas/StraightLine.cs +++ b/Terminal.Gui/Drawing/LineCanvas/StraightLine.cs @@ -1,6 +1,5 @@  namespace Terminal.Gui.Drawing; -#nullable enable // TODO: Add events that notify when StraightLine changes to enable dynamic layout /// A line between two points on a horizontal or vertical and a given style/color. diff --git a/Terminal.Gui/Drawing/LineCanvas/StraightLineExtensions.cs b/Terminal.Gui/Drawing/LineCanvas/StraightLineExtensions.cs index 1cff548ae..f8089952f 100644 --- a/Terminal.Gui/Drawing/LineCanvas/StraightLineExtensions.cs +++ b/Terminal.Gui/Drawing/LineCanvas/StraightLineExtensions.cs @@ -1,4 +1,4 @@ - + namespace Terminal.Gui.Drawing; /// Extension methods for (including collections). @@ -187,7 +187,7 @@ public static class StraightLineExtensions { if (length == 0) { - throw new ArgumentException ("0 length lines are not supported", nameof (length)); + throw new ArgumentException (@"0 length lines are not supported", nameof (length)); } int sub = length > 0 ? 1 : -1; @@ -220,7 +220,7 @@ public static class StraightLineExtensions { if (length == 0) { - throw new ArgumentException ("0 length lines are not supported", nameof (length)); + throw new ArgumentException (@"0 length lines are not supported", nameof (length)); } int sub = length > 0 ? 1 : -1; diff --git a/Terminal.Gui/Drawing/Quant/PopularityPaletteWithThreshold.cs b/Terminal.Gui/Drawing/Quant/PopularityPaletteWithThreshold.cs index 0e7f53596..c98050941 100644 --- a/Terminal.Gui/Drawing/Quant/PopularityPaletteWithThreshold.cs +++ b/Terminal.Gui/Drawing/Quant/PopularityPaletteWithThreshold.cs @@ -1,8 +1,9 @@ - +namespace Terminal.Gui.Drawing; + /// /// Simple fast palette building algorithm which uses the frequency that a color is seen -/// to determine whether it will appear in the final palette. Includes a threshold where -/// by colors will be considered 'the same'. This reduces the chance of under represented +/// to determine whether it will appear in the final palette. Includes a threshold whereby +/// colors will be considered 'the same'. This reduces the chance of underrepresented /// colors being missed completely. /// public class PopularityPaletteWithThreshold : IPaletteBuilder @@ -22,11 +23,11 @@ public class PopularityPaletteWithThreshold : IPaletteBuilder } /// - public List BuildPalette (List colors, int maxColors) + public List BuildPalette (List? colors, int maxColors) { - if (colors == null || colors.Count == 0 || maxColors <= 0) + if (colors is null || colors.Count == 0 || maxColors <= 0) { - return new (); + return []; } // Step 1: Build the histogram of colors (count occurrences) @@ -34,14 +35,10 @@ public class PopularityPaletteWithThreshold : IPaletteBuilder foreach (Color color in colors) { - if (colorHistogram.ContainsKey (color)) + if (!colorHistogram.TryAdd (color, 1)) { colorHistogram [color]++; } - else - { - colorHistogram [color] = 1; - } } // If we already have fewer or equal colors than the limit, no need to merge diff --git a/Terminal.Gui/Drawing/Region.cs b/Terminal.Gui/Drawing/Region.cs index f3abb8e07..597801a6a 100644 --- a/Terminal.Gui/Drawing/Region.cs +++ b/Terminal.Gui/Drawing/Region.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.Drawing; @@ -51,10 +50,10 @@ public class Region private readonly List _rectangles = []; // Add a single reusable list for temp operations - private readonly List _tempRectangles = new(); + private readonly List _tempRectangles = new (); // Object used for synchronization - private readonly object _syncLock = new object(); + private readonly object _syncLock = new object (); /// /// Initializes a new instance of the class. @@ -121,12 +120,12 @@ public class Region { lock (_syncLock) { - CombineInternal(region, operation); + CombineInternal (region, operation); } } // Private method to implement the combine logic within a lock - private void CombineInternal(Region? region, RegionOp operation) + private void CombineInternal (Region? region, RegionOp operation) { if (region is null || region._rectangles.Count == 0) { @@ -189,36 +188,36 @@ public class Region case RegionOp.Union: // Avoid collection initialization with spread operator - _tempRectangles.Clear(); - _tempRectangles.AddRange(_rectangles); + _tempRectangles.Clear (); + _tempRectangles.AddRange (_rectangles); if (region != null) { // Get the region's rectangles safely lock (region._syncLock) { - _tempRectangles.AddRange(region._rectangles); + _tempRectangles.AddRange (region._rectangles); } } - List mergedUnion = MergeRectangles(_tempRectangles, false); - _rectangles.Clear(); - _rectangles.AddRange(mergedUnion); + List mergedUnion = MergeRectangles (_tempRectangles, false); + _rectangles.Clear (); + _rectangles.AddRange (mergedUnion); break; case RegionOp.MinimalUnion: // Avoid collection initialization with spread operator - _tempRectangles.Clear(); - _tempRectangles.AddRange(_rectangles); + _tempRectangles.Clear (); + _tempRectangles.AddRange (_rectangles); if (region != null) { // Get the region's rectangles safely lock (region._syncLock) { - _tempRectangles.AddRange(region._rectangles); + _tempRectangles.AddRange (region._rectangles); } } - List mergedMinimalUnion = MergeRectangles(_tempRectangles, true); - _rectangles.Clear(); - _rectangles.AddRange(mergedMinimalUnion); + List mergedMinimalUnion = MergeRectangles (_tempRectangles, true); + _rectangles.Clear (); + _rectangles.AddRange (mergedMinimalUnion); break; case RegionOp.XOR: @@ -588,17 +587,26 @@ public class Region { // 1. Sort by X int cmp = a.x.CompareTo (b.x); - if (cmp != 0) return cmp; + if (cmp != 0) + { + return cmp; + } // 2. Sort End events before Start events bool aIsEnd = !a.isStart; bool bIsEnd = !b.isStart; cmp = aIsEnd.CompareTo (bIsEnd); // True (End) comes after False (Start) - if (cmp != 0) return -cmp; // Reverse: End (true) should come before Start (false) + if (cmp != 0) + { + return -cmp; // Reverse: End (true) should come before Start (false) + } // 3. Tie-breaker: Sort by yTop cmp = a.yTop.CompareTo (b.yTop); - if (cmp != 0) return cmp; + if (cmp != 0) + { + return cmp; + } // 4. Final Tie-breaker: Sort by yBottom return a.yBottom.CompareTo (b.yBottom); @@ -901,13 +909,16 @@ public class Region /// /// Fills the interior of all rectangles in the region with the specified attribute and fill rune. /// + /// /// The attribute (color/style) to use. /// /// The rune to fill the interior of the rectangles with. If space will be /// used. /// - public void FillRectangles (Attribute attribute, Rune? fillRune = null) + public void FillRectangles (IDriver? driver, Attribute? attribute, Rune? fillRune = null) { + ArgumentNullException.ThrowIfNull (driver); + if (_rectangles.Count == 0) { return; @@ -920,14 +931,14 @@ public class Region continue; } - Application.Driver?.SetAttribute (attribute); + driver?.SetAttribute (attribute!.Value); for (int y = rect.Top; y < rect.Bottom; y++) { for (int x = rect.Left; x < rect.Right; x++) { - Application.Driver?.Move (x, y); - Application.Driver?.AddRune (fillRune ?? (Rune)' '); + driver?.Move (x, y); + driver?.AddRune (fillRune ?? (Rune)' '); } } } @@ -1046,7 +1057,7 @@ public class Region if (bounds.Width > 1000 || bounds.Height > 1000) { // Fall back to drawing each rectangle's boundary - DrawBoundaries(lineCanvas, style, attribute); + DrawBoundaries (lineCanvas, style, attribute); return; } diff --git a/Terminal.Gui/Drawing/RegionOp.cs b/Terminal.Gui/Drawing/RegionOp.cs index e40de1663..0b4689a37 100644 --- a/Terminal.Gui/Drawing/RegionOp.cs +++ b/Terminal.Gui/Drawing/RegionOp.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.Drawing; /// diff --git a/Terminal.Gui/Drawing/Ruler.cs b/Terminal.Gui/Drawing/Ruler.cs index 89ef6b6d1..4c457976f 100644 --- a/Terminal.Gui/Drawing/Ruler.cs +++ b/Terminal.Gui/Drawing/Ruler.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.Drawing; /// Draws a ruler on the screen. @@ -21,11 +20,13 @@ internal class Ruler private string _vTemplate { get; } = "-123456789"; /// Draws the . + /// Optional Driver. If not provided, driver will be used. /// The location to start drawing the ruler, in screen-relative coordinates. /// The start value of the ruler. - /// Optional Driver. If not provided, driver will be used. - public void Draw (Point location, int start = 0, IDriver? driver = null) + public void Draw (IDriver? driver, Point location, int start = 0) { + ArgumentNullException.ThrowIfNull (driver); + if (start < 0) { throw new ArgumentException ("start must be greater than or equal to 0"); @@ -36,8 +37,6 @@ internal class Ruler return; } - driver ??= driver; - if (Orientation == Orientation.Horizontal) { string hrule = diff --git a/Terminal.Gui/Drawing/Scheme.cs b/Terminal.Gui/Drawing/Scheme.cs index ff0933aac..d513fc1e7 100644 --- a/Terminal.Gui/Drawing/Scheme.cs +++ b/Terminal.Gui/Drawing/Scheme.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Immutable; using System.Numerics; using System.Text.Json.Serialization; @@ -163,7 +162,7 @@ public record Scheme : IEqualityOperators new (SchemeManager.SchemesToSchemeName (Schemes.Dialog)!, CreateDialog ()), new (SchemeManager.SchemesToSchemeName (Schemes.Error)!, CreateError ()), new (SchemeManager.SchemesToSchemeName (Schemes.Menu)!, CreateMenu ()), - new (SchemeManager.SchemesToSchemeName (Schemes.Toplevel)!, CreateToplevel ()), + new (SchemeManager.SchemesToSchemeName (Schemes.Runnable)!, CreateRunnable ()), ] ); @@ -199,7 +198,7 @@ public record Scheme : IEqualityOperators }; } - Scheme CreateToplevel () + Scheme CreateRunnable () { return new () { diff --git a/Terminal.Gui/Drawing/Schemes.cs b/Terminal.Gui/Drawing/Schemes.cs index 5408f6b8c..30d66458f 100644 --- a/Terminal.Gui/Drawing/Schemes.cs +++ b/Terminal.Gui/Drawing/Schemes.cs @@ -23,9 +23,9 @@ public enum Schemes Dialog, /// - /// The application Toplevel scheme, used for the Toplevel View. + /// The scheme used for views that support . /// - Toplevel, + Runnable, /// /// The scheme for showing errors. diff --git a/Terminal.Gui/Drawing/Sixel/SixelSupportDetector.cs b/Terminal.Gui/Drawing/Sixel/SixelSupportDetector.cs index 01df783a4..a9e1ae8aa 100644 --- a/Terminal.Gui/Drawing/Sixel/SixelSupportDetector.cs +++ b/Terminal.Gui/Drawing/Sixel/SixelSupportDetector.cs @@ -6,8 +6,21 @@ namespace Terminal.Gui.Drawing; /// Uses Ansi escape sequences to detect whether sixel is supported /// by the terminal. /// -public class SixelSupportDetector +public class SixelSupportDetector () { + private readonly IDriver? _driver; + + /// + /// Creates a new instance of the class. + /// + /// + public SixelSupportDetector (IDriver? driver) : this () + { + ArgumentNullException.ThrowIfNull (driver); + + _driver = driver; + } + /// /// Sends Ansi escape sequences to the console to determine whether /// sixel is supported (and @@ -127,17 +140,17 @@ public class SixelSupportDetector () => resultCallback (result)); } - private static void QueueRequest (AnsiEscapeSequence req, Action responseCallback, Action abandoned) + private void QueueRequest (AnsiEscapeSequence req, Action responseCallback, Action abandoned) { var newRequest = new AnsiEscapeSequenceRequest { Request = req.Request, Terminator = req.Terminator, - ResponseReceived = responseCallback, + ResponseReceived = responseCallback!, Abandoned = abandoned }; - Application.Driver?.QueueAnsiRequest (newRequest); + _driver?.QueueAnsiRequest (newRequest); } private static bool ResponseIndicatesSupport (string response) { return response.Split (';').Contains ("4"); } @@ -145,14 +158,12 @@ public class SixelSupportDetector private static bool IsVirtualTerminal () { return !string.IsNullOrWhiteSpace (Environment.GetEnvironmentVariable ("WT_SESSION")); - - ; } private static bool IsXtermWithTransparency () { // Check if running in real xterm (XTERM_VERSION is more reliable than TERM) - string xtermVersionStr = Environment.GetEnvironmentVariable ("XTERM_VERSION"); + string xtermVersionStr = Environment.GetEnvironmentVariable (@"XTERM_VERSION")!; // If XTERM_VERSION exists, we are in a real xterm if (!string.IsNullOrWhiteSpace (xtermVersionStr) && int.TryParse (xtermVersionStr, out int xtermVersion) && xtermVersion >= 370) diff --git a/Terminal.Gui/Drawing/Sixel/SixelToRender.cs b/Terminal.Gui/Drawing/Sixel/SixelToRender.cs index c66d4bdaf..89c3b26b5 100644 --- a/Terminal.Gui/Drawing/Sixel/SixelToRender.cs +++ b/Terminal.Gui/Drawing/Sixel/SixelToRender.cs @@ -10,7 +10,7 @@ public class SixelToRender /// gets or sets the encoded sixel data. Use to convert bitmaps /// into encoded sixel data. /// - public string SixelData { get; set; } + public string? SixelData { get; set; } /// /// gets or sets where to move the cursor to before outputting the . diff --git a/Terminal.Gui/Drawing/Thickness.cs b/Terminal.Gui/Drawing/Thickness.cs index c89773f1c..a15b49fd4 100644 --- a/Terminal.Gui/Drawing/Thickness.cs +++ b/Terminal.Gui/Drawing/Thickness.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Numerics; +using System.Numerics; using System.Text.Json.Serialization; namespace Terminal.Gui.Drawing; @@ -90,15 +89,15 @@ public record struct Thickness /// The diagnostics label to draw on the bottom of the . /// Optional driver. If not specified, will be used. /// The inner rectangle remaining to be drawn. - public Rectangle Draw (Rectangle rect, ViewDiagnosticFlags diagnosticFlags = ViewDiagnosticFlags.Off, string? label = null, IDriver? driver = null) + public Rectangle Draw (IDriver? driver, Rectangle rect, ViewDiagnosticFlags diagnosticFlags = ViewDiagnosticFlags.Off, string? label = null) { + ArgumentNullException.ThrowIfNull (driver); + if (rect.Size.Width < 1 || rect.Size.Height < 1) { return Rectangle.Empty; } - driver ??= Application.Driver; - var clearChar = (Rune)' '; Rune leftChar = clearChar; Rune rightChar = clearChar; @@ -165,7 +164,7 @@ public record struct Thickness if (Top > 0) { - hRuler.Draw (rect.Location, driver: driver); + hRuler.Draw (driver: driver, location: rect.Location); } //Left @@ -173,19 +172,19 @@ public record struct Thickness if (Left > 0) { - vRuler.Draw (rect.Location with { Y = rect.Y + 1 }, 1, driver); + vRuler.Draw (driver, rect.Location with { Y = rect.Y + 1 }, 1); } // Bottom if (Bottom > 0) { - hRuler.Draw (rect.Location with { Y = rect.Y + rect.Height - 1 }, driver: driver); + hRuler.Draw (driver: driver, location: rect.Location with { Y = rect.Y + rect.Height - 1 }); } // Right if (Right > 0) { - vRuler.Draw (new (rect.X + rect.Width - 1, rect.Y + 1), 1, driver); + vRuler.Draw (driver, new (rect.X + rect.Width - 1, rect.Y + 1), 1); } } @@ -205,7 +204,7 @@ public record struct Thickness if (driver?.CurrentAttribute is { }) { - tf.Draw (rect, driver!.CurrentAttribute, driver!.CurrentAttribute, rect, driver); + tf.Draw (driver, rect, driver!.CurrentAttribute, driver!.CurrentAttribute, rect); } } diff --git a/Terminal.Gui/Drawing/VisualRoleEventArgs.cs b/Terminal.Gui/Drawing/VisualRoleEventArgs.cs index 5f0389967..bdc54af8f 100644 --- a/Terminal.Gui/Drawing/VisualRoleEventArgs.cs +++ b/Terminal.Gui/Drawing/VisualRoleEventArgs.cs @@ -1,5 +1,4 @@ -#nullable enable -namespace Terminal.Gui.Drawing; +namespace Terminal.Gui.Drawing; using System; @@ -60,4 +59,4 @@ public class VisualRoleEventArgs : ResultEventArgs } } -#pragma warning restore CS1711 \ No newline at end of file +#pragma warning restore CS1711 diff --git a/Terminal.Gui/Drivers/AnsiHandling/AnsiEscapeSequence.cs b/Terminal.Gui/Drivers/AnsiHandling/AnsiEscapeSequence.cs index 5b0471776..b90bf3702 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/AnsiEscapeSequence.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/AnsiEscapeSequence.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/AnsiHandling/AnsiEscapeSequenceRequest.cs b/Terminal.Gui/Drivers/AnsiHandling/AnsiEscapeSequenceRequest.cs index de61ae920..cce053a1a 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/AnsiEscapeSequenceRequest.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/AnsiEscapeSequenceRequest.cs @@ -1,5 +1,3 @@ -#nullable enable - namespace Terminal.Gui.Drivers; /// @@ -20,12 +18,12 @@ public class AnsiEscapeSequenceRequest : AnsiEscapeSequence /// public Action? Abandoned { get; init; } - /// /// Sends the to the raw output stream of the current . /// Only call this method from the main UI thread. You should use if /// sending many requests. /// - public void Send () { Application.Driver?.WriteRaw (Request); } + /// + public void Send (IDriver? driver) { driver?.WriteRaw (Request); } } diff --git a/Terminal.Gui/Drivers/AnsiHandling/AnsiMouseParser.cs b/Terminal.Gui/Drivers/AnsiHandling/AnsiMouseParser.cs index 7f3f82709..882863a6a 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/AnsiMouseParser.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/AnsiMouseParser.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Text.RegularExpressions; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/AnsiHandling/AnsiRequestScheduler.cs b/Terminal.Gui/Drivers/AnsiHandling/AnsiRequestScheduler.cs index 3f20af735..8fd50a4cc 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/AnsiRequestScheduler.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/AnsiRequestScheduler.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Concurrent; namespace Terminal.Gui.Drivers; @@ -70,15 +69,16 @@ public class AnsiRequestScheduler /// Sends the immediately or queues it if there is already /// an outstanding request for the given . /// + /// /// /// if request was sent immediately. if it was queued. - public bool SendOrSchedule (AnsiEscapeSequenceRequest request) { return SendOrSchedule (request, true); } + public bool SendOrSchedule (IDriver? driver, AnsiEscapeSequenceRequest request) { return SendOrSchedule (driver, request, true); } - private bool SendOrSchedule (AnsiEscapeSequenceRequest request, bool addToQueue) + private bool SendOrSchedule (IDriver? driver, AnsiEscapeSequenceRequest request, bool addToQueue) { if (CanSend (request, out ReasonCannotSend reason)) { - Send (request); + Send (driver, request); return true; } @@ -91,7 +91,7 @@ public class AnsiRequestScheduler // Try again after evicting if (CanSend (request, out _)) { - Send (request); + Send (driver, request); return true; } @@ -142,6 +142,7 @@ public class AnsiRequestScheduler /// Identifies and runs any that can be sent based on the /// current outstanding requests of the parser. /// + /// /// /// Repeated requests to run the schedule over short period of time will be ignored. /// Pass to override this behaviour and force evaluation of outstanding requests. @@ -150,7 +151,7 @@ public class AnsiRequestScheduler /// if a request was found and run. /// if no outstanding requests or all have existing outstanding requests underway in parser. /// - public bool RunSchedule (bool force = false) + public bool RunSchedule (IDriver? driver, bool force = false) { if (!force && Now () - _lastRun < _runScheduleThrottle) { @@ -163,7 +164,7 @@ public class AnsiRequestScheduler if (opportunity != null) { // Give it another go - if (SendOrSchedule (opportunity.Item1, false)) + if (SendOrSchedule (driver, opportunity.Item1, false)) { _queuedRequests.Remove (opportunity); @@ -176,11 +177,11 @@ public class AnsiRequestScheduler return false; } - private void Send (AnsiEscapeSequenceRequest r) + private void Send (IDriver? driver, AnsiEscapeSequenceRequest r) { _lastSend.AddOrUpdate (r.Terminator!, _ => Now (), (_, _) => Now ()); _parser.ExpectResponse (r.Terminator, r.ResponseReceived, r.Abandoned, false); - r.Send (); + r.Send (driver); } private bool CanSend (AnsiEscapeSequenceRequest r, out ReasonCannotSend reason) diff --git a/Terminal.Gui/Drivers/AnsiHandling/AnsiResponseExpectation.cs b/Terminal.Gui/Drivers/AnsiHandling/AnsiResponseExpectation.cs index fd087de75..1c6539316 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/AnsiResponseExpectation.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/AnsiResponseExpectation.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; internal record AnsiResponseExpectation (string? Terminator, Action Response, Action? Abandoned) diff --git a/Terminal.Gui/Drivers/AnsiHandling/AnsiResponseParser.cs b/Terminal.Gui/Drivers/AnsiHandling/AnsiResponseParser.cs index 5bafbfe55..60f6d87f5 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/AnsiResponseParser.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/AnsiResponseParser.cs @@ -1,5 +1,3 @@ -#nullable enable - using Microsoft.Extensions.Logging; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqReqStatus.cs b/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqReqStatus.cs index ab062e253..8943ab1bc 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqReqStatus.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqReqStatus.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqRequests.cs b/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqRequests.cs index 6e69f6a12..d619539b4 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqRequests.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqRequests.cs @@ -1,5 +1,3 @@ -#nullable enable - namespace Terminal.Gui.Drivers; /// @@ -18,7 +16,7 @@ public static class EscSeqRequests /// /// The terminator. /// The number of requests. - public static void Add (string terminator, int numRequests = 1) + public static void Add (string? terminator, int numRequests = 1) { ArgumentException.ThrowIfNullOrEmpty (terminator); diff --git a/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqUtils.cs b/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqUtils.cs index 6257d1d66..3f9d27d0f 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqUtils.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/EscSeqUtils/EscSeqUtils.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; using System.Globalization; diff --git a/Terminal.Gui/Drivers/AnsiHandling/GenericHeld.cs b/Terminal.Gui/Drivers/AnsiHandling/GenericHeld.cs index 6373003fa..6339b4ee2 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/GenericHeld.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/GenericHeld.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/AnsiHandling/IAnsiResponseParser.cs b/Terminal.Gui/Drivers/AnsiHandling/IAnsiResponseParser.cs index cfdb775f0..29892a2da 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/IAnsiResponseParser.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/IAnsiResponseParser.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/AnsiHandling/IHeld.cs b/Terminal.Gui/Drivers/AnsiHandling/IHeld.cs index 369ef4732..e6d5a3a06 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/IHeld.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/IHeld.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/AnsiKeyboardParser.cs b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/AnsiKeyboardParser.cs index ee41d6cca..89ef61a58 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/AnsiKeyboardParser.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/AnsiKeyboardParser.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/AnsiKeyboardParserPattern.cs b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/AnsiKeyboardParserPattern.cs index 62b0acb64..51011124a 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/AnsiKeyboardParserPattern.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/AnsiKeyboardParserPattern.cs @@ -1,5 +1,3 @@ -#nullable enable - namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/CsiCursorPattern.cs b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/CsiCursorPattern.cs index 744658a76..61adedd62 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/CsiCursorPattern.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/CsiCursorPattern.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Text.RegularExpressions; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/CsiKeyPattern.cs b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/CsiKeyPattern.cs index f0fb3b20b..ed2bcecbe 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/CsiKeyPattern.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/CsiKeyPattern.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Text.RegularExpressions; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/EscAsAltPattern.cs b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/EscAsAltPattern.cs index a9b16e90a..fd6b54321 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/EscAsAltPattern.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/EscAsAltPattern.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Text.RegularExpressions; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/Ss3Pattern.cs b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/Ss3Pattern.cs index 988b584f1..cf2804072 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/Keyboard/Ss3Pattern.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/Keyboard/Ss3Pattern.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Text.RegularExpressions; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/AnsiHandling/Osc8UrlLinker.cs b/Terminal.Gui/Drivers/AnsiHandling/Osc8UrlLinker.cs index 7a3e41a6d..d4cd43065 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/Osc8UrlLinker.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/Osc8UrlLinker.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/AnsiHandling/ReasonCannotSend.cs b/Terminal.Gui/Drivers/AnsiHandling/ReasonCannotSend.cs index 675c9ff64..ba0aa399c 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/ReasonCannotSend.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/ReasonCannotSend.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; internal enum ReasonCannotSend diff --git a/Terminal.Gui/Drivers/AnsiHandling/StringHeld.cs b/Terminal.Gui/Drivers/AnsiHandling/StringHeld.cs index 3202410ab..79e922098 100644 --- a/Terminal.Gui/Drivers/AnsiHandling/StringHeld.cs +++ b/Terminal.Gui/Drivers/AnsiHandling/StringHeld.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/ComponentFactoryImpl.cs b/Terminal.Gui/Drivers/ComponentFactoryImpl.cs index d09099954..04f79a88e 100644 --- a/Terminal.Gui/Drivers/ComponentFactoryImpl.cs +++ b/Terminal.Gui/Drivers/ComponentFactoryImpl.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Collections.Concurrent; +using System.Collections.Concurrent; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/CursorVisibility.cs b/Terminal.Gui/Drivers/CursorVisibility.cs index ca86e9a0a..7d0c5d9f4 100644 --- a/Terminal.Gui/Drivers/CursorVisibility.cs +++ b/Terminal.Gui/Drivers/CursorVisibility.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; /// Terminal Cursor Visibility settings. diff --git a/Terminal.Gui/Drivers/DotNetDriver/NetComponentFactory.cs b/Terminal.Gui/Drivers/DotNetDriver/NetComponentFactory.cs index 669c6efce..46b8b9efb 100644 --- a/Terminal.Gui/Drivers/DotNetDriver/NetComponentFactory.cs +++ b/Terminal.Gui/Drivers/DotNetDriver/NetComponentFactory.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Concurrent; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/DotNetDriver/NetInput.cs b/Terminal.Gui/Drivers/DotNetDriver/NetInput.cs index b44c59522..026689a45 100644 --- a/Terminal.Gui/Drivers/DotNetDriver/NetInput.cs +++ b/Terminal.Gui/Drivers/DotNetDriver/NetInput.cs @@ -1,5 +1,4 @@ -using Microsoft.Extensions.Logging; - +#nullable disable namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/DotNetDriver/NetOutput.cs b/Terminal.Gui/Drivers/DotNetDriver/NetOutput.cs index 8fbd11ba1..4f8ab1fc0 100644 --- a/Terminal.Gui/Drivers/DotNetDriver/NetOutput.cs +++ b/Terminal.Gui/Drivers/DotNetDriver/NetOutput.cs @@ -1,5 +1,3 @@ -using Microsoft.Extensions.Logging; - namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/DotNetDriver/NetWinVTConsole.cs b/Terminal.Gui/Drivers/DotNetDriver/NetWinVTConsole.cs index d6730e044..36cbf0e2a 100644 --- a/Terminal.Gui/Drivers/DotNetDriver/NetWinVTConsole.cs +++ b/Terminal.Gui/Drivers/DotNetDriver/NetWinVTConsole.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Runtime.InteropServices; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/DriverImpl.cs b/Terminal.Gui/Drivers/DriverImpl.cs index db1918459..9aebea3dd 100644 --- a/Terminal.Gui/Drivers/DriverImpl.cs +++ b/Terminal.Gui/Drivers/DriverImpl.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Runtime.InteropServices; +using System.Runtime.InteropServices; namespace Terminal.Gui.Drivers; @@ -75,9 +74,7 @@ internal class DriverImpl : IDriver CreateClipboard (); } - /// - /// The event fired when the screen changes (size, position, etc.). - /// + /// public event EventHandler? SizeChanged; /// @@ -89,7 +86,6 @@ internal class DriverImpl : IDriver /// public ISizeMonitor SizeMonitor { get; } - private void CreateClipboard () { if (InputProcessor.DriverName is { } && InputProcessor.DriverName.Contains ("fake")) @@ -120,27 +116,18 @@ internal class DriverImpl : IDriver // Clipboard is set to FakeClipboard at initialization } - /// Gets the location and size of the terminal screen. - public Rectangle Screen - { - get - { - //if (Application.RunningUnitTests && _output is WindowsConsoleOutput or NetOutput) - //{ - // // In unit tests, we don't have a real output, so we return an empty rectangle. - // return Rectangle.Empty; - //} + /// - return new (0, 0, OutputBuffer.Cols, OutputBuffer.Rows); - } - } + public Rectangle Screen => - /// - /// Sets the screen size for testing purposes. Only supported by FakeDriver. - /// - /// The new width in columns. - /// The new height in rows. - /// Thrown when called on non-FakeDriver instances. + //if (Application.RunningUnitTests && _output is WindowsConsoleOutput or NetOutput) + //{ + // // In unit tests, we don't have a real output, so we return an empty rectangle. + // return Rectangle.Empty; + //} + new (0, 0, OutputBuffer.Cols, OutputBuffer.Rows); + + /// public virtual void SetScreenSize (int width, int height) { OutputBuffer.SetSize (width, height); @@ -148,64 +135,60 @@ internal class DriverImpl : IDriver SizeChanged?.Invoke (this, new (new (width, height))); } - /// - /// Gets or sets the clip rectangle that and are subject - /// to. - /// - /// The rectangle describing the of region. + /// + public Region? Clip { get => OutputBuffer.Clip; set => OutputBuffer.Clip = value; } - /// Get the operating system clipboard. + /// + public IClipboard? Clipboard { get; private set; } = new FakeClipboard (); - /// - /// Gets the column last set by . and are used by - /// and to determine where to add content. - /// + /// + public int Col => OutputBuffer.Col; - /// The number of columns visible in the terminal. + /// + public int Cols { get => OutputBuffer.Cols; set => OutputBuffer.Cols = value; } - /// - /// The contents of the application output. The driver outputs this buffer to the terminal. - /// The format of the array is rows, columns. The first index is the row, the second index is the column. - /// + /// + public Cell [,]? Contents { get => OutputBuffer.Contents; set => OutputBuffer.Contents = value; } - /// The leftmost column in the terminal. + /// + public int Left { get => OutputBuffer.Left; set => OutputBuffer.Left = value; } - /// - /// Gets the row last set by . and are used by - /// and to determine where to add content. - /// + /// + public int Row => OutputBuffer.Row; - /// The number of rows visible in the terminal. + /// + public int Rows { get => OutputBuffer.Rows; set => OutputBuffer.Rows = value; } - /// The topmost row in the terminal. + /// + public int Top { get => OutputBuffer.Top; @@ -214,75 +197,33 @@ internal class DriverImpl : IDriver // TODO: Probably not everyone right? - /// Gets whether the supports TrueColor output. + /// + public bool SupportsTrueColor => true; - // TODO: Currently ignored - /// - /// Gets or sets whether the should use 16 colors instead of the default TrueColors. - /// See to change this setting via . - /// - /// - /// - /// Will be forced to if is - /// , indicating that the cannot support TrueColor. - /// - /// + /// + public bool Force16Colors { get => Application.Force16Colors || !SupportsTrueColor; set => Application.Force16Colors = value || !SupportsTrueColor; } - /// - /// The that will be used for the next or - /// - /// call. - /// + /// + public Attribute CurrentAttribute { get => OutputBuffer.CurrentAttribute; set => OutputBuffer.CurrentAttribute = value; } - /// Adds the specified rune to the display at the current cursor position. - /// - /// - /// When the method returns, will be incremented by the number of columns - /// required, even if the new column value is outside of the - /// or screen - /// dimensions defined by . - /// - /// - /// If requires more than one column, and plus the number - /// of columns - /// needed exceeds the or screen dimensions, the default Unicode replacement - /// character (U+FFFD) - /// will be added instead. - /// - /// - /// Rune to add. + /// public void AddRune (Rune rune) { OutputBuffer.AddRune (rune); } - /// - /// Adds the specified to the display at the current cursor position. This method is a - /// convenience method that calls with the - /// constructor. - /// - /// Character to add. + /// public void AddRune (char c) { OutputBuffer.AddRune (c); } - /// Adds the to the display at the cursor position. - /// - /// - /// When the method returns, will be incremented by the number of columns - /// required, unless the new column value is outside of the - /// or screen - /// dimensions defined by . - /// - /// If requires more columns than are available, the output will be clipped. - /// - /// String. + /// public void AddStr (string str) { OutputBuffer.AddStr (str); } /// Clears the of the driver. @@ -292,28 +233,13 @@ internal class DriverImpl : IDriver ClearedContents?.Invoke (this, new MouseEventArgs ()); } - /// - /// Raised each time is called. For benchmarking. - /// + /// public event EventHandler? ClearedContents; - /// - /// Fills the specified rectangle with the specified rune, using - /// - /// - /// The value of is honored. Any parts of the rectangle not in the clip will not be - /// drawn. - /// - /// The Screen-relative rectangle. - /// The Rune used to fill the rectangle + /// public void FillRect (Rectangle rect, Rune rune = default) { OutputBuffer.FillRect (rect, rune); } - /// - /// Fills the specified rectangle with the specified . This method is a convenience method - /// that calls . - /// - /// - /// + /// public void FillRect (Rectangle rect, char c) { OutputBuffer.FillRect (rect, c); } /// @@ -324,16 +250,11 @@ internal class DriverImpl : IDriver return type; } - /// Tests if the specified rune is supported by the driver. - /// - /// - /// if the rune can be properly presented; if the driver does not - /// support displaying this rune. - /// - public bool IsRuneSupported (Rune rune) { return Rune.IsValid (rune.Value); } + /// + public bool IsRuneSupported (Rune rune) => Rune.IsValid (rune.Value); - /// Tests whether the specified coordinate are valid for drawing the specified Rune. - /// Used to determine if one or two columns are required. + /// Tests whether the specified coordinate are valid for drawing the specified Text. + /// Used to determine if one or two columns are required. /// The column. /// The row. /// @@ -341,31 +262,14 @@ internal class DriverImpl : IDriver /// . /// otherwise. /// - public bool IsValidLocation (Rune rune, int col, int row) { return OutputBuffer.IsValidLocation (rune, col, row); } + public bool IsValidLocation (string text, int col, int row) { return OutputBuffer.IsValidLocation (text, col, row); } - /// - /// Updates and to the specified column and row in - /// . - /// Used by and to determine - /// where to add content. - /// - /// - /// This does not move the cursor on the screen, it only updates the internal state of the driver. - /// - /// If or are negative or beyond - /// and - /// , the method still sets those properties. - /// - /// - /// Column to move to. - /// Row to move to. + /// public void Move (int col, int row) { OutputBuffer.Move (col, row); } // TODO: Probably part of output - /// Sets the terminal cursor visibility. - /// The wished - /// upon success + /// public bool SetCursorVisibility (CursorVisibility visibility) { _lastCursor = visibility; @@ -415,31 +319,22 @@ internal class DriverImpl : IDriver Logging.Error ($"Error suspending terminal: {ex.Message}"); } - Application.LayoutAndDraw (); - - Console.Out.Write (EscSeqUtils.CSI_EnableMouseEvents); } - /// - /// Sets the position of the terminal cursor to and - /// . - /// + /// public void UpdateCursor () { _output.SetCursorPosition (Col, Row); } - /// Initializes the driver + /// public void Init () { throw new NotSupportedException (); } - /// Ends the execution of the console driver. + /// public void End () { // TODO: Nope } - /// Selects the specified attribute as the attribute to use for future calls to AddRune and AddString. - /// Implementations should call base.SetAttribute(c). - /// C. - /// The previously set Attribute. + /// public Attribute SetAttribute (Attribute newAttribute) { Attribute currentAttribute = OutputBuffer.CurrentAttribute; @@ -448,51 +343,29 @@ internal class DriverImpl : IDriver return currentAttribute; } - /// Gets the current . - /// The current attribute. - public Attribute GetAttribute () { return OutputBuffer.CurrentAttribute; } + /// + public Attribute GetAttribute () => OutputBuffer.CurrentAttribute; /// Event fired when a key is pressed down. This is a precursor to . public event EventHandler? KeyDown; - /// Event fired when a key is released. - /// - /// Drivers that do not support key release events will fire this event after - /// processing is - /// complete. - /// + /// public event EventHandler? KeyUp; /// Event fired when a mouse event occurs. public event EventHandler? MouseEvent; - /// - /// Provide proper writing to send escape sequence recognized by the . - /// - /// + /// public void WriteRaw (string ansi) { _output.Write (ansi); } /// - public void EnqueueKeyEvent (Key key) - { - InputProcessor.EnqueueKeyDownEvent (key); - } + public void EnqueueKeyEvent (Key key) { InputProcessor.EnqueueKeyDownEvent (key); } - /// - /// Queues the specified ANSI escape sequence request for execution. - /// - /// The ANSI request to queue. - /// - /// The request is sent immediately if possible, or queued for later execution - /// by the to prevent overwhelming the console. - /// - public void QueueAnsiRequest (AnsiEscapeSequenceRequest request) { _ansiRequestScheduler.SendOrSchedule (request); } + /// + public void QueueAnsiRequest (AnsiEscapeSequenceRequest request) { _ansiRequestScheduler.SendOrSchedule (this, request); } - /// - /// Gets the instance used by this driver. - /// - /// The ANSI request scheduler. - public AnsiRequestScheduler GetRequestScheduler () { return _ansiRequestScheduler; } + /// + public AnsiRequestScheduler GetRequestScheduler () => _ansiRequestScheduler; /// public void Refresh () @@ -500,8 +373,39 @@ internal class DriverImpl : IDriver // No need we will always draw when dirty } - public string? GetName () + /// + public string? GetName () => InputProcessor.DriverName?.ToLowerInvariant (); + + /// + public new string ToString () { - return InputProcessor.DriverName?.ToLowerInvariant (); + StringBuilder sb = new (); + + Cell [,] contents = Contents!; + + for (var r = 0; r < Rows; r++) + { + for (var c = 0; c < Cols; c++) + { + string text = contents [r, c].Grapheme; + + sb.Append (text); + + if (text.GetColumns () > 1) + { + c++; + } + } + + sb.AppendLine (); + } + + return sb.ToString (); + } + + /// + public string ToAnsi () + { + return _output.ToAnsi (OutputBuffer); } } diff --git a/Terminal.Gui/Drivers/FakeDriver/FakeClipboard.cs b/Terminal.Gui/Drivers/FakeDriver/FakeClipboard.cs index 6951b7923..9a7bc4d57 100644 --- a/Terminal.Gui/Drivers/FakeDriver/FakeClipboard.cs +++ b/Terminal.Gui/Drivers/FakeDriver/FakeClipboard.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/FakeDriver/FakeComponentFactory.cs b/Terminal.Gui/Drivers/FakeDriver/FakeComponentFactory.cs index e7ce72f3d..5f4284bdc 100644 --- a/Terminal.Gui/Drivers/FakeDriver/FakeComponentFactory.cs +++ b/Terminal.Gui/Drivers/FakeDriver/FakeComponentFactory.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Concurrent; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/FakeDriver/FakeInput.cs b/Terminal.Gui/Drivers/FakeDriver/FakeInput.cs index 76093e785..b30d871ce 100644 --- a/Terminal.Gui/Drivers/FakeDriver/FakeInput.cs +++ b/Terminal.Gui/Drivers/FakeDriver/FakeInput.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Concurrent; namespace Terminal.Gui.Drivers; @@ -13,16 +12,25 @@ public class FakeInput : InputImpl, ITestableInput _testInput = new (); + private int _peekCallCount; + + /// + /// Gets the number of times has been called. + /// This is useful for verifying that the input loop throttling is working correctly. + /// + internal int PeekCallCount => _peekCallCount; + /// /// Creates a new FakeInput. /// - public FakeInput () - { } + public FakeInput () { } /// public override bool Peek () { // Will be called on the input thread. + Interlocked.Increment (ref _peekCallCount); + return !_testInput.IsEmpty; } @@ -36,7 +44,7 @@ public class FakeInput : InputImpl, ITestableInput + /// public void AddInput (ConsoleKeyInfo input) { //Logging.Trace ($"Enqueuing input: {input.Key}"); @@ -44,4 +52,4 @@ public class FakeInput : InputImpl, ITestableInput } /// - public override void EnqueueMouseEvent (MouseEventArgs mouseEvent) + public override void EnqueueMouseEvent (IApplication? app, MouseEventArgs mouseEvent) { // FakeDriver uses ConsoleKeyInfo as its input record type, which cannot represent mouse events. + // TODO: Verify this is correct. This didn't check the threadId before. // If Application.Invoke is available (running in Application context), defer to next iteration // to ensure proper timing - the event is raised after views are laid out. // Otherwise (unit tests), raise immediately so tests can verify synchronously. - if (Application.MainThreadId is { }) + if (app is {} && app.MainThreadId != Thread.CurrentThread.ManagedThreadId) { // Application is running - use Invoke to defer to next iteration - Application.Invoke (() => RaiseMouseEvent (mouseEvent)); + app?.Invoke ((_) => RaiseMouseEvent (mouseEvent)); } else { diff --git a/Terminal.Gui/Drivers/FakeDriver/FakeOutput.cs b/Terminal.Gui/Drivers/FakeDriver/FakeOutput.cs index 0722079fe..8fd790f19 100644 --- a/Terminal.Gui/Drivers/FakeDriver/FakeOutput.cs +++ b/Terminal.Gui/Drivers/FakeDriver/FakeOutput.cs @@ -1,4 +1,3 @@ -#nullable enable using System; namespace Terminal.Gui.Drivers; @@ -87,8 +86,29 @@ public class FakeOutput : OutputBase, IOutput /// protected override void AppendOrWriteAttribute (StringBuilder output, Attribute attr, TextStyle redrawTextStyle) { - // For testing, we can skip the actual color/style output - // or capture it if needed for verification + if (Application.Force16Colors) + { + output.Append (EscSeqUtils.CSI_SetForegroundColor (attr.Foreground.GetAnsiColorCode ())); + output.Append (EscSeqUtils.CSI_SetBackgroundColor (attr.Background.GetAnsiColorCode ())); + } + else + { + EscSeqUtils.CSI_AppendForegroundColorRGB ( + output, + attr.Foreground.R, + attr.Foreground.G, + attr.Foreground.B + ); + + EscSeqUtils.CSI_AppendBackgroundColorRGB ( + output, + attr.Background.R, + attr.Background.G, + attr.Background.B + ); + } + + EscSeqUtils.CSI_AppendTextStyleChange (output, redrawTextStyle, attr.Style); } /// diff --git a/Terminal.Gui/Drivers/IComponentFactory.cs b/Terminal.Gui/Drivers/IComponentFactory.cs index 7122c4af3..d58a95f68 100644 --- a/Terminal.Gui/Drivers/IComponentFactory.cs +++ b/Terminal.Gui/Drivers/IComponentFactory.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Collections.Concurrent; +using System.Collections.Concurrent; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/IDriver.cs b/Terminal.Gui/Drivers/IDriver.cs index 32af99b05..8616d8edf 100644 --- a/Terminal.Gui/Drivers/IDriver.cs +++ b/Terminal.Gui/Drivers/IDriver.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; @@ -125,8 +124,8 @@ public interface IDriver /// bool IsRuneSupported (Rune rune); - /// Tests whether the specified coordinate are valid for drawing the specified Rune. - /// Used to determine if one or two columns are required. + /// Tests whether the specified coordinate are valid for drawing the specified Text. + /// Used to determine if one or two columns are required. /// The column. /// The row. /// @@ -134,7 +133,7 @@ public interface IDriver /// . /// otherwise. /// - bool IsValidLocation (Rune rune, int col, int row); + bool IsValidLocation (string text, int col, int row); /// /// Updates and to the specified column and row in @@ -295,4 +294,18 @@ public interface IDriver /// /// public AnsiRequestScheduler GetRequestScheduler (); + + + /// + /// Gets a string representation of . + /// + /// + public string ToString (); + + /// + /// Gets an ANSI escape sequence representation of . This is the + /// same output as would be written to the terminal to recreate the current screen contents. + /// + /// + public string ToAnsi (); } diff --git a/Terminal.Gui/Drivers/IInput.cs b/Terminal.Gui/Drivers/IInput.cs index 0b2ec7d41..c4a0af159 100644 --- a/Terminal.Gui/Drivers/IInput.cs +++ b/Terminal.Gui/Drivers/IInput.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Collections.Concurrent; +using System.Collections.Concurrent; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/IInputProcessor.cs b/Terminal.Gui/Drivers/IInputProcessor.cs index d0c0284b8..b10ab0842 100644 --- a/Terminal.Gui/Drivers/IInputProcessor.cs +++ b/Terminal.Gui/Drivers/IInputProcessor.cs @@ -1,6 +1,4 @@ -#nullable enable - -namespace Terminal.Gui.Drivers; +namespace Terminal.Gui.Drivers; /// /// Interface for main loop class that will process the queued input. @@ -13,7 +11,7 @@ public interface IInputProcessor public event EventHandler? AnsiSequenceSwallowed; /// - /// Gets the name of the driver associated with this input processor. + /// Gets the name of the driver associated with this input processor. /// string? DriverName { get; init; } @@ -59,7 +57,8 @@ public interface IInputProcessor /// Called when a key up event has been dequeued. Raises the event. /// /// - /// Drivers that do not support key release events will call this method after processing + /// Drivers that do not support key release events will call this method after + /// processing /// is complete. /// /// The key event data. @@ -90,7 +89,10 @@ public interface IInputProcessor /// /// Adds a mouse input event to the input queue. For unit tests. /// + /// + /// The application instance to use. Used to use Invoke to raise the mouse + /// event in the case where this method is not called on the main thread. + /// /// - void EnqueueMouseEvent (MouseEventArgs mouseEvent); - + void EnqueueMouseEvent (IApplication? app, MouseEventArgs mouseEvent); } diff --git a/Terminal.Gui/Drivers/IOutput.cs b/Terminal.Gui/Drivers/IOutput.cs index bc04dfaa6..0eb647dec 100644 --- a/Terminal.Gui/Drivers/IOutput.cs +++ b/Terminal.Gui/Drivers/IOutput.cs @@ -53,4 +53,12 @@ public interface IOutput : IDisposable /// /// void Write (IOutputBuffer buffer); + + /// + /// Generates an ANSI escape sequence string representation of the given contents. + /// This is the same output that would be written to the terminal to recreate the current screen contents. + /// + /// The output buffer to convert to ANSI. + /// A string containing ANSI escape sequences representing the buffer contents. + string ToAnsi (IOutputBuffer buffer); } diff --git a/Terminal.Gui/Drivers/IOutputBuffer.cs b/Terminal.Gui/Drivers/IOutputBuffer.cs index 2b8991593..3344d0ba8 100644 --- a/Terminal.Gui/Drivers/IOutputBuffer.cs +++ b/Terminal.Gui/Drivers/IOutputBuffer.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.Drivers; /// @@ -85,15 +84,15 @@ public interface IOutputBuffer void FillRect (Rectangle rect, char rune); /// - /// Tests whether the specified coordinate is valid for drawing the specified Rune. + /// Tests whether the specified coordinate is valid for drawing the specified Text. /// - /// Used to determine if one or two columns are required. + /// Used to determine if one or two columns are required. /// The column. /// The row. /// - /// True if the coordinate is valid for the Rune; false otherwise. + /// True if the coordinate is valid for the Text; false otherwise. /// - bool IsValidLocation (Rune rune, int col, int row); + bool IsValidLocation (string text, int col, int row); /// /// The first cell index on left of screen - basically always 0. diff --git a/Terminal.Gui/Drivers/ISizeMonitor.cs b/Terminal.Gui/Drivers/ISizeMonitor.cs index 602d5e4b8..df8273bfd 100644 --- a/Terminal.Gui/Drivers/ISizeMonitor.cs +++ b/Terminal.Gui/Drivers/ISizeMonitor.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/InputImpl.cs b/Terminal.Gui/Drivers/InputImpl.cs index d340b3d85..5cf573a0f 100644 --- a/Terminal.Gui/Drivers/InputImpl.cs +++ b/Terminal.Gui/Drivers/InputImpl.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Collections.Concurrent; +using System.Collections.Concurrent; namespace Terminal.Gui.Drivers; @@ -19,7 +18,7 @@ public abstract class InputImpl : IInput /// public Func Now { get; set; } = () => DateTime.Now; - /// + /// public CancellationTokenSource? ExternalCancellationTokenSource { get; set; } /// @@ -47,8 +46,6 @@ public abstract class InputImpl : IInput do { - DateTime dt = Now (); - while (Peek ()) { foreach (TInputRecord r in Read ()) @@ -58,6 +55,11 @@ public abstract class InputImpl : IInput } effectiveToken.ThrowIfCancellationRequested (); + + // Throttle the input loop to avoid CPU spinning when no input is available + // This is especially important when multiple ApplicationImpl instances are created + // in parallel tests without calling Shutdown() - prevents thread pool exhaustion + Task.Delay (20, effectiveToken).Wait (effectiveToken); } while (!effectiveToken.IsCancellationRequested); } @@ -65,7 +67,7 @@ public abstract class InputImpl : IInput { } finally { - Logging.Trace($"Stopping input processing"); + Logging.Trace ("Stopping input processing"); linkedCts?.Dispose (); } } @@ -86,4 +88,4 @@ public abstract class InputImpl : IInput /// public virtual void Dispose () { } -} \ No newline at end of file +} diff --git a/Terminal.Gui/Drivers/InputProcessorImpl.cs b/Terminal.Gui/Drivers/InputProcessorImpl.cs index f79a96364..57b74f1f4 100644 --- a/Terminal.Gui/Drivers/InputProcessorImpl.cs +++ b/Terminal.Gui/Drivers/InputProcessorImpl.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Collections.Concurrent; +using System.Collections.Concurrent; using Microsoft.Extensions.Logging; namespace Terminal.Gui.Drivers; @@ -123,7 +122,7 @@ public abstract class InputProcessorImpl : IInputProcessor, IDispo public event EventHandler? MouseEvent; /// - public virtual void EnqueueMouseEvent (MouseEventArgs mouseEvent) + public virtual void EnqueueMouseEvent (IApplication? app, MouseEventArgs mouseEvent) { // Base implementation: For drivers where TInputRecord cannot represent mouse events // (e.g., ConsoleKeyInfo), derived classes should override this method. diff --git a/Terminal.Gui/Drivers/KeyCode.cs b/Terminal.Gui/Drivers/KeyCode.cs index eb87a7e92..431508e5f 100644 --- a/Terminal.Gui/Drivers/KeyCode.cs +++ b/Terminal.Gui/Drivers/KeyCode.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/MouseButtonStateEx.cs b/Terminal.Gui/Drivers/MouseButtonStateEx.cs index e6e2a1e96..1aba69677 100644 --- a/Terminal.Gui/Drivers/MouseButtonStateEx.cs +++ b/Terminal.Gui/Drivers/MouseButtonStateEx.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/MouseInterpreter.cs b/Terminal.Gui/Drivers/MouseInterpreter.cs index cb585ed9f..f5848ab65 100644 --- a/Terminal.Gui/Drivers/MouseInterpreter.cs +++ b/Terminal.Gui/Drivers/MouseInterpreter.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/OutputBase.cs b/Terminal.Gui/Drivers/OutputBase.cs index ac43dc93d..ad1f4120e 100644 --- a/Terminal.Gui/Drivers/OutputBase.cs +++ b/Terminal.Gui/Drivers/OutputBase.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Drivers; /// @@ -32,9 +31,6 @@ public abstract class OutputBase CursorVisibility? savedVisibility = _cachedCursorVisibility; SetCursorVisibility (CursorVisibility.Invisible); - const int MAX_CHARS_PER_RUNE = 2; - Span runeBuffer = stackalloc char [MAX_CHARS_PER_RUNE]; - for (int row = top; row < rows; row++) { if (!SetCursorPositionImpl (0, row)) @@ -75,48 +71,11 @@ public abstract class OutputBase lastCol = col; } - Attribute? attribute = buffer.Contents [row, col].Attribute; - - if (attribute is { }) - { - Attribute attr = attribute.Value; - - // Performance: Only send the escape sequence if the attribute has changed. - if (attr != redrawAttr) - { - redrawAttr = attr; - - AppendOrWriteAttribute (output, attr, _redrawTextStyle); - - _redrawTextStyle = attr.Style; - } - } + Cell cell = buffer.Contents [row, col]; + AppendCellAnsi (cell, output, ref redrawAttr, ref _redrawTextStyle, cols, ref col); outputWidth++; - // Avoid Rune.ToString() by appending the rune chars. - Rune rune = buffer.Contents [row, col].Rune; - int runeCharsWritten = rune.EncodeToUtf16 (runeBuffer); - ReadOnlySpan runeChars = runeBuffer [..runeCharsWritten]; - output.Append (runeChars); - - if (buffer.Contents [row, col].CombiningMarks.Count > 0) - { - // AtlasEngine does not support NON-NORMALIZED combining marks in a way - // compatible with the driver architecture. Any CMs (except in the first col) - // are correctly combined with the base char, but are ALSO treated as 1 column - // width codepoints E.g. `echo "[e`u{0301}`u{0301}]"` will output `[é ]`. - // - // For now, we just ignore the list of CMs. - //foreach (var combMark in Contents [row, col].CombiningMarks) { - // output.Append (combMark); - } - else if (rune.IsSurrogatePair () && rune.GetColumns () < 2) - { - WriteToConsole (output, ref lastCol, row, ref outputWidth); - SetCursorPositionImpl (col - 1, row); - } - buffer.Contents [row, col].IsDirty = false; } } @@ -131,14 +90,16 @@ public abstract class OutputBase } } - foreach (SixelToRender s in Application.Sixel) - { - if (!string.IsNullOrWhiteSpace (s.SixelData)) - { - SetCursorPositionImpl (s.ScreenPosition.X, s.ScreenPosition.Y); - Console.Out.Write (s.SixelData); - } - } + // BUGBUG: The Sixel impl depends on the legacy static Application object + // BUGBUG: Disabled for now + //foreach (SixelToRender s in Application.Sixel) + //{ + // if (!string.IsNullOrWhiteSpace (s.SixelData)) + // { + // SetCursorPositionImpl (s.ScreenPosition.X, s.ScreenPosition.Y); + // Console.Out.Write (s.SixelData); + // } + //} SetCursorVisibility (savedVisibility ?? CursorVisibility.Default); _cachedCursorVisibility = savedVisibility; @@ -170,6 +131,101 @@ public abstract class OutputBase /// protected abstract void Write (StringBuilder output); + /// + /// Builds ANSI escape sequences for the specified rectangular region of the buffer. + /// + /// The output buffer to build ANSI for. + /// The starting row (inclusive). + /// The ending row (exclusive). + /// The starting column (inclusive). + /// The ending column (exclusive). + /// The StringBuilder to append ANSI sequences to. + /// The last attribute used, for optimization. + /// Predicate to determine which cells to include. If null, includes all cells. + /// Whether to add newlines between rows. + protected void BuildAnsiForRegion ( + IOutputBuffer buffer, + int startRow, + int endRow, + int startCol, + int endCol, + StringBuilder output, + ref Attribute? lastAttr, + Func? includeCellPredicate = null, + bool addNewlines = true + ) + { + TextStyle redrawTextStyle = TextStyle.None; + + for (int row = startRow; row < endRow; row++) + { + for (int col = startCol; col < endCol; col++) + { + if (includeCellPredicate != null && !includeCellPredicate (row, col)) + { + continue; + } + + Cell cell = buffer.Contents![row, col]; + AppendCellAnsi (cell, output, ref lastAttr, ref redrawTextStyle, endCol, ref col); + } + + // Add newline at end of row if requested + if (addNewlines) + { + output.AppendLine (); + } + } + } + + /// + /// Appends ANSI sequences for a single cell to the output. + /// + /// The cell to append ANSI for. + /// The StringBuilder to append to. + /// The last attribute used, updated if the cell's attribute is different. + /// The current text style for optimization. + /// The maximum column, used for wide character handling. + /// The current column, updated for wide characters. + protected void AppendCellAnsi (Cell cell, StringBuilder output, ref Attribute? lastAttr, ref TextStyle redrawTextStyle, int maxCol, ref int currentCol) + { + Attribute? attribute = cell.Attribute; + + // Add ANSI escape sequence for attribute change + if (attribute.HasValue && attribute.Value != lastAttr) + { + lastAttr = attribute.Value; + AppendOrWriteAttribute (output, attribute.Value, redrawTextStyle); + redrawTextStyle = attribute.Value.Style; + } + + // Add the grapheme + string grapheme = cell.Grapheme; + output.Append (grapheme); + + // Handle wide grapheme + if (grapheme.GetColumns () > 1 && currentCol + 1 < maxCol) + { + currentCol++; // Skip next cell for wide character + } + } + + /// + /// Generates an ANSI escape sequence string representation of the given contents. + /// This is the same output that would be written to the terminal to recreate the current screen contents. + /// + /// The output buffer to convert to ANSI. + /// A string containing ANSI escape sequences representing the buffer contents. + public string ToAnsi (IOutputBuffer buffer) + { + var output = new StringBuilder (); + Attribute? lastAttr = null; + + BuildAnsiForRegion (buffer, 0, buffer.Rows, 0, buffer.Cols, output, ref lastAttr); + + return output.ToString (); + } + private void WriteToConsole (StringBuilder output, ref int lastCol, int row, ref int outputWidth) { SetCursorPositionImpl (lastCol, row); diff --git a/Terminal.Gui/Drivers/OutputBufferImpl.cs b/Terminal.Gui/Drivers/OutputBufferImpl.cs index ee2493d60..ffe254851 100644 --- a/Terminal.Gui/Drivers/OutputBufferImpl.cs +++ b/Terminal.Gui/Drivers/OutputBufferImpl.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Diagnostics; +using System.Diagnostics; namespace Terminal.Gui.Drivers; @@ -66,7 +65,9 @@ public class OutputBufferImpl : IOutputBuffer /// The topmost row in the terminal. public virtual int Top { get; set; } = 0; - /// + /// + /// Indicates which lines have been modified and need to be redrawn. + /// public bool [] DirtyLines { get; set; } = []; // QUESTION: When non-full screen apps are supported, will this represent the app size, or will that be in Application? @@ -113,178 +114,8 @@ public class OutputBufferImpl : IOutputBuffer /// will be added instead. /// /// - /// Rune to add. - public void AddRune (Rune rune) - { - int runeWidth = -1; - bool validLocation = IsValidLocation (rune, Col, Row); - - if (Contents is null) - { - return; - } - - Clip ??= new (Screen); - - Rectangle clipRect = Clip!.GetBounds (); - - if (validLocation) - { - rune = rune.MakePrintable (); - runeWidth = rune.GetColumns (); - - lock (Contents) - { - if (runeWidth == 0 && rune.IsCombiningMark ()) - { - // AtlasEngine does not support NON-NORMALIZED combining marks in a way - // compatible with the driver architecture. Any CMs (except in the first col) - // are correctly combined with the base char, but are ALSO treated as 1 column - // width codepoints E.g. `echo "[e`u{0301}`u{0301}]"` will output `[é ]`. - // - // Until this is addressed (see Issue #), we do our best by - // a) Attempting to normalize any CM with the base char to it's left - // b) Ignoring any CMs that don't normalize - if (Col > 0) - { - if (Contents [Row, Col - 1].CombiningMarks.Count > 0) - { - // Just add this mark to the list - Contents [Row, Col - 1].AddCombiningMark (rune); - - // Ignore. Don't move to next column (let the driver figure out what to do). - } - else - { - // Attempt to normalize the cell to our left combined with this mark - string combined = Contents [Row, Col - 1].Rune + rune.ToString (); - - // Normalize to Form C (Canonical Composition) - string normalized = combined.Normalize (NormalizationForm.FormC); - - if (normalized.Length == 1) - { - // It normalized! We can just set the Cell to the left with the - // normalized codepoint - Contents [Row, Col - 1].Rune = (Rune)normalized [0]; - - // Ignore. Don't move to next column because we're already there - } - else - { - // It didn't normalize. Add it to the Cell to left's CM list - Contents [Row, Col - 1].AddCombiningMark (rune); - - // Ignore. Don't move to next column (let the driver figure out what to do). - } - } - - Contents [Row, Col - 1].Attribute = CurrentAttribute; - Contents [Row, Col - 1].IsDirty = true; - } - else - { - // Most drivers will render a combining mark at col 0 as the mark - Contents [Row, Col].Rune = rune; - Contents [Row, Col].Attribute = CurrentAttribute; - Contents [Row, Col].IsDirty = true; - Col++; - } - } - else - { - Contents [Row, Col].Attribute = CurrentAttribute; - Contents [Row, Col].IsDirty = true; - - if (Col > 0) - { - // Check if cell to left has a wide glyph - if (Contents [Row, Col - 1].Rune.GetColumns () > 1) - { - // Invalidate cell to left - Contents [Row, Col - 1].Rune = Rune.ReplacementChar; - Contents [Row, Col - 1].IsDirty = true; - } - } - - if (runeWidth < 1) - { - Contents [Row, Col].Rune = Rune.ReplacementChar; - } - else if (runeWidth == 1) - { - Contents [Row, Col].Rune = rune; - - if (Col < clipRect.Right - 1) - { - Contents [Row, Col + 1].IsDirty = true; - } - } - else if (runeWidth == 2) - { - if (!Clip.Contains (Col + 1, Row)) - { - // We're at the right edge of the clip, so we can't display a wide character. - // TODO: Figure out if it is better to show a replacement character or ' ' - Contents [Row, Col].Rune = Rune.ReplacementChar; - } - else if (!Clip.Contains (Col, Row)) - { - // Our 1st column is outside the clip, so we can't display a wide character. - Contents [Row, Col + 1].Rune = Rune.ReplacementChar; - } - else - { - Contents [Row, Col].Rune = rune; - - if (Col < clipRect.Right - 1) - { - // Invalidate cell to right so that it doesn't get drawn - // TODO: Figure out if it is better to show a replacement character or ' ' - Contents [Row, Col + 1].Rune = Rune.ReplacementChar; - Contents [Row, Col + 1].IsDirty = true; - } - } - } - else - { - // This is a non-spacing character, so we don't need to do anything - Contents [Row, Col].Rune = (Rune)' '; - Contents [Row, Col].IsDirty = false; - } - - DirtyLines [Row] = true; - } - } - } - - if (runeWidth is < 0 or > 0) - { - Col++; - } - - if (runeWidth > 1) - { - Debug.Assert (runeWidth <= 2); - - if (validLocation && Col < clipRect.Right) - { - lock (Contents!) - { - // This is a double-width character, and we are not at the end of the line. - // Col now points to the second column of the character. Ensure it doesn't - // Get rendered. - Contents [Row, Col].IsDirty = false; - Contents [Row, Col].Attribute = CurrentAttribute; - - // TODO: Determine if we should wipe this out (for now now) - //Contents [Row, Col].Rune = (Rune)' '; - } - } - - Col++; - } - } + /// Text to add. + public void AddRune (Rune rune) { AddStr (rune.ToString ()); } /// /// Adds the specified to the display at the current cursor position. This method is a @@ -297,7 +128,7 @@ public class OutputBufferImpl : IOutputBuffer /// /// /// When the method returns, will be incremented by the number of columns - /// required, unless the new column value is outside of the or screen + /// required, unless the new column value is outside the or screen /// dimensions defined by . /// /// If requires more columns than are available, the output will be clipped. @@ -305,11 +136,117 @@ public class OutputBufferImpl : IOutputBuffer /// String. public void AddStr (string str) { - List runes = str.EnumerateRunes ().ToList (); - - for (var i = 0; i < runes.Count; i++) + foreach (string grapheme in GraphemeHelper.GetGraphemes (str)) { - AddRune (runes [i]); + string text = grapheme; + + if (Contents is null) + { + return; + } + + Clip ??= new (Screen); + + Rectangle clipRect = Clip!.GetBounds (); + + int textWidth = -1; + bool validLocation = false; + + lock (Contents) + { + // Validate location inside the lock to prevent race conditions + validLocation = IsValidLocation (text, Col, Row); + + if (validLocation) + { + text = text.MakePrintable (); + textWidth = text.GetColumns (); + + Contents [Row, Col].Attribute = CurrentAttribute; + Contents [Row, Col].IsDirty = true; + + if (Col > 0) + { + // Check if cell to left has a wide glyph + if (Contents [Row, Col - 1].Grapheme.GetColumns () > 1) + { + // Invalidate cell to left + Contents [Row, Col - 1].Grapheme = Rune.ReplacementChar.ToString (); + Contents [Row, Col - 1].IsDirty = true; + } + } + + if (textWidth is 0 or 1) + { + Contents [Row, Col].Grapheme = text; + + if (Col < clipRect.Right - 1 && Col + 1 < Cols) + { + Contents [Row, Col + 1].IsDirty = true; + } + } + else if (textWidth == 2) + { + if (!Clip.Contains (Col + 1, Row)) + { + // We're at the right edge of the clip, so we can't display a wide character. + Contents [Row, Col].Grapheme = Rune.ReplacementChar.ToString (); + } + else if (!Clip.Contains (Col, Row)) + { + // Our 1st column is outside the clip, so we can't display a wide character. + if (Col + 1 < Cols) + { + Contents [Row, Col + 1].Grapheme = Rune.ReplacementChar.ToString (); + } + } + else + { + Contents [Row, Col].Grapheme = text; + + if (Col < clipRect.Right - 1 && Col + 1 < Cols) + { + // Invalidate cell to right so that it doesn't get drawn + Contents [Row, Col + 1].Grapheme = Rune.ReplacementChar.ToString (); + Contents [Row, Col + 1].IsDirty = true; + } + } + } + else + { + // This is a non-spacing character, so we don't need to do anything + Contents [Row, Col].Grapheme = " "; + Contents [Row, Col].IsDirty = false; + } + + DirtyLines [Row] = true; + } + } + + Col++; + + if (textWidth > 1) + { + Debug.Assert (textWidth <= 2); + + if (validLocation) + { + lock (Contents!) + { + // Re-validate Col is still in bounds after increment + if (Col < Cols && Row < Rows && Col < clipRect.Right) + { + // This is a double-width character, and we are not at the end of the line. + // Col now points to the second column of the character. Ensure it doesn't + // Get rendered. + Contents [Row, Col].IsDirty = false; + Contents [Row, Col].Attribute = CurrentAttribute; + } + } + } + + Col++; + } } } @@ -332,7 +269,7 @@ public class OutputBufferImpl : IOutputBuffer { Contents [row, c] = new () { - Rune = (Rune)' ', + Grapheme = " ", Attribute = new Attribute (Color.White, Color.Black), IsDirty = true }; @@ -346,22 +283,19 @@ public class OutputBufferImpl : IOutputBuffer //ClearedContents?.Invoke (this, EventArgs.Empty); } - /// Tests whether the specified coordinate are valid for drawing the specified Rune. - /// Used to determine if one or two columns are required. + /// Tests whether the specified coordinate are valid for drawing the specified Text. + /// Used to determine if one or two columns are required. /// The column. /// The row. /// /// if the coordinate is outside the screen bounds or outside of . /// otherwise. /// - public bool IsValidLocation (Rune rune, int col, int row) + public bool IsValidLocation (string text, int col, int row) { - if (rune.GetColumns () < 2) - { - return col >= 0 && row >= 0 && col < Cols && row < Rows && Clip!.Contains (col, row); - } + int textWidth = text.GetColumns (); - return Clip!.Contains (col, row) || Clip!.Contains (col + 1, row); + return col >= 0 && row >= 0 && col + textWidth <= Cols && row < Rows && Clip!.Contains (col, row); } /// @@ -384,14 +318,14 @@ public class OutputBufferImpl : IOutputBuffer { for (int c = rect.X; c < rect.X + rect.Width; c++) { - if (!IsValidLocation (rune, c, r)) + if (!IsValidLocation (rune.ToString (), c, r)) { continue; } Contents [r, c] = new () { - Rune = rune != default (Rune) ? rune : (Rune)' ', + Grapheme = rune != default (Rune) ? rune.ToString () : " ", Attribute = CurrentAttribute, IsDirty = true }; } diff --git a/Terminal.Gui/Drivers/Platform.cs b/Terminal.Gui/Drivers/Platform.cs index 4b14ba053..4b7b20a18 100644 --- a/Terminal.Gui/Drivers/Platform.cs +++ b/Terminal.Gui/Drivers/Platform.cs @@ -80,4 +80,4 @@ internal static class Platform [DllImport ("libc")] private static extern int uname (nint buf); -} \ No newline at end of file +} diff --git a/Terminal.Gui/Drivers/SizeMonitorImpl.cs b/Terminal.Gui/Drivers/SizeMonitorImpl.cs index 409f27617..f41b50d7e 100644 --- a/Terminal.Gui/Drivers/SizeMonitorImpl.cs +++ b/Terminal.Gui/Drivers/SizeMonitorImpl.cs @@ -1,5 +1,4 @@ -#nullable enable -using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Logging; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/UnixDriver/UnixClipboard.cs b/Terminal.Gui/Drivers/UnixDriver/UnixClipboard.cs index c562ee66d..6562f3b2d 100644 --- a/Terminal.Gui/Drivers/UnixDriver/UnixClipboard.cs +++ b/Terminal.Gui/Drivers/UnixDriver/UnixClipboard.cs @@ -1,3 +1,4 @@ +#nullable disable using System.Runtime.InteropServices; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/UnixDriver/UnixComponentFactory.cs b/Terminal.Gui/Drivers/UnixDriver/UnixComponentFactory.cs index f53b88f85..5067832d7 100644 --- a/Terminal.Gui/Drivers/UnixDriver/UnixComponentFactory.cs +++ b/Terminal.Gui/Drivers/UnixDriver/UnixComponentFactory.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Concurrent; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/UnixDriver/UnixInput.cs b/Terminal.Gui/Drivers/UnixDriver/UnixInput.cs index 0337e0aff..60807d5c4 100644 --- a/Terminal.Gui/Drivers/UnixDriver/UnixInput.cs +++ b/Terminal.Gui/Drivers/UnixDriver/UnixInput.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Runtime.InteropServices; // ReSharper disable IdentifierTypo diff --git a/Terminal.Gui/Drivers/UnixDriver/UnixKeyConverter.cs b/Terminal.Gui/Drivers/UnixDriver/UnixKeyConverter.cs index 62c05a0ed..22f95d4d3 100644 --- a/Terminal.Gui/Drivers/UnixDriver/UnixKeyConverter.cs +++ b/Terminal.Gui/Drivers/UnixDriver/UnixKeyConverter.cs @@ -1,5 +1,3 @@ -#nullable enable - namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/UnixDriver/UnixOutput.cs b/Terminal.Gui/Drivers/UnixDriver/UnixOutput.cs index 17dbe2bb4..dfbf63ead 100644 --- a/Terminal.Gui/Drivers/UnixDriver/UnixOutput.cs +++ b/Terminal.Gui/Drivers/UnixDriver/UnixOutput.cs @@ -1,4 +1,4 @@ -#nullable enable + using System.Runtime.InteropServices; using Microsoft.Win32.SafeHandles; diff --git a/Terminal.Gui/Drivers/WindowsDriver/ClipboardImpl.cs b/Terminal.Gui/Drivers/WindowsDriver/ClipboardImpl.cs index 6dc708110..cab68fc74 100644 --- a/Terminal.Gui/Drivers/WindowsDriver/ClipboardImpl.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/ClipboardImpl.cs @@ -1,4 +1,3 @@ -#nullable enable using System.ComponentModel; using System.Runtime.InteropServices; diff --git a/Terminal.Gui/Drivers/WindowsDriver/WindowsComponentFactory.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsComponentFactory.cs index 1f16fd66a..4c361b00d 100644 --- a/Terminal.Gui/Drivers/WindowsDriver/WindowsComponentFactory.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsComponentFactory.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Concurrent; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/WindowsDriver/WindowsConsole.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsConsole.cs index 744c32588..fa191262e 100644 --- a/Terminal.Gui/Drivers/WindowsDriver/WindowsConsole.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsConsole.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Runtime.InteropServices; // ReSharper disable InconsistentNaming diff --git a/Terminal.Gui/Drivers/WindowsDriver/WindowsInput.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsInput.cs index 026e1f61b..dc3c98205 100644 --- a/Terminal.Gui/Drivers/WindowsDriver/WindowsInput.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsInput.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Runtime.InteropServices; using Microsoft.Extensions.Logging; using static Terminal.Gui.Drivers.WindowsConsole; diff --git a/Terminal.Gui/Drivers/WindowsDriver/WindowsInputProcessor.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsInputProcessor.cs index 028eb4dc1..3777a034a 100644 --- a/Terminal.Gui/Drivers/WindowsDriver/WindowsInputProcessor.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsInputProcessor.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.Concurrent; namespace Terminal.Gui.Drivers; @@ -19,7 +18,7 @@ internal class WindowsInputProcessor : InputProcessorImpl } /// - public override void EnqueueMouseEvent (MouseEventArgs mouseEvent) + public override void EnqueueMouseEvent (IApplication? app, MouseEventArgs mouseEvent) { InputQueue.Enqueue (new () { diff --git a/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyConverter.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyConverter.cs index 4458ad6ff..0a8f2427f 100644 --- a/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyConverter.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyConverter.cs @@ -1,5 +1,3 @@ -#nullable enable - namespace Terminal.Gui.Drivers; /// diff --git a/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyHelper.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyHelper.cs index 56193db21..cd424136e 100644 --- a/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyHelper.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyHelper.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; // ReSharper disable InconsistentNaming diff --git a/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyboardLayout.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyboardLayout.cs index e368dfa8d..38fc85bfe 100644 --- a/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyboardLayout.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsKeyboardLayout.cs @@ -1,3 +1,4 @@ +#nullable disable using System.Runtime.InteropServices; namespace Terminal.Gui.Drivers; diff --git a/Terminal.Gui/Drivers/WindowsDriver/WindowsOutput.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsOutput.cs index a0bea436c..b351696a2 100644 --- a/Terminal.Gui/Drivers/WindowsDriver/WindowsOutput.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsOutput.cs @@ -1,4 +1,3 @@ -#nullable enable using System.ComponentModel; using System.Runtime.InteropServices; using Microsoft.Extensions.Logging; @@ -148,7 +147,9 @@ internal partial class WindowsOutput : OutputBase, IOutput } // Force 16 colors if not in virtual terminal mode. - Application.Force16Colors = true; + // BUGBUG: This is bad. It does not work if the app was crated without + // BUGBUG: Apis. + //ApplicationImpl.Instance.Force16Colors = true; } @@ -263,7 +264,10 @@ internal partial class WindowsOutput : OutputBase, IOutput public override void Write (IOutputBuffer outputBuffer) { - _force16Colors = Application.Driver!.Force16Colors; + // BUGBUG: This is bad. It does not work if the app was crated without + // BUGBUG: Apis. + //_force16Colors = ApplicationImpl.Instance.Driver!.Force16Colors; + _force16Colors = false; _everythingStringBuilder.Clear (); // for 16 color mode we will write to a backing buffer then flip it to the active one at the end to avoid jitter. @@ -303,6 +307,12 @@ internal partial class WindowsOutput : OutputBase, IOutput { int err = Marshal.GetLastWin32Error (); + if (err == 1) + { + Logging.Logger.LogError ($"Error: {Marshal.GetLastWin32Error ()} in {nameof (WindowsOutput)}"); + + return; + } if (err != 0) { throw new Win32Exception (err); @@ -345,7 +355,10 @@ internal partial class WindowsOutput : OutputBase, IOutput /// protected override void AppendOrWriteAttribute (StringBuilder output, Attribute attr, TextStyle redrawTextStyle) { - bool force16Colors = Application.Force16Colors; + // BUGBUG: This is bad. It does not work if the app was crated without + // BUGBUG: Apis. + // bool force16Colors = ApplicationImpl.Instance.Force16Colors; + bool force16Colors = false; if (force16Colors) { diff --git a/Terminal.Gui/FileServices/DefaultSearchMatcher.cs b/Terminal.Gui/FileServices/DefaultSearchMatcher.cs index 3c10e2a1c..3d9ce8046 100644 --- a/Terminal.Gui/FileServices/DefaultSearchMatcher.cs +++ b/Terminal.Gui/FileServices/DefaultSearchMatcher.cs @@ -4,8 +4,8 @@ namespace Terminal.Gui.FileServices; internal class DefaultSearchMatcher : ISearchMatcher { - private string [] terms; - public void Initialize (string terms) { this.terms = terms.Split (new [] { " " }, StringSplitOptions.RemoveEmptyEntries); } + private string []? _terms; + public void Initialize (string terms) { _terms = terms.Split ([" "], StringSplitOptions.RemoveEmptyEntries); } public bool IsMatch (IFileSystemInfo f) { @@ -15,10 +15,10 @@ internal class DefaultSearchMatcher : ISearchMatcher return // At least one term must match the file name only e.g. "my" in "myfile.csv" - terms.Any (t => f.Name.IndexOf (t, StringComparison.OrdinalIgnoreCase) >= 0) + _terms!.Any (t => f.Name.IndexOf (t, StringComparison.OrdinalIgnoreCase) >= 0) && // All terms must exist in full path e.g. "dos my" can match "c:\documents\myfile.csv" - terms.All (t => f.FullName.IndexOf (t, StringComparison.OrdinalIgnoreCase) >= 0); + _terms!.All (t => f.FullName.IndexOf (t, StringComparison.OrdinalIgnoreCase) >= 0); } } diff --git a/Terminal.Gui/FileServices/FileSystemIconProvider.cs b/Terminal.Gui/FileServices/FileSystemIconProvider.cs index 607582576..de76d91c6 100644 --- a/Terminal.Gui/FileServices/FileSystemIconProvider.cs +++ b/Terminal.Gui/FileServices/FileSystemIconProvider.cs @@ -1,4 +1,3 @@ -#nullable enable using System.IO.Abstractions; namespace Terminal.Gui.FileServices; diff --git a/Terminal.Gui/FileServices/FileSystemInfoStats.cs b/Terminal.Gui/FileServices/FileSystemInfoStats.cs index 72f8ded2d..5444aa26f 100644 --- a/Terminal.Gui/FileServices/FileSystemInfoStats.cs +++ b/Terminal.Gui/FileServices/FileSystemInfoStats.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Globalization; +using System.Globalization; using System.IO.Abstractions; namespace Terminal.Gui.FileServices; diff --git a/Terminal.Gui/FileServices/FileSystemTreeBuilder.cs b/Terminal.Gui/FileServices/FileSystemTreeBuilder.cs index 87aba39af..a44ddd049 100644 --- a/Terminal.Gui/FileServices/FileSystemTreeBuilder.cs +++ b/Terminal.Gui/FileServices/FileSystemTreeBuilder.cs @@ -1,4 +1,5 @@ -using System.IO.Abstractions; +#nullable disable +using System.IO.Abstractions; namespace Terminal.Gui.FileServices; diff --git a/Terminal.Gui/FileServices/IFileOperations.cs b/Terminal.Gui/FileServices/IFileOperations.cs index 610d097be..920f3e947 100644 --- a/Terminal.Gui/FileServices/IFileOperations.cs +++ b/Terminal.Gui/FileServices/IFileOperations.cs @@ -9,28 +9,31 @@ namespace Terminal.Gui.FileServices; public interface IFileOperations { /// Specifies how to handle file/directory deletion attempts in . + /// /// /// if operation was completed or if cancelled /// /// Ensure you use a try/catch block with appropriate error handling (e.g. showing a /// - bool Delete (IEnumerable toDelete); + bool Delete (IApplication? app, IEnumerable toDelete); /// Specifies how to handle 'new directory' operation in . + /// /// /// The parent directory in which the new directory should be created /// The newly created directory or null if cancelled. /// /// Ensure you use a try/catch block with appropriate error handling (e.g. showing a /// - IFileSystemInfo New (IFileSystem fileSystem, IDirectoryInfo inDirectory); + IFileSystemInfo New (IApplication? app, IFileSystem fileSystem, IDirectoryInfo inDirectory); /// Specifies how to handle file/directory rename attempts in . + /// /// /// /// The new name for the file or null if cancelled /// /// Ensure you use a try/catch block with appropriate error handling (e.g. showing a /// - IFileSystemInfo Rename (IFileSystem fileSystem, IFileSystemInfo toRename); + IFileSystemInfo Rename (IApplication? app, IFileSystem fileSystem, IFileSystemInfo toRename); } diff --git a/Terminal.Gui/Input/Command.cs b/Terminal.Gui/Input/Command.cs index 88d99e639..4d1b6d008 100644 --- a/Terminal.Gui/Input/Command.cs +++ b/Terminal.Gui/Input/Command.cs @@ -336,4 +336,4 @@ public enum Command Edit, #endregion -} \ No newline at end of file +} diff --git a/Terminal.Gui/Input/CommandContext.cs b/Terminal.Gui/Input/CommandContext.cs index fe6c9c194..dd6c529ba 100644 --- a/Terminal.Gui/Input/CommandContext.cs +++ b/Terminal.Gui/Input/CommandContext.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.Input; #pragma warning disable CS1574, CS0419 // XML comment has cref attribute that could not be resolved @@ -33,4 +32,4 @@ public record struct CommandContext : ICommandContext /// The keyboard or mouse minding that was used to invoke the , if any. /// public TBinding? Binding { get; set; } -} \ No newline at end of file +} diff --git a/Terminal.Gui/Input/CommandEventArgs.cs b/Terminal.Gui/Input/CommandEventArgs.cs index 05d662437..659d0db64 100644 --- a/Terminal.Gui/Input/CommandEventArgs.cs +++ b/Terminal.Gui/Input/CommandEventArgs.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.ComponentModel; +using System.ComponentModel; namespace Terminal.Gui.Input; diff --git a/Terminal.Gui/Input/ICommandContext.cs b/Terminal.Gui/Input/ICommandContext.cs index a9d4e641c..c4e57de22 100644 --- a/Terminal.Gui/Input/ICommandContext.cs +++ b/Terminal.Gui/Input/ICommandContext.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.Input; #pragma warning disable CS1574 // XML comment has cref attribute that could not be resolved diff --git a/Terminal.Gui/Input/IInputBinding.cs b/Terminal.Gui/Input/IInputBinding.cs index f0ae3a25a..34170c73c 100644 --- a/Terminal.Gui/Input/IInputBinding.cs +++ b/Terminal.Gui/Input/IInputBinding.cs @@ -1,5 +1,4 @@ -#nullable enable -namespace Terminal.Gui.Input; +namespace Terminal.Gui.Input; /// /// Describes an input binding. Used to bind a set of objects to a specific input event. diff --git a/Terminal.Gui/Input/InputBindings.cs b/Terminal.Gui/Input/InputBindings.cs index 75a4711e5..75e2e8aea 100644 --- a/Terminal.Gui/Input/InputBindings.cs +++ b/Terminal.Gui/Input/InputBindings.cs @@ -1,20 +1,15 @@ -#nullable enable +using System.Collections.Concurrent; + namespace Terminal.Gui.Input; /// /// Abstract class for and . +/// This class is thread-safe for all public operations. /// /// The type of the event (e.g. or ). /// The binding type (e.g. ). -public abstract class InputBindings where TBinding : IInputBinding, new () where TEvent : notnull +public abstract class InputBindings where TBinding : IInputBinding, new() where TEvent : notnull { - /// - /// The bindings. - /// - private readonly Dictionary _bindings; - - private readonly Func _constructBinding; - /// /// Initializes a new instance. /// @@ -27,11 +22,11 @@ public abstract class InputBindings where TBinding : IInputBin } /// - /// Tests whether is valid or not. + /// The bindings. /// - /// - /// - public abstract bool IsValid (TEvent eventArgs); + private readonly ConcurrentDictionary _bindings; + + private readonly Func _constructBinding; /// Adds a bound to to the collection. /// @@ -43,24 +38,21 @@ public abstract class InputBindings where TBinding : IInputBin throw new ArgumentException (@"Invalid newEventArgs", nameof (eventArgs)); } -#pragma warning disable CS8601 // Possible null reference assignment. - if (TryGet (eventArgs, out TBinding _)) + // IMPORTANT: Add a COPY of the eventArgs. This is needed because ConfigurationManager.Apply uses DeepMemberWiseCopy + // IMPORTANT: update the memory referenced by the key, and Dictionary uses caching for performance, and thus + // IMPORTANT: Apply will update the Dictionary with the new eventArgs, but the old eventArgs will still be in the dictionary. + // IMPORTANT: See the ConfigurationManager.Illustrate_DeepMemberWiseCopy_Breaks_Dictionary test for details. + if (!_bindings.TryAdd (eventArgs, binding)) { throw new InvalidOperationException (@$"A binding for {eventArgs} exists ({binding})."); } -#pragma warning restore CS8601 // Possible null reference assignment. - - // IMPORTANT: Add a COPY of the eventArgs. This is needed because ConfigurationManager.Apply uses DeepMemberWiseCopy - // IMPORTANT: update the memory referenced by the key, and Dictionary uses caching for performance, and thus - // IMPORTANT: Apply will update the Dictionary with the new eventArgs, but the old eventArgs will still be in the dictionary. - // IMPORTANT: See the ConfigurationManager.Illustrate_DeepMemberWiseCopy_Breaks_Dictionary test for details. - _bindings.Add (eventArgs, binding); } /// /// Adds a new that will trigger the commands in . /// - /// If the is already bound to a different set of s it will be rebound + /// If the is already bound to a different set of s it will be + /// rebound /// . /// /// @@ -78,31 +70,32 @@ public abstract class InputBindings where TBinding : IInputBin throw new ArgumentException (@"At least one command must be specified", nameof (commands)); } - if (TryGet (eventArgs, out TBinding? binding)) + if (!IsValid (eventArgs)) + { + throw new ArgumentException (@"Invalid newEventArgs", nameof (eventArgs)); + } + + TBinding binding = _constructBinding (commands, eventArgs); + + if (!_bindings.TryAdd (eventArgs, binding)) { throw new InvalidOperationException (@$"A binding for {eventArgs} exists ({binding})."); } - - Add (eventArgs, _constructBinding (commands, eventArgs)); } - /// - /// Gets the bindings. - /// - /// - public IEnumerable> GetBindings () { return _bindings; } - /// Removes all objects from the collection. public void Clear () { _bindings.Clear (); } /// - /// Removes all bindings that trigger the given command set. Views can have multiple different + /// Removes all bindings that trigger the given command set. Views can have multiple different + /// /// bound to /// the same command sets and this method will clear all of them. /// /// public void Clear (params Command [] command) { + // ToArray() creates a snapshot to avoid modification during enumeration KeyValuePair [] kvps = _bindings .Where (kvp => kvp.Value.Commands.SequenceEqual (command)) .ToArray (); @@ -126,16 +119,29 @@ public abstract class InputBindings where TBinding : IInputBin throw new InvalidOperationException ($"{eventArgs} is not bound."); } - /// Gets the commands bound with the specified . - /// - /// The to check. - /// - /// When this method returns, contains the commands bound with the , if the is - /// not - /// found; otherwise, null. This parameter is passed uninitialized. - /// - /// if the is bound; otherwise . - public bool TryGet (TEvent eventArgs, out TBinding? binding) { return _bindings.TryGetValue (eventArgs, out binding); } + /// Gets all bound to the set of commands specified by . + /// The set of commands to search. + /// + /// The s bound to the set of commands specified by . An empty + /// list if + /// the + /// set of commands was not found. + /// + public IEnumerable GetAllFromCommands (params Command [] commands) + { + // ToList() creates a snapshot to ensure thread-safe enumeration + return _bindings.Where (a => a.Value.Commands.SequenceEqual (commands)).Select (a => a.Key).ToList (); + } + + /// + /// Gets the bindings. + /// + /// + public IEnumerable> GetBindings () + { + // ConcurrentDictionary provides a snapshot enumeration that is safe for concurrent access + return _bindings; + } /// Gets the array of s bound to if it exists. /// The to check. @@ -164,17 +170,16 @@ public abstract class InputBindings where TBinding : IInputBin /// public TEvent? GetFirstFromCommands (params Command [] commands) { return _bindings.FirstOrDefault (a => a.Value.Commands.SequenceEqual (commands)).Key; } - /// Gets all bound to the set of commands specified by . - /// The set of commands to search. - /// - /// The s bound to the set of commands specified by . An empty list if - /// the - /// set of commands was not found. - /// - public IEnumerable GetAllFromCommands (params Command [] commands) - { - return _bindings.Where (a => a.Value.Commands.SequenceEqual (commands)).Select (a => a.Key); - } + /// + /// Tests whether is valid or not. + /// + /// + /// + public abstract bool IsValid (TEvent eventArgs); + + /// Removes a from the collection. + /// + public void Remove (TEvent eventArgs) { _bindings.TryRemove (eventArgs, out _); } /// Replaces a combination already bound to a set of s. /// @@ -189,15 +194,28 @@ public abstract class InputBindings where TBinding : IInputBin throw new ArgumentException (@"Invalid newEventArgs", nameof (newEventArgs)); } - if (TryGet (oldEventArgs, out TBinding? binding)) + // Thread-safe: Handle the case where oldEventArgs == newEventArgs + if (EqualityComparer.Default.Equals (oldEventArgs, newEventArgs)) { - Remove (oldEventArgs); - Add (newEventArgs, binding!); - } - else - { - Add (newEventArgs, binding!); + // Same key - nothing to do, binding stays as-is + return; } + + // Thread-safe: Get the binding from oldEventArgs, or create default if it doesn't exist + // This is atomic - either gets existing or adds new + TBinding binding = _bindings.GetOrAdd (oldEventArgs, _ => new TBinding ()); + + // Thread-safe: Atomically add/update newEventArgs with the binding from oldEventArgs + // The updateValueFactory is only called if the key already exists, ensuring we don't + // accidentally overwrite a binding that was added by another thread + _bindings.AddOrUpdate ( + newEventArgs, + binding, // Add this binding if newEventArgs doesn't exist + (_, _) => binding); + + // Thread-safe: Remove oldEventArgs only after newEventArgs has been set + // This ensures we don't lose the binding if another thread is reading it + _bindings.TryRemove (oldEventArgs, out _); } /// Replaces the commands already bound to a combination of . @@ -210,28 +228,21 @@ public abstract class InputBindings where TBinding : IInputBin /// The set of commands to replace the old ones with. public void ReplaceCommands (TEvent eventArgs, params Command [] newCommands) { -#pragma warning disable CS8601 // Possible null reference assignment. - if (TryGet (eventArgs, out TBinding _)) - { - Remove (eventArgs); - Add (eventArgs, newCommands); - } - else - { - Add (eventArgs, newCommands); - } -#pragma warning restore CS8601 // Possible null reference assignment. + TBinding newBinding = _constructBinding (newCommands, eventArgs); + + // Thread-safe: Add or update atomically + _bindings.AddOrUpdate (eventArgs, newBinding, (_, _) => newBinding); } - /// Removes a from the collection. - /// - public void Remove (TEvent eventArgs) - { - if (!TryGet (eventArgs, out _)) - { - return; - } - - _bindings.Remove (eventArgs); - } + /// Gets the commands bound with the specified . + /// + /// The to check. + /// + /// When this method returns, contains the commands bound with the , if the + /// is + /// not + /// found; otherwise, null. This parameter is passed uninitialized. + /// + /// if the is bound; otherwise . + public bool TryGet (TEvent eventArgs, out TBinding? binding) { return _bindings.TryGetValue (eventArgs, out binding); } } diff --git a/Terminal.Gui/Input/Keyboard/Key.cs b/Terminal.Gui/Input/Keyboard/Key.cs index cd9924047..7a60b6cb3 100644 --- a/Terminal.Gui/Input/Keyboard/Key.cs +++ b/Terminal.Gui/Input/Keyboard/Key.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics.CodeAnalysis; using System.Globalization; diff --git a/Terminal.Gui/Input/Keyboard/KeyBinding.cs b/Terminal.Gui/Input/Keyboard/KeyBinding.cs index b55a66842..6d97a6b6e 100644 --- a/Terminal.Gui/Input/Keyboard/KeyBinding.cs +++ b/Terminal.Gui/Input/Keyboard/KeyBinding.cs @@ -1,4 +1,4 @@ -#nullable enable + // These classes use a key binding system based on the design implemented in Scintilla.Net which is an diff --git a/Terminal.Gui/Input/Keyboard/KeyBindings.cs b/Terminal.Gui/Input/Keyboard/KeyBindings.cs index c4a2952eb..46a7081de 100644 --- a/Terminal.Gui/Input/Keyboard/KeyBindings.cs +++ b/Terminal.Gui/Input/Keyboard/KeyBindings.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.Input; diff --git a/Terminal.Gui/Input/Keyboard/KeyEqualityComparer.cs b/Terminal.Gui/Input/Keyboard/KeyEqualityComparer.cs index 287dd9cfa..25841107d 100644 --- a/Terminal.Gui/Input/Keyboard/KeyEqualityComparer.cs +++ b/Terminal.Gui/Input/Keyboard/KeyEqualityComparer.cs @@ -1,4 +1,3 @@ -#nullable enable /// /// diff --git a/Terminal.Gui/Input/Mouse/GrabMouseEventArgs.cs b/Terminal.Gui/Input/Mouse/GrabMouseEventArgs.cs index c05fd7471..fd3ae5654 100644 --- a/Terminal.Gui/Input/Mouse/GrabMouseEventArgs.cs +++ b/Terminal.Gui/Input/Mouse/GrabMouseEventArgs.cs @@ -1,4 +1,3 @@ - namespace Terminal.Gui.Input; /// Args GrabMouse related events. diff --git a/Terminal.Gui/Input/Mouse/MouseBinding.cs b/Terminal.Gui/Input/Mouse/MouseBinding.cs index 1c6ebf386..40f32ea8f 100644 --- a/Terminal.Gui/Input/Mouse/MouseBinding.cs +++ b/Terminal.Gui/Input/Mouse/MouseBinding.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.Input; diff --git a/Terminal.Gui/Input/Mouse/MouseBindings.cs b/Terminal.Gui/Input/Mouse/MouseBindings.cs index 55d0bf61d..255be246b 100644 --- a/Terminal.Gui/Input/Mouse/MouseBindings.cs +++ b/Terminal.Gui/Input/Mouse/MouseBindings.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.Input; /// diff --git a/Terminal.Gui/Input/Mouse/MouseEventArgs.cs b/Terminal.Gui/Input/Mouse/MouseEventArgs.cs index db0008ef3..3e10c68a4 100644 --- a/Terminal.Gui/Input/Mouse/MouseEventArgs.cs +++ b/Terminal.Gui/Input/Mouse/MouseEventArgs.cs @@ -1,4 +1,4 @@ -#nullable enable + using System.ComponentModel; namespace Terminal.Gui.Input; diff --git a/Terminal.Gui/Resources/GlobalResources.cs b/Terminal.Gui/Resources/GlobalResources.cs index 8a9ac5a0c..4c05e3415 100644 --- a/Terminal.Gui/Resources/GlobalResources.cs +++ b/Terminal.Gui/Resources/GlobalResources.cs @@ -1,5 +1,4 @@ -#nullable enable - + using System.Collections; using System.Globalization; using System.Resources; diff --git a/Terminal.Gui/Resources/ResourceManagerWrapper.cs b/Terminal.Gui/Resources/ResourceManagerWrapper.cs index 8bcc9271f..dc3651454 100644 --- a/Terminal.Gui/Resources/ResourceManagerWrapper.cs +++ b/Terminal.Gui/Resources/ResourceManagerWrapper.cs @@ -1,5 +1,4 @@ -#nullable enable - + using System.Collections; using System.Globalization; using System.Resources; diff --git a/Terminal.Gui/Resources/config.json b/Terminal.Gui/Resources/config.json index 20b206e38..141429fbb 100644 --- a/Terminal.Gui/Resources/config.json +++ b/Terminal.Gui/Resources/config.json @@ -50,7 +50,7 @@ "TurboPascal 5": { "Schemes": [ { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "White", "Background": "Blue" @@ -123,7 +123,7 @@ "Anders": { "Schemes": [ { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "WhiteSmoke", "Background": "DimGray" @@ -185,7 +185,7 @@ "Button.DefaultShadow": "Opaque", "Schemes": [ { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "LightGray", "Background": "Black", @@ -469,7 +469,7 @@ "Button.DefaultShadow": "Opaque", "Schemes": [ { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "DimGray", "Background": "WhiteSmoke", @@ -748,10 +748,10 @@ "Window.DefaultBorderStyle": "Single", "MessageBox.DefaultBorderStyle": "Single", "Button.DefaultShadow": "None", - "Menuv2.DefaultBorderStyle": "Single", + "Menu.DefaultBorderStyle": "Single", "Schemes": [ { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "GreenPhosphor", "Background": "Black", @@ -885,10 +885,10 @@ "Window.DefaultBorderStyle": "Single", "MessageBox.DefaultBorderStyle": "Single", "Button.DefaultShadow": "None", - "Menuv2.DefaultBorderStyle": "Single", + "Menu.DefaultBorderStyle": "Single", "Schemes": [ { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "AmberPhosphor", "Background": "Black", @@ -1022,7 +1022,7 @@ "Window.DefaultBorderStyle": "Single", "MessageBox.DefaultBorderStyle": "Single", "Button.DefaultShadow": "None", - "Menuv2.DefaultBorderStyle": "None", + "Menu.DefaultBorderStyle": "None", "Glyphs.LeftBracket": "[", "Glyphs.RightBracket": "]", "Glyphs.CheckStateChecked": "X", @@ -1162,7 +1162,7 @@ "Glyphs.ShadowHorizontalEnd": "-", "Schemes": [ { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "White", "Background": "Black" diff --git a/Terminal.Gui/Terminal.Gui.csproj b/Terminal.Gui/Terminal.Gui.csproj index 15d586975..6f1e53802 100644 --- a/Terminal.Gui/Terminal.Gui.csproj +++ b/Terminal.Gui/Terminal.Gui.csproj @@ -24,6 +24,7 @@ net8.0 12 enable + enable $(AssemblyName) true @@ -163,6 +164,16 @@ + + + + + + + + + + diff --git a/Terminal.Gui/Text/NerdFonts.cs b/Terminal.Gui/Text/NerdFonts.cs index 2ceaf4fa7..c6da80697 100644 --- a/Terminal.Gui/Text/NerdFonts.cs +++ b/Terminal.Gui/Text/NerdFonts.cs @@ -741,8 +741,13 @@ internal class NerdFonts { "nf-seti-typescript", '' } }; - public char GetNerdIcon (IFileSystemInfo file, bool isOpen) + public char GetNerdIcon (IFileSystemInfo? file, bool isOpen) { + if (file == null) + { + throw new ArgumentNullException (nameof (file)); + } + if (FilenameToIcon.ContainsKey (file.Name)) { return Glyphs [FilenameToIcon [file.Name]]; diff --git a/Terminal.Gui/Text/RuneExtensions.cs b/Terminal.Gui/Text/RuneExtensions.cs index 4dfb4bb3f..c8a273c83 100644 --- a/Terminal.Gui/Text/RuneExtensions.cs +++ b/Terminal.Gui/Text/RuneExtensions.cs @@ -1,5 +1,4 @@ -#nullable enable - + using System.Globalization; using Wcwidth; diff --git a/Terminal.Gui/Text/StringExtensions.cs b/Terminal.Gui/Text/StringExtensions.cs index e379cf3da..59f433b60 100644 --- a/Terminal.Gui/Text/StringExtensions.cs +++ b/Terminal.Gui/Text/StringExtensions.cs @@ -1,6 +1,4 @@ -#nullable enable -using System.Buffers; -using System.Globalization; +using System.Buffers; namespace Terminal.Gui.Text; @@ -55,8 +53,9 @@ public static class StringExtensions /// Gets the number of columns the string occupies in the terminal. /// This is a Terminal.Gui extension method to to support TUI text manipulation. /// The string to measure. + /// Indicates whether to ignore values ​​less than zero, such as control keys. /// - public static int GetColumns (this string str) + public static int GetColumns (this string str, bool ignoreLessThanZero = true) { if (string.IsNullOrEmpty (str)) { @@ -64,17 +63,25 @@ public static class StringExtensions } var total = 0; - TextElementEnumerator enumerator = StringInfo.GetTextElementEnumerator (str); - while (enumerator.MoveNext ()) + foreach (string grapheme in GraphemeHelper.GetGraphemes (str)) { - string element = enumerator.GetTextElement (); - // Get the maximum rune width within this grapheme cluster - int width = element - .EnumerateRunes () - .Max (r => Math.Max (r.GetColumns (), 0)); - total += width; + int clusterWidth = grapheme.EnumerateRunes () + .Sum (r => + { + int w = r.GetColumns (); + + return ignoreLessThanZero && w < 0 ? 0 : w; + }); + + // Clamp to realistic max display width + if (clusterWidth > 2) + { + clusterWidth = 2; + } + + total += clusterWidth; } return total; @@ -95,7 +102,7 @@ public static class StringExtensions /// A indicating if all elements of the are ASCII digits ( /// ) or not ( /// - public static bool IsAllAsciiDigits (this ReadOnlySpan stringSpan) { return stringSpan.ToString ().All (char.IsAsciiDigit); } + public static bool IsAllAsciiDigits (this ReadOnlySpan stringSpan) { return !stringSpan.IsEmpty && stringSpan.ToString ().All (char.IsAsciiDigit); } /// /// Determines if this of is composed entirely of ASCII @@ -106,7 +113,7 @@ public static class StringExtensions /// A indicating if all elements of the are ASCII digits ( /// ) or not ( /// - public static bool IsAllAsciiHexDigits (this ReadOnlySpan stringSpan) { return stringSpan.ToString ().All (char.IsAsciiHexDigit); } + public static bool IsAllAsciiHexDigits (this ReadOnlySpan stringSpan) { return !stringSpan.IsEmpty && stringSpan.ToString ().All (char.IsAsciiHexDigit); } /// Repeats the string times. /// This is a Terminal.Gui extension method to to support TUI text manipulation. @@ -207,4 +214,60 @@ public static class StringExtensions return encoding.GetString (bytes.ToArray ()); } + + /// Converts a generic collection into a string. + /// The enumerable string to convert. + /// + public static string ToString (IEnumerable strings) { return string.Concat (strings); } + + /// Converts the string into a . + /// This is a Terminal.Gui extension method to to support TUI text manipulation. + /// The string to convert. + /// + public static List ToStringList (this string str) + { + List strings = []; + + foreach (string grapheme in GraphemeHelper.GetGraphemes (str)) + { + strings.Add (grapheme); + } + + return strings; + } + + /// Reports whether a string is a surrogate code point. + /// This is a Terminal.Gui extension method to to support TUI text manipulation. + /// The string to probe. + /// if the string is a surrogate code point; otherwise. + public static bool IsSurrogatePair (this string str) + { + if (str.Length != 2) + { + return false; + } + + Rune rune = Rune.GetRuneAt (str, 0); + + return rune.IsSurrogatePair (); + } + + /// + /// Ensures the text is not a control character and can be displayed by translating characters below 0x20 to + /// equivalent, printable, Unicode chars. + /// + /// This is a Terminal.Gui extension method to to support TUI text manipulation. + /// The text. + /// + public static string MakePrintable (this string str) + { + if (str.Length > 1) + { + return str; + } + + char ch = str [0]; + + return char.IsControl (ch) ? new ((char)(ch + 0x2400), 1) : str; + } } diff --git a/Terminal.Gui/Text/TextDirection.cs b/Terminal.Gui/Text/TextDirection.cs index 2ea3ba3a4..b989c7337 100644 --- a/Terminal.Gui/Text/TextDirection.cs +++ b/Terminal.Gui/Text/TextDirection.cs @@ -58,4 +58,4 @@ public enum TextDirection /// This is a vertical direction. D O
L L
R L
O E
W H BottomTop_RightLeft -} \ No newline at end of file +} diff --git a/Terminal.Gui/Text/TextFormatter.cs b/Terminal.Gui/Text/TextFormatter.cs index 70636c018..f81f4c2b3 100644 --- a/Terminal.Gui/Text/TextFormatter.cs +++ b/Terminal.Gui/Text/TextFormatter.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Buffers; using System.Diagnostics; @@ -11,7 +10,7 @@ namespace Terminal.Gui.Text; public class TextFormatter { // Utilized in CRLF related helper methods for faster newline char index search. - private static readonly SearchValues NewlineSearchValues = SearchValues.Create(['\r', '\n']); + private static readonly SearchValues NewlineSearchValues = SearchValues.Create (['\r', '\n']); private Key _hotKey = new (); private int _hotKeyPos = -1; @@ -52,31 +51,28 @@ public class TextFormatter /// Causes the text to be formatted (references ). Sets to /// false. /// + /// The console driver currently used by the application. /// Specifies the screen-relative location and maximum size for drawing the text. /// The color to use for all text except the hotkey /// The color to use to draw the hotkey /// Specifies the screen-relative location and maximum container size. - /// The console driver currently used by the application. /// public void Draw ( + IDriver? driver, Rectangle screen, Attribute normalColor, Attribute hotColor, - Rectangle maximum = default, - IDriver? driver = null + Rectangle maximum = default ) { + ArgumentNullException.ThrowIfNull (driver); + // With this check, we protect against subclasses with overrides of Text (like Button) if (string.IsNullOrEmpty (Text)) { return; } - if (driver is null) - { - driver = Application.Driver; - } - driver?.SetAttribute (normalColor); List linesFormatted = GetLines (); @@ -126,9 +122,10 @@ public class TextFormatter break; } - Rune [] runes = linesFormatted [line].ToRunes (); + string strings = linesFormatted [line]; + string[] graphemes = GraphemeHelper.GetGraphemes (strings).ToArray (); - // When text is justified, we lost left or right, so we use the direction to align. + // When text is justified, we lost left or right, so we use the direction to align. int x = 0, y = 0; @@ -143,7 +140,7 @@ public class TextFormatter } else { - int runesWidth = StringExtensions.ToString (runes).GetColumns (); + int runesWidth = strings.GetColumns (); x = screen.Right - runesWidth; CursorPosition = screen.Width - runesWidth + (_hotKeyPos > -1 ? _hotKeyPos : 0); } @@ -199,7 +196,7 @@ public class TextFormatter } else { - int runesWidth = StringExtensions.ToString (runes).GetColumns (); + int runesWidth = strings.GetColumns (); x = screen.Left + (screen.Width - runesWidth) / 2; CursorPosition = (screen.Width - runesWidth) / 2 + (_hotKeyPos > -1 ? _hotKeyPos : 0); @@ -217,7 +214,7 @@ public class TextFormatter { if (isVertical) { - y = screen.Bottom - runes.Length; + y = screen.Bottom - graphemes.Length; } else { @@ -253,7 +250,7 @@ public class TextFormatter { if (isVertical) { - int s = (screen.Height - runes.Length) / 2; + int s = (screen.Height - graphemes.Length) / 2; y = screen.Top + s; } else @@ -274,14 +271,14 @@ public class TextFormatter int size = isVertical ? screen.Height : screen.Width; int current = start + colOffset; List lastZeroWidthPos = null!; - Rune rune = default; - int zeroLengthCount = isVertical ? runes.Sum (r => r.GetColumns () == 0 ? 1 : 0) : 0; + string text = string.Empty; + int zeroLengthCount = isVertical ? strings.EnumerateRunes ().Sum (r => r.GetColumns () == 0 ? 1 : 0) : 0; for (int idx = (isVertical ? start - y : start - x) + colOffset; current < start + size + zeroLengthCount; idx++) { - Rune lastRuneUsed = rune; + string lastTextUsed = text; if (lastZeroWidthPos is null) { @@ -295,17 +292,17 @@ public class TextFormatter continue; } - if (!FillRemaining && idx > runes.Length - 1) + if (!FillRemaining && idx > graphemes.Length - 1) { break; } if ((!isVertical && (current - start > maxScreen.Left + maxScreen.Width - screen.X + colOffset - || (idx < runes.Length && runes [idx].GetColumns () > screen.Width))) + || (idx < graphemes.Length && graphemes [idx].GetColumns () > screen.Width))) || (isVertical && ((current > start + size + zeroLengthCount && idx > maxScreen.Top + maxScreen.Height - screen.Y) - || (idx < runes.Length && runes [idx].GetColumns () > screen.Width)))) + || (idx < graphemes.Length && graphemes [idx].GetColumns () > screen.Width)))) { break; } @@ -316,13 +313,13 @@ public class TextFormatter // break; - rune = (Rune)' '; + text = " "; if (isVertical) { - if (idx >= 0 && idx < runes.Length) + if (idx >= 0 && idx < graphemes.Length) { - rune = runes [idx]; + text = graphemes [idx]; } if (lastZeroWidthPos is null) @@ -338,7 +335,7 @@ public class TextFormatter if (foundIdx > -1) { - if (rune.IsCombiningMark ()) + if (Rune.GetRuneAt (text, 0).IsCombiningMark ()) { lastZeroWidthPos [foundIdx] = new Point ( @@ -351,7 +348,7 @@ public class TextFormatter current ); } - else if (!rune.IsCombiningMark () && lastRuneUsed.IsCombiningMark ()) + else if (!Rune.GetRuneAt (text, 0).IsCombiningMark () && Rune.GetRuneAt (lastTextUsed, 0).IsCombiningMark ()) { current++; driver?.Move (x, current); @@ -371,13 +368,13 @@ public class TextFormatter { driver?.Move (current, y); - if (idx >= 0 && idx < runes.Length) + if (idx >= 0 && idx < graphemes.Length) { - rune = runes [idx]; + text = graphemes [idx]; } } - int runeWidth = GetRuneWidth (rune, TabWidth); + int runeWidth = GetTextWidth (text, TabWidth); if (HotKeyPos > -1 && idx == HotKeyPos) { @@ -387,7 +384,7 @@ public class TextFormatter } driver?.SetAttribute (hotColor); - driver?.AddRune (rune); + driver?.AddStr (text); driver?.SetAttribute (normalColor); } else @@ -416,7 +413,7 @@ public class TextFormatter } } - driver?.AddRune (rune); + driver?.AddStr (text); } if (isVertical) @@ -431,11 +428,11 @@ public class TextFormatter current += runeWidth; } - int nextRuneWidth = idx + 1 > -1 && idx + 1 < runes.Length - ? runes [idx + 1].GetColumns () + int nextRuneWidth = idx + 1 > -1 && idx + 1 < graphemes.Length + ? graphemes [idx + 1].GetColumns () : 0; - if (!isVertical && idx + 1 < runes.Length && current + nextRuneWidth > start + size) + if (!isVertical && idx + 1 < graphemes.Length && current + nextRuneWidth > start + size) { break; } @@ -933,9 +930,10 @@ public class TextFormatter break; } - Rune [] runes = linesFormatted [line].ToRunes (); + string strings = linesFormatted [line]; + string [] graphemes = GraphemeHelper.GetGraphemes (strings).ToArray (); - // When text is justified, we lost left or right, so we use the direction to align. + // When text is justified, we lost left or right, so we use the direction to align. int x = 0, y = 0; switch (Alignment) @@ -950,17 +948,17 @@ public class TextFormatter } case Alignment.End: { - int runesWidth = StringExtensions.ToString (runes).GetColumns (); - x = screen.Right - runesWidth; + int stringsWidth = strings.GetColumns (); + x = screen.Right - stringsWidth; break; } case Alignment.Start when isVertical: { - int runesWidth = line > 0 - ? GetColumnsRequiredForVerticalText (linesFormatted, 0, line, TabWidth) - : 0; - x = screen.Left + runesWidth; + int stringsWidth = line > 0 + ? GetColumnsRequiredForVerticalText (linesFormatted, 0, line, TabWidth) + : 0; + x = screen.Left + stringsWidth; break; } @@ -970,7 +968,7 @@ public class TextFormatter break; case Alignment.Fill when isVertical: { - int runesWidth = GetColumnsRequiredForVerticalText (linesFormatted, 0, linesFormatted.Count, TabWidth); + int stringsWidth = GetColumnsRequiredForVerticalText (linesFormatted, 0, linesFormatted.Count, TabWidth); int prevLineWidth = line > 0 ? GetColumnsRequiredForVerticalText (linesFormatted, line - 1, 1, TabWidth) : 0; int firstLineWidth = GetColumnsRequiredForVerticalText (linesFormatted, 0, 1, TabWidth); int lastLineWidth = GetColumnsRequiredForVerticalText (linesFormatted, linesFormatted.Count - 1, 1, TabWidth); @@ -979,7 +977,7 @@ public class TextFormatter x = line == 0 ? screen.Left : line < linesFormatted.Count - 1 - ? screen.Width - runesWidth <= lastLineWidth ? screen.Left + prevLineWidth : screen.Left + line * interval + ? screen.Width - stringsWidth <= lastLineWidth ? screen.Left + prevLineWidth : screen.Left + line * interval : screen.Right - lastLineWidth; break; @@ -990,16 +988,16 @@ public class TextFormatter break; case Alignment.Center when isVertical: { - int runesWidth = GetColumnsRequiredForVerticalText (linesFormatted, 0, linesFormatted.Count, TabWidth); + int stringsWidth = GetColumnsRequiredForVerticalText (linesFormatted, 0, linesFormatted.Count, TabWidth); int linesWidth = GetColumnsRequiredForVerticalText (linesFormatted, 0, line, TabWidth); - x = screen.Left + linesWidth + (screen.Width - runesWidth) / 2; + x = screen.Left + linesWidth + (screen.Width - stringsWidth) / 2; break; } case Alignment.Center: { - int runesWidth = StringExtensions.ToString (runes).GetColumns (); - x = screen.Left + (screen.Width - runesWidth) / 2; + int stringsWidth = strings.GetColumns (); + x = screen.Left + (screen.Width - stringsWidth) / 2; break; } @@ -1013,7 +1011,7 @@ public class TextFormatter { // Vertical Alignment case Alignment.End when isVertical: - y = screen.Bottom - runes.Length; + y = screen.Bottom - graphemes.Length; break; case Alignment.End: @@ -1043,7 +1041,7 @@ public class TextFormatter } case Alignment.Center when isVertical: { - int s = (screen.Height - runes.Length) / 2; + int s = (screen.Height - graphemes.Length) / 2; y = screen.Top + s; break; @@ -1065,7 +1063,7 @@ public class TextFormatter int start = isVertical ? screen.Top : screen.Left; int size = isVertical ? screen.Height : screen.Width; int current = start + colOffset; - int zeroLengthCount = isVertical ? runes.Sum (r => r.GetColumns () == 0 ? 1 : 0) : 0; + int zeroLengthCount = isVertical ? strings.EnumerateRunes ().Sum (r => r.GetColumns () == 0 ? 1 : 0) : 0; int lineX = x, lineY = y, lineWidth = 0, lineHeight = 1; @@ -1083,23 +1081,23 @@ public class TextFormatter continue; } - if (!FillRemaining && idx > runes.Length - 1) + if (!FillRemaining && idx > graphemes.Length - 1) { break; } if ((!isVertical && (current - start > maxScreen.Left + maxScreen.Width - screen.X + colOffset - || (idx < runes.Length && runes [idx].GetColumns () > screen.Width))) + || (idx < graphemes.Length && graphemes [idx].GetColumns () > screen.Width))) || (isVertical && ((current > start + size + zeroLengthCount && idx > maxScreen.Top + maxScreen.Height - screen.Y) - || (idx < runes.Length && runes [idx].GetColumns () > screen.Width)))) + || (idx < graphemes.Length && graphemes [idx].GetColumns () > screen.Width)))) { break; } - Rune rune = idx >= 0 && idx < runes.Length ? runes [idx] : (Rune)' '; - int runeWidth = GetRuneWidth (rune, TabWidth); + string text = idx >= 0 && idx < graphemes.Length ? graphemes [idx] : " "; + int runeWidth = GetStringWidth (text, TabWidth); if (isVertical) { @@ -1118,11 +1116,11 @@ public class TextFormatter current += isVertical && runeWidth > 0 ? 1 : runeWidth; - int nextRuneWidth = idx + 1 > -1 && idx + 1 < runes.Length - ? runes [idx + 1].GetColumns () + int nextStringWidth = idx + 1 > -1 && idx + 1 < graphemes.Length + ? graphemes [idx + 1].GetColumns () : 0; - if (!isVertical && idx + 1 < runes.Length && current + nextRuneWidth > start + size) + if (!isVertical && idx + 1 < graphemes.Length && current + nextStringWidth > start + size) { break; } @@ -1199,8 +1197,8 @@ public class TextFormatter return str; } - StringBuilder stringBuilder = new(); - ReadOnlySpan firstSegment = remaining[..firstNewlineCharIndex]; + StringBuilder stringBuilder = new (); + ReadOnlySpan firstSegment = remaining [..firstNewlineCharIndex]; stringBuilder.Append (firstSegment); // The first newline is not yet skipped because the "keepNewLine" condition has not been evaluated. @@ -1215,7 +1213,7 @@ public class TextFormatter break; } - ReadOnlySpan segment = remaining[..newlineCharIndex]; + ReadOnlySpan segment = remaining [..newlineCharIndex]; stringBuilder.Append (segment); int stride = segment.Length; @@ -1267,8 +1265,8 @@ public class TextFormatter return str; } - StringBuilder stringBuilder = new(); - ReadOnlySpan firstSegment = remaining[..firstNewlineCharIndex]; + StringBuilder stringBuilder = new (); + ReadOnlySpan firstSegment = remaining [..firstNewlineCharIndex]; stringBuilder.Append (firstSegment); // The first newline is not yet skipped because the newline type has not been evaluated. @@ -1283,7 +1281,7 @@ public class TextFormatter break; } - ReadOnlySpan segment = remaining[..newlineCharIndex]; + ReadOnlySpan segment = remaining [..newlineCharIndex]; stringBuilder.Append (segment); int stride = segment.Length; @@ -1335,33 +1333,34 @@ public class TextFormatter /// A list of text without the newline characters. public static List SplitNewLine (string text) { - List runes = text.ToRuneList (); + List graphemes = GraphemeHelper.GetGraphemes (text).ToList (); List lines = new (); var start = 0; - for (var i = 0; i < runes.Count; i++) + for (var i = 0; i < graphemes.Count; i++) { int end = i; - switch (runes [i].Value) + switch (graphemes [i]) { - case '\n': - lines.Add (StringExtensions.ToString (runes.GetRange (start, end - start))); + case "\n": + case "\r\n": + lines.Add (StringExtensions.ToString (graphemes.GetRange (start, end - start))); i++; start = i; break; - case '\r': - if (i + 1 < runes.Count && runes [i + 1].Value == '\n') + case "\r": + if (i + 1 < graphemes.Count && graphemes [i + 1] == "\n") { - lines.Add (StringExtensions.ToString (runes.GetRange (start, end - start))); + lines.Add (StringExtensions.ToString (graphemes.GetRange (start, end - start))); i += 2; start = i; } else { - lines.Add (StringExtensions.ToString (runes.GetRange (start, end - start))); + lines.Add (StringExtensions.ToString (graphemes.GetRange (start, end - start))); i++; start = i; } @@ -1370,14 +1369,14 @@ public class TextFormatter } } - switch (runes.Count) + switch (graphemes.Count) { case > 0 when lines.Count == 0: - lines.Add (StringExtensions.ToString (runes)); + lines.Add (StringExtensions.ToString (graphemes)); break; - case > 0 when start < runes.Count: - lines.Add (StringExtensions.ToString (runes.GetRange (start, runes.Count - start))); + case > 0 when start < graphemes.Count: + lines.Add (StringExtensions.ToString (graphemes.GetRange (start, graphemes.Count - start))); break; default: @@ -1405,16 +1404,19 @@ public class TextFormatter } // if value is not wide enough - if (text.EnumerateRunes ().Sum (c => c.GetColumns ()) < width) + string [] graphemes = GraphemeHelper.GetGraphemes (text).ToArray (); + int totalColumns = graphemes.Sum (s => s.GetColumns ()); + + if (totalColumns < width) { // pad it out with spaces to the given Alignment - int toPad = width - text.EnumerateRunes ().Sum (c => c.GetColumns ()); + int toPad = width - totalColumns; return text + new string (' ', toPad); } // value is too wide - return new (text.TakeWhile (c => (width -= ((Rune)c).GetColumns ()) >= 0).ToArray ()); + return string.Concat (graphemes.TakeWhile (t => (width -= t.GetColumns ()) >= 0)); } /// Formats the provided text to fit within the width provided using word wrapping. @@ -1455,18 +1457,18 @@ public class TextFormatter return lines; } - List runes = StripCRLF (text).ToRuneList (); + List graphemes = GraphemeHelper.GetGraphemes (StripCRLF (text)).ToList (); int start = Math.Max ( - !runes.Contains ((Rune)' ') && textFormatter is { VerticalAlignment: Alignment.End } && IsVerticalDirection (textDirection) - ? runes.Count - width + !graphemes.Contains (" ") && textFormatter is { VerticalAlignment: Alignment.End } && IsVerticalDirection (textDirection) + ? graphemes.Count - width : 0, 0); int end; if (preserveTrailingSpaces) { - while ((end = start) < runes.Count) + while (start < graphemes.Count) { end = GetNextWhiteSpace (start, width, out bool incomplete); @@ -1477,7 +1479,7 @@ public class TextFormatter break; } - lines.Add (StringExtensions.ToString (runes.GetRange (start, end - start))); + lines.Add (StringExtensions.ToString (graphemes.GetRange (start, end - start))); start = end; if (incomplete) @@ -1494,14 +1496,14 @@ public class TextFormatter { while ((end = start + GetLengthThatFits ( - runes.GetRange (start, runes.Count - start), + string.Concat (graphemes.GetRange (start, graphemes.Count - start)), width, tabWidth, textDirection )) - < runes.Count) + < graphemes.Count) { - while (runes [end].Value != ' ' && end > start) + while (graphemes [end] != " " && end > start) { end--; } @@ -1510,22 +1512,22 @@ public class TextFormatter { end = start + GetLengthThatFits ( - runes.GetRange (end, runes.Count - end), + string.Concat (graphemes.GetRange (end, graphemes.Count - end)), width, tabWidth, textDirection ); } - var str = StringExtensions.ToString (runes.GetRange (start, end - start)); + var str = StringExtensions.ToString (graphemes.GetRange (start, end - start)); int zeroLength = text.EnumerateRunes ().Sum (r => r.GetColumns () == 0 ? 1 : 0); - if (end > start && GetRuneWidth (str, tabWidth, textDirection) <= width + zeroLength) + if (end > start && GetTextWidth (str, tabWidth, textDirection) <= width + zeroLength) { lines.Add (str); start = end; - if (runes [end].Value == ' ') + if (graphemes [end] == " ") { start++; } @@ -1539,9 +1541,9 @@ public class TextFormatter } else { - while ((end = start + width) < runes.Count) + while ((end = start + width) < graphemes.Count) { - while (runes [end].Value != ' ' && end > start) + while (graphemes [end] != " " && end > start) { end--; } @@ -1553,11 +1555,11 @@ public class TextFormatter var zeroLength = 0; - for (int i = end; i < runes.Count - start; i++) + for (int i = end; i < graphemes.Count - start; i++) { - Rune r = runes [i]; + string s = graphemes [i]; - if (r.GetColumns () == 0) + if (s.GetColumns () == 0) { zeroLength++; } @@ -1569,7 +1571,7 @@ public class TextFormatter lines.Add ( StringExtensions.ToString ( - runes.GetRange ( + graphemes.GetRange ( start, end - start + zeroLength ) @@ -1578,7 +1580,7 @@ public class TextFormatter end += zeroLength; start = end; - if (runes [end].Value == ' ') + if (graphemes [end] == " ") { start++; } @@ -1592,13 +1594,13 @@ public class TextFormatter int length = cLength; incomplete = false; - while (length < cWidth && to < runes.Count) + while (length < cWidth && to < graphemes.Count) { - Rune rune = runes [to]; + string grapheme = graphemes [to]; if (IsHorizontalDirection (textDirection)) { - length += rune.GetColumns (); + length += grapheme.GetColumns (false); } else { @@ -1607,7 +1609,7 @@ public class TextFormatter if (length > cWidth) { - if (to >= runes.Count || (length > 1 && cWidth <= 1)) + if (to >= graphemes.Count || (length > 1 && cWidth <= 1)) { incomplete = true; } @@ -1615,15 +1617,15 @@ public class TextFormatter return to; } - switch (rune.Value) + switch (grapheme) { - case ' ' when length == cWidth: + case " " when length == cWidth: return to + 1; - case ' ' when length > cWidth: + case " " when length > cWidth: return to; - case ' ': + case " ": return GetNextWhiteSpace (to + 1, cWidth, out incomplete, length); - case '\t': + case "\t": { length += tabWidth + 1; @@ -1648,8 +1650,8 @@ public class TextFormatter return cLength switch { - > 0 when to < runes.Count && runes [to].Value != ' ' && runes [to].Value != '\t' => from, - > 0 when to < runes.Count && (runes [to].Value == ' ' || runes [to].Value == '\t') => from, + > 0 when to < graphemes.Count && graphemes [to] != " " && graphemes [to] != "\t" => from, + > 0 when to < graphemes.Count && (graphemes [to] == " " || graphemes [to] == "\t") => from, _ => to }; } @@ -1657,7 +1659,7 @@ public class TextFormatter if (start < text.GetRuneCount ()) { string str = ReplaceTABWithSpaces ( - StringExtensions.ToString (runes.GetRange (start, runes.Count - start)), + StringExtensions.ToString (graphemes.GetRange (start, graphemes.Count - start)), tabWidth ); @@ -1721,42 +1723,42 @@ public class TextFormatter } text = ReplaceTABWithSpaces (text, tabWidth); - List runes = text.ToRuneList (); - int zeroLength = runes.Sum (r => r.GetColumns () == 0 ? 1 : 0); + List graphemes = GraphemeHelper.GetGraphemes (text).ToList (); + int zeroLength = graphemes.Sum (s => s.EnumerateRunes ().Sum (r => r.GetColumns() == 0 ? 1 : 0)); - if (runes.Count - zeroLength > width) + if (graphemes.Count - zeroLength > width) { if (IsHorizontalDirection (textDirection)) { if (textFormatter is { Alignment: Alignment.End }) { - return GetRangeThatFits (runes, runes.Count - width, text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, graphemes.Count - width, text, width, tabWidth, textDirection); } if (textFormatter is { Alignment: Alignment.Center }) { - return GetRangeThatFits (runes, Math.Max ((runes.Count - width - zeroLength) / 2, 0), text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, Math.Max ((graphemes.Count - width - zeroLength) / 2, 0), text, width, tabWidth, textDirection); } - return GetRangeThatFits (runes, 0, text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, 0, text, width, tabWidth, textDirection); } if (IsVerticalDirection (textDirection)) { if (textFormatter is { VerticalAlignment: Alignment.End }) { - return GetRangeThatFits (runes, runes.Count - width, text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, graphemes.Count - width, text, width, tabWidth, textDirection); } if (textFormatter is { VerticalAlignment: Alignment.Center }) { - return GetRangeThatFits (runes, Math.Max ((runes.Count - width - zeroLength) / 2, 0), text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, Math.Max ((graphemes.Count - width - zeroLength) / 2, 0), text, width, tabWidth, textDirection); } - return GetRangeThatFits (runes, 0, text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, 0, text, width, tabWidth, textDirection); } - return StringExtensions.ToString (runes.GetRange (0, width + zeroLength)); + return StringExtensions.ToString (graphemes.GetRange (0, width + zeroLength)); } if (justify) @@ -1768,18 +1770,18 @@ public class TextFormatter { if (textFormatter is { Alignment: Alignment.End }) { - if (GetRuneWidth (text, tabWidth, textDirection) > width) + if (GetTextWidth (text, tabWidth, textDirection) > width) { - return GetRangeThatFits (runes, runes.Count - width, text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, graphemes.Count - width, text, width, tabWidth, textDirection); } } else if (textFormatter is { Alignment: Alignment.Center }) { - return GetRangeThatFits (runes, Math.Max ((runes.Count - width - zeroLength) / 2, 0), text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, Math.Max ((graphemes.Count - width - zeroLength) / 2, 0), text, width, tabWidth, textDirection); } - else if (GetRuneWidth (text, tabWidth, textDirection) > width) + else if (GetTextWidth (text, tabWidth, textDirection) > width) { - return GetRangeThatFits (runes, 0, text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, 0, text, width, tabWidth, textDirection); } } @@ -1787,28 +1789,28 @@ public class TextFormatter { if (textFormatter is { VerticalAlignment: Alignment.End }) { - if (runes.Count - zeroLength > width) + if (graphemes.Count - zeroLength > width) { - return GetRangeThatFits (runes, runes.Count - width, text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, graphemes.Count - width, text, width, tabWidth, textDirection); } } else if (textFormatter is { VerticalAlignment: Alignment.Center }) { - return GetRangeThatFits (runes, Math.Max ((runes.Count - width - zeroLength) / 2, 0), text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, Math.Max ((graphemes.Count - width - zeroLength) / 2, 0), text, width, tabWidth, textDirection); } - else if (runes.Count - zeroLength > width) + else if (graphemes.Count - zeroLength > width) { - return GetRangeThatFits (runes, 0, text, width, tabWidth, textDirection); + return GetRangeThatFits (graphemes, 0, text, width, tabWidth, textDirection); } } return text; } - private static string GetRangeThatFits (List runes, int index, string text, int width, int tabWidth, TextDirection textDirection) + private static string GetRangeThatFits (List strings, int index, string text, int width, int tabWidth, TextDirection textDirection) { return StringExtensions.ToString ( - runes.GetRange ( + strings.GetRange ( Math.Max (index, 0), GetLengthThatFits (text, width, tabWidth, textDirection) ) @@ -1846,7 +1848,7 @@ public class TextFormatter if (IsHorizontalDirection (textDirection)) { - textCount = words.Sum (arg => GetRuneWidth (arg, tabWidth, textDirection)); + textCount = words.Sum (arg => GetTextWidth (arg, tabWidth, textDirection)); } else { @@ -2141,11 +2143,11 @@ public class TextFormatter i < (linesCount == -1 ? lines.Count : startLine + linesCount); i++) { - string runes = lines [i]; + string strings = lines [i]; - if (runes.Length > 0) + if (strings.Length > 0) { - max += runes.EnumerateRunes ().Max (r => GetRuneWidth (r, tabWidth)); + max += strings.EnumerateRunes ().Max (r => GetRuneWidth (r, tabWidth)); } } @@ -2167,7 +2169,7 @@ public class TextFormatter { List result = SplitNewLine (text); - return result.Max (x => GetRuneWidth (x, tabWidth)); + return result.Max (x => GetTextWidth (x, tabWidth)); } /// @@ -2186,13 +2188,13 @@ public class TextFormatter public static int GetSumMaxCharWidth (string text, int startIndex = -1, int length = -1, int tabWidth = 0) { var max = 0; - Rune [] runes = text.ToRunes (); + string [] graphemes = GraphemeHelper.GetGraphemes (text).ToArray (); for (int i = startIndex == -1 ? 0 : startIndex; - i < (length == -1 ? runes.Length : startIndex + length); + i < (length == -1 ? graphemes.Length : startIndex + length); i++) { - max += GetRuneWidth (runes [i], tabWidth); + max += GetStringWidth (graphemes [i], tabWidth); } return max; @@ -2210,51 +2212,38 @@ public class TextFormatter /// The index of the text that fit the width. public static int GetLengthThatFits (string text, int width, int tabWidth = 0, TextDirection textDirection = TextDirection.LeftRight_TopBottom) { - return GetLengthThatFits (text?.ToRuneList () ?? [], width, tabWidth, textDirection); - } - - /// Gets the number of the Runes in a list of Runes that will fit in . - /// - /// This API will return incorrect results if the text includes glyphs whose width is dependent on surrounding - /// glyphs (e.g. Arabic). - /// - /// The list of runes. - /// The width. - /// The width used for a tab. - /// The text direction. - /// The index of the last Rune in that fit in . - public static int GetLengthThatFits (List runes, int width, int tabWidth = 0, TextDirection textDirection = TextDirection.LeftRight_TopBottom) - { - if (runes is null || runes.Count == 0) + if (string.IsNullOrEmpty (text)) { return 0; } - var runesLength = 0; - var runeIdx = 0; + var textLength = 0; + var stringIdx = 0; - for (; runeIdx < runes.Count; runeIdx++) + foreach (string grapheme in GraphemeHelper.GetGraphemes (text)) { - int runeWidth = GetRuneWidth (runes [runeIdx], tabWidth, textDirection); + int textWidth = GetStringWidth (grapheme, tabWidth, textDirection); - if (runesLength + runeWidth > width) + if (textLength + textWidth > width) { break; } - runesLength += runeWidth; + textLength += textWidth; + stringIdx++; } - return runeIdx; + return stringIdx; } - private static int GetRuneWidth (string str, int tabWidth, TextDirection textDirection = TextDirection.LeftRight_TopBottom) + private static int GetTextWidth (string str, int tabWidth, TextDirection textDirection = TextDirection.LeftRight_TopBottom) { int runesWidth = 0; - foreach (Rune rune in str.EnumerateRunes ()) + foreach (string grapheme in GraphemeHelper.GetGraphemes (str)) { - runesWidth += GetRuneWidth (rune, tabWidth, textDirection); + runesWidth += GetStringWidth (grapheme, tabWidth, textDirection); } + return runesWidth; } @@ -2275,6 +2264,23 @@ public class TextFormatter return runeWidth; } + private static int GetStringWidth (string str, int tabWidth, TextDirection textDirection = TextDirection.LeftRight_TopBottom) + { + int textWidth = IsHorizontalDirection (textDirection) ? str.GetColumns (false) : str.GetColumns () == 0 ? 0 : 1; + + if (str == "\t") + { + return tabWidth; + } + + if (textWidth is < 0 or > 0) + { + return Math.Max (textWidth, 1); + } + + return textWidth; + } + /// Gets the index position from the list based on the . /// /// This API will return incorrect results if the text includes glyphs whose width is dependent on surrounding @@ -2286,23 +2292,23 @@ public class TextFormatter /// The index of the list that fit the width. public static int GetMaxColsForWidth (List lines, int width, int tabWidth = 0) { - var runesLength = 0; + var textLength = 0; var lineIdx = 0; for (; lineIdx < lines.Count; lineIdx++) { - List runes = lines [lineIdx].ToRuneList (); + string [] graphemes = GraphemeHelper.GetGraphemes (lines [lineIdx]).ToArray (); - int maxRruneWidth = runes.Count > 0 - ? runes.Max (r => GetRuneWidth (r, tabWidth)) + int maxTextWidth = graphemes.Length > 0 + ? graphemes.Max (r => GetStringWidth (r, tabWidth)) : 1; - if (runesLength + maxRruneWidth > width) + if (textLength + maxTextWidth > width) { break; } - runesLength += maxRruneWidth; + textLength += maxTextWidth; } return lineIdx; @@ -2445,12 +2451,12 @@ public class TextFormatter } const int maxStackallocCharBufferSize = 512; // ~1 kB - char[]? rentedBufferArray = null; + char []? rentedBufferArray = null; try { Span buffer = text.Length <= maxStackallocCharBufferSize - ? stackalloc char[text.Length] - : (rentedBufferArray = ArrayPool.Shared.Rent(text.Length)); + ? stackalloc char [text.Length] + : (rentedBufferArray = ArrayPool.Shared.Rent (text.Length)); int i = 0; var remainingBuffer = buffer; @@ -2468,7 +2474,7 @@ public class TextFormatter ReadOnlySpan newText = buffer [..^remainingBuffer.Length]; // If the resulting string would be the same as original then just return the original. - if (newText.Equals(text, StringComparison.Ordinal)) + if (newText.Equals (text, StringComparison.Ordinal)) { return text; } diff --git a/Terminal.Gui/ViewBase/Adornment/Adornment.cs b/Terminal.Gui/ViewBase/Adornment/Adornment.cs index 9d5675b6b..6852efea4 100644 --- a/Terminal.Gui/ViewBase/Adornment/Adornment.cs +++ b/Terminal.Gui/ViewBase/Adornment/Adornment.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.ViewBase; @@ -84,6 +84,12 @@ public class Adornment : View, IDesignable #region View Overrides + /// + protected override IApplication? GetApp () => Parent?.App; + + /// + protected override IDriver? GetDriver () => Parent?.Driver ?? base.GetDriver(); + // If a scheme is explicitly set, use that. Otherwise, use the scheme of the parent view. private Scheme? _scheme; @@ -176,7 +182,10 @@ public class Adornment : View, IDesignable } // This just draws/clears the thickness, not the insides. - Thickness.Draw (ViewportToScreen (Viewport), Diagnostics, ToString ()); + if (Driver is { }) + { + Thickness.Draw (Driver, ViewportToScreen (Viewport), Diagnostics, ToString ()); + } NeedsDraw = true; diff --git a/Terminal.Gui/ViewBase/Adornment/Border.Arrangment.cs b/Terminal.Gui/ViewBase/Adornment/Border.Arrangment.cs index b55fec027..ac0a593a1 100644 --- a/Terminal.Gui/ViewBase/Adornment/Border.Arrangment.cs +++ b/Terminal.Gui/ViewBase/Adornment/Border.Arrangment.cs @@ -1,4 +1,3 @@ -#nullable enable using System.ComponentModel; using System.Diagnostics; @@ -40,7 +39,10 @@ public partial class Border // Add Commands and KeyBindings - Note it's ok these get added each time. KeyBindings are cleared in EndArrange() AddArrangeModeKeyBindings (); - Application.MouseEvent += ApplicationOnMouseEvent; + if (App is { }) + { + App.Mouse.MouseEvent += ApplicationOnMouseEvent; + } // Create all necessary arrangement buttons CreateArrangementButtons (); @@ -429,11 +431,14 @@ public partial class Border MouseState &= ~MouseState.Pressed; - Application.MouseEvent -= ApplicationOnMouseEvent; - - if (Application.Mouse.MouseGrabView == this && _dragPosition.HasValue) + if (App is { }) { - Application.Mouse.UngrabMouse (); + App.Mouse.MouseEvent -= ApplicationOnMouseEvent; + + if (App.Mouse.MouseGrabView == this && _dragPosition.HasValue) + { + App.Mouse.UngrabMouse (); + } } // Clean up all arrangement buttons @@ -498,7 +503,7 @@ public partial class Border // Set the start grab point to the Frame coords _startGrabPoint = new (mouseEvent.Position.X + Frame.X, mouseEvent.Position.Y + Frame.Y); _dragPosition = mouseEvent.Position; - Application.Mouse.GrabMouse (this); + App?.Mouse.GrabMouse (this); // Determine the mode based on where the click occurred ViewArrangement arrangeMode = DetermineArrangeModeFromClick (); @@ -511,7 +516,7 @@ public partial class Border return true; } - if (mouseEvent.Flags is (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition) && Application.Mouse.MouseGrabView == this) + if (mouseEvent.Flags is (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition) && App?.Mouse.MouseGrabView == this) { if (_dragPosition.HasValue) { @@ -523,7 +528,7 @@ public partial class Border if (mouseEvent.Flags.HasFlag (MouseFlags.Button1Released) && _dragPosition.HasValue) { _dragPosition = null; - Application.Mouse.UngrabMouse (); + App?.Mouse.UngrabMouse (); EndArrangeMode (); @@ -652,7 +657,7 @@ public partial class Border if (Parent!.SuperView is null) { // Redraw the entire app window. - Application.Top!.SetNeedsDraw (); + App?.TopRunnableView?.SetNeedsDraw (); } else { @@ -763,7 +768,7 @@ public partial class Border private void Application_GrabbingMouse (object? sender, GrabMouseEventArgs e) { - if (Application.Mouse.MouseGrabView == this && _dragPosition.HasValue) + if (App?.Mouse.MouseGrabView == this && _dragPosition.HasValue) { e.Cancel = true; } @@ -771,7 +776,7 @@ public partial class Border private void Application_UnGrabbingMouse (object? sender, GrabMouseEventArgs e) { - if (Application.Mouse.MouseGrabView == this && _dragPosition.HasValue) + if (App?.Mouse.MouseGrabView == this && _dragPosition.HasValue) { e.Cancel = true; } @@ -784,8 +789,11 @@ public partial class Border /// protected override void Dispose (bool disposing) { - Application.Mouse.GrabbingMouse -= Application_GrabbingMouse; - Application.Mouse.UnGrabbingMouse -= Application_UnGrabbingMouse; + if (App is { }) + { + App.Mouse.GrabbingMouse -= Application_GrabbingMouse; + App.Mouse.UnGrabbingMouse -= Application_UnGrabbingMouse; + } _dragPosition = null; base.Dispose (disposing); diff --git a/Terminal.Gui/ViewBase/Adornment/Border.cs b/Terminal.Gui/ViewBase/Adornment/Border.cs index 18a99b1c1..951879e9f 100644 --- a/Terminal.Gui/ViewBase/Adornment/Border.cs +++ b/Terminal.Gui/ViewBase/Adornment/Border.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; namespace Terminal.Gui.ViewBase; @@ -49,10 +48,6 @@ public partial class Border : Adornment Parent = parent; CanFocus = false; TabStop = TabBehavior.TabGroup; - - Application.Mouse.GrabbingMouse += Application_GrabbingMouse; - Application.Mouse.UnGrabbingMouse += Application_UnGrabbingMouse; - ThicknessChanged += OnThicknessChanged; } @@ -113,6 +108,12 @@ public partial class Border : Adornment { base.BeginInit (); + if (App is { }) + { + App.Mouse.GrabbingMouse += Application_GrabbingMouse; + App.Mouse.UnGrabbingMouse += Application_UnGrabbingMouse; + } + if (Parent is null) { return; @@ -140,7 +141,7 @@ public partial class Border : Adornment }; CloseButton.Accept += (s, e) => { - e.Handled = Parent.InvokeCommand (Command.QuitToplevel) == true; + e.Handled = Parent.InvokeCommand (Command.Quit) == true; }; Add (CloseButton); @@ -312,7 +313,8 @@ public partial class Border : Adornment } } - if (Parent is { } + if (Driver is { } + && Parent is { } && canDrawBorder && Thickness.Top > 0 && maxTitleWidth > 0 @@ -321,10 +323,7 @@ public partial class Border : Adornment { Rectangle titleRect = new (borderBounds.X + 2, titleY, maxTitleWidth, 1); - Parent.TitleTextFormatter.Draw ( - titleRect, - GetAttributeForRole (Parent.HasFocus ? VisualRole.Focus : VisualRole.Normal), - GetAttributeForRole (Parent.HasFocus ? VisualRole.HotFocus : VisualRole.HotNormal)); + Parent.TitleTextFormatter.Draw (driver: Driver, screen: titleRect, normalColor: GetAttributeForRole (Parent.HasFocus ? VisualRole.Focus : VisualRole.Normal), hotColor: GetAttributeForRole (Parent.HasFocus ? VisualRole.HotFocus : VisualRole.HotNormal)); Parent?.LineCanvas.Exclude (new (titleRect)); } @@ -498,16 +497,13 @@ public partial class Border : Adornment if (drawTop) { - hruler.Draw (new (screenBounds.X, screenBounds.Y)); + hruler.Draw (driver: Driver, location: new (screenBounds.X, screenBounds.Y)); } // Redraw title if (drawTop && maxTitleWidth > 0 && Settings.FastHasFlags (BorderSettings.Title)) { - Parent!.TitleTextFormatter.Draw ( - new (borderBounds.X + 2, titleY, maxTitleWidth, 1), - Parent.HasFocus ? Parent.GetAttributeForRole (VisualRole.Focus) : Parent.GetAttributeForRole (VisualRole.Normal), - Parent.HasFocus ? Parent.GetAttributeForRole (VisualRole.Focus) : Parent.GetAttributeForRole (VisualRole.Normal)); + Parent!.TitleTextFormatter.Draw (driver: Driver, screen: new (borderBounds.X + 2, titleY, maxTitleWidth, 1), normalColor: Parent.HasFocus ? Parent.GetAttributeForRole (VisualRole.Focus) : Parent.GetAttributeForRole (VisualRole.Normal), hotColor: Parent.HasFocus ? Parent.GetAttributeForRole (VisualRole.Focus) : Parent.GetAttributeForRole (VisualRole.Normal)); } //Left @@ -515,19 +511,19 @@ public partial class Border : Adornment if (drawLeft) { - vruler.Draw (new (screenBounds.X, screenBounds.Y + 1), 1); + vruler.Draw (driver: Driver, location: new (screenBounds.X, screenBounds.Y + 1), start: 1); } // Bottom if (drawBottom) { - hruler.Draw (new (screenBounds.X, screenBounds.Y + screenBounds.Height - 1)); + hruler.Draw (driver: Driver, location: new (screenBounds.X, screenBounds.Y + screenBounds.Height - 1)); } // Right if (drawRight) { - vruler.Draw (new (screenBounds.X + screenBounds.Width - 1, screenBounds.Y + 1), 1); + vruler.Draw (driver: Driver, location: new (screenBounds.X + screenBounds.Width - 1, screenBounds.Y + 1), start: 1); } } diff --git a/Terminal.Gui/ViewBase/Adornment/BorderSettings.cs b/Terminal.Gui/ViewBase/Adornment/BorderSettings.cs index 516842000..4921446ae 100644 --- a/Terminal.Gui/ViewBase/Adornment/BorderSettings.cs +++ b/Terminal.Gui/ViewBase/Adornment/BorderSettings.cs @@ -1,12 +1,9 @@ - - namespace Terminal.Gui.ViewBase; /// /// Determines the settings for . /// [Flags] - public enum BorderSettings { /// diff --git a/Terminal.Gui/ViewBase/Adornment/Margin.cs b/Terminal.Gui/ViewBase/Adornment/Margin.cs index 59b39930f..0ce7740ba 100644 --- a/Terminal.Gui/ViewBase/Adornment/Margin.cs +++ b/Terminal.Gui/ViewBase/Adornment/Margin.cs @@ -1,4 +1,4 @@ -#nullable enable + using System.Runtime.InteropServices; @@ -80,10 +80,10 @@ public class Margin : Adornment if (view.Margin?.GetCachedClip () != null) { view.Margin!.NeedsDraw = true; - Region? saved = GetClip (); - View.SetClip (view.Margin!.GetCachedClip ()); - view.Margin!.Draw (); - View.SetClip (saved); + Region? saved = view.GetClip (); + view.SetClip (view.Margin!.GetCachedClip ()); + view.Margin!.Draw (); + view.SetClip (saved); view.Margin!.ClearCachedClip (); } @@ -128,7 +128,7 @@ public class Margin : Adornment // This just draws/clears the thickness, not the insides. // TODO: This is a hack. See https://github.com/gui-cs/Terminal.Gui/issues/4016 //SetAttribute (GetAttributeForRole (VisualRole.Normal)); - Thickness.Draw (screen, Diagnostics, ToString ()); + Thickness.Draw (Driver, screen, Diagnostics, ToString ()); } if (ShadowStyle != ShadowStyle.None) diff --git a/Terminal.Gui/ViewBase/Adornment/Padding.cs b/Terminal.Gui/ViewBase/Adornment/Padding.cs index 508670504..0f19073a4 100644 --- a/Terminal.Gui/ViewBase/Adornment/Padding.cs +++ b/Terminal.Gui/ViewBase/Adornment/Padding.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.ViewBase; diff --git a/Terminal.Gui/ViewBase/Adornment/ShadowView.cs b/Terminal.Gui/ViewBase/Adornment/ShadowView.cs index 151aa149c..cbb484fb7 100644 --- a/Terminal.Gui/ViewBase/Adornment/ShadowView.cs +++ b/Terminal.Gui/ViewBase/Adornment/ShadowView.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.ViewBase; @@ -100,7 +100,7 @@ internal class ShadowView : View if (c < ScreenContents?.GetLength (1) && r < ScreenContents?.GetLength (0)) { - AddRune (ScreenContents [r, c].Rune); + AddStr (ScreenContents [r, c].Grapheme); } } } @@ -134,7 +134,7 @@ internal class ShadowView : View if (ScreenContents is { } && screen.X < ScreenContents.GetLength (1) && r < ScreenContents.GetLength (0)) { - AddRune (ScreenContents [r, c].Rune); + AddStr (ScreenContents [r, c].Grapheme); } } } @@ -142,11 +142,11 @@ internal class ShadowView : View private Attribute GetAttributeUnderLocation (Point location) { - if (SuperView is not Adornment adornment + if (SuperView is not Adornment || location.X < 0 - || location.X >= Application.Screen.Width + || location.X >= App?.Screen.Width || location.Y < 0 - || location.Y >= Application.Screen.Height) + || location.Y >= App?.Screen.Height) { return Attribute.Default; } @@ -170,8 +170,8 @@ internal class ShadowView : View // use the Normal attribute from the View under the shadow. if (newAttribute.Background == Color.DarkGray) { - List currentViewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettingsFlags.Transparent); - View? underView = currentViewsUnderMouse!.LastOrDefault (); + List currentViewsUnderMouse = GetViewsUnderLocation (location, ViewportSettingsFlags.Transparent); + View? underView = currentViewsUnderMouse.LastOrDefault (); attr = underView?.GetAttributeForRole (VisualRole.Normal) ?? Attribute.Default; newAttribute = new ( diff --git a/Terminal.Gui/ViewBase/DrawAdornmentsEventArgs.cs b/Terminal.Gui/ViewBase/DrawAdornmentsEventArgs.cs index 97092cf91..4fc8b826b 100644 --- a/Terminal.Gui/ViewBase/DrawAdornmentsEventArgs.cs +++ b/Terminal.Gui/ViewBase/DrawAdornmentsEventArgs.cs @@ -1,5 +1,4 @@ -#nullable enable -namespace Terminal.Gui.ViewBase; +namespace Terminal.Gui.ViewBase; /// /// Provides data for events that allow cancellation of adornment drawing in the Cancellable Work Pattern (CWP). diff --git a/Terminal.Gui/ViewBase/DrawContext.cs b/Terminal.Gui/ViewBase/DrawContext.cs index 95eec9a2e..e6df3033b 100644 --- a/Terminal.Gui/ViewBase/DrawContext.cs +++ b/Terminal.Gui/ViewBase/DrawContext.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/DrawEventArgs.cs b/Terminal.Gui/ViewBase/DrawEventArgs.cs index f00bdb618..68be3544c 100644 --- a/Terminal.Gui/ViewBase/DrawEventArgs.cs +++ b/Terminal.Gui/ViewBase/DrawEventArgs.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.ComponentModel; +using System.ComponentModel; namespace Terminal.Gui.ViewBase; diff --git a/Terminal.Gui/ViewBase/EnumExtensions/AddOrSubtractExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/AddOrSubtractExtensions.cs index eef2b4372..65ee7fd9e 100644 --- a/Terminal.Gui/ViewBase/EnumExtensions/AddOrSubtractExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/AddOrSubtractExtensions.cs @@ -1,4 +1,3 @@ -#nullable enable using System.CodeDom.Compiler; using System.Diagnostics; diff --git a/Terminal.Gui/ViewBase/EnumExtensions/AlignmentExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/AlignmentExtensions.cs index e94e6b93e..b6c2b05d4 100644 --- a/Terminal.Gui/ViewBase/EnumExtensions/AlignmentExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/AlignmentExtensions.cs @@ -1,4 +1,3 @@ -#nullable enable using System.CodeDom.Compiler; using System.Diagnostics; diff --git a/Terminal.Gui/ViewBase/EnumExtensions/AlignmentModesExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/AlignmentModesExtensions.cs index da91e93df..b129642f0 100644 --- a/Terminal.Gui/ViewBase/EnumExtensions/AlignmentModesExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/AlignmentModesExtensions.cs @@ -1,4 +1,3 @@ -#nullable enable using System.CodeDom.Compiler; using System.Diagnostics; diff --git a/Terminal.Gui/ViewBase/EnumExtensions/BorderSettingsExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/BorderSettingsExtensions.cs index b908950d6..c01b5b9b5 100644 --- a/Terminal.Gui/ViewBase/EnumExtensions/BorderSettingsExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/BorderSettingsExtensions.cs @@ -1,4 +1,4 @@ -#nullable enable + using System.CodeDom.Compiler; using System.Diagnostics; diff --git a/Terminal.Gui/ViewBase/EnumExtensions/DimAutoStyleExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/DimAutoStyleExtensions.cs index edccb473e..3633cc5e8 100644 --- a/Terminal.Gui/ViewBase/EnumExtensions/DimAutoStyleExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/DimAutoStyleExtensions.cs @@ -1,4 +1,3 @@ -#nullable enable using System.CodeDom.Compiler; using System.Diagnostics; diff --git a/Terminal.Gui/ViewBase/EnumExtensions/DimPercentModeExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/DimPercentModeExtensions.cs index f6a62db75..0eac30890 100644 --- a/Terminal.Gui/ViewBase/EnumExtensions/DimPercentModeExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/DimPercentModeExtensions.cs @@ -1,4 +1,3 @@ -#nullable enable using System.CodeDom.Compiler; using System.Diagnostics; diff --git a/Terminal.Gui/ViewBase/EnumExtensions/DimensionExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/DimensionExtensions.cs index 0a217e1a8..7d34f36ad 100644 --- a/Terminal.Gui/ViewBase/EnumExtensions/DimensionExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/DimensionExtensions.cs @@ -1,4 +1,3 @@ -#nullable enable using System.CodeDom.Compiler; using System.Diagnostics; diff --git a/Terminal.Gui/ViewBase/EnumExtensions/SideExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/SideExtensions.cs index f7a2a548f..cbf67f18d 100644 --- a/Terminal.Gui/ViewBase/EnumExtensions/SideExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/SideExtensions.cs @@ -1,4 +1,3 @@ -#nullable enable using System.CodeDom.Compiler; using System.Diagnostics; diff --git a/Terminal.Gui/ViewBase/EnumExtensions/ViewDiagnosticFlagsExtensions.cs b/Terminal.Gui/ViewBase/EnumExtensions/ViewDiagnosticFlagsExtensions.cs index e0d089184..400d2d081 100644 --- a/Terminal.Gui/ViewBase/EnumExtensions/ViewDiagnosticFlagsExtensions.cs +++ b/Terminal.Gui/ViewBase/EnumExtensions/ViewDiagnosticFlagsExtensions.cs @@ -1,4 +1,3 @@ -#nullable enable using System.CodeDom.Compiler; using System.Diagnostics; diff --git a/Terminal.Gui/ViewBase/Helpers/StackExtensions.cs b/Terminal.Gui/ViewBase/Helpers/StackExtensions.cs index 96201df73..e76788029 100644 --- a/Terminal.Gui/ViewBase/Helpers/StackExtensions.cs +++ b/Terminal.Gui/ViewBase/Helpers/StackExtensions.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.ViewBase; /// Extension of helper to work with specific diff --git a/Terminal.Gui/ViewBase/IDesignable.cs b/Terminal.Gui/ViewBase/IDesignable.cs index 382bdd91b..c7625d079 100644 --- a/Terminal.Gui/ViewBase/IDesignable.cs +++ b/Terminal.Gui/ViewBase/IDesignable.cs @@ -9,10 +9,10 @@ public interface IDesignable /// Causes the View to enable design-time mode. This typically means that the view will load demo data and /// be configured to allow for design-time manipulation. /// - /// Optional arbitrary, View-specific, context. - /// A non-null type for . + /// + /// A non-null type for . /// if the view successfully loaded demo data. - public bool EnableForDesign (ref TContext context) where TContext : notnull => EnableForDesign (); + public bool EnableForDesign (ref TContext targetView) where TContext : notnull => EnableForDesign (); /// /// Causes the View to enable design-time mode. This typically means that the view will load demo data and diff --git a/Terminal.Gui/ViewBase/IMouseHeldDown.cs b/Terminal.Gui/ViewBase/IMouseHeldDown.cs index 5f7435793..d0233fcd3 100644 --- a/Terminal.Gui/ViewBase/IMouseHeldDown.cs +++ b/Terminal.Gui/ViewBase/IMouseHeldDown.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.ComponentModel; +using System.ComponentModel; namespace Terminal.Gui.ViewBase; diff --git a/Terminal.Gui/ViewBase/Layout/Aligner.cs b/Terminal.Gui/ViewBase/Layout/Aligner.cs index 72aae7ad5..c3907bf92 100644 --- a/Terminal.Gui/ViewBase/Layout/Aligner.cs +++ b/Terminal.Gui/ViewBase/Layout/Aligner.cs @@ -1,3 +1,4 @@ +#nullable disable using System.ComponentModel; namespace Terminal.Gui.ViewBase; diff --git a/Terminal.Gui/ViewBase/Layout/Dim.cs b/Terminal.Gui/ViewBase/Layout/Dim.cs index a3326e80a..8952b980a 100644 --- a/Terminal.Gui/ViewBase/Layout/Dim.cs +++ b/Terminal.Gui/ViewBase/Layout/Dim.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; using System.Numerics; @@ -188,18 +187,18 @@ public abstract record Dim : IEqualityOperators /// - /// Indicates whether the specified type is in the hierarchy of this Dim object. + /// Indicates whether the specified type is in the hierarchy of this Dim object. /// /// A reference to this instance. /// - public bool Has (out T dim) where T : Dim + public bool Has (out TDim dim) where TDim : Dim { - dim = (this as T)!; + dim = (this as TDim)!; return this switch { - DimCombine combine => combine.Left.Has (out dim) || combine.Right.Has (out dim), - T => true, + DimCombine combine => combine.Left.Has (out dim) || combine.Right.Has (out dim), + TDim => true, _ => false }; } diff --git a/Terminal.Gui/ViewBase/Layout/DimAbsolute.cs b/Terminal.Gui/ViewBase/Layout/DimAbsolute.cs index 6fd9e8072..f630b3470 100644 --- a/Terminal.Gui/ViewBase/Layout/DimAbsolute.cs +++ b/Terminal.Gui/ViewBase/Layout/DimAbsolute.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/DimAuto.cs b/Terminal.Gui/ViewBase/Layout/DimAuto.cs index b70aca542..1436eb9bc 100644 --- a/Terminal.Gui/ViewBase/Layout/DimAuto.cs +++ b/Terminal.Gui/ViewBase/Layout/DimAuto.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; namespace Terminal.Gui.ViewBase; @@ -31,8 +30,10 @@ public record DimAuto (Dim? MaximumContentDim, Dim? MinimumContentDim, DimAutoSt var textSize = 0; var maxCalculatedSize = 0; + // 2048 x 2048 supports unit testing where no App is running. + Size screenSize = us.App?.Screen.Size ?? new (2048, 2048); int autoMin = MinimumContentDim?.GetAnchor (superviewContentSize) ?? 0; - int screenX4 = dimension == Dimension.Width ? Application.Screen.Width * 4 : Application.Screen.Height * 4; + int screenX4 = dimension == Dimension.Width ? screenSize.Width * 4 : screenSize.Height * 4; int autoMax = MaximumContentDim?.GetAnchor (superviewContentSize) ?? screenX4; //Debug.WriteLineIf (autoMin > autoMax, "MinimumContentDim must be less than or equal to MaximumContentDim."); diff --git a/Terminal.Gui/ViewBase/Layout/DimAutoStyle.cs b/Terminal.Gui/ViewBase/Layout/DimAutoStyle.cs index d3080dd94..ddd6e0ee5 100644 --- a/Terminal.Gui/ViewBase/Layout/DimAutoStyle.cs +++ b/Terminal.Gui/ViewBase/Layout/DimAutoStyle.cs @@ -1,5 +1,3 @@ - - namespace Terminal.Gui.ViewBase; /// @@ -45,4 +43,4 @@ public enum DimAutoStyle /// corresponding dimension /// Auto = Content | Text, -} \ No newline at end of file +} diff --git a/Terminal.Gui/ViewBase/Layout/DimCombine.cs b/Terminal.Gui/ViewBase/Layout/DimCombine.cs index 3bf3b3534..b246d88bb 100644 --- a/Terminal.Gui/ViewBase/Layout/DimCombine.cs +++ b/Terminal.Gui/ViewBase/Layout/DimCombine.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/DimFill.cs b/Terminal.Gui/ViewBase/Layout/DimFill.cs index 0e278cbc5..feda107a0 100644 --- a/Terminal.Gui/ViewBase/Layout/DimFill.cs +++ b/Terminal.Gui/ViewBase/Layout/DimFill.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/DimFunc.cs b/Terminal.Gui/ViewBase/Layout/DimFunc.cs index 0773dc316..678406a9b 100644 --- a/Terminal.Gui/ViewBase/Layout/DimFunc.cs +++ b/Terminal.Gui/ViewBase/Layout/DimFunc.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/DimPercent.cs b/Terminal.Gui/ViewBase/Layout/DimPercent.cs index 499ffb6fd..2b9ade3b3 100644 --- a/Terminal.Gui/ViewBase/Layout/DimPercent.cs +++ b/Terminal.Gui/ViewBase/Layout/DimPercent.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/DimPercentMode.cs b/Terminal.Gui/ViewBase/Layout/DimPercentMode.cs index 3f9aed836..bdb458d38 100644 --- a/Terminal.Gui/ViewBase/Layout/DimPercentMode.cs +++ b/Terminal.Gui/ViewBase/Layout/DimPercentMode.cs @@ -1,5 +1,3 @@ - - namespace Terminal.Gui.ViewBase; /// @@ -16,4 +14,4 @@ public enum DimPercentMode /// The dimension is computed using the View's . /// ContentSize = 1 -} \ No newline at end of file +} diff --git a/Terminal.Gui/ViewBase/Layout/DimView.cs b/Terminal.Gui/ViewBase/Layout/DimView.cs index 0a25e1983..fec551d67 100644 --- a/Terminal.Gui/ViewBase/Layout/DimView.cs +++ b/Terminal.Gui/ViewBase/Layout/DimView.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/Dimension.cs b/Terminal.Gui/ViewBase/Layout/Dimension.cs index 5fae94360..60fbcaea6 100644 --- a/Terminal.Gui/ViewBase/Layout/Dimension.cs +++ b/Terminal.Gui/ViewBase/Layout/Dimension.cs @@ -1,5 +1,3 @@ - - namespace Terminal.Gui.ViewBase; /// @@ -21,4 +19,4 @@ public enum Dimension /// The width dimension. /// Width = 2 -} \ No newline at end of file +} diff --git a/Terminal.Gui/ViewBase/Layout/LayoutException.cs b/Terminal.Gui/ViewBase/Layout/LayoutException.cs index e21dc51f8..176f26982 100644 --- a/Terminal.Gui/ViewBase/Layout/LayoutException.cs +++ b/Terminal.Gui/ViewBase/Layout/LayoutException.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/Pos.cs b/Terminal.Gui/ViewBase/Layout/Pos.cs index 09694adc3..1e6e00688 100644 --- a/Terminal.Gui/ViewBase/Layout/Pos.cs +++ b/Terminal.Gui/ViewBase/Layout/Pos.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; @@ -334,18 +333,18 @@ public abstract record Pos internal virtual bool ReferencesOtherViews () { return false; } /// - /// Indicates whether the specified type is in the hierarchy of this Pos object. + /// Indicates whether the specified type is in the hierarchy of this Pos object. /// /// A reference to this instance. /// - public bool Has (out T pos) where T : Pos + public bool Has (out TPos pos) where TPos : Pos { - pos = (this as T)!; + pos = (this as TPos)!; return this switch { - PosCombine combine => combine.Left.Has (out pos) || combine.Right.Has (out pos), - T => true, + PosCombine combine => combine.Left.Has (out pos) || combine.Right.Has (out pos), + TPos => true, _ => false }; } diff --git a/Terminal.Gui/ViewBase/Layout/PosAbsolute.cs b/Terminal.Gui/ViewBase/Layout/PosAbsolute.cs index b21711355..494c63a50 100644 --- a/Terminal.Gui/ViewBase/Layout/PosAbsolute.cs +++ b/Terminal.Gui/ViewBase/Layout/PosAbsolute.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/PosAlign.cs b/Terminal.Gui/ViewBase/Layout/PosAlign.cs index 4d72cc9af..d6289e510 100644 --- a/Terminal.Gui/ViewBase/Layout/PosAlign.cs +++ b/Terminal.Gui/ViewBase/Layout/PosAlign.cs @@ -1,4 +1,3 @@ -#nullable enable using System.ComponentModel; diff --git a/Terminal.Gui/ViewBase/Layout/PosAnchorEnd.cs b/Terminal.Gui/ViewBase/Layout/PosAnchorEnd.cs index 3cf2195ac..d7c6d30a7 100644 --- a/Terminal.Gui/ViewBase/Layout/PosAnchorEnd.cs +++ b/Terminal.Gui/ViewBase/Layout/PosAnchorEnd.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/PosCenter.cs b/Terminal.Gui/ViewBase/Layout/PosCenter.cs index 4a7945cd2..d1584f8e5 100644 --- a/Terminal.Gui/ViewBase/Layout/PosCenter.cs +++ b/Terminal.Gui/ViewBase/Layout/PosCenter.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/PosCombine.cs b/Terminal.Gui/ViewBase/Layout/PosCombine.cs index 833b499f0..1be5325c2 100644 --- a/Terminal.Gui/ViewBase/Layout/PosCombine.cs +++ b/Terminal.Gui/ViewBase/Layout/PosCombine.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/PosFunc.cs b/Terminal.Gui/ViewBase/Layout/PosFunc.cs index 3900beb46..078459fd9 100644 --- a/Terminal.Gui/ViewBase/Layout/PosFunc.cs +++ b/Terminal.Gui/ViewBase/Layout/PosFunc.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/PosPercent.cs b/Terminal.Gui/ViewBase/Layout/PosPercent.cs index 98505dd3b..08d968210 100644 --- a/Terminal.Gui/ViewBase/Layout/PosPercent.cs +++ b/Terminal.Gui/ViewBase/Layout/PosPercent.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; /// diff --git a/Terminal.Gui/ViewBase/Layout/PosView.cs b/Terminal.Gui/ViewBase/Layout/PosView.cs index fb7f7266a..d42e8cb10 100644 --- a/Terminal.Gui/ViewBase/Layout/PosView.cs +++ b/Terminal.Gui/ViewBase/Layout/PosView.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; namespace Terminal.Gui.ViewBase; diff --git a/Terminal.Gui/ViewBase/Layout/Side.cs b/Terminal.Gui/ViewBase/Layout/Side.cs index b2256faac..0cc52f064 100644 --- a/Terminal.Gui/ViewBase/Layout/Side.cs +++ b/Terminal.Gui/ViewBase/Layout/Side.cs @@ -1,5 +1,3 @@ - - namespace Terminal.Gui.ViewBase; /// @@ -27,4 +25,4 @@ public enum Side /// The bottom (Y + Height) side of the view. /// Bottom = 3 -} \ No newline at end of file +} diff --git a/Terminal.Gui/ViewBase/Layout/SuperViewChangedEventArgs.cs b/Terminal.Gui/ViewBase/Layout/SuperViewChangedEventArgs.cs index f1e79536d..611949a94 100644 --- a/Terminal.Gui/ViewBase/Layout/SuperViewChangedEventArgs.cs +++ b/Terminal.Gui/ViewBase/Layout/SuperViewChangedEventArgs.cs @@ -9,17 +9,17 @@ public class SuperViewChangedEventArgs : EventArgs /// Creates a new instance of the class. /// /// - public SuperViewChangedEventArgs (View superView, View subView) + public SuperViewChangedEventArgs (View? superView, View? subView) { SuperView = superView; SubView = subView; } /// The view that is having it's changed - public View SubView { get; } + public View? SubView { get; } /// /// The parent. For this is the old parent (new parent now being null). /// - public View SuperView { get; } + public View? SuperView { get; } } diff --git a/Terminal.Gui/ViewBase/MouseHeldDown.cs b/Terminal.Gui/ViewBase/MouseHeldDown.cs index ff0764733..f902980a3 100644 --- a/Terminal.Gui/ViewBase/MouseHeldDown.cs +++ b/Terminal.Gui/ViewBase/MouseHeldDown.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.ComponentModel; +using System.ComponentModel; namespace Terminal.Gui.ViewBase; diff --git a/Terminal.Gui/ViewBase/Navigation/FocusEventArgs.cs b/Terminal.Gui/ViewBase/Navigation/FocusEventArgs.cs index 55cc41c6e..d58c68ee3 100644 --- a/Terminal.Gui/ViewBase/Navigation/FocusEventArgs.cs +++ b/Terminal.Gui/ViewBase/Navigation/FocusEventArgs.cs @@ -10,16 +10,15 @@ public class HasFocusEventArgs : CancelEventArgs /// The value will have if the event is not cancelled. /// The view that is losing focus. /// The view that is gaining focus. - public HasFocusEventArgs (bool currentHasFocus, bool newHasFocus, View currentFocused, View newFocused) : base (ref currentHasFocus, ref newHasFocus) + public HasFocusEventArgs (bool currentHasFocus, bool newHasFocus, View? currentFocused, View? newFocused) : base (ref currentHasFocus, ref newHasFocus) { CurrentFocused = currentFocused; NewFocused = newFocused; } /// Gets or sets the view that is losing focus. - public View CurrentFocused { get; set; } + public View? CurrentFocused { get; set; } /// Gets or sets the view that is gaining focus. - public View NewFocused { get; set; } - -} \ No newline at end of file + public View? NewFocused { get; set; } +} diff --git a/Terminal.Gui/ViewBase/Orientation/IOrientation.cs b/Terminal.Gui/ViewBase/Orientation/IOrientation.cs index 4f86d21dd..c56a0cfe5 100644 --- a/Terminal.Gui/ViewBase/Orientation/IOrientation.cs +++ b/Terminal.Gui/ViewBase/Orientation/IOrientation.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.ViewBase; using System; @@ -40,4 +40,4 @@ public interface IOrientation /// /// public void OnOrientationChanged (Orientation newOrientation) { return; } -} \ No newline at end of file +} diff --git a/Terminal.Gui/ViewBase/Orientation/Orientation.cs b/Terminal.Gui/ViewBase/Orientation/Orientation.cs index fa4c766ee..5c847f57a 100644 --- a/Terminal.Gui/ViewBase/Orientation/Orientation.cs +++ b/Terminal.Gui/ViewBase/Orientation/Orientation.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.ViewBase; /// Direction of an element (horizontal or vertical) diff --git a/Terminal.Gui/ViewBase/Orientation/OrientationHelper.cs b/Terminal.Gui/ViewBase/Orientation/OrientationHelper.cs index a7079128c..dfd8a3d44 100644 --- a/Terminal.Gui/ViewBase/Orientation/OrientationHelper.cs +++ b/Terminal.Gui/ViewBase/Orientation/OrientationHelper.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.ViewBase; diff --git a/Terminal.Gui/ViewBase/Runnable/Runnable.cs b/Terminal.Gui/ViewBase/Runnable/Runnable.cs new file mode 100644 index 000000000..018cbf087 --- /dev/null +++ b/Terminal.Gui/ViewBase/Runnable/Runnable.cs @@ -0,0 +1,220 @@ +namespace Terminal.Gui.ViewBase; + +/// +/// Base implementation of for views that can be run as blocking sessions without returning a result. +/// +/// +/// +/// Views that don't need to return a result can derive from this class instead of . +/// +/// +/// This class provides default implementations of the interface +/// following the Terminal.Gui Cancellable Work Pattern (CWP). +/// +/// +/// For views that need to return a result, use instead. +/// +/// +public class Runnable : View, IRunnable +{ + // Cached state - eliminates race conditions from stack queries + private bool _isRunning; + private bool _isModal; + + /// + /// Constructs a new instance of the class. + /// + public Runnable () + { + CanFocus = true; + TabStop = TabBehavior.TabGroup; + Arrangement = ViewArrangement.Overlapped; + Width = Dim.Fill (); + Height = Dim.Fill (); + SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Runnable); + } + + /// + public object? Result { get; set; } + + #region IRunnable Implementation - IsRunning (from base interface) + + /// + public void SetApp (IApplication app) + { + App = app; + } + + /// + public bool IsRunning => _isRunning; + + /// + public void SetIsRunning (bool value) { _isRunning = value; } + + /// + public virtual void RequestStop () + { + // Use the IRunnable-specific RequestStop if the App supports it + App?.RequestStop (this); + } + + /// + public bool RaiseIsRunningChanging (bool oldIsRunning, bool newIsRunning) + { + // Clear previous result when starting (for non-generic Runnable) + // Derived Runnable will clear its typed Result in OnIsRunningChanging override + if (newIsRunning) + { + Result = null; + } + + // CWP Phase 1: Virtual method (pre-notification) + if (OnIsRunningChanging (oldIsRunning, newIsRunning)) + { + return true; // Canceled + } + + // CWP Phase 2: Event notification + bool newValue = newIsRunning; + CancelEventArgs args = new (in oldIsRunning, ref newValue); + IsRunningChanging?.Invoke (this, args); + + return args.Cancel; + } + + /// + public event EventHandler>? IsRunningChanging; + + /// + public void RaiseIsRunningChangedEvent (bool newIsRunning) + { + // Initialize if needed when starting + if (newIsRunning && !IsInitialized) + { + BeginInit (); + EndInit (); + // Initialized event is raised by View.EndInit() + } + + // CWP Phase 3: Post-notification (work already done by Application.Begin/End) + OnIsRunningChanged (newIsRunning); + + EventArgs args = new (newIsRunning); + IsRunningChanged?.Invoke (this, args); + } + + /// + public event EventHandler>? IsRunningChanged; + + /// + /// Called before event. Override to cancel state change or perform cleanup. + /// + /// The current value of . + /// The new value of (true = starting, false = stopping). + /// to cancel; to proceed. + /// + /// + /// Default implementation returns (allow change). + /// + /// + /// IMPORTANT: When is (stopping), this is the ideal + /// place to perform cleanup or validation before the runnable is removed from the stack. + /// + /// + /// + /// protected override bool OnIsRunningChanging (bool oldIsRunning, bool newIsRunning) + /// { + /// if (!newIsRunning) // Stopping + /// { + /// // Check if user wants to save first + /// if (HasUnsavedChanges ()) + /// { + /// int result = MessageBox.Query (App, "Save?", "Save changes?", "Yes", "No", "Cancel"); + /// if (result == 2) return true; // Cancel stopping + /// if (result == 0) Save (); + /// } + /// } + /// + /// return base.OnIsRunningChanging (oldIsRunning, newIsRunning); + /// } + /// + /// + /// + protected virtual bool OnIsRunningChanging (bool oldIsRunning, bool newIsRunning) => false; + + /// + /// Called after has changed. Override for post-state-change logic. + /// + /// The new value of (true = started, false = stopped). + /// + /// Default implementation does nothing. Overrides should call base to ensure extensibility. + /// + protected virtual void OnIsRunningChanged (bool newIsRunning) + { + // Default: no-op + } + + #endregion + + #region IRunnable Implementation - IsModal (from base interface) + + /// + public bool IsModal => _isModal; + + /// + public void SetIsModal (bool value) { _isModal = value; } + + /// + public bool StopRequested { get; set; } + + /// + public void RaiseIsModalChangedEvent (bool newIsModal) + { + // CWP Phase 3: Post-notification (work already done by Application) + OnIsModalChanged (newIsModal); + + EventArgs args = new (newIsModal); + IsModalChanged?.Invoke (this, args); + + // Layout may need to change when modal state changes + SetNeedsLayout (); + SetNeedsDraw (); + + if (newIsModal) + { + // Set focus to self if becoming modal + if (HasFocus is false) + { + SetFocus (); + } + + // Position cursor and update driver + if (App?.PositionCursor () == true) + { + App?.Driver?.UpdateCursor (); + } + } + } + + /// + public event EventHandler>? IsModalChanged; + + /// + /// Called after has changed. Override for post-activation logic. + /// + /// The new value of (true = became modal, false = no longer modal). + /// + /// + /// Default implementation does nothing. Overrides should call base to ensure extensibility. + /// + /// + /// Common uses: setting focus when becoming modal, updating UI state. + /// + /// + protected virtual void OnIsModalChanged (bool newIsModal) + { + // Default: no-op + } + + #endregion +} diff --git a/Terminal.Gui/ViewBase/Runnable/RunnableTResult.cs b/Terminal.Gui/ViewBase/Runnable/RunnableTResult.cs new file mode 100644 index 000000000..44245b235 --- /dev/null +++ b/Terminal.Gui/ViewBase/Runnable/RunnableTResult.cs @@ -0,0 +1,54 @@ +namespace Terminal.Gui.ViewBase; + +/// +/// Base implementation of for views that can be run as blocking sessions. +/// +/// The type of result data returned when the session completes. +/// +/// +/// Views can derive from this class or implement directly. +/// +/// +/// This class provides default implementations of the interface +/// following the Terminal.Gui Cancellable Work Pattern (CWP). +/// +/// +/// For views that don't need to return a result, use instead. +/// +/// +/// This class inherits from to avoid code duplication and ensure consistent behavior. +/// +/// +public class Runnable : Runnable, IRunnable +{ + /// + /// Constructs a new instance of the class. + /// + public Runnable () + { + // Base constructor handles common initialization + } + + /// + public new TResult? Result + { + get => base.Result is TResult typedValue ? typedValue : default; + set => base.Result = value; + } + + /// + /// Override to clear typed result when starting. + /// Called by base before events are raised. + /// + protected override bool OnIsRunningChanging (bool oldIsRunning, bool newIsRunning) + { + // Clear previous typed result when starting + if (newIsRunning) + { + Result = default; + } + + // Call base implementation to allow further customization + return base.OnIsRunningChanging (oldIsRunning, newIsRunning); + } +} diff --git a/Terminal.Gui/ViewBase/Runnable/RunnableWrapper.cs b/Terminal.Gui/ViewBase/Runnable/RunnableWrapper.cs new file mode 100644 index 000000000..bf10b4c0f --- /dev/null +++ b/Terminal.Gui/ViewBase/Runnable/RunnableWrapper.cs @@ -0,0 +1,91 @@ +namespace Terminal.Gui.ViewBase; + +/// +/// Wraps any to make it runnable with a typed result, similar to how +/// wraps . +/// +/// The type of view being wrapped. +/// The type of result data returned when the session completes. +/// +/// +/// This class enables any View to be run as a blocking session with +/// +/// without requiring the View to implement or derive from +/// . +/// +/// +/// Use for a fluent API approach, +/// or to run directly. +/// +/// +/// +/// // Wrap a TextField to make it runnable with string result +/// var textField = new TextField { Width = 40 }; +/// var runnable = new RunnableWrapper<TextField, string> { WrappedView = textField }; +/// +/// // Extract result when stopping +/// runnable.IsRunningChanging += (s, e) => +/// { +/// if (!e.NewValue) // Stopping +/// { +/// runnable.Result = runnable.WrappedView.Text; +/// } +/// }; +/// +/// app.Run(runnable); +/// Console.WriteLine($"User entered: {runnable.Result}"); +/// runnable.Dispose(); +/// +/// +/// +public class RunnableWrapper : Runnable where TView : View +{ + /// + /// Initializes a new instance of . + /// + public RunnableWrapper () + { + // Make the wrapper automatically size to fit the wrapped view + Width = Dim.Fill (); + Height = Dim.Fill (); + } + + private TView? _wrappedView; + + /// + /// Gets or sets the wrapped view that is being made runnable. + /// + /// + /// + /// This property must be set before the wrapper is initialized. + /// Access this property to interact with the original view, extract its state, + /// or configure result extraction logic. + /// + /// + /// Thrown if the property is set after initialization. + public required TView WrappedView + { + get => _wrappedView ?? throw new InvalidOperationException ("WrappedView must be set before use."); + init + { + if (IsInitialized) + { + throw new InvalidOperationException ("WrappedView cannot be changed after initialization."); + } + + _wrappedView = value; + } + } + + /// + public override void EndInit () + { + base.EndInit (); + + // Add the wrapped view as a subview after initialization + if (_wrappedView is { }) + { + Add (_wrappedView); + } + } +} diff --git a/Terminal.Gui/ViewBase/Runnable/ViewRunnableExtensions.cs b/Terminal.Gui/ViewBase/Runnable/ViewRunnableExtensions.cs new file mode 100644 index 000000000..7b12bb055 --- /dev/null +++ b/Terminal.Gui/ViewBase/Runnable/ViewRunnableExtensions.cs @@ -0,0 +1,126 @@ +namespace Terminal.Gui.ViewBase; + +/// +/// Extension methods for making any runnable with typed results. +/// +/// +/// These extensions provide a fluent API for wrapping views in , +/// enabling any View to be run as a blocking session without implementing . +/// +public static class ViewRunnableExtensions +{ + /// + /// Converts any View into a runnable with typed result extraction. + /// + /// The type of view to make runnable. + /// The type of result data to extract. + /// The view to wrap. Cannot be null. + /// + /// Function that extracts the result from the view when stopping. + /// Called automatically when the runnable session ends. + /// + /// A that wraps the view. + /// Thrown if or is null. + /// + /// + /// This method wraps the view in a and automatically + /// subscribes to to extract the result when the session stops. + /// + /// + /// The result is extracted before the view is disposed, ensuring all data is still accessible. + /// + /// + /// + /// + /// // Make a TextField runnable with string result + /// var runnable = new TextField { Width = 40 } + /// .AsRunnable(tf => tf.Text); + /// + /// app.Run(runnable); + /// Console.WriteLine($"User entered: {runnable.Result}"); + /// runnable.Dispose(); + /// + /// // Make a ColorPicker runnable with Color? result + /// var colorRunnable = new ColorPicker() + /// .AsRunnable(cp => cp.SelectedColor); + /// + /// app.Run(colorRunnable); + /// Console.WriteLine($"Selected: {colorRunnable.Result}"); + /// colorRunnable.Dispose(); + /// + /// // Make a FlagSelector runnable with enum result + /// var flagsRunnable = new FlagSelector<SelectorStyles>() + /// .AsRunnable(fs => fs.Value); + /// + /// app.Run(flagsRunnable); + /// Console.WriteLine($"Selected styles: {flagsRunnable.Result}"); + /// flagsRunnable.Dispose(); + /// + /// + public static RunnableWrapper AsRunnable ( + this TView view, + Func resultExtractor) + where TView : View + { + if (view is null) + { + throw new ArgumentNullException (nameof (view)); + } + + if (resultExtractor is null) + { + throw new ArgumentNullException (nameof (resultExtractor)); + } + + var wrapper = new RunnableWrapper { WrappedView = view }; + + // Subscribe to IsRunningChanging to extract result when stopping + wrapper.IsRunningChanging += (s, e) => + { + if (!e.NewValue) // Stopping + { + wrapper.Result = resultExtractor (view); + } + }; + + return wrapper; + } + + /// + /// Converts any View into a runnable without result extraction. + /// + /// The type of view to make runnable. + /// The view to wrap. Cannot be null. + /// A that wraps the view. + /// Thrown if is null. + /// + /// + /// Use this overload when you don't need to extract a typed result, but still want to + /// run the view as a blocking session. The wrapped view can still be accessed via + /// after running. + /// + /// + /// + /// + /// // Make a view runnable without result extraction + /// var colorPicker = new ColorPicker(); + /// var runnable = colorPicker.AsRunnable(); + /// + /// app.Run(runnable); + /// + /// // Access the wrapped view directly to get the result + /// Console.WriteLine($"Selected: {runnable.WrappedView.SelectedColor}"); + /// runnable.Dispose(); + /// + /// + public static RunnableWrapper AsRunnable (this TView view) + where TView : View + { + if (view is null) + { + throw new ArgumentNullException (nameof (view)); + } + + return new RunnableWrapper { WrappedView = view }; + } +} diff --git a/Terminal.Gui/ViewBase/View.Adornments.cs b/Terminal.Gui/ViewBase/View.Adornments.cs index de0ca20a1..97d2da40c 100644 --- a/Terminal.Gui/ViewBase/View.Adornments.cs +++ b/Terminal.Gui/ViewBase/View.Adornments.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.ViewBase; public partial class View // Adornments diff --git a/Terminal.Gui/ViewBase/View.Arrangement.cs b/Terminal.Gui/ViewBase/View.Arrangement.cs index dba4f6c83..58323f11a 100644 --- a/Terminal.Gui/ViewBase/View.Arrangement.cs +++ b/Terminal.Gui/ViewBase/View.Arrangement.cs @@ -1,5 +1,4 @@ -#nullable enable -namespace Terminal.Gui.ViewBase; +namespace Terminal.Gui.ViewBase; public partial class View { diff --git a/Terminal.Gui/ViewBase/View.Command.cs b/Terminal.Gui/ViewBase/View.Command.cs index 0c3a741ac..ca8de67a1 100644 --- a/Terminal.Gui/ViewBase/View.Command.cs +++ b/Terminal.Gui/ViewBase/View.Command.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.ViewBase; public partial class View // Command APIs diff --git a/Terminal.Gui/ViewBase/View.Content.cs b/Terminal.Gui/ViewBase/View.Content.cs index cbb29308a..8d6345a65 100644 --- a/Terminal.Gui/ViewBase/View.Content.cs +++ b/Terminal.Gui/ViewBase/View.Content.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.ViewBase; public partial class View diff --git a/Terminal.Gui/ViewBase/View.Cursor.cs b/Terminal.Gui/ViewBase/View.Cursor.cs index daaf75d69..d710a273e 100644 --- a/Terminal.Gui/ViewBase/View.Cursor.cs +++ b/Terminal.Gui/ViewBase/View.Cursor.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; diff --git a/Terminal.Gui/ViewBase/View.Diagnostics.cs b/Terminal.Gui/ViewBase/View.Diagnostics.cs index d920ef4bf..07379c5dc 100644 --- a/Terminal.Gui/ViewBase/View.Diagnostics.cs +++ b/Terminal.Gui/ViewBase/View.Diagnostics.cs @@ -1,8 +1,8 @@ -#nullable enable -namespace Terminal.Gui.ViewBase; +namespace Terminal.Gui.ViewBase; public partial class View { + // TODO: Make this a configuration property /// Gets or sets whether diagnostic information will be drawn. This is a bit-field of .e diagnostics. /// /// diff --git a/Terminal.Gui/ViewBase/View.Drawing.Attribute.cs b/Terminal.Gui/ViewBase/View.Drawing.Attribute.cs index b43a426d2..075b461f4 100644 --- a/Terminal.Gui/ViewBase/View.Drawing.Attribute.cs +++ b/Terminal.Gui/ViewBase/View.Drawing.Attribute.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.ComponentModel; +using System.ComponentModel; namespace Terminal.Gui.ViewBase; @@ -105,7 +104,7 @@ public partial class View /// /// Selects the specified Attribute - /// as the Attribute to use for subsequent calls to and . + /// as the Attribute to use for subsequent calls to and . /// /// THe Attribute to set. /// The previously set Attribute. @@ -113,7 +112,7 @@ public partial class View /// /// Selects the Attribute associated with the specified - /// as the Attribute to use for subsequent calls to and . + /// as the Attribute to use for subsequent calls to and . /// /// Calls to get the Attribute associated with the specified role, which will /// raise /. diff --git a/Terminal.Gui/ViewBase/View.Drawing.Clipping.cs b/Terminal.Gui/ViewBase/View.Drawing.Clipping.cs index 49a0e1fe3..6a5bbeb67 100644 --- a/Terminal.Gui/ViewBase/View.Drawing.Clipping.cs +++ b/Terminal.Gui/ViewBase/View.Drawing.Clipping.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.ViewBase; public partial class View @@ -16,7 +15,7 @@ public partial class View /// /// /// The current Clip. - public static Region? GetClip () { return Application.Driver?.Clip; } + public Region? GetClip () => Driver?.Clip; /// /// Sets the Clip to the specified region. @@ -28,11 +27,13 @@ public partial class View /// /// /// - public static void SetClip (Region? region) + public void SetClip (Region? region) { - if (Application.Driver is { } && region is { }) + // BUGBUG: If region is null we should set the clip to null. + // BUGBUG: Fixing this probably breaks other things. + if (Driver is { } && region is { }) { - Application.Driver.Clip = region; + Driver.Clip = region; } } @@ -51,13 +52,13 @@ public partial class View /// /// The current Clip, which can be then re-applied /// - public static Region? SetClipToScreen () + public Region? SetClipToScreen () { Region? previous = GetClip (); - if (Application.Driver is { }) + if (Driver is { }) { - Application.Driver.Clip = new (Application.Screen); + Driver.Clip = new (Driver!.Screen); } return previous; @@ -72,7 +73,7 @@ public partial class View /// /// /// - public static void ExcludeFromClip (Rectangle rectangle) { Application.Driver?.Clip?.Exclude (rectangle); } + public void ExcludeFromClip (Rectangle rectangle) { Driver?.Clip?.Exclude (rectangle); } /// /// Removes the specified rectangle from the Clip. @@ -83,7 +84,7 @@ public partial class View /// /// /// - public static void ExcludeFromClip (Region? region) { Application.Driver?.Clip?.Exclude (region); } + public void ExcludeFromClip (Region? region) { Driver?.Clip?.Exclude (region); } /// /// Changes the Clip to the intersection of the current Clip and the of this View. @@ -104,7 +105,7 @@ public partial class View return null; } - Region previous = GetClip () ?? new (Application.Screen); + Region previous = GetClip () ?? new (Driver.Screen); Region frameRegion = previous.Clone (); @@ -151,7 +152,7 @@ public partial class View return null; } - Region previous = GetClip () ?? new (Application.Screen); + Region previous = GetClip () ?? new (App!.Screen); Region viewportRegion = previous.Clone (); diff --git a/Terminal.Gui/ViewBase/View.Drawing.Primitives.cs b/Terminal.Gui/ViewBase/View.Drawing.Primitives.cs index d9d9333ee..c5971598c 100644 --- a/Terminal.Gui/ViewBase/View.Drawing.Primitives.cs +++ b/Terminal.Gui/ViewBase/View.Drawing.Primitives.cs @@ -32,7 +32,6 @@ public partial class View Driver?.AddRune (rune); } - /// /// Adds the specified to the display at the current cursor position. This method is a /// convenience method that calls with the constructor. @@ -63,7 +62,7 @@ public partial class View /// /// /// When the method returns, the draw position will be incremented by the number of columns - /// required, unless the new column value is outside the or . + /// required, unless the new column value is outside the or . /// /// If requires more columns than are available, the output will be clipped. /// @@ -72,6 +71,25 @@ public partial class View { Driver?.AddStr (str); } + + /// Draws the specified in the specified viewport-relative column and row of the View. + /// + /// If the provided coordinates are outside the visible content area, this method does nothing. + /// + /// + /// The top-left corner of the visible content area is ViewPort.Location. + /// + /// Column (viewport-relative). + /// Row (viewport-relative). + /// The Text. + public void AddStr (int col, int row, string str) + { + if (Move (col, row)) + { + Driver?.AddStr (str); + } + } + /// Utility function to draw strings that contain a hotkey. /// String to display, the hotkey specifier before a letter flags the next letter as the hotkey. /// Hot color. @@ -121,8 +139,8 @@ public partial class View { DrawHotString ( text, - Enabled ? GetAttributeForRole (VisualRole.HotNormal) : GetScheme ()!.Disabled, - Enabled ? GetAttributeForRole (VisualRole.Normal) : GetScheme ()!.Disabled + Enabled ? GetAttributeForRole (VisualRole.HotNormal) : GetScheme ().Disabled, + Enabled ? GetAttributeForRole (VisualRole.Normal) : GetScheme ().Disabled ); } } @@ -137,7 +155,7 @@ public partial class View return; } - Region prevClip = AddViewportToClip (); + Region? prevClip = AddViewportToClip (); Rectangle toClear = ViewportToScreen (rect); Attribute prev = SetAttribute (new (color ?? GetAttributeForRole (VisualRole.Normal).Background)); Driver.FillRect (toClear); @@ -155,7 +173,7 @@ public partial class View return; } - Region prevClip = AddViewportToClip (); + Region? prevClip = AddViewportToClip (); Rectangle toClear = ViewportToScreen (rect); Driver.FillRect (toClear, rune); SetClip (prevClip); diff --git a/Terminal.Gui/ViewBase/View.Drawing.Scheme.cs b/Terminal.Gui/ViewBase/View.Drawing.Scheme.cs index dcd28794b..5ad8c0101 100644 --- a/Terminal.Gui/ViewBase/View.Drawing.Scheme.cs +++ b/Terminal.Gui/ViewBase/View.Drawing.Scheme.cs @@ -1,5 +1,4 @@ -#nullable enable -namespace Terminal.Gui.ViewBase; +namespace Terminal.Gui.ViewBase; public partial class View { diff --git a/Terminal.Gui/ViewBase/View.Drawing.cs b/Terminal.Gui/ViewBase/View.Drawing.cs index 1f2756123..70e915863 100644 --- a/Terminal.Gui/ViewBase/View.Drawing.cs +++ b/Terminal.Gui/ViewBase/View.Drawing.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.ComponentModel; +using System.ComponentModel; using System.Diagnostics; namespace Terminal.Gui.ViewBase; @@ -195,18 +194,18 @@ public partial class View // Drawing APIs else { // Set the clip to be just the thicknesses of the adornments - // TODO: Put this union logic in a method on View? + // TODO: Put this union logic in a method on View? Region? clipAdornments = Margin!.Thickness.AsRegion (Margin!.FrameToScreen ()); - clipAdornments?.Combine (Border!.Thickness.AsRegion (Border!.FrameToScreen ()), RegionOp.Union); - clipAdornments?.Combine (Padding!.Thickness.AsRegion (Padding!.FrameToScreen ()), RegionOp.Union); - clipAdornments?.Combine (originalClip, RegionOp.Intersect); + clipAdornments.Combine (Border!.Thickness.AsRegion (Border!.FrameToScreen ()), RegionOp.Union); + clipAdornments.Combine (Padding!.Thickness.AsRegion (Padding!.FrameToScreen ()), RegionOp.Union); + clipAdornments.Combine (originalClip, RegionOp.Intersect); SetClip (clipAdornments); } if (Margin?.NeedsLayout == true) { Margin.NeedsLayout = false; - Margin?.Thickness.Draw (FrameToScreen ()); + Margin?.Thickness.Draw (Driver, FrameToScreen ()); Margin?.Parent?.SetSubViewNeedsDraw (); } @@ -240,7 +239,7 @@ public partial class View // Drawing APIs { // We do not attempt to draw Margin. It is drawn in a separate pass. - // Each of these renders lines to this View's LineCanvas + // Each of these renders lines to this View's LineCanvas // Those lines will be finally rendered in OnRenderLineCanvas if (Border is { } && Border.Thickness != Thickness.Empty) { @@ -446,12 +445,15 @@ public partial class View // Drawing APIs // Report the drawn area to the context context?.AddDrawnRegion (textRegion); - TextFormatter?.Draw ( - drawRect, - HasFocus ? GetAttributeForRole (VisualRole.Focus) : GetAttributeForRole (VisualRole.Normal), - HasFocus ? GetAttributeForRole (VisualRole.HotFocus) : GetAttributeForRole (VisualRole.HotNormal), - Rectangle.Empty - ); + if (Driver is { }) + { + TextFormatter?.Draw ( + Driver, + drawRect, + HasFocus ? GetAttributeForRole (VisualRole.Focus) : GetAttributeForRole (VisualRole.Normal), + HasFocus ? GetAttributeForRole (VisualRole.HotFocus) : GetAttributeForRole (VisualRole.HotNormal), + Rectangle.Empty); + } // We assume that the text has been drawn over the entire area; ensure that the subviews are redrawn. SetSubViewNeedsDraw (); @@ -658,7 +660,7 @@ public partial class View // Drawing APIs Driver.Move (p.Key.X, p.Key.Y); // TODO: #2616 - Support combining sequences that don't normalize - AddRune (p.Value.Value.Rune); + AddStr (p.Value.Value.Grapheme); } } @@ -685,7 +687,7 @@ public partial class View // Drawing APIs context!.ClipDrawnRegion (ViewportToScreen (Viewport)); // Exclude the drawn region from the clip - ExcludeFromClip (context!.GetDrawnRegion ()); + ExcludeFromClip (context.GetDrawnRegion ()); // Exclude the Border and Padding from the clip ExcludeFromClip (Border?.Thickness.AsRegion (Border.FrameToScreen ())); diff --git a/Terminal.Gui/ViewBase/View.Hierarchy.cs b/Terminal.Gui/ViewBase/View.Hierarchy.cs index a80193c38..729212d1a 100644 --- a/Terminal.Gui/ViewBase/View.Hierarchy.cs +++ b/Terminal.Gui/ViewBase/View.Hierarchy.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Collections.ObjectModel; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; @@ -363,12 +362,12 @@ public partial class View // SuperView/SubView hierarchy management (SuperView, #endregion AddRemove - // TODO: This drives a weird coupling of Application.Top and View. It's not clear why this is needed. + // TODO: This drives a weird coupling of Application.TopRunnable and View. It's not clear why this is needed. /// Get the top superview of a given . /// The superview view. internal View? GetTopSuperView (View? view = null, View? superview = null) { - View? top = superview ?? Application.Top; + View? top = superview ?? App?.TopRunnableView; for (View? v = view?.SuperView ?? this?.SuperView; v != null; v = v.SuperView) { diff --git a/Terminal.Gui/ViewBase/View.Keyboard.cs b/Terminal.Gui/ViewBase/View.Keyboard.cs index 51350dca7..8f9a5127a 100644 --- a/Terminal.Gui/ViewBase/View.Keyboard.cs +++ b/Terminal.Gui/ViewBase/View.Keyboard.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.ViewBase; public partial class View // Keyboard APIs diff --git a/Terminal.Gui/ViewBase/View.Layout.cs b/Terminal.Gui/ViewBase/View.Layout.cs index 0c73aacbb..175c35e34 100644 --- a/Terminal.Gui/ViewBase/View.Layout.cs +++ b/Terminal.Gui/ViewBase/View.Layout.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; namespace Terminal.Gui.ViewBase; @@ -438,10 +437,11 @@ public partial class View // Layout APIs private void NeedsClearScreenNextIteration () { - if (Application.Top is { } && Application.Top == this && Application.TopLevels.Count == 1) + if (App is { TopRunnableView: { } } && App.TopRunnableView == this + && App.SessionStack!.Select (r => r.Runnable as View).Count() == 1) { - // If this is the only TopLevel, we need to redraw the screen - Application.ClearScreenNextIteration = true; + // If this is the only Runnable, we need to redraw the screen + App.ClearScreenNextIteration = true; } } @@ -532,7 +532,7 @@ public partial class View // Layout APIs /// /// Performs layout of the view and its subviews using the content size of either the or - /// . + /// . /// /// /// @@ -545,7 +545,7 @@ public partial class View // Layout APIs /// /// /// If the view could not be laid out (typically because dependency was not ready). - public bool Layout () { return Layout (GetContainerSize ()); } + public bool Layout () => Layout (GetContainerSize ()); /// /// Sets the position and size of this view, relative to the SuperView's ContentSize (nominally the same as @@ -1114,11 +1114,12 @@ public partial class View // Layout APIs { // TODO: Get rid of refs to Top Size superViewContentSize = SuperView?.GetContentSize () - ?? (Application.Top is { } && Application.Top != this && Application.Top.IsInitialized - ? Application.Top.GetContentSize () - : Application.Screen.Size); + ?? (App?.TopRunnableView is { } && App?.TopRunnableView != this && App!.TopRunnableView.IsInitialized + ? App.TopRunnableView.GetContentSize () + : App?.Screen.Size ?? new (2048, 2048)); return superViewContentSize; + } // BUGBUG: This method interferes with Dialog/MessageBox default min/max size. @@ -1130,7 +1131,7 @@ public partial class View // Layout APIs /// /// /// If does not have a or it's SuperView is not - /// the position will be bound by . + /// the position will be bound by . /// /// The View that is to be moved. /// The target x location. @@ -1138,7 +1139,7 @@ public partial class View // Layout APIs /// The new x location that will ensure will be fully visible. /// The new y location that will ensure will be fully visible. /// - /// Either (if does not have a Super View) or + /// Either (if does not have a Super View) or /// 's SuperView. This can be used to ensure LayoutSubViews is called on the correct View. /// internal static View? GetLocationEnsuringFullVisibility ( @@ -1152,10 +1153,12 @@ public partial class View // Layout APIs int maxDimension; View? superView; - if (viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top) + IApplication? app = viewToMove.App; + + if (viewToMove?.SuperView is null || viewToMove == app?.TopRunnableView || viewToMove?.SuperView == app?.TopRunnableView) { - maxDimension = Application.Screen.Width; - superView = Application.Top; + maxDimension = app?.Screen.Width ?? 0; + superView = app?.TopRunnableView; } else { @@ -1185,46 +1188,27 @@ public partial class View // Layout APIs } //System.Diagnostics.Debug.WriteLine ($"nx:{nx}, rWidth:{rWidth}"); - var menuVisible = false; - var statusVisible = false; + //var menuVisible = false; + //var statusVisible = false; - if (viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top) - { - menuVisible = Application.Top?.MenuBar?.Visible == true; - } - else - { - View? t = viewToMove!.SuperView; - - while (t is { } and not Toplevel) - { - t = t.SuperView; - } - - if (t is Toplevel topLevel) - { - menuVisible = topLevel.MenuBar?.Visible == true; - } - } - - if (viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top) - { - maxDimension = menuVisible ? 1 : 0; - } - else - { - maxDimension = 0; - } + maxDimension = 0; ny = Math.Max (targetY, maxDimension); - if (viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top) + if (viewToMove?.SuperView is null || viewToMove == app?.TopRunnableView || viewToMove?.SuperView == app?.TopRunnableView) { - maxDimension = statusVisible ? Application.Screen.Height - 1 : Application.Screen.Height; + if (app is { }) + { + maxDimension = app.Screen.Height; + } + else + { + maxDimension = 0; + } } else { - maxDimension = statusVisible ? viewToMove!.SuperView.Viewport.Height - 1 : viewToMove!.SuperView.Viewport.Height; + maxDimension = viewToMove!.SuperView.Viewport.Height; } if (superView?.Margin is { } && superView == viewToMove?.SuperView) @@ -1237,13 +1221,8 @@ public partial class View // Layout APIs if (viewToMove?.Frame.Height <= maxDimension) { ny = ny + viewToMove.Frame.Height > maxDimension - ? Math.Max (maxDimension - viewToMove.Frame.Height, menuVisible ? 1 : 0) + ? Math.Max (maxDimension - viewToMove.Frame.Height, 0) : ny; - - //if (ny > viewToMove.Frame.Y + viewToMove.Frame.Height) - //{ - // ny = Math.Max (viewToMove.Frame.Bottom, 0); - //} } else { @@ -1267,12 +1246,12 @@ public partial class View // Layout APIs /// /// flags set in their ViewportSettings. /// - public static List GetViewsUnderLocation (in Point screenLocation, ViewportSettingsFlags excludeViewportSettingsFlags) + public List GetViewsUnderLocation (in Point screenLocation, ViewportSettingsFlags excludeViewportSettingsFlags) { // PopoverHost - If visible, start with it instead of Top - if (Application.Popover?.GetActivePopover () is View { Visible: true } visiblePopover) + if (App?.Popover?.GetActivePopover () is View { Visible: true } visiblePopover) { - // BUGBUG: We do not traverse all visible toplevels if there's an active popover. This may be a bug. + // BUGBUG: We do not traverse all visible runnables if there's an active popover. This may be a bug. List result = []; result.AddRange (GetViewsUnderLocation (visiblePopover, screenLocation, excludeViewportSettingsFlags)); @@ -1285,14 +1264,14 @@ public partial class View // Layout APIs var checkedTop = false; - // Traverse all visible toplevels, topmost first (reverse stack order) - if (Application.TopLevels.Count > 0) + // Traverse all visible runnables, topmost first (reverse stack order) + if (App?.SessionStack!.Count > 0) { - foreach (Toplevel toplevel in Application.TopLevels) + foreach (View? runnable in App.SessionStack!.Select(r => r.Runnable as View)) { - if (toplevel.Visible && toplevel.Contains (screenLocation)) + if (runnable!.Visible && runnable.Contains (screenLocation)) { - List result = GetViewsUnderLocation (toplevel, screenLocation, excludeViewportSettingsFlags); + List result = GetViewsUnderLocation (runnable, screenLocation, excludeViewportSettingsFlags); // Only return if the result is not empty if (result.Count > 0) @@ -1301,17 +1280,17 @@ public partial class View // Layout APIs } } - if (toplevel == Application.Top) + if (runnable == App.TopRunnableView) { checkedTop = true; } } } - // Fallback: If TopLevels is empty or Top is not in TopLevels, check Top directly (for test compatibility) - if (!checkedTop && Application.Top is { Visible: true } top) + // Fallback: If Runnables is empty or Top is not in Runnables, check Top directly (for test compatibility) + if (!checkedTop && App?.TopRunnableView is { Visible: true } top) { - // For root toplevels, allow hit-testing even if location is outside bounds (for drag/move) + // For root runnables, allow hit-testing even if location is outside bounds (for drag/move) List result = GetViewsUnderLocation (top, screenLocation, excludeViewportSettingsFlags); if (result.Count > 0) diff --git a/Terminal.Gui/ViewBase/View.Mouse.cs b/Terminal.Gui/ViewBase/View.Mouse.cs index 546017059..c899c2d2e 100644 --- a/Terminal.Gui/ViewBase/View.Mouse.cs +++ b/Terminal.Gui/ViewBase/View.Mouse.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.ComponentModel; +using System.ComponentModel; namespace Terminal.Gui.ViewBase; @@ -16,7 +15,7 @@ public partial class View // Mouse APIs private void SetupMouse () { - MouseHeldDown = new MouseHeldDown (this, Application.TimedEvents,Application.Mouse); + MouseHeldDown = new MouseHeldDown (this, App?.TimedEvents, App?.Mouse); MouseBindings = new (); // TODO: Should the default really work with any button or just button1? @@ -54,7 +53,7 @@ public partial class View // Mouse APIs #region MouseEnterLeave /// - /// INTERNAL Called by when the mouse moves over the View's + /// INTERNAL Called by when the mouse moves over the View's /// . /// will /// be raised when the mouse is no longer over the . If another View occludes this View, the @@ -151,7 +150,7 @@ public partial class View // Mouse APIs public event EventHandler? MouseEnter; /// - /// INTERNAL Called by when the mouse leaves , or is + /// INTERNAL Called by when the mouse leaves , or is /// occluded /// by another non-SubView. /// @@ -228,7 +227,7 @@ public partial class View // Mouse APIs public bool WantMousePositionReports { get; set; } /// - /// Processes a new . This method is called by when a + /// Processes a new . This method is called by when a /// mouse /// event occurs. /// @@ -375,7 +374,7 @@ public partial class View // Mouse APIs if (mouseEvent.IsReleased) { - if (Application.Mouse.MouseGrabView == this) + if (App?.Mouse.MouseGrabView == this) { //Logging.Debug ($"{Id} - {MouseState}"); MouseState &= ~MouseState.Pressed; @@ -407,9 +406,9 @@ public partial class View // Mouse APIs if (mouseEvent.IsPressed) { // The first time we get pressed event, grab the mouse and set focus - if (Application.Mouse.MouseGrabView != this) + if (App?.Mouse.MouseGrabView != this) { - Application.Mouse.GrabMouse (this); + App?.Mouse.GrabMouse (this); if (!HasFocus && CanFocus) { @@ -541,10 +540,10 @@ public partial class View // Mouse APIs { mouseEvent.Handled = false; - if (Application.Mouse.MouseGrabView == this && mouseEvent.IsSingleClicked) + if (App?.Mouse.MouseGrabView == this && mouseEvent.IsSingleClicked) { // We're grabbed. Clicked event comes after the last Release. This is our signal to ungrab - Application.Mouse.UngrabMouse (); + App?.Mouse.UngrabMouse (); // TODO: Prove we need to unset MouseState.Pressed and MouseState.PressedOutside here // TODO: There may be perf gains if we don't unset these flags here @@ -695,4 +694,4 @@ public partial class View // Mouse APIs #endregion MouseState Handling private void DisposeMouse () { } -} \ No newline at end of file +} diff --git a/Terminal.Gui/ViewBase/View.Navigation.cs b/Terminal.Gui/ViewBase/View.Navigation.cs index 516aef3c0..da2ab45d0 100644 --- a/Terminal.Gui/ViewBase/View.Navigation.cs +++ b/Terminal.Gui/ViewBase/View.Navigation.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; @@ -396,7 +395,7 @@ public partial class View // Focus and cross-view navigation management (TabStop public event EventHandler? FocusedChanged; /// Returns a value indicating if this View is currently on Top (Active) - public bool IsCurrentTop => Application.Top == this; + public bool IsCurrentTop => App?.TopRunnableView == this; /// /// Returns the most focused SubView down the subview-hierarchy. @@ -520,7 +519,7 @@ public partial class View // Focus and cross-view navigation management (TabStop if (value) { // NOTE: If Application.Navigation is null, we pass null to FocusChanging. For unit tests. - (bool focusSet, bool _) = SetHasFocusTrue (Application.Navigation?.GetFocused ()); + (bool focusSet, bool _) = SetHasFocusTrue (App?.Navigation?.GetFocused ()); if (focusSet) { @@ -557,7 +556,7 @@ public partial class View // Focus and cross-view navigation management (TabStop /// if the focus changed; false otherwise. public bool SetFocus () { - (bool focusSet, bool _) = SetHasFocusTrue (Application.Navigation?.GetFocused ()); + (bool focusSet, bool _) = SetHasFocusTrue (App?.Navigation?.GetFocused ()); return focusSet; } @@ -722,17 +721,17 @@ public partial class View // Focus and cross-view navigation management (TabStop return true; } - View? appFocused = Application.Navigation?.GetFocused (); + View? appFocused = App?.Navigation?.GetFocused (); if (appFocused == currentFocused) { if (newFocused is { HasFocus: true }) { - Application.Navigation?.SetFocused (newFocused); + App?.Navigation?.SetFocused (newFocused); } else { - Application.Navigation?.SetFocused (null); + App?.Navigation?.SetFocused (null); } } @@ -835,7 +834,7 @@ public partial class View // Focus and cross-view navigation management (TabStop } // Application.Navigation.GetFocused? - View? applicationFocused = Application.Navigation?.GetFocused (); + View? applicationFocused = App?.Navigation?.GetFocused (); if (newFocusedView is null && applicationFocused != this && applicationFocused is { CanFocus: true }) { @@ -854,18 +853,18 @@ public partial class View // Focus and cross-view navigation management (TabStop } } - // Application.Top? - if (newFocusedView is null && Application.Top is { CanFocus: true, HasFocus: false }) + // Application.TopRunnable? + if (newFocusedView is null && App?.TopRunnableView is { CanFocus: true, HasFocus: false }) { // Temporarily ensure this view can't get focus bool prevCanFocus = _canFocus; _canFocus = false; - bool restoredFocus = Application.Top.RestoreFocus (); + bool restoredFocus = App?.TopRunnableView.RestoreFocus () ?? false; _canFocus = prevCanFocus; - if (Application.Top is { CanFocus: true, HasFocus: true }) + if (App?.TopRunnableView is { CanFocus: true, HasFocus: true }) { - newFocusedView = Application.Top; + newFocusedView = App?.TopRunnableView; } else if (restoredFocus) { @@ -952,7 +951,7 @@ public partial class View // Focus and cross-view navigation management (TabStop // If we are the most focused view, we need to set the focused view in Application.Navigation if (newHasFocus && focusedView?.Focused is null) { - Application.Navigation?.SetFocused (focusedView); + App?.Navigation?.SetFocused (focusedView); } // Call the virtual method diff --git a/Terminal.Gui/ViewBase/View.ScrollBars.cs b/Terminal.Gui/ViewBase/View.ScrollBars.cs index 4463299f9..fd5f6a327 100644 --- a/Terminal.Gui/ViewBase/View.ScrollBars.cs +++ b/Terminal.Gui/ViewBase/View.ScrollBars.cs @@ -1,5 +1,4 @@ -#nullable enable - + namespace Terminal.Gui.ViewBase; public partial class View diff --git a/Terminal.Gui/ViewBase/View.Text.cs b/Terminal.Gui/ViewBase/View.Text.cs index 32694d33f..b5b401f81 100644 --- a/Terminal.Gui/ViewBase/View.Text.cs +++ b/Terminal.Gui/ViewBase/View.Text.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.ViewBase; diff --git a/Terminal.Gui/ViewBase/View.cs b/Terminal.Gui/ViewBase/View.cs index 5aa8a6e1d..68325dfe9 100644 --- a/Terminal.Gui/ViewBase/View.cs +++ b/Terminal.Gui/ViewBase/View.cs @@ -1,5 +1,4 @@ -#nullable enable -using System.Collections.Concurrent; +using System.Collections.Concurrent; using System.ComponentModel; using System.Diagnostics; @@ -52,7 +51,7 @@ public partial class View : IDisposable, ISupportInitializeNotification /// Pretty prints the View /// - public override string ToString () { return $"{GetType ().Name}({Id}){Frame}"; } + public override string ToString () => $"{GetType ().Name}({Id}){Frame}"; /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. /// @@ -72,9 +71,9 @@ public partial class View : IDisposable, ISupportInitializeNotification DisposeAdornments (); DisposeScrollBars (); - if (Application.Mouse.MouseGrabView == this) + if (App?.Mouse.MouseGrabView == this) { - Application.Mouse.UngrabMouse (); + App.Mouse.UngrabMouse (); } for (int i = InternalSubViews.Count - 1; i >= 0; i--) @@ -109,6 +108,34 @@ public partial class View : IDisposable, ISupportInitializeNotification /// The id should be unique across all Views that share a SuperView. public string Id { get; set; } = ""; + private IApplication? _app; + + /// + /// Gets the instance this view is running in. If this view is at the top of the view + /// hierarchy, returns . + /// + /// + /// + /// If not explicitly set on an instance, this property will retrieve the value from the view at the top + /// of the View hierarchy (the top-most SuperView). + /// + /// + public IApplication? App + { + get => GetApp (); + internal set => _app = value; + } + + /// + /// Gets the instance this view is running in. Used internally to allow overrides by + /// . + /// + /// + /// If this view is at the top of the view hierarchy, and was not explicitly set, + /// returns . + /// + protected virtual IApplication? GetApp () => _app ?? SuperView?.App ?? null; + private IDriver? _driver; /// @@ -118,19 +145,21 @@ public partial class View : IDisposable, ISupportInitializeNotification /// internal IDriver? Driver { - get - { - if (_driver is { }) - { - return _driver; - } - - return Application.Driver; - } + get => GetDriver (); set => _driver = value; } - /// Gets the screen buffer contents. This is a convenience property for Views that need direct access to the screen buffer. + /// + /// Gets the instance for this view. Used internally to allow overrides by + /// . + /// + /// If this view is at the top of the view hierarchy, returns . + protected virtual IDriver? GetDriver () => _driver ?? App?.Driver ?? SuperView?.Driver /*?? ApplicationImpl.Instance.Driver*/; + + /// + /// Gets the screen buffer contents. This is a convenience property for Views that need direct access to the + /// screen buffer. + /// protected Cell [,]? ScreenContents => Driver?.Contents; /// Initializes a new instance of . @@ -387,7 +416,7 @@ public partial class View : IDisposable, ISupportInitializeNotification } /// Called when is changing. Can be cancelled by returning . - protected virtual bool OnVisibleChanging () { return false; } + protected virtual bool OnVisibleChanging () => false; /// /// Raised when the value is being changed. Can be cancelled by setting Cancel to diff --git a/Terminal.Gui/ViewBase/ViewDiagnosticFlags.cs b/Terminal.Gui/ViewBase/ViewDiagnosticFlags.cs index 345ec3c78..94959a874 100644 --- a/Terminal.Gui/ViewBase/ViewDiagnosticFlags.cs +++ b/Terminal.Gui/ViewBase/ViewDiagnosticFlags.cs @@ -1,5 +1,4 @@ -#nullable enable -namespace Terminal.Gui.ViewBase; +namespace Terminal.Gui.ViewBase; /// Enables diagnostic functions for . [Flags] diff --git a/Terminal.Gui/ViewBase/ViewEventArgs.cs b/Terminal.Gui/ViewBase/ViewEventArgs.cs index d2de59ec0..e5cc5e36c 100644 --- a/Terminal.Gui/ViewBase/ViewEventArgs.cs +++ b/Terminal.Gui/ViewBase/ViewEventArgs.cs @@ -13,4 +13,4 @@ public class ViewEventArgs : EventArgs /// child then sender may be the parent while is the child being added. /// public View View { get; } -} \ No newline at end of file +} diff --git a/Terminal.Gui/Views/Autocomplete/AppendAutocomplete.cs b/Terminal.Gui/Views/Autocomplete/AppendAutocomplete.cs index b53971624..f8452862e 100644 --- a/Terminal.Gui/Views/Autocomplete/AppendAutocomplete.cs +++ b/Terminal.Gui/Views/Autocomplete/AppendAutocomplete.cs @@ -1,3 +1,4 @@ +#nullable disable  namespace Terminal.Gui.Views; @@ -8,12 +9,12 @@ namespace Terminal.Gui.Views; public class AppendAutocomplete : AutocompleteBase { private bool _suspendSuggestions; - private TextField textField; + private TextField _textField; /// Creates a new instance of the class. public AppendAutocomplete (TextField textField) { - this.textField = textField; + _textField = textField; base.SelectionKey = KeyCode.Tab; Scheme = new Scheme @@ -35,15 +36,15 @@ public class AppendAutocomplete : AutocompleteBase /// public override View HostControl { - get => textField; - set => textField = (TextField)value; + get => _textField; + set => _textField = (TextField)value; } /// public override void ClearSuggestions () { base.ClearSuggestions (); - textField.SetNeedsDraw (); + _textField.SetNeedsDraw (); } /// @@ -107,19 +108,19 @@ public class AppendAutocomplete : AutocompleteBase } // draw it like it's selected, even though it's not - textField.SetAttribute ( + _textField.SetAttribute ( new Attribute ( Scheme.Normal.Foreground, - textField.GetAttributeForRole(VisualRole.Focus).Background, + _textField.GetAttributeForRole(VisualRole.Focus).Background, Scheme.Normal.Style ) ); - textField.Move (textField.Text.Length, 0); + _textField.Move (_textField.Text.Length, 0); Suggestion suggestion = Suggestions.ElementAt (SelectedIdx); string fragment = suggestion.Replacement.Substring (suggestion.Remove); - int spaceAvailable = textField.Viewport.Width - textField.Text.GetColumns (); + int spaceAvailable = _textField.Viewport.Width - _textField.Text.GetColumns (); int spaceRequired = fragment.EnumerateRunes ().Sum (c => c.GetColumns ()); if (spaceAvailable < spaceRequired) @@ -130,7 +131,7 @@ public class AppendAutocomplete : AutocompleteBase ); } - Application.Driver?.AddStr (fragment); + _textField.Driver?.AddStr (fragment); } /// @@ -143,12 +144,12 @@ public class AppendAutocomplete : AutocompleteBase if (MakingSuggestion ()) { Suggestion insert = Suggestions.ElementAt (SelectedIdx); - string newText = textField.Text; + string newText = _textField.Text; newText = newText.Substring (0, newText.Length - insert.Remove); newText += insert.Replacement; - textField.Text = newText; + _textField.Text = newText; - textField.MoveEnd (); + _textField.MoveEnd (); ClearSuggestions (); @@ -167,8 +168,8 @@ public class AppendAutocomplete : AutocompleteBase newText += Path.DirectorySeparatorChar; } - textField.Text = newText; - textField.MoveEnd (); + _textField.Text = newText; + _textField.MoveEnd (); } private bool CycleSuggestion (int direction) @@ -185,7 +186,7 @@ public class AppendAutocomplete : AutocompleteBase SelectedIdx = Suggestions.Count () - 1; } - textField.SetNeedsDraw (); + _textField.SetNeedsDraw (); return true; } @@ -195,5 +196,5 @@ public class AppendAutocomplete : AutocompleteBase /// to see auto-complete (i.e. focused and cursor in right place). /// /// - private bool MakingSuggestion () { return Suggestions.Any () && SelectedIdx != -1 && textField.HasFocus && textField.CursorIsAtEnd (); } + private bool MakingSuggestion () { return Suggestions.Any () && SelectedIdx != -1 && _textField.HasFocus && _textField.CursorIsAtEnd (); } } diff --git a/Terminal.Gui/Views/Autocomplete/AutocompleteBase.cs b/Terminal.Gui/Views/Autocomplete/AutocompleteBase.cs index f2122fa4b..d8abc050f 100644 --- a/Terminal.Gui/Views/Autocomplete/AutocompleteBase.cs +++ b/Terminal.Gui/Views/Autocomplete/AutocompleteBase.cs @@ -1,3 +1,4 @@ +#nullable disable using System.Collections.ObjectModel; namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/Autocomplete/AutocompleteContext.cs b/Terminal.Gui/Views/Autocomplete/AutocompleteContext.cs index d2e7e4d59..bd9f32712 100644 --- a/Terminal.Gui/Views/Autocomplete/AutocompleteContext.cs +++ b/Terminal.Gui/Views/Autocomplete/AutocompleteContext.cs @@ -1,4 +1,5 @@ +#nullable disable namespace Terminal.Gui.Views; /// diff --git a/Terminal.Gui/Views/Autocomplete/AutocompleteFilepathContext.cs b/Terminal.Gui/Views/Autocomplete/AutocompleteFilepathContext.cs index 6c3e12c34..12384e45b 100644 --- a/Terminal.Gui/Views/Autocomplete/AutocompleteFilepathContext.cs +++ b/Terminal.Gui/Views/Autocomplete/AutocompleteFilepathContext.cs @@ -1,3 +1,4 @@ +#nullable disable using System.IO.Abstractions; using System.Runtime.InteropServices; @@ -11,16 +12,16 @@ internal class AutocompleteFilepathContext (string currentLine, int cursorPositi internal class FilepathSuggestionGenerator : ISuggestionGenerator { - private FileDialogState state; + private FileDialogState _state; public IEnumerable GenerateSuggestions (AutocompleteContext context) { if (context is AutocompleteFilepathContext fileState) { - state = fileState.State; + _state = fileState.State; } - if (state is null) + if (_state is null) { return Enumerable.Empty (); } @@ -41,7 +42,7 @@ internal class FilepathSuggestionGenerator : ISuggestionGenerator return Enumerable.Empty (); } - if (term.Equals (state?.Directory?.Name)) + if (term.Equals (_state?.Directory?.Name)) { // Clear suggestions return Enumerable.Empty (); @@ -49,13 +50,13 @@ internal class FilepathSuggestionGenerator : ISuggestionGenerator bool isWindows = RuntimeInformation.IsOSPlatform (OSPlatform.Windows); - string [] suggestions = state.Children.Where (d => !d.IsParent) - .Select ( - e => e.FileSystemInfo is IDirectoryInfo d - ? d.Name + Path.DirectorySeparatorChar - : e.FileSystemInfo.Name - ) - .ToArray (); + string [] suggestions = _state!.Children.Where (d => !d.IsParent) + .Select ( + e => e.FileSystemInfo is IDirectoryInfo d + ? d.Name + Path.DirectorySeparatorChar + : e.FileSystemInfo.Name + ) + .ToArray (); string [] validSuggestions = suggestions .Where ( @@ -81,9 +82,9 @@ internal class FilepathSuggestionGenerator : ISuggestionGenerator .ToList (); } - public bool IsWordChar (Rune rune) + public bool IsWordChar (string text) { - if (rune.Value == '\n') + if (text == "\n") { return false; } diff --git a/Terminal.Gui/Views/Autocomplete/IAutocomplete.cs b/Terminal.Gui/Views/Autocomplete/IAutocomplete.cs index 717122e9d..ce15a641e 100644 --- a/Terminal.Gui/Views/Autocomplete/IAutocomplete.cs +++ b/Terminal.Gui/Views/Autocomplete/IAutocomplete.cs @@ -1,3 +1,4 @@ +#nullable disable using System.Collections.ObjectModel; namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/Autocomplete/ISuggestionGenerator.cs b/Terminal.Gui/Views/Autocomplete/ISuggestionGenerator.cs index 08fd17c9a..79f62045e 100644 --- a/Terminal.Gui/Views/Autocomplete/ISuggestionGenerator.cs +++ b/Terminal.Gui/Views/Autocomplete/ISuggestionGenerator.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// Generates autocomplete based on a given cursor location within a string @@ -7,9 +8,9 @@ public interface ISuggestionGenerator IEnumerable GenerateSuggestions (AutocompleteContext context); /// - /// Returns if is a character that would continue autocomplete + /// Returns if is a character that would continue autocomplete /// suggesting. Returns if it is a 'breaking' character (i.e. terminating current word /// boundary) /// - bool IsWordChar (Rune rune); + bool IsWordChar (string text); } diff --git a/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.PopUp.cs b/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.PopUp.cs index b7a67726e..18bd89b52 100644 --- a/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.PopUp.cs +++ b/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.PopUp.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.cs b/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.cs index 602a849d7..8a7ca9d3e 100644 --- a/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.cs +++ b/Terminal.Gui/Views/Autocomplete/PopupAutocomplete.cs @@ -1,5 +1,4 @@ -using System.Diagnostics; - +#nullable disable namespace Terminal.Gui.Views; /// @@ -125,7 +124,7 @@ public abstract partial class PopupAutocomplete : AutocompleteBase { Visible = true; HostControl?.SetNeedsDraw (); - Application.Mouse.UngrabMouse (); + HostControl?.App?.Mouse.UngrabMouse (); return false; } @@ -137,7 +136,7 @@ public abstract partial class PopupAutocomplete : AutocompleteBase _closed = false; } - HostControl?.SetNeedsDraw (); + HostControl.SetNeedsDraw (); return false; } @@ -189,7 +188,7 @@ public abstract partial class PopupAutocomplete : AutocompleteBase /// trueif the key can be handled falseotherwise. public override bool ProcessKey (Key key) { - if (SuggestionGenerator.IsWordChar ((Rune)key)) + if (SuggestionGenerator.IsWordChar (key.AsRune.ToString ())) { Visible = true; _closed = false; @@ -406,7 +405,7 @@ public abstract partial class PopupAutocomplete : AutocompleteBase string text = TextFormatter.ClipOrPad (toRender [i].Title, width); - Application.Driver?.AddStr (text); + _popup.App?.Driver?.AddStr (text); } } @@ -544,7 +543,6 @@ public abstract partial class PopupAutocomplete : AutocompleteBase /// protected abstract void SetCursorPosition (int column); -#nullable enable private Point? LastPopupPos { get; set; } #nullable restore diff --git a/Terminal.Gui/Views/Autocomplete/SingleWordSuggestionGenerator.cs b/Terminal.Gui/Views/Autocomplete/SingleWordSuggestionGenerator.cs index 1accda922..fc9504027 100644 --- a/Terminal.Gui/Views/Autocomplete/SingleWordSuggestionGenerator.cs +++ b/Terminal.Gui/Views/Autocomplete/SingleWordSuggestionGenerator.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// @@ -17,10 +18,10 @@ public class SingleWordSuggestionGenerator : ISuggestionGenerator // if there is nothing to pick from if (AllSuggestions.Count == 0) { - return Enumerable.Empty (); + return []; } - List line = context.CurrentLine.Select (c => c.Rune).ToList (); + List line = context.CurrentLine.Select (c => c.Grapheme).ToList (); string currentWord = IdxToWord (line, context.CursorPosition, out int startIdx); context.CursorPosition = startIdx < 1 ? startIdx : Math.Min (startIdx + 1, line.Count); @@ -43,9 +44,13 @@ public class SingleWordSuggestionGenerator : ISuggestionGenerator /// Return true if the given symbol should be considered part of a word and can be contained in matches. Base /// behavior is to use /// - /// The rune. + /// The text. /// - public virtual bool IsWordChar (Rune rune) { return char.IsLetterOrDigit ((char)rune.Value); } + public virtual bool IsWordChar (string text) + { + return !string.IsNullOrEmpty (text) + && Rune.IsLetterOrDigit (text.EnumerateRunes ().First ()); + } /// /// @@ -64,7 +69,7 @@ public class SingleWordSuggestionGenerator : ISuggestionGenerator /// The start index of the word. /// /// - protected virtual string IdxToWord (List line, int idx, out int startIdx, int columnOffset = 0) + protected virtual string IdxToWord (List line, int idx, out int startIdx, int columnOffset = 0) { var sb = new StringBuilder (); startIdx = idx; @@ -93,7 +98,7 @@ public class SingleWordSuggestionGenerator : ISuggestionGenerator { if (IsWordChar (line [startIdx])) { - sb.Insert (0, (char)line [startIdx].Value); + sb.Insert (0, line [startIdx]); } else { diff --git a/Terminal.Gui/Views/Autocomplete/Suggestion.cs b/Terminal.Gui/Views/Autocomplete/Suggestion.cs index 7b7bbd12a..a1facdc38 100644 --- a/Terminal.Gui/Views/Autocomplete/Suggestion.cs +++ b/Terminal.Gui/Views/Autocomplete/Suggestion.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// A replacement suggestion made by diff --git a/Terminal.Gui/Views/Bar.cs b/Terminal.Gui/Views/Bar.cs index 55e4a7914..3c04a16dc 100644 --- a/Terminal.Gui/Views/Bar.cs +++ b/Terminal.Gui/Views/Bar.cs @@ -1,5 +1,3 @@ -#nullable enable - namespace Terminal.Gui.Views; /// @@ -33,13 +31,14 @@ public class Bar : View, IOrientation, IDesignable // Initialized += Bar_Initialized; MouseEvent += OnMouseEvent; - - if (shortcuts is { }) + if (shortcuts is null) { - foreach (View shortcut in shortcuts) - { - Add (shortcut); - } + return; + } + + foreach (View shortcut in shortcuts) + { + base.Add (shortcut); } } @@ -107,7 +106,7 @@ public class Bar : View, IOrientation, IDesignable public void OnOrientationChanged (Orientation newOrientation) { // BUGBUG: this should not be SuperView.GetContentSize - LayoutBarItems (SuperView?.GetContentSize () ?? Application.Screen.Size); + LayoutBarItems (SuperView?.GetContentSize () ?? App?.Screen.Size ?? Size.Empty); } #endregion @@ -245,7 +244,7 @@ public class Bar : View, IOrientation, IDesignable barItem.X = 0; scBarItem.MinimumKeyTextSize = minKeyWidth; scBarItem.Width = scBarItem.GetWidthDimAuto (); - barItem.Layout (Application.Screen.Size); + barItem.Layout (App?.Screen.Size ?? Size.Empty); maxBarItemWidth = Math.Max (maxBarItemWidth, barItem.Frame.Width); } diff --git a/Terminal.Gui/Views/Button.cs b/Terminal.Gui/Views/Button.cs index 942e97b11..b003d0c75 100644 --- a/Terminal.Gui/Views/Button.cs +++ b/Terminal.Gui/Views/Button.cs @@ -1,4 +1,4 @@ - +#nullable disable namespace Terminal.Gui.Views; /// @@ -23,6 +23,9 @@ namespace Terminal.Gui.Views; /// public class Button : View, IDesignable { + private static ShadowStyle _defaultShadow = ShadowStyle.Opaque; // Resources/config.json overrides + private static MouseState _defaultHighlightStates = MouseState.In | MouseState.Pressed | MouseState.PressedOutside; // Resources/config.json overrides + private readonly Rune _leftBracket; private readonly Rune _leftDefault; private readonly Rune _rightBracket; @@ -33,13 +36,21 @@ public class Button : View, IDesignable /// Gets or sets whether s are shown with a shadow effect by default. /// [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static ShadowStyle DefaultShadow { get; set; } = ShadowStyle.Opaque; + public static ShadowStyle DefaultShadow + { + get => _defaultShadow; + set => _defaultShadow = value; + } /// /// Gets or sets the default Highlight Style. /// [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static MouseState DefaultHighlightStates { get; set; } = MouseState.In | MouseState.Pressed | MouseState.PressedOutside; + public static MouseState DefaultHighlightStates + { + get => _defaultHighlightStates; + set => _defaultHighlightStates = value; + } /// Initializes a new instance of . public Button () diff --git a/Terminal.Gui/Views/CharMap/CharMap.cs b/Terminal.Gui/Views/CharMap/CharMap.cs index 02308ac1e..d61e4f87d 100644 --- a/Terminal.Gui/Views/CharMap/CharMap.cs +++ b/Terminal.Gui/Views/CharMap/CharMap.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Globalization; @@ -148,10 +147,7 @@ public class CharMap : View, IDesignable break; } - var rune = new Rune (cp); - Span utf16 = new char [2]; - rune.EncodeToUtf16 (utf16); - UnicodeCategory cat = CharUnicodeInfo.GetUnicodeCategory (utf16 [0]); + UnicodeCategory cat = CharUnicodeInfo.GetUnicodeCategory (cp); if (cat == ShowUnicodeCategory.Value) { anyVisible = true; @@ -285,8 +281,8 @@ public class CharMap : View, IDesignable } } - private void CopyCodePoint () { Clipboard.Contents = $"U+{SelectedCodePoint:x5}"; } - private void CopyGlyph () { Clipboard.Contents = $"{new Rune (SelectedCodePoint)}"; } + private void CopyCodePoint () { App?.Clipboard?.SetClipboardData ($"U+{SelectedCodePoint:x5}"); } + private void CopyGlyph () { App?.Clipboard?.SetClipboardData ($"{new Rune (SelectedCodePoint)}"); } private bool? Move (ICommandContext? commandContext, int cpOffset) { @@ -339,7 +335,7 @@ public class CharMap : View, IDesignable [RequiresDynamicCode ("AOT")] private void ShowDetails () { - if (!Application.Initialized) + if (App is not { Initialized: true }) { // Some unit tests invoke Accept without Init return; @@ -379,20 +375,25 @@ public class CharMap : View, IDesignable waitIndicator.Add (errorLabel); waitIndicator.Add (spinner); - waitIndicator.Ready += async (s, a) => + waitIndicator.IsModalChanged += async (s, a) => { + if (!a.Value) + { + return; + } + try { decResponse = await client.GetCodepointDec (SelectedCodePoint).ConfigureAwait (false); - Application.Invoke (() => waitIndicator.RequestStop ()); + App?.Invoke ((_) => (s as Dialog)?.RequestStop ()); } catch (HttpRequestException e) { getCodePointError = errorLabel.Text = e.Message; - Application.Invoke (() => waitIndicator.RequestStop ()); + App?.Invoke ((_) => (s as Dialog)?.RequestStop ()); } }; - Application.Run (waitIndicator); + App?.Run (waitIndicator); waitIndicator.Dispose (); var name = string.Empty; @@ -525,7 +526,7 @@ public class CharMap : View, IDesignable dlg.Add (json); - Application.Run (dlg); + App?.Run (dlg); dlg.Dispose (); } @@ -685,7 +686,7 @@ public class CharMap : View, IDesignable // Don't render out-of-range scalars if (scalar > MAX_CODE_POINT) { - AddRune (' '); + AddStr (" "); if (visibleRow == selectedRowIndex && col == selectedCol) { SetAttributeForRole (VisualRole.Normal); @@ -693,22 +694,20 @@ public class CharMap : View, IDesignable continue; } - var rune = (Rune)'?'; + string grapheme = "?"; if (Rune.IsValid (scalar)) { - rune = new (scalar); + grapheme = new Rune (scalar).ToString (); } - int width = rune.GetColumns (); + int width = grapheme.GetColumns (); // Compute visibility based on ShowUnicodeCategory bool isVisible = Rune.IsValid (scalar); if (isVisible && ShowUnicodeCategory.HasValue) { - Span filterUtf16 = new char [2]; - rune.EncodeToUtf16 (filterUtf16); - UnicodeCategory cat = CharUnicodeInfo.GetUnicodeCategory (filterUtf16 [0]); + UnicodeCategory cat = CharUnicodeInfo.GetUnicodeCategory (scalar); isVisible = cat == ShowUnicodeCategory.Value; } @@ -717,11 +716,11 @@ public class CharMap : View, IDesignable // Glyph row if (isVisible) { - RenderRune (rune, width); + RenderGrapheme (grapheme, width, scalar); } else { - AddRune (' '); + AddStr (" "); } } else @@ -736,7 +735,7 @@ public class CharMap : View, IDesignable } else { - AddRune (' '); + AddStr (" "); } } @@ -750,21 +749,18 @@ public class CharMap : View, IDesignable return true; - void RenderRune (Rune rune, int width) + void RenderGrapheme (string grapheme, int width, int scalar) { // Get the UnicodeCategory - Span utf16 = new char [2]; - int charCount = rune.EncodeToUtf16 (utf16); - // Get the bidi class for the first code unit // For most bidi characters, the first code unit is sufficient - UnicodeCategory category = CharUnicodeInfo.GetUnicodeCategory (utf16 [0]); + UnicodeCategory category = CharUnicodeInfo.GetUnicodeCategory (scalar); switch (category) { case UnicodeCategory.OtherNotAssigned: SetAttributeForRole (VisualRole.Highlight); - AddRune (Rune.ReplacementChar); + AddStr (Rune.ReplacementChar.ToString ()); SetAttributeForRole (VisualRole.Normal); break; @@ -773,7 +769,7 @@ public class CharMap : View, IDesignable // These report width of 0 and don't render on their own. case UnicodeCategory.Format: SetAttributeForRole (VisualRole.Highlight); - AddRune ('F'); + AddStr ("F"); SetAttributeForRole (VisualRole.Normal); break; @@ -786,36 +782,7 @@ public class CharMap : View, IDesignable case UnicodeCategory.EnclosingMark: if (width > 0) { - AddRune (rune); - } - else - { - if (rune.IsCombiningMark ()) - { - // This is a hack to work around the fact that combining marks - // a) can't be rendered on their own - // b) that don't normalize are not properly supported in - // any known terminal (esp Windows/AtlasEngine). - // See Issue #2616 - var sb = new StringBuilder (); - sb.Append ('a'); - sb.Append (rune); - - // Try normalizing after combining with 'a'. If it normalizes, at least - // it'll show on the 'a'. If not, just show the replacement char. - string normal = sb.ToString ().Normalize (NormalizationForm.FormC); - - if (normal.Length == 1) - { - AddRune ((Rune)normal [0]); - } - else - { - SetAttributeForRole (VisualRole.Highlight); - AddRune ('M'); - SetAttributeForRole (VisualRole.Normal); - } - } + AddStr (grapheme); } break; @@ -825,20 +792,28 @@ public class CharMap : View, IDesignable case UnicodeCategory.LineSeparator: case UnicodeCategory.ParagraphSeparator: case UnicodeCategory.Surrogate: - AddRune (rune); + AddStr (grapheme); break; + case UnicodeCategory.OtherLetter: + AddStr (grapheme); + if (width == 0) + { + AddStr (" "); + } + + break; default: // Draw the rune if (width > 0) { - AddRune (rune); + AddStr (grapheme); } else { - throw new InvalidOperationException ($"The Rune \"{rune}\" (U+{rune.Value:x6}) has zero width and no special-case UnicodeCategory logic applies."); + throw new InvalidOperationException ($"The Rune \"{grapheme}\" (U+{Rune.GetRuneAt (grapheme, 0).Value:x6}) has zero width and no special-case UnicodeCategory logic applies."); } break; @@ -972,7 +947,7 @@ public class CharMap : View, IDesignable // Registering with the PopoverManager will ensure that the context menu is closed when the view is no longer focused // and the context menu is disposed when it is closed. - Application.Popover?.Register (contextMenu); + App!.Popover?.Register (contextMenu); contextMenu?.MakeVisible (ViewportToScreen (GetCursor (SelectedCodePoint))); diff --git a/Terminal.Gui/Views/CharMap/UcdApiClient.cs b/Terminal.Gui/Views/CharMap/UcdApiClient.cs index ae0af4838..a5abaf994 100644 --- a/Terminal.Gui/Views/CharMap/UcdApiClient.cs +++ b/Terminal.Gui/Views/CharMap/UcdApiClient.cs @@ -1,4 +1,3 @@ -#nullable enable namespace Terminal.Gui.Views; /// diff --git a/Terminal.Gui/Views/CharMap/UnicodeRange.cs b/Terminal.Gui/Views/CharMap/UnicodeRange.cs index 24f7378b2..4904d1751 100644 --- a/Terminal.Gui/Views/CharMap/UnicodeRange.cs +++ b/Terminal.Gui/Views/CharMap/UnicodeRange.cs @@ -1,4 +1,3 @@ -#nullable enable using System.Reflection; using System.Text.Unicode; diff --git a/Terminal.Gui/Views/CheckBox.cs b/Terminal.Gui/Views/CheckBox.cs index d5801f9f8..0dfb47e51 100644 --- a/Terminal.Gui/Views/CheckBox.cs +++ b/Terminal.Gui/Views/CheckBox.cs @@ -1,5 +1,3 @@ -#nullable enable - namespace Terminal.Gui.Views; /// Shows a checkbox that can be cycled between two or three states. @@ -10,11 +8,17 @@ namespace Terminal.Gui.Views; /// public class CheckBox : View { + private static MouseState _defaultHighlightStates = MouseState.PressedOutside | MouseState.Pressed | MouseState.In; // Resources/config.json overrides + /// /// Gets or sets the default Highlight Style. /// [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static MouseState DefaultHighlightStates { get; set; } = MouseState.PressedOutside | MouseState.Pressed | MouseState.In; + public static MouseState DefaultHighlightStates + { + get => _defaultHighlightStates; + set => _defaultHighlightStates = value; + } /// /// Initializes a new instance of . diff --git a/Terminal.Gui/Views/CheckState.cs b/Terminal.Gui/Views/CheckState.cs index 2b001ddea..494df666b 100644 --- a/Terminal.Gui/Views/CheckState.cs +++ b/Terminal.Gui/Views/CheckState.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.Views; /// diff --git a/Terminal.Gui/Views/CollectionNavigation/CollectionNavigator.cs b/Terminal.Gui/Views/CollectionNavigation/CollectionNavigator.cs index a12d769c5..ae3626fd1 100644 --- a/Terminal.Gui/Views/CollectionNavigation/CollectionNavigator.cs +++ b/Terminal.Gui/Views/CollectionNavigation/CollectionNavigator.cs @@ -1,4 +1,5 @@ -using System.Collections; +#nullable disable +using System.Collections; namespace Terminal.Gui.Views; @@ -6,6 +7,9 @@ namespace Terminal.Gui.Views; /// This implementation is based on a static of objects. internal class CollectionNavigator : CollectionNavigatorBase, IListCollectionNavigator { + private readonly object _collectionLock = new (); + private IList _collection; + /// Constructs a new CollectionNavigator. public CollectionNavigator () { } @@ -14,11 +18,39 @@ internal class CollectionNavigator : CollectionNavigatorBase, IListCollectionNav public CollectionNavigator (IList collection) { Collection = collection; } /// - public IList Collection { get; set; } + public IList Collection + { + get + { + lock (_collectionLock) + { + return _collection; + } + } + set + { + lock (_collectionLock) + { + _collection = value; + } + } + } /// - protected override object ElementAt (int idx) { return Collection [idx]; } + protected override object ElementAt (int idx) + { + lock (_collectionLock) + { + return Collection [idx]; + } + } /// - protected override int GetCollectionLength () { return Collection.Count; } -} \ No newline at end of file + protected override int GetCollectionLength () + { + lock (_collectionLock) + { + return Collection.Count; + } + } +} diff --git a/Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs b/Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs index 274d32622..b7abad344 100644 --- a/Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs +++ b/Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs @@ -1,11 +1,9 @@ -#nullable enable - - namespace Terminal.Gui.Views; /// internal abstract class CollectionNavigatorBase : ICollectionNavigator { + private readonly object _lock = new (); private DateTime _lastKeystroke = DateTime.Now; private string _searchString = ""; @@ -15,10 +13,20 @@ internal abstract class CollectionNavigatorBase : ICollectionNavigator /// public string SearchString { - get => _searchString; + get + { + lock (_lock) + { + return _searchString; + } + } private set { - _searchString = value; + lock (_lock) + { + _searchString = value; + } + OnSearchStringChanged (new (value)); } } @@ -27,8 +35,13 @@ internal abstract class CollectionNavigatorBase : ICollectionNavigator public int TypingDelay { get; set; } = 500; /// - public int GetNextMatchingItem (int currentIndex, char keyStruck) + public int? GetNextMatchingItem (int? currentIndex, char keyStruck) { + if (currentIndex.HasValue && currentIndex < 0) + { + throw new ArgumentOutOfRangeException (nameof (currentIndex), @"Must be non-negative"); + } + if (!char.IsControl (keyStruck)) { // maybe user pressed 'd' and now presses 'd' again. @@ -36,63 +49,81 @@ internal abstract class CollectionNavigatorBase : ICollectionNavigator // but if we find none then we must fallback on cycling // d instead and discard the candidate state var candidateState = ""; - var elapsedTime = DateTime.Now - _lastKeystroke; + TimeSpan elapsedTime; + string currentSearchString; + + lock (_lock) + { + elapsedTime = DateTime.Now - _lastKeystroke; + currentSearchString = _searchString; + } Logging.Debug ($"CollectionNavigator began processing '{keyStruck}', it has been {elapsedTime} since last keystroke"); // is it a second or third (etc) keystroke within a short time - if (SearchString.Length > 0 && elapsedTime < TimeSpan.FromMilliseconds (TypingDelay)) + if (currentSearchString.Length > 0 && elapsedTime < TimeSpan.FromMilliseconds (TypingDelay)) { // "dd" is a candidate - candidateState = SearchString + keyStruck; + candidateState = currentSearchString + keyStruck; Logging.Debug ($"Appending, search is now for '{candidateState}'"); } else { // its a fresh keystroke after some time // or its first ever key press - SearchString = new string (keyStruck, 1); - Logging.Debug ($"It has been too long since last key press so beginning new search"); + SearchString = new (keyStruck, 1); + Logging.Debug ("It has been too long since last key press so beginning new search"); } - int idxCandidate = GetNextMatchingItem ( - currentIndex, - candidateState, + int? idxCandidate = GetNextMatchingItem ( + currentIndex, + candidateState, - // prefer not to move if there are multiple characters e.g. "ca" + 'r' should stay on "car" and not jump to "cart" - candidateState.Length > 1 - ); + // prefer not to move if there are multiple characters e.g. "ca" + 'r' should stay on "car" and not jump to "cart" + candidateState.Length > 1 + ); Logging.Debug ($"CollectionNavigator searching (preferring minimum movement) matched:{idxCandidate}"); - if (idxCandidate != -1) + + if (idxCandidate is { }) { // found "dd" so candidate search string is accepted - _lastKeystroke = DateTime.Now; + lock (_lock) + { + _lastKeystroke = DateTime.Now; + } + SearchString = candidateState; Logging.Debug ($"Found collection item that matched search:{idxCandidate}"); + return idxCandidate; } //// nothing matches "dd" so discard it as a candidate //// and just cycle "d" instead - _lastKeystroke = DateTime.Now; + lock (_lock) + { + _lastKeystroke = DateTime.Now; + } + idxCandidate = GetNextMatchingItem (currentIndex, candidateState); Logging.Debug ($"CollectionNavigator searching (any match) matched:{idxCandidate}"); // if a match wasn't found, the user typed a 'wrong' key in their search ("can" + 'z' // instead of "can" + 'd'). - if (SearchString.Length > 1 && idxCandidate == -1) + if (SearchString.Length > 1 && idxCandidate is null) { Logging.Debug ("CollectionNavigator ignored key and returned existing index"); + // ignore it since we're still within the typing delay // don't add it to SearchString either return currentIndex; } // if no changes to current state manifested - if (idxCandidate == currentIndex || idxCandidate == -1) + if (idxCandidate == currentIndex || idxCandidate is null) { Logging.Debug ("CollectionNavigator found no changes to current index, so clearing search"); @@ -100,37 +131,29 @@ internal abstract class CollectionNavigatorBase : ICollectionNavigator ClearSearchString (); // match on the fresh letter alone - SearchString = new string (keyStruck, 1); + SearchString = new (keyStruck, 1); idxCandidate = GetNextMatchingItem (currentIndex, SearchString); Logging.Debug ($"CollectionNavigator new SearchString {SearchString} matched index:{idxCandidate}"); - return idxCandidate == -1 ? currentIndex : idxCandidate; + return idxCandidate ?? currentIndex; } Logging.Debug ($"CollectionNavigator final answer was:{idxCandidate}"); + // Found another "d" or just leave index as it was return idxCandidate; } - Logging.Debug ("CollectionNavigator found key press was not actionable so clearing search and returning -1"); + Logging.Debug ("CollectionNavigator found key press was not actionable so clearing search and returning null"); // clear state because keypress was a control char ClearSearchString (); // control char indicates no selection - return -1; + return null; } - - - /// - /// Raised when the is changed. Useful for debugging. Raises the - /// event. - /// - /// - protected virtual void OnSearchStringChanged (KeystrokeNavigatorEventArgs e) { SearchStringChanged?.Invoke (this, e); } - /// This event is raised when is changed. Useful for debugging. public event EventHandler? SearchStringChanged; @@ -141,6 +164,13 @@ internal abstract class CollectionNavigatorBase : ICollectionNavigator /// Return the number of elements in the collection protected abstract int GetCollectionLength (); + /// + /// Raised when the is changed. Useful for debugging. Raises the + /// event. + /// + /// + protected virtual void OnSearchStringChanged (KeystrokeNavigatorEventArgs e) { SearchStringChanged?.Invoke (this, e); } + /// Gets the index of the next item in the collection that matches . /// The index in the collection to start the search from. /// The search string to use. @@ -150,17 +180,17 @@ internal abstract class CollectionNavigatorBase : ICollectionNavigator /// (the default), the next matching item will be returned, even if it is above in the /// collection. /// - /// The index of the next matching item or if no match was found. - internal int GetNextMatchingItem (int currentIndex, string search, bool minimizeMovement = false) + /// The index of the next matching item or if no match was found. + internal int? GetNextMatchingItem (int? currentIndex, string search, bool minimizeMovement = false) { if (string.IsNullOrEmpty (search)) { - return -1; + return null; } int collectionLength = GetCollectionLength (); - if (currentIndex != -1 && currentIndex < collectionLength && Matcher.IsMatch (search, ElementAt (currentIndex))) + if (currentIndex.HasValue && currentIndex < collectionLength && Matcher.IsMatch (search, ElementAt (currentIndex.Value))) { // we are already at a match if (minimizeMovement) @@ -172,9 +202,9 @@ internal abstract class CollectionNavigatorBase : ICollectionNavigator for (var i = 1; i < collectionLength; i++) { //circular - int idxCandidate = (i + currentIndex) % collectionLength; + int? idxCandidate = (i + currentIndex) % collectionLength; - if (Matcher.IsMatch (search, ElementAt (idxCandidate))) + if (Matcher.IsMatch (search, ElementAt (idxCandidate!.Value))) { return idxCandidate; } @@ -194,12 +224,16 @@ internal abstract class CollectionNavigatorBase : ICollectionNavigator } // Nothing matches - return -1; + return null; } private void ClearSearchString () { SearchString = ""; - _lastKeystroke = DateTime.Now; + + lock (_lock) + { + _lastKeystroke = DateTime.Now; + } } -} \ No newline at end of file +} diff --git a/Terminal.Gui/Views/CollectionNavigation/DefaultCollectionNavigatorMatcher.cs b/Terminal.Gui/Views/CollectionNavigation/DefaultCollectionNavigatorMatcher.cs index 20bee6809..ed910a828 100644 --- a/Terminal.Gui/Views/CollectionNavigation/DefaultCollectionNavigatorMatcher.cs +++ b/Terminal.Gui/Views/CollectionNavigation/DefaultCollectionNavigatorMatcher.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigator.cs b/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigator.cs index 85a68d300..69256db43 100644 --- a/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigator.cs +++ b/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigator.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.Views; @@ -6,7 +6,7 @@ namespace Terminal.Gui.Views; /// /// Navigates a collection of items using keystrokes. The keystrokes are used to build a search string. The /// is used to find the next item in the collection that matches the search string when -/// is called. +/// is called. /// /// If the user types keystrokes that can't be found in the collection, the search string is cleared and the next /// item is found that starts with the last keystroke. @@ -17,7 +17,7 @@ public interface ICollectionNavigator { /// /// Gets or sets the number of milliseconds to delay before clearing the search string. The delay is reset on each - /// call to . The default is 500ms. + /// call to . The default is 500ms. /// public int TypingDelay { get; set; } @@ -43,8 +43,8 @@ public interface ICollectionNavigator /// The index in the collection to start the search from. /// The character of the key the user pressed. /// - /// The index of the item that matches what the user has typed. Returns if no item in the + /// The index of the item that matches what the user has typed. Returns if no item in the /// collection matched. /// - int GetNextMatchingItem (int currentIndex, char keyStruck); + int? GetNextMatchingItem (int? currentIndex, char keyStruck); } diff --git a/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigatorMatcher.cs b/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigatorMatcher.cs index f45b59c0f..420c49674 100644 --- a/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigatorMatcher.cs +++ b/Terminal.Gui/Views/CollectionNavigation/ICollectionNavigatorMatcher.cs @@ -1,3 +1,4 @@ +#nullable disable  namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/CollectionNavigation/IListCollectionNavigator.cs b/Terminal.Gui/Views/CollectionNavigation/IListCollectionNavigator.cs index f89e3f7c4..b382bc627 100644 --- a/Terminal.Gui/Views/CollectionNavigation/IListCollectionNavigator.cs +++ b/Terminal.Gui/Views/CollectionNavigation/IListCollectionNavigator.cs @@ -1,3 +1,4 @@ +#nullable disable using System.Collections; namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/CollectionNavigation/TableCollectionNavigator.cs b/Terminal.Gui/Views/CollectionNavigation/TableCollectionNavigator.cs index 69a817e50..21e3ce7d1 100644 --- a/Terminal.Gui/Views/CollectionNavigation/TableCollectionNavigator.cs +++ b/Terminal.Gui/Views/CollectionNavigation/TableCollectionNavigator.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// Collection navigator for cycling selections in a . diff --git a/Terminal.Gui/Views/Color/BBar.cs b/Terminal.Gui/Views/Color/BBar.cs index b59b5eecb..11c5cc9df 100644 --- a/Terminal.Gui/Views/Color/BBar.cs +++ b/Terminal.Gui/Views/Color/BBar.cs @@ -1,4 +1,4 @@ -#nullable enable + using ColorHelper; diff --git a/Terminal.Gui/Views/Color/ColorBar.cs b/Terminal.Gui/Views/Color/ColorBar.cs index ad15e231f..c3590d955 100644 --- a/Terminal.Gui/Views/Color/ColorBar.cs +++ b/Terminal.Gui/Views/Color/ColorBar.cs @@ -1,4 +1,4 @@ -#nullable enable + using ColorHelper; @@ -15,7 +15,7 @@ internal abstract class ColorBar : View, IColorBar /// protected ColorBar () { - Height = 1; + Height = Dim.Auto(minimumContentDim: 1); Width = Dim.Fill (); CanFocus = true; @@ -83,17 +83,14 @@ internal abstract class ColorBar : View, IColorBar SetNeedsDraw (); } - /// - protected override bool OnDrawingContent () + /// + protected override void OnSubViewsLaidOut (LayoutEventArgs args) { + base.OnSubViewsLaidOut (args); var xOffset = 0; if (!string.IsNullOrWhiteSpace (Text)) { - Move (0, 0); - SetAttribute (HasFocus ? GetAttributeForRole (VisualRole.Focus) : GetAttributeForRole (VisualRole.Normal)); - AddStr (Text); - // TODO: is there a better method than this? this is what it is in TableView xOffset = Text.EnumerateRunes ().Sum (c => c.GetColumns ()); } @@ -101,7 +98,21 @@ internal abstract class ColorBar : View, IColorBar _barWidth = Viewport.Width - xOffset; _barStartsAt = xOffset; - DrawBar (xOffset, 0, _barWidth); + // Each 1 unit of X in the bar corresponds to this much of Value + _cellValue = (double)MaxValue / (_barWidth - 1); + } + + /// + protected override bool OnDrawingContent () + { + if (!string.IsNullOrWhiteSpace (Text)) + { + Move (0, 0); + SetAttribute (HasFocus ? GetAttributeForRole (VisualRole.Focus) : GetAttributeForRole (VisualRole.Normal)); + AddStr (Text); + } + + DrawBar (_barStartsAt, 0, _barWidth); return true; } @@ -168,9 +179,6 @@ internal abstract class ColorBar : View, IColorBar private void DrawBar (int xOffset, int yOffset, int width) { - // Each 1 unit of X in the bar corresponds to this much of Value - _cellValue = (double)MaxValue / (width - 1); - for (var x = 0; x < width; x++) { double fraction = (double)x / (width - 1); diff --git a/Terminal.Gui/Views/Color/ColorModelStrategy.cs b/Terminal.Gui/Views/Color/ColorModelStrategy.cs index eb3f15608..0f803be18 100644 --- a/Terminal.Gui/Views/Color/ColorModelStrategy.cs +++ b/Terminal.Gui/Views/Color/ColorModelStrategy.cs @@ -1,4 +1,4 @@ -#nullable enable + using ColorHelper; using ColorConverter = ColorHelper.ColorConverter; diff --git a/Terminal.Gui/Views/Color/ColorPicker.16.cs b/Terminal.Gui/Views/Color/ColorPicker.16.cs index 8c76f2648..6c1eda4cb 100644 --- a/Terminal.Gui/Views/Color/ColorPicker.16.cs +++ b/Terminal.Gui/Views/Color/ColorPicker.16.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/Color/ColorPicker.Prompt.cs b/Terminal.Gui/Views/Color/ColorPicker.Prompt.cs index e6c29172c..907305471 100644 --- a/Terminal.Gui/Views/Color/ColorPicker.Prompt.cs +++ b/Terminal.Gui/Views/Color/ColorPicker.Prompt.cs @@ -1,3 +1,4 @@ +#nullable disable  namespace Terminal.Gui.Views; @@ -8,11 +9,12 @@ public partial class ColorPicker /// is false or true, respectively, for /// and colors. /// + /// The instance ot use. /// The title to show in the dialog. /// The current attribute used. /// The new attribute. /// if a new color was accepted, otherwise . - public static bool Prompt (string title, Attribute? currentAttribute, out Attribute newAttribute) + public static bool Prompt (IApplication app, string title, Attribute? currentAttribute, out Attribute newAttribute) { var accept = false; @@ -36,7 +38,7 @@ public partial class ColorPicker { accept = true; e.Handled = true; - Application.RequestStop (); + (s as View)?.App?.RequestStop (); }; var btnCancel = new Button @@ -50,7 +52,7 @@ public partial class ColorPicker btnCancel.Accepting += (s, e) => { e.Handled = true; - Application.RequestStop (); + (s as View)?.App ?.RequestStop (); }; d.Add (btnOk); @@ -113,12 +115,12 @@ public partial class ColorPicker d.Add (cpForeground, cpBackground); - Application.Run (d); + app.Run (d); d.Dispose (); Color newForeColor = Application.Force16Colors ? ((ColorPicker16)cpForeground).SelectedColor : ((ColorPicker)cpForeground).SelectedColor; Color newBackColor = Application.Force16Colors ? ((ColorPicker16)cpBackground).SelectedColor : ((ColorPicker)cpBackground).SelectedColor; newAttribute = new (newForeColor, newBackColor); - + app.Dispose (); return accept; } } diff --git a/Terminal.Gui/Views/Color/ColorPicker.Style.cs b/Terminal.Gui/Views/Color/ColorPicker.Style.cs index 616687156..afab89d5a 100644 --- a/Terminal.Gui/Views/Color/ColorPicker.Style.cs +++ b/Terminal.Gui/Views/Color/ColorPicker.Style.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/Color/ColorPicker.cs b/Terminal.Gui/Views/Color/ColorPicker.cs index 2a60e536b..60badf165 100644 --- a/Terminal.Gui/Views/Color/ColorPicker.cs +++ b/Terminal.Gui/Views/Color/ColorPicker.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.Views; @@ -34,9 +34,9 @@ public partial class ColorPicker : View, IDesignable private Color _selectedColor = Color.Black; // TODO: Add interface - private readonly IColorNameResolver _colorNameResolver = new MultiStandardColorNameResolver (); + private readonly IColorNameResolver _colorNameResolver = new StandardColorsNameResolver (); - private List _bars = new (); + private List _bars = []; /// /// Rebuild the user interface to reflect the new state of . @@ -47,21 +47,21 @@ public partial class ColorPicker : View, IDesignable DisposeOldViews (); var y = 0; - const int textFieldWidth = 4; + const int TEXT_FIELD_WIDTH = 4; foreach (ColorBar bar in _strategy.CreateBars (Style.ColorModel)) { bar.Y = y; - bar.Width = Dim.Fill (Style.ShowTextFields ? textFieldWidth : 0); + bar.Width = Dim.Fill (Style.ShowTextFields ? TEXT_FIELD_WIDTH : 0); TextField? tfValue = null; if (Style.ShowTextFields) { tfValue = new TextField { - X = Pos.AnchorEnd (textFieldWidth), + X = Pos.AnchorEnd (TEXT_FIELD_WIDTH), Y = y, - Width = textFieldWidth + Width = TEXT_FIELD_WIDTH }; tfValue.HasFocusChanged += UpdateSingleBarValueFromTextField; tfValue.Accepting += (s, _) => UpdateSingleBarValueFromTextField (s); @@ -233,7 +233,10 @@ public partial class ColorPicker : View, IDesignable } } - private void RebuildColorFromBar (object? sender, EventArgs e) { SetSelectedColor (_strategy.GetColorFromBars (_bars, Style.ColorModel), false); } + private void RebuildColorFromBar (object? sender, EventArgs e) + { + SetSelectedColor (_strategy.GetColorFromBars (_bars, Style.ColorModel), false); + } private void SetSelectedColor (Color value, bool syncBars) { @@ -242,9 +245,7 @@ public partial class ColorPicker : View, IDesignable Color old = _selectedColor; _selectedColor = value; - ColorChanged?.Invoke ( - this, - new (value)); + ColorChanged?.Invoke (this, new (value)); } SyncSubViewValues (syncBars); @@ -290,15 +291,16 @@ public partial class ColorPicker : View, IDesignable } private void UpdateSingleBarValueFromTextField (object? sender) { - foreach (KeyValuePair kvp in _textFields) { - if (kvp.Value == sender) + if (kvp.Value != sender) { - if (int.TryParse (kvp.Value.Text, out int v)) - { - kvp.Key.Value = v; - } + continue; + } + + if (int.TryParse (kvp.Value.Text, out int v)) + { + kvp.Key.Value = v; } } } @@ -314,6 +316,7 @@ public partial class ColorPicker : View, IDesignable // it is a leave event so update UpdateValueFromName (); } + private void UpdateValueFromName () { if (_tfName == null) diff --git a/Terminal.Gui/Views/Color/GBar.cs b/Terminal.Gui/Views/Color/GBar.cs index ac9a7227f..b9dd5b435 100644 --- a/Terminal.Gui/Views/Color/GBar.cs +++ b/Terminal.Gui/Views/Color/GBar.cs @@ -1,4 +1,4 @@ -#nullable enable + using ColorHelper; diff --git a/Terminal.Gui/Views/Color/HueBar.cs b/Terminal.Gui/Views/Color/HueBar.cs index 9f7d29e45..fef601bb8 100644 --- a/Terminal.Gui/Views/Color/HueBar.cs +++ b/Terminal.Gui/Views/Color/HueBar.cs @@ -1,10 +1,11 @@ -#nullable enable - using ColorHelper; using ColorConverter = ColorHelper.ColorConverter; namespace Terminal.Gui.Views; +/// +/// A bar representing the Hue component of a in HSL color space. +/// internal class HueBar : ColorBar { /// diff --git a/Terminal.Gui/Views/Color/IColorBar.cs b/Terminal.Gui/Views/Color/IColorBar.cs index b8139b8d5..176edead9 100644 --- a/Terminal.Gui/Views/Color/IColorBar.cs +++ b/Terminal.Gui/Views/Color/IColorBar.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; internal interface IColorBar diff --git a/Terminal.Gui/Views/Color/LightnessBar.cs b/Terminal.Gui/Views/Color/LightnessBar.cs index 0f176a3f6..f3d1e3942 100644 --- a/Terminal.Gui/Views/Color/LightnessBar.cs +++ b/Terminal.Gui/Views/Color/LightnessBar.cs @@ -1,4 +1,4 @@ -#nullable enable + using ColorHelper; using ColorConverter = ColorHelper.ColorConverter; diff --git a/Terminal.Gui/Views/Color/RBar.cs b/Terminal.Gui/Views/Color/RBar.cs index 2610c66bb..e71dd9246 100644 --- a/Terminal.Gui/Views/Color/RBar.cs +++ b/Terminal.Gui/Views/Color/RBar.cs @@ -1,4 +1,4 @@ -#nullable enable + using ColorHelper; diff --git a/Terminal.Gui/Views/Color/SaturationBar.cs b/Terminal.Gui/Views/Color/SaturationBar.cs index 76fcd2029..9be7ab7f7 100644 --- a/Terminal.Gui/Views/Color/SaturationBar.cs +++ b/Terminal.Gui/Views/Color/SaturationBar.cs @@ -1,4 +1,4 @@ -#nullable enable + using ColorHelper; using ColorConverter = ColorHelper.ColorConverter; diff --git a/Terminal.Gui/Views/Color/ValueBar.cs b/Terminal.Gui/Views/Color/ValueBar.cs index 6352c7cab..5673ce8db 100644 --- a/Terminal.Gui/Views/Color/ValueBar.cs +++ b/Terminal.Gui/Views/Color/ValueBar.cs @@ -1,4 +1,4 @@ -#nullable enable + using ColorHelper; using ColorConverter = ColorHelper.ColorConverter; diff --git a/Terminal.Gui/Views/ComboBox.cs b/Terminal.Gui/Views/ComboBox.cs index 6da8acaea..83e72ac79 100644 --- a/Terminal.Gui/Views/ComboBox.cs +++ b/Terminal.Gui/Views/ComboBox.cs @@ -1,3 +1,4 @@ +#nullable disable // // ComboBox.cs: ComboBox control // @@ -46,9 +47,9 @@ public class ComboBox : View, IDesignable }; _listview.SelectedItemChanged += (sender, e) => { - if (!HideDropdownListOnClick && _searchSet.Count > 0) + if (e.Item >= 0 && !HideDropdownListOnClick && _searchSet.Count > 0) { - SetValue (_searchSet [_listview.SelectedItem]); + SetValue (_searchSet [e.Item.Value]); } }; Add (_search, _listview); @@ -113,7 +114,7 @@ public class ComboBox : View, IDesignable /// protected override bool OnSettingScheme (ValueChangingEventArgs args) { - _listview.SetScheme(args.NewValue); + _listview.SetScheme (args.NewValue); return base.OnSettingScheme (args); } @@ -460,7 +461,10 @@ public class ComboBox : View, IDesignable private void FocusSelectedItem () { - _listview.SelectedItem = SelectedItem > -1 ? SelectedItem : 0; + if (_listview.Source?.Count > 0) + { + _listview.SelectedItem = SelectedItem > -1 ? SelectedItem : 0; + } _listview.TabStop = TabBehavior.TabStop; _listview.SetFocus (); OnExpanded (); @@ -516,9 +520,9 @@ public class ComboBox : View, IDesignable _listview.TabStop = TabBehavior.TabStop; _listview.SetFocus (); - if (_listview.SelectedItem > -1) + if (_listview.SelectedItem is { }) { - SetValue (_searchSet [_listview.SelectedItem]); + SetValue (_searchSet [_listview.SelectedItem.Value]); } else { @@ -727,7 +731,7 @@ public class ComboBox : View, IDesignable IsShow = false; _listview.TabStop = TabBehavior.NoStop; - if (_listview.Source.Count == 0 || (_searchSet?.Count ?? 0) == 0) + if (_listview.Source!.Count == 0 || (_searchSet?.Count ?? 0) == 0) { _text = ""; HideList (); @@ -736,7 +740,7 @@ public class ComboBox : View, IDesignable return false; } - SetValue (_listview.SelectedItem > -1 ? _searchSet [_listview.SelectedItem] : _text); + SetValue (_listview.SelectedItem is { } ? _searchSet [_listview.SelectedItem.Value] : _text); _search.CursorPosition = _search.Text.GetColumns (); ShowHideList (Text); OnOpenSelectedItem (); @@ -976,7 +980,11 @@ public class ComboBox : View, IDesignable { bool res = base.OnSelectedChanged (); - _highlighted = SelectedItem; + if (SelectedItem is null) + { + return res; + } + _highlighted = SelectedItem.Value; return res; } @@ -996,7 +1004,7 @@ public class ComboBox : View, IDesignable _container = container ?? throw new ArgumentNullException ( nameof (container), - "ComboBox container cannot be null." + @"ComboBox container cannot be null." ); HideDropdownListOnClick = hideDropdownListOnClick; AddCommand (Command.Up, () => _container.MoveUpList ()); diff --git a/Terminal.Gui/Views/DatePicker.cs b/Terminal.Gui/Views/DatePicker.cs index a4f2791af..579607d3d 100644 --- a/Terminal.Gui/Views/DatePicker.cs +++ b/Terminal.Gui/Views/DatePicker.cs @@ -1,4 +1,4 @@ -#nullable enable + // // DatePicker.cs: DatePicker control diff --git a/Terminal.Gui/Views/Dialog.cs b/Terminal.Gui/Views/Dialog.cs index bf5379f36..ddb813f7a 100644 --- a/Terminal.Gui/Views/Dialog.cs +++ b/Terminal.Gui/Views/Dialog.cs @@ -1,27 +1,33 @@ -#nullable enable namespace Terminal.Gui.Views; /// -/// A . Supports a simple API for adding s +/// Supports a simple API for adding s /// across the bottom. By default, the is centered and used the /// scheme. /// /// /// To run the modally, create the , and pass it to -/// . This will execute the dialog until +/// . This will execute the dialog until /// it terminates via the (`Esc` by default), /// or when one of the views or buttons added to the dialog calls -/// . +/// . /// public class Dialog : Window { + private static LineStyle _defaultBorderStyle = LineStyle.Heavy; // Resources/config.json overrides + private static Alignment _defaultButtonAlignment = Alignment.End; // Resources/config.json overrides + private static AlignmentModes _defaultButtonAlignmentModes = AlignmentModes.StartToEnd | AlignmentModes.AddSpaceBetweenItems; // Resources/config.json overrides + private static int _defaultMinimumHeight = 80; // Resources/config.json overrides + private static int _defaultMinimumWidth = 80; // Resources/config.json overrides + private static ShadowStyle _defaultShadow = ShadowStyle.Transparent; // Resources/config.json overrides + /// /// Initializes a new instance of the class with no s. /// /// /// By default, , , , and are /// set - /// such that the will be centered in, and no larger than 90% of , if + /// such that the will be centered in, and no larger than 90% of , if /// there is one. Otherwise, /// it will be bound by the screen dimensions. /// @@ -38,7 +44,6 @@ public class Dialog : Window SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Dialog); - Modal = true; ButtonAlignment = DefaultButtonAlignment; ButtonAlignmentModes = DefaultButtonAlignmentModes; } @@ -107,37 +112,61 @@ public class Dialog : Window /// [ConfigurationProperty (Scope = typeof (ThemeScope))] - public new static LineStyle DefaultBorderStyle { get; set; } = LineStyle.Heavy; + public new static LineStyle DefaultBorderStyle + { + get => _defaultBorderStyle; + set => _defaultBorderStyle = value; + } /// The default for . /// This property can be set in a Theme. [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static Alignment DefaultButtonAlignment { get; set; } = Alignment.End; + public static Alignment DefaultButtonAlignment + { + get => _defaultButtonAlignment; + set => _defaultButtonAlignment = value; + } /// The default for . /// This property can be set in a Theme. [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static AlignmentModes DefaultButtonAlignmentModes { get; set; } = AlignmentModes.StartToEnd | AlignmentModes.AddSpaceBetweenItems; + public static AlignmentModes DefaultButtonAlignmentModes + { + get => _defaultButtonAlignmentModes; + set => _defaultButtonAlignmentModes = value; + } /// /// Defines the default minimum Dialog height, as a percentage of the container width. Can be configured via /// . /// [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static int DefaultMinimumHeight { get; set; } = 80; + public static int DefaultMinimumHeight + { + get => _defaultMinimumHeight; + set => _defaultMinimumHeight = value; + } /// /// Defines the default minimum Dialog width, as a percentage of the container width. Can be configured via /// . /// [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static int DefaultMinimumWidth { get; set; } = 80; + public static int DefaultMinimumWidth + { + get => _defaultMinimumWidth; + set => _defaultMinimumWidth = value; + } /// /// Gets or sets whether all s are shown with a shadow effect by default. /// [ConfigurationProperty (Scope = typeof (ThemeScope))] - public new static ShadowStyle DefaultShadow { get; set; } = ShadowStyle.Transparent; + public new static ShadowStyle DefaultShadow + { + get => _defaultShadow; + set => _defaultShadow = value; + } // Dialogs are Modal and Focus is indicated by their Border. The following code ensures the diff --git a/Terminal.Gui/Views/FileDialog.cs b/Terminal.Gui/Views/FileDialog.cs index 0519ecba6..644cc55d9 100644 --- a/Terminal.Gui/Views/FileDialog.cs +++ b/Terminal.Gui/Views/FileDialog.cs @@ -1 +1,2 @@ - \ No newline at end of file +#nullable disable + diff --git a/Terminal.Gui/Views/FileDialogs/AllowedType.cs b/Terminal.Gui/Views/FileDialogs/AllowedType.cs index 8460edadf..2bcdfbe4a 100644 --- a/Terminal.Gui/Views/FileDialogs/AllowedType.cs +++ b/Terminal.Gui/Views/FileDialogs/AllowedType.cs @@ -1,3 +1,4 @@ +#nullable disable  namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/FileDialogs/DefaultFileOperations.cs b/Terminal.Gui/Views/FileDialogs/DefaultFileOperations.cs index 5f0aefcad..25214cf17 100644 --- a/Terminal.Gui/Views/FileDialogs/DefaultFileOperations.cs +++ b/Terminal.Gui/Views/FileDialogs/DefaultFileOperations.cs @@ -1,3 +1,4 @@ +#nullable disable using System.IO.Abstractions; namespace Terminal.Gui.Views; @@ -6,7 +7,7 @@ namespace Terminal.Gui.Views; public class DefaultFileOperations : IFileOperations { /// - public bool Delete (IEnumerable toDelete) + public bool Delete (IApplication app, IEnumerable toDelete) { // Default implementation does not allow deleting multiple files if (toDelete.Count () != 1) @@ -17,7 +18,7 @@ public class DefaultFileOperations : IFileOperations IFileSystemInfo d = toDelete.Single (); string adjective = d.Name; - int result = MessageBox.Query ( + int? result = MessageBox.Query (app, string.Format (Strings.fdDeleteTitle, adjective), string.Format (Strings.fdDeleteBody, adjective), Strings.btnYes, @@ -42,14 +43,14 @@ public class DefaultFileOperations : IFileOperations } catch (Exception ex) { - MessageBox.ErrorQuery (Strings.fdDeleteFailedTitle, ex.Message, Strings.btnOk); + MessageBox.ErrorQuery (app, Strings.fdDeleteFailedTitle, ex.Message, Strings.btnOk); } return false; } /// - public IFileSystemInfo Rename (IFileSystem fileSystem, IFileSystemInfo toRename) + public IFileSystemInfo Rename (IApplication app, IFileSystem fileSystem, IFileSystemInfo toRename) { // Don't allow renaming C: or D: or / (on linux) etc if (toRename is IDirectoryInfo dir && dir.Parent is null) @@ -94,7 +95,7 @@ public class DefaultFileOperations : IFileOperations } catch (Exception ex) { - MessageBox.ErrorQuery (Strings.fdRenameFailedTitle, ex.Message, "Ok"); + MessageBox.ErrorQuery (app, Strings.fdRenameFailedTitle, ex.Message, "Ok"); } } } @@ -103,7 +104,7 @@ public class DefaultFileOperations : IFileOperations } /// - public IFileSystemInfo New (IFileSystem fileSystem, IDirectoryInfo inDirectory) + public IFileSystemInfo New (IApplication app, IFileSystem fileSystem, IDirectoryInfo inDirectory) { if (Prompt (Strings.fdNewTitle, "", out string named)) { @@ -121,7 +122,7 @@ public class DefaultFileOperations : IFileOperations } catch (Exception ex) { - MessageBox.ErrorQuery (Strings.fdNewFailed, ex.Message, "Ok"); + MessageBox.ErrorQuery (app, Strings.fdNewFailed, ex.Message, "Ok"); } } } @@ -137,7 +138,7 @@ public class DefaultFileOperations : IFileOperations btnOk.Accepting += (s, e) => { confirm = true; - Application.RequestStop (); + (s as View)?.App?.RequestStop (); // When Accepting is handled, set e.Handled to true to prevent further processing. e.Handled = true; }; @@ -146,7 +147,7 @@ public class DefaultFileOperations : IFileOperations btnCancel.Accepting += (s, e) => { confirm = false; - Application.RequestStop (); + (s as View)?.App?.RequestStop (); // When Accepting is handled, set e.Handled to true to prevent further processing. e.Handled = true; }; diff --git a/Terminal.Gui/Views/FileDialogs/FileDialog.cs b/Terminal.Gui/Views/FileDialogs/FileDialog.cs index 1d2a3533f..afaa624c8 100644 --- a/Terminal.Gui/Views/FileDialogs/FileDialog.cs +++ b/Terminal.Gui/Views/FileDialogs/FileDialog.cs @@ -1,4 +1,3 @@ -#nullable enable using System.IO.Abstractions; using System.Text.RegularExpressions; @@ -43,14 +42,15 @@ public class FileDialog : Dialog, IDesignable private readonly TextField _tbFind; private readonly TextField _tbPath; private readonly TreeView _treeView; +#if MENU_V1 private MenuBarItem? _allowedTypeMenu; private MenuBar? _allowedTypeMenuBar; private MenuItem []? _allowedTypeMenuItems; +#endif private int _currentSortColumn; private bool _currentSortIsAsc = true; private bool _disposed; private string? _feedback; - private bool _loaded; private bool _pushingState; private Dictionary _treeRoots = new (); @@ -105,9 +105,9 @@ public class FileDialog : Dialog, IDesignable e.Handled = true; - if (Modal) + if (IsModal) { - Application.RequestStop (); + (s as View)?.App?.RequestStop (); } }; @@ -435,19 +435,17 @@ public class FileDialog : Dialog, IDesignable } /// - public override void OnLoaded () + protected override void OnIsRunningChanged (bool newIsRunning) { - base.OnLoaded (); + base.OnIsRunningChanged (newIsRunning); - if (_loaded) + if (!newIsRunning) { return; } Arrangement |= ViewArrangement.Resizable; - _loaded = true; - // May have been updated after instance was constructed _btnOk.Text = Style.OkButtonText; _btnCancel.Text = Style.CancelButtonText; @@ -477,6 +475,7 @@ public class FileDialog : Dialog, IDesignable // Fiddle factor int width = AllowedTypes.Max (a => a.ToString ()!.Length) + 6; +#if MENU_V1 _allowedTypeMenu = new ( "", _allowedTypeMenuItems = AllowedTypes.Select ( @@ -510,6 +509,7 @@ public class FileDialog : Dialog, IDesignable }; Add (_allowedTypeMenuBar); +#endif } // if no path has been provided @@ -729,6 +729,7 @@ public class FileDialog : Dialog, IDesignable Accept (false); } } +#if MENU_V1 private void AllowedTypeMenuClicked (int idx) { @@ -749,6 +750,7 @@ public class FileDialog : Dialog, IDesignable State?.RefreshChildren (); WriteStateToTableView (); } +#endif private string AspectGetter (object o) { @@ -827,7 +829,7 @@ public class FileDialog : Dialog, IDesignable return _tableView.GetScheme (); } - Color color = Style.ColorProvider.GetColor (stats.FileSystemInfo) ?? new Color (Color.White); + Color color = Style.ColorProvider.GetColor (stats.FileSystemInfo!) ?? new Color (Color.White); var black = new Color (Color.Black); // TODO: Add some kind of cache for this @@ -844,7 +846,7 @@ public class FileDialog : Dialog, IDesignable { IFileSystemInfo [] toDelete = GetFocusedFiles ()!; - if (FileOperationsHandler.Delete (toDelete)) + if (FileOperationsHandler.Delete (App, toDelete)) { RefreshState (); } @@ -872,9 +874,9 @@ public class FileDialog : Dialog, IDesignable Canceled = false; - if (Modal) + if (IsModal) { - Application.RequestStop (); + App?.RequestStop (); } } @@ -1034,7 +1036,7 @@ public class FileDialog : Dialog, IDesignable private void New () { { - IFileSystemInfo created = FileOperationsHandler.New (_fileSystem, State!.Directory); + IFileSystemInfo created = FileOperationsHandler.New (App, _fileSystem!, State!.Directory); if (created is { }) { @@ -1169,13 +1171,13 @@ public class FileDialog : Dialog, IDesignable PushState (State, false, false, false); } - private void Rename () + private void Rename (IApplication? app) { IFileSystemInfo [] toRename = GetFocusedFiles ()!; if (toRename?.Length == 1) { - IFileSystemInfo newNamed = FileOperationsHandler.Rename (_fileSystem, toRename.Single ()); + IFileSystemInfo newNamed = FileOperationsHandler.Rename (app, _fileSystem!, toRename.Single ()); if (newNamed is { }) { @@ -1225,7 +1227,7 @@ public class FileDialog : Dialog, IDesignable PopoverMenu? contextMenu = new ( [ new (Strings.fdCtxNew, string.Empty, New), - new (Strings.fdCtxRename, string.Empty, Rename), + new (Strings.fdCtxRename, string.Empty, () => Rename (App)), new (Strings.fdCtxDelete, string.Empty, Delete) ]); @@ -1233,7 +1235,7 @@ public class FileDialog : Dialog, IDesignable // Registering with the PopoverManager will ensure that the context menu is closed when the view is no longer focused // and the context menu is disposed when it is closed. - Application.Popover?.Register (contextMenu); + App!.Popover?.Register (contextMenu); contextMenu?.MakeVisible (e.ScreenPosition); } @@ -1261,7 +1263,7 @@ public class FileDialog : Dialog, IDesignable // Registering with the PopoverManager will ensure that the context menu is closed when the view is no longer focused // and the context menu is disposed when it is closed. - Application.Popover?.Register (contextMenu); + App!.Popover?.Register (contextMenu); contextMenu?.MakeVisible (e.ScreenPosition); } @@ -1322,7 +1324,7 @@ public class FileDialog : Dialog, IDesignable if (keyEvent.KeyCode == (KeyCode.CtrlMask | KeyCode.R)) { - Rename (); + Rename (App); return true; } @@ -1569,7 +1571,7 @@ public class FileDialog : Dialog, IDesignable } } - if (Parent.SearchMatcher.IsMatch (f.FileSystemInfo)) + if (Parent.SearchMatcher.IsMatch (f.FileSystemInfo!)) { lock (_oLockFound) { @@ -1612,7 +1614,7 @@ public class FileDialog : Dialog, IDesignable UpdateChildrenToFound (); } - Application.Invoke (() => { Parent._spinnerView.Visible = false; }); + Application.Invoke ((_) => { Parent._spinnerView.Visible = false; }); } } @@ -1624,7 +1626,7 @@ public class FileDialog : Dialog, IDesignable } Application.Invoke ( - () => + (_) => { Parent._tbPath.Autocomplete.GenerateSuggestions ( new AutocompleteFilepathContext ( @@ -1644,9 +1646,7 @@ public class FileDialog : Dialog, IDesignable bool IDesignable.EnableForDesign () { - Modal = false; - OnLoaded (); - + OnIsRunningChanged (true); return true; } } \ No newline at end of file diff --git a/Terminal.Gui/Views/FileDialogs/FileDialogCollectionNavigator.cs b/Terminal.Gui/Views/FileDialogs/FileDialogCollectionNavigator.cs index d482c0a89..9e0590b83 100644 --- a/Terminal.Gui/Views/FileDialogs/FileDialogCollectionNavigator.cs +++ b/Terminal.Gui/Views/FileDialogs/FileDialogCollectionNavigator.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; internal class FileDialogCollectionNavigator (FileDialog fileDialog, TableView tableView) : CollectionNavigatorBase diff --git a/Terminal.Gui/Views/FileDialogs/FileDialogHistory.cs b/Terminal.Gui/Views/FileDialogs/FileDialogHistory.cs index 6558d40d9..535a19777 100644 --- a/Terminal.Gui/Views/FileDialogs/FileDialogHistory.cs +++ b/Terminal.Gui/Views/FileDialogs/FileDialogHistory.cs @@ -1,3 +1,4 @@ +#nullable disable using System.IO.Abstractions; namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/FileDialogs/FileDialogState.cs b/Terminal.Gui/Views/FileDialogs/FileDialogState.cs index 26cde6a62..aec681817 100644 --- a/Terminal.Gui/Views/FileDialogs/FileDialogState.cs +++ b/Terminal.Gui/Views/FileDialogs/FileDialogState.cs @@ -1,3 +1,4 @@ +#nullable disable using System.IO.Abstractions; namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/FileDialogs/FileDialogStyle.cs b/Terminal.Gui/Views/FileDialogs/FileDialogStyle.cs index 0ee7ac5aa..c72f24d8a 100644 --- a/Terminal.Gui/Views/FileDialogs/FileDialogStyle.cs +++ b/Terminal.Gui/Views/FileDialogs/FileDialogStyle.cs @@ -1,3 +1,4 @@ +#nullable disable using System.Diagnostics.CodeAnalysis; using System.Globalization; using System.IO.Abstractions; diff --git a/Terminal.Gui/Views/FileDialogs/FileDialogTableSource.cs b/Terminal.Gui/Views/FileDialogs/FileDialogTableSource.cs index 14d37f097..bf15d3bac 100644 --- a/Terminal.Gui/Views/FileDialogs/FileDialogTableSource.cs +++ b/Terminal.Gui/Views/FileDialogs/FileDialogTableSource.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.Views; internal class FileDialogTableSource ( diff --git a/Terminal.Gui/Views/FileDialogs/FilesSelectedEventArgs.cs b/Terminal.Gui/Views/FileDialogs/FilesSelectedEventArgs.cs index 56ba5f1fe..f8629e31a 100644 --- a/Terminal.Gui/Views/FileDialogs/FilesSelectedEventArgs.cs +++ b/Terminal.Gui/Views/FileDialogs/FilesSelectedEventArgs.cs @@ -1,3 +1,4 @@ +#nullable disable  namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/FileDialogs/OpenDialog.cs b/Terminal.Gui/Views/FileDialogs/OpenDialog.cs index 5f916b1de..3d053b06a 100644 --- a/Terminal.Gui/Views/FileDialogs/OpenDialog.cs +++ b/Terminal.Gui/Views/FileDialogs/OpenDialog.cs @@ -1,3 +1,4 @@ +#nullable disable // // FileDialog.cs: File system dialogs for open and save // @@ -17,15 +18,15 @@ namespace Terminal.Gui.Views; /// /// /// The open dialog can be used to select files for opening, it can be configured to allow multiple items to be -/// selected (based on the AllowsMultipleSelection) variable and you can control whether this should allow files or +/// selected (based on the AllowsMultipleSelection) variable, and you can control whether this should allow files or /// directories to be selected. /// /// /// To use, create an instance of , and pass it to -/// . This will run the dialog modally, and when this returns, +/// . This will run the dialog modally, and when this returns, /// the list of files will be available on the property. /// -/// To select more than one file, users can use the spacebar, or control-t. +/// To select more than one file, users can use the space key, or CTRL-T. /// public class OpenDialog : FileDialog { diff --git a/Terminal.Gui/Views/FileDialogs/OpenMode.cs b/Terminal.Gui/Views/FileDialogs/OpenMode.cs index e50370ea2..e3e62d60f 100644 --- a/Terminal.Gui/Views/FileDialogs/OpenMode.cs +++ b/Terminal.Gui/Views/FileDialogs/OpenMode.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// Determine which type to open. diff --git a/Terminal.Gui/Views/FileDialogs/SaveDialog.cs b/Terminal.Gui/Views/FileDialogs/SaveDialog.cs index 7646817f8..5ed07726a 100644 --- a/Terminal.Gui/Views/FileDialogs/SaveDialog.cs +++ b/Terminal.Gui/Views/FileDialogs/SaveDialog.cs @@ -1,3 +1,4 @@ +#nullable disable // // FileDialog.cs: File system dialogs for open and save // @@ -17,7 +18,7 @@ namespace Terminal.Gui.Views; /// /// /// To use, create an instance of , and pass it to -/// . This will run the dialog modally, and when this returns, +/// . This will run the dialog modally, and when this returns, /// the property will contain the selected file name or null if the user canceled. /// /// diff --git a/Terminal.Gui/Views/FrameView.cs b/Terminal.Gui/Views/FrameView.cs index 4f8713c8b..db2c0c2df 100644 --- a/Terminal.Gui/Views/FrameView.cs +++ b/Terminal.Gui/Views/FrameView.cs @@ -1,5 +1,3 @@ -#nullable enable - namespace Terminal.Gui.Views; // TODO: FrameView is mis-named, really. It's far more about it being a TabGroup than a frame. @@ -19,6 +17,8 @@ namespace Terminal.Gui.Views; /// public class FrameView : View { + private static LineStyle _defaultBorderStyle = LineStyle.Rounded; // Resources/config.json overrides + /// /// Initializes a new instance of the class. /// layout. @@ -31,13 +31,17 @@ public class FrameView : View } /// - /// The default for 's border. The default is - /// . + /// Defines the default border styling for . Can be configured via + /// . /// /// /// This property can be set in a Theme to change the default for all /// s. /// [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static LineStyle DefaultBorderStyle { get; set; } = LineStyle.Rounded; + public static LineStyle DefaultBorderStyle + { + get => _defaultBorderStyle; + set => _defaultBorderStyle = value; + } } diff --git a/Terminal.Gui/Views/GraphView/Axis.cs b/Terminal.Gui/Views/GraphView/Axis.cs index 3160f3ee3..177500f9f 100644 --- a/Terminal.Gui/Views/GraphView/Axis.cs +++ b/Terminal.Gui/Views/GraphView/Axis.cs @@ -1,3 +1,4 @@ +#nullable disable  namespace Terminal.Gui.Views; diff --git a/Terminal.Gui/Views/GraphView/BarSeriesBar.cs b/Terminal.Gui/Views/GraphView/BarSeriesBar.cs index efe17b59c..29f401e85 100644 --- a/Terminal.Gui/Views/GraphView/BarSeriesBar.cs +++ b/Terminal.Gui/Views/GraphView/BarSeriesBar.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// A single bar in a diff --git a/Terminal.Gui/Views/GraphView/GraphCellToRender.cs b/Terminal.Gui/Views/GraphView/GraphCellToRender.cs index 8bf4d99e9..db1b56e5c 100644 --- a/Terminal.Gui/Views/GraphView/GraphCellToRender.cs +++ b/Terminal.Gui/Views/GraphView/GraphCellToRender.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// diff --git a/Terminal.Gui/Views/GraphView/GraphView.cs b/Terminal.Gui/Views/GraphView/GraphView.cs index 92b31a60f..03cda9fed 100644 --- a/Terminal.Gui/Views/GraphView/GraphView.cs +++ b/Terminal.Gui/Views/GraphView/GraphView.cs @@ -1,4 +1,4 @@ -#nullable enable + namespace Terminal.Gui.Views; @@ -344,7 +344,7 @@ public class GraphView : View, IDesignable } /// - /// Sets the color attribute of to the (if defined) or + /// Sets the color attribute of to the (if defined) or /// otherwise. /// public void SetDriverColorToGraphColor () { SetAttribute (GraphColor ?? GetAttributeForRole (VisualRole.Normal)); } diff --git a/Terminal.Gui/Views/GraphView/IAnnotation.cs b/Terminal.Gui/Views/GraphView/IAnnotation.cs index 004339875..c396df59d 100644 --- a/Terminal.Gui/Views/GraphView/IAnnotation.cs +++ b/Terminal.Gui/Views/GraphView/IAnnotation.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// diff --git a/Terminal.Gui/Views/GraphView/LegendAnnotation.cs b/Terminal.Gui/Views/GraphView/LegendAnnotation.cs index 813228f7d..d8ac4be8b 100644 --- a/Terminal.Gui/Views/GraphView/LegendAnnotation.cs +++ b/Terminal.Gui/Views/GraphView/LegendAnnotation.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// diff --git a/Terminal.Gui/Views/GraphView/LineF.cs b/Terminal.Gui/Views/GraphView/LineF.cs index 67ef51cd1..462b03224 100644 --- a/Terminal.Gui/Views/GraphView/LineF.cs +++ b/Terminal.Gui/Views/GraphView/LineF.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// Describes two points in graph space and a line between them diff --git a/Terminal.Gui/Views/GraphView/PathAnnotation.cs b/Terminal.Gui/Views/GraphView/PathAnnotation.cs index 4a623f7df..622ea83a8 100644 --- a/Terminal.Gui/Views/GraphView/PathAnnotation.cs +++ b/Terminal.Gui/Views/GraphView/PathAnnotation.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// Sequence of lines to connect points e.g. of a diff --git a/Terminal.Gui/Views/GraphView/Series.cs b/Terminal.Gui/Views/GraphView/Series.cs index 187d6e6be..d417404ba 100644 --- a/Terminal.Gui/Views/GraphView/Series.cs +++ b/Terminal.Gui/Views/GraphView/Series.cs @@ -1,7 +1,6 @@ using System.Collections.ObjectModel; namespace Terminal.Gui.Views; -#nullable enable /// Describes a series of data that can be rendered into a > public interface ISeries { diff --git a/Terminal.Gui/Views/GraphView/TextAnnotation.cs b/Terminal.Gui/Views/GraphView/TextAnnotation.cs index 98f1fec3e..d1309fe9e 100644 --- a/Terminal.Gui/Views/GraphView/TextAnnotation.cs +++ b/Terminal.Gui/Views/GraphView/TextAnnotation.cs @@ -1,3 +1,4 @@ +#nullable disable namespace Terminal.Gui.Views; /// Displays text at a given position (in screen space or graph space) diff --git a/Terminal.Gui/Views/HexView.cs b/Terminal.Gui/Views/HexView.cs index cf645b03d..ee81eb832 100644 --- a/Terminal.Gui/Views/HexView.cs +++ b/Terminal.Gui/Views/HexView.cs @@ -1,4 +1,4 @@ -#nullable enable + // // HexView.cs: A hexadecimal viewer diff --git a/Terminal.Gui/Views/HexViewEventArgs.cs b/Terminal.Gui/Views/HexViewEventArgs.cs index 11e372115..2ee496b17 100644 --- a/Terminal.Gui/Views/HexViewEventArgs.cs +++ b/Terminal.Gui/Views/HexViewEventArgs.cs @@ -1,3 +1,4 @@ +#nullable disable // // HexView.cs: A hexadecimal viewer // diff --git a/Terminal.Gui/Views/IListDataSource.cs b/Terminal.Gui/Views/IListDataSource.cs index 37f1a63d6..d5d1e5bde 100644 --- a/Terminal.Gui/Views/IListDataSource.cs +++ b/Terminal.Gui/Views/IListDataSource.cs @@ -1,46 +1,71 @@ -#nullable enable +#nullable disable using System.Collections; using System.Collections.Specialized; namespace Terminal.Gui.Views; -/// Implement to provide custom rendering for a . +/// +/// Provides data and rendering for . Implement this interface to provide custom rendering +/// or to wrap custom data sources. +/// +/// +/// +/// The default implementation is which renders items using +/// . +/// +/// +/// Implementors must manage their own marking state and raise when the +/// underlying data changes. +/// +/// public interface IListDataSource : IDisposable { /// - /// Event to raise when an item is added, removed, or moved, or the entire list is refreshed. + /// Raised when items are added, removed, moved, or the entire collection is refreshed. /// + /// + /// subscribes to this event to update its display and content size when the data + /// changes. Implementations should raise this event whenever the underlying collection changes, unless + /// is . + /// event NotifyCollectionChangedEventHandler CollectionChanged; - /// Returns the number of elements to display + /// Gets the number of items in the data source. int Count { get; } - /// Returns the maximum length of elements to display - int Length { get; } - - /// - /// Allow suspending the event from being invoked, - /// if , otherwise is . - /// - bool SuspendCollectionChangedEvent { get; set; } - - /// Should return whether the specified item is currently marked. - /// , if marked, otherwise. - /// Item index. + /// Determines whether the specified item is marked. + /// The zero-based index of the item. + /// if the item is marked; otherwise . + /// + /// calls this method to determine whether to render the item with a mark indicator when + /// is . + /// bool IsMarked (int item); - /// This method is invoked to render a specified item, the method should cover the entire provided width. - /// The render. - /// The list view to render. - /// Describes whether the item being rendered is currently selected by the user. - /// The index of the item to render, zero for the first item and so on. - /// The column where the rendering will start - /// The line where the rendering will be done. - /// The width that must be filled out. - /// The index of the string to be displayed. + /// Gets the width in columns of the widest item in the data source. /// - /// The default color will be set before this method is invoked, and will be based on whether the item is selected - /// or not. + /// uses this value to set its horizontal content size for scrolling. + /// + int Length { get; } + + /// Renders the specified item to the . + /// The to render to. + /// + /// if the item is currently selected; otherwise . + /// + /// The zero-based index of the item to render. + /// The column in where rendering starts. + /// The line in where rendering occurs. + /// The width available for rendering. + /// The horizontal scroll offset. + /// + /// + /// calls this method for each visible item during rendering. The color scheme will be + /// set based on selection state before this method is called. + /// + /// + /// Implementations must fill the entire to avoid rendering artifacts. + /// /// void Render ( ListView listView, @@ -49,15 +74,33 @@ public interface IListDataSource : IDisposable int col, int line, int width, - int start = 0 + int viewportX = 0 ); - /// Flags the item as marked. - /// Item index. - /// If set to value. + /// Sets the marked state of the specified item. + /// The zero-based index of the item. + /// to mark the item; to unmark it. + /// + /// calls this method when the user toggles marking (e.g., via the SPACE key) if + /// is . + /// void SetMark (int item, bool value); - /// Return the source as IList. - /// + /// + /// Gets or sets whether the event should be suppressed. + /// + /// + /// Set to to prevent from being raised during bulk + /// operations. Set back to to resume event notifications. + /// + bool SuspendCollectionChangedEvent { get; set; } + + /// Returns the underlying data source as an . + /// The data source as an . + /// + /// uses this method to access individual items for events like + /// and to enable keyboard search via + /// . + /// IList ToList (); } diff --git a/Terminal.Gui/Views/Label.cs b/Terminal.Gui/Views/Label.cs index 5ea22dba9..c11347f9f 100644 --- a/Terminal.Gui/Views/Label.cs +++ b/Terminal.Gui/Views/Label.cs @@ -24,13 +24,13 @@ public class Label : View, IDesignable Width = Dim.Auto (DimAutoStyle.Text); // On HoKey, pass it to the next view - AddCommand (Command.HotKey, InvokeHotKeyOnNextPeer); + AddCommand (Command.HotKey, InvokeHotKeyOnNextPeer!); TitleChanged += Label_TitleChanged; MouseClick += Label_MouseClick; } - private void Label_MouseClick (object sender, MouseEventArgs e) + private void Label_MouseClick (object? sender, MouseEventArgs e) { if (!CanFocus) { @@ -38,7 +38,7 @@ public class Label : View, IDesignable } } - private void Label_TitleChanged (object sender, EventArgs e) + private void Label_TitleChanged (object? sender, EventArgs e) { base.Text = e.Value; TextFormatter.HotKeySpecifier = HotKeySpecifier; diff --git a/Terminal.Gui/Views/Line.cs b/Terminal.Gui/Views/Line.cs index 5b5a9c9a8..04ba5703f 100644 --- a/Terminal.Gui/Views/Line.cs +++ b/Terminal.Gui/Views/Line.cs @@ -1,5 +1,3 @@ -#nullable enable - namespace Terminal.Gui.Views; /// @@ -163,10 +161,7 @@ public class Line : View, IOrientation public event EventHandler>? OrientationChanged; #pragma warning restore CS0067 // The event is never used - /// - /// Called when has changed. - /// - /// The new orientation value. + /// public void OnOrientationChanged (Orientation newOrientation) { // Set dimensions based on new orientation: diff --git a/Terminal.Gui/Views/ListView.cs b/Terminal.Gui/Views/ListView.cs index b933af9e0..e958844bf 100644 --- a/Terminal.Gui/Views/ListView.cs +++ b/Terminal.Gui/Views/ListView.cs @@ -1,3 +1,4 @@ +#nullable enable using System.Collections; using System.Collections.ObjectModel; using System.Collections.Specialized; @@ -16,7 +17,8 @@ namespace Terminal.Gui.Views; /// /// /// By default uses to render the items of any -/// object (e.g. arrays, , and other collections). Alternatively, an +/// object (e.g. arrays, , and other collections). +/// Alternatively, an /// object that implements can be provided giving full control of what is rendered. /// /// @@ -42,11 +44,6 @@ namespace Terminal.Gui.Views; /// public class ListView : View, IDesignable { - private bool _allowsMarking; - private bool _allowsMultipleSelection = false; - private int _lastSelectedItem = -1; - private int _selected = -1; - private IListDataSource _source; // TODO: ListView has been upgraded to use Viewport and ContentSize instead of the // TODO: bespoke _top and _left. It was a quick & dirty port. There is now duplicate logic // TODO: that could be removed. @@ -62,22 +59,8 @@ public class ListView : View, IDesignable // Things this view knows how to do // - AddCommand (Command.Up, (ctx) => - { - if (RaiseSelecting (ctx) == true) - { - return true; - } - return MoveUp (); - }); - AddCommand (Command.Down, (ctx) => - { - if (RaiseSelecting (ctx) == true) - { - return true; - } - return MoveDown (); - }); + AddCommand (Command.Up, ctx => RaiseSelecting (ctx) == true || MoveUp ()); + AddCommand (Command.Down, ctx => RaiseSelecting (ctx) == true || MoveDown ()); // TODO: add RaiseSelecting to all of these AddCommand (Command.ScrollUp, () => ScrollVertical (-1)); @@ -90,66 +73,67 @@ public class ListView : View, IDesignable AddCommand (Command.ScrollRight, () => ScrollHorizontal (1)); // Accept (Enter key) - Raise Accept event - DO NOT advance state - AddCommand (Command.Accept, (ctx) => - { - if (RaiseAccepting (ctx) == true) - { - return true; - } + AddCommand ( + Command.Accept, + ctx => + { + if (RaiseAccepting (ctx) == true) + { + return true; + } - if (OnOpenSelectedItem ()) - { - return true; - } - - return false; - }); + return OnOpenSelectedItem (); + }); // Select (Space key and single-click) - If markable, change mark and raise Select event - AddCommand (Command.Select, (ctx) => - { - if (_allowsMarking) - { - if (RaiseSelecting (ctx) == true) - { - return true; - } + AddCommand ( + Command.Select, + ctx => + { + if (!_allowsMarking) + { + return false; + } - if (MarkUnmarkSelectedItem ()) - { - return true; - } - } - - return false; - }); + if (RaiseSelecting (ctx) == true) + { + return true; + } + return MarkUnmarkSelectedItem (); + }); // Hotkey - If none set, select and raise Select event. SetFocus. - DO NOT raise Accept - AddCommand (Command.HotKey, (ctx) => - { - if (SelectedItem == -1) - { - SelectedItem = 0; - if (RaiseSelecting (ctx) == true) - { - return true; + AddCommand ( + Command.HotKey, + ctx => + { + if (SelectedItem is { }) + { + return !SetFocus (); + } - } - } + SelectedItem = 0; - return !SetFocus (); - }); + if (RaiseSelecting (ctx) == true) + { + return true; + } - AddCommand (Command.SelectAll, (ctx) => - { - if (ctx is not CommandContext keyCommandContext) - { - return false; - } + return !SetFocus (); + }); - return keyCommandContext.Binding.Data is { } && MarkAll ((bool)keyCommandContext.Binding.Data); - }); + AddCommand ( + Command.SelectAll, + ctx => + { + if (ctx is not CommandContext keyCommandContext) + { + return false; + } + + return keyCommandContext.Binding.Data is { } && MarkAll ((bool)keyCommandContext.Binding.Data); + }); // Default keybindings for all ListViews KeyBindings.Add (Key.CursorUp, Command.Up); @@ -168,23 +152,25 @@ public class ListView : View, IDesignable KeyBindings.Add (Key.End, Command.End); // Key.Space is already bound to Command.Select; this gives us select then move down - KeyBindings.Add (Key.Space.WithShift, [Command.Select, Command.Down]); + KeyBindings.Add (Key.Space.WithShift, Command.Select, Command.Down); // Use the form of Add that lets us pass context to the handler KeyBindings.Add (Key.A.WithCtrl, new KeyBinding ([Command.SelectAll], true)); KeyBindings.Add (Key.U.WithCtrl, new KeyBinding ([Command.SelectAll], false)); } - /// - protected override void OnViewportChanged (DrawEventArgs e) - { - SetContentSize (new Size (MaxLength, _source?.Count ?? Viewport.Height)); - } + private bool _allowsMarking; + private bool _allowsMultipleSelection; - /// - protected override void OnFrameChanged (in Rectangle frame) + private IListDataSource? _source; + + /// + public bool EnableForDesign () { - EnsureSelectedItemVisible (); + ListWrapper source = new (["List Item 1", "List Item two", "List Item Quattro", "Last List Item"]); + Source = source; + + return true; } /// Gets or sets whether this allows items to be marked. @@ -216,10 +202,10 @@ public class ListView : View, IDesignable if (Source is { } && !_allowsMultipleSelection) { - // Clear all selections except selected + // Clear all selections except selected for (var i = 0; i < Source.Count; i++) { - if (Source.IsMarked (i) && i != _selected) + if (Source.IsMarked (i) && SelectedItem.HasValue && i != SelectedItem.Value) { Source.SetMark (i, false); } @@ -230,11 +216,34 @@ public class ListView : View, IDesignable } } + /// + /// Event to raise when an item is added, removed, or moved, or the entire list is refreshed. + /// + public event NotifyCollectionChangedEventHandler? CollectionChanged; + + /// Ensures the selected item is always visible on the screen. + public void EnsureSelectedItemVisible () + { + if (SelectedItem is null) + { + return; + } + + if (SelectedItem < Viewport.Y) + { + Viewport = Viewport with { Y = SelectedItem.Value }; + } + else if (Viewport.Height > 0 && SelectedItem >= Viewport.Y + Viewport.Height) + { + Viewport = Viewport with { Y = SelectedItem.Value - Viewport.Height + 1 }; + } + } + /// /// Gets the that searches the collection as the /// user types. /// - public IListCollectionNavigator KeystrokeNavigator { get; } = new CollectionNavigator(); + public IListCollectionNavigator KeystrokeNavigator { get; } = new CollectionNavigator (); /// Gets or sets the leftmost column that is currently visible (when scrolling horizontally). /// The left position. @@ -243,7 +252,7 @@ public class ListView : View, IDesignable get => Viewport.X; set { - if (_source is null) + if (Source is null) { return; } @@ -258,99 +267,6 @@ public class ListView : View, IDesignable } } - /// Gets the widest item in the list. - public int MaxLength => _source?.Length ?? 0; - - /// Gets or sets the index of the currently selected item. - /// The selected item. - public int SelectedItem - { - get => _selected; - set - { - if (_source is null || _source.Count == 0) - { - return; - } - - if (value < -1 || value >= _source.Count) - { - throw new ArgumentException ("value"); - } - - _selected = value; - OnSelectedChanged (); - } - } - - /// Gets or sets the backing this , enabling custom rendering. - /// The source. - /// Use to set a new source. - public IListDataSource Source - { - get => _source; - set - { - if (_source == value) - { - return; - } - - _source?.Dispose (); - _source = value; - - if (_source is { }) - { - _source.CollectionChanged += Source_CollectionChanged; - } - - SetContentSize (new Size (_source?.Length ?? Viewport.Width, _source?.Count ?? Viewport.Width)); - if (IsInitialized) - { - // Viewport = Viewport with { Y = 0 }; - } - - KeystrokeNavigator.Collection = _source?.ToList (); - _selected = -1; - _lastSelectedItem = -1; - SetNeedsDraw (); - } - } - - - private void Source_CollectionChanged (object sender, NotifyCollectionChangedEventArgs e) - { - SetContentSize (new Size (_source?.Length ?? Viewport.Width, _source?.Count ?? Viewport.Width)); - - if (Source is { Count: > 0 } && _selected > Source.Count - 1) - { - SelectedItem = Source.Count - 1; - } - - SetNeedsDraw (); - - OnCollectionChanged (e); - } - - /// Gets or sets the index of the item that will appear at the top of the . - /// - /// This a helper property for accessing listView.Viewport.Y. - /// - /// The top item. - public int TopItem - { - get => Viewport.Y; - set - { - if (_source is null) - { - return; - } - - Viewport = Viewport with { Y = value }; - } - } - /// /// If and are both , /// marks all items. @@ -366,16 +282,402 @@ public class ListView : View, IDesignable if (AllowsMultipleSelection) { - for (var i = 0; i < Source.Count; i++) + for (var i = 0; i < Source?.Count; i++) { Source.SetMark (i, mark); } + return true; } return false; } + /// Marks the if it is not already marked. + /// if the was marked. + public bool MarkUnmarkSelectedItem () + { + if (Source is null || SelectedItem is null || !UnmarkAllButSelected ()) + { + return false; + } + + Source.SetMark (SelectedItem.Value, !Source.IsMarked (SelectedItem.Value)); + SetNeedsDraw (); + + return Source.IsMarked (SelectedItem.Value); + } + + /// Gets the widest item in the list. + public int MaxLength => Source?.Length ?? 0; + + /// Changes the to the next item in the list, scrolling the list if needed. + /// + public virtual bool MoveDown () + { + if (Source is null || Source.Count == 0) + { + return false; //Nothing for us to move to + } + + if (SelectedItem is null || SelectedItem >= Source.Count) + { + // If SelectedItem is null or for some reason we are currently outside the + // valid values range, we should select the first or bottommost valid value. + // This can occur if the backing data source changes. + SelectedItem = SelectedItem is null ? 0 : Source.Count - 1; + } + else if (SelectedItem + 1 < Source.Count) + { + //can move by down by one. + SelectedItem++; + + if (SelectedItem >= Viewport.Y + Viewport.Height) + { + Viewport = Viewport with { Y = Viewport.Y + 1 }; + } + else if (SelectedItem < Viewport.Y) + { + Viewport = Viewport with { Y = SelectedItem.Value }; + } + } + else if (SelectedItem >= Viewport.Y + Viewport.Height) + { + Viewport = Viewport with { Y = Source.Count - Viewport.Height }; + } + + return true; + } + + /// Changes the to last item in the list, scrolling the list if needed. + /// + public virtual bool MoveEnd () + { + if (Source is { Count: > 0 } && SelectedItem != Source.Count - 1) + { + SelectedItem = Source.Count - 1; + + if (Viewport.Y + SelectedItem > Viewport.Height - 1) + { + Viewport = Viewport with + { + Y = SelectedItem < Viewport.Height - 1 + ? Math.Max (Viewport.Height - SelectedItem.Value + 1, 0) + : Math.Max (SelectedItem.Value - Viewport.Height + 1, 0) + }; + } + } + + return true; + } + + /// Changes the to the first item in the list, scrolling the list if needed. + /// + public virtual bool MoveHome () + { + if (SelectedItem != 0) + { + SelectedItem = 0; + Viewport = Viewport with { Y = SelectedItem.Value }; + } + + return true; + } + + /// + /// Changes the to the item just below the bottom of the visible list, scrolling if + /// needed. + /// + /// + public virtual bool MovePageDown () + { + if (Source is null || Source.Count == 0) + { + return false; + } + + int n = (SelectedItem ?? 0) + Viewport.Height; + + if (n >= Source.Count) + { + n = Source.Count - 1; + } + + if (n != SelectedItem) + { + SelectedItem = n; + + if (Source.Count >= Viewport.Height) + { + Viewport = Viewport with { Y = SelectedItem.Value }; + } + else + { + Viewport = Viewport with { Y = 0 }; + } + } + + return true; + } + + /// Changes the to the item at the top of the visible list. + /// + public virtual bool MovePageUp () + { + if (Source is null || Source.Count == 0) + { + return false; + } + + int n = (SelectedItem ?? 0) - Viewport.Height; + + if (n < 0) + { + n = 0; + } + + if (n != SelectedItem && n < Source?.Count) + { + SelectedItem = n; + Viewport = Viewport with { Y = SelectedItem.Value }; + } + + return true; + } + + /// Changes the to the previous item in the list, scrolling the list if needed. + /// + public virtual bool MoveUp () + { + if (Source is null || Source.Count == 0) + { + return false; //Nothing for us to move to + } + + if (SelectedItem is null || SelectedItem >= Source.Count) + { + // If SelectedItem is null or for some reason we are currently outside the + // valid values range, we should select the bottommost valid value. + // This can occur if the backing data source changes. + SelectedItem = Source.Count - 1; + } + else if (SelectedItem > 0) + { + SelectedItem--; + + if (SelectedItem > Source.Count) + { + SelectedItem = Source.Count - 1; + } + + if (SelectedItem < Viewport.Y) + { + Viewport = Viewport with { Y = SelectedItem.Value }; + } + else if (SelectedItem > Viewport.Y + Viewport.Height) + { + Viewport = Viewport with { Y = SelectedItem.Value - Viewport.Height + 1 }; + } + } + else if (SelectedItem < Viewport.Y) + { + Viewport = Viewport with { Y = SelectedItem.Value }; + } + + return true; + } + + /// Invokes the event if it is defined. + /// if the event was fired. + public bool OnOpenSelectedItem () + { + if (Source is null || SelectedItem is null || Source.Count <= SelectedItem || SelectedItem < 0 || OpenSelectedItem is null) + { + return false; + } + + object? value = Source.ToList () [SelectedItem.Value]; + + OpenSelectedItem?.Invoke (this, new (SelectedItem.Value, value!)); + + // BUGBUG: this should not blindly return true. + return true; + } + + /// Virtual method that will invoke the . + /// + public virtual void OnRowRender (ListViewRowEventArgs rowEventArgs) { RowRender?.Invoke (this, rowEventArgs); } + + + /// This event is raised when the user Double-Clicks on an item or presses ENTER to open the selected item. + public event EventHandler? OpenSelectedItem; + + /// + /// Allow resume the event from being invoked, + /// + public void ResumeSuspendCollectionChangedEvent () + { + if (Source is { }) + { + Source.SuspendCollectionChangedEvent = false; + } + } + + /// This event is invoked when this is being drawn before rendering. + public event EventHandler? RowRender; + + private int? _selectedItem = null; + private int? _lastSelectedItem = null; + + /// Gets or sets the index of the currently selected item. + /// The selected item or null if no item is selected. + public int? SelectedItem + { + get => _selectedItem; + set + { + if (Source is null) + { + return; + } + + if (value.HasValue && (value < 0 || value >= Source.Count)) + { + throw new ArgumentException (@"SelectedItem must be greater than 0 or less than the number of items."); + } + + _selectedItem = value; + OnSelectedChanged (); + SetNeedsDraw (); + } + } + + // TODO: Use standard event model + /// Invokes the event if it is defined. + /// + public virtual bool OnSelectedChanged () + { + if (SelectedItem != _lastSelectedItem) + { + object? value = SelectedItem.HasValue && Source?.Count > 0 ? Source.ToList () [SelectedItem.Value] : null; + SelectedItemChanged?.Invoke (this, new (SelectedItem, value)); + _lastSelectedItem = SelectedItem; + EnsureSelectedItemVisible (); + + return true; + } + + return false; + } + + /// This event is raised when the selected item in the has changed. + public event EventHandler? SelectedItemChanged; + + /// Sets the source of the to an . + /// An object implementing the IList interface. + /// + /// Use the property to set a new source and use custom + /// rendering. + /// + public void SetSource (ObservableCollection? source) + { + if (source is null && Source is not ListWrapper) + { + Source = null; + } + else + { + Source = new ListWrapper (source); + } + } + + /// Sets the source to an value asynchronously. + /// An item implementing the IList interface. + /// + /// Use the property to set a new source and use custom + /// rendering. + /// + public Task SetSourceAsync (ObservableCollection? source) + { + return Task.Factory.StartNew ( + () => + { + if (source is null && Source is not ListWrapper) + { + Source = null; + } + else + { + Source = new ListWrapper (source); + } + + return source; + }, + CancellationToken.None, + TaskCreationOptions.DenyChildAttach, + TaskScheduler.Default + ); + } + + /// Gets or sets the backing this , enabling custom rendering. + /// The source. + /// Use to set a new source. + public IListDataSource? Source + { + get => _source; + set + { + if (_source == value) + { + return; + } + + _source?.Dispose (); + _source = value; + + if (_source is { }) + { + _source.CollectionChanged += Source_CollectionChanged; + SetContentSize (new Size (_source?.Length ?? Viewport.Width, _source?.Count ?? Viewport.Width)); + KeystrokeNavigator.Collection = _source?.ToList (); + } + + SelectedItem = null; + _lastSelectedItem = null; + SetNeedsDraw (); + } + } + + /// + /// Allow suspending the event from being invoked, + /// + public void SuspendCollectionChangedEvent () + { + if (Source is { }) + { + Source.SuspendCollectionChangedEvent = true; + } + } + + /// Gets or sets the index of the item that will appear at the top of the . + /// + /// This a helper property for accessing listView.Viewport.Y. + /// + /// The top item. + public int TopItem + { + get => Viewport.Y; + set + { + if (Source is null) + { + return; + } + + Viewport = Viewport with { Y = value }; + } + } + /// /// If and are both , /// unmarks all marked items other than . @@ -390,9 +692,9 @@ public class ListView : View, IDesignable if (!AllowsMultipleSelection) { - for (var i = 0; i < Source.Count; i++) + for (var i = 0; i < Source?.Count; i++) { - if (Source.IsMarked (i) && i != _selected) + if (Source.IsMarked (i) && i != SelectedItem) { Source.SetMark (i, false); @@ -404,36 +706,121 @@ public class ListView : View, IDesignable return true; } - /// Ensures the selected item is always visible on the screen. - public void EnsureSelectedItemVisible () + /// + protected override void Dispose (bool disposing) { - if (_selected == -1) + Source?.Dispose (); + + base.Dispose (disposing); + } + + /// + /// Call the event to raises the . + /// + /// + protected virtual void OnCollectionChanged (NotifyCollectionChangedEventArgs e) { CollectionChanged?.Invoke (this, e); } + + /// + protected override bool OnDrawingContent () + { + if (Source is null) { - return; + return base.OnDrawingContent (); } - if (_selected < Viewport.Y) + + var current = Attribute.Default; + Move (0, 0); + Rectangle f = Viewport; + int item = Viewport.Y; + bool focused = HasFocus; + int col = _allowsMarking ? 2 : 0; + int start = Viewport.X; + + for (var row = 0; row < f.Height; row++, item++) { - Viewport = Viewport with { Y = _selected }; + bool isSelected = item == SelectedItem; + + Attribute newAttribute = focused ? isSelected ? GetAttributeForRole (VisualRole.Focus) : GetAttributeForRole (VisualRole.Normal) : + isSelected ? GetAttributeForRole (VisualRole.Active) : GetAttributeForRole (VisualRole.Normal); + + if (newAttribute != current) + { + SetAttribute (newAttribute); + current = newAttribute; + } + + Move (0, row); + + if (Source is null || item >= Source.Count) + { + for (var c = 0; c < f.Width; c++) + { + AddRune ((Rune)' '); + } + } + else + { + var rowEventArgs = new ListViewRowEventArgs (item); + OnRowRender (rowEventArgs); + + if (rowEventArgs.RowAttribute is { } && current != rowEventArgs.RowAttribute) + { + current = (Attribute)rowEventArgs.RowAttribute; + SetAttribute (current); + } + + if (_allowsMarking) + { + AddRune ( + Source.IsMarked (item) ? AllowsMultipleSelection ? Glyphs.CheckStateChecked : Glyphs.Selected : + AllowsMultipleSelection ? Glyphs.CheckStateUnChecked : Glyphs.UnSelected + ); + AddRune ((Rune)' '); + } + + Source.Render (this, isSelected, item, col, row, f.Width - col, start); + } } - else if (Viewport.Height > 0 && _selected >= Viewport.Y + Viewport.Height) + + return true; + } + + /// + protected override void OnFrameChanged (in Rectangle frame) { EnsureSelectedItemVisible (); } + + /// + protected override void OnHasFocusChanged (bool newHasFocus, View? currentFocused, View? newFocused) + { + if (newHasFocus && _lastSelectedItem != SelectedItem) { - Viewport = Viewport with { Y = _selected - Viewport.Height + 1 }; + EnsureSelectedItemVisible (); } } - /// Marks the if it is not already marked. - /// if the was marked. - public bool MarkUnmarkSelectedItem () + /// + protected override bool OnKeyDown (Key key) { - if (UnmarkAllButSelected ()) + // If the key was bound to key command, let normal KeyDown processing happen. This enables overriding the default handling. + // See: https://github.com/gui-cs/Terminal.Gui/issues/3950#issuecomment-2807350939 + if (KeyBindings.TryGet (key, out _)) { - Source.SetMark (SelectedItem, !Source.IsMarked (SelectedItem)); - SetNeedsDraw (); - - return Source.IsMarked (SelectedItem); + return false; } - // BUGBUG: Shouldn't this return Source.IsMarked (SelectedItem) + // Enable user to find & select an item by typing text + if (KeystrokeNavigator.Matcher.IsCompatibleKey (key)) + { + int? newItem = KeystrokeNavigator?.GetNextMatchingItem (SelectedItem ?? null, (char)key); + + if (newItem is { } && newItem != -1) + { + SelectedItem = (int)newItem; + EnsureSelectedItemVisible (); + SetNeedsDraw (); + + return true; + } + } return false; } @@ -456,7 +843,7 @@ public class ListView : View, IDesignable SetFocus (); } - if (_source is null) + if (Source is null) { return false; } @@ -495,21 +882,20 @@ public class ListView : View, IDesignable return true; } - if (me.Position.Y + Viewport.Y >= _source.Count + if (me.Position.Y + Viewport.Y >= Source.Count || me.Position.Y + Viewport.Y < 0 || me.Position.Y + Viewport.Y > Viewport.Y + Viewport.Height) { return true; } - _selected = Viewport.Y + me.Position.Y; + SelectedItem = Viewport.Y + me.Position.Y; if (MarkUnmarkSelectedItem ()) { // return true; } - OnSelectedChanged (); SetNeedsDraw (); if (me.Flags == MouseFlags.Button1DoubleClicked) @@ -520,666 +906,20 @@ public class ListView : View, IDesignable return true; } - /// Changes the to the next item in the list, scrolling the list if needed. - /// - public virtual bool MoveDown () - { - if (_source is null || _source.Count == 0) - { - // Do we set lastSelectedItem to -1 here? - return false; //Nothing for us to move to - } - - if (_selected >= _source.Count) - { - // If for some reason we are currently outside of the - // valid values range, we should select the bottommost valid value. - // This can occur if the backing data source changes. - _selected = _source.Count - 1; - OnSelectedChanged (); - SetNeedsDraw (); - } - else if (_selected + 1 < _source.Count) - { - //can move by down by one. - _selected++; - - if (_selected >= Viewport.Y + Viewport.Height) - { - Viewport = Viewport with { Y = Viewport.Y + 1 }; - } - else if (_selected < Viewport.Y) - { - Viewport = Viewport with { Y = _selected }; - } - - OnSelectedChanged (); - SetNeedsDraw (); - } - else if (_selected == 0) - { - OnSelectedChanged (); - SetNeedsDraw (); - } - else if (_selected >= Viewport.Y + Viewport.Height) - { - Viewport = Viewport with { Y = _source.Count - Viewport.Height }; - SetNeedsDraw (); - } - - return true; - } - - /// Changes the to last item in the list, scrolling the list if needed. - /// - public virtual bool MoveEnd () - { - if (_source is { Count: > 0 } && _selected != _source.Count - 1) - { - _selected = _source.Count - 1; - - if (Viewport.Y + _selected > Viewport.Height - 1) - { - Viewport = Viewport with - { - Y = _selected < Viewport.Height - 1 - ? Math.Max (Viewport.Height - _selected + 1, 0) - : Math.Max (_selected - Viewport.Height + 1, 0) - }; - } - - OnSelectedChanged (); - SetNeedsDraw (); - } - - return true; - } - - /// Changes the to the first item in the list, scrolling the list if needed. - /// - public virtual bool MoveHome () - { - if (_selected != 0) - { - _selected = 0; - Viewport = Viewport with { Y = _selected }; - OnSelectedChanged (); - SetNeedsDraw (); - } - - return true; - } - - /// - /// Changes the to the item just below the bottom of the visible list, scrolling if - /// needed. - /// - /// - public virtual bool MovePageDown () - { - if (_source is null) - { - return true; - } - - int n = _selected + Viewport.Height; - - if (n >= _source.Count) - { - n = _source.Count - 1; - } - - if (n != _selected) - { - _selected = n; - - if (_source.Count >= Viewport.Height) - { - Viewport = Viewport with { Y = _selected }; - } - else - { - Viewport = Viewport with { Y = 0 }; - } - - OnSelectedChanged (); - SetNeedsDraw (); - } - - return true; - } - - /// Changes the to the item at the top of the visible list. - /// - public virtual bool MovePageUp () - { - int n = _selected - Viewport.Height; - - if (n < 0) - { - n = 0; - } - - if (n != _selected) - { - _selected = n; - Viewport = Viewport with { Y = _selected }; - OnSelectedChanged (); - SetNeedsDraw (); - } - - return true; - } - - /// Changes the to the previous item in the list, scrolling the list if needed. - /// - public virtual bool MoveUp () - { - if (_source is null || _source.Count == 0) - { - // Do we set lastSelectedItem to -1 here? - return false; //Nothing for us to move to - } - - if (_selected >= _source.Count) - { - // If for some reason we are currently outside of the - // valid values range, we should select the bottommost valid value. - // This can occur if the backing data source changes. - _selected = _source.Count - 1; - OnSelectedChanged (); - SetNeedsDraw (); - } - else if (_selected > 0) - { - _selected--; - - if (_selected > Source.Count) - { - _selected = Source.Count - 1; - } - - if (_selected < Viewport.Y) - { - Viewport = Viewport with { Y = _selected }; - } - else if (_selected > Viewport.Y + Viewport.Height) - { - Viewport = Viewport with { Y = _selected - Viewport.Height + 1 }; - } - - OnSelectedChanged (); - SetNeedsDraw (); - } - else if (_selected < Viewport.Y) - { - Viewport = Viewport with { Y = _selected }; - SetNeedsDraw (); - } - - return true; - } - /// - protected override bool OnDrawingContent () + protected override void OnViewportChanged (DrawEventArgs e) { SetContentSize (new Size (MaxLength, Source?.Count ?? Viewport.Height)); } + + private void Source_CollectionChanged (object? sender, NotifyCollectionChangedEventArgs e) { - Attribute current = Attribute.Default; - Move (0, 0); - Rectangle f = Viewport; - int item = Viewport.Y; - bool focused = HasFocus; - int col = _allowsMarking ? 2 : 0; - int start = Viewport.X; + SetContentSize (new Size (Source?.Length ?? Viewport.Width, Source?.Count ?? Viewport.Width)); - for (var row = 0; row < f.Height; row++, item++) + if (Source is { Count: > 0 } && SelectedItem.HasValue && SelectedItem > Source.Count - 1) { - bool isSelected = item == _selected; - - Attribute newAttribute = focused ? isSelected ? GetAttributeForRole (VisualRole.Focus) : GetAttributeForRole (VisualRole.Normal) : - isSelected ? GetAttributeForRole (VisualRole.Active) : GetAttributeForRole (VisualRole.Normal); - - if (newAttribute != current) - { - SetAttribute (newAttribute); - current = newAttribute; - } - - Move (0, row); - - if (_source is null || item >= _source.Count) - { - for (var c = 0; c < f.Width; c++) - { - AddRune ((Rune)' '); - } - } - else - { - var rowEventArgs = new ListViewRowEventArgs (item); - OnRowRender (rowEventArgs); - - if (rowEventArgs.RowAttribute is { } && current != rowEventArgs.RowAttribute) - { - current = (Attribute)rowEventArgs.RowAttribute; - SetAttribute (current); - } - - if (_allowsMarking) - { - AddRune ( - _source.IsMarked (item) ? AllowsMultipleSelection ? Glyphs.CheckStateChecked : Glyphs.Selected : - AllowsMultipleSelection ? Glyphs.CheckStateUnChecked : Glyphs.UnSelected - ); - AddRune ((Rune)' '); - } - - Source.Render (this, isSelected, item, col, row, f.Width - col, start); - } - } - return true; - } - - /// - protected override void OnHasFocusChanged (bool newHasFocus, [CanBeNull] View currentFocused, [CanBeNull] View newFocused) - { - if (newHasFocus && _lastSelectedItem != _selected) - { - EnsureSelectedItemVisible (); - } - } - - /// Invokes the event if it is defined. - /// if the event was fired. - public bool OnOpenSelectedItem () - { - if (_source is null || _source.Count <= _selected || _selected < 0 || OpenSelectedItem is null) - { - return false; + SelectedItem = Source.Count - 1; } - object value = _source.ToList () [_selected]; + SetNeedsDraw (); - OpenSelectedItem?.Invoke (this, new ListViewItemEventArgs (_selected, value)); - - // BUGBUG: this should not blindly return true. - return true; - } - - /// - protected override bool OnKeyDown (Key key) - { - // If the key was bound to key command, let normal KeyDown processing happen. This enables overriding the default handling. - // See: https://github.com/gui-cs/Terminal.Gui/issues/3950#issuecomment-2807350939 - if (KeyBindings.TryGet (key, out _)) - { - return false; - } - - // Enable user to find & select an item by typing text - if (KeystrokeNavigator.Matcher.IsCompatibleKey (key)) - { - int? newItem = KeystrokeNavigator?.GetNextMatchingItem (SelectedItem, (char)key); - - if (newItem is { } && newItem != -1) - { - SelectedItem = (int)newItem; - EnsureSelectedItemVisible (); - SetNeedsDraw (); - - return true; - } - } - - return false; - } - - /// Virtual method that will invoke the . - /// - public virtual void OnRowRender (ListViewRowEventArgs rowEventArgs) { RowRender?.Invoke (this, rowEventArgs); } - - // TODO: Use standard event model - /// Invokes the event if it is defined. - /// - public virtual bool OnSelectedChanged () - { - if (_selected != _lastSelectedItem) - { - object value = _source?.Count > 0 ? _source.ToList () [_selected] : null; - SelectedItemChanged?.Invoke (this, new ListViewItemEventArgs (_selected, value)); - _lastSelectedItem = _selected; - EnsureSelectedItemVisible (); - - return true; - } - - return false; - } - - /// This event is raised when the user Double-Clicks on an item or presses ENTER to open the selected item. - public event EventHandler OpenSelectedItem; - - /// This event is invoked when this is being drawn before rendering. - public event EventHandler RowRender; - - /// This event is raised when the selected item in the has changed. - public event EventHandler SelectedItemChanged; - - /// - /// Event to raise when an item is added, removed, or moved, or the entire list is refreshed. - /// - public event NotifyCollectionChangedEventHandler CollectionChanged; - - /// Sets the source of the to an . - /// An object implementing the IList interface. - /// - /// Use the property to set a new source and use custom - /// rendering. - /// - public void SetSource (ObservableCollection source) - { - if (source is null && Source is not ListWrapper) - { - Source = null; - } - else - { - Source = new ListWrapper (source); - } - } - - /// Sets the source to an value asynchronously. - /// An item implementing the IList interface. - /// - /// Use the property to set a new source and use custom - /// rendering. - /// - public Task SetSourceAsync (ObservableCollection source) - { - return Task.Factory.StartNew ( - () => - { - if (source is null && (Source is null || !(Source is ListWrapper))) - { - Source = null; - } - else - { - Source = new ListWrapper (source); - } - - return source; - }, - CancellationToken.None, - TaskCreationOptions.DenyChildAttach, - TaskScheduler.Default - ); - } - - private void ListView_LayoutStarted (object sender, LayoutEventArgs e) { EnsureSelectedItemVisible (); } - /// - /// Call the event to raises the . - /// - /// - protected virtual void OnCollectionChanged (NotifyCollectionChangedEventArgs e) { CollectionChanged?.Invoke (this, e); } - - /// - protected override void Dispose (bool disposing) - { - _source?.Dispose (); - - base.Dispose (disposing); - } - - /// - /// Allow suspending the event from being invoked, - /// - public void SuspendCollectionChangedEvent () - { - if (Source is { }) - { - Source.SuspendCollectionChangedEvent = true; - } - } - - /// - /// Allow resume the event from being invoked, - /// - public void ResumeSuspendCollectionChangedEvent () - { - if (Source is { }) - { - Source.SuspendCollectionChangedEvent = false; - } - } - - /// - public bool EnableForDesign () - { - var source = new ListWrapper (["List Item 1", "List Item two", "List Item Quattro", "Last List Item"]); - Source = source; - - return true; - } -} - -/// -/// Provides a default implementation of that renders items -/// using . -/// -public class ListWrapper : IListDataSource, IDisposable -{ - private int _count; - private BitArray _marks; - private readonly ObservableCollection _source; - - /// - public ListWrapper (ObservableCollection source) - { - if (source is { }) - { - _count = source.Count; - _marks = new BitArray (_count); - _source = source; - _source.CollectionChanged += Source_CollectionChanged; - Length = GetMaxLengthItem (); - } - } - - private void Source_CollectionChanged (object sender, NotifyCollectionChangedEventArgs e) - { - if (!SuspendCollectionChangedEvent) - { - CheckAndResizeMarksIfRequired (); - CollectionChanged?.Invoke (sender, e); - } - } - - /// - public event NotifyCollectionChangedEventHandler CollectionChanged; - - /// - public int Count => _source?.Count ?? 0; - - /// - public int Length { get; private set; } - - private bool _suspendCollectionChangedEvent; - - /// - public bool SuspendCollectionChangedEvent - { - get => _suspendCollectionChangedEvent; - set - { - _suspendCollectionChangedEvent = value; - - if (!_suspendCollectionChangedEvent) - { - CheckAndResizeMarksIfRequired (); - } - } - } - - private void CheckAndResizeMarksIfRequired () - { - if (_source != null && _count != _source.Count) - { - _count = _source.Count; - BitArray newMarks = new BitArray (_count); - for (var i = 0; i < Math.Min (_marks.Length, newMarks.Length); i++) - { - newMarks [i] = _marks [i]; - } - _marks = newMarks; - - Length = GetMaxLengthItem (); - } - } - - /// - public void Render ( - ListView container, - bool marked, - int item, - int col, - int line, - int width, - int start = 0 - ) - { - container.Move (Math.Max (col - start, 0), line); - - if (_source is { }) - { - object t = _source [item]; - - if (t is null) - { - RenderUstr (container, "", col, line, width); - } - else - { - if (t is string s) - { - RenderUstr (container, s, col, line, width, start); - } - else - { - RenderUstr (container, t.ToString (), col, line, width, start); - } - } - } - } - - /// - public bool IsMarked (int item) - { - if (item >= 0 && item < _count) - { - return _marks [item]; - } - - return false; - } - - /// - public void SetMark (int item, bool value) - { - if (item >= 0 && item < _count) - { - _marks [item] = value; - } - } - - /// - public IList ToList () { return _source; } - - /// - public int StartsWith (string search) - { - if (_source is null || _source?.Count == 0) - { - return -1; - } - - for (var i = 0; i < _source.Count; i++) - { - object t = _source [i]; - - if (t is string u) - { - if (u.ToUpper ().StartsWith (search.ToUpperInvariant ())) - { - return i; - } - } - else if (t is string s) - { - if (s.StartsWith (search, StringComparison.InvariantCultureIgnoreCase)) - { - return i; - } - } - } - - return -1; - } - - private int GetMaxLengthItem () - { - if (_source is null || _source?.Count == 0) - { - return 0; - } - - var maxLength = 0; - - for (var i = 0; i < _source!.Count; i++) - { - object t = _source [i]; - int l; - - if (t is string u) - { - l = u.GetColumns (); - } - else if (t is string s) - { - l = s.Length; - } - else - { - l = t.ToString ().Length; - } - - if (l > maxLength) - { - maxLength = l; - } - } - - return maxLength; - } - - private void RenderUstr (View driver, string ustr, int col, int line, int width, int start = 0) - { - string str = start > ustr.GetColumns () ? string.Empty : ustr.Substring (Math.Min (start, ustr.ToRunes ().Length - 1)); - string u = TextFormatter.ClipAndJustify (str, width, Alignment.Start); - driver.AddStr (u); - width -= u.GetColumns (); - - while (width-- > 0) - { - driver.AddRune ((Rune)' '); - } - } - - /// - public void Dispose () - { - if (_source is { }) - { - _source.CollectionChanged -= Source_CollectionChanged; - } + OnCollectionChanged (e); } } diff --git a/Terminal.Gui/Views/ListViewEventArgs.cs b/Terminal.Gui/Views/ListViewEventArgs.cs index fe83de580..e7a8c2686 100644 --- a/Terminal.Gui/Views/ListViewEventArgs.cs +++ b/Terminal.Gui/Views/ListViewEventArgs.cs @@ -1,4 +1,4 @@ -namespace Terminal.Gui.Views; +namespace Terminal.Gui.Views; /// for events. public class ListViewItemEventArgs : EventArgs @@ -6,17 +6,17 @@ public class ListViewItemEventArgs : EventArgs /// Initializes a new instance of /// The index of the item. /// The item - public ListViewItemEventArgs (int item, object value) + public ListViewItemEventArgs (int? item, object? value) { Item = item; Value = value; } /// The index of the item. - public int Item { get; } + public int? Item { get; } /// The item. - public object Value { get; } + public object? Value { get; } } /// used by the event. diff --git a/Terminal.Gui/Views/ListWrapper.cs b/Terminal.Gui/Views/ListWrapper.cs new file mode 100644 index 000000000..5f10b4e06 --- /dev/null +++ b/Terminal.Gui/Views/ListWrapper.cs @@ -0,0 +1,256 @@ +#nullable enable +using System.Collections; +using System.Collections.ObjectModel; +using System.Collections.Specialized; + +namespace Terminal.Gui.Views; + +/// +/// Provides a default implementation of that renders items +/// using . +/// +public class ListWrapper : IListDataSource, IDisposable +{ + /// + /// Creates a new instance of that wraps the specified + /// . + /// + /// + public ListWrapper (ObservableCollection? source) + { + if (source is { }) + { + _count = source.Count; + _marks = new (_count); + _source = source; + _source.CollectionChanged += Source_CollectionChanged; + Length = GetMaxLengthItem (); + } + } + + private readonly ObservableCollection? _source; + private int _count; + private BitArray? _marks; + + private bool _suspendCollectionChangedEvent; + + /// + public event NotifyCollectionChangedEventHandler? CollectionChanged; + + /// + public int Count => _source?.Count ?? 0; + + /// + public int Length { get; private set; } + + /// + public bool SuspendCollectionChangedEvent + { + get => _suspendCollectionChangedEvent; + set + { + _suspendCollectionChangedEvent = value; + + if (!_suspendCollectionChangedEvent) + { + CheckAndResizeMarksIfRequired (); + } + } + } + + /// + public void Render ( + ListView container, + bool marked, + int item, + int col, + int line, + int width, + int viewportX = 0 + ) + { + container.Move (Math.Max (col - viewportX, 0), line); + + if (_source is null) + { + return; + } + + object? t = _source [item]; + + if (t is null) + { + RenderString (container, "", col, line, width); + } + else + { + if (t is string s) + { + RenderString (container, s, col, line, width, viewportX); + } + else + { + RenderString (container, t.ToString ()!, col, line, width, viewportX); + } + } + } + + /// + public bool IsMarked (int item) + { + if (item >= 0 && item < _count) + { + return _marks! [item]; + } + + return false; + } + + /// + public void SetMark (int item, bool value) + { + if (item >= 0 && item < _count) + { + _marks! [item] = value; + } + } + + /// + public IList ToList () { return _source ?? []; } + + /// + public void Dispose () + { + if (_source is { }) + { + _source.CollectionChanged -= Source_CollectionChanged; + } + } + + /// + /// INTERNAL: Searches the underlying collection for the first string element that starts with the specified search value, + /// using a case-insensitive comparison. + /// + /// + /// The comparison is performed in a case-insensitive manner using invariant culture rules. Only + /// elements of type string are considered; other types in the collection are ignored. + /// + /// + /// The string value to compare against the start of each string element in the collection. Cannot be + /// null. + /// + /// + /// The zero-based index of the first matching string element if found; otherwise, -1 if no match is found or the + /// collection is empty. + /// + internal int StartsWith (string search) + { + if (_source is null || _source?.Count == 0) + { + return -1; + } + + for (var i = 0; i < _source!.Count; i++) + { + object? t = _source [i]; + + if (t is string u) + { + if (u.ToUpper ().StartsWith (search.ToUpperInvariant ())) + { + return i; + } + } + else if (t is string s && s.StartsWith (search, StringComparison.InvariantCultureIgnoreCase)) + { + return i; + } + } + + return -1; + } + + private void CheckAndResizeMarksIfRequired () + { + if (_source != null && _count != _source.Count && _marks is { }) + { + _count = _source.Count; + var newMarks = new BitArray (_count); + + for (var i = 0; i < Math.Min (_marks.Length, newMarks.Length); i++) + { + newMarks [i] = _marks [i]; + } + + _marks = newMarks; + + Length = GetMaxLengthItem (); + } + } + + private int GetMaxLengthItem () + { + if (_source is null || _source?.Count == 0) + { + return 0; + } + + var maxLength = 0; + + for (var i = 0; i < _source!.Count; i++) + { + object? t = _source [i]; + + if (t is null) + { + continue; + } + + int l; + + l = t is string u ? u.GetColumns () : t.ToString ()!.Length; + + if (l > maxLength) + { + maxLength = l; + } + } + + return maxLength; + } + + private static void RenderString (View driver, string str, int col, int line, int width, int viewportX = 0) + { + if (string.IsNullOrEmpty (str) || viewportX >= str.GetColumns ()) + { + // Empty string or viewport beyond string - just fill with spaces + for (var i = 0; i < width; i++) + { + driver.AddRune ((Rune)' '); + } + + return; + } + + int runeLength = str.ToRunes ().Length; + int startIndex = Math.Min (viewportX, Math.Max (0, runeLength - 1)); + string substring = str.Substring (startIndex); + string u = TextFormatter.ClipAndJustify (substring, width, Alignment.Start); + driver.AddStr (u); + width -= u.GetColumns (); + + while (width-- > 0) + { + driver.AddRune ((Rune)' '); + } + } + + private void Source_CollectionChanged (object? sender, NotifyCollectionChangedEventArgs e) + { + if (!SuspendCollectionChangedEvent) + { + CheckAndResizeMarksIfRequired (); + CollectionChanged?.Invoke (sender, e); + } + } +} diff --git a/Terminal.Gui/Views/Menu/Menuv2.cs b/Terminal.Gui/Views/Menu/Menu.cs similarity index 89% rename from Terminal.Gui/Views/Menu/Menuv2.cs rename to Terminal.Gui/Views/Menu/Menu.cs index 1eb5f6cc4..b9efaa91f 100644 --- a/Terminal.Gui/Views/Menu/Menuv2.cs +++ b/Terminal.Gui/Views/Menu/Menu.cs @@ -1,20 +1,20 @@ -#nullable enable + namespace Terminal.Gui.Views; /// -/// A -derived object to be used as a vertically-oriented menu. Each subview is a . +/// A -derived object to be used as a vertically-oriented menu. Each subview is a . /// -public class Menuv2 : Bar +public class Menu : Bar { /// - public Menuv2 () : this ([]) { } + public Menu () : this ([]) { } /// - public Menuv2 (IEnumerable? menuItems) : this (menuItems?.Cast ()) { } + public Menu (IEnumerable? menuItems) : this (menuItems?.Cast ()) { } /// - public Menuv2 (IEnumerable? shortcuts) : base (shortcuts) + public Menu (IEnumerable? shortcuts) : base (shortcuts) { // Do this to support debugging traces where Title gets set base.HotKeySpecifier = (Rune)'\xffff'; @@ -51,14 +51,14 @@ public class Menuv2 : Bar /// /// Gets or sets the menu item that opened this menu as a sub-menu. /// - public MenuItemv2? SuperMenuItem { get; set; } + public MenuItem? SuperMenuItem { get; set; } /// protected override void OnVisibleChanged () { if (Visible) { - SelectedMenuItem = SubViews.Where (mi => mi is MenuItemv2).ElementAtOrDefault (0) as MenuItemv2; + SelectedMenuItem = SubViews.Where (mi => mi is MenuItem).ElementAtOrDefault (0) as MenuItem; } } @@ -69,7 +69,7 @@ public class Menuv2 : Bar switch (view) { - case MenuItemv2 menuItem: + case MenuItem menuItem: { menuItem.CanFocus = true; @@ -176,7 +176,7 @@ public class Menuv2 : Bar { base.OnFocusedChanged (previousFocused, focused); - SelectedMenuItem = focused as MenuItemv2; + SelectedMenuItem = focused as MenuItem; RaiseSelectedMenuItemChanged (SelectedMenuItem); } @@ -184,9 +184,9 @@ public class Menuv2 : Bar /// Gets or set the currently selected menu item. This is a helper that /// tracks . /// - public MenuItemv2? SelectedMenuItem + public MenuItem? SelectedMenuItem { - get => Focused as MenuItemv2; + get => Focused as MenuItem; set { if (value == Focused) @@ -198,7 +198,7 @@ public class Menuv2 : Bar } } - internal void RaiseSelectedMenuItemChanged (MenuItemv2? selected) + internal void RaiseSelectedMenuItemChanged (MenuItem? selected) { // Logging.Debug ($"{Title} ({selected?.Title})"); @@ -210,14 +210,14 @@ public class Menuv2 : Bar /// Called when the selected menu item has changed. /// /// - protected virtual void OnSelectedMenuItemChanged (MenuItemv2? selected) + protected virtual void OnSelectedMenuItemChanged (MenuItem? selected) { } /// /// Raised when the selected menu item has changed. /// - public event EventHandler? SelectedMenuItemChanged; + public event EventHandler? SelectedMenuItemChanged; /// protected override void Dispose (bool disposing) @@ -229,4 +229,4 @@ public class Menuv2 : Bar ConfigurationManager.Applied -= OnConfigurationManagerApplied; } } -} \ No newline at end of file +} diff --git a/Terminal.Gui/Views/Menu/MenuBarv2.cs b/Terminal.Gui/Views/Menu/MenuBar.cs similarity index 84% rename from Terminal.Gui/Views/Menu/MenuBarv2.cs rename to Terminal.Gui/Views/Menu/MenuBar.cs index fdf1333a2..7e45d2d6f 100644 --- a/Terminal.Gui/Views/Menu/MenuBarv2.cs +++ b/Terminal.Gui/Views/Menu/MenuBar.cs @@ -1,24 +1,24 @@ -#nullable enable + using System.ComponentModel; using System.Diagnostics; namespace Terminal.Gui.Views; /// -/// A horizontal list of s. Each can have a -/// that is shown when the is selected. +/// A horizontal list of s. Each can have a +/// that is shown when the is selected. /// /// /// MenuBars may be hosted by any View and will, by default, be positioned the full width across the top of the View's /// Viewport. /// -public class MenuBarv2 : Menuv2, IDesignable +public class MenuBar : Menu, IDesignable { /// - public MenuBarv2 () : this ([]) { } + public MenuBar () : this ([]) { } /// - public MenuBarv2 (IEnumerable menuBarItems) : base (menuBarItems) + public MenuBar (IEnumerable menuBarItems) : base (menuBarItems) { CanFocus = false; TabStop = TabBehavior.TabGroup; @@ -45,7 +45,7 @@ public class MenuBarv2 : Menuv2, IDesignable return true; } - if (SubViews.OfType ().FirstOrDefault (mbi => mbi.PopoverMenu is { }) is { } first) + if (SubViews.OfType ().FirstOrDefault (mbi => mbi.PopoverMenu is { }) is { } first) { Active = true; ShowItem (first); @@ -152,7 +152,7 @@ public class MenuBarv2 : Menuv2, IDesignable /// This is a convenience property to help porting from the v1 MenuBar. /// /// - public MenuBarItemv2 []? Menus + public MenuBarItem []? Menus { set { @@ -163,7 +163,7 @@ public class MenuBarv2 : Menuv2, IDesignable return; } - foreach (MenuBarItemv2 mbi in value) + foreach (MenuBarItem mbi in value) { Add (mbi); } @@ -175,7 +175,7 @@ public class MenuBarv2 : Menuv2, IDesignable { base.OnSubViewAdded (view); - if (view is MenuBarItemv2 mbi) + if (view is MenuBarItem mbi) { mbi.Accepted += OnMenuBarItemAccepted; mbi.PopoverMenuOpenChanged += OnMenuBarItemPopoverMenuOpenChanged; @@ -187,7 +187,7 @@ public class MenuBarv2 : Menuv2, IDesignable { base.OnSubViewRemoved (view); - if (view is MenuBarItemv2 mbi) + if (view is MenuBarItem mbi) { mbi.Accepted -= OnMenuBarItemAccepted; mbi.PopoverMenuOpenChanged -= OnMenuBarItemPopoverMenuOpenChanged; @@ -196,7 +196,7 @@ public class MenuBarv2 : Menuv2, IDesignable private void OnMenuBarItemPopoverMenuOpenChanged (object? sender, EventArgs e) { - if (sender is MenuBarItemv2 mbi) + if (sender is MenuBarItem mbi) { if (e.Value) { @@ -223,7 +223,7 @@ public class MenuBarv2 : Menuv2, IDesignable /// Gets whether any of the menu bar items have a visible . /// /// - public bool IsOpen () { return SubViews.OfType ().Count (sv => sv is { PopoverMenuOpen: true }) > 0; } + public bool IsOpen () { return SubViews.OfType ().Count (sv => sv is { PopoverMenuOpen: true }) > 0; } private bool _active; @@ -297,11 +297,11 @@ public class MenuBarv2 : Menuv2, IDesignable } /// - protected override void OnSelectedMenuItemChanged (MenuItemv2? selected) + protected override void OnSelectedMenuItemChanged (MenuItem? selected) { // Logging.Debug ($"{Title} ({selected?.Title}) - IsOpen: {IsOpen ()}"); - if (IsOpen () && selected is MenuBarItemv2 { PopoverMenuOpen: false } selectedMenuBarItem) + if (IsOpen () && selected is MenuBarItem { PopoverMenuOpen: false } selectedMenuBarItem) { ShowItem (selectedMenuBarItem); } @@ -319,9 +319,9 @@ public class MenuBarv2 : Menuv2, IDesignable } // TODO: This needs to be done whenever a menuitem in any MenuBarItem changes - foreach (MenuBarItemv2? mbi in SubViews.Select (s => s as MenuBarItemv2)) + foreach (MenuBarItem? mbi in SubViews.Select (s => s as MenuBarItem)) { - Application.Popover?.Register (mbi?.PopoverMenu); + App?.Popover?.Register (mbi?.PopoverMenu); } } @@ -331,7 +331,7 @@ public class MenuBarv2 : Menuv2, IDesignable // Logging.Debug ($"{Title} ({args.Context?.Source?.Title})"); // TODO: Ensure sourceMenuBar is actually one of our bar items - if (Visible && Enabled && args.Context?.Source is MenuBarItemv2 { PopoverMenuOpen: false } sourceMenuBarItem) + if (Visible && Enabled && args.Context?.Source is MenuBarItem { PopoverMenuOpen: false } sourceMenuBarItem) { if (!CanFocus) { @@ -365,7 +365,7 @@ public class MenuBarv2 : Menuv2, IDesignable // Logging.Debug ($"{Title} ({args.Context?.Source?.Title}) Command: {args.Context?.Command}"); base.OnAccepted (args); - if (SubViews.OfType ().Contains (args.Context?.Source)) + if (SubViews.OfType ().Contains (args.Context?.Source)) { return; } @@ -377,7 +377,7 @@ public class MenuBarv2 : Menuv2, IDesignable /// Shows the specified popover, but only if the menu bar is active. /// /// - private void ShowItem (MenuBarItemv2? menuBarItem) + private void ShowItem (MenuBarItem? menuBarItem) { // Logging.Debug ($"{Title} - {menuBarItem?.Id}"); @@ -396,11 +396,11 @@ public class MenuBarv2 : Menuv2, IDesignable } // If the active Application Popover is part of this MenuBar, hide it. - if (Application.Popover?.GetActivePopover () is PopoverMenu popoverMenu + if (App?.Popover?.GetActivePopover () is PopoverMenu popoverMenu && popoverMenu.Root?.SuperMenuItem?.SuperView == this) { - // Logging.Debug ($"{Title} - Calling Application.Popover?.Hide ({popoverMenu.Title})"); - Application.Popover.Hide (popoverMenu); + // Logging.Debug ($"{Title} - Calling App?.Popover?.Hide ({popoverMenu.Title})"); + App?.Popover.Hide (popoverMenu); } if (menuBarItem is null) @@ -420,7 +420,11 @@ public class MenuBarv2 : Menuv2, IDesignable } // Logging.Debug ($"{Title} - \"{menuBarItem.PopoverMenu?.Title}\".MakeVisible"); - menuBarItem.PopoverMenu?.MakeVisible (new Point (menuBarItem.FrameToScreen ().X, menuBarItem.FrameToScreen ().Bottom)); + if (menuBarItem.PopoverMenu is { }) + { + menuBarItem.PopoverMenu.App ??= App; + menuBarItem.PopoverMenu.MakeVisible (new Point (menuBarItem.FrameToScreen ().X, menuBarItem.FrameToScreen ().Bottom)); + } menuBarItem.Accepting += OnMenuItemAccepted; @@ -442,7 +446,7 @@ public class MenuBarv2 : Menuv2, IDesignable } } - private MenuBarItemv2? GetActiveItem () { return SubViews.OfType ().FirstOrDefault (sv => sv is { PopoverMenu: { Visible: true } }); } + private MenuBarItem? GetActiveItem () { return SubViews.OfType ().FirstOrDefault (sv => sv is { PopoverMenu: { Visible: true } }); } /// /// Hides the popover menu associated with the active menu bar item and updates the focus state. @@ -455,7 +459,7 @@ public class MenuBarv2 : Menuv2, IDesignable /// /// /// if the popover was hidden - public bool HideItem (MenuBarItemv2? activeItem) + public bool HideItem (MenuBarItem? activeItem) { // Logging.Debug ($"{Title} ({activeItem?.Title}) - Active: {Active}, CanFocus: {CanFocus}, HasFocus: {HasFocus}"); @@ -480,16 +484,16 @@ public class MenuBarv2 : Menuv2, IDesignable /// /// /// - public IEnumerable GetMenuItemsWithTitle (string title) + public IEnumerable GetMenuItemsWithTitle (string title) { - List menuItems = new (); + List menuItems = new (); if (string.IsNullOrEmpty (title)) { return menuItems; } - foreach (MenuBarItemv2 mbi in SubViews.OfType ()) + foreach (MenuBarItem mbi in SubViews.OfType ()) { if (mbi.PopoverMenu is { }) { @@ -501,11 +505,16 @@ public class MenuBarv2 : Menuv2, IDesignable } /// - public bool EnableForDesign (ref TContext context) where TContext : notnull + public bool EnableForDesign (ref TContext targetView) where TContext : notnull { // Note: This menu is used by unit tests. If you modify it, you'll likely have to update // unit tests. + if (targetView is View target) + { + App ??= target.App; + } + Id = "DemoBar"; var bordersCb = new CheckBox @@ -549,15 +558,15 @@ public class MenuBarv2 : Menuv2, IDesignable }; Add ( - new MenuBarItemv2 ( + new MenuBarItem ( "_File", [ - new MenuItemv2 (context as View, Command.New), - new MenuItemv2 (context as View, Command.Open), - new MenuItemv2 (context as View, Command.Save), - new MenuItemv2 (context as View, Command.SaveAs), + new MenuItem (targetView as View, Command.New), + new MenuItem (targetView as View, Command.Open), + new MenuItem (targetView as View, Command.Save), + new MenuItem (targetView as View, Command.SaveAs), new Line (), - new MenuItemv2 + new MenuItem { Title = "_File Options", SubMenu = new ( @@ -576,13 +585,13 @@ public class MenuBarv2 : Menuv2, IDesignable Key = Key.W.WithCtrl, CommandView = enableOverwriteCb, Command = Command.EnableOverwrite, - TargetView = context as View + TargetView = targetView as View }, new () { Title = "_File Settings...", HelpText = "More file settings", - Action = () => MessageBox.Query ( + Action = () => MessageBox.Query (App, "File Settings", "This is the File Settings Dialog\n", "_Ok", @@ -592,25 +601,25 @@ public class MenuBarv2 : Menuv2, IDesignable ) }, new Line (), - new MenuItemv2 + new MenuItem { Title = "_Preferences", SubMenu = new ( [ - new MenuItemv2 + new MenuItem { CommandView = bordersCb, HelpText = "Toggle Menu Borders", Action = ToggleMenuBorders }, - new MenuItemv2 + new MenuItem { HelpText = "3 Mutually Exclusive Options", CommandView = mutuallyExclusiveOptionsSelector, Key = Key.F7 }, new Line (), - new MenuItemv2 + new MenuItem { HelpText = "MenuBar BG Color", CommandView = menuBgColorCp, @@ -620,9 +629,9 @@ public class MenuBarv2 : Menuv2, IDesignable ) }, new Line (), - new MenuItemv2 + new MenuItem { - TargetView = context as View, + TargetView = targetView as View, Key = Application.QuitKey, Command = Command.Quit } @@ -631,16 +640,16 @@ public class MenuBarv2 : Menuv2, IDesignable ); Add ( - new MenuBarItemv2 ( + new MenuBarItem ( "_Edit", [ - new MenuItemv2 (context as View, Command.Cut), - new MenuItemv2 (context as View, Command.Copy), - new MenuItemv2 (context as View, Command.Paste), + new MenuItem (targetView as View, Command.Cut), + new MenuItem (targetView as View, Command.Copy), + new MenuItem (targetView as View, Command.Paste), new Line (), - new MenuItemv2 (context as View, Command.SelectAll), + new MenuItem (targetView as View, Command.SelectAll), new Line (), - new MenuItemv2 + new MenuItem { Title = "_Details", SubMenu = new (ConfigureDetailsSubMenu ()) @@ -650,18 +659,18 @@ public class MenuBarv2 : Menuv2, IDesignable ); Add ( - new MenuBarItemv2 ( + new MenuBarItem ( "_Help", [ - new MenuItemv2 + new MenuItem { Title = "_Online Help...", - Action = () => MessageBox.Query ("Online Help", "https://gui-cs.github.io/Terminal.Gui", "Ok") + Action = () => MessageBox.Query (App, "Online Help", "https://gui-cs.github.io/Terminal.Gui", "Ok") }, - new MenuItemv2 + new MenuItem { Title = "About...", - Action = () => MessageBox.Query ("About", "Something About Mary.", "Ok") + Action = () => MessageBox.Query (App, "About", "Something About Mary.", "Ok") } ] ) @@ -671,14 +680,14 @@ public class MenuBarv2 : Menuv2, IDesignable void ToggleMenuBorders () { - foreach (MenuBarItemv2 mbi in SubViews.OfType ()) + foreach (MenuBarItem mbi in SubViews.OfType ()) { if (mbi is not { PopoverMenu: { } }) { continue; } - foreach (Menuv2? subMenu in mbi.PopoverMenu.GetAllSubMenus ()) + foreach (Menu? subMenu in mbi.PopoverMenu.GetAllSubMenus ()) { if (bordersCb.CheckedState == CheckState.Checked) { @@ -692,21 +701,21 @@ public class MenuBarv2 : Menuv2, IDesignable } } - MenuItemv2 [] ConfigureDetailsSubMenu () + MenuItem [] ConfigureDetailsSubMenu () { - var detail = new MenuItemv2 + var detail = new MenuItem { Title = "_Detail 1", Text = "Some detail #1" }; - var nestedSubMenu = new MenuItemv2 + var nestedSubMenu = new MenuItem { Title = "_Moar Details", SubMenu = new (ConfigureMoreDetailsSubMenu ()) }; - var editMode = new MenuItemv2 + var editMode = new MenuItem { Text = "App Binding to Command.Edit", Id = "EditMode", @@ -721,14 +730,14 @@ public class MenuBarv2 : Menuv2, IDesignable View [] ConfigureMoreDetailsSubMenu () { - var deeperDetail = new MenuItemv2 + var deeperDetail = new MenuItem { Title = "_Deeper Detail", Text = "Deeper Detail", - Action = () => { MessageBox.Query ("Deeper Detail", "Lots of details", "_Ok"); } + Action = () => { MessageBox.Query (App, "Deeper Detail", "Lots of details", "_Ok"); } }; - var belowLineDetail = new MenuItemv2 + var belowLineDetail = new MenuItem { Title = "_Even more detail", Text = "Below the line" diff --git a/Terminal.Gui/Views/Menu/MenuBarItemv2.cs b/Terminal.Gui/Views/Menu/MenuBarItem.cs similarity index 86% rename from Terminal.Gui/Views/Menu/MenuBarItemv2.cs rename to Terminal.Gui/Views/Menu/MenuBarItem.cs index ca82d7fc3..fb353acbf 100644 --- a/Terminal.Gui/Views/Menu/MenuBarItemv2.cs +++ b/Terminal.Gui/Views/Menu/MenuBarItem.cs @@ -1,21 +1,22 @@ -#nullable enable +using System.Diagnostics; + namespace Terminal.Gui.Views; /// -/// A -derived object to be used as items in a . +/// A -derived object to be used as items in a . /// MenuBarItems hold a instead of a . /// -public class MenuBarItemv2 : MenuItemv2 +public class MenuBarItem : MenuItem { /// - /// Creates a new instance of . + /// Creates a new instance of . /// - public MenuBarItemv2 () : base (null, Command.NotBound) { } + public MenuBarItem () : base (null, Command.NotBound) { } /// - /// Creates a new instance of . Each MenuBarItem typically has a + /// Creates a new instance of . Each MenuBarItem typically has a /// that is /// shown when the item is selected. /// @@ -31,7 +32,7 @@ public class MenuBarItemv2 : MenuItemv2 /// /// The text to display for the command. /// The Popover Menu that will be displayed when this item is selected. - public MenuBarItemv2 (View? targetView, Command command, string? commandText, PopoverMenu? popoverMenu = null) + public MenuBarItem (View? targetView, Command command, string? commandText, PopoverMenu? popoverMenu = null) : base ( targetView, command, @@ -43,14 +44,14 @@ public class MenuBarItemv2 : MenuItemv2 } /// - /// Creates a new instance of with the specified . This is a + /// Creates a new instance of with the specified . This is a /// helper for the most common MenuBar use-cases. /// /// /// /// The text to display for the command. /// The Popover Menu that will be displayed when this item is selected. - public MenuBarItemv2 (string commandText, PopoverMenu? popoverMenu = null) + public MenuBarItem (string commandText, PopoverMenu? popoverMenu = null) : this ( null, Command.NotBound, @@ -59,7 +60,7 @@ public class MenuBarItemv2 : MenuItemv2 { } /// - /// Creates a new instance of with the automatcialy added to a + /// Creates a new instance of with the automatcialy added to a /// . /// This is a helper for the most common MenuBar use-cases. /// @@ -70,7 +71,7 @@ public class MenuBarItemv2 : MenuItemv2 /// The menu items that will be added to the Popover Menu that will be displayed when this item is /// selected. /// - public MenuBarItemv2 (string commandText, IEnumerable menuItems) + public MenuBarItem (string commandText, IEnumerable menuItems) : this ( null, Command.NotBound, @@ -82,7 +83,7 @@ public class MenuBarItemv2 : MenuItemv2 /// Do not use this property. MenuBarItem does not support SubMenu. Use instead. /// /// - public new Menuv2? SubMenu + public new Menu? SubMenu { get => null; set => throw new InvalidOperationException ("MenuBarItem does not support SubMenu. Use PopoverMenu instead."); @@ -113,6 +114,8 @@ public class MenuBarItemv2 : MenuItemv2 if (_popoverMenu is { }) { + _popoverMenu.App = App; + PopoverMenuOpen = _popoverMenu.Visible; _popoverMenu.VisibleChanged += OnPopoverVisibleChanged; _popoverMenu.Accepted += OnPopoverMenuOnAccepted; @@ -182,7 +185,7 @@ public class MenuBarItemv2 : MenuItemv2 { // If the user presses the hotkey for a menu item that is already open, // it should close the menu item (Test: MenuBarItem_HotKey_DeActivates) - if (SuperView is MenuBarv2 { } menuBar) + if (SuperView is MenuBar { } menuBar) { menuBar.HideActiveItem (); } diff --git a/Terminal.Gui/Views/Menu/MenuItemv2.cs b/Terminal.Gui/Views/Menu/MenuItem.cs similarity index 89% rename from Terminal.Gui/Views/Menu/MenuItemv2.cs rename to Terminal.Gui/Views/Menu/MenuItem.cs index c5f472307..01ca14922 100644 --- a/Terminal.Gui/Views/Menu/MenuItemv2.cs +++ b/Terminal.Gui/Views/Menu/MenuItem.cs @@ -1,23 +1,22 @@ -#nullable enable using System.ComponentModel; namespace Terminal.Gui.Views; /// -/// A -derived object to be used as a menu item in a . Has title, an -/// A -derived object to be used as a menu item in a . Has title, an +/// A -derived object to be used as a menu item in a . Has title, an +/// A -derived object to be used as a menu item in a . Has title, an /// associated help text, and an action to execute on activation. /// -public class MenuItemv2 : Shortcut +public class MenuItem : Shortcut { /// - /// Creates a new instance of . + /// Creates a new instance of . /// - public MenuItemv2 () : base (Key.Empty, null, null) { } + public MenuItem () : base (Key.Empty, null, null) { } /// - /// Creates a new instance of , binding it to and + /// Creates a new instance of , binding it to and /// . The Key /// has bound to will be used as . /// @@ -35,7 +34,7 @@ public class MenuItemv2 : Shortcut /// The text to display for the command. /// The help text to display. /// The submenu to display when the user selects this menu item. - public MenuItemv2 (View? targetView, Command command, string? commandText = null, string? helpText = null, Menuv2? subMenu = null) + public MenuItem (View? targetView, Command command, string? commandText = null, string? helpText = null, Menu? subMenu = null) : base ( targetView?.HotKeyBindings.GetFirstFromCommands (command)!, string.IsNullOrEmpty (commandText) ? GlobalResources.GetString ($"cmd.{command}") : commandText, @@ -49,17 +48,17 @@ public class MenuItemv2 : Shortcut } /// - public MenuItemv2 (string? commandText = null, string? helpText = null, Action? action = null, Key? key = null) + public MenuItem (string? commandText = null, string? helpText = null, Action? action = null, Key? key = null) : base (key ?? Key.Empty, commandText, action, helpText) { } /// - public MenuItemv2 (string commandText, Key key, Action? action = null) + public MenuItem (string commandText, Key key, Action? action = null) : base (key ?? Key.Empty, commandText, action, null) { } /// - public MenuItemv2 (string? commandText = null, string? helpText = null, Menuv2? subMenu = null) + public MenuItem (string? commandText = null, string? helpText = null, Menu? subMenu = null) : base (Key.Empty, commandText, null, helpText) { SubMenu = subMenu; @@ -136,7 +135,7 @@ public class MenuItemv2 : Shortcut { // Is this an Application-bound command? // Logging.Debug ($"{Title} - Application.InvokeCommandsBoundToKey ({Key})..."); - ret = Application.InvokeCommandsBoundToKey (Key); + ret = App?.Keyboard.InvokeCommandsBoundToKey (Key); } } @@ -172,12 +171,12 @@ public class MenuItemv2 : Shortcut // return ret is true; //} - private Menuv2? _subMenu; + private Menu? _subMenu; /// /// The submenu to display when the user selects this menu item. /// - public Menuv2? SubMenu + public Menu? SubMenu { get => _subMenu; set @@ -186,6 +185,7 @@ public class MenuItemv2 : Shortcut if (_subMenu is { }) { + SubMenu!.App ??= App; SubMenu!.Visible = false; // TODO: This is a temporary hack - add a flag or something instead KeyView.Text = $"{Glyphs.RightArrow}"; diff --git a/Terminal.Gui/Views/Menu/PopoverMenu.cs b/Terminal.Gui/Views/Menu/PopoverMenu.cs index dcaef66ea..ef0767218 100644 --- a/Terminal.Gui/Views/Menu/PopoverMenu.cs +++ b/Terminal.Gui/Views/Menu/PopoverMenu.cs @@ -1,15 +1,15 @@ -#nullable enable + namespace Terminal.Gui.Views; /// /// Provides a cascading menu that pops over all other content. Can be used as a context menu or a drop-down /// all other content. Can be used as a context menu or a drop-down -/// menu as part of as part of . +/// menu as part of as part of . /// /// /// -/// To use as a context menu, register the popover menu with and call +/// To use as a context menu, register the popover menu with and call /// . /// /// @@ -18,7 +18,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable /// /// Initializes a new instance of the class. /// - public PopoverMenu () : this ((Menuv2?)null) { } + public PopoverMenu () : this ((Menu?)null) { } /// /// Initializes a new instance of the class. If any of the elements of @@ -26,24 +26,24 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable /// a see will be created instead. /// public PopoverMenu (IEnumerable? menuItems) : this ( - new Menuv2 (menuItems?.Select (item => item ?? new Line ())) + new Menu (menuItems?.Select (item => item ?? new Line ())) { Title = "Popover Root" }) { } /// - public PopoverMenu (IEnumerable? menuItems) : this ( - new Menuv2 (menuItems) + public PopoverMenu (IEnumerable? menuItems) : this ( + new Menu (menuItems) { Title = "Popover Root" }) { } /// - /// Initializes a new instance of the class with the specified root . + /// Initializes a new instance of the class with the specified root . /// - public PopoverMenu (Menuv2? root) + public PopoverMenu (Menu? root) { // Do this to support debugging traces where Title gets set base.HotKeySpecifier = (Rune)'\xffff'; @@ -107,7 +107,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable return false; } - if (MostFocused is MenuItemv2 { SuperView: Menuv2 focusedMenu }) + if (MostFocused is MenuItem { SuperView: Menu focusedMenu }) { focusedMenu.SuperMenuItem?.SetFocus (); @@ -119,7 +119,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable bool? MoveRight (ICommandContext? ctx) { - if (MostFocused is MenuItemv2 { SubMenu.Visible: true } focused) + if (MostFocused is MenuItem { SubMenu.Visible: true } focused) { focused.SubMenu.SetFocus (); @@ -176,7 +176,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable UpdateKeyBindings (); SetPosition (idealScreenPosition); - Application.Popover?.Show (this); + App!.Popover?.Show (this); } /// @@ -188,7 +188,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable /// If , the current mouse position will be used. public void SetPosition (Point? idealScreenPosition = null) { - idealScreenPosition ??= Application.GetLastMousePosition (); + idealScreenPosition ??= App?.Mouse.LastMousePosition; if (idealScreenPosition is null || Root is null) { @@ -199,6 +199,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable if (!Root.IsInitialized) { + Root.App ??= App; Root.BeginInit (); Root.EndInit (); Root.Layout (); @@ -223,16 +224,16 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable else { HideAndRemoveSubMenu (_root); - Application.Popover?.Hide (this); + App?.Popover?.Hide (this); } } - private Menuv2? _root; + private Menu? _root; /// - /// Gets or sets the that is the root of the Popover Menu. + /// Gets or sets the that is the root of the Popover Menu. /// - public Menuv2? Root + public Menu? Root { get => _root; set @@ -246,15 +247,21 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable _root = value; + if (_root is { }) + { + _root.App = App; + } + // TODO: This needs to be done whenever any MenuItem in the menu tree changes to support dynamic menus // TODO: And it needs to clear the old bindings first UpdateKeyBindings (); // TODO: This needs to be done whenever any MenuItem in the menu tree changes to support dynamic menus - IEnumerable allMenus = GetAllSubMenus (); + IEnumerable allMenus = GetAllSubMenus (); - foreach (Menuv2 menu in allMenus) + foreach (Menu menu in allMenus) { + menu.App = App; menu.Visible = false; menu.Accepting += MenuOnAccepting; menu.Accepted += MenuAccepted; @@ -265,9 +272,9 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable private void UpdateKeyBindings () { - IEnumerable all = GetMenuItemsOfAllSubMenus (); + IEnumerable all = GetMenuItemsOfAllSubMenus (); - foreach (MenuItemv2 menuItem in all.Where (mi => mi.Command != Command.NotBound)) + foreach (MenuItem menuItem in all.Where (mi => mi.Command != Command.NotBound)) { Key? key; @@ -279,7 +286,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable else { // No TargetView implies Application HotKey - key = Application.KeyBindings.GetFirstFromCommands (menuItem.Command); + key = App?.Keyboard.KeyBindings.GetFirstFromCommands (menuItem.Command); } if (key is not { IsValid: true }) @@ -302,9 +309,9 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable protected override bool OnKeyDownNotHandled (Key key) { // See if any of our MenuItems have this key as Key - IEnumerable all = GetMenuItemsOfAllSubMenus (); + IEnumerable all = GetMenuItemsOfAllSubMenus (); - foreach (MenuItemv2 menuItem in all) + foreach (MenuItem menuItem in all) { if (key != Application.QuitKey && menuItem.Key == key) { @@ -321,26 +328,26 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable /// Gets all the submenus in the PopoverMenu. /// /// - public IEnumerable GetAllSubMenus () + public IEnumerable GetAllSubMenus () { - List result = []; + List result = []; if (Root == null) { return result; } - Stack stack = new (); + Stack stack = new (); stack.Push (Root); while (stack.Count > 0) { - Menuv2 currentMenu = stack.Pop (); + Menu currentMenu = stack.Pop (); result.Add (currentMenu); foreach (View subView in currentMenu.SubViews) { - if (subView is MenuItemv2 { SubMenu: { } } menuItem) + if (subView is MenuItem { SubMenu: { } } menuItem) { stack.Push (menuItem.SubMenu); } @@ -354,15 +361,15 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable /// Gets all the MenuItems in the PopoverMenu. /// /// - internal IEnumerable GetMenuItemsOfAllSubMenus () + internal IEnumerable GetMenuItemsOfAllSubMenus () { - List result = []; + List result = []; - foreach (Menuv2 menu in GetAllSubMenus ()) + foreach (Menu menu in GetAllSubMenus ()) { foreach (View subView in menu.SubViews) { - if (subView is MenuItemv2 menuItem) + if (subView is MenuItem menuItem) { result.Add (menuItem); } @@ -376,16 +383,16 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable /// Pops up the submenu of the specified MenuItem, if there is one. /// /// - internal void ShowSubMenu (MenuItemv2? menuItem) + internal void ShowSubMenu (MenuItem? menuItem) { - var menu = menuItem?.SuperView as Menuv2; + var menu = menuItem?.SuperView as Menu; // Logging.Debug ($"{Title} - menuItem: {menuItem?.Title}, menu: {menu?.Title}"); menu?.Layout (); // If there's a visible peer, remove / hide it - if (menu?.SubViews.FirstOrDefault (v => v is MenuItemv2 { SubMenu.Visible: true }) is MenuItemv2 visiblePeer) + if (menu?.SubViews.FirstOrDefault (v => v is MenuItem { SubMenu.Visible: true }) is MenuItem visiblePeer) { HideAndRemoveSubMenu (visiblePeer.SubMenu); visiblePeer.ForceFocusColors = false; @@ -414,7 +421,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable /// The menu to locate. /// Ideal screen-relative location. /// - internal Point GetMostVisibleLocationForSubMenu (Menuv2 menu, Point idealLocation) + internal Point GetMostVisibleLocationForSubMenu (Menu menu, Point idealLocation) { var pos = Point.Empty; @@ -429,7 +436,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable return new (nx, ny); } - private void AddAndShowSubMenu (Menuv2? menu) + private void AddAndShowSubMenu (Menu? menu) { if (menu is { SuperView: null, Visible: false }) { @@ -439,6 +446,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable if (!menu!.IsInitialized) { + menu.App ??= App; menu.BeginInit (); menu.EndInit (); } @@ -454,14 +462,14 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable } } - private void HideAndRemoveSubMenu (Menuv2? menu) + private void HideAndRemoveSubMenu (Menu? menu) { if (menu is { Visible: true }) { // Logging.Debug ($"{Title} ({menu?.Title}) - menu.Visible: {menu?.Visible}"); // If there's a visible submenu, remove / hide it - if (menu.SubViews.FirstOrDefault (v => v is MenuItemv2 { SubMenu.Visible: true }) is MenuItemv2 visiblePeer) + if (menu.SubViews.FirstOrDefault (v => v is MenuItem { SubMenu.Visible: true }) is MenuItem visiblePeer) { HideAndRemoveSubMenu (visiblePeer.SubMenu); visiblePeer.ForceFocusColors = false; @@ -503,11 +511,11 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable { // Logging.Debug ($"{Title} ({e.Context?.Source?.Title}) Command: {e.Context?.Command}"); - if (e.Context?.Source is MenuItemv2 { SubMenu: null }) + if (e.Context?.Source is MenuItem { SubMenu: null }) { HideAndRemoveSubMenu (_root); } - else if (e.Context?.Source is MenuItemv2 { SubMenu: { } } menuItemWithSubMenu) + else if (e.Context?.Source is MenuItem { SubMenu: { } } menuItemWithSubMenu) { ShowSubMenu (menuItemWithSubMenu); } @@ -587,7 +595,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable /// public event EventHandler? Accepted; - private void MenuOnSelectedMenuItemChanged (object? sender, MenuItemv2? e) + private void MenuOnSelectedMenuItemChanged (object? sender, MenuItem? e) { // Logging.Debug ($"{Title} - e.Title: {e?.Title}"); ShowSubMenu (e); @@ -596,7 +604,7 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable /// protected override void OnSubViewAdded (View view) { - if (Root is null && (view is Menuv2 || view is MenuItemv2)) + if (Root is null && (view is Menu || view is MenuItem)) { throw new InvalidOperationException ("Do not add MenuItems or Menus directly to a PopoverMenu. Use the Root property."); } @@ -609,9 +617,9 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable { if (disposing) { - IEnumerable allMenus = GetAllSubMenus (); + IEnumerable allMenus = GetAllSubMenus (); - foreach (Menuv2 menu in allMenus) + foreach (Menu menu in allMenus) { menu.Accepting -= MenuOnAccepting; menu.Accepted -= MenuAccepted; @@ -626,27 +634,27 @@ public class PopoverMenu : PopoverBaseImpl, IDesignable } /// - public bool EnableForDesign (ref TContext context) where TContext : notnull + public bool EnableForDesign (ref TContext targetView) where TContext : notnull { // Note: This menu is used by unit tests. If you modify it, you'll likely have to update // unit tests. Root = new ( [ - new MenuItemv2 (context as View, Command.Cut), - new MenuItemv2 (context as View, Command.Copy), - new MenuItemv2 (context as View, Command.Paste), + new MenuItem (targetView as View, Command.Cut), + new MenuItem (targetView as View, Command.Copy), + new MenuItem (targetView as View, Command.Paste), new Line (), - new MenuItemv2 (context as View, Command.SelectAll), + new MenuItem (targetView as View, Command.SelectAll), new Line (), - new MenuItemv2 (context as View, Command.Quit) + new MenuItem (targetView as View, Command.Quit) ]) { Title = "Popover Demo Root" }; // NOTE: This is a workaround for the fact that the PopoverMenu is not visible in the designer - // NOTE: without being activated via Application.Popover. But we want it to be visible. + // NOTE: without being activated via App?.Popover. But we want it to be visible. // NOTE: If you use PopoverView.EnableForDesign for real Popover scenarios, change back to false // NOTE: after calling EnableForDesign. //Visible = true; diff --git a/Terminal.Gui/Views/Menuv1/Menu.cs b/Terminal.Gui/Views/Menuv1/Menu.cs deleted file mode 100644 index 7833e4196..000000000 --- a/Terminal.Gui/Views/Menuv1/Menu.cs +++ /dev/null @@ -1,1010 +0,0 @@ -#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable. -#nullable enable - - -namespace Terminal.Gui.Views; - -#pragma warning disable CS0618 // Type or member is obsolete - -/// -/// An internal class used to represent a menu pop-up menu. Created and managed by . -/// -internal sealed class Menu : View -{ - public Menu () - { - if (Application.Top is { }) - { - Application.Top.DrawComplete += Top_DrawComplete; - Application.Top.SizeChanging += Current_TerminalResized; - } - - Application.MouseEvent += Application_RootMouseEvent; - Application.Mouse.UnGrabbedMouse += Application_UnGrabbedMouse; - - // Things this view knows how to do - AddCommand (Command.Up, () => MoveUp ()); - AddCommand (Command.Down, () => MoveDown ()); - - AddCommand ( - Command.Left, - () => - { - _host!.PreviousMenu (true); - - return true; - } - ); - - AddCommand ( - Command.Cancel, - () => - { - CloseAllMenus (); - - return true; - } - ); - - AddCommand ( - Command.Accept, - () => - { - RunSelected (); - - return true; - } - ); - - AddCommand ( - Command.Select, - ctx => - { - if (ctx is not CommandContext keyCommandContext) - { - return false; - } - - return _host?.SelectItem ((keyCommandContext.Binding.Data as MenuItem)!); - }); - - AddCommand ( - Command.Toggle, - ctx => - { - if (ctx is not CommandContext keyCommandContext) - { - return false; - } - - return ExpandCollapse ((keyCommandContext.Binding.Data as MenuItem)!); - }); - - AddCommand ( - Command.HotKey, - ctx => - { - if (ctx is not CommandContext keyCommandContext) - { - return false; - } - - return _host?.SelectItem ((keyCommandContext.Binding.Data as MenuItem)!); - }); - - // Default key bindings for this view - KeyBindings.Add (Key.CursorUp, Command.Up); - KeyBindings.Add (Key.CursorDown, Command.Down); - KeyBindings.Add (Key.CursorLeft, Command.Left); - KeyBindings.Add (Key.CursorRight, Command.Right); - KeyBindings.Add (Key.Esc, Command.Cancel); - } - - internal int _currentChild; - internal View? _previousSubFocused; - private readonly MenuBarItem? _barItems; - private readonly MenuBar _host; - - public override void BeginInit () - { - base.BeginInit (); - - Rectangle frame = MakeFrame (Frame.X, Frame.Y, _barItems!.Children!, Parent); - - if (Frame.X != frame.X) - { - X = frame.X; - } - - if (Frame.Y != frame.Y) - { - Y = frame.Y; - } - - Width = frame.Width; - Height = frame.Height; - - if (_barItems.Children is { }) - { - foreach (MenuItem? menuItem in _barItems.Children) - { - if (menuItem is { }) - { - menuItem._menuBar = Host; - - if (menuItem.ShortcutKey != Key.Empty) - { - KeyBinding keyBinding = new ([Command.Select], this, data: menuItem); - - // Remove an existent ShortcutKey - menuItem._menuBar.HotKeyBindings.Remove (menuItem.ShortcutKey!); - menuItem._menuBar.HotKeyBindings.Add (menuItem.ShortcutKey!, keyBinding); - } - } - } - } - - if (_barItems is { IsTopLevel: true }) - { - // This is a standalone MenuItem on a MenuBar - SetScheme (_host.GetScheme ()); - CanFocus = true; - } - else - { - _currentChild = -1; - - for (var i = 0; i < _barItems.Children?.Length; i++) - { - if (_barItems.Children [i]?.IsEnabled () == true) - { - _currentChild = i; - - break; - } - } - - SetScheme (_host.GetScheme ()); - CanFocus = true; - WantMousePositionReports = _host.WantMousePositionReports; - } - - BorderStyle = _host.MenusBorderStyle; - - AddCommand ( - Command.Right, - () => - { - _host.NextMenu ( - !_barItems.IsTopLevel - || (_barItems.Children is { Length: > 0 } - && _currentChild > -1 - && _currentChild < _barItems.Children.Length - && _barItems.Children [_currentChild]!.IsFromSubMenu), - _barItems.Children is { Length: > 0 } - && _currentChild > -1 - && _host.UseSubMenusSingleFrame - && _barItems.SubMenu ( - _barItems.Children [_currentChild]! - ) - != null! - ); - - return true; - } - ); - - AddKeyBindingsHotKey (_barItems); - } - - public override Point? PositionCursor () - { - if (_host.IsMenuOpen) - { - if (_barItems!.IsTopLevel) - { - return _host.PositionCursor (); - } - - Move (2, 1 + _currentChild); - - return null; // Don't show the cursor - } - - return _host.PositionCursor (); - } - - public void Run (Action? action) - { - if (action is null) - { - return; - } - - Application.Mouse.UngrabMouse (); - _host.CloseAllMenus (); - Application.LayoutAndDraw (true); - - _host.Run (action); - } - - protected override void Dispose (bool disposing) - { - RemoveKeyBindingsHotKey (_barItems); - - if (Application.Top is { }) - { - Application.Top.DrawComplete -= Top_DrawComplete; - Application.Top.SizeChanging -= Current_TerminalResized; - } - - Application.MouseEvent -= Application_RootMouseEvent; - Application.Mouse.UnGrabbedMouse -= Application_UnGrabbedMouse; - base.Dispose (disposing); - } - - protected override void OnHasFocusChanged (bool newHasFocus, View? previousFocusedView, View? view) - { - if (!newHasFocus) - { - _host.LostFocus (previousFocusedView!); - } - } - - /// - protected override bool OnKeyDownNotHandled (Key keyEvent) - { - // We didn't handle the key, pass it on to host - return _host.InvokeCommandsBoundToHotKey (keyEvent) is true; - } - - protected override bool OnMouseEvent (MouseEventArgs me) - { - if (!_host._handled && !_host.HandleGrabView (me, this)) - { - return false; - } - - _host._handled = false; - bool disabled; - - if (me.Flags == MouseFlags.Button1Clicked) - { - disabled = false; - - if (me.Position.Y < 0) - { - return me.Handled = true; - } - - if (me.Position.Y >= _barItems!.Children!.Length) - { - return me.Handled = true; - } - - MenuItem item = _barItems.Children [me.Position.Y]!; - - // ReSharper disable once ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract - if (item is null || !item.IsEnabled ()) - { - disabled = true; - } - - if (disabled) - { - return me.Handled = true; - } - - _currentChild = me.Position.Y; - RunSelected (); - - return me.Handled = true; - } - - if (me.Flags != MouseFlags.Button1Pressed - && me.Flags != MouseFlags.Button1DoubleClicked - && me.Flags != MouseFlags.Button1TripleClicked - && me.Flags != MouseFlags.ReportMousePosition - && !me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition)) - { - return false; - } - - { - disabled = false; - - if (me.Position.Y < 0 || me.Position.Y >= _barItems!.Children!.Length) - { - return me.Handled = true; - } - - MenuItem item = _barItems.Children [me.Position.Y]!; - - // ReSharper disable once ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract - if (item is null) - { - return me.Handled = true; - } - - if (item.IsEnabled () != true) - { - disabled = true; - } - - if (!disabled) - { - _currentChild = me.Position.Y; - } - - if (_host.UseSubMenusSingleFrame || !CheckSubMenu ()) - { - SetNeedsDraw (); - SetParentSetNeedsDisplay (); - - return me.Handled = true; - } - - _host.OnMenuOpened (); - - return me.Handled = true; - } - } - - /// - protected override void OnVisibleChanged () - { - base.OnVisibleChanged (); - - if (Visible) - { - Application.MouseEvent += Application_RootMouseEvent; - } - else - { - Application.MouseEvent -= Application_RootMouseEvent; - } - } - - internal required MenuBarItem? BarItems - { - get => _barItems!; - init - { - ArgumentNullException.ThrowIfNull (value); - _barItems = value; - - // Debugging aid so ToString() is helpful - Text = _barItems.Title; - } - } - - internal bool CheckSubMenu () - { - if (_currentChild == -1 || _barItems?.Children? [_currentChild] is null) - { - return true; - } - - MenuBarItem? subMenu = _barItems.SubMenu (_barItems.Children [_currentChild]!); - - // ReSharper disable once ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract - if (subMenu is { }) - { - int pos = -1; - - if (_host._openSubMenu is { }) - { - pos = _host._openSubMenu.FindIndex (o => o._barItems == subMenu); - } - - if (pos == -1 - && this != _host.OpenCurrentMenu - && subMenu.Children != _host.OpenCurrentMenu!._barItems!.Children - && !_host.CloseMenu (false, true)) - { - return false; - } - - _host.Activate (_host._selected, pos, subMenu); - } - else if (_host._openSubMenu?.Count == 0 || _host._openSubMenu?.Last ()._barItems!.IsSubMenuOf (_barItems.Children [_currentChild]!) == false) - { - return _host.CloseMenu (false, true); - } - else - { - SetNeedsDraw (); - SetParentSetNeedsDisplay (); - } - - return true; - } - - internal Attribute DetermineSchemeFor (MenuItem? item, int index) - { - if (item is null) - { - return GetAttributeForRole (VisualRole.Normal); - } - - if (index == _currentChild) - { - return GetAttributeForRole (VisualRole.Focus); - } - - return !item.IsEnabled () ? GetAttributeForRole (VisualRole.Disabled) : GetAttributeForRole (VisualRole.Normal); - } - - internal required MenuBar Host - { - get => _host; - init - { - ArgumentNullException.ThrowIfNull (value); - _host = value; - } - } - - internal static Rectangle MakeFrame (int x, int y, MenuItem? []? items, Menu? parent = null) - { - if (items is null || items.Length == 0) - { - return Rectangle.Empty; - } - - int minX = x; - int minY = y; - const int borderOffset = 2; // This 2 is for the space around - int maxW = (items.Max (z => z?.Width) ?? 0) + borderOffset; - int maxH = items.Length + borderOffset; - - if (parent is { } && x + maxW > Application.Screen.Width) - { - minX = Math.Max (parent.Frame.Right - parent.Frame.Width - maxW, 0); - } - - if (y + maxH > Application.Screen.Height) - { - minY = Math.Max (Application.Screen.Height - maxH, 0); - } - - return new (minX, minY, maxW, maxH); - } - - internal Menu? Parent { get; init; } - - private void AddKeyBindingsHotKey (MenuBarItem? menuBarItem) - { - if (menuBarItem is null || menuBarItem.Children is null) - { - return; - } - - IEnumerable menuItems = menuBarItem.Children.Where (m => m is { })!; - - foreach (MenuItem menuItem in menuItems) - { - KeyBinding keyBinding = new ([Command.Toggle], this, data: menuItem); - - if (menuItem.HotKey != Key.Empty) - { - HotKeyBindings.Remove (menuItem.HotKey!); - HotKeyBindings.Add (menuItem.HotKey!, keyBinding); - HotKeyBindings.Remove (menuItem.HotKey!.WithAlt); - HotKeyBindings.Add (menuItem.HotKey.WithAlt, keyBinding); - } - } - } - - private void Application_RootMouseEvent (object? sender, MouseEventArgs a) - { - if (a.View is { } and (MenuBar or not Menu)) - { - return; - } - - if (!Visible) - { - throw new InvalidOperationException ("This shouldn't running on a invisible menu!"); - } - - View view = a.View ?? this; - - Point boundsPoint = view.ScreenToViewport (new (a.Position.X, a.Position.Y)); - - var me = new MouseEventArgs - { - Position = boundsPoint, - Flags = a.Flags, - ScreenPosition = a.Position, - View = view - }; - - if (view.NewMouseEvent (me) == true || a.Flags == MouseFlags.Button1Pressed || a.Flags == MouseFlags.Button1Released) - { - a.Handled = true; - } - } - - private void Application_UnGrabbedMouse (object? sender, ViewEventArgs a) - { - if (_host is { IsMenuOpen: true }) - { - _host.CloseAllMenus (); - } - } - - private void CloseAllMenus () - { - Application.Mouse.UngrabMouse (); - _host.CloseAllMenus (); - } - - private void Current_TerminalResized (object? sender, SizeChangedEventArgs e) - { - if (_host.IsMenuOpen) - { - _host.CloseAllMenus (); - } - } - - /// Called when a key bound to Command.ToggleExpandCollapse is pressed. This means a hot key was pressed. - /// - private bool ExpandCollapse (MenuItem? menuItem) - { - if (!IsInitialized || !Visible) - { - return true; - } - - for (var c = 0; c < _barItems!.Children!.Length; c++) - { - if (_barItems.Children [c] == menuItem) - { - _currentChild = c; - - break; - } - } - - if (menuItem is { }) - { - var m = menuItem as MenuBarItem; - - if (m?.Children?.Length > 0) - { - MenuItem? item = _barItems.Children [_currentChild]; - - if (item is null) - { - return true; - } - - // ReSharper disable once ConditionIsAlwaysTrueOrFalse - bool disabled = item is null || !item.IsEnabled (); - - if (!disabled && (_host.UseSubMenusSingleFrame || !CheckSubMenu ())) - { - SetNeedsDraw (); - SetParentSetNeedsDisplay (); - - return true; - } - - if (!disabled) - { - _host.OnMenuOpened (); - } - } - else - { - _host.SelectItem (menuItem); - } - } - else if (_host.IsMenuOpen) - { - _host.CloseAllMenus (); - } - else - { - _host.OpenMenu (); - } - - return true; - } - - private bool MoveDown () - { - if (_barItems!.IsTopLevel) - { - return true; - } - - bool disabled; - - do - { - _currentChild++; - - if (_currentChild >= _barItems?.Children?.Length) - { - _currentChild = 0; - } - - if (this != _host.OpenCurrentMenu && _barItems?.Children? [_currentChild]?.IsFromSubMenu == true && _host._selectedSub > -1) - { - _host.PreviousMenu (true); - _host.SelectEnabledItem (_barItems.Children!, _currentChild, out _currentChild); - _host.OpenCurrentMenu = this; - } - - MenuItem? item = _barItems?.Children? [_currentChild]; - - if (item?.IsEnabled () != true) - { - disabled = true; - } - else - { - disabled = false; - } - - if (_host is { UseSubMenusSingleFrame: false, UseKeysUpDownAsKeysLeftRight: true } - && _barItems?.SubMenu (_barItems?.Children? [_currentChild]!) != null - && !disabled - && _host.IsMenuOpen) - { - if (!CheckSubMenu ()) - { - return false; - } - - break; - } - - if (!_host.IsMenuOpen) - { - _host.OpenMenu (_host._selected); - } - } - while (_barItems?.Children? [_currentChild] is null || disabled); - - SetNeedsDraw (); - SetParentSetNeedsDisplay (); - - if (!_host.UseSubMenusSingleFrame) - { - _host.OnMenuOpened (); - } - - return true; - } - - private bool MoveUp () - { - if (_barItems!.IsTopLevel || _currentChild == -1) - { - return true; - } - - bool disabled; - - do - { - _currentChild--; - - if (_host.UseKeysUpDownAsKeysLeftRight && !_host.UseSubMenusSingleFrame) - { - if ((_currentChild == -1 || this != _host.OpenCurrentMenu) - && _barItems.Children! [_currentChild + 1]!.IsFromSubMenu - && _host._selectedSub > -1) - { - _currentChild++; - _host.PreviousMenu (true); - - if (_currentChild > 0) - { - _currentChild--; - _host.OpenCurrentMenu = this; - } - - break; - } - } - - if (_currentChild < 0) - { - _currentChild = _barItems.Children!.Length - 1; - } - - if (!_host.SelectEnabledItem (_barItems.Children!, _currentChild, out _currentChild, false)) - { - _currentChild = 0; - - if (!_host.SelectEnabledItem (_barItems.Children!, _currentChild, out _currentChild) && !_host.CloseMenu ()) - { - return false; - } - - break; - } - - MenuItem item = _barItems.Children! [_currentChild]!; - disabled = item.IsEnabled () != true; - - if (_host.UseSubMenusSingleFrame - || !_host.UseKeysUpDownAsKeysLeftRight - || _barItems.SubMenu (_barItems.Children [_currentChild]!) == null! - || disabled - || !_host.IsMenuOpen) - { - continue; - } - - if (!CheckSubMenu ()) - { - return false; - } - - break; - } - while (_barItems.Children [_currentChild] is null || disabled); - - SetNeedsDraw (); - SetParentSetNeedsDisplay (); - - if (!_host.UseSubMenusSingleFrame) - { - _host.OnMenuOpened (); - } - - return true; - } - - private void RemoveKeyBindingsHotKey (MenuBarItem? menuBarItem) - { - if (menuBarItem is null || menuBarItem.Children is null) - { - return; - } - - IEnumerable menuItems = menuBarItem.Children.Where (m => m is { })!; - - foreach (MenuItem menuItem in menuItems) - { - if (menuItem.HotKey != Key.Empty) - { - KeyBindings.Remove (menuItem.HotKey!); - KeyBindings.Remove (menuItem.HotKey!.WithAlt); - } - } - } - - private void RunSelected () - { - if (_barItems!.IsTopLevel) - { - Run (_barItems.Action); - } - else - { - switch (_currentChild) - { - case > -1 when _barItems.Children! [_currentChild]!.Action != null!: - Run (_barItems.Children [_currentChild]?.Action); - - break; - case 0 when _host.UseSubMenusSingleFrame && _barItems.Children [_currentChild]?.Parent!.Parent != null: - _host.PreviousMenu (_barItems.Children [_currentChild]!.Parent!.IsFromSubMenu, true); - - break; - case > -1 when _barItems.SubMenu (_barItems.Children [_currentChild]) != null!: - CheckSubMenu (); - - break; - } - } - } - - private void SetParentSetNeedsDisplay () - { - if (_host._openSubMenu is { }) - { - foreach (Menu menu in _host._openSubMenu) - { - menu.SetNeedsDraw (); - } - } - - _host._openMenu?.SetNeedsDraw (); - _host.SetNeedsDraw (); - } - - // By doing this we draw last, over everything else. - private void Top_DrawComplete (object? sender, DrawEventArgs e) - { - if (!Visible) - { - return; - } - - if (_barItems!.Children is null) - { - return; - } - - DrawAdornments (); - RenderLineCanvas (); - - // BUGBUG: Views should not change the clip. Doing so is an indcation of poor design or a bug in the framework. - Region? savedClip = SetClipToScreen (); - - SetAttribute (GetAttributeForRole (VisualRole.Normal)); - - for (int i = Viewport.Y; i < _barItems!.Children.Length; i++) - { - if (i < 0) - { - continue; - } - - if (ViewportToScreen (Viewport).Y + i >= Application.Screen.Height) - { - break; - } - - MenuItem? item = _barItems.Children [i]; - - SetAttribute ( - - // ReSharper disable once ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract - item is null ? GetAttributeForRole (VisualRole.Normal) : - i == _currentChild ? GetAttributeForRole (VisualRole.Focus) : GetAttributeForRole (VisualRole.Normal) - ); - - if (item is null && BorderStyle != LineStyle.None) - { - Move (-1, i); - AddRune (Glyphs.LeftTee); - } - else if (Frame.X < Application.Screen.Width) - { - Move (0, i); - } - - SetAttribute (DetermineSchemeFor (item, i)); - - for (int p = Viewport.X; p < Frame.Width - 2; p++) - { - // This - 2 is for the border - if (p < 0) - { - continue; - } - - if (ViewportToScreen (Viewport).X + p >= Application.Screen.Width) - { - break; - } - - if (item is null) - { - AddRune (Glyphs.HLine); - } - else if (i == 0 && p == 0 && _host.UseSubMenusSingleFrame && item.Parent!.Parent is { }) - { - AddRune (Glyphs.LeftArrow); - } - - // This `- 3` is left border + right border + one row in from right - else if (p == Frame.Width - 3 && _barItems?.SubMenu (_barItems.Children [i]!) is { }) - { - AddRune (Glyphs.RightArrow); - } - else - { - AddRune ((Rune)' '); - } - } - - if (item is null) - { - if (BorderStyle != LineStyle.None && SuperView?.Frame.Right - Frame.X > Frame.Width) - { - Move (Frame.Width - 2, i); - AddRune (Glyphs.RightTee); - } - - continue; - } - - string? textToDraw; - Rune nullCheckedChar = Glyphs.CheckStateNone; - Rune checkChar = Glyphs.Selected; - Rune uncheckedChar = Glyphs.UnSelected; - - if (item.CheckType.HasFlag (MenuItemCheckStyle.Checked)) - { - checkChar = Glyphs.CheckStateChecked; - uncheckedChar = Glyphs.CheckStateUnChecked; - } - - // Support Checked even though CheckType wasn't set - if (item is { CheckType: MenuItemCheckStyle.Checked, Checked: null }) - { - textToDraw = $"{nullCheckedChar} {item.Title}"; - } - else if (item.Checked == true) - { - textToDraw = $"{checkChar} {item.Title}"; - } - else if (item.CheckType.HasFlag (MenuItemCheckStyle.Checked) || item.CheckType.HasFlag (MenuItemCheckStyle.Radio)) - { - textToDraw = $"{uncheckedChar} {item.Title}"; - } - else - { - textToDraw = item.Title; - } - - Point screen = ViewportToScreen (new Point (0, i)); - - if (screen.X < Application.Screen.Width) - { - Move (1, i); - - if (!item.IsEnabled ()) - { - DrawHotString (textToDraw, GetAttributeForRole (VisualRole.Disabled), GetAttributeForRole (VisualRole.Disabled)); - } - else if (i == 0 && _host.UseSubMenusSingleFrame && item.Parent!.Parent is { }) - { - var tf = new TextFormatter - { - ConstrainToWidth = Frame.Width - 3, - ConstrainToHeight = 1, - Alignment = Alignment.Center, HotKeySpecifier = MenuBar.HotKeySpecifier, Text = textToDraw - }; - - // The -3 is left/right border + one space (not sure what for) - tf.Draw ( - ViewportToScreen (new Rectangle (1, i, Frame.Width - 3, 1)), - i == _currentChild ? GetAttributeForRole (VisualRole.Focus) : GetAttributeForRole (VisualRole.Normal), - i == _currentChild ? GetAttributeForRole (VisualRole.HotFocus) : GetAttributeForRole (VisualRole.HotNormal), - SuperView?.ViewportToScreen (SuperView.Viewport) ?? Rectangle.Empty - ); - } - else - { - DrawHotString ( - textToDraw, - i == _currentChild ? GetAttributeForRole (VisualRole.HotFocus) : GetAttributeForRole (VisualRole.HotNormal), - i == _currentChild ? GetAttributeForRole (VisualRole.Focus) : GetAttributeForRole (VisualRole.Normal) - ); - } - - // The help string - int l = item.ShortcutTag.GetColumns () == 0 - ? item.Help.GetColumns () - : item.Help.GetColumns () + item.ShortcutTag.GetColumns () + 2; - int col = Frame.Width - l - 3; - screen = ViewportToScreen (new Point (col, i)); - - if (screen.X < Application.Screen.Width) - { - Move (col, i); - AddStr (item.Help); - - // The shortcut tag string - if (!string.IsNullOrEmpty (item.ShortcutTag)) - { - Move (col + l - item.ShortcutTag.GetColumns (), i); - AddStr (item.ShortcutTag); - } - } - } - } - - SetClip (savedClip); - } -} diff --git a/Terminal.Gui/Views/Menuv1/MenuBar.cs b/Terminal.Gui/Views/Menuv1/MenuBar.cs deleted file mode 100644 index d2ab03dc5..000000000 --- a/Terminal.Gui/Views/Menuv1/MenuBar.cs +++ /dev/null @@ -1,1855 +0,0 @@ -#nullable enable - - -namespace Terminal.Gui.Views; - -/// -/// Provides a menu bar that spans the top of a View with drop-down and cascading menus. -/// -/// By default, any sub-sub-menus (sub-menus of the s added to s) -/// are displayed in a cascading manner, where each sub-sub-menu pops out of the sub-menu frame (either to the -/// right or left, depending on where the sub-menu is relative to the edge of the screen). By setting -/// to , this behavior can be changed such that all -/// sub-sub-menus are drawn within a single frame below the MenuBar. -/// -/// -/// -/// -/// The appears on the first row of the SuperView and uses the full -/// width. -/// -/// The provides global hot keys for the application. See . -/// -/// When the menu is created key bindings for each menu item and its sub-menu items are added for each menu -/// item's hot key (both alone AND with AltMask) and shortcut, if defined. -/// -/// -/// If a key press matches any of the menu item's hot keys or shortcuts, the menu item's action is invoked or -/// sub-menu opened. -/// -/// -/// * If the menu bar is not open * Any shortcut defined within the menu will be invoked * Only hot keys defined -/// for the menu bar items will be invoked, and only if Alt is pressed too. * If the menu bar is open * Un-shifted -/// hot keys defined for the menu bar items will be invoked, only if the menu they belong to is open (the menu bar -/// item's text is visible). * Alt-shifted hot keys defined for the menu bar items will be invoked, only if the -/// menu they belong to is open (the menu bar item's text is visible). * If there is a visible hot key that -/// duplicates a shortcut (e.g. _File and Alt-F), the hot key wins. -/// -/// -[Obsolete ("Use MenuBarv2 instead.", false)] -public class MenuBar : View, IDesignable -{ - // Spaces before the Title - private static readonly int _leftPadding = 1; - - // Spaces after the submenu Title, before Help - private static readonly int _parensAroundHelp = 3; - - // Spaces after the Title - private static readonly int _rightPadding = 1; - - // The column where the MenuBar starts - private static readonly int _xOrigin = 0; - internal bool _isMenuClosing; - internal bool _isMenuOpening; - - internal Menu? _openMenu; - internal List? _openSubMenu; - internal int _selected; - internal int _selectedSub; - - private bool _initialCanFocus; - private bool _isCleaning; - private View? _lastFocused; - private Menu? _ocm; - private View? _previousFocused; - private bool _reopen; - private bool _useSubMenusSingleFrame; - - /// Initializes a new instance of the . - public MenuBar () - { - TabStop = TabBehavior.NoStop; - X = 0; - Y = 0; - Width = Dim.Fill (); - Height = 1; // BUGBUG: Views should avoid setting Height as doing so implies Frame.Size == GetContentSize (). - Menus = []; - - //CanFocus = true; - _selected = -1; - _selectedSub = -1; - SchemeName = SchemeManager.SchemesToSchemeName (Schemes.Menu); - WantMousePositionReports = true; - IsMenuOpen = false; - - SuperViewChanged += MenuBar_SuperViewChanged; - - // Things this view knows how to do - AddCommand ( - Command.Left, - () => - { - MoveLeft (); - - return true; - } - ); - - AddCommand ( - Command.Right, - () => - { - MoveRight (); - - return true; - } - ); - - AddCommand ( - Command.Cancel, - () => - { - if (IsMenuOpen) - { - CloseMenuBar (); - - return true; - } - - return false; - } - ); - - AddCommand ( - Command.Accept, - (ctx) => - { - if (Menus.Length > 0) - { - ProcessMenu (_selected, Menus [_selected]); - } - - return RaiseAccepting (ctx); - } - ); - AddCommand (Command.Toggle, ctx => - { - CloseOtherOpenedMenuBar (); - - if (ctx is not CommandContext keyCommandContext) - { - return false; - } - return Select (Menus.IndexOf (keyCommandContext.Binding.Data)); - }); - AddCommand (Command.Select, ctx => - { - if (ctx is not CommandContext keyCommandContext) - { - return false; - } - if (keyCommandContext.Binding.Data is MouseEventArgs) - { - // HACK: Work around the fact that View.MouseClick always invokes Select - return false; - } - var res = Run ((keyCommandContext.Binding.Data as MenuItem)?.Action!); - CloseAllMenus (); - - return res; - }); - - // Default key bindings for this view - KeyBindings.Add (Key.CursorLeft, Command.Left); - KeyBindings.Add (Key.CursorRight, Command.Right); - KeyBindings.Add (Key.Esc, Command.Cancel); - KeyBindings.Add (Key.CursorDown, Command.Accept); - - KeyBinding keyBinding = new ([Command.Toggle], this, data: -1); // -1 indicates Key was used - HotKeyBindings.Add (Key, keyBinding); - - // TODO: Why do we have two keybindings for opening the menu? Ctrl-Space and Key? - HotKeyBindings.Add (Key.Space.WithCtrl, keyBinding); - // This is needed for macOS because Key.Space.WithCtrl doesn't work - HotKeyBindings.Add (Key.Space.WithAlt, keyBinding); - - // TODO: Figure out how to make Alt work (on Windows) - //KeyBindings.Add (Key.WithAlt, keyBinding); - } - - /// if the menu is open; otherwise . - public bool IsMenuOpen { get; protected set; } - - /// Gets the view that was last focused before opening the menu. - public View? LastFocused { get; private set; } - - /// - /// Gets or sets the array of s for the menu. Only set this after the - /// is visible. - /// - /// The menu array. - public MenuBarItem [] Menus - { - get => _menus; - set - { - _menus = value; - - if (Menus is []) - { - return; - } - - // TODO: Hotkeys should not work for sub-menus if they are not visible! - for (var i = 0; i < Menus.Length; i++) - { - MenuBarItem menuBarItem = Menus [i]; - - if (menuBarItem.HotKey != Key.Empty) - { - HotKeyBindings.Remove (menuBarItem.HotKey!); - KeyBinding keyBinding = new ([Command.Toggle], this, menuBarItem); - HotKeyBindings.Add (menuBarItem.HotKey!, keyBinding); - HotKeyBindings.Remove (menuBarItem.HotKey!.WithAlt); - keyBinding = new ([Command.Toggle], this, data: menuBarItem); - HotKeyBindings.Add (menuBarItem.HotKey.WithAlt, keyBinding); - } - - if (menuBarItem.ShortcutKey != Key.Empty) - { - // Technically this will never run because MenuBarItems don't have shortcuts - // unless the IsTopLevel is true - HotKeyBindings.Remove (menuBarItem.ShortcutKey!); - KeyBinding keyBinding = new ([Command.Select], this, data: menuBarItem); - HotKeyBindings.Add (menuBarItem.ShortcutKey!, keyBinding); - } - - menuBarItem.AddShortcutKeyBindings (this); - } - } - } - - /// - /// The default for 's border. The default is - /// . - /// - public LineStyle MenusBorderStyle { get; set; } = LineStyle.Single; - - /// - /// Gets or sets if the sub-menus must be displayed in a single or multiple frames. - /// - /// By default, any sub-sub-menus (sub-menus of the main s) are displayed in a cascading - /// manner, where each sub-sub-menu pops out of the sub-menu frame (either to the right or left, depending on where - /// the sub-menu is relative to the edge of the screen). By setting to - /// , this behavior can be changed such that all sub-sub-menus are drawn within a single - /// frame below the MenuBar. - /// - /// - public bool UseSubMenusSingleFrame - { - get => _useSubMenusSingleFrame; - set - { - _useSubMenusSingleFrame = value; - - if (value && UseKeysUpDownAsKeysLeftRight) - { - _useKeysUpDownAsKeysLeftRight = false; - SetNeedsDraw (); - } - } - } - - /// - public override bool Visible - { - get => base.Visible; - set - { - base.Visible = value; - - if (!value) - { - CloseAllMenus (); - } - } - } - - internal Menu? OpenCurrentMenu - { - get => _ocm; - set - { - if (_ocm != value) - { - _ocm = value!; - - if (_ocm is { _currentChild: > -1 }) - { - OnMenuOpened (); - } - } - } - } - - /// Closes the Menu programmatically if open and not canceled (as though F9 were pressed). - public bool CloseMenu (bool ignoreUseSubMenusSingleFrame = false) { return CloseMenu (false, false, ignoreUseSubMenusSingleFrame); } - - /// Raised when all the menu is closed. - public event EventHandler? MenuAllClosed; - - /// Raised when a menu is closing passing . - public event EventHandler? MenuClosing; - - /// Raised when a menu is opened. - public event EventHandler? MenuOpened; - - /// Raised as a menu is opening. - public event EventHandler? MenuOpening; - - /// - protected override bool OnDrawingContent () - { - var pos = 0; - - for (var i = 0; i < Menus.Length; i++) - { - MenuBarItem menu = Menus [i]; - Move (pos, 0); - Attribute hotColor, normalColor; - - if (i == _selected && IsMenuOpen) - { - hotColor = i == _selected ? GetAttributeForRole (VisualRole.HotFocus) : GetAttributeForRole (VisualRole.HotNormal); - normalColor = i == _selected ? GetAttributeForRole (VisualRole.Focus) : GetAttributeForRole (VisualRole.Normal); - } - else - { - hotColor = GetAttributeForRole (VisualRole.HotNormal); - normalColor = GetAttributeForRole (VisualRole.Normal); - } - - // Note Help on MenuBar is drawn with parens around it - DrawHotString ( - string.IsNullOrEmpty (menu.Help) ? $" {menu.Title} " : $" {menu.Title} ({menu.Help}) ", - hotColor, - normalColor - ); - - pos += _leftPadding - + menu.TitleLength - + (menu.Help.GetColumns () > 0 - ? _leftPadding + menu.Help.GetColumns () + _parensAroundHelp - : 0) - + _rightPadding; - } - - //PositionCursor (); - return true; - } - - /// Virtual method that will invoke the . - public virtual void OnMenuAllClosed () { MenuAllClosed?.Invoke (this, EventArgs.Empty); } - - /// Virtual method that will invoke the . - /// The current menu to be closed. - /// Whether the current menu will be reopened. - /// Whether is a sub-menu or not. - public virtual MenuClosingEventArgs OnMenuClosing (MenuBarItem currentMenu, bool reopen, bool isSubMenu) - { - var ev = new MenuClosingEventArgs (currentMenu, reopen, isSubMenu); - MenuClosing?.Invoke (this, ev); - - return ev; - } - - /// Virtual method that will invoke the event if it's defined. - public virtual void OnMenuOpened () - { - MenuItem? mi = null; - MenuBarItem? parent; - - if (OpenCurrentMenu?.BarItems?.Children is { Length: > 0 } - && OpenCurrentMenu?._currentChild > -1) - { - parent = OpenCurrentMenu.BarItems; - mi = parent.Children [OpenCurrentMenu._currentChild]; - } - else if (OpenCurrentMenu!.BarItems!.IsTopLevel) - { - parent = null; - mi = OpenCurrentMenu.BarItems; - } - else - { - parent = _openMenu?.BarItems; - - if (OpenCurrentMenu?._currentChild > -1) - { - mi = parent?.Children?.Length > 0 ? parent.Children [_openMenu!._currentChild] : null; - } - } - - MenuOpened?.Invoke (this, new (parent, mi)); - } - - /// Virtual method that will invoke the event if it's defined. - /// The current menu to be replaced. - /// Returns the - public virtual MenuOpeningEventArgs OnMenuOpening (MenuBarItem currentMenu) - { - var ev = new MenuOpeningEventArgs (currentMenu); - MenuOpening?.Invoke (this, ev); - - return ev; - } - - /// Opens the Menu programatically, as though the F9 key were pressed. - public void OpenMenu () - { - MenuBar? mbar = GetMouseGrabViewInstance (this); - - mbar?.CleanUp (); - - CloseOtherOpenedMenuBar (); - - if (!Enabled || _openMenu is { }) - { - return; - } - - _selected = 0; - SetNeedsDraw (); - - _previousFocused = (SuperView is null ? Application.Top?.Focused : SuperView.Focused)!; - OpenMenu (_selected); - - if (!SelectEnabledItem ( - OpenCurrentMenu?.BarItems?.Children, - OpenCurrentMenu!._currentChild, - out OpenCurrentMenu._currentChild - ) - && !CloseMenu ()) - { - return; - } - - if (!OpenCurrentMenu.CheckSubMenu ()) - { - return; - } - - if (_isContextMenuLoading) - { - Application.Mouse.GrabMouse (_openMenu); - _isContextMenuLoading = false; - } - else - { - Application.Mouse.GrabMouse (this); - } - } - - /// - public override Point? PositionCursor () - { - if (_selected == -1 && HasFocus && Menus.Length > 0) - { - _selected = 0; - } - - var pos = 0; - - for (var i = 0; i < Menus.Length; i++) - { - if (i == _selected) - { - pos++; - Move (pos + 1, 0); - - return null; // Don't show the cursor - } - - pos += _leftPadding - + Menus [i].TitleLength - + (Menus [i].Help.GetColumns () > 0 - ? Menus [i].Help.GetColumns () + _parensAroundHelp - : 0) - + _rightPadding; - } - - return null; // Don't show the cursor - } - - // Activates the menu, handles either first focus, or activating an entry when it was already active - // For mouse events. - internal void Activate (int idx, int sIdx = -1, MenuBarItem? subMenu = null!) - { - _selected = idx; - _selectedSub = sIdx; - - if (_openMenu is null) - { - _previousFocused = (SuperView is null ? Application.Top?.Focused ?? null : SuperView.Focused)!; - } - - OpenMenu (idx, sIdx, subMenu); - SetNeedsDraw (); - } - - internal void CleanUp () - { - if (_isCleaning) - { - return; - } - - _isCleaning = true; - - if (_openMenu is { }) - { - CloseAllMenus (); - } - - _openedByAltKey = false; - IsMenuOpen = false; - _selected = -1; - CanFocus = _initialCanFocus; - - if (_lastFocused is { }) - { - _lastFocused.SetFocus (); - } - - SetNeedsDraw (); - - if (Application.Mouse.MouseGrabView is { } && Application.Mouse.MouseGrabView is MenuBar && Application.Mouse.MouseGrabView != this) - { - var menuBar = Application.Mouse.MouseGrabView as MenuBar; - - if (menuBar!.IsMenuOpen) - { - menuBar.CleanUp (); - } - } - Application.Mouse.UngrabMouse (); - _isCleaning = false; - } - - internal void CloseAllMenus () - { - if (!_isMenuOpening && !_isMenuClosing) - { - if (_openSubMenu is { } && !CloseMenu (false, true, true)) - { - return; - } - - if (!CloseMenu ()) - { - return; - } - - if (LastFocused is { } && LastFocused != this) - { - _selected = -1; - } - - Application.Mouse.UngrabMouse (); - } - - if (OpenCurrentMenu is { }) - { - OpenCurrentMenu = null; - } - - IsMenuOpen = false; - _openedByAltKey = false; - OnMenuAllClosed (); - - CloseOtherOpenedMenuBar (); - } - - private void CloseOtherOpenedMenuBar () - { - if (SuperView is { }) - { - // Close others menu bar opened - Menu? menu = SuperView.SubViews.FirstOrDefault (v => v is Menu m && m.Host != this && m.Host.IsMenuOpen) as Menu; - menu?.Host.CleanUp (); - } - } - - internal bool CloseMenu (bool reopen, bool isSubMenu, bool ignoreUseSubMenusSingleFrame = false) - { - MenuBarItem? mbi = isSubMenu ? OpenCurrentMenu!.BarItems : _openMenu?.BarItems; - - if (UseSubMenusSingleFrame && mbi is { } && !ignoreUseSubMenusSingleFrame && mbi.Parent is { }) - { - return false; - } - - _isMenuClosing = true; - _reopen = reopen; - MenuClosingEventArgs args = OnMenuClosing (mbi!, reopen, isSubMenu); - - if (args.Cancel) - { - _isMenuClosing = false; - - if (args.CurrentMenu.Parent is { } && _openMenu is { }) - { - _openMenu._currentChild = - ((MenuBarItem)args.CurrentMenu.Parent).Children.IndexOf (args.CurrentMenu); - } - - return false; - } - - switch (isSubMenu) - { - case false: - if (_openMenu is { }) - { - SuperView?.Remove (_openMenu); - } - - SetNeedsDraw (); - - if (_previousFocused is Menu && _openMenu is { } && _previousFocused.ToString () != OpenCurrentMenu!.ToString ()) - { - _previousFocused.SetFocus (); - } - - if (Application.Mouse.MouseGrabView == _openMenu) - { - Application.Mouse.UngrabMouse (); - } - _openMenu?.Dispose (); - _openMenu = null; - - if (_lastFocused is Menu or MenuBar) - { - _lastFocused = null; - } - - LastFocused = _lastFocused; - _lastFocused = null; - - if (LastFocused is { CanFocus: true }) - { - if (!reopen) - { - _selected = -1; - } - - if (_openSubMenu is { }) - { - _openSubMenu = null; - } - - if (OpenCurrentMenu is { }) - { - SuperView?.Remove (OpenCurrentMenu); - if (Application.Mouse.MouseGrabView == OpenCurrentMenu) - { - Application.Mouse.UngrabMouse (); - } - OpenCurrentMenu.Dispose (); - OpenCurrentMenu = null; - } - - LastFocused.SetFocus (); - } - else if (_openSubMenu is null || _openSubMenu.Count == 0) - { - CloseAllMenus (); - } - else - { - SetFocus (); - } - - IsMenuOpen = false; - - break; - - case true: - _selectedSub = -1; - SetNeedsDraw (); - RemoveAllOpensSubMenus (); - OpenCurrentMenu!._previousSubFocused!.SetFocus (); - _openSubMenu = null; - IsMenuOpen = true; - - break; - } - - _reopen = false; - _isMenuClosing = false; - - return true; - } - - /// Gets the superview location offset relative to the location. - /// The location offset. - internal Point GetScreenOffset () - { - // ReSharper disable once ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract - if (Application.Screen.Height == 0) - { - return Point.Empty; - } - - Rectangle superViewFrame = SuperView?.Frame ?? Application.Screen; - View? sv = SuperView ?? Application.Top; - - if (sv is null) - { - // Support Unit Tests - return Point.Empty; - } - - Point viewportOffset = sv.GetViewportOffsetFromFrame (); - - return new ( - superViewFrame.X - sv.Frame.X - viewportOffset.X, - superViewFrame.Y - sv.Frame.Y - viewportOffset.Y - ); - } - - internal void NextMenu (bool isSubMenu = false, bool ignoreUseSubMenusSingleFrame = false) - { - switch (isSubMenu) - { - case false: - if (_selected == -1) - { - _selected = 0; - } - else if (_selected + 1 == Menus.Length) - { - _selected = 0; - } - else - { - _selected++; - } - - if (_selected > -1 && !CloseMenu (true, ignoreUseSubMenusSingleFrame)) - { - return; - } - - if (_selected == -1) - { - return; - } - - OpenMenu (_selected); - - SelectEnabledItem ( - OpenCurrentMenu?.BarItems?.Children, - OpenCurrentMenu!._currentChild, - out OpenCurrentMenu._currentChild - ); - - break; - case true: - if (UseKeysUpDownAsKeysLeftRight) - { - if (CloseMenu (false, true, ignoreUseSubMenusSingleFrame)) - { - NextMenu (false, ignoreUseSubMenusSingleFrame); - } - } - else - { - MenuBarItem? subMenu = OpenCurrentMenu!._currentChild > -1 && OpenCurrentMenu.BarItems?.Children!.Length > 0 - ? OpenCurrentMenu.BarItems.SubMenu ( - OpenCurrentMenu.BarItems.Children? [OpenCurrentMenu._currentChild]! - ) - : null; - - if ((_selectedSub == -1 || _openSubMenu is null || _openSubMenu?.Count - 1 == _selectedSub) && subMenu is null) - { - if (_openSubMenu is { } && !CloseMenu (false, true)) - { - return; - } - - NextMenu (false, ignoreUseSubMenusSingleFrame); - } - else if (subMenu != null - || (OpenCurrentMenu._currentChild > -1 - && !OpenCurrentMenu.BarItems! - .Children! [OpenCurrentMenu._currentChild]! - .IsFromSubMenu)) - { - _selectedSub++; - OpenCurrentMenu.CheckSubMenu (); - } - else - { - if (CloseMenu (false, true, ignoreUseSubMenusSingleFrame)) - { - NextMenu (false, ignoreUseSubMenusSingleFrame); - } - - return; - } - - SetNeedsDraw (); - - if (UseKeysUpDownAsKeysLeftRight) - { - OpenCurrentMenu.CheckSubMenu (); - } - } - - break; - } - } - - internal void OpenMenu (int index, int sIndex = -1, MenuBarItem? subMenu = null!) - { - _isMenuOpening = true; - MenuOpeningEventArgs newMenu = OnMenuOpening (Menus [index]); - - if (newMenu.Cancel) - { - _isMenuOpening = false; - - return; - } - - if (newMenu.NewMenuBarItem is { }) - { - Menus [index] = newMenu.NewMenuBarItem; - } - - var pos = 0; - - switch (subMenu) - { - case null: - // Open a submenu below a MenuBar - _lastFocused ??= SuperView is null ? Application.Top?.MostFocused : SuperView.MostFocused; - - if (_openSubMenu is { } && !CloseMenu (false, true)) - { - return; - } - - if (_openMenu is { }) - { - SuperView?.Remove (_openMenu); - if (Application.Mouse.MouseGrabView == _openMenu) - { - Application.Mouse.UngrabMouse (); - } - _openMenu.Dispose (); - _openMenu = null; - } - - // This positions the submenu horizontally aligned with the first character of the - // text belonging to the menu - for (var i = 0; i < index; i++) - { - pos += Menus [i].TitleLength + (Menus [i].Help.GetColumns () > 0 ? Menus [i].Help.GetColumns () + 2 : 0) + _leftPadding + _rightPadding; - } - - - - - _openMenu = new () - { - Host = this, - X = Frame.X + pos, - Y = Frame.Y + 1, - BarItems = Menus [index], - Parent = null - }; - OpenCurrentMenu = _openMenu; - OpenCurrentMenu._previousSubFocused = _openMenu; - - if (SuperView is { }) - { - SuperView.Add (_openMenu); - // _openMenu.SetRelativeLayout (Application.Screen.Size); - } - else - { - _openMenu.BeginInit (); - _openMenu.EndInit (); - } - - _openMenu.SetFocus (); - - break; - default: - // Opens a submenu next to another submenu (openSubMenu) - if (_openSubMenu is null) - { - _openSubMenu = new (); - } - - if (sIndex > -1) - { - RemoveSubMenu (sIndex); - } - else - { - Menu? last = _openSubMenu.Count > 0 ? _openSubMenu.Last () : _openMenu; - - if (!UseSubMenusSingleFrame) - { - OpenCurrentMenu = new () - { - Host = this, - X = last!.Frame.Left + last.Frame.Width, - Y = last.Frame.Top + last._currentChild + 1, - BarItems = subMenu, - Parent = last - }; - } - else - { - Menu? first = _openSubMenu.Count > 0 ? _openSubMenu.First () : _openMenu; - - // 2 is for the parent and the separator - MenuItem? [] mbi = new MenuItem [2 + subMenu.Children!.Length]; - mbi [0] = new () { Title = subMenu.Title, Parent = subMenu }; - mbi [1] = null; - - for (var j = 0; j < subMenu.Children.Length; j++) - { - mbi [j + 2] = subMenu.Children [j]; - } - - var newSubMenu = new MenuBarItem (mbi!) { Parent = subMenu }; - - OpenCurrentMenu = new () - { - Host = this, X = first!.Frame.Left, Y = first.Frame.Top, BarItems = newSubMenu - }; - last!.Visible = false; - Application.Mouse.GrabMouse (OpenCurrentMenu); - } - - OpenCurrentMenu._previousSubFocused = last._previousSubFocused; - _openSubMenu.Add (OpenCurrentMenu); - SuperView?.Add (OpenCurrentMenu); - - if (!OpenCurrentMenu.IsInitialized) - { - // Supports unit tests - OpenCurrentMenu.BeginInit (); - OpenCurrentMenu.EndInit (); - } - } - - _selectedSub = _openSubMenu.Count - 1; - - if (_selectedSub > -1 - && SelectEnabledItem ( - OpenCurrentMenu!.BarItems!.Children, - OpenCurrentMenu._currentChild, - out OpenCurrentMenu._currentChild - )) - { - OpenCurrentMenu.SetFocus (); - } - - break; - } - - _isMenuOpening = false; - IsMenuOpen = true; - } - - internal void PreviousMenu (bool isSubMenu = false, bool ignoreUseSubMenusSingleFrame = false) - { - switch (isSubMenu) - { - case false: - if (_selected <= 0) - { - _selected = Menus.Length - 1; - } - else - { - _selected--; - } - - if (_selected > -1 && !CloseMenu (true, false, ignoreUseSubMenusSingleFrame)) - { - return; - } - - if (_selected == -1) - { - return; - } - - OpenMenu (_selected); - - if (!SelectEnabledItem ( - OpenCurrentMenu?.BarItems?.Children, - OpenCurrentMenu!._currentChild, - out OpenCurrentMenu._currentChild, - false - )) - { - OpenCurrentMenu._currentChild = 0; - } - - break; - case true: - if (_selectedSub > -1) - { - _selectedSub--; - RemoveSubMenu (_selectedSub, ignoreUseSubMenusSingleFrame); - SetNeedsDraw (); - } - else - { - PreviousMenu (); - } - - break; - } - } - - internal void RemoveAllOpensSubMenus () - { - if (_openSubMenu is { }) - { - foreach (Menu item in _openSubMenu) - { - SuperView?.Remove (item); - if (Application.Mouse.MouseGrabView == item) - { - Application.Mouse.UngrabMouse (); - } - item.Dispose (); - } - } - } - - internal bool Run (Action? action) - { - if (action is null) - { - return false; - } - - Application.AddTimeout (TimeSpan.Zero, - () => - { - action (); - - return false; - } - ); - - return true; - } - - internal bool SelectEnabledItem ( - MenuItem? []? children, - int current, - out int newCurrent, - bool forward = true - ) - { - if (children is null) - { - newCurrent = -1; - - return true; - } - - IEnumerable childMenuItems = forward ? children : children.Reverse (); - - int count; - - IEnumerable menuItems = childMenuItems as MenuItem [] ?? childMenuItems.ToArray (); - - if (forward) - { - count = -1; - } - else - { - count = menuItems.Count (); - } - - foreach (MenuItem? child in menuItems) - { - if (forward) - { - if (++count < current) - { - continue; - } - } - else - { - if (--count > current) - { - continue; - } - } - - // ReSharper disable once ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract - if (child is null || !child.IsEnabled ()) - { - if (forward) - { - current++; - } - else - { - current--; - } - } - else - { - newCurrent = current; - - return true; - } - } - - newCurrent = -1; - - return false; - } - - /// Called when an item is selected; Runs the action. - /// - internal bool SelectItem (MenuItem? item) - { - if (item?.Action is null) - { - return false; - } - - Application.Mouse.UngrabMouse (); - CloseAllMenus (); - Application.LayoutAndDraw (true); - _openedByAltKey = true; - - return Run (item.Action); - } - - private void CloseMenuBar () - { - if (!CloseMenu ()) - { - return; - } - - if (_openedByAltKey) - { - _openedByAltKey = false; - LastFocused?.SetFocus (); - } - - SetNeedsDraw (); - } - - private Point GetLocationOffset () - { - if (MenusBorderStyle != LineStyle.None) - { - return new (0, 1); - } - - return new (-2, 0); - } - - private void MenuBar_SuperViewChanged (object? sender, SuperViewChangedEventArgs _) - { - _initialCanFocus = CanFocus; - SuperViewChanged -= MenuBar_SuperViewChanged; - } - - private void MoveLeft () - { - _selected--; - - if (_selected < 0) - { - _selected = Menus.Length - 1; - } - - OpenMenu (_selected); - SetNeedsDraw (); - } - - private void MoveRight () - { - _selected = (_selected + 1) % Menus.Length; - OpenMenu (_selected); - SetNeedsDraw (); - } - - private bool ProcessMenu (int i, MenuBarItem mi) - { - if (_selected < 0 && IsMenuOpen) - { - return false; - } - - if (mi.IsTopLevel) - { - Point screen = ViewportToScreen (new Point (0, i)); - var menu = new Menu { Host = this, X = screen.X, Y = screen.Y, BarItems = mi }; - menu.Run (mi.Action); - if (Application.Mouse.MouseGrabView == menu) - { - Application.Mouse.UngrabMouse (); - } - menu.Dispose (); - } - else - { - Application.Mouse.GrabMouse (this); - _selected = i; - OpenMenu (i); - - if (!SelectEnabledItem ( - OpenCurrentMenu?.BarItems?.Children, - OpenCurrentMenu!._currentChild, - out OpenCurrentMenu._currentChild - ) - && !CloseMenu ()) - { - return true; - } - - if (!OpenCurrentMenu.CheckSubMenu ()) - { - return true; - } - } - - SetNeedsDraw (); - - return true; - } - - private void RemoveSubMenu (int index, bool ignoreUseSubMenusSingleFrame = false) - { - if (_openSubMenu == null - || (UseSubMenusSingleFrame - && !ignoreUseSubMenusSingleFrame - && _openSubMenu.Count == 0)) - { - return; - } - - for (int i = _openSubMenu.Count - 1; i > index; i--) - { - _isMenuClosing = true; - Menu? menu; - - if (_openSubMenu!.Count - 1 > 0) - { - menu = _openSubMenu [i - 1]; - } - else - { - menu = _openMenu; - } - - if (!menu!.Visible) - { - menu.Visible = true; - } - - OpenCurrentMenu = menu; - OpenCurrentMenu.SetFocus (); - - if (_openSubMenu is { }) - { - menu = _openSubMenu [i]; - SuperView!.Remove (menu); - _openSubMenu.Remove (menu); - - if (Application.Mouse.MouseGrabView == menu) - { - Application.Mouse.GrabMouse (this); - } - - menu.Dispose (); - } - - RemoveSubMenu (i, ignoreUseSubMenusSingleFrame); - } - - if (_openSubMenu!.Count > 0) - { - OpenCurrentMenu = _openSubMenu.Last (); - } - - _isMenuClosing = false; - } - - #region Keyboard handling - - private Key _key = Key.F9; - - /// - /// The used to activate or close the menu bar by keyboard. The default is - /// . - /// - /// - /// - /// If the user presses any s defined in the s, the menu - /// bar will be activated and the sub-menu will be opened. - /// - /// will close the menu bar and any open sub-menus. - /// - public Key Key - { - get => _key; - set - { - if (_key == value) - { - return; - } - - HotKeyBindings.Remove (_key); - KeyBinding keyBinding = new ([Command.Toggle], this, data: -1); // -1 indicates Key was used - HotKeyBindings.Add (value, keyBinding); - _key = value; - } - } - - private bool _useKeysUpDownAsKeysLeftRight; - - /// Used for change the navigation key style. - public bool UseKeysUpDownAsKeysLeftRight - { - get => _useKeysUpDownAsKeysLeftRight; - set - { - _useKeysUpDownAsKeysLeftRight = value; - - if (value && UseSubMenusSingleFrame) - { - UseSubMenusSingleFrame = false; - SetNeedsDraw (); - } - } - } - - /// The specifier character for the hot keys. - public new static Rune HotKeySpecifier => (Rune)'_'; - - // TODO: This doesn't actually work. Figure out why. - private bool _openedByAltKey; - - /// - /// Called when a key bound to Command.Select is pressed. Either activates the menu item or runs it, depending on - /// whether it has a sub-menu. If the menu is open, it will close the menu bar. - /// - /// The index of the menu bar item to select. -1 if the selection was via . - /// - private bool Select (int index) - { - if (!IsInitialized || !Visible) - { - return true; - } - - // If the menubar is open and the menu that's open is 'index' then close it. Otherwise activate it. - if (IsMenuOpen) - { - if (index == -1) - { - CloseAllMenus (); - - return true; - } - - // Find the index of the open submenu and close the menu if it matches - for (var i = 0; i < Menus.Length; i++) - { - MenuBarItem open = Menus [i]; - - if (open == OpenCurrentMenu!.BarItems && i == index) - { - CloseAllMenus (); - return true; - } - } - } - - if (index == -1) - { - OpenMenu (); - } - else if (Menus [index].IsTopLevel) - { - Run (Menus [index].Action); - } - else - { - Activate (index); - } - - return true; - } - - #endregion Keyboard handling - - #region Mouse Handling - - internal void LostFocus (View view) - { - if (view is not MenuBar && view is not Menu && !_isCleaning && !_reopen) - { - CleanUp (); - } - } - - /// - protected override bool OnMouseEvent (MouseEventArgs me) - { - if (!_handled && !HandleGrabView (me, this)) - { - return false; - } - - _handled = false; - - if (me.Flags == MouseFlags.Button1Pressed - || me.Flags == MouseFlags.Button1DoubleClicked - || me.Flags == MouseFlags.Button1TripleClicked - || me.Flags == MouseFlags.Button1Clicked - || (me.Flags == MouseFlags.ReportMousePosition && _selected > -1) - || (me.Flags.HasFlag (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition) && _selected > -1)) - { - int pos = _xOrigin; - Point locationOffset = default; - - if (SuperView is { }) - { - locationOffset.X += SuperView.Border!.Thickness.Left; - locationOffset.Y += SuperView.Border!.Thickness.Top; - } - - int cx = me.Position.X - locationOffset.X; - - for (var i = 0; i < Menus.Length; i++) - { - if (cx >= pos && cx < pos + _leftPadding + Menus [i].TitleLength + Menus [i].Help.GetColumns () + _rightPadding) - { - if (me.Flags == MouseFlags.Button1Clicked) - { - if (Menus [i].IsTopLevel) - { - Point screen = ViewportToScreen (new Point (0, i)); - var menu = new Menu { Host = this, X = screen.X, Y = screen.Y, BarItems = Menus [i] }; - menu.Run (Menus [i].Action); - if (Application.Mouse.MouseGrabView == menu) - { - Application.Mouse.UngrabMouse (); - } - - menu.Dispose (); - } - else if (!IsMenuOpen) - { - Activate (i); - } - } - else if (me.Flags.HasFlag (MouseFlags.Button1Pressed) - || me.Flags.HasFlag (MouseFlags.Button1DoubleClicked) - || me.Flags.HasFlag (MouseFlags.Button1TripleClicked)) - { - if (IsMenuOpen && !Menus [i].IsTopLevel) - { - CloseAllMenus (); - } - else if (!Menus [i].IsTopLevel) - { - Activate (i); - } - } - else if (_selected != i - && _selected > -1 - && (me.Flags == MouseFlags.ReportMousePosition - || (me.Flags is MouseFlags.Button1Pressed && me.Flags == MouseFlags.ReportMousePosition))) - { - if (IsMenuOpen) - { - if (!CloseMenu (true, false)) - { - return me.Handled = true; - } - - Activate (i); - } - } - else if (IsMenuOpen) - { - if (!UseSubMenusSingleFrame - || (UseSubMenusSingleFrame - && OpenCurrentMenu is { BarItems.Parent: { } } - && OpenCurrentMenu.BarItems.Parent.Parent != Menus [i])) - { - Activate (i); - } - } - - return me.Handled = true; - } - - if (i == Menus.Length - 1 && me.Flags == MouseFlags.Button1Clicked) - { - if (IsMenuOpen && !Menus [i].IsTopLevel) - { - CloseAllMenus (); - - return me.Handled = true; - } - } - - pos += _leftPadding + Menus [i].TitleLength + _rightPadding; - } - } - - return false; - } - - internal bool _handled; - internal bool _isContextMenuLoading; - private MenuBarItem [] _menus = []; - - internal bool HandleGrabView (MouseEventArgs me, View current) - { - if (Application.Mouse.MouseGrabView is { }) - { - if (me.View is MenuBar or Menu) - { - MenuBar? mbar = GetMouseGrabViewInstance (me.View); - - if (mbar is { }) - { - if (me.Flags == MouseFlags.Button1Clicked) - { - mbar.CleanUp (); - Application.Mouse.GrabMouse (me.View); - } - else - { - _handled = false; - - return false; - } - } - - if (Application.Mouse.MouseGrabView != me.View) - { - View v = me.View; - Application.Mouse.GrabMouse (v); - - return true; - } - - if (me.View != current) - { - View v = me.View; - Application.Mouse.GrabMouse (v); - MouseEventArgs nme; - - if (me.Position.Y > -1) - { - Point frameLoc = v.ScreenToFrame (me.Position); - - nme = new () - { - Position = frameLoc, - Flags = me.Flags, - View = v - }; - } - else - { - nme = new () - { - Position = new (me.Position.X + current.Frame.X, me.Position.Y + current.Frame.Y), - Flags = me.Flags, View = v - }; - } - - v.NewMouseEvent (nme); - - return false; - } - } - else if (!(me.View is MenuBar || me.View is Menu) - && me.Flags != MouseFlags.ReportMousePosition - && me.Flags != 0) - { - Application.Mouse.UngrabMouse (); - - if (IsMenuOpen) - { - CloseAllMenus (); - } - - _handled = false; - - return false; - } - else - { - _handled = false; - - return false; - } - } - else if (!IsMenuOpen - && (me.Flags == MouseFlags.Button1Pressed - || me.Flags == MouseFlags.Button1DoubleClicked - || me.Flags == MouseFlags.Button1TripleClicked - || me.Flags.HasFlag ( - MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition - ))) - { - Application.Mouse.GrabMouse (current); - } - else if (IsMenuOpen && (me.View is MenuBar || me.View is Menu)) - { - Application.Mouse.GrabMouse (me.View); - } - else - { - _handled = false; - - return false; - } - - _handled = true; - - return true; - } - - private MenuBar? GetMouseGrabViewInstance (View? view) - { - if (view is null || Application.Mouse.MouseGrabView is null) - { - return null; - } - - MenuBar? hostView = null; - - if (view is MenuBar) - { - hostView = (MenuBar)view; - } - else if (view is Menu) - { - hostView = ((Menu)view).Host; - } - - View grabView = Application.Mouse.MouseGrabView; - MenuBar? hostGrabView = null; - - if (grabView is MenuBar bar) - { - hostGrabView = bar; - } - else if (grabView is Menu menu) - { - hostGrabView = menu.Host; - } - - return hostView != hostGrabView ? hostGrabView : null; - } - - #endregion Mouse Handling - - - /// - public bool EnableForDesign (ref TContext context) where TContext : notnull - { - if (context is not Func actionFn) - { - actionFn = (_) => true; - } - - Menus = - [ - new MenuBarItem ( - "_File", - new MenuItem [] - { - new ( - "_New", - "", - () => actionFn ("New"), - null, - null, - KeyCode.CtrlMask | KeyCode.N - ), - new ( - "_Open", - "", - () => actionFn ("Open"), - null, - null, - KeyCode.CtrlMask | KeyCode.O - ), - new ( - "_Save", - "", - () => actionFn ("Save"), - null, - null, - KeyCode.CtrlMask | KeyCode.S - ), -#pragma warning disable CS8625 // Cannot convert null literal to non-nullable reference type. - null, -#pragma warning restore CS8625 // Cannot convert null literal to non-nullable reference type. - - // Don't use Application.Quit so we can disambiguate between quitting and closing the toplevel - new ( - "_Quit", - "", - () => actionFn ("Quit"), - null, - null, - KeyCode.CtrlMask | KeyCode.Q - ) - } - ), - new MenuBarItem ( - "_Edit", - new MenuItem [] - { - new ( - "_Copy", - "", - () => actionFn ("Copy"), - null, - null, - KeyCode.CtrlMask | KeyCode.C - ), - new ( - "C_ut", - "", - () => actionFn ("Cut"), - null, - null, - KeyCode.CtrlMask | KeyCode.X - ), - new ( - "_Paste", - "", - () => actionFn ("Paste"), - null, - null, - KeyCode.CtrlMask | KeyCode.V - ), - new MenuBarItem ( - "_Find and Replace", - new MenuItem [] - { - new ( - "F_ind", - "", - () => actionFn ("Find"), - null, - null, - KeyCode.CtrlMask | KeyCode.F - ), - new ( - "_Replace", - "", - () => actionFn ("Replace"), - null, - null, - KeyCode.CtrlMask | KeyCode.H - ), - new MenuBarItem ( - "_3rd Level", - new MenuItem [] - { - new ( - "_1st", - "", - () => actionFn ( - "1" - ), - null, - null, - KeyCode.F1 - ), - new ( - "_2nd", - "", - () => actionFn ( - "2" - ), - null, - null, - KeyCode.F2 - ) - } - ), - new MenuBarItem ( - "_4th Level", - new MenuItem [] - { - new ( - "_5th", - "", - () => actionFn ( - "5" - ), - null, - null, - KeyCode.CtrlMask - | KeyCode.D5 - ), - new ( - "_6th", - "", - () => actionFn ( - "6" - ), - null, - null, - KeyCode.CtrlMask - | KeyCode.D6 - ) - } - ) - } - ), - new ( - "_Select All", - "", - () => actionFn ("Select All"), - null, - null, - KeyCode.CtrlMask - | KeyCode.ShiftMask - | KeyCode.S - ) - } - ), - new MenuBarItem ("_About", "Top-Level", () => actionFn ("About")) - ]; - return true; - } -} diff --git a/Terminal.Gui/Views/Menuv1/MenuBarItem.cs b/Terminal.Gui/Views/Menuv1/MenuBarItem.cs deleted file mode 100644 index 8b3be2116..000000000 --- a/Terminal.Gui/Views/Menuv1/MenuBarItem.cs +++ /dev/null @@ -1,266 +0,0 @@ -#nullable enable - - -namespace Terminal.Gui.Views; - -/// -/// is a menu item on . MenuBarItems do not support -/// . -/// -[Obsolete ("Use MenuBarItemv2 instead.", false)] -public class MenuBarItem : MenuItem -{ - /// Initializes a new as a . - /// Title for the menu item. - /// Help text to display. Will be displayed next to the Title surrounded by parentheses. - /// Action to invoke when the menu item is activated. - /// Function to determine if the action can currently be executed. - /// The parent of this if any. - public MenuBarItem ( - string title, - string help, - Action action, - Func? canExecute = null, - MenuItem? parent = null - ) : base (title, help, action, canExecute, parent) - { - SetInitialProperties (title, null, null, true); - } - - /// Initializes a new . - /// Title for the menu item. - /// The items in the current menu. - /// The parent of this if any. - public MenuBarItem (string title, MenuItem [] children, MenuItem? parent = null) { SetInitialProperties (title, children, parent); } - - /// Initializes a new with separate list of items. - /// Title for the menu item. - /// The list of items in the current menu. - /// The parent of this if any. - public MenuBarItem (string title, List children, MenuItem? parent = null) { SetInitialProperties (title, children, parent); } - - /// Initializes a new . - /// The items in the current menu. - public MenuBarItem (MenuItem [] children) : this ("", children) { } - - /// Initializes a new . - public MenuBarItem () : this ([]) { } - - /// - /// Gets or sets an array of objects that are the children of this - /// - /// - /// The children. - public MenuItem? []? Children { get; set; } - - internal bool IsTopLevel => Parent is null && (Children is null || Children.Length == 0) && Action != null; - - /// Get the index of a child . - /// - /// Returns a greater than -1 if the is a child. - public int GetChildrenIndex (MenuItem children) - { - var i = 0; - - if (Children is null) - { - return -1; - } - - foreach (MenuItem? child in Children) - { - if (child == children) - { - return i; - } - - i++; - } - - return -1; - } - - /// Check if a is a submenu of this MenuBar. - /// - /// Returns true if it is a submenu. false otherwise. - public bool IsSubMenuOf (MenuItem menuItem) - { - return Children!.Any (child => child == menuItem && child.Parent == menuItem.Parent); - } - - /// Check if a is a . - /// - /// Returns a or null otherwise. - public MenuBarItem? SubMenu (MenuItem? menuItem) { return menuItem as MenuBarItem; } - - internal void AddShortcutKeyBindings (MenuBar menuBar) - { - if (Children is null) - { - return; - } - - _menuBar = menuBar; - - IEnumerable menuItems = Children.Where (m => m is { })!; - - foreach (MenuItem menuItem in menuItems) - { - // Initialize MenuItem _menuBar - menuItem._menuBar = menuBar; - - // For MenuBar only add shortcuts for submenus - if (menuItem.ShortcutKey != Key.Empty) - { - menuItem.AddShortcutKeyBinding (menuBar, Key.Empty); - } - - SubMenu (menuItem)?.AddShortcutKeyBindings (menuBar); - } - } - - // ReSharper disable once ParameterOnlyUsedForPreconditionCheck.Local - private void SetInitialProperties (string title, object? children, MenuItem? parent = null, bool isTopLevel = false) - { - if (!isTopLevel && children is null) - { - throw new ArgumentNullException ( - nameof (children), - @"The parameter cannot be null. Use an empty array instead." - ); - } - - SetTitle (title); - - if (parent is { }) - { - Parent = parent; - } - - switch (children) - { - case List childrenList: - { - MenuItem [] newChildren = []; - - foreach (MenuItem [] grandChild in childrenList) - { - foreach (MenuItem child in grandChild) - { - SetParent (grandChild); - Array.Resize (ref newChildren, newChildren.Length + 1); - newChildren [^1] = child; - } - } - - Children = newChildren; - - break; - } - case MenuItem [] items: - SetParent (items); - Children = items; - - break; - default: - Children = null; - - break; - } - } - - private void SetParent (MenuItem [] children) - { - foreach (MenuItem child in children) - { - if (child is { Parent: null }) - { - child.Parent = this; - } - } - } - - private void SetTitle (string? title) - { - title ??= string.Empty; - Title = title; - } - - /// - /// Add a dynamically into the .Menus. - /// - /// - /// - public void AddMenuBarItem (MenuBar menuBar, MenuItem? menuItem = null) - { - ArgumentNullException.ThrowIfNull (menuBar); - - _menuBar = menuBar; - - if (menuItem is null) - { - MenuBarItem [] menus = _menuBar.Menus; - Array.Resize (ref menus, menus.Length + 1); - menus [^1] = this; - _menuBar.Menus = menus; - } - else - { - MenuItem [] childrens = (Children ?? [])!; - Array.Resize (ref childrens, childrens.Length + 1); - menuItem._menuBar = menuBar; - childrens [^1] = menuItem; - Children = childrens; - } - } - - /// - public override void RemoveMenuItem () - { - if (Children is { }) - { - foreach (MenuItem? menuItem in Children) - { - if (menuItem?.ShortcutKey != Key.Empty) - { - // Remove an existent ShortcutKey - _menuBar?.HotKeyBindings.Remove (menuItem?.ShortcutKey!); - } - } - } - - if (ShortcutKey != Key.Empty) - { - // Remove an existent ShortcutKey - _menuBar?.HotKeyBindings.Remove (ShortcutKey!); - } - - var index = _menuBar!.Menus.IndexOf (this); - if (index > -1) - { - if (_menuBar.Menus [index].HotKey != Key.Empty) - { - // Remove an existent HotKey - _menuBar.HotKeyBindings.Remove (HotKey!.WithAlt); - } - - _menuBar.Menus [index] = null!; - } - - var i = 0; - - foreach (MenuBarItem m in _menuBar.Menus) - { - // ReSharper disable once ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract - if (m != null) - { - _menuBar.Menus [i] = m; - i++; - } - } - - MenuBarItem [] menus = _menuBar.Menus; - Array.Resize (ref menus, menus.Length - 1); - _menuBar.Menus = menus; - } -} diff --git a/Terminal.Gui/Views/Menuv1/MenuClosingEventArgs.cs b/Terminal.Gui/Views/Menuv1/MenuClosingEventArgs.cs deleted file mode 100644 index 0a830c2b8..000000000 --- a/Terminal.Gui/Views/Menuv1/MenuClosingEventArgs.cs +++ /dev/null @@ -1,33 +0,0 @@ -namespace Terminal.Gui.Views; - -#pragma warning disable CS0618 // Type or member is obsolete - -/// An which allows passing a cancelable menu closing event. -public class MenuClosingEventArgs : EventArgs -{ - /// Initializes a new instance of . - /// The current parent. - /// Whether the current menu will reopen. - /// Indicates whether it is a sub-menu. - public MenuClosingEventArgs (MenuBarItem currentMenu, bool reopen, bool isSubMenu) - { - CurrentMenu = currentMenu; - Reopen = reopen; - IsSubMenu = isSubMenu; - } - - /// - /// Flag that allows the cancellation of the event. If set to in the event handler, the - /// event will be canceled. - /// - public bool Cancel { get; set; } - - /// The current parent. - public MenuBarItem CurrentMenu { get; } - - /// Indicates whether the current menu is a sub-menu. - public bool IsSubMenu { get; } - - /// Indicates whether the current menu will reopen. - public bool Reopen { get; } -} \ No newline at end of file diff --git a/Terminal.Gui/Views/Menuv1/MenuItem.cs b/Terminal.Gui/Views/Menuv1/MenuItem.cs deleted file mode 100644 index 002ea0a38..000000000 --- a/Terminal.Gui/Views/Menuv1/MenuItem.cs +++ /dev/null @@ -1,388 +0,0 @@ -#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable. -#nullable enable - - -namespace Terminal.Gui.Views; - -/// -/// A has title, an associated help text, and an action to execute on activation. MenuItems -/// can also have a checked indicator (see ). -/// -[Obsolete ("Use MenuItemv2 instead.", false)] - -public class MenuItem -{ - internal MenuBar _menuBar; - - /// Initializes a new instance of - public MenuItem (Key? shortcutKey = null) : this ("", "", null, null, null, shortcutKey) { } - - /// Initializes a new instance of . - /// Title for the menu item. - /// Help text to display. - /// Action to invoke when the menu item is activated. - /// Function to determine if the action can currently be executed. - /// The of this menu item. - /// The keystroke combination. - public MenuItem ( - string? title, - string? help, - Action? action, - Func? canExecute = null, - MenuItem? parent = null, - Key? shortcutKey = null - ) - { - Title = title ?? ""; - Help = help ?? ""; - Action = action!; - CanExecute = canExecute!; - Parent = parent!; - - if (Parent is { } && Parent.ShortcutKey != Key.Empty) - { - Parent.ShortcutKey = Key.Empty; - } - // Setter will ensure Key.Empty if it's null - ShortcutKey = shortcutKey!; - } - - private bool _allowNullChecked; - private MenuItemCheckStyle _checkType; - - private string _title; - - /// Gets or sets the action to be invoked when the menu item is triggered. - /// Method to invoke. - public Action? Action { get; set; } - - /// - /// Used only if is of type. If - /// allows to be null, true or false. If only - /// allows to be true or false. - /// - public bool AllowNullChecked - { - get => _allowNullChecked; - set - { - _allowNullChecked = value; - Checked ??= false; - } - } - - /// - /// Gets or sets the action to be invoked to determine if the menu can be triggered. If - /// returns the menu item will be enabled. Otherwise, it will be disabled. - /// - /// Function to determine if the action is can be executed or not. - public Func? CanExecute { get; set; } - - /// - /// Sets or gets whether the shows a check indicator or not. See - /// . - /// - public bool? Checked { set; get; } - - /// - /// Sets or gets the of a menu item where is set to - /// . - /// - public MenuItemCheckStyle CheckType - { - get => _checkType; - set - { - _checkType = value; - - if (_checkType == MenuItemCheckStyle.Checked && !_allowNullChecked && Checked is null) - { - Checked = false; - } - } - } - - /// Gets or sets arbitrary data for the menu item. - /// This property is not used internally. - public object Data { get; set; } - - /// Gets or sets the help text for the menu item. The help text is drawn to the right of the . - /// The help text. - public string Help { get; set; } - - /// - /// Returns if the menu item is enabled. This method is a wrapper around - /// . - /// - public bool IsEnabled () { return CanExecute?.Invoke () ?? true; } - - /// Gets the parent for this . - /// The parent. - public MenuItem? Parent { get; set; } - - /// Gets or sets the title of the menu item . - /// The title. - public string Title - { - get => _title; - set - { - if (_title == value) - { - return; - } - - _title = value; - GetHotKey (); - } - } - - /// - /// Toggle the between three states if is - /// or between two states if is . - /// - public void ToggleChecked () - { - if (_checkType != MenuItemCheckStyle.Checked) - { - throw new InvalidOperationException ("This isn't a Checked MenuItemCheckStyle!"); - } - - bool? previousChecked = Checked; - - if (AllowNullChecked) - { - Checked = previousChecked switch - { - null => true, - true => false, - false => null - }; - } - else - { - Checked = !Checked; - } - } - - /// Merely a debugging aid to see the interaction with main. - internal bool GetMenuBarItem () { return IsFromSubMenu; } - - /// Merely a debugging aid to see the interaction with main. - internal MenuItem GetMenuItem () { return this; } - - /// Gets if this is from a sub-menu. - internal bool IsFromSubMenu => Parent != null; - - internal int TitleLength => GetMenuBarItemLength (Title); - - // - // ┌─────────────────────────────┐ - // │ Quit Quit UI Catalog Ctrl+Q │ - // └─────────────────────────────┘ - // ┌─────────────────┐ - // │ ◌ TopLevel Alt+T │ - // └─────────────────┘ - // TODO: Replace the `2` literals with named constants - internal int Width => 1 - + // space before Title - TitleLength - + 2 - + // space after Title - BUGBUG: This should be 1 - (Checked == true || CheckType.HasFlag (MenuItemCheckStyle.Checked) || CheckType.HasFlag (MenuItemCheckStyle.Radio) - ? 2 - : 0) - + // check glyph + space - (Help.GetColumns () > 0 ? 2 + Help.GetColumns () : 0) - + // Two spaces before Help - (ShortcutTag.GetColumns () > 0 - ? 2 + ShortcutTag.GetColumns () - : 0); // Pad two spaces before shortcut tag (which are also aligned right) - - private static int GetMenuBarItemLength (string title) - { - return title.EnumerateRunes () - .Where (ch => ch != MenuBar.HotKeySpecifier) - .Sum (ch => Math.Max (ch.GetColumns (), 1)); - } - - #region Keyboard Handling - - private Key _hotKey = Key.Empty; - - /// - /// The HotKey is used to activate a with the keyboard. HotKeys are defined by prefixing the - /// of a MenuItem with an underscore ('_'). - /// - /// Pressing Alt-Hotkey for a (menu items on the menu bar) works even if the menu is - /// not active. Once a menu has focus and is active, pressing just the HotKey will activate the MenuItem. - /// - /// - /// For example for a MenuBar with a "_File" MenuBarItem that contains a "_New" MenuItem, Alt-F will open the - /// File menu. Pressing the N key will then activate the New MenuItem. - /// - /// See also which enable global key-bindings to menu items. - /// - public Key? HotKey - { - get => _hotKey; - private set - { - var oldKey = _hotKey; - _hotKey = value ?? Key.Empty; - UpdateHotKeyBinding (oldKey); - } - } - - private void GetHotKey () - { - var nextIsHot = false; - - foreach (char x in _title) - { - if (x == MenuBar.HotKeySpecifier.Value) - { - nextIsHot = true; - } - else if (nextIsHot) - { - HotKey = char.ToLower (x); - - return; - } - } - - HotKey = Key.Empty; - } - - private Key _shortcutKey = Key.Empty; - - /// - /// Shortcut defines a key binding to the MenuItem that will invoke the MenuItem's action globally for the - /// that is the parent of the this - /// . - /// - /// The will be drawn on the MenuItem to the right of the and - /// text. See . - /// - /// - public Key? ShortcutKey - { - get => _shortcutKey; - set - { - var oldKey = _shortcutKey; - _shortcutKey = value ?? Key.Empty; - UpdateShortcutKeyBinding (oldKey); - } - } - - /// Gets the text describing the keystroke combination defined by . - public string ShortcutTag => ShortcutKey != Key.Empty ? ShortcutKey!.ToString () : string.Empty; - - internal void AddShortcutKeyBinding (MenuBar menuBar, Key key) - { - ArgumentNullException.ThrowIfNull (menuBar); - - _menuBar = menuBar; - - AddOrUpdateShortcutKeyBinding (key); - } - - private void AddOrUpdateShortcutKeyBinding (Key key) - { - if (key != Key.Empty) - { - _menuBar.HotKeyBindings.Remove (key); - } - - if (ShortcutKey != Key.Empty) - { - KeyBinding keyBinding = new ([Command.Select], null, data: this); - // Remove an existent ShortcutKey - _menuBar.HotKeyBindings.Remove (ShortcutKey!); - _menuBar.HotKeyBindings.Add (ShortcutKey!, keyBinding); - } - } - - private void UpdateHotKeyBinding (Key oldKey) - { - if (_menuBar is null or { IsInitialized: false }) - { - return; - } - - if (oldKey != Key.Empty) - { - var index = _menuBar.Menus.IndexOf (this); - - if (index > -1) - { - _menuBar.HotKeyBindings.Remove (oldKey.WithAlt); - } - } - - if (HotKey != Key.Empty) - { - var index = _menuBar.Menus.IndexOf (this); - - if (index > -1) - { - _menuBar.HotKeyBindings.Remove (HotKey!.WithAlt); - KeyBinding keyBinding = new ([Command.Toggle], null, data: this); - _menuBar.HotKeyBindings.Add (HotKey.WithAlt, keyBinding); - } - } - } - - private void UpdateShortcutKeyBinding (Key oldKey) - { - // ReSharper disable once ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract - if (_menuBar is null) - { - return; - } - - AddOrUpdateShortcutKeyBinding (oldKey); - } - - #endregion Keyboard Handling - - /// - /// Removes a dynamically from the . - /// - public virtual void RemoveMenuItem () - { - if (Parent is { }) - { - MenuItem? []? childrens = ((MenuBarItem)Parent).Children; - var i = 0; - - foreach (MenuItem? c in childrens!) - { - if (c != this) - { - childrens [i] = c; - i++; - } - } - - Array.Resize (ref childrens, childrens.Length - 1); - - if (childrens.Length == 0) - { - ((MenuBarItem)Parent).Children = null; - } - else - { - ((MenuBarItem)Parent).Children = childrens; - } - } - - if (ShortcutKey != Key.Empty) - { - // Remove an existent ShortcutKey - _menuBar.HotKeyBindings.Remove (ShortcutKey!); - } - } -} diff --git a/Terminal.Gui/Views/Menuv1/MenuItemCheckStyle.cs b/Terminal.Gui/Views/Menuv1/MenuItemCheckStyle.cs deleted file mode 100644 index 87bc5168e..000000000 --- a/Terminal.Gui/Views/Menuv1/MenuItemCheckStyle.cs +++ /dev/null @@ -1,15 +0,0 @@ -namespace Terminal.Gui.Views; - -/// Specifies how a shows selection state. -[Flags] -public enum MenuItemCheckStyle -{ - /// The menu item will be shown normally, with no check indicator. The default. - NoCheck = 0b_0000_0000, - - /// The menu item will indicate checked/un-checked state (see ). - Checked = 0b_0000_0001, - - /// The menu item is part of a menu radio group (see ) and will indicate selected state. - Radio = 0b_0000_0010 -} \ No newline at end of file diff --git a/Terminal.Gui/Views/Menuv1/MenuOpenedEventArgs.cs b/Terminal.Gui/Views/Menuv1/MenuOpenedEventArgs.cs deleted file mode 100644 index ba6c4adcf..000000000 --- a/Terminal.Gui/Views/Menuv1/MenuOpenedEventArgs.cs +++ /dev/null @@ -1,21 +0,0 @@ -namespace Terminal.Gui.Views; -#pragma warning disable CS0618 // Type or member is obsolete - -/// Defines arguments for the event -public class MenuOpenedEventArgs : EventArgs -{ - /// Creates a new instance of the class - /// - /// - public MenuOpenedEventArgs (MenuBarItem parent, MenuItem menuItem) - { - Parent = parent; - MenuItem = menuItem; - } - - /// Gets the being opened. - public MenuItem MenuItem { get; } - - /// The parent of . Will be null if menu opening is the root. - public MenuBarItem Parent { get; } -} \ No newline at end of file diff --git a/Terminal.Gui/Views/Menuv1/MenuOpeningEventArgs.cs b/Terminal.Gui/Views/Menuv1/MenuOpeningEventArgs.cs deleted file mode 100644 index e19421caa..000000000 --- a/Terminal.Gui/Views/Menuv1/MenuOpeningEventArgs.cs +++ /dev/null @@ -1,26 +0,0 @@ -namespace Terminal.Gui.Views; - -#pragma warning disable CS0618 // Type or member is obsolete - -/// -/// An which allows passing a cancelable menu opening event or replacing with a new -/// . -/// -public class MenuOpeningEventArgs : EventArgs -{ - /// Initializes a new instance of . - /// The current parent. - public MenuOpeningEventArgs (MenuBarItem currentMenu) { CurrentMenu = currentMenu; } - - /// - /// Flag that allows the cancellation of the event. If set to in the event handler, the - /// event will be canceled. - /// - public bool Cancel { get; set; } - - /// The current parent. - public MenuBarItem CurrentMenu { get; } - - /// The new to be replaced. - public MenuBarItem NewMenuBarItem { get; set; } -} \ No newline at end of file diff --git a/Terminal.Gui/Views/MessageBox.cs b/Terminal.Gui/Views/MessageBox.cs index 478d79565..e6d3cebd3 100644 --- a/Terminal.Gui/Views/MessageBox.cs +++ b/Terminal.Gui/Views/MessageBox.cs @@ -1,111 +1,205 @@ - namespace Terminal.Gui.Views; /// -/// MessageBox displays a modal message to the user, with a title, a message and a series of options that the user -/// can choose from. +/// Displays a modal message box with a title, message, and buttons. Returns the index of the selected button, +/// or if the user cancels with . /// -/// -/// The difference between the and -/// method is the default set of colors used for the message box. -/// -/// -/// The following example pops up a with the specified title and text, plus two -/// s. The value -1 is returned when the user cancels the by pressing the -/// ESC key. -/// -/// -/// -/// var n = MessageBox.Query ("Quit Demo", "Are you sure you want to quit this demo?", "Yes", "No"); -/// if (n == 0) -/// quit = true; -/// else -/// quit = false; -/// -/// +/// +/// +/// MessageBox provides static methods for displaying modal dialogs with customizable buttons and messages. +/// All methods return where the value is the 0-based index of the button pressed, +/// or if the user pressed (typically Esc). +/// +/// +/// uses the default Dialog color scheme. +/// uses the Error color scheme. +/// +/// +/// Important: All MessageBox methods require an instance to be passed. +/// This enables proper modal dialog management and respects the application's lifecycle. Pass your +/// application instance (from ) or use the legacy +/// if using the static Application pattern. +/// +/// +/// Example using instance-based pattern: +/// +/// IApplication app = Application.Create(); +/// app.Init(); +/// +/// int? result = MessageBox.Query(app, "Quit Demo", "Are you sure you want to quit?", "Yes", "No"); +/// if (result == 0) // User clicked "Yes" +/// app.RequestStop(); +/// else if (result == null) // User pressed Esc +/// // Handle cancellation +/// +/// app.Shutdown(); +/// +/// +/// +/// Example using legacy static pattern: +/// +/// Application.Init(); +/// +/// int? result = MessageBox.Query(ApplicationImpl.Instance, "Quit Demo", "Are you sure?", "Yes", "No"); +/// if (result == 0) // User clicked "Yes" +/// Application.RequestStop(); +/// +/// Application.Shutdown(); +/// +/// +/// +/// The property provides a global variable alternative for web-based consoles +/// without SynchronizationContext. However, using the return value is preferred as it's more thread-safe +/// and follows modern async patterns. +/// +/// public static class MessageBox { + private static LineStyle _defaultBorderStyle = LineStyle.Heavy; // Resources/config.json overrides + private static Alignment _defaultButtonAlignment = Alignment.Center; // Resources/config.json overrides + private static int _defaultMinimumWidth = 0; // Resources/config.json overrides + private static int _defaultMinimumHeight = 0; // Resources/config.json overrides + /// /// Defines the default border styling for . Can be configured via /// . /// [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static LineStyle DefaultBorderStyle { get; set; } = LineStyle.Heavy; + public static LineStyle DefaultBorderStyle + { + get => _defaultBorderStyle; + set => _defaultBorderStyle = value; + } /// The default for . /// This property can be set in a Theme. [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static Alignment DefaultButtonAlignment { get; set; } = Alignment.Center; + public static Alignment DefaultButtonAlignment + { + get => _defaultButtonAlignment; + set => _defaultButtonAlignment = value; + } /// /// Defines the default minimum MessageBox width, as a percentage of the screen width. Can be configured via /// . /// [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static int DefaultMinimumWidth { get; set; } = 0; + public static int DefaultMinimumWidth + { + get => _defaultMinimumWidth; + set => _defaultMinimumWidth = value; + } /// /// Defines the default minimum Dialog height, as a percentage of the screen width. Can be configured via /// . /// [ConfigurationProperty (Scope = typeof (ThemeScope))] - public static int DefaultMinimumHeight { get; set; } = 0; - /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. This is useful for web - /// based console where there is no SynchronizationContext or TaskScheduler. - /// - /// - /// Warning: This is a global variable and should be used with caution. It is not thread safe. - /// - public static int Clicked { get; private set; } = -1; + public static int DefaultMinimumHeight + { + get => _defaultMinimumHeight; + set => _defaultMinimumHeight = value; + } /// - /// Presents an error with the specified title and message and a list of buttons. + /// The index of the selected button, or if the user pressed . /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. + /// + /// This global variable is useful for web-based consoles without a SynchronizationContext or TaskScheduler. + /// Warning: Not thread-safe. + /// + public static int? Clicked { get; private set; } + + /// + /// Displays an error with fixed dimensions. + /// + /// The application instance. If , uses . /// Width for the MessageBox. /// Height for the MessageBox. /// Title for the MessageBox. - /// Message to display; might contain multiple lines. The message will be word=wrapped by default. - /// Array of buttons to add. + /// Message to display. May contain multiple lines and will be word-wrapped. + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . /// - /// Use instead; it automatically sizes the MessageBox based on - /// the contents. + /// Consider using which automatically sizes the + /// MessageBox. /// - public static int ErrorQuery (int width, int height, string title, string message, params string [] buttons) + public static int? ErrorQuery ( + IApplication? app, + int width, + int height, + string title, + string message, + params string [] buttons + ) { - return QueryFull (true, width, height, title, message, 0, true, buttons); + return QueryFull ( + app, + true, + width, + height, + title, + message, + 0, + true, + buttons); } /// - /// Presents an error with the specified title and message and a list of buttons to show - /// to the user. + /// Displays an auto-sized error . /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. - /// Title for the query. - /// Message to display; might contain multiple lines. The message will be word=wrapped by default. - /// Array of buttons to add. + /// The application instance. If , uses . + /// Title for the MessageBox. + /// Message to display. May contain multiple lines and will be word-wrapped. + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . /// - /// The message box will be vertically and horizontally centered in the container and the size will be - /// automatically determined from the size of the title, message. and buttons. + /// The MessageBox is centered and auto-sized based on title, message, and buttons. /// - public static int ErrorQuery (string title, string message, params string [] buttons) { return QueryFull (true, 0, 0, title, message, 0, true, buttons); } + public static int? ErrorQuery (IApplication? app, string title, string message, params string [] buttons) + { + return QueryFull ( + app, + true, + 0, + 0, + title, + message, + 0, + true, + buttons); + } /// - /// Presents an error with the specified title and message and a list of buttons. + /// Displays an error with fixed dimensions and a default button. /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. + /// The application instance. If , uses . /// Width for the MessageBox. /// Height for the MessageBox. /// Title for the MessageBox. - /// Message to display; might contain multiple lines. The message will be word=wrapped by default. - /// Index of the default button. - /// Array of buttons to add. + /// Message to display. May contain multiple lines and will be word-wrapped. + /// Index of the default button (0-based). + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . /// - /// Use instead; it automatically sizes the MessageBox based on - /// the contents. + /// Consider using which automatically sizes the + /// MessageBox. /// - public static int ErrorQuery ( + public static int? ErrorQuery ( + IApplication? app, int width, int height, string title, @@ -114,184 +208,73 @@ public static class MessageBox params string [] buttons ) { - return QueryFull (true, width, height, title, message, defaultButton, true, buttons); + return QueryFull ( + app, + true, + width, + height, + title, + message, + defaultButton, + true, + buttons); } /// - /// Presents an error with the specified title and message and a list of buttons to show - /// to the user. + /// Displays an auto-sized error with a default button. /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. + /// The application instance. If , uses . /// Title for the MessageBox. - /// Message to display; might contain multiple lines. The message will be word=wrapped by default. - /// Index of the default button. - /// Array of buttons to add. + /// Message to display. May contain multiple lines and will be word-wrapped. + /// Index of the default button (0-based). + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . /// - /// The message box will be vertically and horizontally centered in the container and the size will be - /// automatically determined from the size of the title, message. and buttons. + /// The MessageBox is centered and auto-sized based on title, message, and buttons. /// - public static int ErrorQuery (string title, string message, int defaultButton = 0, params string [] buttons) + public static int? ErrorQuery (IApplication? app, string title, string message, int defaultButton = 0, params string [] buttons) { - return QueryFull (true, 0, 0, title, message, defaultButton, true, buttons); + return QueryFull ( + app, + true, + 0, + 0, + title, + message, + defaultButton, + true, + buttons); } /// - /// Presents an error with the specified title and message and a list of buttons to show - /// to the user. + /// Displays an error with fixed dimensions, a default button, and word-wrap control. /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. - /// Width for the window. - /// Height for the window. - /// Title for the query. - /// Message to display; might contain multiple lines. The message will be word=wrapped by default. - /// Index of the default button. - /// If wrap the message or not. - /// Array of buttons to add. - /// - /// Use instead; it automatically sizes the MessageBox based on - /// the contents. - /// - public static int ErrorQuery ( - int width, - int height, - string title, - string message, - int defaultButton = 0, - bool wrapMessage = true, - params string [] buttons - ) - { - return QueryFull (true, width, height, title, message, defaultButton, wrapMessage, buttons); - } - - /// - /// Presents an error with the specified title and message and a list of buttons to show - /// to the user. - /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. - /// Title for the query. - /// Message to display; might contain multiple lines. The message will be word=wrapped by default. - /// Index of the default button. - /// If wrap the message or not. The default is - /// Array of buttons to add. - /// - /// The message box will be vertically and horizontally centered in the container and the size will be - /// automatically determined from the size of the title, message. and buttons. - /// - public static int ErrorQuery ( - string title, - string message, - int defaultButton = 0, - bool wrapMessage = true, - params string [] buttons - ) - { - return QueryFull (true, 0, 0, title, message, defaultButton, wrapMessage, buttons); - } - - /// - /// Presents a with the specified title and message and a list of buttons. - /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. + /// The application instance. If , uses . /// Width for the MessageBox. /// Height for the MessageBox. /// Title for the MessageBox. - /// Message to display; might contain multiple lines. The message will be word=wrapped by default. - /// Array of buttons to add. + /// Message to display. May contain multiple lines. + /// Index of the default button (0-based). + /// + /// If , word-wraps the message; otherwise displays as-is with multi-line + /// support. + /// + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . /// - /// Use instead; it automatically sizes the MessageBox based on - /// the contents. + /// Consider using which automatically + /// sizes the MessageBox. /// - public static int Query (int width, int height, string title, string message, params string [] buttons) - { - return QueryFull (false, width, height, title, message, 0, true, buttons); - } - - /// - /// Presents a with the specified title and message and a list of buttons. - /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. - /// Title for the MessageBox. - /// Message to display; might contain multiple lines. The message will be word=wrapped by default. - /// Array of buttons to add. - /// - /// - /// The message box will be vertically and horizontally centered in the container and the size will be - /// automatically determined from the size of the title, message. and buttons. - /// - /// - /// Use instead; it automatically sizes the MessageBox based on - /// the contents. - /// - /// - public static int Query (string title, string message, params string [] buttons) { return QueryFull (false, 0, 0, title, message, 0, true, buttons); } - - /// - /// Presents a with the specified title and message and a list of buttons. - /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. - /// Width for the window. - /// Height for the window. - /// Title for the MessageBox. - /// Message to display; might contain multiple lines. The message will be word=wrapped by default. - /// Index of the default button. - /// Array of buttons to add. - /// - /// - /// The message box will be vertically and horizontally centered in the container and the size will be - /// automatically determined from the size of the title, message. and buttons. - /// - /// - /// Use instead; it automatically sizes the MessageBox based on - /// the contents. - /// - /// - public static int Query ( - int width, - int height, - string title, - string message, - int defaultButton = 0, - params string [] buttons - ) - { - return QueryFull (false, width, height, title, message, defaultButton, true, buttons); - } - - /// - /// Presents a with the specified title and message and a list of buttons. - /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. - /// Title for the MessageBox. - /// Message to display; might contain multiple lines. The message will be word=wrapped by default. - /// Index of the default button. - /// Array of buttons to add. - /// - /// The message box will be vertically and horizontally centered in the container and the size will be - /// automatically determined from the size of the message and buttons. - /// - public static int Query (string title, string message, int defaultButton = 0, params string [] buttons) - { - return QueryFull (false, 0, 0, title, message, defaultButton, true, buttons); - } - - /// - /// Presents a with the specified title and message and a list of buttons to show - /// to the user. - /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. - /// Width for the window. - /// Height for the window. - /// Title for the query. - /// Message to display, might contain multiple lines. - /// Index of the default button. - /// If wrap the message or not. - /// Array of buttons to add. - /// - /// Use instead; it automatically sizes the MessageBox based on the - /// contents. - /// - public static int Query ( + public static int? ErrorQuery ( + IApplication? app, int width, int height, string title, @@ -301,20 +284,40 @@ public static class MessageBox params string [] buttons ) { - return QueryFull (false, width, height, title, message, defaultButton, wrapMessage, buttons); + return QueryFull ( + app, + true, + width, + height, + title, + message, + defaultButton, + wrapMessage, + buttons); } /// - /// Presents a with the specified title and message and a list of buttons to show - /// to the user. + /// Displays an auto-sized error with a default button and word-wrap control. /// - /// The index of the selected button, or -1 if the user pressed to close the MessageBox. - /// Title for the query. - /// Message to display, might contain multiple lines. - /// Index of the default button. - /// If wrap the message or not. - /// Array of buttons to add. - public static int Query ( + /// The application instance. If , uses . + /// Title for the MessageBox. + /// Message to display. May contain multiple lines. + /// Index of the default button (0-based). + /// + /// If , word-wraps the message; otherwise displays as-is with multi-line + /// support. + /// + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . + /// + /// The MessageBox is centered and auto-sized based on title, message, and buttons. + /// + public static int? ErrorQuery ( + IApplication? app, string title, string message, int defaultButton = 0, @@ -322,10 +325,239 @@ public static class MessageBox params string [] buttons ) { - return QueryFull (false, 0, 0, title, message, defaultButton, wrapMessage, buttons); + return QueryFull ( + app, + true, + 0, + 0, + title, + message, + defaultButton, + wrapMessage, + buttons); } - private static int QueryFull ( + /// + /// Displays a with fixed dimensions. + /// + /// The application instance. If , uses . + /// Width for the MessageBox. + /// Height for the MessageBox. + /// Title for the MessageBox. + /// Message to display. May contain multiple lines and will be word-wrapped. + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . + /// + /// Consider using which automatically sizes the + /// MessageBox. + /// + public static int? Query (IApplication? app, int width, int height, string title, string message, params string [] buttons) + { + return QueryFull ( + app, + false, + width, + height, + title, + message, + 0, + true, + buttons); + } + + /// + /// Displays an auto-sized . + /// + /// The application instance. If , uses . + /// Title for the MessageBox. + /// Message to display. May contain multiple lines and will be word-wrapped. + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . + /// + /// The MessageBox is centered and auto-sized based on title, message, and buttons. + /// + public static int? Query (IApplication? app, string title, string message, params string [] buttons) + { + return QueryFull ( + app, + false, + 0, + 0, + title, + message, + 0, + true, + buttons); + } + + /// + /// Displays a with fixed dimensions and a default button. + /// + /// The application instance. If , uses . + /// Width for the MessageBox. + /// Height for the MessageBox. + /// Title for the MessageBox. + /// Message to display. May contain multiple lines and will be word-wrapped. + /// Index of the default button (0-based). + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . + /// + /// Consider using which automatically sizes the + /// MessageBox. + /// + public static int? Query ( + IApplication? app, + int width, + int height, + string title, + string message, + int defaultButton = 0, + params string [] buttons + ) + { + return QueryFull ( + app, + false, + width, + height, + title, + message, + defaultButton, + true, + buttons); + } + + /// + /// Displays an auto-sized with a default button. + /// + /// The application instance. If , uses . + /// Title for the MessageBox. + /// Message to display. May contain multiple lines and will be word-wrapped. + /// Index of the default button (0-based). + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . + /// + /// The MessageBox is centered and auto-sized based on title, message, and buttons. + /// + public static int? Query (IApplication? app, string title, string message, int defaultButton = 0, params string [] buttons) + { + return QueryFull ( + app, + false, + 0, + 0, + title, + message, + defaultButton, + true, + buttons); + } + + /// + /// Displays a with fixed dimensions, a default button, and word-wrap control. + /// + /// The application instance. If , uses . + /// Width for the MessageBox. + /// Height for the MessageBox. + /// Title for the MessageBox. + /// Message to display. May contain multiple lines. + /// Index of the default button (0-based). + /// + /// If , word-wraps the message; otherwise displays as-is with multi-line + /// support. + /// + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . + /// + /// Consider using which automatically sizes + /// the MessageBox. + /// + public static int? Query ( + IApplication? app, + int width, + int height, + string title, + string message, + int defaultButton = 0, + bool wrapMessage = true, + params string [] buttons + ) + { + return QueryFull ( + app, + false, + width, + height, + title, + message, + defaultButton, + wrapMessage, + buttons); + } + + /// + /// Displays an auto-sized with a default button and word-wrap control. + /// + /// The application instance. If , uses . + /// Title for the MessageBox. + /// Message to display. May contain multiple lines. + /// Index of the default button (0-based). + /// + /// If , word-wraps the message; otherwise displays as-is with multi-line + /// support. + /// + /// Array of button labels. + /// + /// The index of the selected button, or if the user pressed + /// . + /// + /// Thrown if is . + /// + /// The MessageBox is centered and auto-sized based on title, message, and buttons. + /// + public static int? Query ( + IApplication? app, + string title, + string message, + int defaultButton = 0, + bool wrapMessage = true, + params string [] buttons + ) + { + return QueryFull ( + app, + false, + 0, + 0, + title, + message, + defaultButton, + wrapMessage, + buttons); + } + + private static int? QueryFull ( + IApplication? app, bool useErrorColors, int width, int height, @@ -336,10 +568,12 @@ public static class MessageBox params string [] buttons ) { + ArgumentNullException.ThrowIfNull (app); + // Create button array for Dialog var count = 0; List /// /// - public GuiTestContext Then (Action doAction) + public GuiTestContext Then (Action doAction) { try { @@ -302,7 +319,7 @@ public partial class GuiTestContext : IDisposable /// /// /// - public GuiTestContext WaitIteration (Action? action = null) + public GuiTestContext WaitIteration (Action? action = null) { // If application has already exited don't wait! if (Finished || _runCancellationTokenSource.Token.IsCancellationRequested || _fakeInput.ExternalCancellationTokenSource!.Token.IsCancellationRequested) @@ -312,31 +329,34 @@ public partial class GuiTestContext : IDisposable return this; } - if (Thread.CurrentThread.ManagedThreadId == Application.MainThreadId) + if (Thread.CurrentThread.ManagedThreadId == _applicationImpl?.MainThreadId) { throw new NotSupportedException ("Cannot WaitIteration during Invoke"); } - Logging.Trace ($"WaitIteration started"); - action ??= () => { }; + //Logging.Trace ($"WaitIteration started"); + if (action is null) + { + action = (app) => { }; + } CancellationTokenSource ctsActionCompleted = new (); - Application.Invoke (() => - { - try - { - action (); + App?.Invoke (app => + { + try + { + action (app); - //Logging.Trace ("Action completed"); - ctsActionCompleted.Cancel (); - } - catch (Exception e) - { - Logging.Warning ($"Action failed with exception: {e}"); - _backgroundException = e; - _fakeInput.ExternalCancellationTokenSource?.Cancel (); - } - }); + //Logging.Trace ("Action completed"); + ctsActionCompleted.Cancel (); + } + catch (Exception e) + { + Logging.Warning ($"Action failed with exception: {e}"); + _backgroundException = e; + _fakeInput.ExternalCancellationTokenSource?.Cancel (); + } + }); // Blocks until either the token or the hardStopToken is cancelled. // With linked tokens, we only need to wait on _runCancellationTokenSource and ctsLocal @@ -356,8 +376,9 @@ public partial class GuiTestContext : IDisposable GuiTestContext? c = null; var sw = Stopwatch.StartNew (); - //Logging.Trace ($"WaitUntil started with timeout {_timeout}"); + Logging.Trace ($"WaitUntil started with timeout {_timeout}"); + int count = 0; while (!condition ()) { if (sw.Elapsed > _timeout) @@ -366,8 +387,10 @@ public partial class GuiTestContext : IDisposable } c = WaitIteration (); + count++; } + Logging.Trace ($"WaitUntil completed after {sw.ElapsedMilliseconds}ms and {count} iterations"); return c ?? this; } @@ -384,15 +407,30 @@ public partial class GuiTestContext : IDisposable /// new Width for the console. /// new Height for the console. /// - public GuiTestContext ResizeConsole (int width, int height) { return WaitIteration (() => { Application.Driver!.SetScreenSize (width, height); }); } + public GuiTestContext ResizeConsole (int width, int height) + { + return WaitIteration ((app) => { app.Driver!.SetScreenSize (width, height); }); + } public GuiTestContext ScreenShot (string title, TextWriter? writer) { //Logging.Trace ($"{title}"); - return WaitIteration (() => + return WaitIteration ((app) => { writer?.WriteLine (title + ":"); - var text = Application.ToString (); + var text = app.Driver?.ToString (); + + writer?.WriteLine (text); + }); + } + + public GuiTestContext AnsiScreenShot (string title, TextWriter? writer) + { + //Logging.Trace ($"{title}"); + return WaitIteration ((app) => + { + writer?.WriteLine (title + ":"); + var text = app.Driver?.ToAnsi (); writer?.WriteLine (text); }); @@ -412,7 +450,7 @@ public partial class GuiTestContext : IDisposable { try { - Application.Shutdown (); + App?.Dispose (); } catch { @@ -425,7 +463,7 @@ public partial class GuiTestContext : IDisposable return this; } - WaitIteration (() => { Application.RequestStop (); }); + WaitIteration ((app) => { app.RequestStop (); }); // Wait for the application to stop, but give it a 1-second timeout const int WAIT_TIMEOUT_MS = 1000; @@ -440,8 +478,8 @@ public partial class GuiTestContext : IDisposable // If this doesn't work there will be test failures as the main loop continues to run during next test. try { - Application.RequestStop (); - Application.Shutdown (); + App?.RequestStop (); + App?.Dispose (); } catch (Exception ex) { @@ -507,6 +545,7 @@ public partial class GuiTestContext : IDisposable internal void Fail (string reason) { Logging.Error ($"{reason}"); + WriteOutLogs (_logWriter); throw new (reason); } @@ -516,9 +555,8 @@ public partial class GuiTestContext : IDisposable Logging.Trace ("CleanupApplication"); _fakeInput.ExternalCancellationTokenSource = null; - Application.ResetState (true); - ApplicationImpl.ChangeInstance (_originalApplicationInstance); - Logging.Logger = _originalLogger; + App?.ResetState (true); + Logging.Logger = _originalLogger!; Finished = true; Application.MaximumIterationsPerSecond = Application.DefaultMaximumIterationsPerSecond; diff --git a/Tests/TerminalGuiFluentTesting/NetSequences.cs b/Tests/TerminalGuiFluentTesting/NetSequences.cs deleted file mode 100644 index 10256b126..000000000 --- a/Tests/TerminalGuiFluentTesting/NetSequences.cs +++ /dev/null @@ -1,53 +0,0 @@ -namespace TerminalGuiFluentTesting; -class NetSequences -{ - public static ConsoleKeyInfo [] Down = new [] - { - new ConsoleKeyInfo('\x1B', ConsoleKey.Enter, false, false, false), - new ConsoleKeyInfo('[', ConsoleKey.None, false, false, false), - new ConsoleKeyInfo('B', ConsoleKey.None, false, false, false), - }; - - public static ConsoleKeyInfo [] Up = new [] - { - new ConsoleKeyInfo('\x1B', ConsoleKey.Enter, false, false, false), - new ConsoleKeyInfo('[', ConsoleKey.None, false, false, false), - new ConsoleKeyInfo('A', ConsoleKey.None, false, false, false), - }; - - public static ConsoleKeyInfo [] Left = new [] - { - new ConsoleKeyInfo('\x1B', ConsoleKey.Enter, false, false, false), - new ConsoleKeyInfo('[', ConsoleKey.None, false, false, false), - new ConsoleKeyInfo('D', ConsoleKey.None, false, false, false), - }; - - public static ConsoleKeyInfo [] Right = new [] - { - new ConsoleKeyInfo('\x1B', ConsoleKey.Enter, false, false, false), - new ConsoleKeyInfo('[', ConsoleKey.None, false, false, false), - new ConsoleKeyInfo('C', ConsoleKey.None, false, false, false), - }; - - public static IEnumerable Click (int button, int screenX, int screenY) - { - // Adjust for 1-based coordinates - int adjustedX = screenX + 1; - int adjustedY = screenY + 1; - - // Mouse press sequence - var sequence = $"\x1B[<{button};{adjustedX};{adjustedY}M"; - foreach (char c in sequence) - { - yield return new ConsoleKeyInfo (c, ConsoleKey.None, false, false, false); - } - - // Mouse release sequence - sequence = $"\x1B[<{button};{adjustedX};{adjustedY}m"; - foreach (char c in sequence) - { - yield return new ConsoleKeyInfo (c, ConsoleKey.None, false, false, false); - } - } - -} diff --git a/Tests/TerminalGuiFluentTesting/With.cs b/Tests/TerminalGuiFluentTesting/With.cs index 04658d89b..71abdea16 100644 --- a/Tests/TerminalGuiFluentTesting/With.cs +++ b/Tests/TerminalGuiFluentTesting/With.cs @@ -14,7 +14,7 @@ public static class With /// Which v2 testDriver to use for the test /// /// - public static GuiTestContext A (int width, int height, TestDriver testDriver, TextWriter? logWriter = null) where T : Toplevel, new() + public static GuiTestContext A (int width, int height, TestDriver testDriver, TextWriter? logWriter = null) where T : IRunnable, new() { return new (() => new T () { @@ -23,16 +23,17 @@ public static class With } /// - /// Overload that takes a function to create instance after application is initialized. + /// Overload that takes a function to create instance after application is initialized. /// - /// + /// /// /// /// + /// /// - public static GuiTestContext A (Func toplevelFactory, int width, int height, TestDriver testDriver) + public static GuiTestContext A (Func runnableFactory, int width, int height, TestDriver testDriver, TextWriter? logWriter = null) { - return new (toplevelFactory, width, height, testDriver, null, Timeout); + return new (runnableFactory, width, height, testDriver, logWriter, Timeout); } /// /// The global timeout to allow for any given application to run for before shutting down. diff --git a/Tests/UnitTests/Application/Application.NavigationTests.cs b/Tests/UnitTests/Application/Application.NavigationTests.cs deleted file mode 100644 index 93ad1ae91..000000000 --- a/Tests/UnitTests/Application/Application.NavigationTests.cs +++ /dev/null @@ -1,158 +0,0 @@ -using UnitTests; -using Xunit.Abstractions; - -namespace UnitTests.ApplicationTests; - -public class ApplicationNavigationTests (ITestOutputHelper output) -{ - private readonly ITestOutputHelper _output = output; - - - [AutoInitShutdown] - [Theory] - [InlineData (TabBehavior.NoStop)] - [InlineData (TabBehavior.TabStop)] - [InlineData (TabBehavior.TabGroup)] - public void Begin_SetsFocus_On_Deepest_Focusable_View (TabBehavior behavior) - { - var top = new Toplevel - { - TabStop = behavior - }; - Assert.False (top.HasFocus); - - View subView = new () - { - CanFocus = true, - TabStop = behavior - }; - top.Add (subView); - - View subSubView = new () - { - CanFocus = true, - TabStop = TabBehavior.NoStop - }; - subView.Add (subSubView); - - SessionToken rs = Application.Begin (top); - Assert.True (top.HasFocus); - Assert.True (subView.HasFocus); - Assert.True (subSubView.HasFocus); - - top.Dispose (); - } - - [Fact] - [AutoInitShutdown] - public void Begin_SetsFocus_On_Top () - { - var top = new Toplevel (); - Assert.False (top.HasFocus); - - SessionToken rs = Application.Begin (top); - Assert.True (top.HasFocus); - - top.Dispose (); - } - - [Fact] - public void Focused_Change_Raises_FocusedChanged () - { - var raised = false; - - Application.Navigation = new (); - - Application.Navigation.FocusedChanged += ApplicationNavigationOnFocusedChanged; - - Application.Navigation.SetFocused (new () { CanFocus = true, HasFocus = true }); - - Assert.True (raised); - - Application.Navigation.GetFocused ().Dispose (); - Application.Navigation.SetFocused (null); - - Application.Navigation.FocusedChanged -= ApplicationNavigationOnFocusedChanged; - - Application.Navigation = null; - - return; - - void ApplicationNavigationOnFocusedChanged (object sender, EventArgs e) { raised = true; } - } - - [Fact] - public void GetFocused_Returns_Focused_View () - { - Application.Navigation = new (); - - Application.Top = new () - { - Id = "top", - CanFocus = true - }; - - var subView1 = new View - { - Id = "subView1", - CanFocus = true - }; - - var subView2 = new View - { - Id = "subView2", - CanFocus = true - }; - Application.Top.Add (subView1, subView2); - Assert.False (Application.Top.HasFocus); - - Application.Top.SetFocus (); - Assert.True (subView1.HasFocus); - Assert.Equal (subView1, Application.Navigation.GetFocused ()); - - Application.Navigation.AdvanceFocus (NavigationDirection.Forward, null); - Assert.Equal (subView2, Application.Navigation.GetFocused ()); - - Application.Top.Dispose (); - Application.Top = null; - Application.Navigation = null; - } - - [Fact] - public void GetFocused_Returns_Null_If_No_Focused_View () - { - Application.Navigation = new (); - - Application.Top = new () - { - Id = "top", - CanFocus = true - }; - - var subView1 = new View - { - Id = "subView1", - CanFocus = true - }; - - Application.Top.Add (subView1); - Assert.False (Application.Top.HasFocus); - - Application.Top.SetFocus (); - Assert.True (subView1.HasFocus); - Assert.Equal (subView1, Application.Navigation.GetFocused ()); - - subView1.HasFocus = false; - Assert.False (subView1.HasFocus); - Assert.True (Application.Top.HasFocus); - Assert.Equal (Application.Top, Application.Navigation.GetFocused ()); - - Application.Top.HasFocus = false; - Assert.False (Application.Top.HasFocus); - Assert.Null (Application.Navigation.GetFocused ()); - - Application.Top.Dispose (); - Application.Top = null; - Application.Navigation = null; - } -} diff --git a/Tests/UnitTests/Application/ApplicationForceDriverTests.cs b/Tests/UnitTests/Application/ApplicationForceDriverTests.cs new file mode 100644 index 000000000..1bbb0d71f --- /dev/null +++ b/Tests/UnitTests/Application/ApplicationForceDriverTests.cs @@ -0,0 +1,41 @@ +using UnitTests; + +namespace UnitTests.ApplicationTests; + +public class ApplicationForceDriverTests : FakeDriverBase +{ + [Fact (Skip = "Bogus test now that config properties are handled correctly")] + public void ForceDriver_Does_Not_Changes_If_It_Has_Valid_Value () + { + Assert.False (Application.Initialized); + Assert.Null (Application.Driver); + Assert.Equal (string.Empty, Application.ForceDriver); + + Application.ForceDriver = "fake"; + Assert.Equal ("fake", Application.ForceDriver); + + Application.ForceDriver = "dotnet"; + Assert.Equal ("fake", Application.ForceDriver); + } + + [Fact (Skip = "Bogus test now that config properties are handled correctly")] + public void ForceDriver_Throws_If_Initialized_Changed_To_Another_Value () + { + IDriver driver = CreateFakeDriver (); + + Assert.False (Application.Initialized); + Assert.Null (Application.Driver); + Assert.Equal (string.Empty, Application.ForceDriver); + + Application.Init (driverName: "fake"); + Assert.True (Application.Initialized); + Assert.NotNull (Application.Driver); + Assert.Equal ("fake", Application.Driver.GetName ()); + Assert.Equal (string.Empty, Application.ForceDriver); + + Assert.Throws (() => Application.ForceDriver = "dotnet"); + + Application.ForceDriver = "fake"; + Assert.Equal ("fake", Application.ForceDriver); + } +} diff --git a/Tests/UnitTests/Application/ApplicationImplTests.cs b/Tests/UnitTests/Application/ApplicationImplTests.cs deleted file mode 100644 index d31a254d3..000000000 --- a/Tests/UnitTests/Application/ApplicationImplTests.cs +++ /dev/null @@ -1,663 +0,0 @@ -#nullable enable -using System.Collections.Concurrent; -using Moq; -using TerminalGuiFluentTesting; - -namespace UnitTests.ApplicationTests; - -public class ApplicationImplTests -{ - /// - /// Crates a new ApplicationImpl instance for testing. The input, output, and size monitor components are mocked. - /// - private ApplicationImpl NewMockedApplicationImpl () - { - Mock netInput = new (); - SetupRunInputMockMethodToBlock (netInput); - - Mock> m = new (); - m.Setup (f => f.CreateInput ()).Returns (netInput.Object); - m.Setup (f => f.CreateInputProcessor (It.IsAny> ())).Returns (Mock.Of ()); - - Mock consoleOutput = new (); - var size = new Size (80, 25); - consoleOutput.Setup (o => o.SetSize (It.IsAny (), It.IsAny ())) - .Callback ((w, h) => size = new Size (w, h)); - consoleOutput.Setup (o => o.GetSize ()).Returns (() => size); - m.Setup (f => f.CreateOutput ()).Returns (consoleOutput.Object); - m.Setup (f => f.CreateSizeMonitor (It.IsAny (), It.IsAny ())).Returns (Mock.Of ()); - - return new (m.Object); - } - - [Fact] - public void Init_CreatesKeybindings () - { - IApplication orig = ApplicationImpl.Instance; - - ApplicationImpl v2 = NewMockedApplicationImpl (); - ApplicationImpl.ChangeInstance (v2); - - Application.KeyBindings.Clear (); - - Assert.Empty (Application.KeyBindings.GetBindings ()); - - v2.Init (null, "fake"); - - Assert.NotEmpty (Application.KeyBindings.GetBindings ()); - - v2.Shutdown (); - - ApplicationImpl.ChangeInstance (orig); - } - - /* - [Fact] - public void Init_ExplicitlyRequestWin () - { - var orig = ApplicationImpl.Instance; - - Assert.Null (Application.Driver); - var netInput = new Mock (MockBehavior.Strict); - var netOutput = new Mock (MockBehavior.Strict); - var winInput = new Mock (MockBehavior.Strict); - var winOutput = new Mock (MockBehavior.Strict); - - winInput.Setup (i => i.Initialize (It.IsAny> ())) - .Verifiable (Times.Once); - SetupRunInputMockMethodToBlock (winInput); - winInput.Setup (i => i.Dispose ()) - .Verifiable (Times.Once); - winOutput.Setup (i => i.Dispose ()) - .Verifiable (Times.Once); - - var v2 = new ApplicationV2 ( - () => netInput.Object, - () => netOutput.Object, - () => winInput.Object, - () => winOutput.Object); - ApplicationImpl.ChangeInstance (v2); - - Assert.Null (Application.Driver); - v2.Init (null, "v2win"); - Assert.NotNull (Application.Driver); - - var type = Application.Driver.GetType (); - Assert.True (type.IsGenericType); - Assert.True (type.GetGenericTypeDefinition () == typeof (ConsoleDriverFacade<>)); - v2.Shutdown (); - - Assert.Null (Application.Driver); - - winInput.VerifyAll (); - - ApplicationImpl.ChangeInstance (orig); - } - - [Fact] - public void Init_ExplicitlyRequestNet () - { - var orig = ApplicationImpl.Instance; - - var netInput = new Mock (MockBehavior.Strict); - var netOutput = new Mock (MockBehavior.Strict); - var winInput = new Mock (MockBehavior.Strict); - var winOutput = new Mock (MockBehavior.Strict); - - netInput.Setup (i => i.Initialize (It.IsAny> ())) - .Verifiable (Times.Once); - SetupRunInputMockMethodToBlock (netInput); - netInput.Setup (i => i.Dispose ()) - .Verifiable (Times.Once); - netOutput.Setup (i => i.Dispose ()) - .Verifiable (Times.Once); - var v2 = new ApplicationV2 ( - () => netInput.Object, - () => netOutput.Object, - () => winInput.Object, - () => winOutput.Object); - ApplicationImpl.ChangeInstance (v2); - - Assert.Null (Application.Driver); - v2.Init (null, "v2net"); - Assert.NotNull (Application.Driver); - - var type = Application.Driver.GetType (); - Assert.True (type.IsGenericType); - Assert.True (type.GetGenericTypeDefinition () == typeof (ConsoleDriverFacade<>)); - v2.Shutdown (); - - Assert.Null (Application.Driver); - - netInput.VerifyAll (); - - ApplicationImpl.ChangeInstance (orig); - } -*/ - private void SetupRunInputMockMethodToBlock (Mock> winInput) - { - winInput.Setup (r => r.Run (It.IsAny ())) - .Callback (token => - { - // Simulate an infinite loop that checks for cancellation - while (!token.IsCancellationRequested) - { - // Perform the action that should repeat in the loop - // This could be some mock behavior or just an empty loop depending on the context - } - }) - .Verifiable (Times.Once); - } - - private void SetupRunInputMockMethodToBlock (Mock netInput) - { - netInput.Setup (r => r.Run (It.IsAny ())) - .Callback (token => - { - // Simulate an infinite loop that checks for cancellation - while (!token.IsCancellationRequested) - { - // Perform the action that should repeat in the loop - // This could be some mock behavior or just an empty loop depending on the context - } - }) - .Verifiable (Times.Once); - } - - [Fact] - public void NoInitThrowOnRun () - { - IApplication orig = ApplicationImpl.Instance; - - Assert.Null (Application.Driver); - ApplicationImpl app = NewMockedApplicationImpl (); - ApplicationImpl.ChangeInstance (app); - - var ex = Assert.Throws (() => app.Run (new Window ())); - Assert.Equal ("Run cannot be accessed before Initialization", ex.Message); - app.Shutdown (); - - ApplicationImpl.ChangeInstance (orig); - } - - [Fact] - public void InitRunShutdown_Top_Set_To_Null_After_Shutdown () - { - IApplication orig = ApplicationImpl.Instance; - - ApplicationImpl v2 = NewMockedApplicationImpl (); - ApplicationImpl.ChangeInstance (v2); - - v2.Init (null, "fake"); - - object timeoutToken = v2.AddTimeout ( - TimeSpan.FromMilliseconds (150), - () => - { - if (Application.Top != null) - { - Application.RequestStop (); - - return false; - } - - return false; - } - ); - Assert.Null (Application.Top); - - // Blocks until the timeout call is hit - - v2.Run (new Window ()); - - // We returned false above, so we should not have to remove the timeout - Assert.False (v2.RemoveTimeout (timeoutToken)); - - Assert.NotNull (Application.Top); - Application.Top?.Dispose (); - v2.Shutdown (); - Assert.Null (Application.Top); - - ApplicationImpl.ChangeInstance (orig); - } - - [Fact] - public void InitRunShutdown_Running_Set_To_False () - { - IApplication orig = ApplicationImpl.Instance; - - ApplicationImpl v2 = NewMockedApplicationImpl (); - ApplicationImpl.ChangeInstance (v2); - - v2.Init (null, "fake"); - - Toplevel top = new Window - { - Title = "InitRunShutdown_Running_Set_To_False" - }; - - object timeoutToken = v2.AddTimeout ( - TimeSpan.FromMilliseconds (150), - () => - { - Assert.True (top!.Running); - - if (Application.Top != null) - { - Application.RequestStop (); - - return false; - } - - return false; - } - ); - - Assert.False (top!.Running); - - // Blocks until the timeout call is hit - v2.Run (top); - - // We returned false above, so we should not have to remove the timeout - Assert.False (v2.RemoveTimeout (timeoutToken)); - - Assert.False (top!.Running); - - // BUGBUG: Shutdown sets Top to null, not End. - //Assert.Null (Application.Top); - Application.Top?.Dispose (); - v2.Shutdown (); - - ApplicationImpl.ChangeInstance (orig); - } - - - [Fact] - public void InitRunShutdown_StopAfterFirstIteration_Stops () - { - IApplication orig = ApplicationImpl.Instance; - - ApplicationImpl v2 = NewMockedApplicationImpl (); - ApplicationImpl.ChangeInstance (v2); - - Assert.Null (Application.Top); - Assert.Null (Application.Driver); - - v2.Init (null, "fake"); - - Toplevel top = new Window (); - - var closedCount = 0; - - top.Closed - += (_, a) => { closedCount++; }; - - var unloadedCount = 0; - - top.Unloaded - += (_, a) => { unloadedCount++; }; - - object timeoutToken = v2.AddTimeout ( - TimeSpan.FromMilliseconds (150), - () => - { - Assert.Fail (@"Didn't stop after first iteration."); - return false; - } - ); - - Assert.Equal (0, closedCount); - Assert.Equal (0, unloadedCount); - - v2.StopAfterFirstIteration = true; - v2.Run (top); - - Assert.Equal (1, closedCount); - Assert.Equal (1, unloadedCount); - - Application.Top?.Dispose (); - v2.Shutdown (); - Assert.Equal (1, closedCount); - Assert.Equal (1, unloadedCount); - - ApplicationImpl.ChangeInstance (orig); - } - - - [Fact] - public void InitRunShutdown_End_Is_Called () - { - IApplication orig = ApplicationImpl.Instance; - - ApplicationImpl v2 = NewMockedApplicationImpl (); - ApplicationImpl.ChangeInstance (v2); - - Assert.Null (Application.Top); - Assert.Null (Application.Driver); - - v2.Init (null, "fake"); - - Toplevel top = new Window (); - - // BUGBUG: Both Closed and Unloaded are called from End; what's the difference? - var closedCount = 0; - - top.Closed - += (_, a) => { closedCount++; }; - - var unloadedCount = 0; - - top.Unloaded - += (_, a) => { unloadedCount++; }; - - object timeoutToken = v2.AddTimeout ( - TimeSpan.FromMilliseconds (150), - () => - { - Assert.True (top!.Running); - - if (Application.Top != null) - { - Application.RequestStop (); - - return false; - } - - return false; - } - ); - - Assert.Equal (0, closedCount); - Assert.Equal (0, unloadedCount); - - // Blocks until the timeout call is hit - v2.Run (top); - - Assert.Equal (1, closedCount); - Assert.Equal (1, unloadedCount); - - // We returned false above, so we should not have to remove the timeout - Assert.False (v2.RemoveTimeout (timeoutToken)); - - Application.Top?.Dispose (); - v2.Shutdown (); - Assert.Equal (1, closedCount); - Assert.Equal (1, unloadedCount); - - ApplicationImpl.ChangeInstance (orig); - } - - [Fact] - public void InitRunShutdown_QuitKey_Quits () - { - IApplication orig = ApplicationImpl.Instance; - - ApplicationImpl v2 = NewMockedApplicationImpl (); - ApplicationImpl.ChangeInstance (v2); - - v2.Init (null, "fake"); - - Toplevel top = new Window - { - Title = "InitRunShutdown_QuitKey_Quits" - }; - - object timeoutToken = v2.AddTimeout ( - TimeSpan.FromMilliseconds (150), - () => - { - Assert.True (top!.Running); - - if (Application.Top != null) - { - Application.RaiseKeyDownEvent (Application.QuitKey); - } - - return false; - } - ); - - Assert.False (top!.Running); - - // Blocks until the timeout call is hit - v2.Run (top); - - // We returned false above, so we should not have to remove the timeout - Assert.False (v2.RemoveTimeout (timeoutToken)); - - Assert.False (top!.Running); - - Assert.NotNull (Application.Top); - top.Dispose (); - v2.Shutdown (); - Assert.Null (Application.Top); - - ApplicationImpl.ChangeInstance (orig); - } - - [Fact] - public void InitRunShutdown_Generic_IdleForExit () - { - IApplication orig = ApplicationImpl.Instance; - - ApplicationImpl v2 = NewMockedApplicationImpl (); - ApplicationImpl.ChangeInstance (v2); - - v2.Init (null, "fake"); - - v2.AddTimeout (TimeSpan.Zero, IdleExit); - Assert.Null (Application.Top); - - // Blocks until the timeout call is hit - - v2.Run (); - - Assert.NotNull (Application.Top); - Application.Top?.Dispose (); - v2.Shutdown (); - Assert.Null (Application.Top); - - ApplicationImpl.ChangeInstance (orig); - } - - [Fact] - public void Shutdown_Closing_Closed_Raised () - { - IApplication orig = ApplicationImpl.Instance; - - ApplicationImpl v2 = NewMockedApplicationImpl (); - ApplicationImpl.ChangeInstance (v2); - - v2.Init (null, "fake"); - - var closing = 0; - var closed = 0; - var t = new Toplevel (); - - t.Closing - += (_, a) => - { - // Cancel the first time - if (closing == 0) - { - a.Cancel = true; - } - - closing++; - Assert.Same (t, a.RequestingTop); - }; - - t.Closed - += (_, a) => - { - closed++; - Assert.Same (t, a.Toplevel); - }; - - v2.AddTimeout (TimeSpan.Zero, IdleExit); - - // Blocks until the timeout call is hit - - v2.Run (t); - - Application.Top?.Dispose (); - v2.Shutdown (); - - ApplicationImpl.ChangeInstance (orig); - - Assert.Equal (2, closing); - Assert.Equal (1, closed); - } - - private bool IdleExit () - { - if (Application.Top != null) - { - Application.RequestStop (); - - return true; - } - - return true; - } - /* - [Fact] - public void Shutdown_Called_Repeatedly_DoNotDuplicateDisposeOutput () - { - var orig = ApplicationImpl.Instance; - - var netInput = new Mock (); - SetupRunInputMockMethodToBlock (netInput); - Mock? outputMock = null; - - - var v2 = new ApplicationV2 ( - () => netInput.Object, - () => (outputMock = new Mock ()).Object, - Mock.Of, - Mock.Of); - ApplicationImpl.ChangeInstance (v2); - - v2.Init (null, "v2net"); - - - v2.Shutdown (); - outputMock!.Verify (o => o.Dispose (), Times.Once); - - ApplicationImpl.ChangeInstance (orig); - } - */ - - [Fact] - public void Open_Calls_ContinueWith_On_UIThread () - { - IApplication orig = ApplicationImpl.Instance; - - ApplicationImpl v2 = NewMockedApplicationImpl (); - ApplicationImpl.ChangeInstance (v2); - - v2.Init (null, "fake"); - var b = new Button (); - - var result = false; - - b.Accepting += - (_, _) => - { - Task.Run (() => { Task.Delay (300).Wait (); }) - .ContinueWith ( - (t, _) => - { - // no longer loading - Application.Invoke (() => - { - result = true; - Application.RequestStop (); - }); - }, - TaskScheduler.FromCurrentSynchronizationContext ()); - }; - - v2.AddTimeout ( - TimeSpan.FromMilliseconds (150), - () => - { - // Run asynchronous logic inside Task.Run - if (Application.Top != null) - { - b.NewKeyDownEvent (Key.Enter); - b.NewKeyUpEvent (Key.Enter); - } - - return false; - }); - - Assert.Null (Application.Top); - - var w = new Window - { - Title = "Open_CallsContinueWithOnUIThread" - }; - w.Add (b); - - // Blocks until the timeout call is hit - v2.Run (w); - - Assert.NotNull (Application.Top); - Application.Top?.Dispose (); - v2.Shutdown (); - Assert.Null (Application.Top); - - ApplicationImpl.ChangeInstance (orig); - - Assert.True (result); - } - - [Fact] - public void ApplicationImpl_UsesInstanceFields_NotStaticReferences () - { - // This test verifies that ApplicationImpl uses instance fields instead of static Application references - IApplication orig = ApplicationImpl.Instance; - - ApplicationImpl v2 = NewMockedApplicationImpl (); - ApplicationImpl.ChangeInstance (v2); - - // Before Init, all fields should be null/default - Assert.Null (v2.Driver); - Assert.False (v2.Initialized); - Assert.Null (v2.Popover); - Assert.Null (v2.Navigation); - Assert.Null (v2.Top); - Assert.Empty (v2.TopLevels); - - // Init should populate instance fields - v2.Init (null, "fake"); - - // After Init, Driver, Navigation, and Popover should be populated - Assert.NotNull (v2.Driver); - Assert.True (v2.Initialized); - Assert.NotNull (v2.Popover); - Assert.NotNull (v2.Navigation); - Assert.Null (v2.Top); // Top is still null until Run - - // Verify that static Application properties delegate to instance - Assert.Equal (v2.Driver, Application.Driver); - Assert.Equal (v2.Initialized, Application.Initialized); - Assert.Equal (v2.Popover, Application.Popover); - Assert.Equal (v2.Navigation, Application.Navigation); - Assert.Equal (v2.Top, Application.Top); - Assert.Same (v2.TopLevels, Application.TopLevels); - - // Shutdown should clean up instance fields - v2.Shutdown (); - - Assert.Null (v2.Driver); - Assert.False (v2.Initialized); - Assert.Null (v2.Popover); - Assert.Null (v2.Navigation); - Assert.Null (v2.Top); - Assert.Empty (v2.TopLevels); - - ApplicationImpl.ChangeInstance (orig); - } -} diff --git a/Tests/UnitTests/Application/ApplicationModelFencingTests.cs b/Tests/UnitTests/Application/ApplicationModelFencingTests.cs new file mode 100644 index 000000000..f133c3db4 --- /dev/null +++ b/Tests/UnitTests/Application/ApplicationModelFencingTests.cs @@ -0,0 +1,169 @@ +namespace UnitTests.ApplicationTests; + +/// +/// Tests to ensure that mixing legacy static Application and modern instance-based models +/// throws appropriate exceptions. +/// +public class ApplicationModelFencingTests +{ + [Fact] + public void Create_ThenInstanceAccess_ThrowsInvalidOperationException () + { + // Reset the model usage tracking before each test + ApplicationImpl.ResetModelUsageTracking (); + + // Create a modern instance-based application + IApplication app = Application.Create (); + app.Init ("fake"); + + // Attempting to initialize using the legacy static model should throw + var ex = Assert.Throws (() => { ApplicationImpl.Instance.Init ("fake"); }); + + Assert.Contains ("Cannot use legacy static Application model", ex.Message); + Assert.Contains ("after using modern instance-based model", ex.Message); + + // Clean up + app.Dispose (); + ApplicationImpl.ResetModelUsageTracking (); + } + + [Fact] + public void InstanceAccess_ThenCreate_ThrowsInvalidOperationException () + { + // Reset the model usage tracking before each test + ApplicationImpl.ResetModelUsageTracking (); + + // Initialize using the legacy static model + IApplication staticInstance = ApplicationImpl.Instance; + staticInstance.Init ("fake"); + + // Attempting to create and initialize with modern instance-based model should throw + var ex = Assert.Throws (() => + { + IApplication app = Application.Create (); + app.Init ("fake"); + }); + + Assert.Contains ("Cannot use modern instance-based model", ex.Message); + Assert.Contains ("after using legacy static Application model", ex.Message); + + // Clean up + staticInstance.Dispose (); + ApplicationImpl.ResetModelUsageTracking (); + } + + [Fact] + public void Init_ThenCreate_ThrowsInvalidOperationException () + { + // Reset the model usage tracking before each test + ApplicationImpl.ResetModelUsageTracking (); + + // Initialize using legacy static API + IApplication staticInstance = ApplicationImpl.Instance; + staticInstance.Init ("fake"); + + // Attempting to create a modern instance-based application should throw + var ex = Assert.Throws (() => + { + IApplication _ = Application.Create (); + }); + + Assert.Contains ("Cannot use modern instance-based model", ex.Message); + Assert.Contains ("after using legacy static Application model", ex.Message); + + // Clean up + staticInstance.Dispose (); + ApplicationImpl.ResetModelUsageTracking (); + } + + [Fact] + public void Create_ThenInit_ThrowsInvalidOperationException () + { + // Reset the model usage tracking before each test + ApplicationImpl.ResetModelUsageTracking (); + + // Create a modern instance-based application + IApplication app = Application.Create (); + app.Init ("fake"); + + // Attempting to initialize using the legacy static model should throw + var ex = Assert.Throws (() => { ApplicationImpl.Instance.Init ("fake"); }); + + Assert.Contains ("Cannot use legacy static Application model", ex.Message); + Assert.Contains ("after using modern instance-based model", ex.Message); + + // Clean up + app.Dispose (); + ApplicationImpl.ResetModelUsageTracking (); + } + + [Fact] + public void MultipleCreate_Calls_DoNotThrow () + { + // Reset the model usage tracking before each test + ApplicationImpl.ResetModelUsageTracking (); + + // Multiple calls to Create should not throw + IApplication app1 = Application.Create (); + IApplication app2 = Application.Create (); + IApplication app3 = Application.Create (); + + Assert.NotNull (app1); + Assert.NotNull (app2); + Assert.NotNull (app3); + + // Clean up + app1.Dispose (); + app2.Dispose (); + app3.Dispose (); + ApplicationImpl.ResetModelUsageTracking (); + } + + [Fact] + public void MultipleInstanceAccess_DoesNotThrow () + { + // Reset the model usage tracking before each test + ApplicationImpl.ResetModelUsageTracking (); + + // Multiple accesses to Instance should not throw (it's a singleton) + IApplication instance1 = ApplicationImpl.Instance; + IApplication instance2 = ApplicationImpl.Instance; + IApplication instance3 = ApplicationImpl.Instance; + + Assert.NotNull (instance1); + Assert.Same (instance1, instance2); + Assert.Same (instance2, instance3); + + // Clean up + instance1.Dispose (); + ApplicationImpl.ResetModelUsageTracking (); + } + + [Fact] + public void ResetModelUsageTracking_AllowsSwitchingModels () + { + // Reset the model usage tracking before each test + ApplicationImpl.ResetModelUsageTracking (); + + // Use modern model + IApplication app1 = Application.Create (); + app1.Dispose (); + + // Reset the tracking + ApplicationImpl.ResetModelUsageTracking (); + + // Should now be able to use legacy model + IApplication staticInstance = ApplicationImpl.Instance; + Assert.NotNull (staticInstance); + staticInstance.Dispose (); + + // Reset again + ApplicationImpl.ResetModelUsageTracking (); + + // Should be able to use modern model again + IApplication app2 = Application.Create (); + Assert.NotNull (app2); + app2.Dispose (); + ApplicationImpl.ResetModelUsageTracking (); + } +} diff --git a/Tests/UnitTests/Application/ApplicationPopoverTests.cs b/Tests/UnitTests/Application/ApplicationPopoverTests.cs index 9cee1ed7c..6056bee16 100644 --- a/Tests/UnitTests/Application/ApplicationPopoverTests.cs +++ b/Tests/UnitTests/Application/ApplicationPopoverTests.cs @@ -9,15 +9,14 @@ public class ApplicationPopoverTests try { // Arrange - Assert.Null (Application.Popover); - Application.Init (null, "fake"); + Application.Init ("fake"); // Act Assert.NotNull (Application.Popover); } finally { - Application.ResetState (true); + Application.Shutdown (); } } @@ -27,8 +26,8 @@ public class ApplicationPopoverTests try { // Arrange - Assert.Null (Application.Popover); - Application.Init (null, "fake"); + + Application.Init ("fake"); // Act Assert.NotNull (Application.Popover); @@ -36,28 +35,26 @@ public class ApplicationPopoverTests Application.Shutdown (); // Test - Assert.Null (Application.Popover); } finally { - Application.ResetState (true); + Application.Shutdown (); } } [Fact] public void Application_End_Does_Not_Reset_PopoverManager () { - Toplevel? top = null; + Runnable? top = null; try { // Arrange - Assert.Null (Application.Popover); - Application.Init (null, "fake"); + Application.Init ("fake"); Assert.NotNull (Application.Popover); Application.StopAfterFirstIteration = true; - top = new Toplevel (); + top = new (); SessionToken rs = Application.Begin (top); // Act @@ -69,27 +66,27 @@ public class ApplicationPopoverTests finally { top?.Dispose (); - Application.ResetState (true); + Application.Shutdown (); } } [Fact] public void Application_End_Hides_Active () { - Toplevel? top = null; + Runnable? top = null; try { // Arrange - Assert.Null (Application.Popover); - Application.Init (null, "fake"); + Application.Init ("fake"); Application.StopAfterFirstIteration = true; - top = new Toplevel (); + top = new (); SessionToken rs = Application.Begin (top); PopoverTestClass? popover = new (); + Application.Popover?.Register (popover); Application.Popover?.Show (popover); Assert.True (popover.Visible); @@ -106,7 +103,7 @@ public class ApplicationPopoverTests finally { top?.Dispose (); - Application.ResetState (true); + Application.Shutdown (); } } @@ -116,8 +113,8 @@ public class ApplicationPopoverTests try { // Arrange - Assert.Null (Application.Popover); - Application.Init (null, "fake"); + + Application.Init ("fake"); PopoverTestClass? popover = new (); @@ -130,7 +127,7 @@ public class ApplicationPopoverTests } finally { - Application.ResetState (true); + Application.Shutdown (); } } @@ -140,8 +137,8 @@ public class ApplicationPopoverTests try { // Arrange - Assert.Null (Application.Popover); - Application.Init (null, "fake"); + + Application.Init ("fake"); PopoverTestClass? popover = new (); @@ -159,7 +156,7 @@ public class ApplicationPopoverTests } finally { - Application.ResetState (true); + Application.Shutdown (); } } @@ -169,11 +166,11 @@ public class ApplicationPopoverTests try { // Arrange - Assert.Null (Application.Popover); - Application.Init (null, "fake"); + + Application.Init ("fake"); PopoverTestClass? popover = new (); - + Application.Popover?.Register (popover); Application.Popover?.Show (popover); Application.Popover?.DeRegister (popover); @@ -188,57 +185,62 @@ public class ApplicationPopoverTests } finally { - Application.ResetState (true); + Application.Shutdown (); } } [Fact] - public void Register_SetsTopLevel () + public void Register_SetsRunnable () { try { // Arrange - Assert.Null (Application.Popover); - Application.Init (null, "fake"); - Application.Top = new Toplevel (); + + Application.Init ("fake"); + Application.Begin (new Runnable ()); PopoverTestClass? popover = new (); // Act Application.Popover?.Register (popover); // Assert - Assert.Equal (Application.Top, popover.Toplevel); + Assert.Equal (Application.TopRunnableView as IRunnable, popover.Current); } finally { - Application.ResetState (true); + Application.TopRunnableView?.Dispose (); + Application.Shutdown (); } } [Fact] - public void Keyboard_Events_Go_Only_To_Popover_Associated_With_Toplevel () + public void Keyboard_Events_Go_Only_To_Popover_Associated_With_Runnable () { try { // Arrange - Assert.Null (Application.Popover); - Application.Init (null, "fake"); - Application.Top = new Toplevel () { Id = "initialTop" }; + Application.Init ("fake"); + + Runnable? initialRunnable = new () { Id = "initialRunnable" }; + Application.Begin (initialRunnable); PopoverTestClass? popover = new (); - int keyDownEvents = 0; + var keyDownEvents = 0; + popover.KeyDown += (s, e) => - { - keyDownEvents++; - e.Handled = true; - }; // Ensure it handles the key + { + keyDownEvents++; + e.Handled = true; + }; // Ensure it handles the key Application.Popover?.Register (popover); // Act - Application.RaiseKeyDownEvent (Key.A); // Goes to initialTop + Application.RaiseKeyDownEvent (Key.A); // Goes to initialRunnable - Application.Top = new Toplevel () { Id = "secondaryTop" }; - Application.RaiseKeyDownEvent (Key.A); // Goes to secondaryTop + Runnable? secondaryRunnable = new () { Id = "secondaryRunnable" }; + Application.Begin (secondaryRunnable); + + Application.RaiseKeyDownEvent (Key.A); // Goes to secondaryRunnable // Test Assert.Equal (1, keyDownEvents); @@ -248,19 +250,19 @@ public class ApplicationPopoverTests } finally { - Application.ResetState (true); + Application.Shutdown (); } } // See: https://github.com/gui-cs/Terminal.Gui/issues/4122 [Theory] - [InlineData (0, 0, new [] { "top" })] + [InlineData (0, 0, new [] { "runnable" })] [InlineData (10, 10, new string [] { })] - [InlineData (1, 1, new [] { "top", "view" })] - [InlineData (5, 5, new [] { "top" })] + [InlineData (1, 1, new [] { "runnable", "view" })] + [InlineData (5, 5, new [] { "runnable" })] [InlineData (6, 6, new [] { "popoverSubView" })] - [InlineData (7, 7, new [] { "top" })] - [InlineData (3, 3, new [] { "top" })] + [InlineData (7, 7, new [] { "runnable" })] + [InlineData (3, 3, new [] { "runnable" })] public void GetViewsUnderMouse_Supports_ActivePopover (int mouseX, int mouseY, string [] viewIdStrings) { PopoverTestClass? popover = null; @@ -268,13 +270,14 @@ public class ApplicationPopoverTests try { // Arrange - Assert.Null (Application.Popover); - Application.Init (null, "fake"); - Application.Top = new () + Application.Init ("fake"); + + Runnable? runnable = new () { Frame = new (0, 0, 10, 10), - Id = "top" + Id = "runnable" }; + Application.Begin (runnable); View? view = new () { @@ -282,10 +285,10 @@ public class ApplicationPopoverTests X = 1, Y = 1, Width = 2, - Height = 2, + Height = 2 }; - Application.Top.Add (view); + runnable.Add (view); popover = new () { @@ -293,7 +296,7 @@ public class ApplicationPopoverTests X = 5, Y = 5, Width = 3, - Height = 3, + Height = 3 }; // at 5,5 to 8,8 (screen) View? popoverSubView = new () @@ -302,14 +305,15 @@ public class ApplicationPopoverTests X = 1, Y = 1, Width = 1, - Height = 1, + Height = 1 }; popover.Add (popoverSubView); + Application.Popover?.Register (popover); Application.Popover?.Show (popover); - List found = View.GetViewsUnderLocation (new (mouseX, mouseY), ViewportSettingsFlags.TransparentMouse); + List found = view.GetViewsUnderLocation (new (mouseX, mouseY), ViewportSettingsFlags.TransparentMouse); string [] foundIds = found.Select (v => v!.Id).ToArray (); @@ -318,8 +322,7 @@ public class ApplicationPopoverTests finally { popover?.Dispose (); - Application.Top?.Dispose (); - Application.ResetState (true); + Application.Shutdown (); } } @@ -361,4 +364,4 @@ public class ApplicationPopoverTests DisposedCount++; } } -} \ No newline at end of file +} diff --git a/Tests/UnitTests/Application/ApplicationScreenTests.cs b/Tests/UnitTests/Application/ApplicationScreenTests.cs index fd4f27be8..30fe51a5f 100644 --- a/Tests/UnitTests/Application/ApplicationScreenTests.cs +++ b/Tests/UnitTests/Application/ApplicationScreenTests.cs @@ -1,39 +1,18 @@ -using UnitTests; -using Xunit.Abstractions; +using Xunit.Abstractions; namespace UnitTests.ApplicationTests; public class ApplicationScreenTests { - public ApplicationScreenTests (ITestOutputHelper output) - { - } - - - [Fact] - public void ClearScreenNextIteration_Resets_To_False_After_LayoutAndDraw () - { - // Arrange - Application.ResetState (true); - Application.Init (null, "fake"); - - // Act - Application.ClearScreenNextIteration = true; - Application.LayoutAndDraw (); - - // Assert - Assert.False (Application.ClearScreenNextIteration); - - // Cleanup - Application.ResetState (true); - } + public ApplicationScreenTests (ITestOutputHelper output) { } [Fact] [AutoInitShutdown] public void ClearContents_Called_When_Top_Frame_Changes () { - Toplevel top = new Toplevel (); + var top = new Runnable (); SessionToken rs = Application.Begin (top); + // Arrange var clearedContentsRaised = 0; @@ -46,35 +25,35 @@ public class ApplicationScreenTests Assert.Equal (0, clearedContentsRaised); // Act - Application.Top!.SetNeedsLayout (); + Application.TopRunnableView!.SetNeedsLayout (); Application.LayoutAndDraw (); // Assert Assert.Equal (0, clearedContentsRaised); // Act - Application.Top.X = 1; + Application.TopRunnableView.X = 1; Application.LayoutAndDraw (); // Assert Assert.Equal (1, clearedContentsRaised); // Act - Application.Top.Width = 10; + Application.TopRunnableView.Width = 10; Application.LayoutAndDraw (); // Assert Assert.Equal (2, clearedContentsRaised); // Act - Application.Top.Y = 1; + Application.TopRunnableView.Y = 1; Application.LayoutAndDraw (); // Assert Assert.Equal (3, clearedContentsRaised); // Act - Application.Top.Height = 10; + Application.TopRunnableView.Height = 10; Application.LayoutAndDraw (); // Assert @@ -89,6 +68,24 @@ public class ApplicationScreenTests void OnClearedContents (object e, EventArgs a) { clearedContentsRaised++; } } + [Fact] + public void ClearScreenNextIteration_Resets_To_False_After_LayoutAndDraw () + { + // Arrange + Application.ResetState (true); + Application.Init ("fake"); + + // Act + Application.ClearScreenNextIteration = true; + Application.LayoutAndDraw (); + + // Assert + Assert.False (Application.ClearScreenNextIteration); + + // Cleanup + Application.ResetState (true); + } + [Fact] [SetupFakeApplication] public void Screen_Changes_OnScreenChanged_Without_Call_Application_Init () diff --git a/Tests/UnitTests/Application/ApplicationTests.cs b/Tests/UnitTests/Application/ApplicationTests.cs deleted file mode 100644 index a0909f551..000000000 --- a/Tests/UnitTests/Application/ApplicationTests.cs +++ /dev/null @@ -1,1017 +0,0 @@ -using System.Diagnostics; -using Xunit.Abstractions; -using static Terminal.Gui.Configuration.ConfigurationManager; - -// Alias Console to MockConsole so we don't accidentally use Console - -namespace UnitTests.ApplicationTests; - -public class ApplicationTests -{ - public ApplicationTests (ITestOutputHelper output) - { - _output = output; - -#if DEBUG_IDISPOSABLE - View.EnableDebugIDisposableAsserts = true; - View.Instances.Clear (); - SessionToken.Instances.Clear (); -#endif - } - - private readonly ITestOutputHelper _output; - - private object _timeoutLock; - - [Fact (Skip = "Hangs with SetupFakeApplication")] - [SetupFakeApplication] - public void AddTimeout_Fires () - { - Assert.Null (_timeoutLock); - _timeoutLock = new (); - - uint timeoutTime = 250; - var initialized = false; - var iteration = 0; - var shutdown = false; - object timeout = null; - var timeoutCount = 0; - - Application.InitializedChanged += OnApplicationOnInitializedChanged; - - _output.WriteLine ("Application.Run ().Dispose ().."); - Application.Run ().Dispose (); - _output.WriteLine ("Back from Application.Run ().Dispose ()"); - - Assert.True (initialized); - Assert.False (shutdown); - - Assert.Equal (1, timeoutCount); - Application.Shutdown (); - - Application.InitializedChanged -= OnApplicationOnInitializedChanged; - - lock (_timeoutLock) - { - if (timeout is { }) - { - Application.RemoveTimeout (timeout); - timeout = null; - } - } - - Assert.True (initialized); - Assert.True (shutdown); - -#if DEBUG_IDISPOSABLE - Assert.Empty (View.Instances); -#endif - lock (_timeoutLock) - { - _timeoutLock = null; - } - - return; - - void OnApplicationOnInitializedChanged (object s, EventArgs a) - { - if (a.Value) - { - Application.Iteration += OnApplicationOnIteration; - initialized = true; - - lock (_timeoutLock) - { - _output.WriteLine ($"Setting timeout for {timeoutTime}ms"); - timeout = Application.AddTimeout (TimeSpan.FromMilliseconds (timeoutTime), TimeoutCallback); - } - } - else - { - Application.Iteration -= OnApplicationOnIteration; - shutdown = true; - } - } - - bool TimeoutCallback () - { - lock (_timeoutLock) - { - _output.WriteLine ($"TimeoutCallback. Count: {++timeoutCount}. Application Iteration: {iteration}"); - - if (timeout is { }) - { - _output.WriteLine (" Nulling timeout."); - timeout = null; - } - } - - // False means "don't re-do timer and remove it" - return false; - } - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - lock (_timeoutLock) - { - if (timeoutCount > 0) - { - _output.WriteLine ($"Iteration #{iteration} - Timeout fired. Calling Application.RequestStop."); - Application.RequestStop (); - - return; - } - } - - iteration++; - - // Simulate a delay - Thread.Sleep ((int)timeoutTime / 10); - - // Worst case scenario - something went wrong - if (Application.Initialized && iteration > 25) - { - _output.WriteLine ($"Too many iterations ({iteration}): Calling Application.RequestStop."); - Application.RequestStop (); - } - } - } - - [Fact] - [SetupFakeApplication] - public void Begin_Null_Toplevel_Throws () - { - // Test null Toplevel - Assert.Throws (() => Application.Begin (null)); - } - - [Fact] - [SetupFakeApplication] - public void Begin_Sets_Application_Top_To_Console_Size () - { - Assert.Null (Application.Top); - Application.Driver!.SetScreenSize (80, 25); - Toplevel top = new (); - Application.Begin (top); - Assert.Equal (new (0, 0, 80, 25), Application.Top!.Frame); - Application.Driver!.SetScreenSize (5, 5); - Assert.Equal (new (0, 0, 5, 5), Application.Top!.Frame); - top.Dispose (); - } - - [Fact] - [SetupFakeApplication] - public void End_And_Shutdown_Should_Not_Dispose_ApplicationTop () - { - Assert.Null (Application.Top); - - SessionToken rs = Application.Begin (new ()); - Application.Top!.Title = "End_And_Shutdown_Should_Not_Dispose_ApplicationTop"; - Assert.Equal (rs.Toplevel, Application.Top); - Application.End (rs); - -#if DEBUG_IDISPOSABLE - Assert.True (rs.WasDisposed); - Assert.False (Application.Top!.WasDisposed); // Is true because the rs.Toplevel is the same as Application.Top -#endif - - Assert.Null (rs.Toplevel); - - Toplevel top = Application.Top; - -#if DEBUG_IDISPOSABLE - Exception exception = Record.Exception (Application.Shutdown); - Assert.NotNull (exception); - Assert.False (top.WasDisposed); - top.Dispose (); - Assert.True (top.WasDisposed); -#endif - } - - [Fact] - [SetupFakeApplication] - public void Init_Begin_End_Cleans_Up () - { - // Start stopwatch - var stopwatch = new Stopwatch (); - stopwatch.Start (); - - SessionToken sessionToken = null; - - EventHandler newSessionTokenFn = (s, e) => - { - Assert.NotNull (e.State); - sessionToken = e.State; - }; - Application.SessionBegun += newSessionTokenFn; - - var topLevel = new Toplevel (); - SessionToken rs = Application.Begin (topLevel); - Assert.NotNull (rs); - Assert.NotNull (sessionToken); - Assert.Equal (rs, sessionToken); - - Assert.Equal (topLevel, Application.Top); - - Application.SessionBegun -= newSessionTokenFn; - Application.End (sessionToken); - - Assert.NotNull (Application.Top); - Assert.NotNull (Application.Driver); - - topLevel.Dispose (); - - // Stop stopwatch - stopwatch.Stop (); - - _output.WriteLine ($"Load took {stopwatch.ElapsedMilliseconds} ms"); - } - - [Fact] - public void Init_KeyBindings_Are_Not_Reset () - { - Debug.Assert (!IsEnabled); - - try - { - // arrange - ThrowOnJsonErrors = true; - - Application.QuitKey = Key.Q; - Assert.Equal (Key.Q, Application.QuitKey); - - Application.Init (null, "fake"); - - Assert.Equal (Key.Q, Application.QuitKey); - } - finally - { - Application.ResetState (); - } - } - - [Fact] - public void Init_NoParam_ForceDriver_Works () - { - Application.ForceDriver = "Fake"; - Application.Init (); - - Assert.Equal ("fake", Application.Driver!.GetName ()); - Application.ResetState (); - } - - - [Fact] - public void Init_Null_Driver_Should_Pick_A_Driver () - { - Application.Init (); - - Assert.NotNull (Application.Driver); - - Application.Shutdown (); - } - - [Fact] - public void Init_ResetState_Resets_Properties () - { - ThrowOnJsonErrors = true; - - // For all the fields/properties of Application, check that they are reset to their default values - - // Set some values - - Application.Init (driverName: "fake"); - - // Application.IsInitialized = true; - - // Reset - Application.ResetState (); - - CheckReset (); - - // Set the values that can be set - Application.Initialized = true; - Application.MainThreadId = 1; - - //Application._topLevels = new List (); - Application.CachedViewsUnderMouse.Clear (); - - //Application.SupportedCultures = new List (); - Application.Force16Colors = true; - - //Application.ForceDriver = "driver"; - Application.StopAfterFirstIteration = true; - Application.PrevTabGroupKey = Key.A; - Application.NextTabGroupKey = Key.B; - Application.QuitKey = Key.C; - Application.KeyBindings.Add (Key.D, Command.Cancel); - - Application.CachedViewsUnderMouse.Clear (); - - //Application.WantContinuousButtonPressedView = new View (); - - // Mouse - Application.LastMousePosition = new Point (1, 1); - - Application.Navigation = new (); - - Application.ResetState (); - CheckReset (); - - ThrowOnJsonErrors = false; - - return; - - void CheckReset () - { - // Check that all fields and properties are set to their default values - - // Public Properties - Assert.Null (Application.Top); - Assert.Null (Application.Mouse.MouseGrabView); - - // Don't check Application.ForceDriver - // Assert.Empty (Application.ForceDriver); - // Don't check Application.Force16Colors - //Assert.False (Application.Force16Colors); - Assert.Null (Application.Driver); - Assert.False (Application.StopAfterFirstIteration); - - // Commented out because if CM changed the defaults, those changes should - // persist across Inits. - //Assert.Equal (Key.Tab.WithShift, Application.PrevTabKey); - //Assert.Equal (Key.Tab, Application.NextTabKey); - //Assert.Equal (Key.F6.WithShift, Application.PrevTabGroupKey); - //Assert.Equal (Key.F6, Application.NextTabGroupKey); - //Assert.Equal (Key.Esc, Application.QuitKey); - - // Internal properties - Assert.False (Application.Initialized); - Assert.Equal (Application.GetSupportedCultures (), Application.SupportedCultures); - Assert.Equal (Application.GetAvailableCulturesFromEmbeddedResources (), Application.SupportedCultures); - Assert.Null (Application.MainThreadId); - Assert.Empty (Application.TopLevels); - Assert.Empty (Application.CachedViewsUnderMouse); - - // Mouse - // Do not reset _lastMousePosition - //Assert.Null (Application._lastMousePosition); - - // Navigation - Assert.Null (Application.Navigation); - - // Popover - Assert.Null (Application.Popover); - - // Events - Can't check - //Assert.Null (GetEventSubscribers (typeof (Application), "InitializedChanged")); - //Assert.Null (GetEventSubscribers (typeof (Application), "SessionBegun")); - //Assert.Null (GetEventSubscribers (typeof (Application), "Iteration")); - //Assert.Null (GetEventSubscribers (typeof (Application), "ScreenChanged")); - //Assert.Null (GetEventSubscribers (typeof (Application.Mouse), "MouseEvent")); - //Assert.Null (GetEventSubscribers (typeof (Application.Keyboard), "KeyDown")); - //Assert.Null (GetEventSubscribers (typeof (Application.Keyboard), "KeyUp")); - } - } - - [Fact] - public void Init_Shutdown_Cleans_Up () - { - // Verify initial state is per spec - //Pre_Init_State (); - - Application.Init (null, "fake"); - - // Verify post-Init state is correct - //Post_Init_State (); - - Application.Shutdown (); - - // Verify state is back to initial - //Pre_Init_State (); -#if DEBUG_IDISPOSABLE - - // Validate there are no outstanding Responder-based instances - // after a scenario was selected to run. This proves the main UI Catalog - // 'app' closed cleanly. - Assert.Empty (View.Instances); -#endif - } - - [Fact] - public void Init_Shutdown_Fire_InitializedChanged () - { - var initialized = false; - var shutdown = false; - - Application.InitializedChanged += OnApplicationOnInitializedChanged; - - Application.Init (driverName: "fake"); - Assert.True (initialized); - Assert.False (shutdown); - - Application.Shutdown (); - Assert.True (initialized); - Assert.True (shutdown); - - Application.InitializedChanged -= OnApplicationOnInitializedChanged; - - return; - - void OnApplicationOnInitializedChanged (object s, EventArgs a) - { - if (a.Value) - { - initialized = true; - } - else - { - shutdown = true; - } - } - } - - [Fact] - [SetupFakeApplication] - public void Init_Unbalanced_Throws () - { - Assert.Throws (() => - Application.Init (null, "fake") - ); - } - - [Fact] - [SetupFakeApplication] - public void Init_Unbalanced_Throws2 () - { - // Now try the other way - Assert.Throws (() => Application.Init (null, "fake")); - } - - [Fact] - public void Init_WithoutTopLevelFactory_Begin_End_Cleans_Up () - { - Application.StopAfterFirstIteration = true; - - // NOTE: Run, when called after Init has been called behaves differently than - // when called if Init has not been called. - Toplevel topLevel = new (); - Application.Init (null, "fake"); - - SessionToken sessionToken = null; - - EventHandler newSessionTokenFn = (s, e) => - { - Assert.NotNull (e.State); - sessionToken = e.State; - }; - Application.SessionBegun += newSessionTokenFn; - - SessionToken rs = Application.Begin (topLevel); - Assert.NotNull (rs); - Assert.NotNull (sessionToken); - Assert.Equal (rs, sessionToken); - - Assert.Equal (topLevel, Application.Top); - - Application.SessionBegun -= newSessionTokenFn; - Application.End (sessionToken); - - Assert.NotNull (Application.Top); - Assert.NotNull (Application.Driver); - - topLevel.Dispose (); - Application.Shutdown (); - - Assert.Null (Application.Top); - Assert.Null (Application.Driver); - } - - [Fact] - [SetupFakeApplication] - public void Internal_Properties_Correct () - { - Assert.True (Application.Initialized); - Assert.Null (Application.Top); - SessionToken rs = Application.Begin (new ()); - Assert.Equal (Application.Top, rs.Toplevel); - Assert.Null (Application.Mouse.MouseGrabView); // public - Application.Top!.Dispose (); - } - - // Invoke Tests - // TODO: Test with threading scenarios - [Fact] - [SetupFakeApplication] - public void Invoke_Adds_Idle () - { - Toplevel top = new (); - SessionToken rs = Application.Begin (top); - - var actionCalled = 0; - Application.Invoke (() => { actionCalled++; }); - Application.TimedEvents!.RunTimers (); - Assert.Equal (1, actionCalled); - top.Dispose (); - } - - [Fact] - public void Run_Iteration_Fires () - { - var iteration = 0; - - Application.Init (null, "fake"); - - Application.Iteration += Application_Iteration; - Application.Run ().Dispose (); - Application.Iteration -= Application_Iteration; - - Assert.Equal (1, iteration); - Application.Shutdown (); - - return; - - void Application_Iteration (object sender, IterationEventArgs e) - { - if (iteration > 0) - { - Assert.Fail (); - } - - iteration++; - Application.RequestStop (); - } - } - - [Fact] - [SetupFakeApplication] - public void Screen_Size_Changes () - { - IDriver driver = Application.Driver; - - Application.Driver!.SetScreenSize (80, 25); - - Assert.Equal (new (0, 0, 80, 25), driver!.Screen); - Assert.Equal (new (0, 0, 80, 25), Application.Screen); - - // TODO: Should not be possible to manually change these at whim! - driver.Cols = 100; - driver.Rows = 30; - - // IDriver.Screen isn't assignable - //driver.Screen = new (0, 0, driver.Cols, Rows); - - Application.Driver!.SetScreenSize (100, 30); - - Assert.Equal (new (0, 0, 100, 30), driver.Screen); - - // Assert does not make sense - // Assert.NotEqual (new (0, 0, 100, 30), Application.Screen); - // Assert.Equal (new (0, 0, 80, 25), Application.Screen); - Application.Screen = new (0, 0, driver.Cols, driver.Rows); - Assert.Equal (new (0, 0, 100, 30), driver.Screen); - } - - [Fact] - public void Shutdown_Alone_Does_Nothing () { Application.Shutdown (); } - - //[Fact] - //public void InitState_Throws_If_Driver_Is_Null () - //{ - // Assert.Throws (static () => Application.SubscribeDriverEvents ()); - //} - - #region RunTests - - [Fact] - [SetupFakeApplication] - public void Run_T_After_InitWithDriver_with_TopLevel_Does_Not_Throws () - { - Application.StopAfterFirstIteration = true; - - // Run when already initialized or not with a Driver will not throw (because Window is derived from Toplevel) - // Using another type not derived from Toplevel will throws at compile time - Application.Run (); - Assert.True (Application.Top is Window); - - Application.Top!.Dispose (); - } - - [Fact] - public void Run_T_After_InitWithDriver_with_TopLevel_and_Driver_Does_Not_Throws () - { - Application.StopAfterFirstIteration = true; - - // Run when already initialized or not with a Driver will not throw (because Window is derived from Toplevel) - // Using another type not derived from Toplevel will throws at compile time - Application.Run (null, "fake"); - Assert.True (Application.Top is Window); - - Application.Top!.Dispose (); - - // Run when already initialized or not with a Driver will not throw (because Dialog is derived from Toplevel) - Application.Run (null, "fake"); - Assert.True (Application.Top is Dialog); - - Application.Top!.Dispose (); - Application.Shutdown (); - } - - [Fact] - [SetupFakeApplication] - public void Run_T_After_Init_Does_Not_Disposes_Application_Top () - { - // Init doesn't create a Toplevel and assigned it to Application.Top - // but Begin does - var initTop = new Toplevel (); - - Application.Iteration += OnApplicationOnIteration; - - Application.Run (); - Application.Iteration -= OnApplicationOnIteration; - -#if DEBUG_IDISPOSABLE - Assert.False (initTop.WasDisposed); - initTop.Dispose (); - Assert.True (initTop.WasDisposed); -#endif - Application.Top!.Dispose (); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - Assert.NotEqual (initTop, Application.Top); -#if DEBUG_IDISPOSABLE - Assert.False (initTop.WasDisposed); -#endif - Application.RequestStop (); - } - } - - [Fact] - [SetupFakeApplication] - public void Run_T_After_InitWithDriver_with_TestTopLevel_DoesNotThrow () - { - Application.StopAfterFirstIteration = true; - - // Init has been called and we're passing no driver to Run. This is ok. - Application.Run (); - - Application.Top!.Dispose (); - } - - [Fact] - [SetupFakeApplication] - public void Run_T_After_InitNullDriver_with_TestTopLevel_DoesNotThrow () - { - Application.StopAfterFirstIteration = true; - - // Init has been called, selecting FakeDriver; we're passing no driver to Run. Should be fine. - Application.Run (); - - Application.Top!.Dispose (); - } - - [Fact] - [SetupFakeApplication] - public void Run_T_Init_Driver_Cleared_with_TestTopLevel_Throws () - { - Application.Driver = null; - - // Init has been called, but Driver has been set to null. Bad. - Assert.Throws (() => Application.Run ()); - } - - [Fact] - [SetupFakeApplication] - public void Run_T_NoInit_DoesNotThrow () - { - Application.StopAfterFirstIteration = true; - - Application.Run ().Dispose (); - } - - [Fact] - [SetupFakeApplication] - public void Run_T_NoInit_WithDriver_DoesNotThrow () - { - Application.StopAfterFirstIteration = true; - - // Init has NOT been called and we're passing a valid driver to Run. This is ok. - Application.Run (null, "fake"); - - Application.Top!.Dispose (); - } - - [Fact] - [SetupFakeApplication] - public void Run_RequestStop_Stops () - { - var top = new Toplevel (); - SessionToken rs = Application.Begin (top); - Assert.NotNull (rs); - - Application.Iteration += OnApplicationOnIteration; - Application.Run (top); - Application.Iteration -= OnApplicationOnIteration; - - top.Dispose (); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) { Application.RequestStop (); } - } - - [Fact] - [SetupFakeApplication] - public void Run_Sets_Running_True () - { - var top = new Toplevel (); - SessionToken rs = Application.Begin (top); - Assert.NotNull (rs); - - Application.Iteration += OnApplicationOnIteration; - Application.Run (top); - Application.Iteration -= OnApplicationOnIteration; - - top.Dispose (); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - Assert.True (top.Running); - top.Running = false; - } - } - - [Fact] - [SetupFakeApplication] - public void Run_RunningFalse_Stops () - { - var top = new Toplevel (); - SessionToken rs = Application.Begin (top); - Assert.NotNull (rs); - - Application.Iteration += OnApplicationOnIteration; - Application.Run (top); - Application.Iteration -= OnApplicationOnIteration; - - top.Dispose (); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) { top.Running = false; } - } - - [Fact] - [SetupFakeApplication] - public void Run_Loaded_Ready_Unloaded_Events () - { - Application.StopAfterFirstIteration = true; - - Toplevel top = new (); - var count = 0; - top.Loaded += (s, e) => count++; - top.Ready += (s, e) => count++; - top.Unloaded += (s, e) => count++; - Application.Run (top); - top.Dispose (); - } - - // TODO: All Toplevel layout tests should be moved to ToplevelTests.cs - [Fact] - [SetupFakeApplication] - public void Run_A_Modal_Toplevel_Refresh_Background_On_Moving () - { - // Don't use Dialog here as it has more layout logic. Use Window instead. - var w = new Window - { - Width = 5, Height = 5, - Arrangement = ViewArrangement.Movable - }; - Application.Driver!.SetScreenSize (10, 10); - SessionToken rs = Application.Begin (w); - - // Don't use visuals to test as style of border can change over time. - Assert.Equal (new (0, 0), w.Frame.Location); - - Application.RaiseMouseEvent (new () { Flags = MouseFlags.Button1Pressed }); - Assert.Equal (w.Border, Application.Mouse.MouseGrabView); - Assert.Equal (new (0, 0), w.Frame.Location); - - // Move down and to the right. - Application.RaiseMouseEvent (new () { ScreenPosition = new (1, 1), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition }); - Assert.Equal (new (1, 1), w.Frame.Location); - - Application.End (rs); - w.Dispose (); - } - - [Fact] - [SetupFakeApplication] - public void End_Does_Not_Dispose () - { - var top = new Toplevel (); - - Window w = new (); - Application.StopAfterFirstIteration = true; - Application.Run (w); - -#if DEBUG_IDISPOSABLE - Assert.False (w.WasDisposed); -#endif - - Assert.NotNull (w); - Assert.Equal (string.Empty, w.Title); // Valid - w has not been disposed. The user may want to run it again - Assert.NotNull (Application.Top); - Assert.Equal (w, Application.Top); - Assert.NotEqual (top, Application.Top); - - Application.Run (w); // Valid - w has not been disposed. - -#if DEBUG_IDISPOSABLE - Assert.False (w.WasDisposed); - Exception exception = Record.Exception (Application.Shutdown); // Invalid - w has not been disposed. - Assert.NotNull (exception); - - w.Dispose (); - Assert.True (w.WasDisposed); - - //exception = Record.Exception ( - // () => Application.Run ( - // w)); // Invalid - w has been disposed. Run it in debug mode will throw, otherwise the user may want to run it again - //Assert.NotNull (exception); - - // TODO: Re-enable this when we are done debug logging of ctx.Source.Title in RaiseSelecting - //exception = Record.Exception (() => Assert.Equal (string.Empty, w.Title)); // Invalid - w has been disposed and cannot be accessed - //Assert.NotNull (exception); - //exception = Record.Exception (() => w.Title = "NewTitle"); // Invalid - w has been disposed and cannot be accessed - //Assert.NotNull (exception); -#endif - } - - [Fact] - public void Run_Creates_Top_Without_Init () - { - Assert.Null (Application.Top); - Application.StopAfterFirstIteration = true; - - Application.Iteration += OnApplicationOnIteration; - Toplevel top = Application.Run (null, "fake"); - Application.Iteration -= OnApplicationOnIteration; -#if DEBUG_IDISPOSABLE - Assert.Equal (top, Application.Top); - Assert.False (top.WasDisposed); - Exception exception = Record.Exception (Application.Shutdown); - Assert.NotNull (exception); - Assert.False (top.WasDisposed); -#endif - - // It's up to caller to dispose it - top.Dispose (); - -#if DEBUG_IDISPOSABLE - Assert.True (top.WasDisposed); -#endif - Assert.NotNull (Application.Top); - - Application.Shutdown (); - Assert.Null (Application.Top); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs e) { Assert.NotNull (Application.Top); } - } - - [Fact] - public void Run_T_Creates_Top_Without_Init () - { - Assert.Null (Application.Top); - - Application.StopAfterFirstIteration = true; - - Application.Run (null, "fake"); -#if DEBUG_IDISPOSABLE - Assert.False (Application.Top!.WasDisposed); - Exception exception = Record.Exception (Application.Shutdown); - Assert.NotNull (exception); - Assert.False (Application.Top!.WasDisposed); - - // It's up to caller to dispose it - Application.Top!.Dispose (); - Assert.True (Application.Top!.WasDisposed); -#endif - Assert.NotNull (Application.Top); - - Application.Shutdown (); - Assert.Null (Application.Top); - } - - [Fact] - public void Run_t_Does_Not_Creates_Top_Without_Init () - { - // When a Toplevel is created it must already have all the Application configuration loaded - // This is only possible by two ways: - // 1 - Using Application.Init first - // 2 - Using Application.Run() or Application.Run() - // The Application.Run(new(Toplevel)) must always call Application.Init() first because - // the new(Toplevel) may be a derived class that is possible using Application static - // properties that is only available after the Application.Init was called - - Assert.Null (Application.Top); - - Assert.Throws (() => Application.Run (new Toplevel ())); - - Application.Init (null, "fake"); - - Application.Iteration += OnApplicationOnIteration; - Application.Run (new Toplevel ()); - Application.Iteration -= OnApplicationOnIteration; -#if DEBUG_IDISPOSABLE - Assert.False (Application.Top!.WasDisposed); - Exception exception = Record.Exception (Application.Shutdown); - Assert.NotNull (exception); - Assert.False (Application.Top!.WasDisposed); - - // It's up to caller to dispose it - Application.Top!.Dispose (); - Assert.True (Application.Top!.WasDisposed); -#endif - Assert.NotNull (Application.Top); - - Application.Shutdown (); - Assert.Null (Application.Top); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs e) - { - Assert.NotNull (Application.Top); - Application.RequestStop (); - } - } - - private class TestToplevel : Toplevel - { } - - [Fact] - public void Run_T_With_V2_Driver_Does_Not_Call_ResetState_After_Init () - { - Assert.False (Application.Initialized); - Application.Init (null, "fake"); - Assert.True (Application.Initialized); - - Task.Run (() => { Task.Delay (300).Wait (); }) - .ContinueWith ( - (t, _) => - { - // no longer loading - Application.Invoke (() => { Application.RequestStop (); }); - }, - TaskScheduler.FromCurrentSynchronizationContext ()); - Application.Run (); - Assert.NotNull (Application.Driver); - Assert.NotNull (Application.Top); - Assert.False (Application.Top!.Running); - Application.Top!.Dispose (); - Application.Shutdown (); - } - - // TODO: Add tests for Run that test errorHandler - - #endregion - - #region ShutdownTests - - [Fact] - public async Task Shutdown_Allows_Async () - { - var isCompletedSuccessfully = false; - - async Task TaskWithAsyncContinuation () - { - await Task.Yield (); - await Task.Yield (); - - isCompletedSuccessfully = true; - } - - Application.Shutdown (); - - Assert.False (isCompletedSuccessfully); - await TaskWithAsyncContinuation (); - Thread.Sleep (100); - Assert.True (isCompletedSuccessfully); - } - - [Fact] - public void Shutdown_Resets_SyncContext () - { - Application.Shutdown (); - Assert.Null (SynchronizationContext.Current); - } - - #endregion -} diff --git a/Tests/UnitTests/Application/CursorTests.cs b/Tests/UnitTests/Application/CursorTests.cs index 69d472290..bf5cb1247 100644 --- a/Tests/UnitTests/Application/CursorTests.cs +++ b/Tests/UnitTests/Application/CursorTests.cs @@ -1,5 +1,4 @@ -using UnitTests; -using Xunit.Abstractions; +using Xunit.Abstractions; namespace UnitTests.ApplicationTests; @@ -7,22 +6,20 @@ public class CursorTests { private readonly ITestOutputHelper _output; - public CursorTests (ITestOutputHelper output) - { - _output = output; - } + public CursorTests (ITestOutputHelper output) { _output = output; } private class TestView : View { public Point? TestLocation { get; set; } - /// + /// public override Point? PositionCursor () { if (TestLocation.HasValue && HasFocus) { - Driver.SetCursorVisibility (CursorVisibility.Default); + Driver?.SetCursorVisibility (CursorVisibility.Default); } + return TestLocation; } } @@ -31,7 +28,6 @@ public class CursorTests [AutoInitShutdown] public void PositionCursor_No_Focus_Returns_False () { - Application.Navigation = new (); Application.Navigation.SetFocused (null); Assert.False (Application.PositionCursor ()); @@ -40,7 +36,7 @@ public class CursorTests { CanFocus = false, Width = 1, - Height = 1, + Height = 1 }; view.TestLocation = new Point (0, 0); Assert.False (Application.PositionCursor ()); @@ -50,12 +46,11 @@ public class CursorTests [AutoInitShutdown] public void PositionCursor_No_Position_Returns_False () { - Application.Navigation = new (); TestView view = new () { CanFocus = false, Width = 1, - Height = 1, + Height = 1 }; view.CanFocus = true; @@ -67,11 +62,10 @@ public class CursorTests [AutoInitShutdown] public void PositionCursor_No_IntersectSuperView_Returns_False () { - Application.Navigation = new (); View superView = new () { Width = 1, - Height = 1, + Height = 1 }; TestView view = new () @@ -80,7 +74,7 @@ public class CursorTests X = 1, Y = 1, Width = 1, - Height = 1, + Height = 1 }; superView.Add (view); @@ -94,11 +88,10 @@ public class CursorTests [AutoInitShutdown] public void PositionCursor_Position_OutSide_SuperView_Returns_False () { - Application.Navigation = new (); View superView = new () { Width = 1, - Height = 1, + Height = 1 }; TestView view = new () @@ -107,7 +100,7 @@ public class CursorTests X = 0, Y = 0, Width = 2, - Height = 2, + Height = 2 }; superView.Add (view); @@ -121,12 +114,12 @@ public class CursorTests [AutoInitShutdown] public void PositionCursor_Focused_With_Position_Returns_True () { - Application.Navigation = new (); TestView view = new () { CanFocus = false, Width = 1, Height = 1, + App = ApplicationImpl.Instance }; view.CanFocus = true; view.SetFocus (); @@ -138,12 +131,11 @@ public class CursorTests [AutoInitShutdown] public void PositionCursor_Defaults_Invisible () { - Application.Navigation = new (); View view = new () { CanFocus = true, Width = 1, - Height = 1, + Height = 1 }; view.SetFocus (); diff --git a/Tests/UnitTests/Application/MainLoopCoordinatorTests.cs b/Tests/UnitTests/Application/MainLoopCoordinatorTests.cs index 6c7f1d123..b0e1e5708 100644 --- a/Tests/UnitTests/Application/MainLoopCoordinatorTests.cs +++ b/Tests/UnitTests/Application/MainLoopCoordinatorTests.cs @@ -26,7 +26,7 @@ public class MainLoopCoordinatorTests // StartAsync boots the main loop and the input thread. But if the input class bombs // on startup it is important that the exception surface at the call site and not lost - var ex = await Assert.ThrowsAsync(c.StartInputTaskAsync); + var ex = await Assert.ThrowsAsync(() => c.StartInputTaskAsync (null)); Assert.Equal ("Crash on boot", ex.InnerExceptions [0].Message); diff --git a/Tests/UnitTests/Application/Mouse/ApplicationMouseEnterLeaveTests.cs b/Tests/UnitTests/Application/Mouse/ApplicationMouseEnterLeaveTests.cs deleted file mode 100644 index cbe800a98..000000000 --- a/Tests/UnitTests/Application/Mouse/ApplicationMouseEnterLeaveTests.cs +++ /dev/null @@ -1,481 +0,0 @@ -using System.ComponentModel; - -namespace UnitTests.ViewMouseTests; - -[Trait ("Category", "Input")] -public class ApplicationMouseEnterLeaveTests -{ - private class TestView : View - { - public TestView () - { - X = 1; - Y = 1; - Width = 1; - Height = 1; - } - - public bool CancelOnEnter { get; } - public int OnMouseEnterCalled { get; private set; } - public int OnMouseLeaveCalled { get; private set; } - - protected override bool OnMouseEnter (CancelEventArgs eventArgs) - { - OnMouseEnterCalled++; - eventArgs.Cancel = CancelOnEnter; - - base.OnMouseEnter (eventArgs); - - return eventArgs.Cancel; - } - - protected override void OnMouseLeave () - { - OnMouseLeaveCalled++; - - base.OnMouseLeave (); - } - } - - [Fact] - public void RaiseMouseEnterLeaveEvents_MouseEntersView_CallsOnMouseEnter () - { - // Arrange - Application.Top = new () { Frame = new (0, 0, 10, 10) }; - var view = new TestView (); - Application.Top.Add (view); - var mousePosition = new Point (1, 1); - List currentViewsUnderMouse = new () { view }; - - var mouseEvent = new MouseEventArgs - { - Position = mousePosition, - ScreenPosition = mousePosition - }; - - Application.CachedViewsUnderMouse.Clear (); - - try - { - // Act - Application.RaiseMouseEnterLeaveEvents (mousePosition, currentViewsUnderMouse); - - // Assert - Assert.Equal (1, view.OnMouseEnterCalled); - } - finally - { - // Cleanup - Application.Top?.Dispose (); - Application.ResetState (); - } - } - - [Fact] - public void RaiseMouseEnterLeaveEvents_MouseLeavesView_CallsOnMouseLeave () - { - // Arrange - Application.Top = new () { Frame = new (0, 0, 10, 10) }; - var view = new TestView (); - Application.Top.Add (view); - var mousePosition = new Point (0, 0); - List currentViewsUnderMouse = new (); - var mouseEvent = new MouseEventArgs (); - - Application.CachedViewsUnderMouse.Clear (); - Application.CachedViewsUnderMouse.Add (view); - - try - { - // Act - Application.RaiseMouseEnterLeaveEvents (mousePosition, currentViewsUnderMouse); - - // Assert - Assert.Equal (0, view.OnMouseEnterCalled); - Assert.Equal (1, view.OnMouseLeaveCalled); - } - finally - { - // Cleanup - Application.Top?.Dispose (); - Application.ResetState (); - } - } - - [Fact] - public void RaiseMouseEnterLeaveEvents_MouseMovesBetweenAdjacentViews_CallsOnMouseEnterAndLeave () - { - // Arrange - Application.Top = new () { Frame = new (0, 0, 10, 10) }; - var view1 = new TestView (); // at 1,1 to 2,2 - - var view2 = new TestView () // at 2,2 to 3,3 - { - X = 2, - Y = 2 - }; - Application.Top.Add (view1); - Application.Top.Add (view2); - - Application.CachedViewsUnderMouse.Clear (); - - try - { - // Act - var mousePosition = new Point (0, 0); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (0, view1.OnMouseEnterCalled); - Assert.Equal (0, view1.OnMouseLeaveCalled); - Assert.Equal (0, view2.OnMouseEnterCalled); - Assert.Equal (0, view2.OnMouseLeaveCalled); - - // Act - mousePosition = new (1, 1); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (0, view1.OnMouseLeaveCalled); - Assert.Equal (0, view2.OnMouseEnterCalled); - Assert.Equal (0, view2.OnMouseLeaveCalled); - - // Act - mousePosition = new (2, 2); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (1, view1.OnMouseLeaveCalled); - Assert.Equal (1, view2.OnMouseEnterCalled); - Assert.Equal (0, view2.OnMouseLeaveCalled); - - // Act - mousePosition = new (3, 3); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (1, view1.OnMouseLeaveCalled); - Assert.Equal (1, view2.OnMouseEnterCalled); - Assert.Equal (1, view2.OnMouseLeaveCalled); - - // Act - mousePosition = new (0, 0); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (1, view1.OnMouseLeaveCalled); - Assert.Equal (1, view2.OnMouseEnterCalled); - Assert.Equal (1, view2.OnMouseLeaveCalled); - } - finally - { - // Cleanup - Application.Top?.Dispose (); - Application.ResetState (); - } - } - - [Fact] - public void RaiseMouseEnterLeaveEvents_NoViewsUnderMouse_DoesNotCallOnMouseEnterOrLeave () - { - // Arrange - Application.Top = new () { Frame = new (0, 0, 10, 10) }; - var view = new TestView (); - Application.Top.Add (view); - var mousePosition = new Point (0, 0); - List currentViewsUnderMouse = new (); - var mouseEvent = new MouseEventArgs (); - - Application.CachedViewsUnderMouse.Clear (); - - try - { - // Act - Application.RaiseMouseEnterLeaveEvents (mousePosition, currentViewsUnderMouse); - - // Assert - Assert.Equal (0, view.OnMouseEnterCalled); - Assert.Equal (0, view.OnMouseLeaveCalled); - } - finally - { - // Cleanup - Application.Top?.Dispose (); - Application.ResetState (); - } - } - - [Fact] - public void RaiseMouseEnterLeaveEvents_MouseMovesBetweenOverlappingPeerViews_CallsOnMouseEnterAndLeave () - { - // Arrange - Application.Top = new () { Frame = new (0, 0, 10, 10) }; - - var view1 = new TestView - { - Width = 2 - }; // at 1,1 to 3,2 - - var view2 = new TestView () // at 2,2 to 4,3 - { - Width = 2, - X = 2, - Y = 2 - }; - Application.Top.Add (view1); - Application.Top.Add (view2); - - Application.CachedViewsUnderMouse.Clear (); - - try - { - // Act - var mousePosition = new Point (0, 0); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (0, view1.OnMouseEnterCalled); - Assert.Equal (0, view1.OnMouseLeaveCalled); - Assert.Equal (0, view2.OnMouseEnterCalled); - Assert.Equal (0, view2.OnMouseLeaveCalled); - - // Act - mousePosition = new (1, 1); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (0, view1.OnMouseLeaveCalled); - Assert.Equal (0, view2.OnMouseEnterCalled); - Assert.Equal (0, view2.OnMouseLeaveCalled); - - // Act - mousePosition = new (2, 2); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (1, view1.OnMouseLeaveCalled); - Assert.Equal (1, view2.OnMouseEnterCalled); - Assert.Equal (0, view2.OnMouseLeaveCalled); - - // Act - mousePosition = new (3, 3); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (1, view1.OnMouseLeaveCalled); - Assert.Equal (1, view2.OnMouseEnterCalled); - Assert.Equal (1, view2.OnMouseLeaveCalled); - - // Act - mousePosition = new (0, 0); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (1, view1.OnMouseLeaveCalled); - Assert.Equal (1, view2.OnMouseEnterCalled); - Assert.Equal (1, view2.OnMouseLeaveCalled); - - // Act - mousePosition = new (2, 2); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (1, view1.OnMouseLeaveCalled); - Assert.Equal (2, view2.OnMouseEnterCalled); - Assert.Equal (1, view2.OnMouseLeaveCalled); - } - finally - { - // Cleanup - Application.Top?.Dispose (); - Application.ResetState (); - } - } - - [Fact] - public void RaiseMouseEnterLeaveEvents_MouseMovesBetweenOverlappingSubViews_CallsOnMouseEnterAndLeave () - { - // Arrange - Application.Top = new () { Frame = new (0, 0, 10, 10) }; - - var view1 = new TestView - { - Id = "view1", - Width = 2, - Height = 2, - Arrangement = ViewArrangement.Overlapped - }; // at 1,1 to 3,3 (screen) - - var subView = new TestView - { - Id = "subView", - Width = 2, - Height = 2, - X = 1, - Y = 1, - Arrangement = ViewArrangement.Overlapped - }; // at 2,2 to 4,4 (screen) - view1.Add (subView); - Application.Top.Add (view1); - - Application.CachedViewsUnderMouse.Clear (); - - try - { - Assert.Equal (1, view1.FrameToScreen ().X); - Assert.Equal (2, subView.FrameToScreen ().X); - - // Act - var mousePosition = new Point (0, 0); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (0, view1.OnMouseEnterCalled); - Assert.Equal (0, view1.OnMouseLeaveCalled); - Assert.Equal (0, subView.OnMouseEnterCalled); - Assert.Equal (0, subView.OnMouseLeaveCalled); - - // Act - mousePosition = new (1, 1); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (0, view1.OnMouseLeaveCalled); - Assert.Equal (0, subView.OnMouseEnterCalled); - Assert.Equal (0, subView.OnMouseLeaveCalled); - - // Act - mousePosition = new (2, 2); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (0, view1.OnMouseLeaveCalled); - Assert.Equal (1, subView.OnMouseEnterCalled); - Assert.Equal (0, subView.OnMouseLeaveCalled); - - // Act - mousePosition = new (0, 0); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (1, view1.OnMouseEnterCalled); - Assert.Equal (1, view1.OnMouseLeaveCalled); - Assert.Equal (1, subView.OnMouseEnterCalled); - Assert.Equal (1, subView.OnMouseLeaveCalled); - - // Act - mousePosition = new (2, 2); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (2, view1.OnMouseEnterCalled); - Assert.Equal (1, view1.OnMouseLeaveCalled); - Assert.Equal (2, subView.OnMouseEnterCalled); - Assert.Equal (1, subView.OnMouseLeaveCalled); - - // Act - mousePosition = new (3, 3); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (2, view1.OnMouseEnterCalled); - Assert.Equal (2, view1.OnMouseLeaveCalled); - Assert.Equal (2, subView.OnMouseEnterCalled); - Assert.Equal (2, subView.OnMouseLeaveCalled); - - // Act - mousePosition = new (0, 0); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (2, view1.OnMouseEnterCalled); - Assert.Equal (2, view1.OnMouseLeaveCalled); - Assert.Equal (2, subView.OnMouseEnterCalled); - Assert.Equal (2, subView.OnMouseLeaveCalled); - - // Act - mousePosition = new (2, 2); - - Application.RaiseMouseEnterLeaveEvents ( - mousePosition, - View.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); - - // Assert - Assert.Equal (3, view1.OnMouseEnterCalled); - Assert.Equal (2, view1.OnMouseLeaveCalled); - Assert.Equal (3, subView.OnMouseEnterCalled); - Assert.Equal (2, subView.OnMouseLeaveCalled); - } - finally - { - // Cleanup - Application.Top?.Dispose (); - Application.ResetState (); - } - } -} diff --git a/Tests/UnitTests/Application/Mouse/ApplicationMouseTests.cs b/Tests/UnitTests/Application/Mouse/ApplicationMouseTests.cs index 0451264ed..887b10c0d 100644 --- a/Tests/UnitTests/Application/Mouse/ApplicationMouseTests.cs +++ b/Tests/UnitTests/Application/Mouse/ApplicationMouseTests.cs @@ -16,7 +16,6 @@ public class ApplicationMouseTests _output = output; #if DEBUG_IDISPOSABLE View.Instances.Clear (); - SessionToken.Instances.Clear (); #endif } @@ -127,7 +126,7 @@ public class ApplicationMouseTests clicked = true; }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (view); Application.Begin (top); @@ -136,105 +135,6 @@ public class ApplicationMouseTests top.Dispose (); } - /// - /// Tests that the mouse coordinates passed to the focused view are correct when the mouse is clicked. With - /// Frames; Frame != Viewport - /// - //[AutoInitShutdown] - [Theory] - - // click on border - [InlineData (0, 0, 0, 0, 0, false)] - [InlineData (0, 1, 0, 0, 0, false)] - [InlineData (0, 0, 1, 0, 0, false)] - [InlineData (0, 9, 0, 0, 0, false)] - [InlineData (0, 0, 9, 0, 0, false)] - - // outside border - [InlineData (0, 10, 0, 0, 0, false)] - [InlineData (0, 0, 10, 0, 0, false)] - - // view is offset from origin ; click is on border - [InlineData (1, 1, 1, 0, 0, false)] - [InlineData (1, 2, 1, 0, 0, false)] - [InlineData (1, 1, 2, 0, 0, false)] - [InlineData (1, 10, 1, 0, 0, false)] - [InlineData (1, 1, 10, 0, 0, false)] - - // outside border - [InlineData (1, -1, 0, 0, 0, false)] - [InlineData (1, 0, -1, 0, 0, false)] - [InlineData (1, 10, 10, 0, 0, false)] - [InlineData (1, 11, 11, 0, 0, false)] - - // view is at origin, click is inside border - [InlineData (0, 1, 1, 0, 0, true)] - [InlineData (0, 2, 1, 1, 0, true)] - [InlineData (0, 1, 2, 0, 1, true)] - [InlineData (0, 8, 1, 7, 0, true)] - [InlineData (0, 1, 8, 0, 7, true)] - [InlineData (0, 8, 8, 7, 7, true)] - - // view is offset from origin ; click inside border - // our view is 10x10, but has a border, so it's bounds is 8x8 - [InlineData (1, 2, 2, 0, 0, true)] - [InlineData (1, 3, 2, 1, 0, true)] - [InlineData (1, 2, 3, 0, 1, true)] - [InlineData (1, 9, 2, 7, 0, true)] - [InlineData (1, 2, 9, 0, 7, true)] - [InlineData (1, 9, 9, 7, 7, true)] - [InlineData (1, 10, 10, 7, 7, false)] - - //01234567890123456789 - // |12345678| - // |xxxxxxxx - public void MouseCoordinatesTest_Border ( - int offset, - int clickX, - int clickY, - int expectedX, - int expectedY, - bool expectedClicked - ) - { - Size size = new (10, 10); - Point pos = new (offset, offset); - - var clicked = false; - - Application.Top = new Toplevel () - { - Id = "top", - }; - Application.Top.X = 0; - Application.Top.Y = 0; - Application.Top.Width = size.Width * 2; - Application.Top.Height = size.Height * 2; - Application.Top.BorderStyle = LineStyle.None; - - var view = new View { Id = "view", X = pos.X, Y = pos.Y, Width = size.Width, Height = size.Height }; - - // Give the view a border. With PR #2920, mouse clicks are only passed if they are inside the view's Viewport. - view.BorderStyle = LineStyle.Single; - view.CanFocus = true; - - Application.Top.Add (view); - - var mouseEvent = new MouseEventArgs { Position = new (clickX, clickY), ScreenPosition = new (clickX, clickY), Flags = MouseFlags.Button1Clicked }; - - view.MouseClick += (s, e) => - { - Assert.Equal (expectedX, e.Position.X); - Assert.Equal (expectedY, e.Position.Y); - clicked = true; - }; - - Application.RaiseMouseEvent (mouseEvent); - Assert.Equal (expectedClicked, clicked); - Application.Top.Dispose (); - Application.ResetState (ignoreDisposed: true); - - } #endregion mouse coordinate tests @@ -249,7 +149,7 @@ public class ApplicationMouseTests //sv.SetContentSize (new (100, 100)); //sv.Add (tf); - //var top = new Toplevel (); + //var top = new Runnable (); //top.Add (sv); //int iterations = -1; @@ -267,14 +167,14 @@ public class ApplicationMouseTests // Assert.Equal (sv, Application.Mouse.MouseGrabView); - // MessageBox.Query ("Title", "Test", "Ok"); + // MessageBox.Query (App, "Title", "Test", "Ok"); // Assert.Null (Application.Mouse.MouseGrabView); // } // else if (iterations == 1) // { // // Application.Mouse.MouseGrabView is null because - // // another toplevel (Dialog) was opened + // // another runnable (Dialog) was opened // Assert.Null (Application.Mouse.MouseGrabView); // Application.RaiseMouseEvent (new () { ScreenPosition = new (5, 5), Flags = MouseFlags.ReportMousePosition }); @@ -390,7 +290,7 @@ public class ApplicationMouseTests var count = 0; var view = new View { Width = 1, Height = 1 }; view.MouseEvent += (s, e) => count++; - var top = new Toplevel (); + var top = new Runnable (); top.Add (view); Application.Begin (top); @@ -439,7 +339,7 @@ public class ApplicationMouseTests View? receivedView = null; grabView.MouseEvent += (_, e) => receivedView = e.View; - var top = new Toplevel { Width = 20, Height = 10 }; + var top = new Runnable { Width = 20, Height = 10 }; top.Add (grabView); top.Add (targetView); // deepestViewUnderMouse = targetView Application.Begin (top); diff --git a/Tests/UnitTests/Application/SessionTokenTests.cs b/Tests/UnitTests/Application/SessionTokenTests.cs deleted file mode 100644 index d01bc1c59..000000000 --- a/Tests/UnitTests/Application/SessionTokenTests.cs +++ /dev/null @@ -1,79 +0,0 @@ - -namespace UnitTests.ApplicationTests; - -/// These tests focus on Application.SessionToken and the various ways it can be changed. -public class SessionTokenTests -{ - public SessionTokenTests () - { -#if DEBUG_IDISPOSABLE - View.EnableDebugIDisposableAsserts = true; - - View.Instances.Clear (); - SessionToken.Instances.Clear (); -#endif - } - - [Fact] - [AutoInitShutdown] - public void Begin_End_Cleans_Up_SessionToken () - { - // Test null Toplevel - Assert.Throws (() => Application.Begin (null)); - - var top = new Toplevel (); - SessionToken rs = Application.Begin (top); - Assert.NotNull (rs); - Application.End (rs); - - Assert.NotNull (Application.Top); - - // v2 does not use main loop, it uses MainLoop and its internal - //Assert.NotNull (Application.MainLoop); - Assert.NotNull (Application.Driver); - - top.Dispose (); - -#if DEBUG_IDISPOSABLE - Assert.True (rs.WasDisposed); -#endif - } - - [Fact] - public void Dispose_Cleans_Up_SessionToken () - { - var rs = new SessionToken (null); - Assert.NotNull (rs); - - // Should not throw because Toplevel was null - rs.Dispose (); -#if DEBUG_IDISPOSABLE - Assert.True (rs.WasDisposed); -#endif - var top = new Toplevel (); - rs = new (top); - Assert.NotNull (rs); - - // Should throw because Toplevel was not cleaned up - Assert.Throws (() => rs.Dispose ()); - - rs.Toplevel.Dispose (); - rs.Toplevel = null; - rs.Dispose (); -#if DEBUG_IDISPOSABLE - Assert.True (rs.WasDisposed); - Assert.True (top.WasDisposed); -#endif - } - - [Fact] - public void New_Creates_SessionToken () - { - var rs = new SessionToken (null); - Assert.Null (rs.Toplevel); - - var top = new Toplevel (); - rs = new (top); - Assert.Equal (top, rs.Toplevel); - } -} diff --git a/Tests/UnitTests/Application/SynchronizatonContextTests.cs b/Tests/UnitTests/Application/SynchronizatonContextTests.cs index 9f8d34b0e..39fee532f 100644 --- a/Tests/UnitTests/Application/SynchronizatonContextTests.cs +++ b/Tests/UnitTests/Application/SynchronizatonContextTests.cs @@ -9,7 +9,7 @@ public class SyncrhonizationContextTests [Fact] public void SynchronizationContext_CreateCopy () { - Application.Init (null, "fake"); + Application.Init ("fake"); SynchronizationContext context = SynchronizationContext.Current; Assert.NotNull (context); @@ -31,7 +31,7 @@ public class SyncrhonizationContextTests { lock (_lockPost) { - Application.Init (null, driverName: driverName); + Application.Init (driverName); SynchronizationContext context = SynchronizationContext.Current; @@ -39,7 +39,7 @@ public class SyncrhonizationContextTests Task.Run (() => { - while (Application.Top is null || Application.Top is { Running: false }) + while (Application.TopRunnable is { IsRunning: false }) { Thread.Sleep (500); } @@ -56,7 +56,7 @@ public class SyncrhonizationContextTests null ); - if (Application.Top is { Running: true }) + if (Application.TopRunnable is { IsRunning: true }) { Assert.False (success); } @@ -64,7 +64,7 @@ public class SyncrhonizationContextTests ); // blocks here until the RequestStop is processed at the end of the test - Application.Run ().Dispose (); + Application.Run (); Assert.True (success); Application.Shutdown (); @@ -100,7 +100,7 @@ public class SyncrhonizationContextTests ); // blocks here until the RequestStop is processed at the end of the test - Application.Run ().Dispose (); + Application.Run (); Assert.True (success); Application.Shutdown (); } diff --git a/Tests/UnitTests/Application/TimedEventsTests.cs b/Tests/UnitTests/Application/TimedEventsTests.cs index 4877a6b2c..98d061159 100644 --- a/Tests/UnitTests/Application/TimedEventsTests.cs +++ b/Tests/UnitTests/Application/TimedEventsTests.cs @@ -134,4 +134,35 @@ public class TimedEventsTests Assert.Equal (expected, executeCount); } + + [Fact] + public void StopAll_Stops_All_Timeouts () + { + var timedEvents = new TimedEvents (); + var executeCount = 0; + var expected = 100; + + for (var i = 0; i < expected; i++) + { + timedEvents.Add ( + TimeSpan.Zero, + () => + { + Interlocked.Increment (ref executeCount); + + return false; + }); + } + + Assert.Equal (expected, timedEvents.Timeouts.Count); + + timedEvents.StopAll (); + + Assert.Empty (timedEvents.Timeouts); + + // Run timers once + timedEvents.RunTimers (); + + Assert.Equal (0, executeCount); + } } diff --git a/Tests/UnitTests/AutoInitShutdownAttribute.cs b/Tests/UnitTests/AutoInitShutdownAttribute.cs index 0b3d2af07..a0536503b 100644 --- a/Tests/UnitTests/AutoInitShutdownAttribute.cs +++ b/Tests/UnitTests/AutoInitShutdownAttribute.cs @@ -25,20 +25,16 @@ public class AutoInitShutdownAttribute : BeforeAfterTestAttribute /// be used when Application.Init is called. If not specified FakeDriver will be used. Only valid if /// is true. /// - /// If true and is true, the test will fail. public AutoInitShutdownAttribute ( bool autoInit = true, - string forceDriver = null, - bool verifyShutdown = false + string forceDriver = null ) { - AutoInit = autoInit; + _autoInit = autoInit; CultureInfo.DefaultThreadCurrentUICulture = CultureInfo.GetCultureInfo ("en-US"); _forceDriver = forceDriver; - _verifyShutdown = verifyShutdown; } - private readonly bool _verifyShutdown; private readonly string _forceDriver; private IDisposable _v2Cleanup; @@ -51,15 +47,10 @@ public class AutoInitShutdownAttribute : BeforeAfterTestAttribute _v2Cleanup?.Dispose (); - if (AutoInit) + if (_autoInit) { - // try + try { - if (!_verifyShutdown) - { - Application.ResetState (ignoreDisposed: true); - } - Application.Shutdown (); #if DEBUG_IDISPOSABLE if (View.Instances.Count == 0) @@ -74,14 +65,15 @@ public class AutoInitShutdownAttribute : BeforeAfterTestAttribute } //catch (Exception e) //{ - // Assert.Fail ($"Application.Shutdown threw an exception after the test exited: {e}"); + // Debug.WriteLine ($"Application.Shutdown threw an exception after the test exited: {e}"); //} - //finally + finally { #if DEBUG_IDISPOSABLE View.Instances.Clear (); Application.ResetState (true); #endif + ApplicationImpl.SetInstance (null); } } @@ -102,7 +94,7 @@ public class AutoInitShutdownAttribute : BeforeAfterTestAttribute //Debug.Assert(!CM.IsEnabled, "Some other test left ConfigurationManager enabled."); - if (AutoInit) + if (_autoInit) { #if DEBUG_IDISPOSABLE View.EnableDebugIDisposableAsserts = true; @@ -117,7 +109,7 @@ public class AutoInitShutdownAttribute : BeforeAfterTestAttribute View.Instances.Clear (); } #endif - if (string.IsNullOrEmpty(_forceDriver) || _forceDriver.ToLowerInvariant () == "fake") + if (string.IsNullOrEmpty (_forceDriver) || _forceDriver.ToLowerInvariant () == "fake") { var fa = new FakeApplicationFactory (); _v2Cleanup = fa.SetupFakeApplication (); @@ -131,7 +123,7 @@ public class AutoInitShutdownAttribute : BeforeAfterTestAttribute } } - private bool AutoInit { get; } + private bool _autoInit { get; } /// /// Runs a single iteration of the main loop (layout, draw, run timed events etc.) diff --git a/Tests/UnitTests/Clipboard/ClipboardTests.cs b/Tests/UnitTests/Clipboard/ClipboardTests.cs index 77a20b2d0..13b690ad1 100644 --- a/Tests/UnitTests/Clipboard/ClipboardTests.cs +++ b/Tests/UnitTests/Clipboard/ClipboardTests.cs @@ -20,6 +20,27 @@ public class ClipboardTests Assert.Throws (() => iclip.SetClipboardData ("foo")); } + [Fact, AutoInitShutdown (useFakeClipboard: true)] + public void IApplication_Clipboard_Property_Works () + { + if (Application.Clipboard?.IsSupported != true) + { + output.WriteLine ($"The Clipboard not supported on this platform."); + return; + } + + string clipText = "The IApplication_Clipboard_Property_Works unit test pasted this to the OS clipboard."; + + // Use the new IApplication.Clipboard property + Application.Clipboard.SetClipboardData (clipText); + + ApplicationImpl.Instance.Iteration += (s, a) => ApplicationImpl.Instance.RequestStop (); + ApplicationImpl.Instance.Run>().Dispose(); + + Assert.True(Application.Clipboard.TryGetClipboardData(out string result)); + Assert.Equal (clipText, result); + } + [Fact, AutoInitShutdown (useFakeClipboard: true)] public void Contents_Fake_Gets_Sets () { diff --git a/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs b/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs index e1a83b4a5..0a611d08b 100644 --- a/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs +++ b/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs @@ -550,7 +550,7 @@ public class ConfigurationManagerTests (ITestOutputHelper output) ""MessageBox.DefaultButtonAlignment"": ""End"", ""Schemes"": [ { - ""TopLevel"": { + ""Runnable"": { ""Normal"": { ""Foreground"": ""BrightGreen"", ""Background"": ""Black"" @@ -1245,7 +1245,7 @@ public class ConfigurationManagerTests (ITestOutputHelper output) ""MessageBox.DefaultButtonAlignment"": ""End"", ""Schemes"": [ { - ""TopLevel"": { + ""Runnable"": { ""Normal"": { ""Foreground"": ""BrightGreen"", ""Background"": ""Black"" @@ -1399,4 +1399,20 @@ public class ConfigurationManagerTests (ITestOutputHelper output) Disable (true); } } + + [ConfigurationProperty (Scope = typeof (CMTestsScope))] + public static bool? TestProperty { get; set; } + + private class CMTestsScope : Scope + { + } + + [Fact] + public void GetConfigPropertiesByScope_Gets () + { + var props = GetUninitializedConfigPropertiesByScope ("CMTestsScope"); + + Assert.NotNull (props); + Assert.NotEmpty (props); + } } diff --git a/Tests/UnitTests/Configuration/SchemeManagerTests.cs b/Tests/UnitTests/Configuration/SchemeManagerTests.cs index b44d3ff8e..4a7b2399f 100644 --- a/Tests/UnitTests/Configuration/SchemeManagerTests.cs +++ b/Tests/UnitTests/Configuration/SchemeManagerTests.cs @@ -97,10 +97,10 @@ public class SchemeManagerTests Assert.NotNull (menuScheme); Assert.Equal (new Attribute (StandardColor.Charcoal, StandardColor.LightBlue, TextStyle.Bold), menuScheme!.Normal); - // Toplevel - var toplevelScheme = schemes ["Toplevel"]; - Assert.NotNull (toplevelScheme); - Assert.Equal (new Attribute (StandardColor.CadetBlue, StandardColor.Charcoal).ToString (), toplevelScheme!.Normal.ToString ()); + // Runnable + var runnableScheme = schemes ["Runnable"]; + Assert.NotNull (runnableScheme); + Assert.Equal (new Attribute (StandardColor.CadetBlue, StandardColor.Charcoal).ToString (), runnableScheme!.Normal.ToString ()); } @@ -132,10 +132,10 @@ public class SchemeManagerTests Assert.NotNull (menuScheme); Assert.Equal (new Attribute (StandardColor.Charcoal, StandardColor.LightBlue, TextStyle.Bold), menuScheme!.Normal); - // Toplevel - var toplevelScheme = schemes ["Toplevel"]; - Assert.NotNull (toplevelScheme); - Assert.Equal (new Attribute (StandardColor.CadetBlue, StandardColor.Charcoal).ToString (), toplevelScheme!.Normal.ToString ()); + // Runnable + var runnableScheme = schemes ["Runnable"]; + Assert.NotNull (runnableScheme); + Assert.Equal (new Attribute (StandardColor.CadetBlue, StandardColor.Charcoal).ToString (), runnableScheme!.Normal.ToString ()); } [Fact] public void Not_Case_Sensitive_Disabled () @@ -370,7 +370,7 @@ public class SchemeManagerTests "TestTheme": { "Schemes": [ { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "AntiqueWhite", "Background": "DimGray" @@ -506,17 +506,17 @@ public class SchemeManagerTests // Capture hardCoded hard-coded scheme colors ImmutableSortedDictionary hardCodedSchemes = SchemeManager.GetHardCodedSchemes ()!; - Color hardCodedTopLevelNormalFg = hardCodedSchemes ["TopLevel"].Normal.Foreground; - Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), hardCodedTopLevelNormalFg.ToString ()); + Color hardCodedRunnableNormalFg = hardCodedSchemes ["Runnable"].Normal.Foreground; + Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), hardCodedRunnableNormalFg.ToString ()); Assert.Equal (hardCodedSchemes ["Menu"].Normal.Style, SchemeManager.GetSchemesForCurrentTheme () ["Menu"]!.Normal.Style); // Capture current scheme colors Dictionary currentSchemes = SchemeManager.GetSchemes ()!; - Color currentTopLevelNormalFg = currentSchemes ["TopLevel"].Normal.Foreground; + Color currentRunnableNormalFg = currentSchemes ["Runnable"].Normal.Foreground; - Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), currentTopLevelNormalFg.ToString ()); + Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), currentRunnableNormalFg.ToString ()); // Load the test theme Load (ConfigLocations.Runtime); @@ -524,8 +524,8 @@ public class SchemeManagerTests Assert.Equal (TextStyle.Reverse, SchemeManager.GetSchemesForCurrentTheme () ["Menu"]!.Normal.Style); currentSchemes = SchemeManager.GetSchemesForCurrentTheme ()!; - currentTopLevelNormalFg = currentSchemes ["TopLevel"].Normal.Foreground; - Assert.NotEqual (hardCodedTopLevelNormalFg.ToString (), currentTopLevelNormalFg.ToString ()); + currentRunnableNormalFg = currentSchemes ["Runnable"].Normal.Foreground; + Assert.NotEqual (hardCodedRunnableNormalFg.ToString (), currentRunnableNormalFg.ToString ()); // Now reset everything and reload ResetToHardCodedDefaults (); @@ -534,8 +534,8 @@ public class SchemeManagerTests Assert.Equal ("Default", ThemeManager.Theme); currentSchemes = SchemeManager.GetSchemes ()!; - currentTopLevelNormalFg = currentSchemes ["TopLevel"].Normal.Foreground; - Assert.Equal (hardCodedTopLevelNormalFg.ToString (), currentTopLevelNormalFg.ToString ()); + currentRunnableNormalFg = currentSchemes ["Runnable"].Normal.Foreground; + Assert.Equal (hardCodedRunnableNormalFg.ToString (), currentRunnableNormalFg.ToString ()); } finally @@ -561,7 +561,7 @@ public class SchemeManagerTests "Default": { "Schemes": [ { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "AntiqueWhite", "Background": "DimGray" @@ -697,17 +697,17 @@ public class SchemeManagerTests // Capture hardCoded hard-coded scheme colors ImmutableSortedDictionary hardCodedSchemes = SchemeManager.GetHardCodedSchemes ()!; - Color hardCodedTopLevelNormalFg = hardCodedSchemes ["TopLevel"].Normal.Foreground; - Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), hardCodedTopLevelNormalFg.ToString ()); + Color hardCodedRunnableNormalFg = hardCodedSchemes ["Runnable"].Normal.Foreground; + Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), hardCodedRunnableNormalFg.ToString ()); Assert.Equal (hardCodedSchemes ["Menu"].Normal.Style, SchemeManager.GetSchemesForCurrentTheme () ["Menu"]!.Normal.Style); // Capture current scheme colors Dictionary currentSchemes = SchemeManager.GetSchemes ()!; - Color currentTopLevelNormalFg = currentSchemes ["TopLevel"].Normal.Foreground; + Color currentRunnableNormalFg = currentSchemes ["Runnable"].Normal.Foreground; - Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), currentTopLevelNormalFg.ToString ()); + Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), currentRunnableNormalFg.ToString ()); // Load the test theme Load (ConfigLocations.Runtime); @@ -716,9 +716,9 @@ public class SchemeManagerTests Assert.Equal (TextStyle.Reverse, SchemeManager.GetSchemesForCurrentTheme () ["Menu"]!.Normal.Style); currentSchemes = SchemeManager.GetSchemesForCurrentTheme ()!; - currentTopLevelNormalFg = currentSchemes ["TopLevel"].Normal.Foreground; + currentRunnableNormalFg = currentSchemes ["Runnable"].Normal.Foreground; // BUGBUG: We did not Apply after loading, so schemes should NOT have been updated - //Assert.Equal (hardCodedTopLevelNormalFg.ToString (), currentTopLevelNormalFg.ToString ()); + //Assert.Equal (hardCodedRunnableNormalFg.ToString (), currentRunnableNormalFg.ToString ()); // Now reset everything and reload ResetToHardCodedDefaults (); @@ -727,8 +727,8 @@ public class SchemeManagerTests Assert.Equal ("Default", ThemeManager.Theme); currentSchemes = SchemeManager.GetSchemes ()!; - currentTopLevelNormalFg = currentSchemes ["TopLevel"].Normal.Foreground; - Assert.Equal (hardCodedTopLevelNormalFg.ToString (), currentTopLevelNormalFg.ToString ()); + currentRunnableNormalFg = currentSchemes ["Runnable"].Normal.Foreground; + Assert.Equal (hardCodedRunnableNormalFg.ToString (), currentRunnableNormalFg.ToString ()); } finally @@ -754,7 +754,7 @@ public class SchemeManagerTests "TestTheme": { "Schemes": [ { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "AntiqueWhite", "Background": "DimGray" @@ -890,13 +890,13 @@ public class SchemeManagerTests // Capture dynamically created hardCoded hard-coded scheme colors ImmutableSortedDictionary hardCodedSchemes = SchemeManager.GetHardCodedSchemes ()!; - Color hardCodedTopLevelNormalFg = hardCodedSchemes ["TopLevel"].Normal.Foreground; - Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), hardCodedTopLevelNormalFg.ToString ()); + Color hardCodedRunnableNormalFg = hardCodedSchemes ["Runnable"].Normal.Foreground; + Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), hardCodedRunnableNormalFg.ToString ()); // Capture current scheme colors Dictionary currentSchemes = SchemeManager.GetSchemes ()!; - Color currentTopLevelNormalFg = currentSchemes ["TopLevel"].Normal.Foreground; - Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), currentTopLevelNormalFg.ToString ()); + Color currentRunnableNormalFg = currentSchemes ["Runnable"].Normal.Foreground; + Assert.Equal (new Color (StandardColor.CadetBlue).ToString (), currentRunnableNormalFg.ToString ()); // Load the test theme ConfigurationManager.SourcesManager?.Load (Settings, json, "UpdateFromJson", ConfigLocations.Runtime); @@ -904,7 +904,7 @@ public class SchemeManagerTests Assert.Equal ("TestTheme", ThemeManager.Theme); Assert.Equal (TextStyle.Reverse, SchemeManager.GetSchemesForCurrentTheme () ["Menu"]!.Normal.Style); Dictionary? hardCodedSchemesViaScope = GetHardCodedConfigPropertiesByScope ("ThemeScope")!.ToFrozenDictionary () ["Schemes"].PropertyValue as Dictionary; - Assert.Equal (hardCodedTopLevelNormalFg.ToString (), hardCodedSchemesViaScope! ["TopLevel"].Normal.Foreground.ToString ()); + Assert.Equal (hardCodedRunnableNormalFg.ToString (), hardCodedSchemesViaScope! ["Runnable"].Normal.Foreground.ToString ()); } finally @@ -919,7 +919,7 @@ public class SchemeManagerTests Enable (ConfigLocations.HardCoded); Assert.False (SchemeManager.GetSchemes ()!.ContainsKey ("test")); - Assert.Equal (5, SchemeManager.GetSchemes ().Count); // base, toplevel, menu, error, dialog + Assert.Equal (5, SchemeManager.GetSchemes ().Count); // base, runnable, menu, error, dialog var theme = new ThemeScope (); Assert.NotEmpty (theme); @@ -943,7 +943,7 @@ public class SchemeManagerTests // Act ThemeManager.Theme = "testTheme"; ThemeManager.Themes! [ThemeManager.Theme]!.Apply (); - Assert.Equal (5, SchemeManager.GetSchemes ().Count); // base, toplevel, menu, error, dialog + Assert.Equal (5, SchemeManager.GetSchemes ().Count); // base, runnable, menu, error, dialog // Assert Scheme updatedScheme = SchemeManager.GetSchemes () ["test"]!; diff --git a/Tests/UnitTests/Configuration/SourcesManagerTests.cs b/Tests/UnitTests/Configuration/SourcesManagerTests.cs new file mode 100644 index 000000000..20e750ab0 --- /dev/null +++ b/Tests/UnitTests/Configuration/SourcesManagerTests.cs @@ -0,0 +1,47 @@ +using System.Reflection; +using System.Text.Json; + +namespace UnitTests.ConfigurationTests; + +public class SourcesManagerTests +{ + [Fact] + public void Sources_StaysConsistentWhenUpdateFails () + { + // Arrange + var sourcesManager = new SourcesManager (); + var settingsScope = new SettingsScope (); + + // Add one successful source + var validSource = "valid.json"; + var validLocation = ConfigLocations.Runtime; + sourcesManager.Load (settingsScope, """{"Application.QuitKey": "Ctrl+Z"}""", validSource, validLocation); + + try + { + // Configure to throw on errors + ConfigurationManager.ThrowOnJsonErrors = true; + + // Act & Assert - attempt to update with invalid JSON + var invalidSource = "invalid.json"; + var invalidLocation = ConfigLocations.AppCurrent; + var invalidJson = "{ invalid json }"; + + Assert.Throws ( + () => + sourcesManager.Load (settingsScope, invalidJson, invalidSource, invalidLocation)); + + // The valid source should still be there + Assert.Single (sourcesManager.Sources); + Assert.Equal (validSource, sourcesManager.Sources [validLocation]); + + // The invalid source should not have been added + Assert.DoesNotContain (invalidLocation, sourcesManager.Sources.Keys); + } + finally + { + // Reset for other tests + ConfigurationManager.ThrowOnJsonErrors = false; + } + } +} diff --git a/Tests/UnitTests/Configuration/ThemeScopeTests.cs b/Tests/UnitTests/Configuration/ThemeScopeTests.cs index 25c881d64..ca1e05aa1 100644 --- a/Tests/UnitTests/Configuration/ThemeScopeTests.cs +++ b/Tests/UnitTests/Configuration/ThemeScopeTests.cs @@ -86,6 +86,43 @@ public class ThemeScopeTests Disable (true); } + + [Fact] + public void DeSerialize_Themes_UpdateFrom_Updates () + { + Enable (ConfigLocations.HardCoded); + + IDictionary initial = ThemeManager.Themes!; + + string serialized = """ + { + "Default": { + "Button.DefaultShadow": "None" + } + } + """; + ConcurrentDictionary? deserialized = + JsonSerializer.Deserialize> (serialized, SerializerContext.Options); + + ShadowStyle initialShadowStyle = (ShadowStyle)(initial! ["Default"] ["Button.DefaultShadow"].PropertyValue!); + Assert.Equal (ShadowStyle.Opaque, initialShadowStyle); + + ShadowStyle deserializedShadowStyle = (ShadowStyle)(deserialized! ["Default"] ["Button.DefaultShadow"].PropertyValue!); + Assert.Equal (ShadowStyle.None, deserializedShadowStyle); + + initial ["Default"].UpdateFrom (deserialized ["Default"]); + initialShadowStyle = (ShadowStyle)(initial! ["Default"] ["Button.DefaultShadow"].PropertyValue!); + Assert.Equal (ShadowStyle.None, initialShadowStyle); + + Assert.Equal(ShadowStyle.Opaque, Button.DefaultShadow); + initial ["Default"].Apply (); + Assert.Equal (ShadowStyle.None, Button.DefaultShadow); + + Disable (true); + Assert.Equal (ShadowStyle.Opaque, Button.DefaultShadow); + + } + [Fact] public void Serialize_New_RoundTrip () { diff --git a/Tests/UnitTests/Dialogs/DialogTests.cs b/Tests/UnitTests/Dialogs/DialogTests.cs index b37f3225d..c9d9289fa 100644 --- a/Tests/UnitTests/Dialogs/DialogTests.cs +++ b/Tests/UnitTests/Dialogs/DialogTests.cs @@ -896,17 +896,15 @@ public class DialogTests (ITestOutputHelper output) { Dialog dlg = new (); - dlg.Ready += Dlg_Ready; + ApplicationImpl.Instance.StopAfterFirstIteration = true; Application.Run (dlg); #if DEBUG_IDISPOSABLE Assert.False (dlg.WasDisposed); - Assert.False (Application.Top!.WasDisposed); - Assert.Equal (dlg, Application.Top); #endif - Assert.True (dlg.Canceled); + Assert.False (dlg.Canceled); // Run it again is possible because it isn't disposed yet Application.Run (dlg); @@ -914,7 +912,6 @@ public class DialogTests (ITestOutputHelper output) // Run another view without dispose the prior will throw an assertion #if DEBUG_IDISPOSABLE Dialog dlg2 = new (); - dlg2.Ready += Dlg_Ready; // Exception exception = Record.Exception (() => Application.Run (dlg2)); // Assert.NotNull (exception); @@ -925,34 +922,16 @@ public class DialogTests (ITestOutputHelper output) Application.Run (dlg2); Assert.True (dlg.WasDisposed); - Assert.False (Application.Top.WasDisposed); - Assert.Equal (dlg2, Application.Top); Assert.False (dlg2.WasDisposed); dlg2.Dispose (); - // tznind REMOVED: Why wouldn't you be able to read cancelled after dispose - that makes no sense - // Now an assertion will throw accessing the Canceled property - //var exception = Record.Exception (() => Assert.True (dlg.Canceled))!; - //Assert.NotNull (exception); - //Assert.StartsWith ("Cannot access a disposed object.", exception.Message); - - Assert.True (Application.Top.WasDisposed); Application.Shutdown (); Assert.True (dlg2.WasDisposed); - Assert.Null (Application.Top); #endif - - return; - - void Dlg_Ready (object? sender, EventArgs e) - { - ((Dialog)sender!).Canceled = true; - Application.RequestStop (); - } } - [Fact] + [Fact (Skip = "Convoluted test that needs to be rewritten")] [AutoInitShutdown] public void Dialog_In_Window_With_Size_One_Button_Aligns () { @@ -972,11 +951,15 @@ public class DialogTests (ITestOutputHelper output) Application.Iteration += OnApplicationOnIteration; var btn = $"{Glyphs.LeftBracket} Ok {Glyphs.RightBracket}"; - win.Loaded += (s, a) => + win.IsModalChanged += (s, a) => { + if (!a.Value) + { + return; + } var dlg = new Dialog { Width = 18, Height = 3, Buttons = [new () { Text = "Ok" }] }; - dlg.Loaded += (s, a) => + dlg.IsModalChanged += (s, a) => { AutoInitShutdownAttribute.RunIteration (); @@ -998,7 +981,7 @@ public class DialogTests (ITestOutputHelper output) return; - void OnApplicationOnIteration (object? s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { if (++iterations > 2) { @@ -1085,7 +1068,7 @@ public class DialogTests (ITestOutputHelper output) return; - void OnApplicationOnIteration (object? s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { iterations++; @@ -1109,7 +1092,7 @@ public class DialogTests (ITestOutputHelper output) } } - [Fact] + [Fact (Skip = "Convoluted test that needs to be rewritten")] [AutoInitShutdown] public void Dialog_Opened_From_Another_Dialog () { @@ -1159,7 +1142,7 @@ public class DialogTests (ITestOutputHelper output) Application.Iteration += OnApplicationOnIteration; - Application.Run ().Dispose (); + Application.Run (); Application.Iteration -= OnApplicationOnIteration; Application.Shutdown (); @@ -1167,15 +1150,15 @@ public class DialogTests (ITestOutputHelper output) return; - void OnApplicationOnIteration (object? s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { iterations++; switch (iterations) { case 0: - Application.Top!.SetNeedsLayout (); - Application.Top.SetNeedsDraw (); + Application.TopRunnableView!.SetNeedsLayout (); + Application.TopRunnableView.SetNeedsDraw (); break; @@ -1216,7 +1199,7 @@ public class DialogTests (ITestOutputHelper output) └───────────────────────┘", output); - Assert.False (Application.Top!.NewKeyDownEvent (Key.Enter)); + Assert.False (Application.TopRunnableView!.NewKeyDownEvent (Key.Enter)); break; case 7: @@ -1242,8 +1225,8 @@ public class DialogTests (ITestOutputHelper output) { for (var i = 0; i < 8; i++) { + ApplicationImpl.Instance.StopAfterFirstIteration = true; var fd = new FileDialog (); - fd.Ready += (s, e) => Application.RequestStop (); Application.Run (fd); fd.Dispose (); } @@ -1260,6 +1243,7 @@ public class DialogTests (ITestOutputHelper output) }; Application.Begin (d); Application.Driver?.SetScreenSize (100, 100); + Application.LayoutAndDraw (); // Default location is centered, so 100 / 2 - 85 / 2 = 7 var expected = 7; @@ -1296,6 +1280,7 @@ public class DialogTests (ITestOutputHelper output) var d = new Dialog { X = expected, Y = expected, Height = 5, Width = 5 }; Application.Begin (d); Application.Driver?.SetScreenSize (20, 10); + Application.LayoutAndDraw (); // Default location is centered, so 100 / 2 - 85 / 2 = 7 Assert.Equal (new (expected, expected), d.Frame.Location); @@ -1316,7 +1301,7 @@ public class DialogTests (ITestOutputHelper output) [AutoInitShutdown] public void Modal_Captures_All_Mouse () { - var top = new Toplevel + var top = new Runnable { Id = "top" }; @@ -1348,7 +1333,7 @@ public class DialogTests (ITestOutputHelper output) return; - void OnApplicationOnIteration (object? s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { if (++iterations > 2) { @@ -1400,19 +1385,15 @@ public class DialogTests (ITestOutputHelper output) [AutoInitShutdown] public void Run_Does_Not_Dispose_Dialog () { - var top = new Toplevel (); + var top = new Runnable (); - Dialog dlg = new (); - - dlg.Ready += Dlg_Ready; + Dialog dlg = new () { }; + ApplicationImpl.Instance.StopAfterFirstIteration = true; Application.Run (dlg); #if DEBUG_IDISPOSABLE Assert.False (dlg.WasDisposed); - Assert.False (Application.Top!.WasDisposed); - Assert.NotEqual (top, Application.Top); - Assert.Equal (dlg, Application.Top); #endif // dlg wasn't disposed yet and it's possible to access to his properties @@ -1426,15 +1407,8 @@ public class DialogTests (ITestOutputHelper output) top.Dispose (); #if DEBUG_IDISPOSABLE Assert.True (dlg.WasDisposed); - Assert.True (Application.Top.WasDisposed); - Assert.NotNull (Application.Top); #endif Application.Shutdown (); - Assert.Null (Application.Top); - - return; - - void Dlg_Ready (object? sender, EventArgs e) { Application.RequestStop (); } } [Fact] @@ -1449,6 +1423,7 @@ public class DialogTests (ITestOutputHelper output) Application.Begin (d); Application.Driver?.SetScreenSize (100, 100); + Application.LayoutAndDraw (); // Default size is Percent(85) Assert.Equal (new ((int)(100 * .85), (int)(100 * .85)), d.Frame.Size); diff --git a/Tests/UnitTests/Dialogs/MessageBoxTests.cs b/Tests/UnitTests/Dialogs/MessageBoxTests.cs deleted file mode 100644 index 075067f5f..000000000 --- a/Tests/UnitTests/Dialogs/MessageBoxTests.cs +++ /dev/null @@ -1,544 +0,0 @@ -using System.Text; -using UICatalog; -using UnitTests; -using Xunit.Abstractions; - -namespace UnitTests.DialogTests; - -public class MessageBoxTests (ITestOutputHelper output) -{ - [Fact] - [AutoInitShutdown] - public void KeyBindings_Enter_Causes_Focused_Button_Click_No_Accept () - { - int result = -1; - - var iteration = 0; - - var btnAcceptCount = 0; - - Application.Iteration += OnApplicationOnIteration; - Application.Run ().Dispose (); - Application.Iteration -= OnApplicationOnIteration; - - Assert.Equal (1, result); - Assert.Equal (1, btnAcceptCount); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - iteration++; - - switch (iteration) - { - case 1: - result = MessageBox.Query (string.Empty, string.Empty, 0, false, "btn0", "btn1"); - Application.RequestStop (); - - break; - - case 2: - // Tab to btn2 - Application.RaiseKeyDownEvent (Key.Tab); - - var btn = Application.Navigation!.GetFocused () as Button; - - btn.Accepting += (sender, e) => { btnAcceptCount++; }; - - // Click - Application.RaiseKeyDownEvent (Key.Enter); - - break; - - default: - Assert.Fail (); - - break; - } - } - } - - [Fact] - [AutoInitShutdown] - public void KeyBindings_Esc_Closes () - { - var result = 999; - - var iteration = 0; - - Application.Iteration += OnApplicationOnIteration; - Application.Run ().Dispose (); - Application.Iteration -= OnApplicationOnIteration; - - Assert.Equal (-1, result); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - iteration++; - - switch (iteration) - { - case 1: - result = MessageBox.Query (string.Empty, string.Empty, 0, false, "btn0", "btn1"); - Application.RequestStop (); - - break; - - case 2: - Application.RaiseKeyDownEvent (Key.Esc); - - break; - - default: - Assert.Fail (); - - break; - } - } - } - - [Fact] - [AutoInitShutdown] - public void KeyBindings_Space_Causes_Focused_Button_Click_No_Accept () - { - int result = -1; - - var iteration = 0; - - var btnAcceptCount = 0; - - Application.Iteration += OnApplicationOnIteration; - Application.Run ().Dispose (); - Application.Iteration -= OnApplicationOnIteration; - - Assert.Equal (1, result); - Assert.Equal (1, btnAcceptCount); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - iteration++; - - switch (iteration) - { - case 1: - result = MessageBox.Query (string.Empty, string.Empty, 0, false, "btn0", "btn1"); - Application.RequestStop (); - - break; - - case 2: - // Tab to btn2 - Application.RaiseKeyDownEvent (Key.Tab); - - var btn = Application.Navigation!.GetFocused () as Button; - - btn.Accepting += (sender, e) => { btnAcceptCount++; }; - - Application.RaiseKeyDownEvent (Key.Space); - - break; - - default: - Assert.Fail (); - - break; - } - } - } - - [Theory] - [InlineData (@"", false, false, 6, 6, 2, 2)] - [InlineData (@"", false, true, 3, 6, 9, 3)] - [InlineData (@"01234\n-----\n01234", false, false, 1, 6, 13, 3)] - [InlineData (@"01234\n-----\n01234", true, false, 1, 5, 13, 4)] - [InlineData (@"0123456789", false, false, 1, 6, 12, 3)] - [InlineData (@"0123456789", false, true, 1, 5, 12, 4)] - [InlineData (@"01234567890123456789", false, true, 1, 5, 13, 4)] - [InlineData (@"01234567890123456789", true, true, 1, 5, 13, 5)] - [InlineData (@"01234567890123456789\n01234567890123456789", false, true, 1, 5, 13, 4)] - [InlineData (@"01234567890123456789\n01234567890123456789", true, true, 1, 4, 13, 7)] - [AutoInitShutdown] - public void Location_And_Size_Correct (string message, bool wrapMessage, bool hasButton, int expectedX, int expectedY, int expectedW, int expectedH) - { - int iterations = -1; - - Application.Driver!.SetScreenSize(15, 15); // 15 x 15 gives us enough room for a button with one char (9x1) - Dialog.DefaultShadow = ShadowStyle.None; - Button.DefaultShadow = ShadowStyle.None; - - var mbFrame = Rectangle.Empty; - - Application.Iteration += OnApplicationOnIteration; - - Application.Run ().Dispose (); - Application.Iteration -= OnApplicationOnIteration; - - Assert.Equal (new (expectedX, expectedY, expectedW, expectedH), mbFrame); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - iterations++; - - if (iterations == 0) - { - MessageBox.Query (string.Empty, message, 0, wrapMessage, hasButton ? ["0"] : []); - Application.RequestStop (); - } - else if (iterations == 1) - { - mbFrame = Application.Top!.Frame; - Application.RequestStop (); - } - } - } - - [Fact] - [AutoInitShutdown] - public void Message_With_Spaces_WrapMessage_False () - { - int iterations = -1; - var top = new Toplevel (); - top.BorderStyle = LineStyle.None; - Application.Driver!.SetScreenSize(20, 10); - - var btn = - $"{Glyphs.LeftBracket}{Glyphs.LeftDefaultIndicator} btn {Glyphs.RightDefaultIndicator}{Glyphs.RightBracket}"; - - // Override CM - MessageBox.DefaultButtonAlignment = Alignment.End; - MessageBox.DefaultBorderStyle = LineStyle.Double; - Dialog.DefaultShadow = ShadowStyle.None; - Button.DefaultShadow = ShadowStyle.None; - - Application.Iteration += OnApplicationOnIteration; - - Application.Run (top); - Application.Iteration -= OnApplicationOnIteration; - top.Dispose (); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - iterations++; - - if (iterations == 0) - { - var sb = new StringBuilder (); - - for (var i = 0; i < 17; i++) - { - sb.Append ("ff "); - } - - MessageBox.Query (string.Empty, sb.ToString (), 0, false, "btn"); - - Application.RequestStop (); - } - else if (iterations == 2) - { - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - ╔════════════════╗ - ║ ff ff ff ff ff ║ - ║ ⟦► btn ◄⟧║ - ╚════════════════╝", - output); - Application.RequestStop (); - - // Really long text - MessageBox.Query (string.Empty, new ('f', 500), 0, false, "btn"); - } - else if (iterations == 4) - { - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - ╔════════════════╗ - ║ffffffffffffffff║ - ║ ⟦► btn ◄⟧║ - ╚════════════════╝", - output); - Application.RequestStop (); - } - } - } - - [Fact] - [AutoInitShutdown] - public void Message_With_Spaces_WrapMessage_True () - { - int iterations = -1; - var top = new Toplevel (); - top.BorderStyle = LineStyle.None; - Application.Driver!.SetScreenSize (20, 10); - - var btn = - $"{Glyphs.LeftBracket}{Glyphs.LeftDefaultIndicator} btn {Glyphs.RightDefaultIndicator}{Glyphs.RightBracket}"; - - // Override CM - MessageBox.DefaultButtonAlignment = Alignment.End; - MessageBox.DefaultBorderStyle = LineStyle.Double; - Dialog.DefaultShadow = ShadowStyle.None; - Button.DefaultShadow = ShadowStyle.None; - - Application.Iteration += OnApplicationOnIteration; - - Application.Run (top); - Application.Iteration -= OnApplicationOnIteration; - top.Dispose (); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - iterations++; - - if (iterations == 0) - { - var sb = new StringBuilder (); - - for (var i = 0; i < 17; i++) - { - sb.Append ("ff "); - } - - MessageBox.Query (string.Empty, sb.ToString (), 0, true, "btn"); - - Application.RequestStop (); - } - else if (iterations == 2) - { - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - ╔══════════════╗ - ║ff ff ff ff ff║ - ║ff ff ff ff ff║ - ║ff ff ff ff ff║ - ║ ff ff ║ - ║ ⟦► btn ◄⟧║ - ╚══════════════╝", - output); - Application.RequestStop (); - - // Really long text - MessageBox.Query (string.Empty, new ('f', 500), 0, true, "btn"); - } - else if (iterations == 4) - { - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - ╔════════════════╗ - ║ffffffffffffffff║ - ║ffffffffffffffff║ - ║ffffffffffffffff║ - ║ffffffffffffffff║ - ║ffffffffffffffff║ - ║ffffffffffffffff║ - ║fffffff⟦► btn ◄⟧║ - ╚════════════════╝", - output); - Application.RequestStop (); - } - } - } - - [Theory (Skip = "Bogus test: Never does anything")] - [InlineData (0, 0, "1")] - [InlineData (1, 1, "1")] - [InlineData (7, 5, "1")] - [InlineData (50, 50, "1")] - [InlineData (0, 0, "message")] - [InlineData (1, 1, "message")] - [InlineData (7, 5, "message")] - [InlineData (50, 50, "message")] - [AutoInitShutdown] - public void Size_Not_Default_Message (int height, int width, string message) - { - int iterations = -1; - Application.Driver!.SetScreenSize(100, 100); - - Application.Iteration += (s, a) => - { - iterations++; - - if (iterations == 0) - { - MessageBox.Query (height, width, string.Empty, message, null); - - Application.RequestStop (); - } - else if (iterations == 1) - { - AutoInitShutdownAttribute.RunIteration (); - - Assert.IsType (Application.Top); - Assert.Equal (new (height, width), Application.Top.Frame.Size); - - Application.RequestStop (); - } - }; - } - - [Theory (Skip = "Bogus test: Never does anything")] - [InlineData (0, 0, "1")] - [InlineData (1, 1, "1")] - [InlineData (7, 5, "1")] - [InlineData (50, 50, "1")] - [InlineData (0, 0, "message")] - [InlineData (1, 1, "message")] - [InlineData (7, 5, "message")] - [InlineData (50, 50, "message")] - [AutoInitShutdown] - public void Size_Not_Default_Message_Button (int height, int width, string message) - { - int iterations = -1; - Application.Driver?.SetScreenSize(100, 100); - - Application.Iteration += (s, a) => - { - iterations++; - - if (iterations == 0) - { - MessageBox.Query (height, width, string.Empty, message, "_Ok"); - - Application.RequestStop (); - } - else if (iterations == 1) - { - AutoInitShutdownAttribute.RunIteration (); - - Assert.IsType (Application.Top); - Assert.Equal (new (height, width), Application.Top.Frame.Size); - - Application.RequestStop (); - } - }; - } - - [Theory (Skip = "Bogus test: Never does anything")] - [InlineData (0, 0)] - [InlineData (1, 1)] - [InlineData (7, 5)] - [InlineData (50, 50)] - [AutoInitShutdown] - public void Size_Not_Default_No_Message (int height, int width) - { - int iterations = -1; - Application.Driver?.SetScreenSize(100, 100); - - Application.Iteration += (s, a) => - { - iterations++; - - if (iterations == 0) - { - MessageBox.Query (height, width, string.Empty, string.Empty, null); - - Application.RequestStop (); - } - else if (iterations == 1) - { - AutoInitShutdownAttribute.RunIteration (); - - Assert.IsType (Application.Top); - Assert.Equal (new (height, width), Application.Top.Frame.Size); - - Application.RequestStop (); - } - }; - } - - [Fact] - [AutoInitShutdown] - public void UICatalog_AboutBox () - { - int iterations = -1; - Application.Driver!.SetScreenSize (70, 15); - - // Override CM - MessageBox.DefaultButtonAlignment = Alignment.End; - MessageBox.DefaultBorderStyle = LineStyle.Double; - Dialog.DefaultShadow = ShadowStyle.None; - Button.DefaultShadow = ShadowStyle.None; - - Application.Iteration += OnApplicationOnIteration; - - var top = new Toplevel (); - top.BorderStyle = LineStyle.Single; - Application.Run (top); - Application.Iteration -= OnApplicationOnIteration; - top.Dispose (); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - iterations++; - - if (iterations == 0) - { - MessageBox.Query ( - "", - UICatalog.UICatalogTop.GetAboutBoxMessage (), - wrapMessage: false, - buttons: "_Ok"); - - Application.RequestStop (); - } - else if (iterations == 2) - { - var expectedText = """ - ┌────────────────────────────────────────────────────────────────────┐ - │ ╔═══════════════════════════════════════════════════════════╗ │ - │ ║UI Catalog: A comprehensive sample library and test app for║ │ - │ ║ ║ │ - │ ║ _______ _ _ _____ _ ║ │ - │ ║|__ __| (_) | | / ____| (_) ║ │ - │ ║ | | ___ _ __ _ __ ___ _ _ __ __ _| || | __ _ _ _ ║ │ - │ ║ | |/ _ \ '__| '_ ` _ \| | '_ \ / _` | || | |_ | | | | | ║ │ - │ ║ | | __/ | | | | | | | | | | | (_| | || |__| | |_| | | ║ │ - │ ║ |_|\___|_| |_| |_| |_|_|_| |_|\__,_|_(_)_____|\__,_|_| ║ │ - │ ║ ║ │ - │ ║ v2 - Pre-Alpha ║ │ - │ ║ ⟦► Ok ◄⟧║ │ - │ ╚═══════════════════════════════════════════════════════════╝ │ - └────────────────────────────────────────────────────────────────────┘ - """; - - DriverAssert.AssertDriverContentsAre (expectedText, output); - - Application.RequestStop (); - } - } - } - - [Theory] - [MemberData (nameof (AcceptingKeys))] - [AutoInitShutdown] - public void Button_IsDefault_True_Return_His_Index_On_Accepting (Key key) - { - Application.Iteration += OnApplicationOnIteration; - int res = MessageBox.Query ("hey", "IsDefault", "Yes", "No"); - Application.Iteration -= OnApplicationOnIteration; - - Assert.Equal (0, res); - - return; - - void OnApplicationOnIteration (object o, IterationEventArgs iterationEventArgs) => Assert.True (Application.RaiseKeyDownEvent (key)); - } - - public static IEnumerable AcceptingKeys () - { - yield return [Key.Enter]; - yield return [Key.Space]; - } -} diff --git a/Tests/UnitTests/Dialogs/WizardTests.cs b/Tests/UnitTests/Dialogs/WizardTests.cs index 951e86900..fcbed9e22 100644 --- a/Tests/UnitTests/Dialogs/WizardTests.cs +++ b/Tests/UnitTests/Dialogs/WizardTests.cs @@ -12,7 +12,7 @@ public class WizardTests wizard.Dispose (); } - [Fact] + [Fact (Skip = "Convoluted test that needs to be rewritten")] [AutoInitShutdown] public void Finish_Button_Closes () { @@ -24,8 +24,8 @@ public class WizardTests var finishedFired = false; wizard.Finished += (s, args) => { finishedFired = true; }; - var closedFired = false; - wizard.Closed += (s, e) => { closedFired = true; }; + var isRunningChangedFired = false; + wizard.IsRunningChanged += (s, e) => { isRunningChangedFired = true; }; SessionToken sessionToken = Application.Begin (wizard); AutoInitShutdownAttribute.RunIteration (); @@ -34,7 +34,7 @@ public class WizardTests AutoInitShutdownAttribute.RunIteration (); Application.End (sessionToken); Assert.True (finishedFired); - Assert.True (closedFired); + Assert.True (isRunningChangedFired); step1.Dispose (); wizard.Dispose (); @@ -48,8 +48,8 @@ public class WizardTests finishedFired = false; wizard.Finished += (s, args) => { finishedFired = true; }; - closedFired = false; - wizard.Closed += (s, e) => { closedFired = true; }; + isRunningChangedFired = false; + wizard.IsRunningChanged += (s, e) => { isRunningChangedFired = true; }; sessionToken = Application.Begin (wizard); AutoInitShutdownAttribute.RunIteration (); @@ -57,14 +57,14 @@ public class WizardTests Assert.Equal (step1.Title, wizard.CurrentStep.Title); wizard.NextFinishButton.InvokeCommand (Command.Accept); Assert.False (finishedFired); - Assert.False (closedFired); + Assert.False (isRunningChangedFired); Assert.Equal (step2.Title, wizard.CurrentStep.Title); Assert.Equal (wizard.GetLastStep ().Title, wizard.CurrentStep.Title); wizard.NextFinishButton.InvokeCommand (Command.Accept); Application.End (sessionToken); Assert.True (finishedFired); - Assert.True (closedFired); + Assert.True (isRunningChangedFired); step1.Dispose (); step2.Dispose (); @@ -81,8 +81,8 @@ public class WizardTests finishedFired = false; wizard.Finished += (s, args) => { finishedFired = true; }; - closedFired = false; - wizard.Closed += (s, e) => { closedFired = true; }; + isRunningChangedFired = false; + wizard.IsRunningChanged += (s, e) => { isRunningChangedFired = true; }; sessionToken = Application.Begin (wizard); AutoInitShutdownAttribute.RunIteration (); @@ -92,7 +92,7 @@ public class WizardTests wizard.NextFinishButton.InvokeCommand (Command.Accept); Application.End (sessionToken); Assert.True (finishedFired); - Assert.True (closedFired); + Assert.True (isRunningChangedFired); wizard.Dispose (); } diff --git a/Tests/UnitTests/DriverAssert.cs b/Tests/UnitTests/DriverAssert.cs index a1abc36b5..b837e462d 100644 --- a/Tests/UnitTests/DriverAssert.cs +++ b/Tests/UnitTests/DriverAssert.cs @@ -42,7 +42,12 @@ internal partial class DriverAssert } expectedLook = expectedLook.Trim (); - driver ??= Application.Driver; + + if (driver is null && ApplicationImpl.ModelUsage == ApplicationModelUsage.LegacyStatic) + { + driver = Application.Driver; + } + ArgumentNullException.ThrowIfNull(driver); Cell [,] contents = driver!.Contents!; @@ -60,7 +65,7 @@ internal partial class DriverAssert { case 0: output.WriteLine ( - $"{Application.ToString (driver)}\n" + $"{driver.ToString ()}\n" + $"Expected Attribute {val} at Contents[{line},{c}] {contents [line, c]} was not found.\n" + $" Expected: {string.Join (",", expectedAttributes.Select (attr => attr))}\n" + $" But Was: " @@ -79,7 +84,7 @@ internal partial class DriverAssert if (colorUsed != userExpected) { - output.WriteLine ($"{Application.ToString (driver)}"); + output.WriteLine ($"{driver.ToString ()}"); output.WriteLine ($"Unexpected Attribute at Contents[{line},{c}] = {contents [line, c]}."); output.WriteLine ($" Expected: {userExpected} ({expectedAttributes [int.Parse (userExpected.ToString ())]})"); output.WriteLine ($" But Was: {colorUsed} ({val})"); @@ -152,7 +157,12 @@ internal partial class DriverAssert ) { #pragma warning restore xUnit1013 // Public method should be marked as test - var actualLook = Application.ToString (driver ?? Application.Driver); + if (driver is null && ApplicationImpl.ModelUsage == ApplicationModelUsage.LegacyStatic) + { + driver = Application.Driver; + } + ArgumentNullException.ThrowIfNull (driver); + var actualLook = driver.ToString (); if (string.Equals (expectedLook, actualLook)) { @@ -196,10 +206,13 @@ internal partial class DriverAssert IDriver? driver = null ) { - List> lines = []; + List> lines = []; var sb = new StringBuilder (); - driver ??= Application.Driver; - + if (driver is null && ApplicationImpl.ModelUsage == ApplicationModelUsage.LegacyStatic) + { + driver = Application.Driver; + } + ArgumentNullException.ThrowIfNull (driver); int x = -1; int y = -1; int w = -1; @@ -209,13 +222,13 @@ internal partial class DriverAssert for (var rowIndex = 0; rowIndex < driver.Rows; rowIndex++) { - List runes = []; + List strings = []; for (var colIndex = 0; colIndex < driver.Cols; colIndex++) { - Rune runeAtCurrentLocation = contents! [rowIndex, colIndex].Rune; + string textAtCurrentLocation = contents! [rowIndex, colIndex].Grapheme; - if (runeAtCurrentLocation != _spaceRune) + if (textAtCurrentLocation != _spaceRune.ToString ()) { if (x == -1) { @@ -224,11 +237,11 @@ internal partial class DriverAssert for (var i = 0; i < colIndex; i++) { - runes.InsertRange (i, [_spaceRune]); + strings.InsertRange (i, [_spaceRune.ToString ()]); } } - if (runeAtCurrentLocation.GetColumns () > 1) + if (textAtCurrentLocation.GetColumns () > 1) { colIndex++; } @@ -243,18 +256,13 @@ internal partial class DriverAssert if (x > -1) { - runes.Add (runeAtCurrentLocation); + strings.Add (textAtCurrentLocation); } - - // See Issue #2616 - //foreach (var combMark in contents [r, c].CombiningMarks) { - // runes.Add (combMark); - //} } - if (runes.Count > 0) + if (strings.Count > 0) { - lines.Add (runes); + lines.Add (strings); } } @@ -268,13 +276,13 @@ internal partial class DriverAssert } // Remove trailing whitespace on each line - foreach (List row in lines) + foreach (List row in lines) { for (int c = row.Count - 1; c >= 0; c--) { - Rune rune = row [c]; + string text = row [c]; - if (rune != (Rune)' ' || row.Sum (x => x.GetColumns ()) == w) + if (text != " " || row.Sum (x => x.GetColumns ()) == w) { break; } @@ -283,7 +291,7 @@ internal partial class DriverAssert } } - // Convert Rune list to string + // Convert Text list to string for (var r = 0; r < lines.Count; r++) { var line = StringExtensions.ToString (lines [r]); @@ -341,8 +349,11 @@ internal partial class DriverAssert /// internal static void AssertDriverUsedColors (IDriver? driver = null, params Attribute [] expectedColors) { - driver ??= Application.Driver; - Cell [,] contents = driver?.Contents!; + if (driver is null && ApplicationImpl.ModelUsage == ApplicationModelUsage.LegacyStatic) + { + driver = Application.Driver; + } + ArgumentNullException.ThrowIfNull (driver); Cell [,] contents = driver?.Contents!; List toFind = expectedColors.ToList (); diff --git a/Tests/UnitTests/Drivers/ClipRegionTests.cs b/Tests/UnitTests/Drivers/ClipRegionTests.cs deleted file mode 100644 index 8ede58565..000000000 --- a/Tests/UnitTests/Drivers/ClipRegionTests.cs +++ /dev/null @@ -1,105 +0,0 @@ -using System.Text; -using Xunit.Abstractions; - -// Alias Console to MockConsole so we don't accidentally use Console - -namespace UnitTests.DriverTests; - -public class ClipRegionTests (ITestOutputHelper output) -{ - private readonly ITestOutputHelper _output = output; - - [Fact] - public void AddRune_Is_Clipped () - { - Application.Init (null, "fake"); - - Application.Driver!.Move (0, 0); - Application.Driver!.AddRune ('x'); - Assert.Equal ((Rune)'x', Application.Driver!.Contents! [0, 0].Rune); - - Application.Driver?.Move (5, 5); - Application.Driver?.AddRune ('x'); - Assert.Equal ((Rune)'x', Application.Driver!.Contents [5, 5].Rune); - - // Clear the contents - Application.Driver?.FillRect (new Rectangle (0, 0, Application.Driver.Rows, Application.Driver.Cols), ' '); - Assert.Equal ((Rune)' ', Application.Driver?.Contents [0, 0].Rune); - - // Setup the region with a single rectangle, fill screen with 'x' - Application.Driver!.Clip = new (new Rectangle (5, 5, 5, 5)); - Application.Driver.FillRect (new Rectangle (0, 0, Application.Driver.Rows, Application.Driver.Cols), 'x'); - Assert.Equal ((Rune)' ', Application.Driver?.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', Application.Driver?.Contents [4, 9].Rune); - Assert.Equal ((Rune)'x', Application.Driver?.Contents [5, 5].Rune); - Assert.Equal ((Rune)'x', Application.Driver?.Contents [9, 9].Rune); - Assert.Equal ((Rune)' ', Application.Driver?.Contents [10, 10].Rune); - - Application.Shutdown (); - } - - [Fact] - public void Clip_Set_To_Empty_AllInvalid () - { - Application.Init (null, "fake"); - - // Define a clip rectangle - Application.Driver!.Clip = new (Rectangle.Empty); - - // negative - Assert.False (Application.Driver.IsValidLocation (default, 4, 5)); - Assert.False (Application.Driver.IsValidLocation (default, 5, 4)); - Assert.False (Application.Driver.IsValidLocation (default, 10, 9)); - Assert.False (Application.Driver.IsValidLocation (default, 9, 10)); - Assert.False (Application.Driver.IsValidLocation (default, -1, 0)); - Assert.False (Application.Driver.IsValidLocation (default, 0, -1)); - Assert.False (Application.Driver.IsValidLocation (default, -1, -1)); - Assert.False (Application.Driver.IsValidLocation (default, Application.Driver.Cols, Application.Driver.Rows - 1)); - Assert.False (Application.Driver.IsValidLocation (default, Application.Driver.Cols, Application.Driver.Rows - 1)); - Assert.False (Application.Driver.IsValidLocation (default, Application.Driver.Cols, Application.Driver.Rows)); - - Application.Shutdown (); - } - - [Fact] - public void IsValidLocation () - { - Application.Init (null, "fake"); - Application.Driver!.Rows = 10; - Application.Driver!.Cols = 10; - - // positive - Assert.True (Application.Driver.IsValidLocation (default, 0, 0)); - Assert.True (Application.Driver.IsValidLocation (default, 1, 1)); - Assert.True (Application.Driver.IsValidLocation (default, Application.Driver.Cols - 1, Application.Driver.Rows - 1)); - - // negative - Assert.False (Application.Driver.IsValidLocation (default, -1, 0)); - Assert.False (Application.Driver.IsValidLocation (default, 0, -1)); - Assert.False (Application.Driver.IsValidLocation (default, -1, -1)); - Assert.False (Application.Driver.IsValidLocation (default, Application.Driver.Cols, Application.Driver.Rows - 1)); - Assert.False (Application.Driver.IsValidLocation (default, Application.Driver.Cols, Application.Driver.Rows - 1)); - Assert.False (Application.Driver.IsValidLocation (default, Application.Driver.Cols, Application.Driver.Rows)); - - // Define a clip rectangle - Application.Driver.Clip = new (new Rectangle (5, 5, 5, 5)); - - // positive - Assert.True (Application.Driver.IsValidLocation (default, 5, 5)); - Assert.True (Application.Driver.IsValidLocation (default, 9, 9)); - - // negative - Assert.False (Application.Driver.IsValidLocation (default, 4, 5)); - Assert.False (Application.Driver.IsValidLocation (default, 5, 4)); - Assert.False (Application.Driver.IsValidLocation (default, 10, 9)); - Assert.False (Application.Driver.IsValidLocation (default, 9, 10)); - Assert.False (Application.Driver.IsValidLocation (default, -1, 0)); - Assert.False (Application.Driver.IsValidLocation (default, 0, -1)); - Assert.False (Application.Driver.IsValidLocation (default, -1, -1)); - Assert.False (Application.Driver.IsValidLocation (default, Application.Driver.Cols, Application.Driver.Rows - 1)); - Assert.False (Application.Driver.IsValidLocation (default, Application.Driver.Cols, Application.Driver.Rows - 1)); - Assert.False (Application.Driver.IsValidLocation (default, Application.Driver.Cols, Application.Driver.Rows)); - - Application.Shutdown (); - } -} diff --git a/Tests/UnitTests/Drivers/DriverTests.cs b/Tests/UnitTests/Drivers/DriverTests.cs deleted file mode 100644 index 558245c9e..000000000 --- a/Tests/UnitTests/Drivers/DriverTests.cs +++ /dev/null @@ -1,63 +0,0 @@ -using System.Text; -using UnitTests.ViewsTests; -using Xunit.Abstractions; - -namespace UnitTests.DriverTests; - -public class DriverTests (ITestOutputHelper output) -{ - private readonly ITestOutputHelper _output = output; - - - [Theory] - [InlineData ("fake")] - [InlineData ("windows")] - [InlineData ("dotnet")] - [InlineData ("unix")] - public void All_Drivers_Init_Shutdown_Cross_Platform (string driverName = null) - { - Application.Init (null, driverName: driverName); - Application.Shutdown (); - } - - [Theory] - [InlineData ("fake")] - [InlineData ("windows")] - [InlineData ("dotnet")] - [InlineData ("unix")] - public void All_Drivers_Run_Cross_Platform (string driverName = null) - { - Application.Init (null, driverName: driverName); - Application.StopAfterFirstIteration = true; - Application.Run ().Dispose (); - Application.Shutdown (); - } - - [Theory] - [InlineData ("fake")] - [InlineData ("windows")] - [InlineData ("dotnet")] - [InlineData ("unix")] - public void All_Drivers_LayoutAndDraw_Cross_Platform (string driverName = null) - { - Application.Init (null, driverName: driverName); - Application.StopAfterFirstIteration = true; - Application.Run ().Dispose (); - - DriverAssert.AssertDriverContentsWithFrameAre (expectedLook: driverName!, _output); - - Application.Shutdown (); - - } -} - -public class TestTop : Toplevel -{ - /// - public override void BeginInit () - { - Text = Driver!.GetName ()!; - BorderStyle = LineStyle.None; - base.BeginInit (); - } -} diff --git a/Tests/TerminalGuiFluentTesting/FakeDriver/FakeApplicationFactory.cs b/Tests/UnitTests/FakeDriver/FakeApplicationFactory.cs similarity index 81% rename from Tests/TerminalGuiFluentTesting/FakeDriver/FakeApplicationFactory.cs rename to Tests/UnitTests/FakeDriver/FakeApplicationFactory.cs index 92f644bbb..6d39b6b1d 100644 --- a/Tests/TerminalGuiFluentTesting/FakeDriver/FakeApplicationFactory.cs +++ b/Tests/UnitTests/FakeDriver/FakeApplicationFactory.cs @@ -21,17 +21,14 @@ public class FakeApplicationFactory FakeOutput output = new (); output.SetSize (80, 25); - IApplication origApp = ApplicationImpl.Instance; - SizeMonitorImpl sizeMonitor = new (output); ApplicationImpl impl = new (new FakeComponentFactory (fakeInput, output, sizeMonitor)); - - ApplicationImpl.ChangeInstance (impl); + ApplicationImpl.SetInstance (impl); // Initialize with a fake driver - impl.Init (null, "fake"); + impl.Init ("fake"); - return new FakeApplicationLifecycle (origApp, hardStopTokenSource); + return new FakeApplicationLifecycle (impl, hardStopTokenSource); } } diff --git a/Tests/TerminalGuiFluentTesting/FakeDriver/FakeApplicationLifecycle.cs b/Tests/UnitTests/FakeDriver/FakeApplicationLifecycle.cs similarity index 57% rename from Tests/TerminalGuiFluentTesting/FakeDriver/FakeApplicationLifecycle.cs rename to Tests/UnitTests/FakeDriver/FakeApplicationLifecycle.cs index 7bfbac632..df7e217c1 100644 --- a/Tests/TerminalGuiFluentTesting/FakeDriver/FakeApplicationLifecycle.cs +++ b/Tests/UnitTests/FakeDriver/FakeApplicationLifecycle.cs @@ -5,17 +5,15 @@ namespace Terminal.Gui.Drivers; /// Implements a fake application lifecycle for testing purposes. Cleans up the application on dispose by cancelling /// the provided and shutting down the application. /// -/// /// -internal class FakeApplicationLifecycle (IApplication origApp, CancellationTokenSource hardStop) : IDisposable +internal class FakeApplicationLifecycle (IApplication? app, CancellationTokenSource? hardStop) : IDisposable { /// public void Dispose () { - hardStop.Cancel (); + hardStop?.Cancel (); - Application.Top?.Dispose (); - Application.Shutdown (); - ApplicationImpl.ChangeInstance (origApp); + app?.TopRunnableView?.Dispose (); + app?.Dispose (); } } diff --git a/Tests/UnitTests/FakeDriverBase.cs b/Tests/UnitTests/FakeDriverBase.cs index f692cd914..0e6011e34 100644 --- a/Tests/UnitTests/FakeDriverBase.cs +++ b/Tests/UnitTests/FakeDriverBase.cs @@ -4,7 +4,7 @@ namespace UnitTests; /// Enables tests to create a FakeDriver for testing purposes. /// [Collection ("Global Test Setup")] -public abstract class FakeDriverBase +public abstract class FakeDriverBase /*: IDisposable*/ { /// /// Creates a new FakeDriver instance with the specified buffer size. @@ -19,14 +19,20 @@ public abstract class FakeDriverBase var output = new FakeOutput (); DriverImpl driver = new ( - new FakeInputProcessor (null), - new OutputBufferImpl (), - output, - new AnsiRequestScheduler (new AnsiResponseParser ()), - new SizeMonitorImpl (output)); + new FakeInputProcessor (null), + new OutputBufferImpl (), + output, + new AnsiRequestScheduler (new AnsiResponseParser ()), + new SizeMonitorImpl (output)); driver.SetScreenSize (width, height); return driver; } + + ///// + //public void Dispose () + //{ + // Application.ResetState (true); + //} } diff --git a/Tests/UnitTests/README.md b/Tests/UnitTests/README.md index 217607fd3..db8d0451c 100644 --- a/Tests/UnitTests/README.md +++ b/Tests/UnitTests/README.md @@ -1,3 +1,5 @@ # Automated Unit Tests (non-Parallelizable) +**IMPORTANT:** New tests belong in [UnitTests.Parallelizable](../UnitTestsParallelizable/README.md). Please use the [UnitTests.Parallelizable](../UnitTestsParallelizable/README.md) project for all new tests. + See the [Testing wiki](https://github.com/gui-cs/Terminal.Gui/wiki/Testing) for details on how to add more tests. diff --git a/Tests/UnitTests/SetupFakeApplicationAttribute.cs b/Tests/UnitTests/SetupFakeApplicationAttribute.cs index 930e44c41..8907caff5 100644 --- a/Tests/UnitTests/SetupFakeApplicationAttribute.cs +++ b/Tests/UnitTests/SetupFakeApplicationAttribute.cs @@ -19,7 +19,6 @@ public class SetupFakeApplicationAttribute : BeforeAfterTestAttribute { Debug.WriteLine ($"Before: {methodUnderTest.Name}"); - _appDispose?.Dispose (); var appFactory = new FakeApplicationFactory (); _appDispose = appFactory.SetupFakeApplication (); @@ -33,6 +32,10 @@ public class SetupFakeApplicationAttribute : BeforeAfterTestAttribute _appDispose?.Dispose (); _appDispose = null; + // TODO: This is troublesome; it seems to cause tests to hang when enabled, but shouldn't have any impact. + // TODO: Uncomment after investigation. + //ApplicationImpl.SetInstance (null); + base.After (methodUnderTest); } diff --git a/Tests/UnitTests/TestsAllViews.cs b/Tests/UnitTests/TestsAllViews.cs index 619334087..2098c1e21 100644 --- a/Tests/UnitTests/TestsAllViews.cs +++ b/Tests/UnitTests/TestsAllViews.cs @@ -1,6 +1,5 @@ #nullable enable using System.Reflection; -using System.Drawing; namespace UnitTests; @@ -65,7 +64,15 @@ public class TestsAllViews : FakeDriverBase // use or the original type if applicable foreach (Type arg in type.GetGenericArguments ()) { - if (arg.IsValueType && Nullable.GetUnderlyingType (arg) == null) + // Check if this type parameter has constraints that object can't satisfy + Type [] constraints = arg.GetGenericParameterConstraints (); + + // If there's a View constraint, use View instead of object + if (constraints.Any (c => c == typeof (View) || c.IsSubclassOf (typeof (View)))) + { + typeArguments.Add (typeof (View)); + } + else if (arg.IsValueType && Nullable.GetUnderlyingType (arg) == null) { typeArguments.Add (arg); } @@ -86,6 +93,14 @@ public class TestsAllViews : FakeDriverBase return null; } + // Check if the type has required properties that can't be satisfied by Activator.CreateInstance + // This handles cases like RunnableWrapper which has a required WrappedView property + if (HasRequiredProperties (type)) + { + Logging.Warning ($"Cannot create an instance of {type} because it has required properties that must be set."); + return null; + } + Assert.IsType (type, (View)Activator.CreateInstance (type)!); } else @@ -140,6 +155,16 @@ public class TestsAllViews : FakeDriverBase return viewType; } + /// + /// Checks if a type has required properties (C# 11 feature). + /// + private static bool HasRequiredProperties (Type type) + { + // Check all public instance properties for the RequiredMemberAttribute + return type.GetProperties (BindingFlags.Public | BindingFlags.Instance) + .Any (p => p.GetCustomAttributes (typeof (System.Runtime.CompilerServices.RequiredMemberAttribute), true).Any ()); + } + private static void AddArguments (Type paramType, List pTypes) { if (paramType == typeof (Rectangle)) @@ -164,7 +189,7 @@ public class TestsAllViews : FakeDriverBase } else if (paramType.Name == "View") { - var top = new Toplevel (); + var top = new Runnable (); var view = new View (); top.Add (view); pTypes.Add (view); diff --git a/Tests/UnitTests/Text/AutocompleteTests.cs b/Tests/UnitTests/Text/AutocompleteTests.cs index ec2a0dd44..b517cdf42 100644 --- a/Tests/UnitTests/Text/AutocompleteTests.cs +++ b/Tests/UnitTests/Text/AutocompleteTests.cs @@ -19,7 +19,7 @@ public class AutocompleteTests (ITestOutputHelper output) .Select (s => s.Value) .Distinct () .ToList (); - Toplevel top = new (); + Runnable top = new (); top.Add (tv); SessionToken rs = Application.Begin (top); @@ -165,7 +165,7 @@ This an long line and against TextView.", public void KeyBindings_Command () { var tv = new TextView { Width = 10, Height = 2, Text = " Fortunately super feature." }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); diff --git a/Tests/IntegrationTests/UICatalog/ScenarioTests.cs b/Tests/UnitTests/UICatalog/ScenarioTests.cs similarity index 93% rename from Tests/IntegrationTests/UICatalog/ScenarioTests.cs rename to Tests/UnitTests/UICatalog/ScenarioTests.cs index a7943d4e5..7f0f0c8dc 100644 --- a/Tests/IntegrationTests/UICatalog/ScenarioTests.cs +++ b/Tests/UnitTests/UICatalog/ScenarioTests.cs @@ -1,11 +1,12 @@ +#nullable enable using System.Diagnostics; using System.Reflection; using System.Runtime.InteropServices; using UICatalog; -using UnitTests; using Xunit.Abstractions; +using Timeout = System.Threading.Timeout; -namespace IntegrationTests.UICatalog; +namespace UnitTests.UICatalog; public class ScenarioTests : TestsAllViews { @@ -20,8 +21,6 @@ public class ScenarioTests : TestsAllViews private readonly ITestOutputHelper _output; - private object? _timeoutLock; - /// /// This runs through all Scenarios defined in UI Catalog, calling Init, Setup, and Run. /// Should find any Scenarios which crash on load or do not respond to . @@ -34,21 +33,21 @@ public class ScenarioTests : TestsAllViews if (RuntimeInformation.IsOSPlatform (OSPlatform.OSX)) { _output.WriteLine ($"Skipping Scenario '{scenarioType}' on macOS due to random timeout failures."); + return; } - Assert.Null (_timeoutLock); - _timeoutLock = new (); - - ConfigurationManager.Disable (true); - - // If a previous test failed, this will ensure that the Application is in a clean state - Application.ResetState (true); + // Force a complete reset + ApplicationImpl.SetInstance (null); + CM.Disable (true); _output.WriteLine ($"Running Scenario '{scenarioType}'"); Scenario? scenario = null; var scenarioName = string.Empty; - object? timeout = null; + + // Do not use Application.AddTimer for out-of-band watchdogs as + // they will be stopped by Shutdown/ResetState. + Timer? watchdogTimer = null; var timeoutFired = false; // Increase timeout for macOS - it's consistently slower @@ -90,14 +89,7 @@ public class ScenarioTests : TestsAllViews iterationHandlerRemoved = true; } - lock (_timeoutLock) - { - if (timeout is { }) - { - Application.RemoveTimeout (timeout); - timeout = null; - } - } + watchdogTimer?.Dispose (); scenario?.Dispose (); scenario = null; @@ -130,10 +122,8 @@ public class ScenarioTests : TestsAllViews Application.Iteration += OnApplicationOnIteration; initialized = true; - lock (_timeoutLock) - { - timeout = Application.AddTimeout (TimeSpan.FromMilliseconds (abortTime), ForceCloseCallback); - } + // Use a System.Threading.Timer for the watchdog to ensure it's not affected by Application.StopAllTimers + watchdogTimer = new (_ => ForceCloseCallback (), null, (int)abortTime, Timeout.Infinite); } else { @@ -144,13 +134,9 @@ public class ScenarioTests : TestsAllViews } // If the scenario doesn't close within abortTime ms, this will force it to quit - bool ForceCloseCallback () + void ForceCloseCallback () { - lock (_timeoutLock) - { - timeoutFired = true; - timeout = null; - } + timeoutFired = true; _output.WriteLine ($"TIMEOUT FIRED for {scenarioName} after {abortTime}ms. Attempting graceful shutdown."); @@ -167,11 +153,9 @@ public class ScenarioTests : TestsAllViews { _output.WriteLine ($"Exception during timeout callback: {ex.Message}"); } - - return false; } - void OnApplicationOnIteration (object? s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { iterationCount++; @@ -219,9 +203,9 @@ public class ScenarioTests : TestsAllViews List posNames = ["Percent", "AnchorEnd", "Center", "Absolute"]; List dimNames = ["Auto", "Percent", "Fill", "Absolute"]; - Application.Init (null, "fake"); + Application.Init ("fake"); - var top = new Toplevel (); + var top = new Runnable (); Dictionary viewClasses = GetAllViewClasses ().ToDictionary (t => t.Name); @@ -233,7 +217,7 @@ public class ScenarioTests : TestsAllViews Width = 15, Height = Dim.Fill (1), // for status bar CanFocus = false, - SchemeName = "TopLevel" + SchemeName = "Runnable" }; ListView classListView = new () @@ -243,7 +227,7 @@ public class ScenarioTests : TestsAllViews Width = Dim.Fill (), Height = Dim.Fill (), AllowsMarking = false, - SchemeName = "TopLevel", + SchemeName = "Runnable", Source = new ListWrapper (new (viewClasses.Keys.ToList ())) }; leftPane.Add (classListView); @@ -255,7 +239,7 @@ public class ScenarioTests : TestsAllViews Width = Dim.Fill (), Height = 10, CanFocus = false, - SchemeName = "TopLevel", + SchemeName = "Runnable", Title = "Settings" }; @@ -338,7 +322,7 @@ public class ScenarioTests : TestsAllViews hostPane.FillRect (hostPane.Viewport); } - curView = CreateClass (viewClasses.Values.ToArray () [classListView.SelectedItem]); + curView = CreateClass (viewClasses.Values.ToArray () [classListView.SelectedItem!.Value]); }; xOptionSelector.ValueChanged += (_, _) => DimPosChanged (curView); @@ -413,7 +397,7 @@ public class ScenarioTests : TestsAllViews return; - void OnApplicationOnIteration (object? s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { iterations++; @@ -425,12 +409,12 @@ public class ScenarioTests : TestsAllViews { Assert.Equal ( curView.GetType ().Name, - viewClasses.Values.ToArray () [classListView.SelectedItem].Name); + viewClasses.Values.ToArray () [classListView.SelectedItem!.Value].Name); } } else { - Application.RequestStop (); + a.Value?.RequestStop (); } } @@ -517,7 +501,7 @@ public class ScenarioTests : TestsAllViews } catch (Exception e) { - MessageBox.ErrorQuery ("Exception", e.Message, "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Exception", e.Message, "Ok"); } UpdateTitle (view); @@ -621,7 +605,7 @@ public class ScenarioTests : TestsAllViews } catch (TargetInvocationException e) { - MessageBox.ErrorQuery ("Exception", e.InnerException!.Message, "Ok"); + MessageBox.ErrorQuery (ApplicationImpl.Instance, "Exception", e.InnerException!.Message, "Ok"); view = null; } } diff --git a/Tests/UnitTests/UnitTests.csproj b/Tests/UnitTests/UnitTests.csproj index 10ee70744..032f6b6c9 100644 --- a/Tests/UnitTests/UnitTests.csproj +++ b/Tests/UnitTests/UnitTests.csproj @@ -26,6 +26,11 @@ true + + + + + diff --git a/Tests/UnitTests/View/Adornment/AdornmentSubViewTests.cs b/Tests/UnitTests/View/Adornment/AdornmentSubViewTests.cs deleted file mode 100644 index 52d5bc01e..000000000 --- a/Tests/UnitTests/View/Adornment/AdornmentSubViewTests.cs +++ /dev/null @@ -1,73 +0,0 @@ -using Xunit.Abstractions; - -namespace UnitTests.ViewTests; - -public class AdornmentSubViewTests (ITestOutputHelper output) -{ - private readonly ITestOutputHelper _output = output; - - [Theory] - [InlineData (0, 0, false)] // Margin has no thickness, so false - [InlineData (0, 1, false)] // Margin has no thickness, so false - [InlineData (1, 0, true)] - [InlineData (1, 1, true)] - [InlineData (2, 1, true)] - public void Adornment_WithSubView_Finds (int viewMargin, int subViewMargin, bool expectedFound) - { - Application.Top = new Toplevel() - { - Width = 10, - Height = 10 - }; - Application.Top.Margin!.Thickness = new Thickness (viewMargin); - // Turn of TransparentMouse for the test - Application.Top.Margin!.ViewportSettings = ViewportSettingsFlags.None; - - var subView = new View () - { - X = 0, - Y = 0, - Width = 5, - Height = 5 - }; - subView.Margin!.Thickness = new Thickness (subViewMargin); - // Turn of TransparentMouse for the test - subView.Margin!.ViewportSettings = ViewportSettingsFlags.None; - - Application.Top.Margin!.Add (subView); - Application.Top.Layout (); - - var foundView = View.GetViewsUnderLocation (new Point(0, 0), ViewportSettingsFlags.None).LastOrDefault (); - - bool found = foundView == subView || foundView == subView.Margin; - Assert.Equal (expectedFound, found); - Application.Top.Dispose (); - Application.ResetState (ignoreDisposed: true); - } - - [Fact] - public void Adornment_WithNonVisibleSubView_Finds_Adornment () - { - Application.Top = new Toplevel () - { - Width = 10, - Height = 10 - }; - Application.Top.Padding.Thickness = new Thickness (1); - - var subView = new View () - { - X = 0, - Y = 0, - Width = 1, - Height = 1, - Visible = false - }; - Application.Top.Padding.Add (subView); - Application.Top.Layout (); - - Assert.Equal (Application.Top.Padding, View.GetViewsUnderLocation (new Point(0, 0), ViewportSettingsFlags.None).LastOrDefault ()); - Application.Top?.Dispose (); - Application.ResetState (ignoreDisposed: true); - } -} diff --git a/Tests/UnitTests/View/Adornment/AdornmentTests.cs b/Tests/UnitTests/View/Adornment/AdornmentTests.cs index 176dbc719..6c19e7c70 100644 --- a/Tests/UnitTests/View/Adornment/AdornmentTests.cs +++ b/Tests/UnitTests/View/Adornment/AdornmentTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; public class AdornmentTests (ITestOutputHelper output) { @@ -9,7 +9,11 @@ public class AdornmentTests (ITestOutputHelper output) [SetupFakeApplication] public void Border_Is_Cleared_After_Margin_Thickness_Change () { - View view = new () { Text = "View", Width = 6, Height = 3, BorderStyle = LineStyle.Rounded }; + View view = new () + { + App = ApplicationImpl.Instance, + Text = "View", Width = 6, Height = 3, BorderStyle = LineStyle.Rounded + }; // Remove border bottom thickness view.Border!.Thickness = new (1, 1, 1, 0); @@ -59,7 +63,7 @@ public class AdornmentTests (ITestOutputHelper output) Assert.Equal (6, view.Width); Assert.Equal (3, view.Height); - View.SetClipToScreen (); + view.SetClipToScreen (); view.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( diff --git a/Tests/UnitTests/View/Adornment/BorderTests.cs b/Tests/UnitTests/View/Adornment/BorderTests.cs index 80a769258..332cd0304 100644 --- a/Tests/UnitTests/View/Adornment/BorderTests.cs +++ b/Tests/UnitTests/View/Adornment/BorderTests.cs @@ -1,6 +1,6 @@ using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; public class BorderTests (ITestOutputHelper output) { @@ -8,7 +8,11 @@ public class BorderTests (ITestOutputHelper output) [SetupFakeApplication] public void Border_Parent_HasFocus_Title_Uses_FocusAttribute () { - var superView = new View { Width = 10, Height = 10, CanFocus = true }; + var superView = new View + { + Driver = ApplicationImpl.Instance.Driver, + Width = 10, Height = 10, CanFocus = true + }; var otherView = new View { Width = 0, Height = 0, CanFocus = true }; superView.Add (otherView); @@ -39,7 +43,7 @@ public class BorderTests (ITestOutputHelper output) view.CanFocus = true; view.SetFocus (); - View.SetClipToScreen (); + view.SetClipToScreen (); view.Draw (); Assert.Equal (view.GetAttributeForRole (VisualRole.Focus), view.Border!.GetAttributeForRole (VisualRole.Focus)); Assert.Equal (view.GetScheme ().Focus.Foreground, view.Border!.GetAttributeForRole (VisualRole.Focus).Foreground); @@ -51,7 +55,11 @@ public class BorderTests (ITestOutputHelper output) [SetupFakeApplication] public void Border_Uses_Parent_Scheme () { - var view = new View { Title = "A", Height = 2, Width = 5 }; + var view = new View + { + Driver = ApplicationImpl.Instance.Driver, + Title = "A", Height = 2, Width = 5 + }; view.Border!.Thickness = new (0, 1, 0, 0); view.Border!.LineStyle = LineStyle.Single; @@ -721,7 +729,7 @@ public class BorderTests (ITestOutputHelper output) [AutoInitShutdown] public void HasSuperView () { - var top = new Toplevel (); + var top = new Runnable (); top.BorderStyle = LineStyle.Double; var frame = new FrameView { Width = Dim.Fill (), Height = Dim.Fill (), BorderStyle = LineStyle.Single }; @@ -748,7 +756,7 @@ public class BorderTests (ITestOutputHelper output) [AutoInitShutdown] public void HasSuperView_Title () { - var top = new Toplevel (); + var top = new Runnable (); top.BorderStyle = LineStyle.Double; var frame = new FrameView { Title = "1234", Width = Dim.Fill (), Height = Dim.Fill (), BorderStyle = LineStyle.Single }; @@ -839,6 +847,7 @@ public class BorderTests (ITestOutputHelper output) { var superView = new View { + Driver = ApplicationImpl.Instance.Driver, Id = "superView", Width = 5, Height = 5, @@ -902,6 +911,7 @@ public class BorderTests (ITestOutputHelper output) { var superView = new View { + Driver = ApplicationImpl.Instance.Driver, Id = "superView", Title = "A", Width = 11, diff --git a/Tests/UnitTests/View/Adornment/MarginTests.cs b/Tests/UnitTests/View/Adornment/MarginTests.cs deleted file mode 100644 index 82053e1ef..000000000 --- a/Tests/UnitTests/View/Adornment/MarginTests.cs +++ /dev/null @@ -1,81 +0,0 @@ -using UnitTests; -using Xunit.Abstractions; - -namespace UnitTests.ViewTests; - -public class MarginTests (ITestOutputHelper output) -{ - [Fact] - [SetupFakeApplication] - public void Margin_Is_Transparent () - { - Application.Driver!.SetScreenSize (5, 5); - - var view = new View { Height = 3, Width = 3 }; - view.Margin!.Diagnostics = ViewDiagnosticFlags.Thickness; - view.Margin.Thickness = new (1); - - Application.Top = new Toplevel (); - Application.TopLevels.Push (Application.Top); - - Application.Top.SetScheme (new() - { - Normal = new (Color.Red, Color.Green), Focus = new (Color.Green, Color.Red) - }); - - Application.Top.Add (view); - Assert.Equal (ColorName16.Red, view.Margin.GetAttributeForRole (VisualRole.Normal).Foreground.GetClosestNamedColor16 ()); - Assert.Equal (ColorName16.Red, Application.Top.GetAttributeForRole (VisualRole.Normal).Foreground.GetClosestNamedColor16 ()); - - Application.Top.BeginInit (); - Application.Top.EndInit (); - Application.LayoutAndDraw(); - - DriverAssert.AssertDriverContentsAre ( - @"", - output - ); - DriverAssert.AssertDriverAttributesAre ("0", output, null, Application.Top.GetAttributeForRole (VisualRole.Normal)); - - Application.ResetState (true); - } - - [Fact] - [SetupFakeApplication] - public void Margin_ViewPortSettings_Not_Transparent_Is_NotTransparent () - { - Application.Driver!.SetScreenSize (5, 5); - - var view = new View { Height = 3, Width = 3 }; - view.Margin!.Diagnostics = ViewDiagnosticFlags.Thickness; - view.Margin.Thickness = new (1); - view.Margin.ViewportSettings = ViewportSettingsFlags.None; - - Application.Top = new Toplevel (); - Application.TopLevels.Push (Application.Top); - - Application.Top.SetScheme (new () - { - Normal = new (Color.Red, Color.Green), Focus = new (Color.Green, Color.Red) - }); - - Application.Top.Add (view); - Assert.Equal (ColorName16.Red, view.Margin.GetAttributeForRole (VisualRole.Normal).Foreground.GetClosestNamedColor16 ()); - Assert.Equal (ColorName16.Red, Application.Top.GetAttributeForRole (VisualRole.Normal).Foreground.GetClosestNamedColor16 ()); - - Application.Top.BeginInit (); - Application.Top.EndInit (); - Application.LayoutAndDraw (); - - DriverAssert.AssertDriverContentsAre ( - @" -MMM -M M -MMM", - output - ); - DriverAssert.AssertDriverAttributesAre ("0", output, null, Application.Top.GetAttributeForRole (VisualRole.Normal)); - - Application.ResetState (true); - } -} diff --git a/Tests/UnitTests/View/Adornment/PaddingTests.cs b/Tests/UnitTests/View/Adornment/PaddingTests.cs index d869a8d26..ad96a1d0a 100644 --- a/Tests/UnitTests/View/Adornment/PaddingTests.cs +++ b/Tests/UnitTests/View/Adornment/PaddingTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; public class PaddingTests (ITestOutputHelper output) { @@ -9,8 +9,12 @@ public class PaddingTests (ITestOutputHelper output) [SetupFakeApplication] public void Padding_Uses_Parent_Scheme () { - Application.Driver!.SetScreenSize (5, 5); - var view = new View { Height = 3, Width = 3 }; + ApplicationImpl.Instance.Driver!.SetScreenSize (5, 5); + var view = new View + { + App = ApplicationImpl.Instance, + Height = 3, Width = 3 + }; view.Padding!.Thickness = new (1); view.Padding.Diagnostics = ViewDiagnosticFlags.Thickness; diff --git a/Tests/UnitTests/View/Adornment/ShadowStyleTests.cs b/Tests/UnitTests/View/Adornment/ShadowStyleTests.cs index d640a314c..ef8cb488e 100644 --- a/Tests/UnitTests/View/Adornment/ShadowStyleTests.cs +++ b/Tests/UnitTests/View/Adornment/ShadowStyleTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; public class ShadowStyleTests (ITestOutputHelper output) { @@ -46,8 +46,9 @@ public class ShadowStyleTests (ITestOutputHelper output) new (fg.GetDimColor (), bg.GetDimColor ()) }; - var superView = new Toplevel + var superView = new Runnable { + Driver = ApplicationImpl.Instance.Driver, Height = 3, Width = 3, Text = "012ABC!@#", @@ -65,9 +66,10 @@ public class ShadowStyleTests (ITestOutputHelper output) view.SetScheme (new (Attribute.Default)); superView.Add (view); - Application.TopLevels.Push (superView); + Application.Begin (superView); Application.LayoutAndDraw (true); DriverAssert.AssertDriverAttributesAre (expectedAttrs, output, Application.Driver, attributes); + superView.Dispose (); Application.ResetState (true); } @@ -102,8 +104,9 @@ public class ShadowStyleTests (ITestOutputHelper output) { Application.Driver!.SetScreenSize (5, 5); - var superView = new Toplevel + var superView = new Runnable { + Driver = ApplicationImpl.Instance.Driver, Width = 4, Height = 4, Text = "!@#$".Repeat (4)! @@ -118,11 +121,11 @@ public class ShadowStyleTests (ITestOutputHelper output) }; view.ShadowStyle = style; superView.Add (view); - Application.TopLevels.Push (superView); + Application.Begin (superView); Application.LayoutAndDraw (true); DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - view.Dispose (); + superView.Dispose (); Application.ResetState (true); } @@ -136,7 +139,8 @@ public class ShadowStyleTests (ITestOutputHelper output) { var superView = new View { - Height = 10, Width = 10 + Height = 10, Width = 10, + App = ApplicationImpl.Instance }; View view = new () diff --git a/Tests/UnitTests/View/ArrangementTests.cs b/Tests/UnitTests/View/ArrangementTests.cs new file mode 100644 index 000000000..19aa25c5d --- /dev/null +++ b/Tests/UnitTests/View/ArrangementTests.cs @@ -0,0 +1,217 @@ +using Xunit.Abstractions; + +namespace UnitTests.ViewBaseTests; + +public class ArrangementTests (ITestOutputHelper output) +{ + private readonly ITestOutputHelper _output = output; + + [Fact] + public void MouseGrabHandler_WorksWithMovableView_UsingNewMouseEvent () + { + // This test proves that MouseGrabHandler works correctly with concurrent unit tests + // using NewMouseEvent directly on views, without requiring Application.Init + + var superView = new View + { + Width = 80, + Height = 25 + }; + superView.App = ApplicationImpl.Instance; + + var movableView = new View + { + Arrangement = ViewArrangement.Movable, + BorderStyle = LineStyle.Single, + X = 10, + Y = 10, + Width = 20, + Height = 10 + }; + + superView.Add (movableView); + + // Verify initial state + Assert.NotNull (movableView.Border); + Assert.Null (Application.Mouse.MouseGrabView); + + // Simulate mouse press on the border to start dragging + var pressEvent = new MouseEventArgs + { + Position = new (1, 0), // Top border area + Flags = MouseFlags.Button1Pressed + }; + + bool? result = movableView.Border.NewMouseEvent (pressEvent); + + // The border should have grabbed the mouse + Assert.True (result); + Assert.Equal (movableView.Border, superView.App.Mouse.MouseGrabView); + + // Simulate mouse drag + var dragEvent = new MouseEventArgs + { + Position = new (5, 2), + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + result = movableView.Border.NewMouseEvent (dragEvent); + Assert.True (result); + + // Mouse should still be grabbed + Assert.Equal (movableView.Border, superView.App.Mouse.MouseGrabView); + + // Simulate mouse release to end dragging + var releaseEvent = new MouseEventArgs + { + Position = new (5, 2), + Flags = MouseFlags.Button1Released + }; + + result = movableView.Border.NewMouseEvent (releaseEvent); + Assert.True (result); + + // Mouse should be released + Assert.Null (superView.App.Mouse.MouseGrabView); + } + + [Fact] + public void MouseGrabHandler_WorksWithResizableView_UsingNewMouseEvent () + { + // This test proves MouseGrabHandler works for resizing operations + + var superView = new View + { + App = ApplicationImpl.Instance, + Width = 80, + Height = 25 + }; + + var resizableView = new View + { + Arrangement = ViewArrangement.RightResizable, + BorderStyle = LineStyle.Single, + X = 10, + Y = 10, + Width = 20, + Height = 10 + }; + + superView.Add (resizableView); + + // Verify initial state + Assert.NotNull (resizableView.Border); + Assert.Null (Application.Mouse.MouseGrabView); + + // Calculate position on right border (border is at right edge) + // Border.Frame.X is relative to parent, so we use coordinates relative to the border + var pressEvent = new MouseEventArgs + { + Position = new (resizableView.Border.Frame.Width - 1, 5), // Right border area + Flags = MouseFlags.Button1Pressed + }; + + bool? result = resizableView.Border.NewMouseEvent (pressEvent); + + // The border should have grabbed the mouse for resizing + Assert.True (result); + Assert.Equal (resizableView.Border, superView.App.Mouse.MouseGrabView); + + // Simulate dragging to resize + var dragEvent = new MouseEventArgs + { + Position = new (resizableView.Border.Frame.Width + 3, 5), + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + result = resizableView.Border.NewMouseEvent (dragEvent); + Assert.True (result); + Assert.Equal (resizableView.Border, superView.App.Mouse.MouseGrabView); + + // Simulate mouse release + var releaseEvent = new MouseEventArgs + { + Position = new (resizableView.Border.Frame.Width + 3, 5), + Flags = MouseFlags.Button1Released + }; + + result = resizableView.Border.NewMouseEvent (releaseEvent); + Assert.True (result); + + // Mouse should be released + Assert.Null (superView.App.Mouse.MouseGrabView); + } + + [Fact] + public void MouseGrabHandler_ReleasesOnMultipleViews () + { + // This test verifies MouseGrabHandler properly releases when switching between views + + var superView = new View { Width = 80, Height = 25 }; + superView.App = ApplicationImpl.Instance; + + var view1 = new View + { + Arrangement = ViewArrangement.Movable, + BorderStyle = LineStyle.Single, + X = 10, + Y = 10, + Width = 15, + Height = 8 + }; + + var view2 = new View + { + Arrangement = ViewArrangement.Movable, + BorderStyle = LineStyle.Single, + X = 30, + Y = 10, + Width = 15, + Height = 8 + }; + + superView.Add (view1, view2); + superView.BeginInit (); + superView.EndInit (); + + // Grab mouse on first view + var pressEvent1 = new MouseEventArgs + { + Position = new (1, 0), + Flags = MouseFlags.Button1Pressed + }; + + view1.Border!.NewMouseEvent (pressEvent1); + Assert.Equal (view1.Border, superView.App.Mouse.MouseGrabView); + + // Release on first view + var releaseEvent1 = new MouseEventArgs + { + Position = new (1, 0), + Flags = MouseFlags.Button1Released + }; + + view1.Border.NewMouseEvent (releaseEvent1); + Assert.Null (Application.Mouse.MouseGrabView); + + // Grab mouse on second view + var pressEvent2 = new MouseEventArgs + { + Position = new (1, 0), + Flags = MouseFlags.Button1Pressed + }; + + view2.Border!.NewMouseEvent (pressEvent2); + Assert.Equal (view2.Border, superView.App.Mouse.MouseGrabView); + + // Release on second view + var releaseEvent2 = new MouseEventArgs + { + Position = new (1, 0), + Flags = MouseFlags.Button1Released + }; + + view2.Border.NewMouseEvent (releaseEvent2); + Assert.Null (superView.App.Mouse.MouseGrabView); + } +} diff --git a/Tests/UnitTests/View/DiagnosticsTests.cs b/Tests/UnitTests/View/DiagnosticsTests.cs index 258a0ab3b..d5b95b1e7 100644 --- a/Tests/UnitTests/View/DiagnosticsTests.cs +++ b/Tests/UnitTests/View/DiagnosticsTests.cs @@ -1,7 +1,7 @@ #nullable enable using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; /// /// Tests static property and enum. diff --git a/Tests/UnitTests/View/Draw/ClearViewportTests.cs b/Tests/UnitTests/View/Draw/ClearViewportTests.cs index 3cdcc9401..8c8e3c54f 100644 --- a/Tests/UnitTests/View/Draw/ClearViewportTests.cs +++ b/Tests/UnitTests/View/Draw/ClearViewportTests.cs @@ -3,7 +3,7 @@ using Moq; using UnitTests; using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; [Trait ("Category", "Output")] public class ClearViewportTests (ITestOutputHelper output) @@ -101,7 +101,11 @@ public class ClearViewportTests (ITestOutputHelper output) [SetupFakeApplication] public void Clear_ClearsEntireViewport () { - var superView = new View { Width = Dim.Fill (), Height = Dim.Fill () }; + var superView = new View + { + App = ApplicationImpl.Instance, + Width = Dim.Fill (), Height = Dim.Fill () + }; var view = new View { @@ -133,7 +137,7 @@ public class ClearViewportTests (ITestOutputHelper output) └─┘", output); - View.SetClipToScreen (); + view.SetClipToScreen (); view.ClearViewport (); @@ -149,7 +153,11 @@ public class ClearViewportTests (ITestOutputHelper output) [SetupFakeApplication] public void Clear_WithClearVisibleContentOnly_ClearsVisibleContentOnly () { - var superView = new View { Width = Dim.Fill (), Height = Dim.Fill () }; + var superView = new View + { + App = ApplicationImpl.Instance, + Width = Dim.Fill (), Height = Dim.Fill () + }; var view = new View { @@ -172,7 +180,7 @@ public class ClearViewportTests (ITestOutputHelper output) │X│ └─┘", output); - View.SetClipToScreen (); + view.SetClipToScreen (); view.ClearViewport (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -203,13 +211,14 @@ public class ClearViewportTests (ITestOutputHelper output) } } - View.SetClip (savedClip); + view.SetClip (savedClip); e.Cancel = true; }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (view); Application.Begin (top); Application.Driver!.SetScreenSize (20, 10); + Application.LayoutAndDraw (); var expected = @" ┌──────────────────┐ @@ -268,13 +277,14 @@ public class ClearViewportTests (ITestOutputHelper output) } } - View.SetClip (savedClip); + view.SetClip (savedClip); e.Cancel = true; }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (view); Application.Begin (top); Application.Driver!.SetScreenSize (20, 10); + Application.LayoutAndDraw (); var expected = @" ┌──────────────────┐ @@ -312,103 +322,4 @@ public class ClearViewportTests (ITestOutputHelper output) top.Dispose (); } - - [Theory (Skip = "This test is too fragile; depends on Library Resoruces/Themes which can easily change.")] - [AutoInitShutdown] - [InlineData (true)] - [InlineData (false)] - public void Clear_Does_Not_Spillover_Its_Parent (bool label) - { - ConfigurationManager.Enable (ConfigLocations.LibraryResources); - - View root = new () { Width = 20, Height = 10 }; - - string text = new ('c', 100); - - View v = label - - // Label has Width/Height == AutoSize, so Frame.Size will be (100, 1) - ? new Label { Text = text } - - // TextView has Width/Height == (Dim.Fill, 1), so Frame.Size will be 20 (width of root), 1 - : new TextView { Width = Dim.Fill (), Height = 1, Text = text }; - - root.Add (v); - - Toplevel top = new (); - top.Add (root); - SessionToken sessionToken = Application.Begin (top); - AutoInitShutdownAttribute.RunIteration (); - - if (label) - { - Assert.False (v.CanFocus); - Assert.Equal (new (0, 0, text.Length, 1), v.Frame); - } - else - { - Assert.True (v.CanFocus); - Assert.Equal (new (0, 0, 20, 1), v.Frame); - } - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -cccccccccccccccccccc", - output - ); - - Attribute [] attributes = - { - SchemeManager.GetSchemes () ["TopLevel"]!.Normal, - SchemeManager.GetSchemes () ["Base"]!.Normal, - SchemeManager.GetSchemes () ["Base"]!.Focus - }; - - if (label) - { - DriverAssert.AssertDriverAttributesAre ( - @" -111111111111111111110 -111111111111111111110", - output, - Application.Driver, - attributes - ); - } - else - { - DriverAssert.AssertDriverAttributesAre ( - @" -222222222222222222220 -111111111111111111110", - output, - Application.Driver, - attributes - ); - } - - if (label) - { - root.CanFocus = true; - v.CanFocus = true; - Assert.True (v.HasFocus); - v.SetFocus (); - Assert.True (v.HasFocus); - Application.LayoutAndDraw (); - - DriverAssert.AssertDriverAttributesAre ( - @" -222222222222222222220 -111111111111111111110", - output, - Application.Driver, - attributes - ); - } - - Application.End (sessionToken); - top.Dispose (); - - CM.Disable (resetToHardCodedDefaults: true); - } } diff --git a/Tests/UnitTests/View/Draw/ClipTests.cs b/Tests/UnitTests/View/Draw/ClipTests.cs index 44b120d76..565795f85 100644 --- a/Tests/UnitTests/View/Draw/ClipTests.cs +++ b/Tests/UnitTests/View/Draw/ClipTests.cs @@ -3,7 +3,7 @@ using System.Text; using UnitTests; using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; [Trait ("Category", "Output")] public class ClipTests (ITestOutputHelper _output) @@ -14,6 +14,7 @@ public class ClipTests (ITestOutputHelper _output) { var view = new View { + App = ApplicationImpl.Instance, X = 1, Y = 1, Width = 3, Height = 3 @@ -36,6 +37,7 @@ public class ClipTests (ITestOutputHelper _output) { var view = new View { + App = ApplicationImpl.Instance, X = 1, Y = 1, Width = 3, Height = 3 @@ -47,17 +49,17 @@ public class ClipTests (ITestOutputHelper _output) view.Draw (); // Only valid location w/in Viewport is 0, 0 (view) - 2, 2 (screen) - Assert.Equal ((Rune)' ', Application.Driver?.Contents! [2, 2].Rune); + Assert.Equal (" ", Application.Driver?.Contents! [2, 2].Grapheme); // When we exit Draw, the view is excluded from the clip. So drawing at 0,0, is not valid and is clipped. view.AddRune (0, 0, Rune.ReplacementChar); - Assert.Equal ((Rune)' ', Application.Driver?.Contents! [2, 2].Rune); + Assert.Equal (" ", Application.Driver?.Contents! [2, 2].Grapheme); view.AddRune (-1, -1, Rune.ReplacementChar); - Assert.Equal ((Rune)'P', Application.Driver?.Contents! [1, 1].Rune); + Assert.Equal ("P", Application.Driver?.Contents! [1, 1].Grapheme); view.AddRune (1, 1, Rune.ReplacementChar); - Assert.Equal ((Rune)'P', Application.Driver?.Contents! [3, 3].Rune); + Assert.Equal ("P", Application.Driver?.Contents! [3, 3].Grapheme); } [Theory] @@ -67,7 +69,11 @@ public class ClipTests (ITestOutputHelper _output) [SetupFakeApplication] public void FillRect_Fills_HonorsClip (int x, int y, int width, int height) { - var superView = new View { Width = Dim.Fill (), Height = Dim.Fill () }; + var superView = new View + { + App = ApplicationImpl.Instance, + Width = Dim.Fill (), Height = Dim.Fill () + }; var view = new View { @@ -91,7 +97,7 @@ public class ClipTests (ITestOutputHelper _output) _output); Rectangle toFill = new (x, y, width, height); - View.SetClipToScreen (); + superView.SetClipToScreen (); view.FillRect (toFill); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -133,7 +139,7 @@ public class ClipTests (ITestOutputHelper _output) _output); toFill = new (-1, -1, width + 1, height + 1); - View.SetClipToScreen (); + superView.SetClipToScreen (); view.FillRect (toFill); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -154,7 +160,7 @@ public class ClipTests (ITestOutputHelper _output) └─┘", _output); toFill = new (0, 0, width * 2, height * 2); - View.SetClipToScreen (); + superView.SetClipToScreen (); view.FillRect (toFill); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -175,6 +181,7 @@ public class ClipTests (ITestOutputHelper _output) var top = new View { + App = ApplicationImpl.Instance, Id = "top", Width = Dim.Fill (), Height = Dim.Fill () @@ -193,7 +200,7 @@ public class ClipTests (ITestOutputHelper _output) frameView.Border!.Thickness = new (1, 0, 0, 0); top.Add (frameView); - View.SetClipToScreen (); + top.SetClipToScreen (); top.Layout (); top.Draw (); @@ -217,7 +224,7 @@ public class ClipTests (ITestOutputHelper _output) top.Add (view); top.Layout (); - View.SetClipToScreen (); + top.SetClipToScreen (); top.Draw (); // 012345678901234567890123456789012345678 @@ -226,7 +233,7 @@ public class ClipTests (ITestOutputHelper _output) // 01 2345678901234 56 78 90 12 34 56 // │� |0123456989│� ン ラ イ ン で す 。 expectedOutput = """ - │�│0123456789│�ンラインです。 + │�│0123456789│ ンラインです。 """; DriverAssert.AssertDriverContentsWithFrameAre (expectedOutput, _output); @@ -252,19 +259,20 @@ public class ClipTests (ITestOutputHelper _output) { Width = Dim.Fill (), Height = Dim.Fill (), - ViewportSettings = ViewportSettingsFlags.ClipContentOnly + ViewportSettings = ViewportSettingsFlags.ClipContentOnly, + App = ApplicationImpl.Instance }; view.SetContentSize (new Size (10, 10)); view.Border!.Thickness = new (1); view.BeginInit (); view.EndInit (); - Assert.Equal (view.Frame, View.GetClip ()!.GetBounds ()); + Assert.Equal (view.Frame, view.GetClip ()!.GetBounds ()); // Act view.AddViewportToClip (); // Assert - Assert.Equal (expectedClip, View.GetClip ()!.GetBounds ()); + Assert.Equal (expectedClip, view.GetClip ()!.GetBounds ()); view.Dispose (); } @@ -286,20 +294,21 @@ public class ClipTests (ITestOutputHelper _output) var view = new View { Width = Dim.Fill (), - Height = Dim.Fill () + Height = Dim.Fill (), + App = ApplicationImpl.Instance }; view.SetContentSize (new Size (10, 10)); view.Border!.Thickness = new (1); view.BeginInit (); view.EndInit (); - Assert.Equal (view.Frame, View.GetClip ()!.GetBounds ()); + Assert.Equal (view.Frame, view.GetClip ()!.GetBounds ()); view.Viewport = view.Viewport with { X = 1, Y = 1 }; // Act view.AddViewportToClip (); // Assert - Assert.Equal (expectedClip, View.GetClip ()!.GetBounds ()); + Assert.Equal (expectedClip, view.GetClip ()!.GetBounds ()); view.Dispose (); } } diff --git a/Tests/UnitTests/View/Draw/DrawEventTests.cs b/Tests/UnitTests/View/Draw/DrawEventTests.cs index 4b091d971..c037af3d5 100644 --- a/Tests/UnitTests/View/Draw/DrawEventTests.cs +++ b/Tests/UnitTests/View/Draw/DrawEventTests.cs @@ -1,7 +1,7 @@ #nullable enable using UnitTests; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; [Trait ("Category", "Output")] public class DrawEventTests @@ -18,7 +18,7 @@ public class DrawEventTests var tv = new TextView { Y = 11, Width = 10, Height = 10 }; tv.DrawComplete += (s, e) => tvCalled = true; - var top = new Toplevel (); + var top = new Runnable (); top.Add (view, tv); Application.Begin (top); AutoInitShutdownAttribute.RunIteration (); diff --git a/Tests/UnitTests/View/Draw/DrawTests.cs b/Tests/UnitTests/View/Draw/DrawTests.cs index 2526c2178..7cce52b6b 100644 --- a/Tests/UnitTests/View/Draw/DrawTests.cs +++ b/Tests/UnitTests/View/Draw/DrawTests.cs @@ -3,7 +3,7 @@ using System.Text; using UnitTests; using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; [Trait ("Category", "Output")] public class DrawTests (ITestOutputHelper output) @@ -14,31 +14,32 @@ public class DrawTests (ITestOutputHelper output) [Trait ("Category", "Unicode")] public void CJK_Compatibility_Ideographs_ConsoleWidth_ColumnWidth_Equal_Two () { - const string us = "\U0000f900"; + const string s = "\U0000f900"; var r = (Rune)0xf900; - Assert.Equal ("豈", us); + Assert.Equal ("豈", s); Assert.Equal ("豈", r.ToString ()); - Assert.Equal (us, r.ToString ()); + Assert.Equal (s, r.ToString ()); - Assert.Equal (2, us.GetColumns ()); + Assert.Equal (2, s.GetColumns ()); Assert.Equal (2, r.GetColumns ()); - var win = new Window { Title = us }; + var win = new Window { Title = s }; var view = new View { Text = r.ToString (), Height = Dim.Fill (), Width = Dim.Fill () }; - var tf = new TextField { Text = us, Y = 1, Width = 3 }; + var tf = new TextField { Text = s, Y = 1, Width = 3 }; win.Add (view, tf); - Toplevel top = new (); + Runnable top = new (); top.Add (win); Application.Begin (top); Application.Driver!.SetScreenSize (10, 4); + Application.LayoutAndDraw (); const string expectedOutput = """ - ┌┤豈├────┐ - │豈 │ - │豈 │ + ┌┤豈├────┐ + │豈 │ + │豈 │ └────────┘ """; DriverAssert.AssertDriverContentsWithFrameAre (expectedOutput, output); @@ -71,7 +72,7 @@ public class DrawTests (ITestOutputHelper output) Height = 6, VerticalTextAlignment = Alignment.End, }; - Toplevel top = new (); + Runnable top = new (); top.Add (viewRight, viewBottom); var rs = Application.Begin (top); @@ -114,7 +115,11 @@ public class DrawTests (ITestOutputHelper output) [SetupFakeApplication] public void Draw_Minimum_Full_Border_With_Empty_Viewport () { - var view = new View { Width = 2, Height = 2, BorderStyle = LineStyle.Single }; + var view = new View + { + App = ApplicationImpl.Instance, + Width = 2, Height = 2, BorderStyle = LineStyle.Single + }; Assert.True (view.NeedsLayout); Assert.True (view.NeedsDraw); view.Layout (); @@ -139,7 +144,11 @@ public class DrawTests (ITestOutputHelper output) [SetupFakeApplication] public void Draw_Minimum_Full_Border_With_Empty_Viewport_Without_Bottom () { - var view = new View { Width = 2, Height = 1, BorderStyle = LineStyle.Single }; + var view = new View + { + App = ApplicationImpl.Instance, + Width = 2, Height = 1, BorderStyle = LineStyle.Single + }; view.Border!.Thickness = new (1, 1, 1, 0); view.BeginInit (); view.EndInit (); @@ -157,7 +166,11 @@ public class DrawTests (ITestOutputHelper output) [SetupFakeApplication] public void Draw_Minimum_Full_Border_With_Empty_Viewport_Without_Left () { - var view = new View { Width = 1, Height = 2, BorderStyle = LineStyle.Single }; + var view = new View + { + App = ApplicationImpl.Instance, + Width = 1, Height = 2, BorderStyle = LineStyle.Single + }; view.Border!.Thickness = new (0, 1, 1, 1); view.BeginInit (); view.EndInit (); @@ -182,7 +195,11 @@ public class DrawTests (ITestOutputHelper output) [SetupFakeApplication] public void Draw_Minimum_Full_Border_With_Empty_Viewport_Without_Right () { - var view = new View { Width = 1, Height = 2, BorderStyle = LineStyle.Single }; + var view = new View + { + App = ApplicationImpl.Instance, + Width = 1, Height = 2, BorderStyle = LineStyle.Single + }; view.Border!.Thickness = new (1, 1, 0, 1); view.BeginInit (); view.EndInit (); @@ -207,7 +224,11 @@ public class DrawTests (ITestOutputHelper output) [SetupFakeApplication] public void Draw_Minimum_Full_Border_With_Empty_Viewport_Without_Top () { - var view = new View { Width = 2, Height = 1, BorderStyle = LineStyle.Single }; + var view = new View + { + App = ApplicationImpl.Instance, + Width = 2, Height = 1, BorderStyle = LineStyle.Single + }; view.Border!.Thickness = new (1, 0, 1, 1); view.BeginInit (); @@ -284,7 +305,7 @@ public class DrawTests (ITestOutputHelper output) Height = 5 }; container.Add (content); - Toplevel top = new (); + Runnable top = new (); top.Add (container); var rs = Application.Begin (top); @@ -401,7 +422,7 @@ public class DrawTests (ITestOutputHelper output) Height = 5 }; container.Add (content); - Toplevel top = new (); + Runnable top = new (); top.Add (container); // BUGBUG: v2 - it's bogus to reference .Frame before BeginInit. And why is the clip being set anyway??? @@ -492,7 +513,7 @@ public class DrawTests (ITestOutputHelper output) Height = 5 }; container.Add (content); - Toplevel top = new (); + Runnable top = new (); top.Add (container); Application.Begin (top); @@ -587,7 +608,11 @@ public class DrawTests (ITestOutputHelper output) [InlineData ("a𐐀b")] public void DrawHotString_NonBmp (string expected) { - var view = new View { Width = 10, Height = 1 }; + var view = new View + { + App = ApplicationImpl.Instance, + Width = 10, Height = 1 + }; view.DrawHotString (expected, Attribute.Default, Attribute.Default); DriverAssert.AssertDriverContentsWithFrameAre (expected, output); @@ -612,12 +637,12 @@ public class DrawTests (ITestOutputHelper output) var view = new Label { Text = r.ToString () }; var tf = new TextField { Text = us, Y = 1, Width = 3 }; win.Add (view, tf); - Toplevel top = new (); + Runnable top = new (); top.Add (win); Application.Begin (top); Application.Driver!.SetScreenSize (10, 4); - + Application.LayoutAndDraw (); var expected = """ @@ -638,7 +663,7 @@ public class DrawTests (ITestOutputHelper output) [AutoInitShutdown] public void Draw_Throws_IndexOutOfRangeException_With_Negative_Bounds () { - Toplevel top = new (); + Runnable top = new (); var view = new View { X = -2, Text = "view" }; top.Add (view); @@ -666,7 +691,7 @@ public class DrawTests (ITestOutputHelper output) return; - void OnApplicationOnIteration (object? s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { Assert.Equal (-2, view.X); @@ -689,7 +714,7 @@ public class DrawTests (ITestOutputHelper output) Height = 2, Text = "A text with some long width\n and also with two lines." }; - Toplevel top = new (); + Runnable top = new (); top.Add (label, view); SessionToken sessionToken = Application.Begin (top); AutoInitShutdownAttribute.RunIteration (); @@ -737,7 +762,7 @@ At 0,0 Height = 2, Text = "A text with some long width\n and also with two lines." }; - Toplevel top = new (); + Runnable top = new (); top.Add (label, view); SessionToken sessionToken = Application.Begin (top); @@ -760,7 +785,7 @@ At 0,0 Assert.Equal (new (3, 3, 10, 1), view.Frame); Assert.Equal (new (0, 0, 10, 1), view.Viewport); Assert.Equal (new (0, 0, 10, 1), view.NeedsDrawRect); - View.SetClipToScreen (); + view.SetClipToScreen (); top.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -790,7 +815,7 @@ At 0,0 Height = 2, Text = "A text with some long width\n and also with two lines." }; - Toplevel top = new (); + Runnable top = new (); top.Add (label, view); SessionToken sessionToken = Application.Begin (top); AutoInitShutdownAttribute.RunIteration (); @@ -836,7 +861,7 @@ At 0,0 Height = 2, Text = "A text with some long width\n and also with two lines." }; - Toplevel top = new (); + Runnable top = new (); top.Add (label, view); SessionToken sessionToken = Application.Begin (top); @@ -859,7 +884,7 @@ At 0,0 Assert.Equal (new (1, 1, 10, 1), view.Frame); Assert.Equal (new (0, 0, 10, 1), view.Viewport); Assert.Equal (new (0, 0, 10, 1), view.NeedsDrawRect); - View.SetClipToScreen (); + view.SetClipToScreen (); top.Draw (); diff --git a/Tests/UnitTests/View/Draw/NeedsDrawTests.cs b/Tests/UnitTests/View/Draw/NeedsDrawTests.cs index 9928dd14c..231590f72 100644 --- a/Tests/UnitTests/View/Draw/NeedsDrawTests.cs +++ b/Tests/UnitTests/View/Draw/NeedsDrawTests.cs @@ -1,7 +1,7 @@ #nullable enable using UnitTests; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; [Trait ("Category", "Output")] public class NeedsDrawTests () @@ -33,7 +33,7 @@ public class NeedsDrawTests () frame.Width = 40; frame.Height = 8; - Toplevel top = new (); + Runnable top = new (); top.Add (frame); diff --git a/Tests/UnitTests/View/Draw/TransparentTests.cs b/Tests/UnitTests/View/Draw/TransparentTests.cs index 6a38f91e7..39f966a92 100644 --- a/Tests/UnitTests/View/Draw/TransparentTests.cs +++ b/Tests/UnitTests/View/Draw/TransparentTests.cs @@ -2,7 +2,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; [Trait ("Category", "Output")] public class TransparentTests (ITestOutputHelper output) @@ -14,6 +14,7 @@ public class TransparentTests (ITestOutputHelper output) { var super = new View { + App = ApplicationImpl.Instance, Id = "super", Width = 20, Height = 5, @@ -58,6 +59,7 @@ public class TransparentTests (ITestOutputHelper output) { var super = new View { + App = ApplicationImpl.Instance, Id = "super", Width = 20, Height = 5, diff --git a/Tests/UnitTests/View/Layout/Dim.FillTests.cs b/Tests/UnitTests/View/Layout/Dim.FillTests.cs deleted file mode 100644 index 7345147c0..000000000 --- a/Tests/UnitTests/View/Layout/Dim.FillTests.cs +++ /dev/null @@ -1,23 +0,0 @@ -using Xunit.Abstractions; - -namespace UnitTests.LayoutTests; - -public class DimFillTests (ITestOutputHelper output) -{ - private readonly ITestOutputHelper _output = output; - - [Fact] - public void DimFill_SizedCorrectly () - { - var view = new View { Width = Dim.Fill (), Height = Dim.Fill (), BorderStyle = LineStyle.Single }; - var top = new Toplevel (); - top.Add (view); - - top.Layout (); - - view.SetRelativeLayout (new (32, 5)); - Assert.Equal (32, view.Frame.Width); - Assert.Equal (5, view.Frame.Height); - top.Dispose (); - } -} diff --git a/Tests/UnitTests/View/Layout/Dim.Tests.cs b/Tests/UnitTests/View/Layout/Dim.Tests.cs index db4a2b349..6caade5a1 100644 --- a/Tests/UnitTests/View/Layout/Dim.Tests.cs +++ b/Tests/UnitTests/View/Layout/Dim.Tests.cs @@ -24,7 +24,7 @@ public class DimTests // TODO: This actually a SetRelativeLayout/LayoutSubViews test and should be moved // TODO: A new test that calls SetRelativeLayout directly is needed. - [Fact] + [Fact (Skip = "Convoluted test; rewrite")] [AutoInitShutdown] public void Only_DimAbsolute_And_DimFactor_As_A_Different_Procedure_For_Assigning_Value_To_Width_Or_Height () { @@ -32,7 +32,7 @@ public class DimTests Button.DefaultShadow = ShadowStyle.None; // Testing with the Button because it properly handles the Dim class. - Toplevel t = new (); + Runnable t = new (); var w = new Window { Width = 100, Height = 100 }; @@ -111,7 +111,7 @@ public class DimTests w.Add (f1, f2, v1, v2, v3, v4, v5, v6); t.Add (w); - t.Ready += (s, e) => + t.IsModalChanged += (s, e) => { Assert.Equal ("Absolute(100)", w.Width.ToString ()); Assert.Equal ("Absolute(100)", w.Height.ToString ()); diff --git a/Tests/UnitTests/View/Layout/GetViewsUnderLocationTests.cs b/Tests/UnitTests/View/Layout/GetViewsUnderLocationTests.cs deleted file mode 100644 index ec1fcdd08..000000000 --- a/Tests/UnitTests/View/Layout/GetViewsUnderLocationTests.cs +++ /dev/null @@ -1,840 +0,0 @@ -#nullable enable - -namespace UnitTests.ViewMouseTests; - -[Trait ("Category", "Input")] -public class GetViewsUnderLocationTests -{ - [Theory] - [InlineData (0, 0, 0, 0, 0, -1, -1, new string [] { })] - [InlineData (0, 0, 0, 0, 0, 0, 0, new [] { "Top" })] - [InlineData (0, 0, 0, 0, 0, 1, 1, new [] { "Top" })] - [InlineData (0, 0, 0, 0, 0, 4, 4, new [] { "Top" })] - [InlineData (0, 0, 0, 0, 0, 9, 9, new [] { "Top" })] - [InlineData (0, 0, 0, 0, 0, 10, 10, new string [] { })] - [InlineData (1, 1, 0, 0, 0, -1, -1, new string [] { })] - [InlineData (1, 1, 0, 0, 0, 0, 0, new string [] { })] - [InlineData (1, 1, 0, 0, 0, 1, 1, new [] { "Top" })] - [InlineData (1, 1, 0, 0, 0, 4, 4, new [] { "Top" })] - [InlineData (1, 1, 0, 0, 0, 9, 9, new [] { "Top" })] - [InlineData (1, 1, 0, 0, 0, 10, 10, new [] { "Top" })] - [InlineData (0, 0, 1, 0, 0, -1, -1, new string [] { })] - [InlineData (0, 0, 1, 0, 0, 0, 0, new string [] { })] //margin is ViewportSettings.TransparentToMouse - [InlineData (0, 0, 1, 0, 0, 1, 1, new [] { "Top" })] - [InlineData (0, 0, 1, 0, 0, 4, 4, new [] { "Top" })] - [InlineData (0, 0, 1, 0, 0, 9, 9, new string [] { })] //margin is ViewportSettings.TransparentToMouse - [InlineData (0, 0, 1, 0, 0, 10, 10, new string [] { })] - [InlineData (0, 0, 1, 1, 0, -1, -1, new string [] { })] - [InlineData (0, 0, 1, 1, 0, 0, 0, new string [] { })] //margin is ViewportSettings.TransparentToMouse - [InlineData (0, 0, 1, 1, 0, 1, 1, new [] { "Top", "Border" })] - [InlineData (0, 0, 1, 1, 0, 4, 4, new [] { "Top" })] - [InlineData (0, 0, 1, 1, 0, 9, 9, new string [] { })] //margin is ViewportSettings.TransparentToMouse - [InlineData (0, 0, 1, 1, 0, 10, 10, new string [] { })] - [InlineData (0, 0, 1, 1, 1, -1, -1, new string [] { })] - [InlineData (0, 0, 1, 1, 1, 0, 0, new string [] { })] //margin is ViewportSettings.TransparentToMouse - [InlineData (0, 0, 1, 1, 1, 1, 1, new [] { "Top", "Border" })] - [InlineData (0, 0, 1, 1, 1, 2, 2, new [] { "Top", "Padding" })] - [InlineData (0, 0, 1, 1, 1, 4, 4, new [] { "Top" })] - [InlineData (0, 0, 1, 1, 1, 9, 9, new string [] { })] //margin is ViewportSettings.TransparentToMouse - [InlineData (0, 0, 1, 1, 1, 10, 10, new string [] { })] - [InlineData (1, 1, 1, 0, 0, -1, -1, new string [] { })] - [InlineData (1, 1, 1, 0, 0, 0, 0, new string [] { })] - [InlineData (1, 1, 1, 0, 0, 1, 1, new string [] { })] //margin is ViewportSettings.TransparentToMouse - [InlineData (1, 1, 1, 0, 0, 4, 4, new [] { "Top" })] - [InlineData (1, 1, 1, 0, 0, 9, 9, new [] { "Top" })] - [InlineData (1, 1, 1, 0, 0, 10, 10, new string [] { })] //margin is ViewportSettings.TransparentToMouse - [InlineData (1, 1, 1, 1, 0, -1, -1, new string [] { })] - [InlineData (1, 1, 1, 1, 0, 0, 0, new string [] { })] - [InlineData (1, 1, 1, 1, 0, 1, 1, new string [] { })] //margin is ViewportSettings.TransparentToMouse - [InlineData (1, 1, 1, 1, 0, 4, 4, new [] { "Top" })] - [InlineData (1, 1, 1, 1, 0, 9, 9, new [] { "Top", "Border" })] - [InlineData (1, 1, 1, 1, 0, 10, 10, new string [] { })] //margin is ViewportSettings.TransparentToMouse - [InlineData (1, 1, 1, 1, 1, -1, -1, new string [] { })] - [InlineData (1, 1, 1, 1, 1, 0, 0, new string [] { })] - [InlineData (1, 1, 1, 1, 1, 1, 1, new string [] { })] //margin is ViewportSettings.TransparentToMouse - [InlineData (1, 1, 1, 1, 1, 2, 2, new [] { "Top", "Border" })] - [InlineData (1, 1, 1, 1, 1, 3, 3, new [] { "Top", "Padding" })] - [InlineData (1, 1, 1, 1, 1, 4, 4, new [] { "Top" })] - [InlineData (1, 1, 1, 1, 1, 8, 8, new [] { "Top", "Padding" })] - [InlineData (1, 1, 1, 1, 1, 9, 9, new [] { "Top", "Border" })] - [InlineData (1, 1, 1, 1, 1, 10, 10, new string [] { })] //margin is ViewportSettings.TransparentToMouse - public void Top_Adornments_Returns_Correct_View ( - int frameX, - int frameY, - int marginThickness, - int borderThickness, - int paddingThickness, - int testX, - int testY, - string [] expectedViewsFound - ) - { - // Arrange - Application.Top = new () - { - Id = "Top", - Frame = new (frameX, frameY, 10, 10) - }; - Application.Top.Margin!.Thickness = new (marginThickness); - Application.Top.Margin!.Id = "Margin"; - Application.Top.Border!.Thickness = new (borderThickness); - Application.Top.Border!.Id = "Border"; - Application.Top.Padding!.Thickness = new (paddingThickness); - Application.Top.Padding.Id = "Padding"; - - var location = new Point (testX, testY); - - // Act - List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettingsFlags.TransparentMouse); - - // Assert - if (expectedViewsFound.Length == 0) - { - Assert.Empty (viewsUnderMouse); - } - else - { - string [] foundIds = viewsUnderMouse.Select (v => v!.Id).ToArray (); - Assert.Equal (expectedViewsFound, foundIds); - } - - Application.Top.Dispose (); - Application.ResetState (true); - } - - [Theory] - [InlineData (0, 0)] - [InlineData (1, 1)] - [InlineData (2, 2)] - public void Returns_Top_If_No_SubViews (int testX, int testY) - { - // Arrange - Application.Top = new () - { - Frame = new (0, 0, 10, 10) - }; - - var location = new Point (testX, testY); - - // Act - List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettingsFlags.TransparentMouse); - - // Assert - Assert.Contains (viewsUnderMouse, v => v == Application.Top); - Application.Top.Dispose (); - Application.ResetState (true); - } - - // Test that GetViewsUnderLocation returns the correct view if the start view has no subviews - [Theory] - [InlineData (0, 0)] - [InlineData (1, 1)] - [InlineData (2, 2)] - public void Returns_Start_If_No_SubViews (int testX, int testY) - { - Application.ResetState (true); - - Application.Top = new () - { - Width = 10, Height = 10 - }; - - Assert.Same (Application.Top, View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault ()); - Application.Top.Dispose (); - Application.ResetState (true); - } - - // Test that GetViewsUnderLocation returns the correct view if the start view has subviews - [Theory] - [InlineData (0, 0, false)] - [InlineData (1, 1, false)] - [InlineData (9, 9, false)] - [InlineData (10, 10, false)] - [InlineData (6, 7, false)] - [InlineData (1, 2, true)] - [InlineData (5, 6, true)] - public void Returns_Correct_If_SubViews (int testX, int testY, bool expectedSubViewFound) - { - Application.Top = new () - { - Width = 10, Height = 10 - }; - - var subview = new View - { - X = 1, Y = 2, - Width = 5, Height = 5 - }; - Application.Top.Add (subview); - - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); - - Assert.Equal (expectedSubViewFound, found == subview); - Application.Top.Dispose (); - Application.ResetState (true); - } - - [Theory] - [InlineData (0, 0, false)] - [InlineData (1, 1, false)] - [InlineData (9, 9, false)] - [InlineData (10, 10, false)] - [InlineData (6, 7, false)] - [InlineData (1, 2, false)] - [InlineData (5, 6, false)] - public void Returns_Null_If_SubView_NotVisible (int testX, int testY, bool expectedSubViewFound) - { - Application.Top = new () - { - Width = 10, Height = 10 - }; - - var subview = new View - { - X = 1, Y = 2, - Width = 5, Height = 5, - Visible = false - }; - Application.Top.Add (subview); - - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); - - Assert.Equal (expectedSubViewFound, found == subview); - Application.Top.Dispose (); - Application.ResetState (true); - } - - [Theory] - [InlineData (0, 0, false)] - [InlineData (1, 1, false)] - [InlineData (9, 9, false)] - [InlineData (10, 10, false)] - [InlineData (6, 7, false)] - [InlineData (1, 2, false)] - [InlineData (5, 6, false)] - public void Returns_Null_If_Not_Visible_And_SubView_Visible (int testX, int testY, bool expectedSubViewFound) - { - Application.Top = new () - { - Width = 10, Height = 10, - Visible = false - }; - - var subview = new View - { - X = 1, Y = 2, - Width = 5, Height = 5 - }; - Application.Top.Add (subview); - subview.Visible = true; - Assert.True (subview.Visible); - Assert.False (Application.Top.Visible); - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); - - Assert.Equal (expectedSubViewFound, found == subview); - Application.Top.Dispose (); - Application.ResetState (true); - } - - // Test that GetViewsUnderLocation works if the start view has positive Adornments - [Theory] - [InlineData (0, 0, false)] - [InlineData (1, 1, false)] - [InlineData (9, 9, false)] - [InlineData (10, 10, false)] - [InlineData (7, 8, false)] - [InlineData (1, 2, false)] - [InlineData (2, 3, true)] - [InlineData (5, 6, true)] - [InlineData (6, 7, true)] - public void Returns_Correct_If_Start_Has_Adornments (int testX, int testY, bool expectedSubViewFound) - { - Application.Top = new () - { - Width = 10, Height = 10 - }; - Application.Top.Margin!.Thickness = new (1); - - var subview = new View - { - X = 1, Y = 2, - Width = 5, Height = 5 - }; - Application.Top.Add (subview); - - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); - - Assert.Equal (expectedSubViewFound, found == subview); - Application.Top.Dispose (); - Application.ResetState (true); - } - - // Test that GetViewsUnderLocation works if the start view has offset Viewport location - [Theory] - [InlineData (1, 0, 0, true)] - [InlineData (1, 1, 1, true)] - [InlineData (1, 2, 2, false)] - [InlineData (-1, 3, 3, true)] - [InlineData (-1, 2, 2, true)] - [InlineData (-1, 1, 1, false)] - [InlineData (-1, 0, 0, false)] - public void Returns_Correct_If_Start_Has_Offset_Viewport (int offset, int testX, int testY, bool expectedSubViewFound) - { - Application.Top = new () - { - Width = 10, Height = 10, - ViewportSettings = ViewportSettingsFlags.AllowNegativeLocation - }; - Application.Top.Viewport = new (offset, offset, 10, 10); - - var subview = new View - { - X = 1, Y = 1, - Width = 2, Height = 2 - }; - Application.Top.Add (subview); - - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); - - Assert.Equal (expectedSubViewFound, found == subview); - Application.Top.Dispose (); - Application.ResetState (true); - } - - [Theory] - [InlineData (9, 9, true)] - [InlineData (0, 0, false)] - [InlineData (1, 1, false)] - [InlineData (10, 10, false)] - [InlineData (7, 8, false)] - [InlineData (1, 2, false)] - [InlineData (2, 3, false)] - [InlineData (5, 6, false)] - [InlineData (6, 7, false)] - public void Returns_Correct_If_Start_Has_Adornment_WithSubView (int testX, int testY, bool expectedSubViewFound) - { - Application.Top = new () - { - Width = 10, Height = 10 - }; - Application.Top.Padding!.Thickness = new (1); - - var subview = new View - { - X = Pos.AnchorEnd (1), Y = Pos.AnchorEnd (1), - Width = 1, Height = 1 - }; - Application.Top.Padding.Add (subview); - Application.Top.BeginInit (); - Application.Top.EndInit (); - - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); - - Assert.Equal (expectedSubViewFound, found == subview); - Application.Top.Dispose (); - Application.ResetState (true); - } - - [Theory] - [InlineData (0, 0, new string [] { })] - [InlineData (9, 9, new string [] { })] - [InlineData (1, 1, new [] { "Top", "Border" })] - [InlineData (8, 8, new [] { "Top", "Border" })] - [InlineData (2, 2, new [] { "Top", "Padding" })] - [InlineData (7, 7, new [] { "Top", "Padding" })] - [InlineData (5, 5, new [] { "Top" })] - public void Returns_Adornment_If_Start_Has_Adornments (int testX, int testY, string [] expectedViewsFound) - { - Application.ResetState (true); - - Application.Top = new () - { - Id = "Top", - Width = 10, Height = 10 - }; - Application.Top.Margin!.Thickness = new (1); - Application.Top.Margin!.Id = "Margin"; - Application.Top.Border!.Thickness = new (1); - Application.Top.Border!.Id = "Border"; - Application.Top.Padding!.Thickness = new (1); - Application.Top.Padding.Id = "Padding"; - - var subview = new View - { - Id = "SubView", - X = 1, Y = 1, - Width = 1, Height = 1 - }; - Application.Top.Add (subview); - - List viewsUnderMouse = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse); - string [] foundIds = viewsUnderMouse.Select (v => v!.Id).ToArray (); - - Assert.Equal (expectedViewsFound, foundIds); - Application.Top.Dispose (); - Application.ResetState (true); - } - - // Test that GetViewsUnderLocation works if the subview has positive Adornments - [Theory] - [InlineData (0, 0, new [] { "Top" })] - [InlineData (1, 1, new [] { "Top" })] - [InlineData (9, 9, new [] { "Top" })] - [InlineData (10, 10, new string [] { })] - [InlineData (7, 8, new [] { "Top" })] - [InlineData (6, 7, new [] { "Top" })] - [InlineData (1, 2, new [] { "Top", "subview", "border" })] - [InlineData (5, 6, new [] { "Top", "subview", "border" })] - [InlineData (2, 3, new [] { "Top", "subview" })] - public void Returns_Correct_If_SubView_Has_Adornments (int testX, int testY, string [] expectedViewsFound) - { - Application.Top = new () - { - Id = "Top", - Width = 10, Height = 10 - }; - - var subview = new View - { - Id = "subview", - X = 1, Y = 2, - Width = 5, Height = 5 - }; - subview.Border!.Thickness = new (1); - subview.Border!.Id = "border"; - Application.Top.Add (subview); - - List viewsUnderMouse = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse); - string [] foundIds = viewsUnderMouse.Select (v => v!.Id).ToArray (); - - Assert.Equal (expectedViewsFound, foundIds); - Application.Top.Dispose (); - Application.ResetState (true); - } - - // Test that GetViewsUnderLocation works if the subview has positive Adornments - [Theory] - [InlineData (0, 0, new [] { "Top" })] - [InlineData (1, 1, new [] { "Top" })] - [InlineData (9, 9, new [] { "Top" })] - [InlineData (10, 10, new string [] { })] - [InlineData (7, 8, new [] { "Top" })] - [InlineData (6, 7, new [] { "Top" })] - [InlineData (1, 2, new [] { "Top" })] - [InlineData (5, 6, new [] { "Top" })] - [InlineData (2, 3, new [] { "Top", "subview" })] - public void Returns_Correct_If_SubView_Has_Adornments_With_TransparentMouse (int testX, int testY, string [] expectedViewsFound) - { - Application.Top = new () - { - Id = "Top", - Width = 10, Height = 10 - }; - - var subview = new View - { - Id = "subview", - X = 1, Y = 2, - Width = 5, Height = 5 - }; - subview.Border!.Thickness = new (1); - subview.Border!.ViewportSettings = ViewportSettingsFlags.TransparentMouse; - subview.Border!.Id = "border"; - Application.Top.Add (subview); - - List viewsUnderMouse = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse); - string [] foundIds = viewsUnderMouse.Select (v => v!.Id).ToArray (); - - Assert.Equal (expectedViewsFound, foundIds); - Application.Top.Dispose (); - Application.ResetState (true); - } - - [Theory] - [InlineData (0, 0, false)] - [InlineData (1, 1, false)] - [InlineData (9, 9, false)] - [InlineData (10, 10, false)] - [InlineData (7, 8, false)] - [InlineData (6, 7, false)] - [InlineData (1, 2, false)] - [InlineData (5, 6, false)] - [InlineData (6, 5, false)] - [InlineData (5, 5, true)] - public void Returns_Correct_If_SubView_Has_Adornment_WithSubView (int testX, int testY, bool expectedSubViewFound) - { - Application.Top = new () - { - Width = 10, Height = 10 - }; - - // A subview with + Padding - var subview = new View - { - X = 1, Y = 1, - Width = 5, Height = 5 - }; - subview.Padding!.Thickness = new (1); - - // This subview will be at the bottom-right-corner of subview - // So screen-relative location will be X + Width - 1 = 5 - var paddingSubView = new View - { - X = Pos.AnchorEnd (1), - Y = Pos.AnchorEnd (1), - Width = 1, - Height = 1 - }; - subview.Padding.Add (paddingSubView); - Application.Top.Add (subview); - Application.Top.BeginInit (); - Application.Top.EndInit (); - - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); - - Assert.Equal (expectedSubViewFound, found == paddingSubView); - Application.Top.Dispose (); - Application.ResetState (true); - } - - [Theory] - [InlineData (0, 0, false)] - [InlineData (1, 1, false)] - [InlineData (9, 9, false)] - [InlineData (10, 10, false)] - [InlineData (7, 8, false)] - [InlineData (6, 7, false)] - [InlineData (1, 2, false)] - [InlineData (5, 6, false)] - [InlineData (6, 5, false)] - [InlineData (5, 5, true)] - public void Returns_Correct_If_SubView_Is_Scrolled_And_Has_Adornment_WithSubView (int testX, int testY, bool expectedSubViewFound) - { - Application.Top = new () - { - Width = 10, Height = 10 - }; - - // A subview with + Padding - var subview = new View - { - X = 1, Y = 1, - Width = 5, Height = 5 - }; - subview.Padding!.Thickness = new (1); - - // Scroll the subview - subview.SetContentSize (new (10, 10)); - subview.Viewport = subview.Viewport with { Location = new (1, 1) }; - - // This subview will be at the bottom-right-corner of subview - // So screen-relative location will be X + Width - 1 = 5 - var paddingSubView = new View - { - X = Pos.AnchorEnd (1), - Y = Pos.AnchorEnd (1), - Width = 1, - Height = 1 - }; - subview.Padding.Add (paddingSubView); - Application.Top.Add (subview); - Application.Top.BeginInit (); - Application.Top.EndInit (); - - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); - - Assert.Equal (expectedSubViewFound, found == paddingSubView); - Application.Top.Dispose (); - Application.ResetState (true); - } - - // Test that GetViewsUnderLocation works with nested subviews - [Theory] - [InlineData (0, 0, -1)] - [InlineData (9, 9, -1)] - [InlineData (10, 10, -1)] - [InlineData (1, 1, 0)] - [InlineData (1, 2, 0)] - [InlineData (2, 2, 1)] - [InlineData (3, 3, 2)] - [InlineData (5, 5, 2)] - public void Returns_Correct_With_NestedSubViews (int testX, int testY, int expectedSubViewFound) - { - Application.Top = new () - { - Width = 10, Height = 10 - }; - - var numSubViews = 3; - List subviews = new (); - - for (var i = 0; i < numSubViews; i++) - { - var subview = new View - { - X = 1, Y = 1, - Width = 5, Height = 5 - }; - subviews.Add (subview); - - if (i > 0) - { - subviews [i - 1].Add (subview); - } - } - - Application.Top.Add (subviews [0]); - - View? found = View.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); - Assert.Equal (expectedSubViewFound, subviews.IndexOf (found!)); - Application.Top.Dispose (); - Application.ResetState (true); - } - - [Theory] - [InlineData (0, 0, new [] { "top" })] - [InlineData (9, 9, new [] { "top" })] - [InlineData (10, 10, new string [] { })] - [InlineData (1, 1, new [] { "top", "view" })] - [InlineData (1, 2, new [] { "top", "view" })] - [InlineData (2, 1, new [] { "top", "view" })] - [InlineData (2, 2, new [] { "top", "view", "subView" })] - [InlineData (3, 3, new [] { "top" })] // clipped - [InlineData (2, 3, new [] { "top" })] // clipped - public void Tiled_SubViews (int mouseX, int mouseY, string [] viewIdStrings) - { - // Arrange - Application.Top = new () - { - Frame = new (0, 0, 10, 10), - Id = "top" - }; - - var view = new View - { - Id = "view", - X = 1, - Y = 1, - Width = 2, - Height = 2, - Arrangement = ViewArrangement.Overlapped - }; // at 1,1 to 3,2 (screen) - - var subView = new View - { - Id = "subView", - X = 1, - Y = 1, - Width = 2, - Height = 2, - Arrangement = ViewArrangement.Overlapped - }; // at 2,2 to 4,3 (screen) - view.Add (subView); - Application.Top.Add (view); - - List found = View.GetViewsUnderLocation (new (mouseX, mouseY), ViewportSettingsFlags.TransparentMouse); - - string [] foundIds = found.Select (v => v!.Id).ToArray (); - - Assert.Equal (viewIdStrings, foundIds); - - Application.Top.Dispose (); - Application.ResetState (true); - } - - [Theory] - [InlineData (0, 0, new [] { "top" })] - [InlineData (9, 9, new [] { "top" })] - [InlineData (10, 10, new string [] { })] - [InlineData (-1, -1, new string [] { })] - [InlineData (1, 1, new [] { "top", "view" })] - [InlineData (1, 2, new [] { "top", "view" })] - [InlineData (2, 1, new [] { "top", "view" })] - [InlineData (2, 2, new [] { "top", "view", "popover" })] - [InlineData (3, 3, new [] { "top" })] // clipped - [InlineData (2, 3, new [] { "top" })] // clipped - public void Popover (int mouseX, int mouseY, string [] viewIdStrings) - { - // Arrange - Application.Top = new () - { - Frame = new (0, 0, 10, 10), - Id = "top" - }; - - var view = new View - { - Id = "view", - X = 1, - Y = 1, - Width = 2, - Height = 2, - Arrangement = ViewArrangement.Overlapped - }; // at 1,1 to 3,2 (screen) - - var popOver = new View - { - Id = "popover", - X = 1, - Y = 1, - Width = 2, - Height = 2, - Arrangement = ViewArrangement.Overlapped - }; // at 2,2 to 4,3 (screen) - - view.Add (popOver); - Application.Top.Add (view); - - List found = View.GetViewsUnderLocation (new (mouseX, mouseY), ViewportSettingsFlags.TransparentMouse); - - string [] foundIds = found.Select (v => v!.Id).ToArray (); - - Assert.Equal (viewIdStrings, foundIds); - - Application.Top.Dispose (); - Application.ResetState (true); - } - - [Fact] - public void Returns_TopToplevel_When_Point_Inside_Only_TopToplevel () - { - Application.ResetState (true); - - Toplevel topToplevel = new () - { - Id = "topToplevel", - Frame = new (0, 0, 20, 20) - }; - - Toplevel secondaryToplevel = new () - { - Id = "secondaryToplevel", - Frame = new (5, 5, 10, 10) - }; - secondaryToplevel.Margin!.Thickness = new (1); - secondaryToplevel.Layout (); - - Application.TopLevels.Clear (); - Application.TopLevels.Push (topToplevel); - Application.TopLevels.Push (secondaryToplevel); - Application.Top = secondaryToplevel; - - List found = View.GetViewsUnderLocation (new (2, 2), ViewportSettingsFlags.TransparentMouse); - Assert.Contains (found, v => v?.Id == topToplevel.Id); - Assert.Contains (found, v => v == topToplevel); - - topToplevel.Dispose (); - secondaryToplevel.Dispose (); - Application.TopLevels.Clear (); - Application.ResetState (true); - } - - [Fact] - public void Returns_SecondaryToplevel_When_Point_Inside_Only_SecondaryToplevel () - { - Application.ResetState (true); - - Toplevel topToplevel = new () - { - Id = "topToplevel", - Frame = new (0, 0, 20, 20) - }; - - Toplevel secondaryToplevel = new () - { - Id = "secondaryToplevel", - Frame = new (5, 5, 10, 10) - }; - secondaryToplevel.Margin!.Thickness = new (1); - secondaryToplevel.Layout (); - - Application.TopLevels.Clear (); - Application.TopLevels.Push (topToplevel); - Application.TopLevels.Push (secondaryToplevel); - Application.Top = secondaryToplevel; - - List found = View.GetViewsUnderLocation (new (7, 7), ViewportSettingsFlags.TransparentMouse); - Assert.Contains (found, v => v?.Id == secondaryToplevel.Id); - Assert.DoesNotContain (found, v => v?.Id == topToplevel.Id); - - topToplevel.Dispose (); - secondaryToplevel.Dispose (); - Application.TopLevels.Clear (); - Application.ResetState (true); - } - - [Fact] - public void Returns_Depends_On_Margin_ViewportSettings_When_Point_In_Margin_Of_SecondaryToplevel () - { - Application.ResetState (true); - - Toplevel topToplevel = new () - { - Id = "topToplevel", - Frame = new (0, 0, 20, 20) - }; - - Toplevel secondaryToplevel = new () - { - Id = "secondaryToplevel", - Frame = new (5, 5, 10, 10) - }; - secondaryToplevel.Margin!.Thickness = new (1); - - Application.TopLevels.Clear (); - Application.TopLevels.Push (topToplevel); - Application.TopLevels.Push (secondaryToplevel); - Application.Top = secondaryToplevel; - - secondaryToplevel.Margin!.ViewportSettings = ViewportSettingsFlags.None; - - List found = View.GetViewsUnderLocation (new (5, 5), ViewportSettingsFlags.TransparentMouse); - Assert.Contains (found, v => v == secondaryToplevel); - Assert.Contains (found, v => v == secondaryToplevel.Margin); - Assert.DoesNotContain (found, v => v?.Id == topToplevel.Id); - - secondaryToplevel.Margin!.ViewportSettings = ViewportSettingsFlags.TransparentMouse; - found = View.GetViewsUnderLocation (new (5, 5), ViewportSettingsFlags.TransparentMouse); - Assert.DoesNotContain (found, v => v == secondaryToplevel); - Assert.DoesNotContain (found, v => v == secondaryToplevel.Margin); - Assert.Contains (found, v => v?.Id == topToplevel.Id); - - topToplevel.Dispose (); - secondaryToplevel.Dispose (); - Application.TopLevels.Clear (); - Application.ResetState (true); - } - - [Fact] - public void Returns_Empty_When_Point_Outside_All_Toplevels () - { - Application.ResetState (true); - - Toplevel topToplevel = new () - { - Id = "topToplevel", - Frame = new (0, 0, 20, 20) - }; - - Toplevel secondaryToplevel = new () - { - Id = "secondaryToplevel", - Frame = new (5, 5, 10, 10) - }; - secondaryToplevel.Margin!.Thickness = new (1); - secondaryToplevel.Layout (); - - Application.TopLevels.Clear (); - Application.TopLevels.Push (topToplevel); - Application.TopLevels.Push (secondaryToplevel); - Application.Top = secondaryToplevel; - - List found = View.GetViewsUnderLocation (new (20, 20), ViewportSettingsFlags.TransparentMouse); - Assert.Empty (found); - - topToplevel.Dispose (); - secondaryToplevel.Dispose (); - Application.TopLevels.Clear (); - Application.ResetState (true); - } -} diff --git a/Tests/UnitTests/View/Layout/Pos.AnchorEndTests.cs b/Tests/UnitTests/View/Layout/Pos.AnchorEndTests.cs deleted file mode 100644 index 39c96c707..000000000 --- a/Tests/UnitTests/View/Layout/Pos.AnchorEndTests.cs +++ /dev/null @@ -1,71 +0,0 @@ -using UnitTests; - -namespace UnitTests.LayoutTests; - -public class PosAnchorEndTests () -{ - // TODO: This actually a SetRelativeLayout/LayoutSubViews test and should be moved - // TODO: A new test that calls SetRelativeLayout directly is needed. - [Fact] - [AutoInitShutdown] - public void PosAnchorEnd_Equal_Inside_Window () - { - var viewWidth = 10; - var viewHeight = 1; - - var tv = new TextView - { - X = Pos.AnchorEnd (viewWidth), Y = Pos.AnchorEnd (viewHeight), Width = viewWidth, Height = viewHeight - }; - - var win = new Window (); - - win.Add (tv); - - Toplevel top = new (); - top.Add (win); - SessionToken rs = Application.Begin (top); - - Application.Driver!.SetScreenSize (80,25); - - Assert.Equal (new (0, 0, 80, 25), top.Frame); - Assert.Equal (new (0, 0, 80, 25), win.Frame); - Assert.Equal (new (68, 22, 10, 1), tv.Frame); - Application.End (rs); - top.Dispose (); - } - - //// TODO: This actually a SetRelativeLayout/LayoutSubViews test and should be moved - //// TODO: A new test that calls SetRelativeLayout directly is needed. - //[Fact] - //[AutoInitShutdown] - //public void PosAnchorEnd_Equal_Inside_Window_With_MenuBar_And_StatusBar_On_Toplevel () - //{ - // var viewWidth = 10; - // var viewHeight = 1; - - // var tv = new TextView - // { - // X = Pos.AnchorEnd (viewWidth), Y = Pos.AnchorEnd (viewHeight), Width = viewWidth, Height = viewHeight - // }; - - // var win = new Window (); - - // win.Add (tv); - - // var menu = new MenuBar (); - // var status = new StatusBar (); - // Toplevel top = new (); - // top.Add (win, menu, status); - // SessionToken rs = Application.Begin (top); - - // Assert.Equal (new (0, 0, 80, 25), top.Frame); - // Assert.Equal (new (0, 0, 80, 1), menu.Frame); - // Assert.Equal (new (0, 24, 80, 1), status.Frame); - // Assert.Equal (new (0, 1, 80, 23), win.Frame); - // Assert.Equal (new (68, 20, 10, 1), tv.Frame); - - // Application.End (rs); - // top.Dispose (); - //} -} diff --git a/Tests/UnitTests/View/Layout/Pos.CombineTests.cs b/Tests/UnitTests/View/Layout/Pos.CombineTests.cs deleted file mode 100644 index f6ca4edcf..000000000 --- a/Tests/UnitTests/View/Layout/Pos.CombineTests.cs +++ /dev/null @@ -1,116 +0,0 @@ -using Microsoft.VisualStudio.TestPlatform.Utilities; -using UnitTests; -using Xunit.Abstractions; -using static Terminal.Gui.ViewBase.Dim; -using static Terminal.Gui.ViewBase.Pos; - -namespace UnitTests.LayoutTests; - -public class PosCombineTests (ITestOutputHelper output) -{ - private readonly ITestOutputHelper _output = output; - - // TODO: This actually a SetRelativeLayout/LayoutSubViews test and should be moved - // TODO: A new test that calls SetRelativeLayout directly is needed. - [Fact] - [SetupFakeApplication] - public void PosCombine_Will_Throws () - { - Toplevel t = new (); - - var w = new Window { X = Pos.Left (t) + 2, Y = Pos.Top (t) + 2 }; - var f = new FrameView (); - var v1 = new View { X = Pos.Left (w) + 2, Y = Pos.Top (w) + 2 }; - var v2 = new View { X = Pos.Left (v1) + 2, Y = Pos.Top (v1) + 2 }; - - f.Add (v1); // v2 not added - w.Add (f); - t.Add (w); - - f.X = Pos.X (v2) - Pos.X (v1); - f.Y = Pos.Y (v2) - Pos.Y (v1); - - Assert.Throws (() => Application.Run (t)); - t.Dispose (); - v2.Dispose (); - } - - - [Fact] - [SetupFakeApplication] - public void PosCombine_DimCombine_View_With_SubViews () - { - Application.Top = new Toplevel () { Width = 80, Height = 25 }; - var win1 = new Window { Id = "win1", Width = 20, Height = 10 }; - var view1 = new View - { - Text = "view1", - Width = Auto (DimAutoStyle.Text), - Height = Auto (DimAutoStyle.Text) - - }; - var win2 = new Window { Id = "win2", Y = Pos.Bottom (view1) + 1, Width = 10, Height = 3 }; - var view2 = new View { Id = "view2", Width = Dim.Fill (), Height = 1, CanFocus = true }; - - //var clicked = false; - //view2.MouseClick += (sender, e) => clicked = true; - var view3 = new View { Id = "view3", Width = Dim.Fill (1), Height = 1, CanFocus = true }; - - view2.Add (view3); - win2.Add (view2); - win1.Add (view1, win2); - Application.Top.Add (win1); - Application.Top.Layout (); - - Assert.Equal (new Rectangle (0, 0, 80, 25), Application.Top.Frame); - Assert.Equal (new Rectangle (0, 0, 5, 1), view1.Frame); - Assert.Equal (new Rectangle (0, 0, 20, 10), win1.Frame); - Assert.Equal (new Rectangle (0, 2, 10, 3), win2.Frame); - Assert.Equal (new Rectangle (0, 0, 8, 1), view2.Frame); - Assert.Equal (new Rectangle (0, 0, 7, 1), view3.Frame); - var foundView = View.GetViewsUnderLocation (new Point(9, 4), ViewportSettingsFlags.None).LastOrDefault (); - Assert.Equal (foundView, view2); - Application.Top.Dispose (); - } - - [Fact] - public void PosCombine_Refs_SuperView_Throws () - { - Application.Init (null, "fake"); - - var top = new Toplevel (); - var w = new Window { X = Pos.Left (top) + 2, Y = Pos.Top (top) + 2 }; - var f = new FrameView (); - var v1 = new View { X = Pos.Left (w) + 2, Y = Pos.Top (w) + 2 }; - var v2 = new View { X = Pos.Left (v1) + 2, Y = Pos.Top (v1) + 2 }; - - f.Add (v1, v2); - w.Add (f); - top.Add (w); - Application.Begin (top); - - f.X = Pos.X (Application.Top) + Pos.X (v2) - Pos.X (v1); - f.Y = Pos.Y (Application.Top) + Pos.Y (v2) - Pos.Y (v1); - - Application.Top.SubViewsLaidOut += (s, e) => - { - Assert.Equal (0, Application.Top.Frame.X); - Assert.Equal (0, Application.Top.Frame.Y); - Assert.Equal (2, w.Frame.X); - Assert.Equal (2, w.Frame.Y); - Assert.Equal (2, f.Frame.X); - Assert.Equal (2, f.Frame.Y); - Assert.Equal (4, v1.Frame.X); - Assert.Equal (4, v1.Frame.Y); - Assert.Equal (6, v2.Frame.X); - Assert.Equal (6, v2.Frame.Y); - }; - - Application.StopAfterFirstIteration = true; - - Assert.Throws (() => Application.Run ()); - Application.Top.Dispose (); - top.Dispose (); - Application.Shutdown (); - } -} diff --git a/Tests/UnitTests/View/Layout/Pos.Tests.cs b/Tests/UnitTests/View/Layout/Pos.Tests.cs index 4d419b29a..1b81e9c49 100644 --- a/Tests/UnitTests/View/Layout/Pos.Tests.cs +++ b/Tests/UnitTests/View/Layout/Pos.Tests.cs @@ -1,7 +1,4 @@ -using UnitTests; -using Xunit.Abstractions; -using static Terminal.Gui.ViewBase.Dim; -using static Terminal.Gui.ViewBase.Pos; +#nullable enable namespace UnitTests.LayoutTests; @@ -11,9 +8,9 @@ public class PosTests () public void Pos_Validation_Do_Not_Throws_If_NewValue_Is_PosAbsolute_And_OldValue_Is_Another_Type_After_Sets_To_LayoutStyle_Absolute () { - Application.Init (null, "fake"); + Application.Init ("fake"); - Toplevel t = new (); + Runnable t = new (); var w = new Window { X = Pos.Left (t) + 2, Y = Pos.Absolute (2) }; @@ -22,7 +19,7 @@ public class PosTests () w.Add (v); t.Add (w); - t.Ready += (s, e) => + t.IsModalChanged += (s, e) => { v.Frame = new Rectangle (2, 2, 10, 10); Assert.Equal (2, v.X = 2); @@ -40,12 +37,11 @@ public class PosTests () // TODO: This actually a SetRelativeLayout/LayoutSubViews test and should be moved // TODO: A new test that calls SetRelativeLayout directly is needed. [Fact] - [TestRespondersDisposed] public void PosCombine_WHY_Throws () { - Application.Init (null, "fake"); + Application.Init ("fake"); - Toplevel t = new Toplevel (); + Runnable t = new Runnable (); var w = new Window { X = Pos.Left (t) + 2, Y = Pos.Top (t) + 2 }; var f = new FrameView (); @@ -73,7 +69,7 @@ public class PosTests () [SetupFakeApplication] public void Pos_Add_Operator () { - Toplevel top = new (); + Runnable top = new (); var view = new View { X = 0, Y = 0, Width = 20, Height = 20 }; var field = new TextField { X = 0, Y = 0, Width = 20 }; @@ -116,7 +112,7 @@ public class PosTests () return; - void OnInstanceOnIteration (object s, IterationEventArgs a) + void OnInstanceOnIteration (object? s, EventArgs a) { while (count < 20) { @@ -130,12 +126,11 @@ public class PosTests () // TODO: This actually a SetRelativeLayout/LayoutSubViews test and should be moved // TODO: A new test that calls SetRelativeLayout directly is needed. [Fact] - [TestRespondersDisposed] public void Pos_Subtract_Operator () { - Application.Init (null, "fake"); + Application.Init ("fake"); - Toplevel top = new (); + Runnable top = new (); var view = new View { X = 0, Y = 0, Width = 20, Height = 20 }; var field = new TextField { X = 0, Y = 0, Width = 20 }; @@ -191,7 +186,7 @@ public class PosTests () return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { while (count > 0) { @@ -207,14 +202,14 @@ public class PosTests () [Fact] public void Pos_Validation_Do_Not_Throws_If_NewValue_Is_PosAbsolute_And_OldValue_Is_Null () { - Application.Init (null, "fake"); + Application.Init ("fake"); - Toplevel t = new (); + Runnable t = new (); var w = new Window { X = 1, Y = 2, Width = 3, Height = 5 }; t.Add (w); - t.Ready += (s, e) => + t.IsModalChanged += (s, e) => { Assert.Equal (2, w.X = 2); Assert.Equal (2, w.Y = 2); @@ -233,14 +228,14 @@ public class PosTests () [Fact] public void Validation_Does_Not_Throw_If_NewValue_Is_PosAbsolute_And_OldValue_Is_Null () { - Application.Init (null, "fake"); + Application.Init ("fake"); - Toplevel t = new Toplevel (); + Runnable t = new Runnable (); var w = new Window { X = 1, Y = 2, Width = 3, Height = 5 }; t.Add (w); - t.Ready += (s, e) => + t.IsModalChanged += (s, e) => { Assert.Equal (2, w.X = 2); Assert.Equal (2, w.Y = 2); diff --git a/Tests/UnitTests/View/Layout/Pos.ViewTests.cs b/Tests/UnitTests/View/Layout/Pos.ViewTests.cs index 9755fd208..3edf2733c 100644 --- a/Tests/UnitTests/View/Layout/Pos.ViewTests.cs +++ b/Tests/UnitTests/View/Layout/Pos.ViewTests.cs @@ -1,6 +1,6 @@ -using UnitTests; +#nullable enable +using JetBrains.Annotations; using Xunit.Abstractions; -using static Terminal.Gui.ViewBase.Pos; namespace UnitTests.LayoutTests; @@ -14,7 +14,7 @@ public class PosViewTests (ITestOutputHelper output) [SetupFakeApplication] public void Subtract_Operator () { - var top = new Toplevel (); + var top = new Runnable (); var view = new View { X = 0, Y = 0, Width = 20, Height = 20 }; var field = new TextField { X = 0, Y = 0, Width = 20 }; @@ -69,7 +69,7 @@ public class PosViewTests (ITestOutputHelper output) return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { while (count > 0) { diff --git a/Tests/UnitTests/View/Layout/SetLayoutTests.cs b/Tests/UnitTests/View/Layout/SetLayoutTests.cs deleted file mode 100644 index ac3654e29..000000000 --- a/Tests/UnitTests/View/Layout/SetLayoutTests.cs +++ /dev/null @@ -1,42 +0,0 @@ -using UnitTests; -using Xunit.Abstractions; - -namespace UnitTests.LayoutTests; - -public class SetLayoutTests (ITestOutputHelper output) -{ - private readonly ITestOutputHelper _output = output; - - - [Fact] - [AutoInitShutdown] - public void Screen_Size_Change_Causes_Layout () - { - Application.Top = new (); - - var view = new View - { - X = 3, - Y = 2, - Width = 10, - Height = 1, - Text = "0123456789" - }; - Application.Top.Add (view); - - var rs = Application.Begin (Application.Top); - Application.Driver!.SetScreenSize (80, 25); - - Assert.Equal (new (0, 0, 80, 25), new Rectangle (0, 0, Application.Screen.Width, Application.Screen.Height)); - Assert.Equal (new (0, 0, Application.Screen.Width, Application.Screen.Height), Application.Top.Frame); - Assert.Equal (new (0, 0, 80, 25), Application.Top.Frame); - - Application.Driver!.SetScreenSize (20, 10); - Assert.Equal (new (0, 0, Application.Screen.Width, Application.Screen.Height), Application.Top.Frame); - - Assert.Equal (new (0, 0, 20, 10), Application.Top.Frame); - - Application.End (rs); - Application.Top.Dispose (); - } -} diff --git a/Tests/UnitTests/View/Mouse/MouseTests.cs b/Tests/UnitTests/View/Mouse/MouseTests.cs index ec1215934..05326f7ea 100644 --- a/Tests/UnitTests/View/Mouse/MouseTests.cs +++ b/Tests/UnitTests/View/Mouse/MouseTests.cs @@ -1,6 +1,6 @@ using Timeout = Terminal.Gui.App.Timeout; -namespace UnitTests.ViewMouseTests; +namespace UnitTests.ViewBaseTests.MouseTests; [Trait ("Category", "Input")] public class MouseTests : TestsAllViews @@ -38,7 +38,7 @@ public class MouseTests : TestsAllViews testView.Border!.Thickness = new (borderThickness); testView.Padding!.Thickness = new (paddingThickness); - var top = new Toplevel (); + var top = new Runnable (); top.Add (testView); SessionToken rs = Application.Begin (top); diff --git a/Tests/UnitTests/View/Navigation/CanFocusTests.cs b/Tests/UnitTests/View/Navigation/CanFocusTests.cs deleted file mode 100644 index 679239fdc..000000000 --- a/Tests/UnitTests/View/Navigation/CanFocusTests.cs +++ /dev/null @@ -1,130 +0,0 @@ -using UnitTests; - -namespace UnitTests.ViewTests; - -public class CanFocusTests -{ - // TODO: Figure out what this test is supposed to be testing - [Fact] - [AutoInitShutdown] - public void CanFocus_Faced_With_Container_Before_Run () - { - using Toplevel t = new (); - - var w = new Window (); - var f = new FrameView (); - var v = new View { CanFocus = true }; - f.Add (v); - w.Add (f); - t.Add (w); - - Assert.True (t.CanFocus); - Assert.True (w.CanFocus); - Assert.True (f.CanFocus); - Assert.True (v.CanFocus); - - f.CanFocus = false; - Assert.False (f.CanFocus); - Assert.True (v.CanFocus); - - v.CanFocus = false; - Assert.False (f.CanFocus); - Assert.False (v.CanFocus); - - v.CanFocus = true; - Assert.False (f.CanFocus); - Assert.True (v.CanFocus); - - Application.StopAfterFirstIteration = true; - - Application.Run (t); - t.Dispose (); - Application.Shutdown (); - } - - //[Fact] - //public void CanFocus_Set_Changes_TabIndex_And_TabStop () - //{ - // var r = new View (); - // var v1 = new View { Text = "1" }; - // var v2 = new View { Text = "2" }; - // var v3 = new View { Text = "3" }; - - // r.Add (v1, v2, v3); - - // v2.CanFocus = true; - // Assert.Equal (r.TabIndexes.IndexOf (v2), v2.TabIndex); - // Assert.Equal (0, v2.TabIndex); - // Assert.Equal (TabBehavior.TabStop, v2.TabStop); - - // v1.CanFocus = true; - // Assert.Equal (r.TabIndexes.IndexOf (v1), v1.TabIndex); - // Assert.Equal (1, v1.TabIndex); - // Assert.Equal (TabBehavior.TabStop, v1.TabStop); - - // v1.TabIndex = 2; - // Assert.Equal (r.TabIndexes.IndexOf (v1), v1.TabIndex); - // Assert.Equal (1, v1.TabIndex); - // v3.CanFocus = true; - // Assert.Equal (r.TabIndexes.IndexOf (v1), v1.TabIndex); - // Assert.Equal (1, v1.TabIndex); - // Assert.Equal (r.TabIndexes.IndexOf (v3), v3.TabIndex); - // Assert.Equal (2, v3.TabIndex); - // Assert.Equal (TabBehavior.TabStop, v3.TabStop); - - // v2.CanFocus = false; - // Assert.Equal (r.TabIndexes.IndexOf (v1), v1.TabIndex); - // Assert.Equal (1, v1.TabIndex); - // Assert.Equal (TabBehavior.TabStop, v1.TabStop); - // Assert.Equal (r.TabIndexes.IndexOf (v2), v2.TabIndex); // TabIndex is not changed - // Assert.NotEqual (-1, v2.TabIndex); - // Assert.Equal (TabBehavior.TabStop, v2.TabStop); // TabStop is not changed - // Assert.Equal (r.TabIndexes.IndexOf (v3), v3.TabIndex); - // Assert.Equal (2, v3.TabIndex); - // Assert.Equal (TabBehavior.TabStop, v3.TabStop); - // r.Dispose (); - //} - - [Fact] - public void CanFocus_Set_True_Get_AdvanceFocus_Works () - { - Label label = new () { Text = "label" }; - View view = new () { Text = "view", CanFocus = true }; - Application.Navigation = new (); - Application.Top = new (); - Application.Top.Add (label, view); - - Application.Top.SetFocus (); - Assert.Equal (view, Application.Navigation.GetFocused ()); - Assert.False (label.CanFocus); - Assert.False (label.HasFocus); - Assert.True (view.CanFocus); - Assert.True (view.HasFocus); - - Assert.False (Application.Navigation.AdvanceFocus (NavigationDirection.Forward, null)); - Assert.False (label.HasFocus); - Assert.True (view.HasFocus); - - // Set label CanFocus to true - label.CanFocus = true; - Assert.False (label.HasFocus); - Assert.True (view.HasFocus); - - // label can now be focused, so AdvanceFocus should move to it. - Assert.True (Application.Navigation.AdvanceFocus (NavigationDirection.Forward, null)); - Assert.True (label.HasFocus); - Assert.False (view.HasFocus); - - // Move back to view - view.SetFocus (); - Assert.False (label.HasFocus); - Assert.True (view.HasFocus); - - Assert.True (Application.RaiseKeyDownEvent (Key.Tab)); - Assert.True (label.HasFocus); - Assert.False (view.HasFocus); - - Application.Top.Dispose (); - Application.ResetState (); - } -} diff --git a/Tests/UnitTests/View/Navigation/EnabledTests.cs b/Tests/UnitTests/View/Navigation/EnabledTests.cs index de86a639e..67f5f52bc 100644 --- a/Tests/UnitTests/View/Navigation/EnabledTests.cs +++ b/Tests/UnitTests/View/Navigation/EnabledTests.cs @@ -1,10 +1,9 @@ -using UnitTests; - -namespace UnitTests.ViewTests; +#nullable enable +namespace UnitTests.ViewBaseTests; public class EnabledTests { - + [Fact] [AutoInitShutdown] public void _Enabled_Sets_Also_Sets_SubViews () @@ -15,7 +14,7 @@ public class EnabledTests button.Accepting += (s, e) => wasClicked = !wasClicked; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; win.Add (button); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); var iterations = 0; @@ -30,7 +29,7 @@ public class EnabledTests return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { iterations++; diff --git a/Tests/UnitTests/View/SchemeTests.cs b/Tests/UnitTests/View/SchemeTests.cs index 6b16dcb39..9660a853b 100644 --- a/Tests/UnitTests/View/SchemeTests.cs +++ b/Tests/UnitTests/View/SchemeTests.cs @@ -1,6 +1,6 @@ using Xunit; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; [Trait ("Category", "View.Scheme")] public class SchemeTests diff --git a/Tests/UnitTests/View/SubviewTests.cs b/Tests/UnitTests/View/SubviewTests.cs index 2da6f6065..a5241638d 100644 --- a/Tests/UnitTests/View/SubviewTests.cs +++ b/Tests/UnitTests/View/SubviewTests.cs @@ -1,107 +1,107 @@ using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; public class SubViewTests { - private readonly ITestOutputHelper _output; - public SubViewTests (ITestOutputHelper output) { _output = output; } + //private readonly ITestOutputHelper _output; + //public SubViewTests (ITestOutputHelper output) { _output = output; } - // TODO: This is a poor unit tests. Not clear what it's testing. Refactor. - [Fact] - [AutoInitShutdown] - public void Initialized_Event_Will_Be_Invoked_When_Added_Dynamically () - { - var t = new Toplevel { Id = "0" }; + //// TODO: This is a poor unit tests. Not clear what it's testing. Refactor. + //[Fact] + //[AutoInitShutdown] + //public void Initialized_Event_Will_Be_Invoked_When_Added_Dynamically () + //{ + // var t = new Runnable { Id = "0" }; - var w = new Window { Id = "t", Width = Dim.Fill (), Height = Dim.Fill () }; - var v1 = new View { Id = "v1", Width = Dim.Fill (), Height = Dim.Fill () }; - var v2 = new View { Id = "v2", Width = Dim.Fill (), Height = Dim.Fill () }; + // var w = new Window { Id = "t", Width = Dim.Fill (), Height = Dim.Fill () }; + // var v1 = new View { Id = "v1", Width = Dim.Fill (), Height = Dim.Fill () }; + // var v2 = new View { Id = "v2", Width = Dim.Fill (), Height = Dim.Fill () }; - int tc = 0, wc = 0, v1c = 0, v2c = 0, sv1c = 0; + // int tc = 0, wc = 0, v1c = 0, v2c = 0, sv1c = 0; - t.Initialized += (s, e) => - { - tc++; - Assert.Equal (1, tc); - Assert.Equal (1, wc); - Assert.Equal (1, v1c); - Assert.Equal (1, v2c); - Assert.Equal (0, sv1c); // Added after t in the Application.Iteration. + // t.Initialized += (s, e) => + // { + // tc++; + // Assert.Equal (1, tc); + // Assert.Equal (1, wc); + // Assert.Equal (1, v1c); + // Assert.Equal (1, v2c); + // Assert.Equal (0, sv1c); // Added after t in the Application.Iteration. - Assert.True (t.CanFocus); - Assert.True (w.CanFocus); - Assert.False (v1.CanFocus); - Assert.False (v2.CanFocus); + // Assert.True (t.CanFocus); + // Assert.True (w.CanFocus); + // Assert.False (v1.CanFocus); + // Assert.False (v2.CanFocus); - Application.LayoutAndDraw (); - }; + // Application.LayoutAndDraw (); + // }; - w.Initialized += (s, e) => - { - wc++; - Assert.Equal (t.Viewport.Width, w.Frame.Width); - Assert.Equal (t.Viewport.Height, w.Frame.Height); - }; + // w.Initialized += (s, e) => + // { + // wc++; + // Assert.Equal (t.Viewport.Width, w.Frame.Width); + // Assert.Equal (t.Viewport.Height, w.Frame.Height); + // }; - v1.Initialized += (s, e) => - { - v1c++; + // v1.Initialized += (s, e) => + // { + // v1c++; - //Assert.Equal (t.Viewport.Width, v1.Frame.Width); - //Assert.Equal (t.Viewport.Height, v1.Frame.Height); - }; + // //Assert.Equal (t.Viewport.Width, v1.Frame.Width); + // //Assert.Equal (t.Viewport.Height, v1.Frame.Height); + // }; - v2.Initialized += (s, e) => - { - v2c++; + // v2.Initialized += (s, e) => + // { + // v2c++; - //Assert.Equal (t.Viewport.Width, v2.Frame.Width); - //Assert.Equal (t.Viewport.Height, v2.Frame.Height); - }; - w.Add (v1, v2); - t.Add (w); + // //Assert.Equal (t.Viewport.Width, v2.Frame.Width); + // //Assert.Equal (t.Viewport.Height, v2.Frame.Height); + // }; + // w.Add (v1, v2); + // t.Add (w); - Application.Iteration += OnApplicationOnIteration; + // Application.Iteration += OnApplicationOnIteration; - Application.Run (t); - Application.Iteration -= OnApplicationOnIteration; + // Application.Run (t); + // Application.Iteration -= OnApplicationOnIteration; - t.Dispose (); - Application.Shutdown (); + // t.Dispose (); + // Application.Shutdown (); - Assert.Equal (1, tc); - Assert.Equal (1, wc); - Assert.Equal (1, v1c); - Assert.Equal (1, v2c); - Assert.Equal (1, sv1c); + // Assert.Equal (1, tc); + // Assert.Equal (1, wc); + // Assert.Equal (1, v1c); + // Assert.Equal (1, v2c); + // Assert.Equal (1, sv1c); - Assert.True (t.CanFocus); - Assert.True (w.CanFocus); - Assert.False (v1.CanFocus); - Assert.False (v2.CanFocus); + // Assert.True (t.CanFocus); + // Assert.True (w.CanFocus); + // Assert.False (v1.CanFocus); + // Assert.False (v2.CanFocus); - return; + // return; - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - var sv1 = new View { Id = "sv1", Width = Dim.Fill (), Height = Dim.Fill () }; + // void OnApplicationOnIteration (object s, EventArgs a) + // { + // var sv1 = new View { Id = "sv1", Width = Dim.Fill (), Height = Dim.Fill () }; - sv1.Initialized += (s, e) => - { - sv1c++; - Assert.NotEqual (t.Frame.Width, sv1.Frame.Width); - Assert.NotEqual (t.Frame.Height, sv1.Frame.Height); - Assert.False (sv1.CanFocus); + // sv1.Initialized += (s, e) => + // { + // sv1c++; + // Assert.NotEqual (t.Frame.Width, sv1.Frame.Width); + // Assert.NotEqual (t.Frame.Height, sv1.Frame.Height); + // Assert.False (sv1.CanFocus); - //Assert.Throws (() => sv1.CanFocus = true); - Assert.False (sv1.CanFocus); - }; + // //Assert.Throws (() => sv1.CanFocus = true); + // Assert.False (sv1.CanFocus); + // }; - v1.Add (sv1); + // v1.Add (sv1); - Application.LayoutAndDraw (); - t.Running = false; - } - } + // Application.LayoutAndDraw (); + // t.Running = false; + // } + //} } diff --git a/Tests/UnitTests/View/TextTests.cs b/Tests/UnitTests/View/TextTests.cs index 3e552204c..f63d219e2 100644 --- a/Tests/UnitTests/View/TextTests.cs +++ b/Tests/UnitTests/View/TextTests.cs @@ -1,7 +1,8 @@ -using UnitTests; +using System.Text; +using UnitTests; using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; /// /// Tests of the and properties. @@ -13,6 +14,7 @@ public class TextTests (ITestOutputHelper output) public void Setting_With_Height_Horizontal () { var top = new View { Width = 25, Height = 25 }; + top.App = ApplicationImpl.Instance; var label = new Label { Text = "Hello", /* Width = 10, Height = 2, */ ValidatePosDim = true }; var viewX = new View { Text = "X", X = Pos.Right (label), Width = 1, Height = 1 }; @@ -39,7 +41,7 @@ Y Assert.Equal (new (0, 0, 10, 2), label.Frame); top.LayoutSubViews (); - View.SetClipToScreen (); + top.SetClipToScreen (); top.Draw (); expected = @" @@ -63,7 +65,7 @@ Y var viewX = new View { Text = "X", X = Pos.Right (label), Width = 1, Height = 1 }; var viewY = new View { Text = "Y", Y = Pos.Bottom (label), Width = 1, Height = 1 }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (label, viewX, viewY); SessionToken rs = Application.Begin (top); @@ -117,11 +119,12 @@ Y var view = new View (); win.Add (view); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); SessionToken rs = Application.Begin (top); Application.Driver!.SetScreenSize (15, 15); + Application.LayoutAndDraw (); Assert.Equal (new (0, 0, 15, 15), win.Frame); Assert.Equal (new (0, 0, 15, 15), win.Margin!.Frame); @@ -383,10 +386,11 @@ Y var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; win.Add (view); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); SessionToken rs = Application.Begin (top); Application.Driver!.SetScreenSize (4, 10); + Application.LayoutAndDraw (); Assert.Equal (5, text.Length); @@ -394,7 +398,7 @@ Y Assert.Equal (new (1, 5), view.TextFormatter.ConstrainToSize); Assert.Equal (new () { "Views" }, view.TextFormatter.GetLines ()); Assert.Equal (new (0, 0, 4, 10), win.Frame); - Assert.Equal (new (0, 0, 4, 10), Application.Top.Frame); + Assert.Equal (new (0, 0, 4, 10), Application.TopRunnableView.Frame); var expected = @" ┌──┐ @@ -449,6 +453,7 @@ Y var view = new View { + App = ApplicationImpl.Instance, TextDirection = TextDirection.TopBottom_LeftRight, Text = text, Width = Dim.Auto (), @@ -508,10 +513,11 @@ w "; Text = "Window" }; win.Add (horizontalView, verticalView); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); SessionToken rs = Application.Begin (top); Application.Driver!.SetScreenSize (20, 20); + Application.LayoutAndDraw (); Assert.Equal (new (0, 0, 11, 2), horizontalView.Frame); Assert.Equal (new (0, 3, 2, 11), verticalView.Frame); @@ -596,10 +602,11 @@ w "; }; var win = new Window { Id = "win", Width = Dim.Fill (), Height = Dim.Fill (), Text = "Window" }; win.Add (horizontalView, verticalView); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); SessionToken rs = Application.Begin (top); Application.Driver!.SetScreenSize (22, 22); + Application.LayoutAndDraw (); Assert.Equal (new (text.GetColumns (), 1), horizontalView.TextFormatter.ConstrainToSize); Assert.Equal (new (2, 8), verticalView.TextFormatter.ConstrainToSize); @@ -675,7 +682,7 @@ w "; public void Excess_Text_Is_Erased_When_The_Width_Is_Reduced () { var lbl = new Label { Text = "123" }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (lbl); SessionToken rs = Application.Begin (top); AutoInitShutdownAttribute.RunIteration (); @@ -697,14 +704,14 @@ w "; string GetContents () { - var text = ""; + var sb = new StringBuilder (); for (var i = 0; i < 4; i++) { - text += Application.Driver?.Contents [0, i].Rune; + sb.Append (Application.Driver?.Contents! [0, i].Grapheme); } - return text; + return sb.ToString (); } Application.End (rs); @@ -780,10 +787,11 @@ w "; var frame = new FrameView { Width = Dim.Fill (), Height = Dim.Fill (), BorderStyle = LineStyle.Single }; frame.Add (lblLeft, lblCenter, lblRight, lblJust); - var top = new Toplevel (); + var top = new Runnable (); top.Add (frame); Application.Begin (top); Application.Driver!.SetScreenSize (width + 2, 6); + Application.LayoutAndDraw (); // frame.Width is width + border wide (20 + 2) and 6 high @@ -910,10 +918,11 @@ w "; var frame = new FrameView { Width = Dim.Fill (), Height = Dim.Fill (), BorderStyle = LineStyle.Single }; frame.Add (lblLeft, lblCenter, lblRight, lblJust); - var top = new Toplevel (); + var top = new Runnable (); top.Add (frame); Application.Begin (top); Application.Driver!.SetScreenSize (9, height + 2); + Application.LayoutAndDraw (); if (autoSize) { @@ -1000,6 +1009,7 @@ w "; { Application.Driver!.SetScreenSize (32, 32); var top = new View { Width = 32, Height = 32 }; + top.App = ApplicationImpl.Instance; var text = $"First line{Environment.NewLine}Second line"; var horizontalView = new View { Width = 20, Height = 1, Text = text }; @@ -1075,7 +1085,7 @@ w "; verticalView.Width = 2; verticalView.TextFormatter.ConstrainToSize = new (2, 20); Assert.True (verticalView.TextFormatter.NeedsFormat); - View.SetClipToScreen (); + top.SetClipToScreen (); top.Draw (); Assert.Equal (new (0, 3, 2, 20), verticalView.Frame); @@ -1124,7 +1134,7 @@ w "; View view; var text = "test"; - view = new Label { Text = text }; + view = new Label { App = ApplicationImpl.Instance, Text = text }; view.BeginInit (); view.EndInit (); view.Draw (); diff --git a/Tests/UnitTests/View/ViewCommandTests.cs b/Tests/UnitTests/View/ViewCommandTests.cs index 9564aefdd..f77f36af1 100644 --- a/Tests/UnitTests/View/ViewCommandTests.cs +++ b/Tests/UnitTests/View/ViewCommandTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; public class ViewCommandTests { @@ -46,9 +46,8 @@ public class ViewCommandTests w.LayoutSubViews (); - Application.Top = w; - Application.TopLevels.Push (w); - Assert.Same (Application.Top, w); + Application.Begin (w); + Assert.Same (Application.TopRunnableView, w); // Click button 2 Rectangle btn2Frame = btnB.FrameToScreen (); @@ -81,7 +80,7 @@ public class ViewCommandTests } // See: https://github.com/gui-cs/Terminal.Gui/issues/3905 - [Fact]// (Skip = "Failing as part of ##4270. Disabling temporarily.")] + [Fact] [SetupFakeApplication] public void Button_CanFocus_False_Raises_Accepted_Correctly () { @@ -121,9 +120,8 @@ public class ViewCommandTests w.Add (btn); - Application.Top = w; - Application.TopLevels.Push (w); - Assert.Same (Application.Top, w); + Application.Begin (w); + Assert.Same (Application.TopRunnableView, w); w.LayoutSubViews (); @@ -154,6 +152,7 @@ public class ViewCommandTests Assert.Equal (1, btnAcceptedCount); Assert.Equal (0, wAcceptedCount); + w.Dispose (); Application.ResetState (true); } } diff --git a/Tests/UnitTests/View/ViewTests.cs b/Tests/UnitTests/View/ViewTests.cs index 42d89f39a..0a4e0f1aa 100644 --- a/Tests/UnitTests/View/ViewTests.cs +++ b/Tests/UnitTests/View/ViewTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace UnitTests.ViewBaseTests; public class ViewTests { @@ -332,6 +332,7 @@ public class ViewTests public void Test_Nested_Views_With_Height_Equal_To_One () { var v = new View { Width = 11, Height = 3 }; + v.App = ApplicationImpl.Instance; var top = new View { Width = Dim.Fill (), Height = 1 }; var bottom = new View { Width = Dim.Fill (), Height = 1, Y = 2 }; @@ -447,7 +448,7 @@ public class ViewTests Assert.Equal (0, view.Height); var win = new Window (); win.Add (view); - Toplevel top = new (); + Runnable top = new (); top.Add (win); SessionToken rs = Application.Begin (top); @@ -457,6 +458,7 @@ public class ViewTests Assert.Equal ("Testing visibility.".Length, view.Frame.Width); Assert.True (view.Visible); Application.Driver!.SetScreenSize (30, 5); + Application.LayoutAndDraw (); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -494,7 +496,7 @@ public class ViewTests var button = new Button { Text = "Click Me" }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; win.Add (button); - Toplevel top = new (); + Runnable top = new (); top.Add (win); var iterations = 0; @@ -508,7 +510,7 @@ public class ViewTests return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object s, EventArgs a) { iterations++; diff --git a/Tests/UnitTests/Views/AppendAutocompleteTests.cs b/Tests/UnitTests/Views/AppendAutocompleteTests.cs index a3c910710..ee38be859 100644 --- a/Tests/UnitTests/Views/AppendAutocompleteTests.cs +++ b/Tests/UnitTests/Views/AppendAutocompleteTests.cs @@ -13,9 +13,9 @@ public class AppendAutocompleteTests (ITestOutputHelper output) // f is typed and suggestion is "fish" Application.RaiseKeyDownEvent ('f'); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("fish", output); Assert.Equal ("f", tf.Text); @@ -25,17 +25,17 @@ public class AppendAutocompleteTests (ITestOutputHelper output) // Suggestion should disappear tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); DriverAssert.AssertDriverContentsAre ("f", output); Assert.Equal ("f", tf.Text); // Still has focus though - Assert.Same (tf, Application.Top.Focused); + Assert.Same (tf, Application.TopRunnableView.Focused); // But can tab away Application.RaiseKeyDownEvent ('\t'); - Assert.NotSame (tf, Application.Top.Focused); - Application.Top.Dispose (); + Assert.NotSame (tf, Application.TopRunnableView.Focused); + Application.TopRunnableView.Dispose (); } [Fact] @@ -46,9 +46,9 @@ public class AppendAutocompleteTests (ITestOutputHelper output) // f is typed and suggestion is "fish" Application.RaiseKeyDownEvent ('f'); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("fish", output); Assert.Equal ("f", tf.Text); @@ -63,13 +63,13 @@ public class AppendAutocompleteTests (ITestOutputHelper output) // Should reappear when you press next letter Application.RaiseKeyDownEvent (Key.I); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("fish", output); Assert.Equal ("fi", tf.Text); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Theory] @@ -82,9 +82,9 @@ public class AppendAutocompleteTests (ITestOutputHelper output) // f is typed and suggestion is "fish" Application.RaiseKeyDownEvent ('f'); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("fish", output); Assert.Equal ("f", tf.Text); @@ -92,22 +92,22 @@ public class AppendAutocompleteTests (ITestOutputHelper output) // When cycling autocomplete Application.RaiseKeyDownEvent (cycleKey); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("friend", output); Assert.Equal ("f", tf.Text); // Should be able to cycle in circles endlessly Application.RaiseKeyDownEvent (cycleKey); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("fish", output); Assert.Equal ("f", tf.Text); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -118,9 +118,9 @@ public class AppendAutocompleteTests (ITestOutputHelper output) // f is typed and suggestion is "fish" Application.RaiseKeyDownEvent ('f'); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("fish", output); Assert.Equal ("f", tf.Text); @@ -129,11 +129,11 @@ public class AppendAutocompleteTests (ITestOutputHelper output) Application.RaiseKeyDownEvent (' '); Application.RaiseKeyDownEvent (Key.CursorLeft); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); DriverAssert.AssertDriverContentsAre ("f", output); Assert.Equal ("f ", tf.Text); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -144,20 +144,20 @@ public class AppendAutocompleteTests (ITestOutputHelper output) // f is typed and suggestion is "fish" Application.RaiseKeyDownEvent ('f'); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("fish", output); Assert.Equal ("f", tf.Text); // x is typed and suggestion should disappear Application.RaiseKeyDownEvent (Key.X); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); DriverAssert.AssertDriverContentsAre ("fx", output); Assert.Equal ("fx", tf.Text); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -170,9 +170,9 @@ public class AppendAutocompleteTests (ITestOutputHelper output) var generator = (SingleWordSuggestionGenerator)tf.Autocomplete.SuggestionGenerator; generator.AllSuggestions = new() { "FISH" }; - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("", output); tf.NewKeyDownEvent (Key.M); @@ -182,20 +182,20 @@ public class AppendAutocompleteTests (ITestOutputHelper output) Assert.Equal ("my f", tf.Text); // Even though there is no match on case we should still get the suggestion - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("my fISH", output); Assert.Equal ("my f", tf.Text); // When tab completing the case of the whole suggestion should be applied Application.RaiseKeyDownEvent ('\t'); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); DriverAssert.AssertDriverContentsAre ("my FISH", output); Assert.Equal ("my FISH", tf.Text); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -208,35 +208,35 @@ public class AppendAutocompleteTests (ITestOutputHelper output) var generator = (SingleWordSuggestionGenerator)tf.Autocomplete.SuggestionGenerator; generator.AllSuggestions = new() { "fish" }; - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("", output); tf.NewKeyDownEvent (new ('f')); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre ("fish", output); Assert.Equal ("f", tf.Text); Application.RaiseKeyDownEvent ('\t'); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); DriverAssert.AssertDriverContentsAre ("fish", output); Assert.Equal ("fish", tf.Text); // Tab should autcomplete but not move focus - Assert.Same (tf, Application.Top.Focused); + Assert.Same (tf, Application.TopRunnableView.Focused); // Second tab should move focus (nothing to autocomplete) Application.RaiseKeyDownEvent ('\t'); - Assert.NotSame (tf, Application.Top.Focused); - Application.Top.Dispose (); + Assert.NotSame (tf, Application.TopRunnableView.Focused); + Application.TopRunnableView.Dispose (); } [Theory] @@ -250,13 +250,13 @@ public class AppendAutocompleteTests (ITestOutputHelper output) // f is typed we should only see 'f' up to size of View (10) Application.RaiseKeyDownEvent ('f'); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.PositionCursor (); DriverAssert.AssertDriverContentsAre (expectRender, output); Assert.Equal ("f", tf.Text); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } private TextField GetTextFieldsInView () @@ -264,7 +264,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output) var tf = new TextField { Width = 10 }; var tf2 = new TextField { Y = 1, Width = 10 }; - Toplevel top = new (); + Runnable top = new (); top.Add (tf); top.Add (tf2); diff --git a/Tests/UnitTests/Views/ButtonTests.cs b/Tests/UnitTests/Views/ButtonTests.cs index d05a3fc53..6e3690eee 100644 --- a/Tests/UnitTests/Views/ButtonTests.cs +++ b/Tests/UnitTests/Views/ButtonTests.cs @@ -13,7 +13,10 @@ public class ButtonTests (ITestOutputHelper output) // Override CM Button.DefaultShadow = ShadowStyle.None; - var btn = new Button (); + var btn = new Button () + { + App = ApplicationImpl.Instance + }; Assert.Equal (string.Empty, btn.Text); btn.BeginInit (); btn.EndInit (); @@ -45,7 +48,8 @@ public class ButtonTests (ITestOutputHelper output) DriverAssert.AssertDriverContentsWithFrameAre (expected, output); btn.Dispose (); - btn = new () { Text = "_Test", IsDefault = true }; + btn = new () { App = ApplicationImpl.Instance, + Text = "_Test", IsDefault = true }; btn.Layout (); Assert.Equal (new (10, 1), btn.TextFormatter.ConstrainToSize); @@ -77,7 +81,8 @@ public class ButtonTests (ITestOutputHelper output) btn.Dispose (); - btn = new () { X = 1, Y = 2, Text = "_abc", IsDefault = true }; + btn = new () { App = ApplicationImpl.Instance, + X = 1, Y = 2, Text = "_abc", IsDefault = true }; btn.BeginInit (); btn.EndInit (); Assert.Equal ("_abc", btn.Text); @@ -92,13 +97,13 @@ public class ButtonTests (ITestOutputHelper output) Assert.Equal ('_', btn.HotKeySpecifier.Value); Assert.True (btn.CanFocus); - Application.Driver?.ClearContents (); + ApplicationImpl.Instance.Driver?.ClearContents (); btn.Draw (); expected = @$" {Glyphs.LeftBracket}{Glyphs.LeftDefaultIndicator} abc {Glyphs.RightDefaultIndicator}{Glyphs.RightBracket} "; - DriverAssert.AssertDriverContentsWithFrameAre (expected, output); + DriverAssert.AssertDriverContentsWithFrameAre (expected, output, ApplicationImpl.Instance.Driver); Assert.Equal (new (0, 0, 9, 1), btn.Viewport); Assert.Equal (new (1, 2, 9, 1), btn.Frame); @@ -122,7 +127,7 @@ public class ButtonTests (ITestOutputHelper output) Assert.Contains (Command.HotKey, btn.GetSupportedCommands ()); Assert.Contains (Command.Accept, btn.GetSupportedCommands ()); - var top = new Toplevel (); + var top = new Runnable (); top.Add (btn); Application.Begin (top); @@ -168,7 +173,7 @@ public class ButtonTests (ITestOutputHelper output) var clicked = false; var btn = new Button { Text = "_Test" }; btn.Accepting += (s, e) => clicked = true; - var top = new Toplevel (); + var top = new Runnable (); top.Add (btn); Application.Begin (top); @@ -203,8 +208,8 @@ public class ButtonTests (ITestOutputHelper output) Assert.True (clicked); clicked = false; - // Toplevel does not handle Enter, so it should get passed on to button - Assert.False (Application.Top.NewKeyDownEvent (Key.Enter)); + // Runnable does not handle Enter, so it should get passed on to button + Assert.False (Application.TopRunnableView.NewKeyDownEvent (Key.Enter)); Assert.True (clicked); clicked = false; @@ -238,14 +243,14 @@ public class ButtonTests (ITestOutputHelper output) var btn = new Button { X = Pos.Center (), Y = Pos.Center (), Text = "Say Hello 你" }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; win.Add (btn); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Assert.False (btn.IsInitialized); Application.Begin (top); Application.Driver?.SetScreenSize (30, 5); - + Application.LayoutAndDraw(); Assert.True (btn.IsInitialized); Assert.Equal ("Say Hello 你", btn.Text); Assert.Equal ($"{Glyphs.LeftBracket} {btn.Text} {Glyphs.RightBracket}", btn.TextFormatter.Text); diff --git a/Tests/UnitTests/Views/CheckBoxTests.cs b/Tests/UnitTests/Views/CheckBoxTests.cs index adfde4db8..a14d1c45d 100644 --- a/Tests/UnitTests/Views/CheckBoxTests.cs +++ b/Tests/UnitTests/Views/CheckBoxTests.cs @@ -12,64 +12,6 @@ public class CheckBoxTests (ITestOutputHelper output) - [Fact] - public void Commands_Select () - { - Application.Navigation = new (); - Application.Top = new (); - View otherView = new () { CanFocus = true }; - var ckb = new CheckBox (); - Application.Top.Add (ckb, otherView); - Application.Top.SetFocus (); - Assert.True (ckb.HasFocus); - - var checkedStateChangingCount = 0; - ckb.CheckedStateChanging += (s, e) => checkedStateChangingCount++; - - var selectCount = 0; - ckb.Selecting += (s, e) => selectCount++; - - var acceptCount = 0; - ckb.Accepting += (s, e) => acceptCount++; - - Assert.Equal (CheckState.UnChecked, ckb.CheckedState); - Assert.Equal (0, checkedStateChangingCount); - Assert.Equal (0, selectCount); - Assert.Equal (0, acceptCount); - Assert.Equal (Key.Empty, ckb.HotKey); - - // Test while focused - ckb.Text = "_Test"; - Assert.Equal (Key.T, ckb.HotKey); - ckb.NewKeyDownEvent (Key.T); - Assert.Equal (CheckState.Checked, ckb.CheckedState); - Assert.Equal (1, checkedStateChangingCount); - Assert.Equal (1, selectCount); - Assert.Equal (0, acceptCount); - - ckb.Text = "T_est"; - Assert.Equal (Key.E, ckb.HotKey); - ckb.NewKeyDownEvent (Key.E.WithAlt); - Assert.Equal (2, checkedStateChangingCount); - Assert.Equal (2, selectCount); - Assert.Equal (0, acceptCount); - - ckb.NewKeyDownEvent (Key.Space); - Assert.Equal (3, checkedStateChangingCount); - Assert.Equal (3, selectCount); - Assert.Equal (0, acceptCount); - - ckb.NewKeyDownEvent (Key.Enter); - Assert.Equal (3, checkedStateChangingCount); - Assert.Equal (3, selectCount); - Assert.Equal (1, acceptCount); - - Application.Top.Dispose (); - Application.ResetState (); - } - - - #region Mouse Tests @@ -92,11 +34,12 @@ public class CheckBoxTests (ITestOutputHelper output) }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" }; win.Add (checkBox); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Application.Begin (top); Application.Driver?.SetScreenSize (30, 5); + Application.LayoutAndDraw (); Assert.Equal (Alignment.Center, checkBox.TextAlignment); Assert.Equal (new (1, 1, 25, 1), checkBox.Frame); @@ -152,12 +95,12 @@ public class CheckBoxTests (ITestOutputHelper output) }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" }; win.Add (checkBox1, checkBox2); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); SessionToken rs = Application.Begin (top); Application.Driver!.SetScreenSize (30, 6); - + Application.LayoutAndDraw (); Assert.Equal (Alignment.Fill, checkBox1.TextAlignment); Assert.Equal (new (1, 1, 25, 1), checkBox1.Frame); Assert.Equal (Alignment.Fill, checkBox2.TextAlignment); @@ -213,12 +156,12 @@ public class CheckBoxTests (ITestOutputHelper output) }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" }; win.Add (checkBox); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Application.Begin (top); Application.Driver!.SetScreenSize (30, 5); - + Application.LayoutAndDraw (); Assert.Equal (Alignment.Start, checkBox.TextAlignment); Assert.Equal (new (1, 1, 25, 1), checkBox.Frame); Assert.Equal (_size25x1, checkBox.TextFormatter.ConstrainToSize); @@ -264,12 +207,12 @@ public class CheckBoxTests (ITestOutputHelper output) }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" }; win.Add (checkBox); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Application.Begin (top); Application.Driver!.SetScreenSize (30, 5); - + Application.LayoutAndDraw (); Assert.Equal (Alignment.End, checkBox.TextAlignment); Assert.Equal (new (1, 1, 25, 1), checkBox.Frame); Assert.Equal (_size25x1, checkBox.TextFormatter.ConstrainToSize); diff --git a/Tests/UnitTests/Views/ColorPicker16Tests.cs b/Tests/UnitTests/Views/ColorPicker16Tests.cs index be2b376cb..14a089b0c 100644 --- a/Tests/UnitTests/Views/ColorPicker16Tests.cs +++ b/Tests/UnitTests/Views/ColorPicker16Tests.cs @@ -49,7 +49,7 @@ public class ColorPicker16Tests { var colorPicker = new ColorPicker16 { X = 0, Y = 0, Height = 4, Width = 32 }; Assert.Equal (ColorName16.Black, colorPicker.SelectedColor); - var top = new Toplevel (); + var top = new Runnable (); top.Add (colorPicker); Application.Begin (top); diff --git a/Tests/UnitTests/Views/ColorPickerTests.cs b/Tests/UnitTests/Views/ColorPickerTests.cs index e6beba010..3ed1358ef 100644 --- a/Tests/UnitTests/Views/ColorPickerTests.cs +++ b/Tests/UnitTests/Views/ColorPickerTests.cs @@ -1,828 +1,9 @@ -using UnitTests; +#nullable enable +using UnitTests; -namespace UnitTests.ViewsTests; +namespace UnitTests_Parallelizable.ViewsTests; public class ColorPickerTests { - [Fact] - [SetupFakeApplication] - public void ColorPicker_ChangeValueOnUI_UpdatesAllUIElements () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, true); - - var otherView = new View { CanFocus = true }; - - Application.Top?.Add (otherView); // thi sets focus to otherView - Assert.True (otherView.HasFocus); - - cp.SetFocus (); - Assert.False (otherView.HasFocus); - - cp.Draw (); - - ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - TextField rTextField = GetTextField (cp, ColorPickerPart.Bar1); - TextField gTextField = GetTextField (cp, ColorPickerPart.Bar2); - TextField bTextField = GetTextField (cp, ColorPickerPart.Bar3); - - Assert.Equal ("R:", r.Text); - Assert.Equal (2, r.TrianglePosition); - Assert.Equal ("0", rTextField.Text); - Assert.Equal ("G:", g.Text); - Assert.Equal (2, g.TrianglePosition); - Assert.Equal ("0", gTextField.Text); - Assert.Equal ("B:", b.Text); - Assert.Equal (2, b.TrianglePosition); - Assert.Equal ("0", bTextField.Text); - Assert.Equal ("#000000", hex.Text); - - // Change value using text field - TextField rBarTextField = cp.SubViews.OfType ().First (tf => tf.Text == "0"); - - rBarTextField.SetFocus (); - rBarTextField.Text = "128"; - - otherView.SetFocus (); - Assert.True (otherView.HasFocus); - - cp.Draw (); - - Assert.Equal ("R:", r.Text); - Assert.Equal (9, r.TrianglePosition); - Assert.Equal ("128", rTextField.Text); - Assert.Equal ("G:", g.Text); - Assert.Equal (2, g.TrianglePosition); - Assert.Equal ("0", gTextField.Text); - Assert.Equal ("B:", b.Text); - Assert.Equal (2, b.TrianglePosition); - Assert.Equal ("0", bTextField.Text); - Assert.Equal ("#800000", hex.Text); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_ClickingAtEndOfBar_SetsMaxValue () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, false); - - cp.Draw (); - - // Click at the end of the Red bar - cp.Focused.RaiseMouseEvent ( - new () - { - Flags = MouseFlags.Button1Pressed, - Position = new (19, 0) // Assuming 0-based indexing - }); - - cp.Draw (); - - ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - - Assert.Equal ("R:", r.Text); - Assert.Equal (19, r.TrianglePosition); - Assert.Equal ("G:", g.Text); - Assert.Equal (2, g.TrianglePosition); - Assert.Equal ("B:", b.Text); - Assert.Equal (2, b.TrianglePosition); - Assert.Equal ("#FF0000", hex.Text); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_ClickingBeyondBar_ChangesToMaxValue () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, false); - - cp.Draw (); - - // Click beyond the bar - cp.Focused.RaiseMouseEvent ( - new () - { - Flags = MouseFlags.Button1Pressed, - Position = new (21, 0) // Beyond the bar - }); - - cp.Draw (); - - ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - - Assert.Equal ("R:", r.Text); - Assert.Equal (19, r.TrianglePosition); - Assert.Equal ("G:", g.Text); - Assert.Equal (2, g.TrianglePosition); - Assert.Equal ("B:", b.Text); - Assert.Equal (2, b.TrianglePosition); - Assert.Equal ("#FF0000", hex.Text); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_ClickingDifferentBars_ChangesFocus () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, false); - - cp.Draw (); - - // Click on Green bar - Application.RaiseMouseEvent ( - new () - { - Flags = MouseFlags.Button1Pressed, - ScreenPosition = new (0, 1) - }); - - //cp.SubViews.OfType () - // .Single () - // .OnMouseEvent ( - // new () - // { - // Flags = MouseFlags.Button1Pressed, - // Position = new (0, 1) - // }); - - cp.Draw (); - - Assert.IsAssignableFrom (cp.Focused); - - // Click on Blue bar - Application.RaiseMouseEvent ( - new () - { - Flags = MouseFlags.Button1Pressed, - ScreenPosition = new (0, 2) - }); - - //cp.SubViews.OfType () - // .Single () - // .OnMouseEvent ( - // new () - // { - // Flags = MouseFlags.Button1Pressed, - // Position = new (0, 2) - // }); - - cp.Draw (); - - Assert.IsAssignableFrom (cp.Focused); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_Construct_DefaultValue () - { - ColorPicker cp = GetColorPicker (ColorModel.HSV, false); - - // Should be only a single text field (Hex) because ShowTextFields is false - Assert.Single (cp.SubViews.OfType ()); - - cp.Draw (); - - // All bars should be at 0 with the triangle at 0 (+2 because of "H:", "S:" etc) - ColorBar h = GetColorBar (cp, ColorPickerPart.Bar1); - Assert.Equal ("H:", h.Text); - Assert.Equal (2, h.TrianglePosition); - Assert.IsType (h); - - ColorBar s = GetColorBar (cp, ColorPickerPart.Bar2); - Assert.Equal ("S:", s.Text); - Assert.Equal (2, s.TrianglePosition); - Assert.IsType (s); - - ColorBar v = GetColorBar (cp, ColorPickerPart.Bar3); - Assert.Equal ("V:", v.Text); - Assert.Equal (2, v.TrianglePosition); - Assert.IsType (v); - - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - Assert.Equal ("#000000", hex.Text); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_DisposesOldViews_OnModelChange () - { - ColorPicker cp = GetColorPicker (ColorModel.HSL, true); - - ColorBar b1 = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar b2 = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b3 = GetColorBar (cp, ColorPickerPart.Bar3); - - TextField tf1 = GetTextField (cp, ColorPickerPart.Bar1); - TextField tf2 = GetTextField (cp, ColorPickerPart.Bar2); - TextField tf3 = GetTextField (cp, ColorPickerPart.Bar3); - - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - -#if DEBUG_IDISPOSABLE - Assert.All (new View [] { b1, b2, b3, tf1, tf2, tf3, hex }, b => Assert.False (b.WasDisposed)); -#endif - cp.Style.ColorModel = ColorModel.RGB; - cp.ApplyStyleChanges (); - - ColorBar b1After = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar b2After = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b3After = GetColorBar (cp, ColorPickerPart.Bar3); - - TextField tf1After = GetTextField (cp, ColorPickerPart.Bar1); - TextField tf2After = GetTextField (cp, ColorPickerPart.Bar2); - TextField tf3After = GetTextField (cp, ColorPickerPart.Bar3); - - TextField hexAfter = GetTextField (cp, ColorPickerPart.Hex); - - // Old bars should be disposed -#if DEBUG_IDISPOSABLE - Assert.All (new View [] { b1, b2, b3, tf1, tf2, tf3, hex }, b => Assert.True (b.WasDisposed)); -#endif - Assert.NotSame (hex, hexAfter); - - Assert.NotSame (b1, b1After); - Assert.NotSame (b2, b2After); - Assert.NotSame (b3, b3After); - - Assert.NotSame (tf1, tf1After); - Assert.NotSame (tf2, tf2After); - Assert.NotSame (tf3, tf3After); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_EnterHexFor_ColorName () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, true, true); - - cp.Draw (); - - TextField name = GetTextField (cp, ColorPickerPart.ColorName); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - - hex.SetFocus (); - - Assert.True (hex.HasFocus); - Assert.Same (hex, cp.Focused); - - hex.Text = ""; - name.Text = ""; - - Assert.Empty (hex.Text); - Assert.Empty (name.Text); - - Application.RaiseKeyDownEvent ('#'); - Assert.Empty (name.Text); - - //7FFFD4 - - Assert.Equal ("#", hex.Text); - Application.RaiseKeyDownEvent ('7'); - Application.RaiseKeyDownEvent ('F'); - Application.RaiseKeyDownEvent ('F'); - Application.RaiseKeyDownEvent ('F'); - Application.RaiseKeyDownEvent ('D'); - Assert.Empty (name.Text); - - Application.RaiseKeyDownEvent ('4'); - - Assert.True (hex.HasFocus); - - // Tab out of the hex field - should wrap to first focusable subview - Application.RaiseKeyDownEvent (Key.Tab); - Assert.False (hex.HasFocus); - Assert.NotSame (hex, cp.Focused); - - // Color name should be recognised as a known string and populated - Assert.Equal ("#7FFFD4", hex.Text); - Assert.Equal ("Aquamarine", name.Text); - } - - /// - /// In this version we use the Enter button to accept the typed text instead - /// of tabbing to the next view. - /// - [Fact] - [SetupFakeApplication] - public void ColorPicker_EnterHexFor_ColorName_AcceptVariation () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, true, true); - - cp.Draw (); - - TextField name = GetTextField (cp, ColorPickerPart.ColorName); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - - hex.SetFocus (); - - Assert.True (hex.HasFocus); - Assert.Same (hex, cp.Focused); - - hex.Text = ""; - name.Text = ""; - - Assert.Empty (hex.Text); - Assert.Empty (name.Text); - - Application.RaiseKeyDownEvent ('#'); - Assert.Empty (name.Text); - - //7FFFD4 - - Assert.Equal ("#", hex.Text); - Application.RaiseKeyDownEvent ('7'); - Application.RaiseKeyDownEvent ('F'); - Application.RaiseKeyDownEvent ('F'); - Application.RaiseKeyDownEvent ('F'); - Application.RaiseKeyDownEvent ('D'); - Assert.Empty (name.Text); - - Application.RaiseKeyDownEvent ('4'); - - Assert.True (hex.HasFocus); - - // Should stay in the hex field (because accept not tab) - Application.RaiseKeyDownEvent (Key.Enter); - Assert.True (hex.HasFocus); - Assert.Same (hex, cp.Focused); - - // But still, Color name should be recognised as a known string and populated - Assert.Equal ("#7FFFD4", hex.Text); - Assert.Equal ("Aquamarine", name.Text); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_InvalidHexInput_DoesNotChangeColor () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, true); - - cp.Draw (); - - // Enter invalid hex value - TextField hexField = cp.SubViews.OfType ().First (tf => tf.Text == "#000000"); - hexField.SetFocus (); - hexField.Text = "#ZZZZZZ"; - Assert.True (hexField.HasFocus); - Assert.Equal ("#ZZZZZZ", hexField.Text); - - ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - - Assert.Equal ("#ZZZZZZ", hex.Text); - - // Advance away from hexField to cause validation - cp.AdvanceFocus (NavigationDirection.Forward, null); - - cp.Draw (); - - Assert.Equal ("R:", r.Text); - Assert.Equal (2, r.TrianglePosition); - Assert.Equal ("G:", g.Text); - Assert.Equal (2, g.TrianglePosition); - Assert.Equal ("B:", b.Text); - Assert.Equal (2, b.TrianglePosition); - Assert.Equal ("#000000", hex.Text); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_RGB_KeyboardNavigation () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, false); - cp.Draw (); - - ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - - Assert.Equal ("R:", r.Text); - Assert.Equal (2, r.TrianglePosition); - Assert.IsType (r); - Assert.Equal ("G:", g.Text); - Assert.Equal (2, g.TrianglePosition); - Assert.IsType (g); - Assert.Equal ("B:", b.Text); - Assert.Equal (2, b.TrianglePosition); - Assert.IsType (b); - Assert.Equal ("#000000", hex.Text); - - Assert.IsAssignableFrom (cp.Focused); - - cp.Draw (); - - Application.RaiseKeyDownEvent (Key.CursorRight); - - cp.Draw (); - - Assert.Equal (3, r.TrianglePosition); - Assert.Equal ("#0F0000", hex.Text); - - Application.RaiseKeyDownEvent (Key.CursorRight); - - cp.Draw (); - - Assert.Equal (4, r.TrianglePosition); - Assert.Equal ("#1E0000", hex.Text); - - // Use cursor to move the triangle all the way to the right - for (var i = 0; i < 1000; i++) - { - Application.RaiseKeyDownEvent (Key.CursorRight); - } - - cp.Draw (); - - // 20 width and TrianglePosition is 0 indexed - // Meaning we are asserting that triangle is at end - Assert.Equal (19, r.TrianglePosition); - Assert.Equal ("#FF0000", hex.Text); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_RGB_MouseNavigation () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, false); - - cp.Draw (); - - ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - - Assert.Equal ("R:", r.Text); - Assert.Equal (2, r.TrianglePosition); - Assert.IsType (r); - Assert.Equal ("G:", g.Text); - Assert.Equal (2, g.TrianglePosition); - Assert.IsType (g); - Assert.Equal ("B:", b.Text); - Assert.Equal (2, b.TrianglePosition); - Assert.IsType (b); - Assert.Equal ("#000000", hex.Text); - - Assert.IsAssignableFrom (cp.Focused); - - cp.Focused.RaiseMouseEvent ( - new () - { - Flags = MouseFlags.Button1Pressed, - Position = new (3, 0) - }); - - cp.Draw (); - - Assert.Equal (3, r.TrianglePosition); - Assert.Equal ("#0F0000", hex.Text); - - cp.Focused.RaiseMouseEvent ( - new () - { - Flags = MouseFlags.Button1Pressed, - Position = new (4, 0) - }); - - cp.Draw (); - - Assert.Equal (4, r.TrianglePosition); - Assert.Equal ("#1E0000", hex.Text); - } - - [Theory] - [SetupFakeApplication] - [MemberData (nameof (ColorPickerTestData))] - public void ColorPicker_RGB_NoText ( - Color c, - string expectedR, - int expectedRTriangle, - string expectedG, - int expectedGTriangle, - string expectedB, - int expectedBTriangle, - string expectedHex - ) - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, false); - cp.SelectedColor = c; - - cp.Draw (); - - ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - - Assert.Equal (expectedR, r.Text); - Assert.Equal (expectedRTriangle, r.TrianglePosition); - Assert.Equal (expectedG, g.Text); - Assert.Equal (expectedGTriangle, g.TrianglePosition); - Assert.Equal (expectedB, b.Text); - Assert.Equal (expectedBTriangle, b.TrianglePosition); - Assert.Equal (expectedHex, hex.Text); - } - - [Theory] - [SetupFakeApplication] - [MemberData (nameof (ColorPickerTestData_WithTextFields))] - public void ColorPicker_RGB_NoText_WithTextFields ( - Color c, - string expectedR, - int expectedRTriangle, - int expectedRValue, - string expectedG, - int expectedGTriangle, - int expectedGValue, - string expectedB, - int expectedBTriangle, - int expectedBValue, - string expectedHex - ) - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, true); - cp.SelectedColor = c; - - cp.Draw (); - - ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - TextField rTextField = GetTextField (cp, ColorPickerPart.Bar1); - TextField gTextField = GetTextField (cp, ColorPickerPart.Bar2); - TextField bTextField = GetTextField (cp, ColorPickerPart.Bar3); - - Assert.Equal (expectedR, r.Text); - Assert.Equal (expectedRTriangle, r.TrianglePosition); - Assert.Equal (expectedRValue.ToString (), rTextField.Text); - Assert.Equal (expectedG, g.Text); - Assert.Equal (expectedGTriangle, g.TrianglePosition); - Assert.Equal (expectedGValue.ToString (), gTextField.Text); - Assert.Equal (expectedB, b.Text); - Assert.Equal (expectedBTriangle, b.TrianglePosition); - Assert.Equal (expectedBValue.ToString (), bTextField.Text); - Assert.Equal (expectedHex, hex.Text); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_SwitchingColorModels_ResetsBars () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, false); - cp.BeginInit (); - cp.EndInit (); - cp.SelectedColor = new (255, 0); - - cp.Draw (); - - ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - - Assert.Equal ("R:", r.Text); - Assert.Equal (19, r.TrianglePosition); - Assert.Equal ("G:", g.Text); - Assert.Equal (2, g.TrianglePosition); - Assert.Equal ("B:", b.Text); - Assert.Equal (2, b.TrianglePosition); - Assert.Equal ("#FF0000", hex.Text); - - // Switch to HSV - cp.Style.ColorModel = ColorModel.HSV; - cp.ApplyStyleChanges (); - - cp.Draw (); - - ColorBar h = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar s = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar v = GetColorBar (cp, ColorPickerPart.Bar3); - - Assert.Equal ("H:", h.Text); - Assert.Equal (2, h.TrianglePosition); - Assert.Equal ("S:", s.Text); - Assert.Equal (19, s.TrianglePosition); - Assert.Equal ("V:", v.Text); - Assert.Equal (19, v.TrianglePosition); - Assert.Equal ("#FF0000", hex.Text); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_SyncBetweenTextFieldAndBars () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, true); - - cp.Draw (); - - // Change value using the bar - RBar rBar = cp.SubViews.OfType ().First (); - rBar.Value = 128; - - cp.Draw (); - - ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - TextField rTextField = GetTextField (cp, ColorPickerPart.Bar1); - TextField gTextField = GetTextField (cp, ColorPickerPart.Bar2); - TextField bTextField = GetTextField (cp, ColorPickerPart.Bar3); - - Assert.Equal ("R:", r.Text); - Assert.Equal (9, r.TrianglePosition); - Assert.Equal ("128", rTextField.Text); - Assert.Equal ("G:", g.Text); - Assert.Equal (2, g.TrianglePosition); - Assert.Equal ("0", gTextField.Text); - Assert.Equal ("B:", b.Text); - Assert.Equal (2, b.TrianglePosition); - Assert.Equal ("0", bTextField.Text); - Assert.Equal ("#800000", hex.Text); - } - - [Fact] - [SetupFakeApplication] - public void ColorPicker_TabCompleteColorName () - { - ColorPicker cp = GetColorPicker (ColorModel.RGB, true, true); - - cp.Draw (); - - ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); - ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); - ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); - TextField name = GetTextField (cp, ColorPickerPart.ColorName); - TextField hex = GetTextField (cp, ColorPickerPart.Hex); - - name.SetFocus (); - - Assert.True (name.HasFocus); - Assert.Same (name, cp.Focused); - - name.Text = ""; - Assert.Empty (name.Text); - - Application.RaiseKeyDownEvent (Key.A); - Application.RaiseKeyDownEvent (Key.Q); - - Assert.Equal ("aq", name.Text); - - // Auto complete the color name - Application.RaiseKeyDownEvent (Key.Tab); - - // Match cyan alternative name - Assert.Equal ("Aqua", name.Text); - - Assert.True (name.HasFocus); - - Application.RaiseKeyDownEvent (Key.Tab); - - // Resolves to cyan color - Assert.Equal ("Aqua", name.Text); - - // Tab out of the text field - Application.RaiseKeyDownEvent (Key.Tab); - - Assert.False (name.HasFocus); - Assert.NotSame (name, cp.Focused); - - Assert.Equal ("#00FFFF", hex.Text); - } - - public static IEnumerable ColorPickerTestData () - { - yield return new object [] - { - new Color (255, 0), - "R:", 19, "G:", 2, "B:", 2, "#FF0000" - }; - - yield return new object [] - { - new Color (0, 255), - "R:", 2, "G:", 19, "B:", 2, "#00FF00" - }; - - yield return new object [] - { - new Color (0, 0, 255), - "R:", 2, "G:", 2, "B:", 19, "#0000FF" - }; - - yield return new object [] - { - new Color (125, 125, 125), - "R:", 11, "G:", 11, "B:", 11, "#7D7D7D" - }; - } - - public static IEnumerable ColorPickerTestData_WithTextFields () - { - yield return new object [] - { - new Color (255, 0), - "R:", 15, 255, "G:", 2, 0, "B:", 2, 0, "#FF0000" - }; - - yield return new object [] - { - new Color (0, 255), - "R:", 2, 0, "G:", 15, 255, "B:", 2, 0, "#00FF00" - }; - - yield return new object [] - { - new Color (0, 0, 255), - "R:", 2, 0, "G:", 2, 0, "B:", 15, 255, "#0000FF" - }; - - yield return new object [] - { - new Color (125, 125, 125), - "R:", 9, 125, "G:", 9, 125, "B:", 9, 125, "#7D7D7D" - }; - } - - private ColorBar GetColorBar (ColorPicker cp, ColorPickerPart toGet) - { - if (toGet <= ColorPickerPart.Bar3) - { - return cp.SubViews.OfType ().ElementAt ((int)toGet); - } - - throw new NotSupportedException ("ColorPickerPart must be a bar"); - } - - private ColorPicker GetColorPicker (ColorModel colorModel, bool showTextFields, bool showName = false) - { - var cp = new ColorPicker { Width = 20, SelectedColor = new (0, 0) }; - cp.Style.ColorModel = colorModel; - cp.Style.ShowTextFields = showTextFields; - cp.Style.ShowColorName = showName; - cp.ApplyStyleChanges (); - - Application.Navigation = new (); - - Application.Top = new () { Width = 20, Height = 5 }; - Application.Top.Add (cp); - - Application.Top.LayoutSubViews (); - Application.Top.SetFocus (); - - return cp; - } - - private TextField GetTextField (ColorPicker cp, ColorPickerPart toGet) - { - bool hasBarValueTextFields = cp.Style.ShowTextFields; - bool hasColorNameTextField = cp.Style.ShowColorName; - - switch (toGet) - { - case ColorPickerPart.Bar1: - case ColorPickerPart.Bar2: - case ColorPickerPart.Bar3: - if (!hasBarValueTextFields) - { - throw new NotSupportedException ("Corresponding Style option is not enabled"); - } - - return cp.SubViews.OfType ().ElementAt ((int)toGet); - case ColorPickerPart.ColorName: - if (!hasColorNameTextField) - { - throw new NotSupportedException ("Corresponding Style option is not enabled"); - } - - return cp.SubViews.OfType ().ElementAt (hasBarValueTextFields ? (int)toGet : (int)toGet - 3); - case ColorPickerPart.Hex: - - int offset = hasBarValueTextFields ? 0 : 3; - offset += hasColorNameTextField ? 0 : 1; - - return cp.SubViews.OfType ().ElementAt ((int)toGet - offset); - default: - throw new ArgumentOutOfRangeException (nameof (toGet), toGet, null); - } - } - - private enum ColorPickerPart - { - Bar1 = 0, - Bar2 = 1, - Bar3 = 2, - ColorName = 3, - Hex = 4 - } + } diff --git a/Tests/UnitTests/Views/ComboBoxTests.cs b/Tests/UnitTests/Views/ComboBoxTests.cs index e1280424c..338a871d6 100644 --- a/Tests/UnitTests/Views/ComboBoxTests.cs +++ b/Tests/UnitTests/Views/ComboBoxTests.cs @@ -77,7 +77,7 @@ public class ComboBoxTests (ITestOutputHelper output) string [] source = Enumerable.Range (0, 15).Select (x => x.ToString ()).ToArray (); comboBox.SetSource (new ObservableCollection (source.ToList ())); - var top = new Toplevel (); + var top = new Runnable (); top.Add (comboBox); foreach (KeyCode key in (KeyCode [])Enum.GetValues (typeof (KeyCode))) @@ -96,7 +96,7 @@ public class ComboBoxTests (ITestOutputHelper output) cb.Expanded += (s, e) => cb.SetSource (list); cb.Collapsed += (s, e) => cb.Source = null; - var top = new Toplevel (); + var top = new Runnable (); top.Add (cb); Application.Begin (top); @@ -127,7 +127,7 @@ public class ComboBoxTests (ITestOutputHelper output) var cb = new ComboBox { Height = 4, Width = 5, HideDropdownListOnClick = false }; cb.SetSource (["One", "Two", "Three"]); cb.OpenSelectedItem += (s, e) => selected = e.Value.ToString (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (cb); Application.Begin (top); @@ -182,7 +182,7 @@ public class ComboBoxTests (ITestOutputHelper output) var cb = new ComboBox { Height = 4, Width = 5, HideDropdownListOnClick = false }; cb.SetSource (["One", "Two", "Three"]); cb.OpenSelectedItem += (s, e) => selected = e.Value.ToString (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (cb); Application.Begin (top); @@ -219,7 +219,7 @@ public class ComboBoxTests (ITestOutputHelper output) var cb = new ComboBox { Height = 4, Width = 5, HideDropdownListOnClick = false, ReadOnly = true }; cb.SetSource (["One", "Two", "Three"]); cb.OpenSelectedItem += (s, e) => selected = e.Value.ToString (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (cb); Application.Begin (top); @@ -278,7 +278,7 @@ public class ComboBoxTests (ITestOutputHelper output) var cb = new ComboBox { Height = 4, Width = 5 }; cb.SetSource (["One", "Two", "Three"]); cb.OpenSelectedItem += (s, e) => selected = e.Value.ToString (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (cb); Application.Begin (top); @@ -382,7 +382,7 @@ public class ComboBoxTests (ITestOutputHelper output) var cb = new ComboBox { Height = 4, Width = 5, HideDropdownListOnClick = true }; cb.SetSource (["One", "Two", "Three"]); cb.OpenSelectedItem += (s, e) => selected = e.Value.ToString (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (cb); Application.Begin (top); @@ -501,7 +501,7 @@ public class ComboBoxTests (ITestOutputHelper output) var cb = new ComboBox { Width = 6, Height = 4, HideDropdownListOnClick = true }; cb.SetSource (["One", "Two", "Three"]); cb.OpenSelectedItem += (s, e) => selected = e.Value.ToString (); - var top = new Toplevel (); + var top = new Runnable (); var otherView = new View { CanFocus = true }; @@ -565,7 +565,7 @@ Three ", Assert.True (cb.IsShow); Assert.Equal (-1, cb.SelectedItem); Assert.Equal ("", cb.Text); - View.SetClipToScreen (); + cb.SetClipToScreen (); cb.Draw (); DriverAssert.AssertDriverAttributesAre ( @@ -584,7 +584,7 @@ Three ", Assert.True (cb.IsShow); Assert.Equal (-1, cb.SelectedItem); Assert.Equal ("", cb.Text); - View.SetClipToScreen (); + cb.SetClipToScreen (); cb.Draw (); DriverAssert.AssertDriverAttributesAre ( @@ -609,7 +609,7 @@ Three ", Assert.True (cb.IsShow); Assert.Equal (2, cb.SelectedItem); Assert.Equal ("Three", cb.Text); - View.SetClipToScreen (); + cb.SetClipToScreen (); cb.Draw (); DriverAssert.AssertDriverAttributesAre ( @@ -628,7 +628,7 @@ Three ", Assert.True (cb.IsShow); Assert.Equal (2, cb.SelectedItem); Assert.Equal ("Three", cb.Text); - View.SetClipToScreen (); + cb.SetClipToScreen (); cb.Draw (); DriverAssert.AssertDriverAttributesAre ( @@ -647,7 +647,7 @@ Three ", Assert.True (cb.IsShow); Assert.Equal (2, cb.SelectedItem); Assert.Equal ("Three", cb.Text); - View.SetClipToScreen (); + cb.SetClipToScreen (); cb.Draw (); DriverAssert.AssertDriverAttributesAre ( @@ -677,7 +677,7 @@ Three ", var cb = new ComboBox { Height = 4, Width = 5, HideDropdownListOnClick = true }; cb.SetSource (["One", "Two", "Three"]); cb.OpenSelectedItem += (s, e) => selected = e.Value.ToString (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (cb); Application.Begin (top); @@ -740,7 +740,7 @@ Three ", var cb = new ComboBox { Height = 4, Width = 5, HideDropdownListOnClick = true }; cb.SetSource (["One", "Two", "Three"]); cb.OpenSelectedItem += (s, e) => selected = e.Value.ToString (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (cb); Application.Begin (top); @@ -798,7 +798,7 @@ Three ", var cb = new ComboBox { Height = 4, Width = 5, HideDropdownListOnClick = true }; cb.SetSource (["One", "Two", "Three"]); cb.OpenSelectedItem += (s, e) => selected = e.Value.ToString (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (cb); Application.Begin (top); @@ -832,7 +832,7 @@ Three ", { ObservableCollection source = ["One", "Two", "Three"]; var cb = new ComboBox { Width = 10 }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (cb); @@ -928,7 +928,7 @@ One Assert.Equal (1, cb.SelectedItem); Assert.Equal ("Two", cb.Text); - View.SetClipToScreen (); + cb.SetClipToScreen (); cb.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -944,7 +944,7 @@ Two Assert.Equal (2, cb.SelectedItem); Assert.Equal ("Three", cb.Text); - View.SetClipToScreen (); + cb.SetClipToScreen (); cb.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1009,53 +1009,4 @@ Three Assert.Equal (3, cb.Source.Count); top.Dispose (); } - - [Fact] - public void Source_Equal_Null_Or_Count_Equal_Zero_Sets_SelectedItem_Equal_To_Minus_One () - { - Application.Navigation = new (); - var cb = new ComboBox (); - var top = new Toplevel (); - Application.Top = top; - - top.Add (cb); - top.FocusDeepest (NavigationDirection.Forward, null); - Assert.Null (cb.Source); - Assert.Equal (-1, cb.SelectedItem); - ObservableCollection source = []; - cb.SetSource (source); - Assert.NotNull (cb.Source); - Assert.Equal (0, cb.Source.Count); - Assert.Equal (-1, cb.SelectedItem); - source.Add ("One"); - Assert.Equal (1, cb.Source.Count); - Assert.Equal (-1, cb.SelectedItem); - Assert.True (Application.RaiseKeyDownEvent (Key.F4)); - Assert.True (cb.IsShow); - Assert.Equal (0, cb.SelectedItem); - Assert.Equal ("One", cb.Text); - source.Add ("Two"); - Assert.Equal (0, cb.SelectedItem); - Assert.Equal ("One", cb.Text); - cb.Text = "T"; - Assert.True (cb.IsShow); - Assert.Equal (-1, cb.SelectedItem); - Assert.Equal ("T", cb.Text); - Assert.True (Application.RaiseKeyDownEvent (Key.Enter)); - Assert.False (cb.IsShow); - Assert.Equal (2, cb.Source.Count); - Assert.Equal (-1, cb.SelectedItem); - Assert.Equal ("T", cb.Text); - Assert.True (Application.RaiseKeyDownEvent (Key.Esc)); - Assert.False (cb.IsShow); - Assert.Equal (-1, cb.SelectedItem); // retains last accept selected item - Assert.Equal ("", cb.Text); // clear text - cb.SetSource (new ObservableCollection ()); - Assert.Equal (0, cb.Source.Count); - Assert.Equal (-1, cb.SelectedItem); - Assert.Equal ("", cb.Text); - - Application.Top.Dispose (); - Application.ResetState (true); - } } diff --git a/Tests/UnitTests/Views/DatePickerTests.cs b/Tests/UnitTests/Views/DatePickerTests.cs index 4dd616494..414bddd9c 100644 --- a/Tests/UnitTests/Views/DatePickerTests.cs +++ b/Tests/UnitTests/Views/DatePickerTests.cs @@ -12,7 +12,7 @@ public class DatePickerTests var date = new DateTime (9999, 11, 15); var datePicker = new DatePicker (date); - var top = new Toplevel (); + var top = new Runnable (); top.Add (datePicker); Application.Begin (top); @@ -42,7 +42,7 @@ public class DatePickerTests { var date = new DateTime (1, 2, 15); var datePicker = new DatePicker (date); - var top = new Toplevel (); + var top = new Runnable (); // Move focus to previous month button top.Add (datePicker); diff --git a/Tests/UnitTests/Views/FrameViewTests.cs b/Tests/UnitTests/Views/FrameViewTests.cs index 2b78d216b..9e59b48c4 100644 --- a/Tests/UnitTests/Views/FrameViewTests.cs +++ b/Tests/UnitTests/Views/FrameViewTests.cs @@ -42,7 +42,7 @@ public class FrameViewTests (ITestOutputHelper output) var fv = new FrameView () { BorderStyle = LineStyle.Single }; Assert.Equal (string.Empty, fv.Title); Assert.Equal (string.Empty, fv.Text); - var top = new Toplevel (); + var top = new Runnable (); top.Add (fv); Application.Begin (top); Assert.Equal (new (0, 0, 0, 0), fv.Frame); diff --git a/Tests/UnitTests/Views/GraphViewTests.cs b/Tests/UnitTests/Views/GraphViewTests.cs index d2184945b..8f3d878fd 100644 --- a/Tests/UnitTests/Views/GraphViewTests.cs +++ b/Tests/UnitTests/Views/GraphViewTests.cs @@ -44,7 +44,7 @@ internal class FakeVAxis : VerticalAxis #endregion -public class GraphViewTests +public class GraphViewTests : FakeDriverBase { /// /// A cell size of 0 would result in mapping all graph space into the same cell of the console. Since @@ -74,7 +74,10 @@ public class GraphViewTests /// public static GraphView GetGraph () { - var gv = new GraphView (); + var gv = new GraphView () + { + Driver = Application.Driver ?? CreateFakeDriver () + }; gv.BeginInit (); gv.EndInit (); @@ -604,7 +607,10 @@ public class MultiBarSeriesTests [AutoInitShutdown] public void TestRendering_MultibarSeries () { - var gv = new GraphView (); + var gv = new GraphView () + { + App = ApplicationImpl.Instance, + }; //gv.Scheme = new Scheme (); // y axis goes from 0.1 to 1 across 10 console rows @@ -650,7 +656,7 @@ public class MultiBarSeriesTests fakeXAxis.LabelPoints.Clear (); gv.LayoutSubViews (); gv.SetNeedsDraw (); - View.SetClipToScreen (); + gv.SetClipToScreen (); gv.Draw (); Assert.Equal (3, fakeXAxis.LabelPoints.Count); @@ -677,12 +683,13 @@ public class MultiBarSeriesTests } } -public class BarSeriesTests +public class BarSeriesTests : FakeDriverBase { [Fact] public void TestOneLongOneShortHorizontalBars_WithOffset () { GraphView graph = GetGraph (out FakeBarSeries barSeries, out FakeHAxis axisX, out FakeVAxis axisY); + graph.Driver = CreateFakeDriver (); graph.Draw (); // no bars @@ -847,7 +854,7 @@ public class BarSeriesTests // y axis goes from 0.1 to 1 across 10 console rows // x axis goes from 0 to 10 across 20 console columns gv.Viewport = new Rectangle (0, 0, 20, 10); - //gv.Scheme = new Scheme (); + //gv.Scheme = new Scheme (); gv.CellSize = new PointF (0.5f, 0.1f); gv.Series.Add (series = new FakeBarSeries ()); @@ -886,7 +893,7 @@ public class AxisTests { var gv = new GraphView (); gv.Viewport = new Rectangle (0, 0, 50, 30); - // gv.Scheme = new Scheme (); + // gv.Scheme = new Scheme (); // graph can't be completely empty or it won't draw gv.Series.Add (new ScatterSeries ()); @@ -1125,7 +1132,7 @@ public class TextAnnotationTests // user scrolls up one unit of graph space gv.ScrollOffset = new PointF (0, 1f); gv.SetNeedsDraw (); - View.SetClipToScreen (); + gv.SetClipToScreen (); gv.Draw (); // we expect the text annotation to go down one line since @@ -1222,7 +1229,7 @@ public class TextAnnotationTests new TextAnnotation { Text = "hey!", ScreenPosition = new Point (3, 1) } ); gv.LayoutSubViews (); - View.SetClipToScreen (); + gv.SetClipToScreen (); gv.Draw (); var expected = @@ -1238,7 +1245,7 @@ public class TextAnnotationTests // user scrolls up one unit of graph space gv.ScrollOffset = new PointF (0, 1f); gv.SetNeedsDraw (); - View.SetClipToScreen (); + gv.SetClipToScreen (); gv.Draw (); // we expect no change in the location of the annotation (only the axis label changes) @@ -1257,7 +1264,7 @@ public class TextAnnotationTests // user scrolls up one unit of graph space gv.ScrollOffset = new PointF (0, 1f); gv.SetNeedsDraw (); - View.SetClipToScreen (); + gv.SetClipToScreen (); gv.Draw (); // we expect no change in the location of the annotation (only the axis label changes) @@ -1385,7 +1392,7 @@ public class PathAnnotationTests "; - DriverAssert.AssertDriverContentsAre (expected, _output); + DriverAssert.AssertDriverContentsAre (expected, _output, gv.Driver); // Shutdown must be called to safely clean up Application if Init has been called Application.Shutdown (); @@ -1410,7 +1417,7 @@ public class PathAnnotationTests "; - DriverAssert.AssertDriverContentsAre (expected, _output); + DriverAssert.AssertDriverContentsAre (expected, _output, gv.Driver); // Shutdown must be called to safely clean up Application if Init has been called Application.Shutdown (); @@ -1492,7 +1499,7 @@ public class PathAnnotationTests { // create a wide window var mount = new View { Width = 100, Height = 100 }; - var top = new Toplevel (); + var top = new Runnable (); try { @@ -1512,7 +1519,7 @@ public class PathAnnotationTests //put label into view mount.Add (view); - //putting mount into Toplevel since changing size + //putting mount into Runnable since changing size top.Add (mount); Application.Begin (top); @@ -1528,7 +1535,7 @@ public class PathAnnotationTests // change the text and redraw view.Text = "ff1234"; mount.SetNeedsDraw (); - View.SetClipToScreen (); + top.SetClipToScreen (); mount.Draw (); // should have the new text rendered @@ -1545,7 +1552,11 @@ public class PathAnnotationTests [AutoInitShutdown] public void XAxisLabels_With_MarginLeft () { - var gv = new GraphView { Viewport = new Rectangle (0, 0, 10, 7) }; + var gv = new GraphView + { + App = ApplicationImpl.Instance, + Viewport = new Rectangle (0, 0, 10, 7) + }; gv.CellSize = new PointF (1, 0.5f); gv.AxisY.Increment = 1; @@ -1584,7 +1595,11 @@ public class PathAnnotationTests [AutoInitShutdown] public void YAxisLabels_With_MarginBottom () { - var gv = new GraphView { Viewport = new Rectangle (0, 0, 10, 7) }; + var gv = new GraphView + { + App = ApplicationImpl.Instance, + Viewport = new Rectangle (0, 0, 10, 7) + }; gv.CellSize = new PointF (1, 0.5f); gv.AxisY.Increment = 1; diff --git a/Tests/UnitTests/Views/LabelTests.cs b/Tests/UnitTests/Views/LabelTests.cs index 550abf360..d3a9efe50 100644 --- a/Tests/UnitTests/Views/LabelTests.cs +++ b/Tests/UnitTests/Views/LabelTests.cs @@ -1,4 +1,4 @@ -using UnitTests; +#nullable enable using Xunit.Abstractions; namespace UnitTests.ViewsTests; @@ -14,7 +14,7 @@ public class LabelTests (ITestOutputHelper output) var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; win.Add (label); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Application.Begin (top); @@ -55,12 +55,12 @@ public class LabelTests (ITestOutputHelper output) var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; win.Add (label); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Application.Begin (top); Application.Driver!.SetScreenSize (30, 5); - + Application.LayoutAndDraw (); var expected = @" ┌────────────────────────────┐ │ │ @@ -101,7 +101,7 @@ public class LabelTests (ITestOutputHelper output) TextFormatter tf2 = new () { Direction = TextDirection.LeftRight_TopBottom, ConstrainToSize = tfSize, FillRemaining = true }; tf2.Text = "This TextFormatter (tf2) with fill will be cleared on rewritten."; - Toplevel top = new (); + Runnable top = new (); top.Add (label); SessionToken sessionToken = Application.Begin (top); AutoInitShutdownAttribute.RunIteration (); @@ -112,9 +112,17 @@ public class LabelTests (ITestOutputHelper output) AutoInitShutdownAttribute.RunIteration (); - tf1.Draw (new (new (0, 1), tfSize), label.GetAttributeForRole (VisualRole.Normal), label.GetAttributeForRole (VisualRole.HotNormal)); + tf1.Draw ( + Application.Driver, + new (new (0, 1), tfSize), + label.GetAttributeForRole (VisualRole.Normal), + label.GetAttributeForRole (VisualRole.HotNormal)); - tf2.Draw (new (new (0, 2), tfSize), label.GetAttributeForRole (VisualRole.Normal), label.GetAttributeForRole (VisualRole.HotNormal)); + tf2.Draw ( + Application.Driver, + new (new (0, 2), tfSize), + label.GetAttributeForRole (VisualRole.Normal), + label.GetAttributeForRole (VisualRole.HotNormal)); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -135,10 +143,20 @@ This TextFormatter (tf2) with fill will be cleared on rewritten. ", label.Draw (); tf1.Text = "This TextFormatter (tf1) is rewritten."; - tf1.Draw (new (new (0, 1), tfSize), label.GetAttributeForRole (VisualRole.Normal), label.GetAttributeForRole (VisualRole.HotNormal)); + + tf1.Draw ( + Application.Driver, + new (new (0, 1), tfSize), + label.GetAttributeForRole (VisualRole.Normal), + label.GetAttributeForRole (VisualRole.HotNormal)); tf2.Text = "This TextFormatter (tf2) is rewritten."; - tf2.Draw (new (new (0, 2), tfSize), label.GetAttributeForRole (VisualRole.Normal), label.GetAttributeForRole (VisualRole.HotNormal)); + + tf2.Draw ( + Application.Driver, + new (new (0, 2), tfSize), + label.GetAttributeForRole (VisualRole.Normal), + label.GetAttributeForRole (VisualRole.HotNormal)); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -154,8 +172,8 @@ This TextFormatter (tf2) is rewritten. ", [AutoInitShutdown] public void Label_Draw_Horizontal_Simple_Runes () { - var label = new Label { Text = "Demo Simple Rune" }; - var top = new Toplevel (); + var label = new Label { Text = "Demo Simple Text" }; + var top = new Runnable (); top.Add (label); Application.Begin (top); AutoInitShutdownAttribute.RunIteration (); @@ -163,7 +181,7 @@ This TextFormatter (tf2) is rewritten. ", Assert.Equal (new (0, 0, 16, 1), label.Frame); var expected = @" -Demo Simple Rune +Demo Simple Text "; Rectangle pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); @@ -173,10 +191,10 @@ Demo Simple Rune [Fact] [AutoInitShutdown] - public void Label_Draw_Vertical_Simple_Runes () + public void Label_Draw_Vertical_Simple_Text () { - var label = new Label { TextDirection = TextDirection.TopBottom_LeftRight, Text = "Demo Simple Rune" }; - var top = new Toplevel (); + var label = new Label { TextDirection = TextDirection.TopBottom_LeftRight, Text = "Demo Simple Text" }; + var top = new Runnable (); top.Add (label); Application.Begin (top); AutoInitShutdownAttribute.RunIteration (); @@ -196,10 +214,10 @@ p l e -R -u -n +T e +x +t "; Rectangle pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); @@ -212,7 +230,7 @@ e public void Label_Draw_Vertical_Wide_Runes () { var label = new Label { TextDirection = TextDirection.TopBottom_LeftRight, Text = "デモエムポンズ" }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (label); Application.Begin (top); AutoInitShutdownAttribute.RunIteration (); @@ -239,14 +257,14 @@ e var label = new Label { X = Pos.Center (), Y = Pos.Center (), Text = "Say Hello 你" }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; win.Add (label); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Assert.False (label.IsInitialized); Application.Begin (top); Application.Driver!.SetScreenSize (30, 5); - + Application.LayoutAndDraw (); Assert.True (label.IsInitialized); Assert.Equal ("Say Hello 你", label.Text); Assert.Equal ("Say Hello 你", label.TextFormatter.Text); @@ -271,14 +289,14 @@ e var label = new Label { X = Pos.Center (), Y = Pos.Center (), Text = "Say Hello 你" }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; win.Add (label); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Assert.False (label.IsInitialized); Application.Begin (top); Application.Driver!.SetScreenSize (30, 5); - + Application.LayoutAndDraw (); Assert.True (label.IsInitialized); Assert.Equal ("Say Hello 你", label.Text); Assert.Equal ("Say Hello 你", label.TextFormatter.Text); @@ -301,7 +319,11 @@ e [SetupFakeApplication] public void Full_Border () { - var label = new Label { BorderStyle = LineStyle.Single, Text = "Test" }; + var label = new Label + { + Driver = Application.Driver, + BorderStyle = LineStyle.Single, Text = "Test" + }; label.BeginInit (); label.EndInit (); label.SetRelativeLayout (Application.Screen.Size); @@ -321,54 +343,6 @@ e label.Dispose (); } - [Fact] - [AutoInitShutdown] - public void With_Top_Margin_Without_Top_Border () - { - var label = new Label { Text = "Test", /*Width = 6, Height = 3,*/ BorderStyle = LineStyle.Single }; - label.Margin!.Thickness = new (0, 1, 0, 0); - label.Border!.Thickness = new (1, 0, 1, 1); - var top = new Toplevel (); - top.Add (label); - Application.Begin (top); - AutoInitShutdownAttribute.RunIteration (); - - Assert.Equal (new (0, 0, 6, 3), label.Frame); - Assert.Equal (new (0, 0, 4, 1), label.Viewport); - Application.Begin (top); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -│Test│ -└────┘", - output - ); - top.Dispose (); - } - - [Fact] - [AutoInitShutdown] - public void Without_Top_Border () - { - var label = new Label { Text = "Test", /* Width = 6, Height = 3, */BorderStyle = LineStyle.Single }; - label.Border!.Thickness = new (1, 0, 1, 1); - var top = new Toplevel (); - top.Add (label); - Application.Begin (top); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (new (0, 0, 6, 2), label.Frame); - Assert.Equal (new (0, 0, 4, 1), label.Viewport); - Application.Begin (top); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -│Test│ -└────┘", - output - ); - top.Dispose (); - } - // These tests were formally in AutoSizetrue.cs. They are (poor) Label tests. private readonly string [] _expecteds = new string [21] { @@ -699,6 +673,7 @@ e var label = new Label { Text = "This should be the last line.", + //Width = Dim.Fill (), X = 0, // keep unit test focused; don't use Center here Y = Pos.AnchorEnd (1) @@ -706,11 +681,11 @@ e win.Add (label); - Toplevel top = new (); + Runnable top = new (); top.Add (win); SessionToken rs = Application.Begin (top); Application.Driver!.SetScreenSize (40, 10); - + Application.LayoutAndDraw (); Assert.Equal (29, label.Text.Length); Assert.Equal (new (0, 0, 40, 10), top.Frame); Assert.Equal (new (0, 0, 40, 10), win.Frame); @@ -745,6 +720,7 @@ e var label = new Label { Text = "This should be the last line.", + //Width = Dim.Fill (), X = 0, Y = Pos.Bottom (win) @@ -753,11 +729,11 @@ e win.Add (label); - Toplevel top = new (); + Runnable top = new (); top.Add (win); SessionToken rs = Application.Begin (top); Application.Driver!.SetScreenSize (40, 10); - + Application.LayoutAndDraw (); Assert.Equal (new (0, 0, 40, 10), top.Frame); Assert.Equal (new (0, 0, 40, 10), win.Frame); Assert.Equal (new (0, 7, 29, 1), label.Frame); @@ -786,7 +762,7 @@ e [AutoInitShutdown] public void Dim_Subtract_Operator_With_Text () { - Toplevel top = new (); + Runnable top = new (); var view = new View { @@ -829,6 +805,7 @@ e if (k.KeyCode == KeyCode.Enter) { Application.Driver!.SetScreenSize (22, count + 4); + Application.LayoutAndDraw (); Rectangle pos = DriverAssert.AssertDriverContentsWithFrameAre (_expecteds [count], output); Assert.Equal (new (0, 0, 22, count + 4), pos); @@ -873,7 +850,7 @@ e return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { while (count > -1) { @@ -907,7 +884,11 @@ e label.Width = Dim.Fill () - text.Length; label.Height = 0; - var win = new View { CanFocus = true, BorderStyle = LineStyle.Single, Width = Dim.Fill (), Height = Dim.Fill () }; + var win = new View + { + App = ApplicationImpl.Instance, + CanFocus = true, BorderStyle = LineStyle.Single, Width = Dim.Fill (), Height = Dim.Fill () + }; win.Add (label); win.BeginInit (); win.EndInit (); @@ -965,7 +946,7 @@ e [AutoInitShutdown] public void Dim_Add_Operator_With_Text () { - Toplevel top = new (); + Runnable top = new (); var view = new View { @@ -985,6 +966,7 @@ e if (k.KeyCode == KeyCode.Enter) { Application.Driver!.SetScreenSize (22, count + 4); + Application.LayoutAndDraw (); Rectangle pos = DriverAssert.AssertDriverContentsWithFrameAre (_expecteds [count], output); Assert.Equal (new (0, 0, 22, count + 4), pos); @@ -1030,7 +1012,7 @@ e return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { while (count < 21) { @@ -1061,17 +1043,17 @@ e }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; win.Add (label); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Application.Begin (top); Application.Driver!.SetScreenSize (10, 4); - + Application.LayoutAndDraw (); Assert.Equal (5, text.Length); Assert.Equal (new (0, 0, 5, 1), label.Frame); Assert.Equal (new (5, 1), label.TextFormatter.ConstrainToSize); Assert.Equal (["Label"], label.TextFormatter.GetLines ()); Assert.Equal (new (0, 0, 10, 4), win.Frame); - Assert.Equal (new (0, 0, 10, 4), Application.Top.Frame); + Assert.Equal (new (0, 0, 10, 4), Application.TopRunnableView!.Frame); var expected = @" ┌────────┐ @@ -1120,17 +1102,17 @@ e }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; win.Add (label); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Application.Begin (top); Application.Driver!.SetScreenSize (10, 4); - + Application.LayoutAndDraw (); Assert.Equal (5, text.Length); Assert.Equal (new (0, 0, 5, 1), label.Frame); Assert.Equal (new (5, 1), label.TextFormatter.ConstrainToSize); Assert.Equal (["Label"], label.TextFormatter.GetLines ()); Assert.Equal (new (0, 0, 10, 4), win.Frame); - Assert.Equal (new (0, 0, 10, 4), Application.Top.Frame); + Assert.Equal (new (0, 0, 10, 4), Application.TopRunnableView!.Frame); var expected = @" ┌────────┐ @@ -1183,150 +1165,6 @@ e super.Dispose (); } - [Fact] - public void CanFocus_False_HotKey_SetsFocus_Next () - { - View otherView = new () - { - Text = "otherView", - CanFocus = true - }; - - Label label = new () - { - Text = "_label" - }; - - View nextView = new () - { - Text = "nextView", - CanFocus = true - }; - Application.Navigation = new (); - Application.Top = new (); - Application.Top.Add (otherView, label, nextView); - - Application.Top.SetFocus (); - Assert.True (otherView.HasFocus); - - Assert.True (Application.RaiseKeyDownEvent (label.HotKey)); - Assert.False (otherView.HasFocus); - Assert.False (label.HasFocus); - Assert.True (nextView.HasFocus); - - Application.Top.Dispose (); - Application.ResetState (); - } - - [Fact] - public void CanFocus_False_MouseClick_SetsFocus_Next () - { - View otherView = new () { X = 0, Y = 0, Width = 1, Height = 1, Id = "otherView", CanFocus = true }; - Label label = new () { X = 0, Y = 1, Text = "_label" }; - View nextView = new () { X = Pos.Right (label), Y = Pos.Top (label), Width = 1, Height = 1, Id = "nextView", CanFocus = true }; - Application.Navigation = new (); - Application.Top = new (); - Application.Top.Add (otherView, label, nextView); - Application.Top.Layout (); - - Application.Top.SetFocus (); - - // click on label - Application.RaiseMouseEvent (new () { ScreenPosition = label.Frame.Location, Flags = MouseFlags.Button1Clicked }); - Assert.False (label.HasFocus); - Assert.True (nextView.HasFocus); - - Application.Top.Dispose (); - Application.ResetState (); - } - - [Fact] - public void CanFocus_True_HotKey_SetsFocus () - { - Label label = new () - { - Text = "_label", - CanFocus = true - }; - - View view = new () - { - Text = "view", - CanFocus = true - }; - Application.Navigation = new (); - Application.Top = new (); - Application.Top.Add (label, view); - - view.SetFocus (); - Assert.True (label.CanFocus); - Assert.False (label.HasFocus); - Assert.True (view.CanFocus); - Assert.True (view.HasFocus); - - // No focused view accepts Tab, and there's no other view to focus, so OnKeyDown returns false - Assert.True (Application.RaiseKeyDownEvent (label.HotKey)); - Assert.True (label.HasFocus); - Assert.False (view.HasFocus); - - Application.Top.Dispose (); - Application.ResetState (); - } - - [Fact] - public void CanFocus_True_MouseClick_Focuses () - { - Application.Navigation = new (); - - Label label = new () - { - Text = "label", - X = 0, - Y = 0, - CanFocus = true - }; - - View otherView = new () - { - Text = "view", - X = 0, - Y = 1, - Width = 4, - Height = 1, - CanFocus = true - }; - - Application.Top = new () - { - Width = 10, - Height = 10 - }; - Application.Top.Add (label, otherView); - Application.Top.SetFocus (); - Application.Top.Layout (); - - Assert.True (label.CanFocus); - Assert.True (label.HasFocus); - Assert.True (otherView.CanFocus); - Assert.False (otherView.HasFocus); - - otherView.SetFocus (); - Assert.True (otherView.HasFocus); - - // label can focus, so clicking on it set focus - Application.RaiseMouseEvent (new () { ScreenPosition = new (0, 0), Flags = MouseFlags.Button1Clicked }); - Assert.True (label.HasFocus); - Assert.False (otherView.HasFocus); - - // click on view - Application.RaiseMouseEvent (new () { ScreenPosition = new (0, 1), Flags = MouseFlags.Button1Clicked }); - Assert.False (label.HasFocus); - Assert.True (otherView.HasFocus); - - Application.Top.Dispose (); - Application.ResetState (); - } - // https://github.com/gui-cs/Terminal.Gui/issues/3893 [Fact] [SetupFakeApplication] diff --git a/Tests/UnitTests/Views/ListViewTests.cs b/Tests/UnitTests/Views/ListViewTests.cs deleted file mode 100644 index d42827760..000000000 --- a/Tests/UnitTests/Views/ListViewTests.cs +++ /dev/null @@ -1,1225 +0,0 @@ -using System.Collections; -using System.Collections.ObjectModel; -using System.Collections.Specialized; -using Moq; -using UnitTests; -using Xunit.Abstractions; - -namespace UnitTests.ViewsTests; - -public class ListViewTests (ITestOutputHelper output) -{ - [Fact] - public void Constructors_Defaults () - { - var lv = new ListView (); - Assert.Null (lv.Source); - Assert.True (lv.CanFocus); - Assert.Equal (-1, lv.SelectedItem); - Assert.False (lv.AllowsMultipleSelection); - - lv = new () { Source = new ListWrapper (["One", "Two", "Three"]) }; - Assert.NotNull (lv.Source); - Assert.Equal (-1, lv.SelectedItem); - - lv = new () { Source = new NewListDataSource () }; - Assert.NotNull (lv.Source); - Assert.Equal (-1, lv.SelectedItem); - - lv = new () - { - Y = 1, Width = 10, Height = 20, Source = new ListWrapper (["One", "Two", "Three"]) - }; - Assert.NotNull (lv.Source); - Assert.Equal (-1, lv.SelectedItem); - Assert.Equal (new (0, 1, 10, 20), lv.Frame); - - lv = new () { Y = 1, Width = 10, Height = 20, Source = new NewListDataSource () }; - Assert.NotNull (lv.Source); - Assert.Equal (-1, lv.SelectedItem); - Assert.Equal (new (0, 1, 10, 20), lv.Frame); - - } - - [Fact] - [AutoInitShutdown] - public void Ensures_Visibility_SelectedItem_On_MoveDown_And_MoveUp () - { - ObservableCollection source = []; - - for (var i = 0; i < 20; i++) - { - source.Add ($"Line{i}"); - } - - var lv = new ListView { Width = Dim.Fill (), Height = Dim.Fill (), Source = new ListWrapper (source) }; - var win = new Window (); - win.Add (lv); - var top = new Toplevel (); - top.Add (win); - SessionToken rs = Application.Begin (top); - Application.Driver!.SetScreenSize (12, 12); - AutoInitShutdownAttribute.RunIteration (); - - Assert.Equal (-1, lv.SelectedItem); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────┐ -│Line0 │ -│Line1 │ -│Line2 │ -│Line3 │ -│Line4 │ -│Line5 │ -│Line6 │ -│Line7 │ -│Line8 │ -│Line9 │ -└──────────┘", - output - ); - - Assert.True (lv.ScrollVertical (10)); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (-1, lv.SelectedItem); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────┐ -│Line10 │ -│Line11 │ -│Line12 │ -│Line13 │ -│Line14 │ -│Line15 │ -│Line16 │ -│Line17 │ -│Line18 │ -│Line19 │ -└──────────┘", - output - ); - - Assert.True (lv.MoveDown ()); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (0, lv.SelectedItem); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────┐ -│Line0 │ -│Line1 │ -│Line2 │ -│Line3 │ -│Line4 │ -│Line5 │ -│Line6 │ -│Line7 │ -│Line8 │ -│Line9 │ -└──────────┘", - output - ); - - Assert.True (lv.MoveEnd ()); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (19, lv.SelectedItem); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────┐ -│Line10 │ -│Line11 │ -│Line12 │ -│Line13 │ -│Line14 │ -│Line15 │ -│Line16 │ -│Line17 │ -│Line18 │ -│Line19 │ -└──────────┘", - output - ); - - Assert.True (lv.ScrollVertical (-20)); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (19, lv.SelectedItem); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────┐ -│Line0 │ -│Line1 │ -│Line2 │ -│Line3 │ -│Line4 │ -│Line5 │ -│Line6 │ -│Line7 │ -│Line8 │ -│Line9 │ -└──────────┘", - output - ); - - Assert.True (lv.MoveDown ()); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (19, lv.SelectedItem); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────┐ -│Line10 │ -│Line11 │ -│Line12 │ -│Line13 │ -│Line14 │ -│Line15 │ -│Line16 │ -│Line17 │ -│Line18 │ -│Line19 │ -└──────────┘", - output - ); - - Assert.True (lv.ScrollVertical (-20)); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (19, lv.SelectedItem); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────┐ -│Line0 │ -│Line1 │ -│Line2 │ -│Line3 │ -│Line4 │ -│Line5 │ -│Line6 │ -│Line7 │ -│Line8 │ -│Line9 │ -└──────────┘", - output - ); - - Assert.True (lv.MoveDown ()); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (19, lv.SelectedItem); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────┐ -│Line10 │ -│Line11 │ -│Line12 │ -│Line13 │ -│Line14 │ -│Line15 │ -│Line16 │ -│Line17 │ -│Line18 │ -│Line19 │ -└──────────┘", - output - ); - - Assert.True (lv.MoveHome ()); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (0, lv.SelectedItem); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────┐ -│Line0 │ -│Line1 │ -│Line2 │ -│Line3 │ -│Line4 │ -│Line5 │ -│Line6 │ -│Line7 │ -│Line8 │ -│Line9 │ -└──────────┘", - output - ); - - Assert.True (lv.ScrollVertical (20)); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (0, lv.SelectedItem); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────┐ -│Line19 │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -└──────────┘", - output - ); - - Assert.True (lv.MoveUp ()); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (0, lv.SelectedItem); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────┐ -│Line0 │ -│Line1 │ -│Line2 │ -│Line3 │ -│Line4 │ -│Line5 │ -│Line6 │ -│Line7 │ -│Line8 │ -│Line9 │ -└──────────┘", - output - ); - top.Dispose (); - } - - [Fact] - [AutoInitShutdown] - public void EnsureSelectedItemVisible_SelectedItem () - { - ObservableCollection source = []; - - for (var i = 0; i < 10; i++) - { - source.Add ($"Item {i}"); - } - - var lv = new ListView { Width = 10, Height = 5, Source = new ListWrapper (source) }; - var top = new Toplevel (); - top.Add (lv); - Application.Begin (top); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -Item 0 -Item 1 -Item 2 -Item 3 -Item 4", - output - ); - - // EnsureSelectedItemVisible is auto enabled on the OnSelectedChanged - lv.SelectedItem = 6; - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -Item 2 -Item 3 -Item 4 -Item 5 -Item 6", - output - ); - top.Dispose (); - } - - [Fact] - [AutoInitShutdown] - public void EnsureSelectedItemVisible_Top () - { - ObservableCollection source = ["First", "Second"]; - var lv = new ListView { Width = Dim.Fill (), Height = 1, Source = new ListWrapper (source) }; - lv.SelectedItem = 1; - var top = new Toplevel (); - top.Add (lv); - Application.Begin (top); - AutoInitShutdownAttribute.RunIteration (); - - Assert.Equal ("Second ", GetContents (0)); - Assert.Equal (new (' ', 7), GetContents (1)); - - lv.MoveUp (); - lv.Draw (); - - Assert.Equal ("First ", GetContents (0)); - Assert.Equal (new (' ', 7), GetContents (1)); - - string GetContents (int line) - { - var item = ""; - - for (var i = 0; i < 7; i++) - { - item += Application.Driver?.Contents [line, i].Rune; - } - - return item; - } - top.Dispose (); - } - - [Fact] - public void KeyBindings_Command () - { - ObservableCollection source = ["One", "Two", "Three"]; - var lv = new ListView { Height = 2, AllowsMarking = true, Source = new ListWrapper (source) }; - lv.BeginInit (); - lv.EndInit (); - Assert.Equal (-1, lv.SelectedItem); - Assert.True (lv.NewKeyDownEvent (Key.CursorDown)); - Assert.Equal (0, lv.SelectedItem); - Assert.True (lv.NewKeyDownEvent (Key.CursorUp)); - Assert.Equal (0, lv.SelectedItem); - Assert.True (lv.NewKeyDownEvent (Key.PageDown)); - Assert.Equal (2, lv.SelectedItem); - Assert.Equal (2, lv.TopItem); - Assert.True (lv.NewKeyDownEvent (Key.PageUp)); - Assert.Equal (0, lv.SelectedItem); - Assert.Equal (0, lv.TopItem); - Assert.False (lv.Source.IsMarked (lv.SelectedItem)); - Assert.True (lv.NewKeyDownEvent (Key.Space)); - Assert.True (lv.Source.IsMarked (lv.SelectedItem)); - var opened = false; - lv.OpenSelectedItem += (s, _) => opened = true; - Assert.True (lv.NewKeyDownEvent (Key.Enter)); - Assert.True (opened); - Assert.True (lv.NewKeyDownEvent (Key.End)); - Assert.Equal (2, lv.SelectedItem); - Assert.True (lv.NewKeyDownEvent (Key.Home)); - Assert.Equal (0, lv.SelectedItem); - } - - [Fact] - public void HotKey_Command_SetsFocus () - { - var view = new ListView (); - - view.CanFocus = true; - Assert.False (view.HasFocus); - view.InvokeCommand (Command.HotKey); - Assert.True (view.HasFocus); - } - - [Fact] - public void HotKey_Command_Does_Not_Accept () - { - var listView = new ListView (); - var accepted = false; - - listView.Accepting += OnAccepted; - listView.InvokeCommand (Command.HotKey); - - Assert.False (accepted); - - return; - - void OnAccepted (object sender, CommandEventArgs e) { accepted = true; } - } - - [Fact] - public void Accept_Command_Accepts_and_Opens_Selected_Item () - { - ObservableCollection source = ["One", "Two", "Three"]; - var listView = new ListView { Source = new ListWrapper (source) }; - listView.SelectedItem = 0; - - var accepted = false; - var opened = false; - var selectedValue = string.Empty; - - listView.Accepting += Accepted; - listView.OpenSelectedItem += OpenSelectedItem; - - listView.InvokeCommand (Command.Accept); - - Assert.True (accepted); - Assert.True (opened); - Assert.Equal (source [0], selectedValue); - - return; - - void OpenSelectedItem (object sender, ListViewItemEventArgs e) - { - opened = true; - selectedValue = e.Value.ToString (); - } - - void Accepted (object sender, CommandEventArgs e) { accepted = true; } - } - - [Fact] - public void Accept_Cancel_Event_Prevents_OpenSelectedItem () - { - ObservableCollection source = ["One", "Two", "Three"]; - var listView = new ListView { Source = new ListWrapper (source) }; - listView.SelectedItem = 0; - - var accepted = false; - var opened = false; - var selectedValue = string.Empty; - - listView.Accepting += Accepted; - listView.OpenSelectedItem += OpenSelectedItem; - - listView.InvokeCommand (Command.Accept); - - Assert.True (accepted); - Assert.False (opened); - Assert.Equal (string.Empty, selectedValue); - - return; - - void OpenSelectedItem (object sender, ListViewItemEventArgs e) - { - opened = true; - selectedValue = e.Value.ToString (); - } - - void Accepted (object sender, CommandEventArgs e) - { - accepted = true; - e.Handled = true; - } - } - - /// - /// Tests that when none of the Commands in a chained keybinding are possible the - /// returns the appropriate result - /// - [Fact] - public void ListViewProcessKeyReturnValue_WithMultipleCommands () - { - var lv = new ListView { Source = new ListWrapper (["One", "Two", "Three", "Four"]) }; - - Assert.NotNull (lv.Source); - - // first item should be deselected by default - Assert.Equal (-1, lv.SelectedItem); - - // bind shift down to move down twice in control - lv.KeyBindings.Add (Key.CursorDown.WithShift, Command.Down, Command.Down); - - Key ev = Key.CursorDown.WithShift; - - Assert.True (lv.NewKeyDownEvent (ev), "The first time we move down 2 it should be possible"); - - // After moving down twice from -1 we should be at 'Two' - Assert.Equal (1, lv.SelectedItem); - - // clear the items - lv.SetSource (null); - - // Press key combo again - return should be false this time as none of the Commands are allowable - Assert.False (lv.NewKeyDownEvent (ev), "We cannot move down so will not respond to this"); - } - - [Fact] - public void AllowsMarking_True_SpaceWithShift_SelectsThenDown_SingleSelection () - { - var lv = new ListView { Source = new ListWrapper (["One", "Two", "Three"]) }; - lv.AllowsMarking = true; - lv.AllowsMultipleSelection = false; - - Assert.NotNull (lv.Source); - - // first item should be deselected by default - Assert.Equal (-1, lv.SelectedItem); - - // nothing is ticked - Assert.False (lv.Source.IsMarked (0)); - Assert.False (lv.Source.IsMarked (1)); - Assert.False (lv.Source.IsMarked (2)); - - // view should indicate that it has accepted and consumed the event - Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); - - // first item should now be selected - Assert.Equal (0, lv.SelectedItem); - - // none of the items should be ticked - Assert.False (lv.Source.IsMarked (0)); - Assert.False (lv.Source.IsMarked (1)); - Assert.False (lv.Source.IsMarked (2)); - - // Press key combo again - Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); - - // second item should now be selected - Assert.Equal (1, lv.SelectedItem); - - // first item only should be ticked - Assert.True (lv.Source.IsMarked (0)); - Assert.False (lv.Source.IsMarked (1)); - Assert.False (lv.Source.IsMarked (2)); - - // Press key combo again - Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); - Assert.Equal (2, lv.SelectedItem); - Assert.False (lv.Source.IsMarked (0)); - Assert.True (lv.Source.IsMarked (1)); - Assert.False (lv.Source.IsMarked (2)); - - // Press key combo again - Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); - Assert.Equal (2, lv.SelectedItem); // cannot move down any further - Assert.False (lv.Source.IsMarked (0)); - Assert.False (lv.Source.IsMarked (1)); - Assert.True (lv.Source.IsMarked (2)); // but can toggle marked - - // Press key combo again - Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); - Assert.Equal (2, lv.SelectedItem); // cannot move down any further - Assert.False (lv.Source.IsMarked (0)); - Assert.False (lv.Source.IsMarked (1)); - Assert.False (lv.Source.IsMarked (2)); // untoggle toggle marked - } - - [Fact] - public void AllowsMarking_True_SpaceWithShift_SelectsThenDown_MultipleSelection () - { - var lv = new ListView { Source = new ListWrapper (["One", "Two", "Three"]) }; - lv.AllowsMarking = true; - lv.AllowsMultipleSelection = true; - - Assert.NotNull (lv.Source); - - // first item should be deselected by default - Assert.Equal (-1, lv.SelectedItem); - - // nothing is ticked - Assert.False (lv.Source.IsMarked (0)); - Assert.False (lv.Source.IsMarked (1)); - Assert.False (lv.Source.IsMarked (2)); - - // view should indicate that it has accepted and consumed the event - Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); - - // first item should now be selected - Assert.Equal (0, lv.SelectedItem); - - // none of the items should be ticked - Assert.False (lv.Source.IsMarked (0)); - Assert.False (lv.Source.IsMarked (1)); - Assert.False (lv.Source.IsMarked (2)); - - // Press key combo again - Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); - - // second item should now be selected - Assert.Equal (1, lv.SelectedItem); - - // first item only should be ticked - Assert.True (lv.Source.IsMarked (0)); - Assert.False (lv.Source.IsMarked (1)); - Assert.False (lv.Source.IsMarked (2)); - - // Press key combo again - Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); - Assert.Equal (2, lv.SelectedItem); - Assert.True (lv.Source.IsMarked (0)); - Assert.True (lv.Source.IsMarked (1)); - Assert.False (lv.Source.IsMarked (2)); - - // Press key combo again - Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); - Assert.Equal (2, lv.SelectedItem); // cannot move down any further - Assert.True (lv.Source.IsMarked (0)); - Assert.True (lv.Source.IsMarked (1)); - Assert.True (lv.Source.IsMarked (2)); // but can toggle marked - - // Press key combo again - Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); - Assert.Equal (2, lv.SelectedItem); // cannot move down any further - Assert.True (lv.Source.IsMarked (0)); - Assert.True (lv.Source.IsMarked (1)); - Assert.False (lv.Source.IsMarked (2)); // untoggle toggle marked - } - - [Fact] - public void ListWrapper_StartsWith () - { - var lw = new ListWrapper (["One", "Two", "Three"]); - - Assert.Equal (1, lw.StartsWith ("t")); - Assert.Equal (1, lw.StartsWith ("tw")); - Assert.Equal (2, lw.StartsWith ("th")); - Assert.Equal (1, lw.StartsWith ("T")); - Assert.Equal (1, lw.StartsWith ("TW")); - Assert.Equal (2, lw.StartsWith ("TH")); - - lw = new (["One", "Two", "Three"]); - - Assert.Equal (1, lw.StartsWith ("t")); - Assert.Equal (1, lw.StartsWith ("tw")); - Assert.Equal (2, lw.StartsWith ("th")); - Assert.Equal (1, lw.StartsWith ("T")); - Assert.Equal (1, lw.StartsWith ("TW")); - Assert.Equal (2, lw.StartsWith ("TH")); - } - - [Fact] - public void OnEnter_Does_Not_Throw_Exception () - { - var lv = new ListView (); - var top = new View (); - top.Add (lv); - Exception exception = Record.Exception (() => lv.SetFocus ()); - Assert.Null (exception); - } - - [Fact] - [AutoInitShutdown] - public void RowRender_Event () - { - var rendered = false; - ObservableCollection source = ["one", "two", "three"]; - var lv = new ListView { Width = Dim.Fill (), Height = Dim.Fill () }; - lv.RowRender += (s, _) => rendered = true; - var top = new Toplevel (); - top.Add (lv); - Application.Begin (top); - Assert.False (rendered); - - lv.SetSource (source); - lv.Draw (); - Assert.True (rendered); - top.Dispose (); - } - - [Fact] - public void SelectedItem_Get_Set () - { - var lv = new ListView { Source = new ListWrapper (["One", "Two", "Three"]) }; - Assert.Equal (-1, lv.SelectedItem); - Assert.Throws (() => lv.SelectedItem = 3); - Exception exception = Record.Exception (() => lv.SelectedItem = -1); - Assert.Null (exception); - } - - [Fact] - public void SetSource_Preserves_ListWrapper_Instance_If_Not_Null () - { - var lv = new ListView { Source = new ListWrapper (["One", "Two"]) }; - - Assert.NotNull (lv.Source); - - lv.SetSource (null); - Assert.NotNull (lv.Source); - - lv.Source = null; - Assert.Null (lv.Source); - - lv = new () { Source = new ListWrapper (["One", "Two"]) }; - Assert.NotNull (lv.Source); - - lv.SetSourceAsync (null); - Assert.NotNull (lv.Source); - } - - [Fact] - public void SettingEmptyKeybindingThrows () - { - var lv = new ListView { Source = new ListWrapper (["One", "Two", "Three"]) }; - Assert.Throws (() => lv.KeyBindings.Add (Key.Space)); - } - - private class NewListDataSource : IListDataSource - { -#pragma warning disable CS0067 - /// - public event NotifyCollectionChangedEventHandler CollectionChanged; -#pragma warning restore CS0067 - - public int Count => 0; - public int Length => 0; - - public bool SuspendCollectionChangedEvent { get => throw new NotImplementedException (); set => throw new NotImplementedException (); } - - public bool IsMarked (int item) { throw new NotImplementedException (); } - - public void Render ( - ListView container, - bool selected, - int item, - int col, - int line, - int width, - int start = 0 - ) - { - throw new NotImplementedException (); - } - - public void SetMark (int item, bool value) { throw new NotImplementedException (); } - public IList ToList () { return new List { "One", "Two", "Three" }; } - - public void Dispose () - { - throw new NotImplementedException (); - } - } - - [Fact] - [AutoInitShutdown] - public void Clicking_On_Border_Is_Ignored () - { - var selected = ""; - - var lv = new ListView - { - Height = 5, - Width = 7, - BorderStyle = LineStyle.Single - }; - lv.SetSource (["One", "Two", "Three", "Four"]); - lv.SelectedItemChanged += (s, e) => selected = e.Value.ToString (); - var top = new Toplevel (); - top.Add (lv); - Application.Begin (top); - AutoInitShutdownAttribute.RunIteration (); - - Assert.Equal (new (1), lv.Border!.Thickness); - Assert.Equal (-1, lv.SelectedItem); - Assert.Equal ("", lv.Text); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌─────┐ -│One │ -│Two │ -│Three│ -└─────┘", - output); - - Application.RaiseMouseEvent (new () { ScreenPosition = new (0, 0), Flags = MouseFlags.Button1Clicked }); - Assert.Equal ("", selected); - Assert.Equal (-1, lv.SelectedItem); - - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (1, 1), Flags = MouseFlags.Button1Clicked - }); - Assert.Equal ("One", selected); - Assert.Equal (0, lv.SelectedItem); - - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (1, 2), Flags = MouseFlags.Button1Clicked - }); - Assert.Equal ("Two", selected); - Assert.Equal (1, lv.SelectedItem); - - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (1, 3), Flags = MouseFlags.Button1Clicked - }); - Assert.Equal ("Three", selected); - Assert.Equal (2, lv.SelectedItem); - - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (1, 4), Flags = MouseFlags.Button1Clicked - }); - Assert.Equal ("Three", selected); - Assert.Equal (2, lv.SelectedItem); - top.Dispose (); - } - - [Fact] - [AutoInitShutdown] - public void LeftItem_TopItem_Tests () - { - ObservableCollection source = []; - - for (int i = 0; i < 5; i++) - { - source.Add ($"Item {i}"); - } - - var lv = new ListView - { - X = 1, - Source = new ListWrapper (source) - }; - lv.Height = lv.Source.Count; - lv.Width = lv.MaxLength; - var top = new Toplevel (); - top.Add (lv); - Application.Begin (top); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - Item 0 - Item 1 - Item 2 - Item 3 - Item 4", - output); - - lv.LeftItem = 1; - lv.TopItem = 1; - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - tem 1 - tem 2 - tem 3 - tem 4", - output); - top.Dispose (); - } - - [Fact] - public void CollectionChanged_Event () - { - var added = 0; - var removed = 0; - ObservableCollection source = []; - var lv = new ListView { Source = new ListWrapper (source) }; - - lv.CollectionChanged += (sender, args) => - { - if (args.Action == NotifyCollectionChangedAction.Add) - { - added++; - } - else if (args.Action == NotifyCollectionChangedAction.Remove) - { - removed++; - } - }; - - for (int i = 0; i < 3; i++) - { - source.Add ($"Item{i}"); - } - Assert.Equal (3, added); - Assert.Equal (0, removed); - - added = 0; - - for (int i = 0; i < 3; i++) - { - source.Remove (source [0]); - } - Assert.Equal (0, added); - Assert.Equal (3, removed); - Assert.Empty (source); - } - - [Fact] - public void CollectionChanged_Event_Is_Only_Subscribed_Once () - { - var added = 0; - var removed = 0; - var otherActions = 0; - IList source1 = []; - var lv = new ListView { Source = new ListWrapper (new (source1)) }; - - lv.CollectionChanged += (sender, args) => - { - if (args.Action == NotifyCollectionChangedAction.Add) - { - added++; - } - else if (args.Action == NotifyCollectionChangedAction.Remove) - { - removed++; - } - else - { - otherActions++; - } - }; - - ObservableCollection source2 = []; - lv.Source = new ListWrapper (source2); - ObservableCollection source3 = []; - lv.Source = new ListWrapper (source3); - Assert.Equal (0, added); - Assert.Equal (0, removed); - Assert.Equal (0, otherActions); - - for (int i = 0; i < 3; i++) - { - source1.Add ($"Item{i}"); - source2.Add ($"Item{i}"); - source3.Add ($"Item{i}"); - } - Assert.Equal (3, added); - Assert.Equal (0, removed); - Assert.Equal (0, otherActions); - - added = 0; - - for (int i = 0; i < 3; i++) - { - source1.Remove (source1 [0]); - source2.Remove (source2 [0]); - source3.Remove (source3 [0]); - } - Assert.Equal (0, added); - Assert.Equal (3, removed); - Assert.Equal (0, otherActions); - Assert.Empty (source1); - Assert.Empty (source2); - Assert.Empty (source3); - } - - [Fact] - public void CollectionChanged_Event_UnSubscribe_Previous_If_New_Is_Null () - { - var added = 0; - var removed = 0; - var otherActions = 0; - ObservableCollection source1 = []; - var lv = new ListView { Source = new ListWrapper (source1) }; - - lv.CollectionChanged += (sender, args) => - { - if (args.Action == NotifyCollectionChangedAction.Add) - { - added++; - } - else if (args.Action == NotifyCollectionChangedAction.Remove) - { - removed++; - } - else - { - otherActions++; - } - }; - - lv.Source = new ListWrapper (null); - Assert.Equal (0, added); - Assert.Equal (0, removed); - Assert.Equal (0, otherActions); - - for (int i = 0; i < 3; i++) - { - source1.Add ($"Item{i}"); - } - Assert.Equal (0, added); - Assert.Equal (0, removed); - Assert.Equal (0, otherActions); - - for (int i = 0; i < 3; i++) - { - source1.Remove (source1 [0]); - } - Assert.Equal (0, added); - Assert.Equal (0, removed); - Assert.Equal (0, otherActions); - Assert.Empty (source1); - } - - [Fact] - public void ListWrapper_CollectionChanged_Event_Is_Only_Subscribed_Once () - { - var added = 0; - var removed = 0; - var otherActions = 0; - ObservableCollection source1 = []; - ListWrapper lw = new (source1); - - lw.CollectionChanged += (sender, args) => - { - if (args.Action == NotifyCollectionChangedAction.Add) - { - added++; - } - else if (args.Action == NotifyCollectionChangedAction.Remove) - { - removed++; - } - else - { - otherActions++; - } - }; - - ObservableCollection source2 = []; - lw = new (source2); - ObservableCollection source3 = []; - lw = new (source3); - Assert.Equal (0, added); - Assert.Equal (0, removed); - Assert.Equal (0, otherActions); - - for (int i = 0; i < 3; i++) - { - source1.Add ($"Item{i}"); - source2.Add ($"Item{i}"); - source3.Add ($"Item{i}"); - } - - Assert.Equal (3, added); - Assert.Equal (0, removed); - Assert.Equal (0, otherActions); - - added = 0; - - for (int i = 0; i < 3; i++) - { - source1.Remove (source1 [0]); - source2.Remove (source2 [0]); - source3.Remove (source3 [0]); - } - Assert.Equal (0, added); - Assert.Equal (3, removed); - Assert.Equal (0, otherActions); - Assert.Empty (source1); - Assert.Empty (source2); - Assert.Empty (source3); - } - - [Fact] - public void ListWrapper_CollectionChanged_Event_UnSubscribe_Previous_Is_Disposed () - { - var added = 0; - var removed = 0; - var otherActions = 0; - ObservableCollection source1 = []; - ListWrapper lw = new (source1); - - lw.CollectionChanged += Lw_CollectionChanged; - - lw.Dispose (); - lw = new (null); - Assert.Equal (0, lw.Count); - Assert.Equal (0, added); - Assert.Equal (0, removed); - Assert.Equal (0, otherActions); - - for (int i = 0; i < 3; i++) - { - source1.Add ($"Item{i}"); - } - Assert.Equal (0, added); - Assert.Equal (0, removed); - Assert.Equal (0, otherActions); - - for (int i = 0; i < 3; i++) - { - source1.Remove (source1 [0]); - } - Assert.Equal (0, added); - Assert.Equal (0, removed); - Assert.Equal (0, otherActions); - Assert.Empty (source1); - - - void Lw_CollectionChanged (object sender, NotifyCollectionChangedEventArgs e) - { - if (e.Action == NotifyCollectionChangedAction.Add) - { - added++; - } - else if (e.Action == NotifyCollectionChangedAction.Remove) - { - removed++; - } - else - { - otherActions++; - } - } - } - - [Fact] - public void ListWrapper_SuspendCollectionChangedEvent_ResumeSuspendCollectionChangedEvent_Tests () - { - var added = 0; - ObservableCollection source = []; - ListWrapper lw = new (source); - - lw.CollectionChanged += Lw_CollectionChanged; - - lw.SuspendCollectionChangedEvent = true; - - for (int i = 0; i < 3; i++) - { - source.Add ($"Item{i}"); - } - Assert.Equal (0, added); - Assert.Equal (3, lw.Count); - Assert.Equal (3, source.Count); - - lw.SuspendCollectionChangedEvent = false; - - for (int i = 3; i < 6; i++) - { - source.Add ($"Item{i}"); - } - Assert.Equal (3, added); - Assert.Equal (6, lw.Count); - Assert.Equal (6, source.Count); - - - void Lw_CollectionChanged (object sender, NotifyCollectionChangedEventArgs e) - { - if (e.Action == NotifyCollectionChangedAction.Add) - { - added++; - } - } - } - - [Fact] - public void ListView_SuspendCollectionChangedEvent_ResumeSuspendCollectionChangedEvent_Tests () - { - var added = 0; - ObservableCollection source = []; - ListView lv = new ListView { Source = new ListWrapper (source) }; - - lv.CollectionChanged += Lw_CollectionChanged; - - lv.SuspendCollectionChangedEvent (); - - for (int i = 0; i < 3; i++) - { - source.Add ($"Item{i}"); - } - Assert.Equal (0, added); - Assert.Equal (3, lv.Source.Count); - Assert.Equal (3, source.Count); - - lv.ResumeSuspendCollectionChangedEvent (); - - for (int i = 3; i < 6; i++) - { - source.Add ($"Item{i}"); - } - Assert.Equal (3, added); - Assert.Equal (6, lv.Source.Count); - Assert.Equal (6, source.Count); - - - void Lw_CollectionChanged (object sender, NotifyCollectionChangedEventArgs e) - { - if (e.Action == NotifyCollectionChangedAction.Add) - { - added++; - } - } - } -} \ No newline at end of file diff --git a/Tests/UnitTests/Views/MenuBarTests.cs b/Tests/UnitTests/Views/MenuBarTests.cs index 8ad5f05eb..9657a3b44 100644 --- a/Tests/UnitTests/Views/MenuBarTests.cs +++ b/Tests/UnitTests/Views/MenuBarTests.cs @@ -10,23 +10,38 @@ public class MenuBarTests () public void DefaultKey_Activates_And_Opens () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var top = new Runnable () + { + App = ApplicationImpl.Instance + }; + + var menuBar = new MenuBar () { Id = "menuBar" }; + top.Add (menuBar); + + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); + + menuBar.Add (menuBarItem); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; - menuBar.Add (menuBarItem); + + + Assert.NotNull (menuBar.App); + Assert.NotNull (menu.App); + Assert.NotNull (menuItem.App); + Assert.NotNull (menuBarItem); + Assert.NotNull (menuBarItemPopover); + Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); - top.Add (menuBar); + SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); // Act - Application.RaiseKeyDownEvent (MenuBarv2.DefaultKey); + Application.RaiseKeyDownEvent (MenuBar.DefaultKey); Assert.True (menuBar.Active); Assert.True (menuBar.IsOpen ()); Assert.True (menuBar.HasFocus); @@ -43,33 +58,23 @@ public class MenuBarTests () public void DefaultKey_Deactivates () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; - var menuBarItemPopover = new PopoverMenu (); - menuBarItem.PopoverMenu = menuBarItemPopover; - menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; - menuBar.Add (menuBarItem); - Assert.Single (menuBar.SubViews); - Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable () { App = ApplicationImpl.Instance }; + MenuBar menuBar = new MenuBar () { App = ApplicationImpl.Instance }; + menuBar.EnableForDesign (ref top); + top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); // Act - Application.RaiseKeyDownEvent (MenuBarv2.DefaultKey); + Application.RaiseKeyDownEvent (MenuBar.DefaultKey); Assert.True (menuBar.IsOpen ()); - Assert.True (menuBarItem.PopoverMenu.Visible); - Application.RaiseKeyDownEvent (MenuBarv2.DefaultKey); + Application.RaiseKeyDownEvent (MenuBar.DefaultKey); Assert.False (menuBar.Active); Assert.False (menuBar.IsOpen ()); Assert.False (menuBar.HasFocus); Assert.False (menuBar.CanFocus); - Assert.False (menuBarItem.PopoverMenu.Visible); - Assert.False (menuBarItem.PopoverMenu.HasFocus); Application.End (rs); top.Dispose (); @@ -80,21 +85,21 @@ public class MenuBarTests () public void QuitKey_Deactivates () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "Menu_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_MenuBarItem" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "Menu_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_MenuBarItem" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); - Application.RaiseKeyDownEvent (MenuBarv2.DefaultKey); + Application.RaiseKeyDownEvent (MenuBar.DefaultKey); Assert.True (menuBar.Active); Assert.True (menuBar.IsOpen ()); Assert.True (menuBarItem.PopoverMenu.Visible); @@ -118,17 +123,17 @@ public class MenuBarTests () public void MenuBarItem_HotKey_Activates_And_Opens () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -150,17 +155,17 @@ public class MenuBarTests () public void MenuBarItem_HotKey_Deactivates () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -189,17 +194,17 @@ public class MenuBarTests () { // Arrange int action = 0; - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "Menu_Item", Action = () => action++ }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_MenuBarItem" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "Menu_Item", Action = () => action++ }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_MenuBarItem" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -222,17 +227,17 @@ public class MenuBarTests () public void MenuItems_HotKey_Deactivates () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "Menu_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_MenuBarItem" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "Menu_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_MenuBarItem" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -259,17 +264,17 @@ public class MenuBarTests () public void HotKey_Makes_PopoverMenu_Visible_Only_Once () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -296,25 +301,25 @@ public class MenuBarTests () public void WhenOpen_Other_MenuBarItem_HotKey_Activates_And_Opens () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuItem2 = new MenuItemv2 { Id = "menuItem2", Title = "_Copy" }; - var menu2 = new Menuv2 ([menuItem2]) { Id = "menu2" }; - var menuBarItem2 = new MenuBarItemv2 () { Id = "menuBarItem2", Title = "_Edit" }; + var menuItem2 = new MenuItem { Id = "menuItem2", Title = "_Copy" }; + var menu2 = new Menu ([menuItem2]) { Id = "menu2" }; + var menuBarItem2 = new MenuBarItem () { Id = "menuBarItem2", Title = "_Edit" }; var menuBarItemPopover2 = new PopoverMenu () { Id = "menuBarItemPopover2" }; menuBarItem2.PopoverMenu = menuBarItemPopover2; menuBarItemPopover2.Root = menu2; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); menuBar.Add (menuBarItem2); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -341,17 +346,17 @@ public class MenuBarTests () public void Mouse_Enter_Activates_But_Does_Not_Open () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -377,17 +382,10 @@ public class MenuBarTests () public void Mouse_Click_Activates_And_Opens () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; - var menuBarItemPopover = new PopoverMenu (); - menuBarItem.PopoverMenu = menuBarItemPopover; - menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; - menuBar.Add (menuBarItem); - Assert.Single (menuBar.SubViews); - Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable () { App = ApplicationImpl.Instance }; + MenuBar menuBar = new MenuBar () { App = ApplicationImpl.Instance }; + menuBar.EnableForDesign (ref top); + top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -401,8 +399,6 @@ public class MenuBarTests () Assert.True (menuBar.IsOpen ()); Assert.True (menuBar.HasFocus); Assert.True (menuBar.CanFocus); - Assert.True (menuBarItem.PopoverMenu.Visible); - Assert.True (menuBarItem.PopoverMenu.HasFocus); Application.End (rs); top.Dispose (); @@ -418,17 +414,17 @@ public class MenuBarTests () { // Arrange // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -465,17 +461,17 @@ public class MenuBarTests () { // Arrange int action = 0; - var menuItem = new MenuItemv2 { Title = "_Item", Action = () => action++ }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Title = "_New" }; + var menuItem = new MenuItem { Title = "_Item", Action = () => action++ }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 (); + var menuBar = new MenuBar (); menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); @@ -483,7 +479,7 @@ public class MenuBarTests () Application.RaiseKeyDownEvent (Key.N.WithAlt); Assert.Equal (0, action); - Assert.Equal(Key.I, menuItem.HotKey); + Assert.Equal (Key.I, menuItem.HotKey); Application.RaiseKeyDownEvent (Key.I); Assert.Equal (1, action); Assert.False (menuBar.Active); @@ -507,17 +503,17 @@ public class MenuBarTests () public void Disabled_MenuBar_Is_Not_Activated () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -538,17 +534,17 @@ public class MenuBarTests () public void MenuBarItem_Disabled_MenuBarItem_HotKey_No_Activate_Or_Open () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -570,17 +566,17 @@ public class MenuBarTests () public void MenuBarItem_Disabled_Popover_Is_Activated () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -608,17 +604,17 @@ public class MenuBarTests () public void Update_MenuBarItem_HotKey_Works () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -657,17 +653,17 @@ public class MenuBarTests () public void Visible_False_HotKey_Does_Not_Activate () { // Arrange - var menuItem = new MenuItemv2 { Id = "menuItem", Title = "_Item" }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menuItem = new MenuItem { Id = "menuItem", Title = "_Item" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); @@ -692,23 +688,23 @@ public class MenuBarTests () { // Arrange int action = 0; - var menuItem = new MenuItemv2 () + var menuItem = new MenuItem () { Id = "menuItem", Title = "_Item", Key = Key.F1, Action = () => action++ }; - var menu = new Menuv2 ([menuItem]) { Id = "menu" }; - var menuBarItem = new MenuBarItemv2 { Id = "menuBarItem", Title = "_New" }; + var menu = new Menu ([menuItem]) { Id = "menu" }; + var menuBarItem = new MenuBarItem { Id = "menuBarItem", Title = "_New" }; var menuBarItemPopover = new PopoverMenu (); menuBarItem.PopoverMenu = menuBarItemPopover; menuBarItemPopover.Root = menu; - var menuBar = new MenuBarv2 () { Id = "menuBar" }; + var menuBar = new MenuBar () { Id = "menuBar" }; menuBar.Add (menuBarItem); Assert.Single (menuBar.SubViews); Assert.Single (menuBarItem.SubViews); - var top = new Toplevel (); + var top = new Runnable (); top.Add (menuBar); SessionToken rs = Application.Begin (top); Assert.False (menuBar.Active); diff --git a/Tests/UnitTests/Views/Menuv1/MenuBarv1Tests.cs b/Tests/UnitTests/Views/Menuv1/MenuBarv1Tests.cs deleted file mode 100644 index 31ec42bde..000000000 --- a/Tests/UnitTests/Views/Menuv1/MenuBarv1Tests.cs +++ /dev/null @@ -1,3410 +0,0 @@ -using UnitTests; -using Xunit.Abstractions; - -namespace UnitTests.ViewsTests; - -#pragma warning disable CS0618 // Type or member is obsolete -public class MenuBarv1Tests (ITestOutputHelper output) -{ - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void AddMenuBarItem_RemoveMenuItem_Dynamically () - { - var menuBar = new MenuBar (); - var menuBarItem = new MenuBarItem { Title = "_New" }; - var action = ""; - var menuItem = new MenuItem { Title = "_Item", Action = () => action = "I", Parent = menuBarItem }; - Assert.Equal ("n", menuBarItem.HotKey); - Assert.Equal ("i", menuItem.HotKey); - Assert.Empty (menuBar.Menus); - menuBarItem.AddMenuBarItem (menuBar, menuItem); - menuBar.Menus = [menuBarItem]; - Assert.Single (menuBar.Menus); - Assert.Single (menuBar.Menus [0].Children!); - - Assert.True (menuBar.HotKeyBindings.TryGet (Key.N.WithAlt, out _)); - Assert.False (menuBar.HotKeyBindings.TryGet (Key.I, out _)); - - var top = new Toplevel (); - top.Add (menuBar); - Application.Begin (top); - - top.NewKeyDownEvent (Key.N.WithAlt); - AutoInitShutdownAttribute.RunIteration (); - - Assert.True (menuBar.IsMenuOpen); - Assert.Equal ("", action); - - top.NewKeyDownEvent (Key.I); - AutoInitShutdownAttribute.RunIteration (); - - Assert.False (menuBar.IsMenuOpen); - Assert.Equal ("I", action); - - menuItem.RemoveMenuItem (); - Assert.Single (menuBar.Menus); - Assert.Null (menuBar.Menus [0].Children); - Assert.True (menuBar.HotKeyBindings.TryGet (Key.N.WithAlt, out _)); - Assert.False (menuBar.HotKeyBindings.TryGet (Key.I, out _)); - - menuBarItem.RemoveMenuItem (); - Assert.Empty (menuBar.Menus); - Assert.False (menuBar.HotKeyBindings.TryGet (Key.N.WithAlt, out _)); - - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void AllowNullChecked_Get_Set () - { - var mi = new MenuItem ("Check this out 你", "", null) { CheckType = MenuItemCheckStyle.Checked }; - mi.Action = mi.ToggleChecked; - - var menu = new MenuBar - { - Menus = - [ - new ("Nullable Checked", new [] { mi }) - ] - }; - - //new CheckBox (); - Toplevel top = new (); - top.Add (menu); - Application.Begin (top); - - Assert.False (mi.Checked); - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu._openMenu.NewKeyDownEvent (Key.Enter)); - AutoInitShutdownAttribute.RunIteration (); - Assert.True (mi.Checked); - - Assert.True ( - menu.NewMouseEvent ( - new () { Position = new (0, 0), Flags = MouseFlags.Button1Pressed, View = menu } - ) - ); - - Assert.True ( - menu._openMenu.NewMouseEvent ( - new () { Position = new (0, 0), Flags = MouseFlags.Button1Clicked, View = menu._openMenu } - ) - ); - AutoInitShutdownAttribute.RunIteration (); - Assert.False (mi.Checked); - - mi.AllowNullChecked = true; - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu._openMenu.NewKeyDownEvent (Key.Enter)); - AutoInitShutdownAttribute.RunIteration (); - Assert.Null (mi.Checked); - - Assert.True ( - menu.NewMouseEvent ( - new () { Position = new (0, 0), Flags = MouseFlags.Button1Pressed, View = menu } - ) - ); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @$" - Nullable Checked -┌──────────────────────┐ -│ {Glyphs.CheckStateNone} Check this out 你 │ -└──────────────────────┘", - output - ); - - Assert.True ( - menu._openMenu.NewMouseEvent ( - new () { Position = new (0, 0), Flags = MouseFlags.Button1Clicked, View = menu._openMenu } - ) - ); - AutoInitShutdownAttribute.RunIteration (); - Assert.True (mi.Checked); - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu._openMenu.NewKeyDownEvent (Key.Enter)); - AutoInitShutdownAttribute.RunIteration (); - Assert.False (mi.Checked); - - Assert.True ( - menu.NewMouseEvent ( - new () { Position = new (0, 0), Flags = MouseFlags.Button1Pressed, View = menu } - ) - ); - - Assert.True ( - menu._openMenu.NewMouseEvent ( - new () { Position = new (0, 0), Flags = MouseFlags.Button1Clicked, View = menu._openMenu } - ) - ); - AutoInitShutdownAttribute.RunIteration (); - Assert.Null (mi.Checked); - - mi.AllowNullChecked = false; - Assert.False (mi.Checked); - - mi.CheckType = MenuItemCheckStyle.NoCheck; - Assert.Throws (mi.ToggleChecked); - - mi.CheckType = MenuItemCheckStyle.Radio; - Assert.Throws (mi.ToggleChecked); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void CanExecute_False_Does_Not_Throws () - { - var menu = new MenuBar - { - Menus = - [ - new ("File", new MenuItem [] - { - new ("New", "", null, () => false), - null, - new ("Quit", "", null) - }) - ] - }; - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu.IsMenuOpen); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void CanExecute_HotKey () - { - Window win = null; - - var menu = new MenuBar - { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new ("_New", "", New, CanExecuteNew), - new ( - "_Close", - "", - Close, - CanExecuteClose - ) - } - ) - ] - }; - Toplevel top = new (); - top.Add (menu); - - bool CanExecuteNew () { return win == null; } - - void New () { win = new (); } - - bool CanExecuteClose () { return win != null; } - - void Close () { win = null; } - - Application.Begin (top); - - Assert.Null (win); - Assert.True (CanExecuteNew ()); - Assert.False (CanExecuteClose ()); - - Assert.True (top.NewKeyDownEvent (Key.F.WithAlt)); - Assert.True (top.NewKeyDownEvent (Key.N.WithAlt)); - AutoInitShutdownAttribute.RunIteration (); - Assert.NotNull (win); - Assert.False (CanExecuteNew ()); - Assert.True (CanExecuteClose ()); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void Click_Another_View_Close_An_Open_Menu () - { - var menu = new MenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }) - ] - }; - - var btnClicked = false; - var btn = new Button { Y = 4, Text = "Test" }; - btn.Accepting += (s, e) => btnClicked = true; - var top = new Toplevel (); - top.Add (menu, btn); - Application.Begin (top); - - Application.RaiseMouseEvent (new () { ScreenPosition = new (0, 4), Flags = MouseFlags.Button1Clicked }); - Assert.True (btnClicked); - top.Dispose (); - } - - // TODO: Lots of tests in here really test Menu and MenuItem - Move them to MenuTests.cs - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - public void Constructors_Defaults () - { - var menuBar = new MenuBar (); - Assert.Equal (KeyCode.F9, menuBar.Key); - var menu = new Menu { Host = menuBar, X = 0, Y = 0, BarItems = new () }; - Assert.False (menu.HasScheme); - Assert.False (menu.IsInitialized); - menu.BeginInit (); - menu.EndInit (); - Assert.True (menu.CanFocus); - Assert.False (menu.WantContinuousButtonPressed); - Assert.Equal (LineStyle.Single, menuBar.MenusBorderStyle); - - menuBar = new (); - Assert.Equal (0, menuBar.X); - Assert.Equal (0, menuBar.Y); - Assert.IsType (menuBar.Width); - Assert.Equal (1, menuBar.Height); - Assert.Empty (menuBar.Menus); - Assert.True (menuBar.WantMousePositionReports); - Assert.False (menuBar.IsMenuOpen); - - menuBar = new () { Menus = [] }; - Assert.Equal (0, menuBar.X); - Assert.Equal (0, menuBar.Y); - Assert.IsType (menuBar.Width); - Assert.Equal (1, menuBar.Height); - Assert.Empty (menuBar.Menus); - Assert.True (menuBar.WantMousePositionReports); - Assert.False (menuBar.IsMenuOpen); - - var menuBarItem = new MenuBarItem (); - Assert.Equal ("", menuBarItem.Title); - Assert.Null (menuBarItem.Parent); - Assert.Empty (menuBarItem.Children); - - menuBarItem = new (new MenuBarItem [] { }); - Assert.Equal ("", menuBarItem.Title); - Assert.Null (menuBarItem.Parent); - Assert.Empty (menuBarItem.Children); - - menuBarItem = new ("Test", new MenuBarItem [] { }); - Assert.Equal ("Test", menuBarItem.Title); - Assert.Null (menuBarItem.Parent); - Assert.Empty (menuBarItem.Children); - - menuBarItem = new ("Test", new List ()); - Assert.Equal ("Test", menuBarItem.Title); - Assert.Null (menuBarItem.Parent); - Assert.Empty (menuBarItem.Children); - - menuBarItem = new ("Test", "Help", null); - Assert.Equal ("Test", menuBarItem.Title); - Assert.Equal ("Help", menuBarItem.Help); - Assert.Null (menuBarItem.Action); - Assert.Null (menuBarItem.CanExecute); - Assert.Null (menuBarItem.Parent); - Assert.Equal (Key.Empty, menuBarItem.ShortcutKey); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void Disabled_MenuBar_Is_Never_Opened () - { - Toplevel top = new (); - - var menu = new MenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }) - ] - }; - top.Add (menu); - Application.Begin (top); - Assert.True (menu.Enabled); - menu.OpenMenu (); - Assert.True (menu.IsMenuOpen); - - menu.Enabled = false; - menu.CloseAllMenus (); - menu.OpenMenu (); - Assert.False (menu.IsMenuOpen); - top.Dispose (); - } - - [Fact (Skip = "#3798 Broke. Will fix in #2975")] - [AutoInitShutdown] - public void Disabled_MenuItem_Is_Never_Selected () - { - var menu = new MenuBar - { - Menus = - [ - new ( - "Menu", - new MenuItem [] - { - new ("Enabled 1", "", null), - new ("Disabled", "", null, () => false), - null, - new ("Enabled 2", "", null) - } - ) - ] - }; - - Toplevel top = new (); - top.Add (menu); - Application.Begin (top); - - Attribute [] attributes = - { - // 0 - menu.GetAttributeForRole(VisualRole.Normal), - - // 1 - menu.GetAttributeForRole(VisualRole.Focus), - - // 2 - menu.GetAttributeForRole(VisualRole.Disabled) - }; - - DriverAssert.AssertDriverAttributesAre ( - @" -00000000000000", - output, - Application.Driver, - attributes - ); - - Assert.True ( - menu.NewMouseEvent ( - new () { Position = new (0, 0), Flags = MouseFlags.Button1Pressed, View = menu } - ) - ); - top.Draw (); - - DriverAssert.AssertDriverAttributesAre ( - @" -11111100000000 -00000000000000 -01111111111110 -02222222222220 -00000000000000 -00000000000000 -00000000000000", - output, - Application.Driver, - attributes - ); - - Assert.True ( - top.SubViews.ElementAt (1) - .NewMouseEvent ( - new () { Position = new (0, 2), Flags = MouseFlags.Button1Clicked, View = top.SubViews.ElementAt (1) } - ) - ); - top.SubViews.ElementAt (1).Layout (); - top.SubViews.ElementAt (1).Draw (); - - DriverAssert.AssertDriverAttributesAre ( - @" -11111100000000 -00000000000000 -01111111111110 -02222222222220 -00000000000000 -00000000000000 -00000000000000", - output, - Application.Driver, - attributes - ); - - Assert.True ( - top.SubViews.ElementAt (1) - .NewMouseEvent ( - new () { Position = new (0, 2), Flags = MouseFlags.ReportMousePosition, View = top.SubViews.ElementAt (1) } - ) - ); - top.SubViews.ElementAt (1).Draw (); - - DriverAssert.AssertDriverAttributesAre ( - @" -11111100000000 -00000000000000 -01111111111110 -02222222222220 -00000000000000 -00000000000000 -00000000000000", - output, - Application.Driver, - attributes - ); - top.Dispose (); - } - - [Fact (Skip = "#3798 Broke. Will fix in #2975")] - [AutoInitShutdown] - public void Draw_A_Menu_Over_A_Dialog () - { - // Override CM - Window.DefaultBorderStyle = LineStyle.Single; - Dialog.DefaultButtonAlignment = Alignment.Center; - Dialog.DefaultBorderStyle = LineStyle.Single; - Dialog.DefaultShadow = ShadowStyle.None; - Button.DefaultShadow = ShadowStyle.None; - - Toplevel top = new (); - Window win = new (); - top.Add (win); - SessionToken rsTop = Application.Begin (top); - Application.Driver!.SetScreenSize (40, 15); - - Assert.Equal (new (0, 0, 40, 15), win.Frame); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - List items = new () - { - "New", - "Open", - "Close", - "Save", - "Save As", - "Delete" - }; - Dialog dialog = new () { X = 2, Y = 2, Width = 15, Height = 4 }; - MenuBar menu = new () { X = Pos.Center (), Width = 10 }; - - menu.Menus = new MenuBarItem [] - { - new ( - "File", - new MenuItem [] - { - new ( - items [0], - "Create a new file", - () => ChangeMenuTitle ("New"), - null, - null, - KeyCode.CtrlMask | KeyCode.N - ), - new ( - items [1], - "Open a file", - () => ChangeMenuTitle ("Open"), - null, - null, - KeyCode.CtrlMask | KeyCode.O - ), - new ( - items [2], - "Close a file", - () => ChangeMenuTitle ("Close"), - null, - null, - KeyCode.CtrlMask | KeyCode.C - ), - new ( - items [3], - "Save a file", - () => ChangeMenuTitle ("Save"), - null, - null, - KeyCode.CtrlMask | KeyCode.S - ), - new ( - items [4], - "Save a file as", - () => ChangeMenuTitle ("Save As"), - null, - null, - KeyCode.CtrlMask | KeyCode.A - ), - new ( - items [5], - "Delete a file", - () => ChangeMenuTitle ("Delete"), - null, - null, - KeyCode.CtrlMask | KeyCode.A - ) - } - ) - }; - dialog.Add (menu); - - void ChangeMenuTitle (string title) - { - menu.Menus [0].Title = title; - menu.SetNeedsDraw (); - } - - SessionToken rsDialog = Application.Begin (dialog); - AutoInitShutdownAttribute.RunIteration (); - - Assert.Equal (new (2, 2, 15, 4), dialog.Frame); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ │ -│ ┌─────────────┐ │ -│ │ File │ │ -│ │ │ │ -│ └─────────────┘ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.Equal ("File", menu.Menus [0].Title); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ │ -│ ┌─────────────┐ │ -│ │ File │ │ -│ │ ┌──────────────────────────────────┐ -│ └─│ New Create a new file Ctrl+N │ -│ │ Open Open a file Ctrl+O │ -│ │ Close Close a file Ctrl+C │ -│ │ Save Save a file Ctrl+S │ -│ │ Save As Save a file as Ctrl+A │ -│ │ Delete Delete a file Ctrl+A │ -│ └──────────────────────────────────┘ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Application.RaiseMouseEvent (new () { ScreenPosition = new (20, 5), Flags = MouseFlags.Button1Clicked }); - - // Need to fool MainLoop into thinking it's running - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (items [0], menu.Menus [0].Title); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ │ -│ ┌─────────────┐ │ -│ │ New │ │ -│ │ │ │ -│ └─────────────┘ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - for (var i = 0; i < items.Count; i++) - { - menu.OpenMenu (); - - Application.RaiseMouseEvent (new () { ScreenPosition = new (20, 5 + i), Flags = MouseFlags.Button1Clicked }); - - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (items [i], menu.Menus [0].Title); - } - - Application.Driver!.SetScreenSize (20, 15); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────┐ -│ │ -│ ┌─────────────┐ │ -│ │ Delete │ │ -│ │ ┌─────────────── -│ └─│ New Create -│ │ Open O -│ │ Close Cl -│ │ Save S -│ │ Save As Save -│ │ Delete Del -│ └─────────────── -│ │ -│ │ -└──────────────────┘", - output - ); - - Application.End (rsDialog); - Application.End (rsTop); - top.Dispose (); - } - - [Fact (Skip = "#3798 Broke. Will fix in #2975")] - [AutoInitShutdown] - public void Draw_A_Menu_Over_A_Top_Dialog () - { - Application.Driver!.SetScreenSize (40, 15); - - // Override CM - Window.DefaultBorderStyle = LineStyle.Single; - Dialog.DefaultButtonAlignment = Alignment.Center; - Dialog.DefaultBorderStyle = LineStyle.Single; - Dialog.DefaultShadow = ShadowStyle.None; - Button.DefaultShadow = ShadowStyle.None; - - Assert.Equal (new (0, 0, 40, 15), View.GetClip ()!.GetBounds ()); - DriverAssert.AssertDriverContentsWithFrameAre (@"", output); - - List items = new () - { - "New", - "Open", - "Close", - "Save", - "Save As", - "Delete" - }; - var dialog = new Dialog { X = 2, Y = 2, Width = 15, Height = 4 }; - var menu = new MenuBar { X = Pos.Center (), Width = 10 }; - - menu.Menus = new MenuBarItem [] - { - new ( - "File", - new MenuItem [] - { - new ( - items [0], - "Create a new file", - () => ChangeMenuTitle ("New"), - null, - null, - KeyCode.CtrlMask | KeyCode.N - ), - new ( - items [1], - "Open a file", - () => ChangeMenuTitle ("Open"), - null, - null, - KeyCode.CtrlMask | KeyCode.O - ), - new ( - items [2], - "Close a file", - () => ChangeMenuTitle ("Close"), - null, - null, - KeyCode.CtrlMask | KeyCode.C - ), - new ( - items [3], - "Save a file", - () => ChangeMenuTitle ("Save"), - null, - null, - KeyCode.CtrlMask | KeyCode.S - ), - new ( - items [4], - "Save a file as", - () => ChangeMenuTitle ("Save As"), - null, - null, - KeyCode.CtrlMask | KeyCode.A - ), - new ( - items [5], - "Delete a file", - () => ChangeMenuTitle ("Delete"), - null, - null, - KeyCode.CtrlMask | KeyCode.A - ) - } - ) - }; - dialog.Add (menu); - - void ChangeMenuTitle (string title) - { - menu.Menus [0].Title = title; - menu.SetNeedsDraw (); - } - - SessionToken rs = Application.Begin (dialog); - AutoInitShutdownAttribute.RunIteration (); - - Assert.Equal (new (2, 2, 15, 4), dialog.Frame); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - ┌─────────────┐ - │ File │ - │ │ - └─────────────┘", - output - ); - - Assert.Equal ("File", menu.Menus [0].Title); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - ┌─────────────┐ - │ File │ - │ ┌──────────────────────────────────┐ - └─│ New Create a new file Ctrl+N │ - │ Open Open a file Ctrl+O │ - │ Close Close a file Ctrl+C │ - │ Save Save a file Ctrl+S │ - │ Save As Save a file as Ctrl+A │ - │ Delete Delete a file Ctrl+A │ - └──────────────────────────────────┘", - output - ); - - Application.RaiseMouseEvent (new () { ScreenPosition = new (20, 5), Flags = MouseFlags.Button1Clicked }); - - // Need to fool MainLoop into thinking it's running - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (items [0], menu.Menus [0].Title); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - ┌─────────────┐ - │ New │ - │ │ - └─────────────┘", - output - ); - - for (var i = 1; i < items.Count; i++) - { - menu.OpenMenu (); - - Application.RaiseMouseEvent (new () { ScreenPosition = new (20, 5 + i), Flags = MouseFlags.Button1Clicked }); - - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (items [i], menu.Menus [0].Title); - } - - Application.Driver!.SetScreenSize (20, 15); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - ┌─────────────┐ - │ Delete │ - │ ┌─────────────── - └─│ New Create - │ Open O - │ Close Cl - │ Save S - │ Save As Save - │ Delete Del - └───────────────", - output - ); - - Application.End (rs); - dialog.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void DrawFrame_With_Negative_Positions () - { - var menu = new MenuBar - { - X = -1, - Y = -1, - Menus = - [ - new (new MenuItem [] { new ("One", "", null), new ("Two", "", null) }) - ] - }; - menu.Layout (); - - Assert.Equal (new (-1, -1), new Point (menu.Frame.X, menu.Frame.Y)); - - Toplevel top = new (); - Application.Begin (top); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - var expected = @" -──────┐ - One │ - Two │ -──────┘ -"; - - Rectangle pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (0, 0, 7, 4), pos); - - menu.CloseAllMenus (); - menu.Frame = new (-1, -2, menu.Frame.Width, menu.Frame.Height); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - expected = @" - One │ - Two │ -──────┘ -"; - - pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (1, 0, 7, 3), pos); - - menu.CloseAllMenus (); - menu.Frame = new (0, 0, menu.Frame.Width, menu.Frame.Height); - Application.Driver!.SetScreenSize (7, 5); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - expected = @" -┌────── -│ One -│ Two -└────── -"; - - pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (0, 1, 7, 4), pos); - - menu.CloseAllMenus (); - menu.Frame = new (0, 0, menu.Frame.Width, menu.Frame.Height); - Application.Driver!.SetScreenSize (7, 3); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - expected = @" -┌────── -│ One -│ Two -"; - - pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (0, 0, 7, 3), pos); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void DrawFrame_With_Negative_Positions_Disabled_Border () - { - var menu = new MenuBar - { - X = -2, - Y = -1, - MenusBorderStyle = LineStyle.None, - Menus = - [ - new (new MenuItem [] { new ("One", "", null), new ("Two", "", null) }) - ] - }; - menu.Layout (); - - Assert.Equal (new (-2, -1), new Point (menu.Frame.X, menu.Frame.Y)); - - Toplevel top = new (); - Application.Begin (top); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - var expected = @" -ne -wo -"; - - _ = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - - menu.CloseAllMenus (); - menu.Frame = new (-2, -2, menu.Frame.Width, menu.Frame.Height); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - expected = @" -wo -"; - - _ = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - - menu.CloseAllMenus (); - menu.Frame = new (0, 0, menu.Frame.Width, menu.Frame.Height); - Application.Driver!.SetScreenSize (3, 2); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - expected = @" - On - Tw -"; - - _ = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - - menu.CloseAllMenus (); - menu.Frame = new (0, 0, menu.Frame.Width, menu.Frame.Height); - Application.Driver!.SetScreenSize (3, 1); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - expected = @" - On -"; - - _ = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void DrawFrame_With_Positive_Positions () - { - var menu = new MenuBar - { - Menus = - [ - new (new MenuItem [] { new ("One", "", null), new ("Two", "", null) }) - ] - }; - - Assert.Equal (Point.Empty, new (menu.Frame.X, menu.Frame.Y)); - - Toplevel top = new (); - Application.Begin (top); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - var expected = @" -┌──────┐ -│ One │ -│ Two │ -└──────┘ -"; - - Rectangle pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (0, 1, 8, 4), pos); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void DrawFrame_With_Positive_Positions_Disabled_Border () - { - var menu = new MenuBar - { - MenusBorderStyle = LineStyle.None, - Menus = - [ - new (new MenuItem [] { new ("One", "", null), new ("Two", "", null) }) - ] - }; - - Assert.Equal (Point.Empty, new (menu.Frame.X, menu.Frame.Y)); - - Toplevel top = new (); - Application.Begin (top); - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - var expected = @" - One - Two -"; - - _ = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - public void Exceptions () - { - Assert.Throws (() => new MenuBarItem ("Test", (MenuItem [])null)); - Assert.Throws (() => new MenuBarItem ("Test", (List)null)); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void HotKey_MenuBar_OnKeyDown_OnKeyUp_ProcessKeyPressed () - { - var newAction = false; - var copyAction = false; - - var menu = new MenuBar - { - Menus = - [ - new ("_File", new MenuItem [] { new ("_New", "", () => newAction = true) }), - new ( - "_Edit", - new MenuItem [] { new ("_Copy", "", () => copyAction = true) } - ) - ] - }; - - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - Assert.False (newAction); - Assert.False (copyAction); - -#if SUPPORT_ALT_TO_ACTIVATE_MENU - Assert.False (Application.Top.ProcessKeyDown (new KeyEventArgs (Key.AltMask))); - Assert.False (Application.Top.ProcessKeyDown (new KeyEventArgs (Key.AltMask))); - Assert.True (Application.Top.ProcessKeyUp (new KeyEventArgs (Key.AltMask))); - Assert.True (menu.IsMenuOpen); - Application.Top.Draw (); - - string expected = @" - File Edit -"; - - var pos = DriverAsserts.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (1, 0, 11, 1), pos); - - Assert.True (Application.Top.ProcessKeyDown (new KeyEventArgs (Key.N))); - AutoInitShutdownAttribute.RunIteration (); - Assert.False (newAction); // not yet, hot keys don't work if the item is not visible - - Assert.True (Application.Top.ProcessKeyDown (new KeyEventArgs (Key.F))); - AutoInitShutdownAttribute.RunIteration (); - Assert.True (Application.Top.ProcessKeyDown (new KeyEventArgs (Key.N))); - AutoInitShutdownAttribute.RunIteration (); - Assert.True (newAction); - Application.Top.Draw (); - - expected = @" - File Edit -"; - - Assert.False (Application.Top.ProcessKeyDown (new KeyEventArgs (Key.AltMask))); - Assert.True (Application.Top.ProcessKeyUp (new KeyEventArgs (Key.AltMask))); - Assert.True (Application.Top.ProcessKeyUp (new KeyEventArgs (Key.AltMask))); - Assert.True (menu.IsMenuOpen); - Application.Top.Draw (); - - expected = @" - File Edit -"; - - pos = DriverAsserts.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (1, 0, 11, 1), pos); - - Assert.True (Application.Top.ProcessKeyDown (new KeyEventArgs (Key.CursorRight))); - Assert.True (Application.Top.ProcessKeyDown (new KeyEventArgs (Key.C))); - AutoInitShutdownAttribute.RunIteration (); - Assert.True (copyAction); -#endif - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void HotKey_MenuBar_ProcessKeyPressed_Menu_ProcessKey () - { - var newAction = false; - var copyAction = false; - - // Define the expected menu - var expectedMenu = new ExpectedMenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }), - new ( - "Edit", - new MenuItem [] { new ("Copy", "", null) } - ) - ] - }; - - // The real menu - var menu = new MenuBar - { - Menus = - [ - new ( - "_" + expectedMenu.Menus [0].Title, - new MenuItem [] - { - new ( - "_" + expectedMenu.Menus [0].Children [0].Title, - "", - () => newAction = true - ) - } - ), - new ( - "_" + expectedMenu.Menus [1].Title, - new MenuItem [] - { - new ( - "_" - + expectedMenu.Menus [1] - .Children [0] - .Title, - "", - () => copyAction = true - ) - } - ) - ] - }; - - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - Assert.False (newAction); - Assert.False (copyAction); - - Assert.True (menu.NewKeyDownEvent (Key.F.WithAlt)); - Assert.True (menu.IsMenuOpen); - Application.Top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (0), output); - - Assert.True (Application.Top.SubViews.ElementAt (1).NewKeyDownEvent (Key.N)); - AutoInitShutdownAttribute.RunIteration (); - Assert.True (newAction); - - Assert.True (menu.NewKeyDownEvent (Key.E.WithAlt)); - Assert.True (menu.IsMenuOpen); - Application.Top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (1), output); - - Assert.True (Application.Top.SubViews.ElementAt (1).NewKeyDownEvent (Key.C)); - AutoInitShutdownAttribute.RunIteration (); - Assert.True (copyAction); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void Key_Open_And_Close_The_MenuBar () - { - var menu = new MenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }) - ] - }; - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - Assert.True (top.NewKeyDownEvent (menu.Key)); - Assert.True (menu.IsMenuOpen); - Assert.True (top.NewKeyDownEvent (menu.Key)); - Assert.False (menu.IsMenuOpen); - - menu.Key = Key.F10.WithShift; - Assert.False (top.NewKeyDownEvent (Key.F9)); - Assert.False (menu.IsMenuOpen); - - Assert.True (top.NewKeyDownEvent (Key.F10.WithShift)); - Assert.True (menu.IsMenuOpen); - Assert.True (top.NewKeyDownEvent (Key.F10.WithShift)); - Assert.False (menu.IsMenuOpen); - top.Dispose (); - } - - [Theory (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - [InlineData ("_File", "_New", "", KeyCode.Space | KeyCode.CtrlMask)] - [InlineData ("Closed", "None", "", KeyCode.Space | KeyCode.CtrlMask, KeyCode.Space | KeyCode.CtrlMask)] - [InlineData ("_File", "_New", "", KeyCode.F9)] - [InlineData ("Closed", "None", "", KeyCode.F9, KeyCode.F9)] - [InlineData ("_File", "_Open", "", KeyCode.F9, KeyCode.CursorDown)] - [InlineData ("_File", "_Save", "", KeyCode.F9, KeyCode.CursorDown, KeyCode.CursorDown)] - [InlineData ("_File", "_Quit", "", KeyCode.F9, KeyCode.CursorDown, KeyCode.CursorDown, KeyCode.CursorDown)] - [InlineData ( - "_File", - "_New", - "", - KeyCode.F9, - KeyCode.CursorDown, - KeyCode.CursorDown, - KeyCode.CursorDown, - KeyCode.CursorDown - )] - [InlineData ("_File", "_New", "", KeyCode.F9, KeyCode.CursorDown, KeyCode.CursorUp)] - [InlineData ("_File", "_Quit", "", KeyCode.F9, KeyCode.CursorUp)] - [InlineData ("_File", "_New", "", KeyCode.F9, KeyCode.CursorUp, KeyCode.CursorDown)] - [InlineData ("Closed", "None", "Open", KeyCode.F9, KeyCode.CursorDown, KeyCode.Enter)] - [InlineData ("_Edit", "_Copy", "", KeyCode.F9, KeyCode.CursorRight)] - [InlineData ("_About", "_About", "", KeyCode.F9, KeyCode.CursorLeft)] - [InlineData ("_Edit", "_Copy", "", KeyCode.F9, KeyCode.CursorLeft, KeyCode.CursorLeft)] - [InlineData ("_Edit", "_Select All", "", KeyCode.F9, KeyCode.CursorRight, KeyCode.CursorUp)] - [InlineData ("_File", "_New", "", KeyCode.F9, KeyCode.CursorRight, KeyCode.CursorDown, KeyCode.CursorLeft)] - [InlineData ("_About", "_About", "", KeyCode.F9, KeyCode.CursorRight, KeyCode.CursorRight)] - [InlineData ("Closed", "None", "New", KeyCode.F9, KeyCode.Enter)] - [InlineData ("Closed", "None", "Quit", KeyCode.F9, KeyCode.CursorUp, KeyCode.Enter)] - [InlineData ("Closed", "None", "Copy", KeyCode.F9, KeyCode.CursorRight, KeyCode.Enter)] - [InlineData ( - "Closed", - "None", - "Find", - KeyCode.F9, - KeyCode.CursorRight, - KeyCode.CursorUp, - KeyCode.CursorUp, - KeyCode.Enter - )] - [InlineData ( - "Closed", - "None", - "Replace", - KeyCode.F9, - KeyCode.CursorRight, - KeyCode.CursorUp, - KeyCode.CursorUp, - KeyCode.CursorDown, - KeyCode.Enter - )] - [InlineData ( - "_Edit", - "F_ind", - "", - KeyCode.F9, - KeyCode.CursorRight, - KeyCode.CursorUp, - KeyCode.CursorUp, - KeyCode.CursorLeft, - KeyCode.Enter - )] - [InlineData ("Closed", "None", "About", KeyCode.F9, KeyCode.CursorRight, KeyCode.CursorRight, KeyCode.Enter)] - - //// Hotkeys - [InlineData ("_File", "_New", "", KeyCode.AltMask | KeyCode.F)] - [InlineData ("Closed", "None", "", KeyCode.AltMask | KeyCode.ShiftMask | KeyCode.F)] - [InlineData ("Closed", "None", "", KeyCode.AltMask | KeyCode.F, KeyCode.Esc)] - [InlineData ("Closed", "None", "", KeyCode.AltMask | KeyCode.F, KeyCode.AltMask | KeyCode.F)] - [InlineData ("Closed", "None", "Open", KeyCode.AltMask | KeyCode.F, KeyCode.O)] - [InlineData ("_File", "_New", "", KeyCode.AltMask | KeyCode.F, KeyCode.ShiftMask | KeyCode.O)] - [InlineData ("Closed", "None", "Open", KeyCode.AltMask | KeyCode.F, KeyCode.AltMask | KeyCode.O)] - [InlineData ("_Edit", "_Copy", "", KeyCode.AltMask | KeyCode.E)] - [InlineData ("_Edit", "F_ind", "", KeyCode.AltMask | KeyCode.E, KeyCode.F)] - [InlineData ("_Edit", "F_ind", "", KeyCode.AltMask | KeyCode.E, KeyCode.AltMask | KeyCode.F)] - [InlineData ("Closed", "None", "Replace", KeyCode.AltMask | KeyCode.E, KeyCode.F, KeyCode.R)] - [InlineData ("Closed", "None", "Copy", KeyCode.AltMask | KeyCode.E, KeyCode.F, KeyCode.C)] - [InlineData ("_Edit", "_1st", "", KeyCode.AltMask | KeyCode.E, KeyCode.F, KeyCode.D3)] - [InlineData ("Closed", "None", "1", KeyCode.AltMask | KeyCode.E, KeyCode.F, KeyCode.D3, KeyCode.D1)] - [InlineData ("Closed", "None", "1", KeyCode.AltMask | KeyCode.E, KeyCode.F, KeyCode.D3, KeyCode.Enter)] - [InlineData ("Closed", "None", "2", KeyCode.AltMask | KeyCode.E, KeyCode.F, KeyCode.D3, KeyCode.D2)] - [InlineData ("_Edit", "_5th", "", KeyCode.AltMask | KeyCode.E, KeyCode.F, KeyCode.D3, KeyCode.D4)] - [InlineData ("Closed", "None", "5", KeyCode.AltMask | KeyCode.E, KeyCode.F, KeyCode.D4, KeyCode.D5)] - [InlineData ("Closed", "None", "About", KeyCode.AltMask | KeyCode.A)] - public void KeyBindings_Navigation_Commands ( - string expectedBarTitle, - string expectedItemTitle, - string expectedAction, - params KeyCode [] keys - ) - { - var miAction = ""; - MenuItem mbiCurrent = null; - MenuItem miCurrent = null; - - var menu = new MenuBar (); - - Func fn = s => - { - miAction = s as string; - - return true; - }; - menu.EnableForDesign (ref fn); - - menu.Key = KeyCode.F9; - menu.MenuOpening += (s, e) => mbiCurrent = e.CurrentMenu; - menu.MenuOpened += (s, e) => { miCurrent = e.MenuItem; }; - - menu.MenuClosing += (s, e) => - { - mbiCurrent = null; - miCurrent = null; - }; - menu.UseKeysUpDownAsKeysLeftRight = true; - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - foreach (Key key in keys) - { - top.NewKeyDownEvent (key); - AutoInitShutdownAttribute.RunIteration (); - } - - Assert.Equal (expectedBarTitle, mbiCurrent != null ? mbiCurrent.Title : "Closed"); - Assert.Equal (expectedItemTitle, miCurrent != null ? miCurrent.Title : "None"); - Assert.Equal (expectedAction, miAction); - top.Dispose (); - } - - [Theory (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - [InlineData ("New", KeyCode.CtrlMask | KeyCode.N)] - [InlineData ("Quit", KeyCode.CtrlMask | KeyCode.Q)] - [InlineData ("Copy", KeyCode.CtrlMask | KeyCode.C)] - [InlineData ("Replace", KeyCode.CtrlMask | KeyCode.H)] - [InlineData ("1", KeyCode.F1)] - [InlineData ("5", KeyCode.CtrlMask | KeyCode.D5)] - public void KeyBindings_Shortcut_Commands (string expectedAction, params KeyCode [] keys) - { - var miAction = ""; - MenuItem mbiCurrent = null; - MenuItem miCurrent = null; - - var menu = new MenuBar (); - - bool FnAction (string s) - { - miAction = s; - - return true; - } - - // Declare a variable for the function - Func fnActionVariable = FnAction; - - menu.EnableForDesign (ref fnActionVariable); - - menu.Key = KeyCode.F9; - menu.MenuOpening += (s, e) => mbiCurrent = e.CurrentMenu; - menu.MenuOpened += (s, e) => { miCurrent = e.MenuItem; }; - - menu.MenuClosing += (s, e) => - { - mbiCurrent = null; - miCurrent = null; - }; - menu.UseKeysUpDownAsKeysLeftRight = true; - - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - foreach (KeyCode key in keys) - { - Assert.True (top.NewKeyDownEvent (new (key))); - AutoInitShutdownAttribute.RunIteration (); - } - - Assert.Equal (expectedAction, miAction); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void Menu_With_Separator () - { - var menu = new MenuBar - { - Menus = - [ - new ( - "File", - new MenuItem [] - { - new ( - "_Open", - "Open a file", - () => { }, - null, - null, - KeyCode.CtrlMask | KeyCode.O - ), - null, - new ("_Quit", "", null) - } - ) - ] - }; - - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - File -┌────────────────────────────┐ -│ Open Open a file Ctrl+O │ -├────────────────────────────┤ -│ Quit │ -└────────────────────────────┘", - output - ); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void Menu_With_Separator_Disabled_Border () - { - var menu = new MenuBar - { - MenusBorderStyle = LineStyle.None, - Menus = - [ - new ( - "File", - new MenuItem [] - { - new ( - "_Open", - "Open a file", - () => { }, - null, - null, - KeyCode.CtrlMask | KeyCode.O - ), - null, - new ("_Quit", "", null) - } - ) - ] - }; - - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - menu.OpenMenu (); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - File - Open Open a file Ctrl+O -──────────────────────────── - Quit ", - output - ); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void MenuBar_ButtonPressed_Open_The_Menu_ButtonPressed_Again_Close_The_Menu () - { - // Define the expected menu - var expectedMenu = new ExpectedMenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("Open", "", null) }), - new ( - "Edit", - new MenuItem [] { new ("Copy", "", null) } - ) - ] - }; - - // Test without HotKeys first - var menu = new MenuBar - { - Menus = - [ - new ( - "_" + expectedMenu.Menus [0].Title, - new MenuItem [] { new ("_" + expectedMenu.Menus [0].Children [0].Title, "", null) } - ), - new ( - "_" + expectedMenu.Menus [1].Title, - new MenuItem [] - { - new ( - "_" - + expectedMenu.Menus [1] - .Children [0] - .Title, - "", - null - ) - } - ) - ] - }; - - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - Assert.True (menu.NewMouseEvent (new () { Position = new (1, 0), Flags = MouseFlags.Button1Pressed, View = menu })); - Assert.True (menu.IsMenuOpen); - top.Draw (); - - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (0), output); - - Assert.True (menu.NewMouseEvent (new () { Position = new (1, 0), Flags = MouseFlags.Button1Pressed, View = menu })); - Assert.False (menu.IsMenuOpen); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ClosedMenuText, output); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void MenuBar_In_Window_Without_Other_Views_With_Top_Init () - { - var win = new Window (); - - var menu = new MenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }), - new ( - "Edit", - new MenuItem [] - { - new MenuBarItem ( - "Delete", - new MenuItem [] - { new ("All", "", null), new ("Selected", "", null) } - ) - } - ) - ] - }; - win.Add (menu); - Toplevel top = new (); - top.Add (win); - Application.Begin (top); - Application.Driver!.SetScreenSize (40, 8); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ │ -│ │ -│ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (win.NewKeyDownEvent (menu.Key)); - top.Draw (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│┌──────┐ │ -││ New │ │ -│└──────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (menu.NewKeyDownEvent (Key.CursorRight)); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ ┌─────────┐ │ -│ │ Delete ►│ │ -│ └─────────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (menu._openMenu.NewKeyDownEvent (Key.CursorRight)); - top.Draw (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ ┌─────────┐ │ -│ │ Delete ►│┌───────────┐ │ -│ └─────────┘│ All │ │ -│ │ Selected │ │ -│ └───────────┘ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (menu._openMenu.NewKeyDownEvent (Key.CursorRight)); - View.SetClipToScreen (); - top.Draw (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│┌──────┐ │ -││ New │ │ -│└──────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void MenuBar_In_Window_Without_Other_Views_With_Top_Init_With_Parameterless_Run () - { - var win = new Window (); - - var menu = new MenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }), - new ( - "Edit", - new MenuItem [] - { - new MenuBarItem ( - "Delete", - new MenuItem [] - { new ("All", "", null), new ("Selected", "", null) } - ) - } - ) - ] - }; - win.Add (menu); - Toplevel top = new (); - top.Add (win); - - Application.AddTimeout (TimeSpan.Zero, () => - { - Application.Driver!.SetScreenSize (40, 8); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ │ -│ │ -│ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (win.NewKeyDownEvent (menu.Key)); - top.Draw (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│┌──────┐ │ -││ New │ │ -│└──────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (menu.NewKeyDownEvent (Key.CursorRight)); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ ┌─────────┐ │ -│ │ Delete ►│ │ -│ └─────────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (menu._openMenu.NewKeyDownEvent (Key.CursorRight)); - top.Draw (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ ┌─────────┐ │ -│ │ Delete ►│┌───────────┐ │ -│ └─────────┘│ All │ │ -│ │ Selected │ │ -│ └───────────┘ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (menu._openMenu.NewKeyDownEvent (Key.CursorRight)); - View.SetClipToScreen (); - top.Draw (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│┌──────┐ │ -││ New │ │ -│└──────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Application.RequestStop (); - - return false; - }); - - Application.Run (top); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void MenuBar_In_Window_Without_Other_Views_Without_Top_Init () - { - var win = new Window (); - - var menu = new MenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }), - new ( - "Edit", - new MenuItem [] - { - new MenuBarItem ( - "Delete", - new MenuItem [] - { new ("All", "", null), new ("Selected", "", null) } - ) - } - ) - ] - }; - win.Add (menu); - Application.Driver!.SetScreenSize (40, 8); - SessionToken rs = Application.Begin (win); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ │ -│ │ -│ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (win.NewKeyDownEvent (menu.Key)); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│┌──────┐ │ -││ New │ │ -│└──────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (menu.NewKeyDownEvent (Key.CursorRight)); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ ┌─────────┐ │ -│ │ Delete ►│ │ -│ └─────────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (menu._openMenu.NewKeyDownEvent (Key.CursorRight)); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ ┌─────────┐ │ -│ │ Delete ►│┌───────────┐ │ -│ └─────────┘│ All │ │ -│ │ Selected │ │ -│ └───────────┘ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (menu._openMenu.NewKeyDownEvent (Key.CursorRight)); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│┌──────┐ │ -││ New │ │ -│└──────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - win.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void MenuBar_In_Window_Without_Other_Views_Without_Top_Init_With_Run_T () - { - Application.Driver!.SetScreenSize (40, 8); - - Application.AddTimeout (TimeSpan.Zero, () => - { - Toplevel top = Application.Top; - - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ │ -│ │ -│ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (top.NewKeyDownEvent (Key.F9)); - top.Draw (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│┌──────┐ │ -││ New │ │ -│└──────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True (top.SubViews.ElementAt (0).NewKeyDownEvent (Key.CursorRight)); - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ ┌─────────┐ │ -│ │ Delete ►│ │ -│ └─────────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True ( - ((MenuBar)top.SubViews.ElementAt (0))._openMenu.NewKeyDownEvent (Key.CursorRight) - ); - top.Draw (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│ ┌─────────┐ │ -│ │ Delete ►│┌───────────┐ │ -│ └─────────┘│ All │ │ -│ │ Selected │ │ -│ └───────────┘ │ -└──────────────────────────────────────┘", - output - ); - - Assert.True ( - ((MenuBar)top.SubViews.ElementAt (0))._openMenu.NewKeyDownEvent (Key.CursorRight) - ); - View.SetClipToScreen (); - top.Draw (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│┌──────┐ │ -││ New │ │ -│└──────┘ │ -│ │ -│ │ -└──────────────────────────────────────┘", - output - ); - - Application.RequestStop (); - - return false; - }); - - Application.Run ().Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void MenuBar_Position_And_Size_With_HotKeys_Is_The_Same_As_Without_HotKeys () - { - // Define the expected menu - var expectedMenu = new ExpectedMenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("12", "", null) }), - new ( - "Edit", - new MenuItem [] { new ("Copy", "", null) } - ) - ] - }; - - // Test without HotKeys first - var menu = new MenuBar - { - Menus = - [ - new ( - expectedMenu.Menus [0].Title, - new MenuItem [] { new (expectedMenu.Menus [0].Children [0].Title, "", null) } - ), - new ( - expectedMenu.Menus [1].Title, - new MenuItem [] - { - new ( - expectedMenu.Menus [1].Children [0].Title, - "", - null - ) - } - ) - ] - }; - - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - // Open first - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu.IsMenuOpen); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (0), output); - - // Open second - Assert.True (Application.Top.SubViews.ElementAt (1).NewKeyDownEvent (Key.CursorRight)); - Assert.True (menu.IsMenuOpen); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (1), output); - - // Close menu - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.False (menu.IsMenuOpen); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ClosedMenuText, output); - - top.Remove (menu); - - // Now test WITH HotKeys - menu = new () - { - Menus = - [ - new ( - "_" + expectedMenu.Menus [0].Title, - new MenuItem [] { new ("_" + expectedMenu.Menus [0].Children [0].Title, "", null) } - ), - new ( - "_" + expectedMenu.Menus [1].Title, - new MenuItem [] - { - new ( - "_" + expectedMenu.Menus [1].Children [0].Title, - "", - null - ) - } - ) - ] - }; - - top.Add (menu); - - // Open first - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu.IsMenuOpen); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (0), output); - - // Open second - Assert.True (top.SubViews.ElementAt (1).NewKeyDownEvent (Key.CursorRight)); - Assert.True (menu.IsMenuOpen); - View.SetClipToScreen (); - Application.Top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (1), output); - - // Close menu - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.False (menu.IsMenuOpen); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ClosedMenuText, output); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void MenuBar_Submenus_Alignment_Correct () - { - // Define the expected menu - var expectedMenu = new ExpectedMenuBar - { - Menus = - [ - new ( - "File", - new MenuItem [] - { - new ( - "Really Long Sub Menu", - "", - null - ) - } - ), - new ( - "123", - new MenuItem [] { new ("Copy", "", null) } - ), - new ( - "Format", - new MenuItem [] { new ("Word Wrap", "", null) } - ), - new ( - "Help", - new MenuItem [] { new ("About", "", null) } - ), - new ( - "1", - new MenuItem [] { new ("2", "", null) } - ), - new ( - "3", - new MenuItem [] { new ("2", "", null) } - ), - new ( - "Last one", - new MenuItem [] { new ("Test", "", null) } - ) - ] - }; - - MenuBarItem [] items = new MenuBarItem [expectedMenu.Menus.Length]; - - for (var i = 0; i < expectedMenu.Menus.Length; i++) - { - items [i] = new ( - expectedMenu.Menus [i].Title, - new MenuItem [] { new (expectedMenu.Menus [i].Children [0].Title, "", null) } - ); - } - - var menu = new MenuBar { Menus = items }; - - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ClosedMenuText, output); - - for (var i = 0; i < expectedMenu.Menus.Length; i++) - { - menu.OpenMenu (i); - Assert.True (menu.IsMenuOpen); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (i), output); - } - - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void MenuBar_With_Action_But_Without_MenuItems_Not_Throw () - { - var menu = new MenuBar - { - Menus = - [ - new () { Title = "Test 1", Action = () => { } }, - - new () { Title = "Test 2", Action = () => { } } - ] - }; - - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - -#if SUPPORT_ALT_TO_ACTIVATE_MENU - Assert.True ( - Application.OnKeyUp ( - new KeyEventArgs ( - Key.AltMask - ) - ) - ); // changed to true because Alt activates menu bar -#endif - Assert.True (menu.NewKeyDownEvent (Key.CursorRight)); - Assert.True (menu.NewKeyDownEvent (Key.CursorRight)); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void MenuBarItem_Children_Null_Does_Not_Throw () - { - var menu = new MenuBar - { - Menus = - [ - new ("Test", "", null) - ] - }; - var top = new Toplevel (); - top.Add (menu); - - Exception exception = Record.Exception (() => menu.NewKeyDownEvent (Key.Space)); - Assert.Null (exception); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void MenuOpened_On_Disabled_MenuItem () - { - MenuItem parent = null; - MenuItem miCurrent = null; - Menu mCurrent = null; - - var menu = new MenuBar - { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new MenuBarItem ( - "_New", - new MenuItem [] - { - new ( - "_New doc", - "Creates new doc.", - null, - () => false - ) - } - ), - null, - new ("_Save", "Saves the file.", null) - } - ) - ] - }; - - menu.MenuOpened += (s, e) => - { - parent = e.Parent; - miCurrent = e.MenuItem; - mCurrent = menu._openMenu; - }; - menu.UseKeysUpDownAsKeysLeftRight = true; - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - // open the menu - Assert.True ( - menu.NewMouseEvent ( - new () { Position = new (1, 0), Flags = MouseFlags.Button1Pressed, View = menu } - ) - ); - Assert.True (menu.IsMenuOpen); - Assert.Equal ("_File", parent.Title); - Assert.Equal ("_File", miCurrent.Parent.Title); - Assert.Equal ("_New", miCurrent.Title); - - Assert.True ( - mCurrent.NewMouseEvent ( - new () { Position = new (1, 1), Flags = MouseFlags.ReportMousePosition, View = mCurrent } - ) - ); - Assert.True (menu.IsMenuOpen); - Assert.Equal ("_File", parent.Title); - Assert.Equal ("_File", miCurrent.Parent.Title); - Assert.Equal ("_New", miCurrent.Title); - - Assert.True ( - mCurrent.NewMouseEvent ( - new () { Position = new (1, 1), Flags = MouseFlags.ReportMousePosition, View = mCurrent } - ) - ); - Assert.True (menu.IsMenuOpen); - Assert.Equal ("_File", parent.Title); - Assert.Equal ("_File", miCurrent.Parent.Title); - Assert.Equal ("_New", miCurrent.Title); - - Assert.True ( - mCurrent.NewMouseEvent ( - new () { Position = new (1, 2), Flags = MouseFlags.ReportMousePosition, View = mCurrent } - ) - ); - Assert.True (menu.IsMenuOpen); - Assert.Equal ("_File", parent.Title); - Assert.Equal ("_File", miCurrent.Parent.Title); - Assert.Equal ("_Save", miCurrent.Title); - - // close the menu - Assert.True ( - menu.NewMouseEvent ( - new () { Position = new (1, 0), Flags = MouseFlags.Button1Pressed, View = menu } - ) - ); - Assert.False (menu.IsMenuOpen); - - // open the menu - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu.IsMenuOpen); - - // The _New doc is enabled but the sub-menu isn't enabled. Is show but can't be selected and executed - Assert.Equal ("_New", parent.Title); - Assert.Equal ("_New", miCurrent.Parent.Title); - Assert.Equal ("_New doc", miCurrent.Title); - - Assert.True (mCurrent.NewKeyDownEvent (Key.CursorDown)); - Assert.True (menu.IsMenuOpen); - Assert.Equal ("_File", parent.Title); - Assert.Equal ("_File", miCurrent.Parent.Title); - Assert.Equal ("_Save", miCurrent.Title); - - Assert.True (mCurrent.NewKeyDownEvent (Key.CursorUp)); - Assert.True (menu.IsMenuOpen); - Assert.Equal ("_File", parent.Title); - Assert.Null (miCurrent); - - // close the menu - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.False (menu.IsMenuOpen); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void MenuOpening_MenuOpened_MenuClosing_Events () - { - var miAction = ""; - var isMenuClosed = true; - var cancelClosing = false; - - var menu = new MenuBar - { - Menus = - [ - new ("_File", new MenuItem [] { new ("_New", "Creates new file.", New) }) - ] - }; - - menu.MenuOpening += (s, e) => - { - Assert.Equal ("_File", e.CurrentMenu.Title); - Assert.Equal ("_New", e.CurrentMenu.Children [0].Title); - Assert.Equal ("Creates new file.", e.CurrentMenu.Children [0].Help); - Assert.Equal (New, e.CurrentMenu.Children [0].Action); - e.CurrentMenu.Children [0].Action (); - Assert.Equal ("New", miAction); - - e.NewMenuBarItem = new ( - "_Edit", - new MenuItem [] { new ("_Copy", "Copies the selection.", Copy) } - ); - }; - - menu.MenuOpened += (s, e) => - { - MenuItem mi = e.MenuItem; - - Assert.Equal ("_Edit", mi.Parent.Title); - Assert.Equal ("_Copy", mi.Title); - Assert.Equal ("Copies the selection.", mi.Help); - Assert.Equal (Copy, mi.Action); - mi.Action (); - Assert.Equal ("Copy", miAction); - }; - - menu.MenuClosing += (s, e) => - { - Assert.False (isMenuClosed); - - if (cancelClosing) - { - e.Cancel = true; - isMenuClosed = false; - } - else - { - isMenuClosed = true; - } - }; - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu.IsMenuOpen); - isMenuClosed = !menu.IsMenuOpen; - Assert.False (isMenuClosed); - top.Draw (); - - var expected = @" -Edit -┌──────────────────────────────┐ -│ Copy Copies the selection. │ -└──────────────────────────────┘ -"; - DriverAssert.AssertDriverContentsAre (expected, output); - - cancelClosing = true; - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu.IsMenuOpen); - Assert.False (isMenuClosed); - View.SetClipToScreen (); - top.Draw (); - - expected = @" -Edit -┌──────────────────────────────┐ -│ Copy Copies the selection. │ -└──────────────────────────────┘ -"; - DriverAssert.AssertDriverContentsAre (expected, output); - - cancelClosing = false; - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.False (menu.IsMenuOpen); - Assert.True (isMenuClosed); - View.SetClipToScreen (); - top.Draw (); - - expected = @" -Edit -"; - DriverAssert.AssertDriverContentsAre (expected, output); - - void New () { miAction = "New"; } - - void Copy () { miAction = "Copy"; } - - top.Dispose (); - } - - [Fact (Skip = "See Issue #4370. Not gonna try to fix menu v1.")] - [AutoInitShutdown] - public void MouseEvent_Test () - { - MenuItem miCurrent = null; - Menu mCurrent = null; - - var menuBar = new MenuBar - { - Menus = - [ - new ( - "_File", - new MenuItem [] { new ("_New", "", null), new ("_Open", "", null), new ("_Save", "", null) } - ), - new ( - "_Edit", - new MenuItem [] { new ("_Copy", "", null), new ("C_ut", "", null), new ("_Paste", "", null) } - ) - ] - }; - - menuBar.MenuOpened += (s, e) => - { - miCurrent = e.MenuItem; - mCurrent = menuBar.OpenCurrentMenu; - }; - var top = new Toplevel (); - top.Add (menuBar); - Application.Begin (top); - - // Click on Edit - Assert.True ( - menuBar.NewMouseEvent ( - new () { Position = new (10, 0), Flags = MouseFlags.Button1Pressed, View = menuBar } - ) - ); - Assert.True (menuBar.IsMenuOpen); - Assert.Equal ("_Edit", miCurrent.Parent.Title); - Assert.Equal ("_Copy", miCurrent.Title); - - // Click on Paste - Assert.True ( - mCurrent.NewMouseEvent ( - new () { Position = new (10, 2), Flags = MouseFlags.ReportMousePosition, View = mCurrent } - ) - ); - Assert.True (menuBar.IsMenuOpen); - Assert.Equal ("_Edit", miCurrent.Parent.Title); - Assert.Equal ("_Paste", miCurrent.Title); - - for (var i = 4; i >= -1; i--) - { - Application.RaiseMouseEvent ( - new () { ScreenPosition = new (10, i), Flags = MouseFlags.ReportMousePosition } - ); - - Assert.True (menuBar.IsMenuOpen); - Menu menu = (Menu)top.SubViews.First (v => v is Menu); - - if (i is < 0 or > 0) - { - Assert.Equal (menu, Application.Mouse.MouseGrabView); - } - else - { - Assert.Equal (menuBar, Application.Mouse.MouseGrabView); - } - - Assert.Equal ("_Edit", miCurrent.Parent.Title); - - if (i == 4) - { - Assert.Equal ("_Paste", miCurrent.Title); - } - else if (i == 3) - { - Assert.Equal ("C_ut", miCurrent.Title); - } - else if (i == 2) - { - Assert.Equal ("_Copy", miCurrent.Title); - } - else - { - Assert.Equal ("_Copy", miCurrent.Title); - } - } - - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void Parent_MenuItem_Stay_Focused_If_Child_MenuItem_Is_Empty_By_Keyboard () - { - var expectedMenu = new ExpectedMenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }), - new ("Edit", Array.Empty ()), - new ( - "Format", - new MenuItem [] { new ("Wrap", "", null) } - ) - ] - }; - - MenuBarItem [] items = new MenuBarItem [expectedMenu.Menus.Length]; - - for (var i = 0; i < expectedMenu.Menus.Length; i++) - { - items [i] = new ( - expectedMenu.Menus [i].Title, - expectedMenu.Menus [i].Children.Length > 0 - ? new MenuItem [] { new (expectedMenu.Menus [i].Children [0].Title, "", null) } - : Array.Empty () - ); - } - - var menu = new MenuBar { Menus = items }; - - var tf = new TextField { Y = 2, Width = 10 }; - var top = new Toplevel (); - top.Add (menu, tf); - - Application.Begin (top); - Assert.True (tf.HasFocus); - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu.IsMenuOpen); - Assert.False (tf.HasFocus); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (0), output); - - // Right - Edit has no sub menu; this tests that no sub menu shows - Assert.True (menu._openMenu.NewKeyDownEvent (Key.CursorRight)); - Assert.True (menu.IsMenuOpen); - Assert.False (tf.HasFocus); - Assert.Equal (1, menu._selected); - Assert.Equal (-1, menu._selectedSub); - Assert.Null (menu._openSubMenu); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (1), output); - - // Right - Format - Assert.True (menu._openMenu.NewKeyDownEvent (Key.CursorRight)); - Assert.True (menu.IsMenuOpen); - Assert.False (tf.HasFocus); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (2), output); - - // Left - Edit - Assert.True (menu._openMenu.NewKeyDownEvent (Key.CursorLeft)); - Assert.True (menu.IsMenuOpen); - Assert.False (tf.HasFocus); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (1), output); - - Assert.True (menu._openMenu.NewKeyDownEvent (Key.CursorLeft)); - Assert.True (menu.IsMenuOpen); - Assert.False (tf.HasFocus); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (0), output); - - Assert.True (Application.RaiseKeyDownEvent (menu.Key)); - Assert.False (menu.IsMenuOpen); - Assert.True (tf.HasFocus); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ClosedMenuText, output); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void Parent_MenuItem_Stay_Focused_If_Child_MenuItem_Is_Empty_By_Mouse () - { - // File Edit Format - //┌──────┐ ┌───────┐ - //│ New │ │ Wrap │ - //└──────┘ └───────┘ - - // Define the expected menu - var expectedMenu = new ExpectedMenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }), - new ("Edit", new MenuItem [] { }), - new ( - "Format", - new MenuItem [] { new ("Wrap", "", null) } - ) - ] - }; - - var menu = new MenuBar - { - Menus = - [ - new ( - expectedMenu.Menus [0].Title, - new MenuItem [] { new (expectedMenu.Menus [0].Children [0].Title, "", null) } - ), - new (expectedMenu.Menus [1].Title, new MenuItem [] { }), - new ( - expectedMenu.Menus [2].Title, - new MenuItem [] - { - new ( - expectedMenu.Menus [2].Children [0].Title, - "", - null - ) - } - ) - ] - }; - - var tf = new TextField { Y = 2, Width = 10 }; - var top = new Toplevel (); - top.Add (menu, tf); - Application.Begin (top); - - Assert.True (tf.HasFocus); - Assert.True (menu.NewMouseEvent (new () { Position = new (1, 0), Flags = MouseFlags.Button1Pressed, View = menu })); - Assert.True (menu.IsMenuOpen); - Assert.False (tf.HasFocus); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (0), output); - - Assert.True ( - menu.NewMouseEvent ( - new () { Position = new (8, 0), Flags = MouseFlags.ReportMousePosition, View = menu } - ) - ); - Assert.True (menu.IsMenuOpen); - Assert.False (tf.HasFocus); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (1), output); - - Assert.True ( - menu.NewMouseEvent ( - new () { Position = new (15, 0), Flags = MouseFlags.ReportMousePosition, View = menu } - ) - ); - Assert.True (menu.IsMenuOpen); - Assert.False (tf.HasFocus); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (2), output); - - Assert.True ( - menu.NewMouseEvent ( - new () { Position = new (8, 0), Flags = MouseFlags.ReportMousePosition, View = menu } - ) - ); - Assert.True (menu.IsMenuOpen); - Assert.False (tf.HasFocus); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ClosedMenuText, output); - - Assert.True ( - menu.NewMouseEvent ( - new () { Position = new (1, 0), Flags = MouseFlags.ReportMousePosition, View = menu } - ) - ); - Assert.True (menu.IsMenuOpen); - Assert.False (tf.HasFocus); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ExpectedSubMenuOpen (0), output); - - Assert.True (menu.NewMouseEvent (new () { Position = new (8, 0), Flags = MouseFlags.Button1Pressed, View = menu })); - Assert.False (menu.IsMenuOpen); - Assert.True (tf.HasFocus); - View.SetClipToScreen (); - top.Draw (); - DriverAssert.AssertDriverContentsAre (expectedMenu.ClosedMenuText, output); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - public void RemoveAndThenAddMenuBar_ShouldNotChangeWidth () - { - MenuBar menuBar; - MenuBar menuBar2; - - // TODO: When https: //github.com/gui-cs/Terminal.Gui/issues/3136 is fixed, - // TODO: Change this to Window - var w = new View (); - menuBar2 = new (); - menuBar = new (); - w.Width = Dim.Fill (); - w.Height = Dim.Fill (); - w.X = 0; - w.Y = 0; - - w.Visible = true; - - // TODO: When https: //github.com/gui-cs/Terminal.Gui/issues/3136 is fixed, - // TODO: uncomment this. - //w.Modal = false; - w.Title = ""; - menuBar.Width = Dim.Fill (); - menuBar.Height = 1; - menuBar.X = 0; - menuBar.Y = 0; - menuBar.Visible = true; - w.Add (menuBar); - - menuBar2.Width = Dim.Fill (); - menuBar2.Height = 1; - menuBar2.X = 0; - menuBar2.Y = 4; - menuBar2.Visible = true; - w.Add (menuBar2); - - MenuBar [] menuBars = w.SubViews.OfType ().ToArray (); - Assert.Equal (2, menuBars.Length); - - Assert.Equal (Dim.Fill (), menuBars [0].Width); - Assert.Equal (Dim.Fill (), menuBars [1].Width); - - // Goes wrong here - w.Remove (menuBar); - w.Remove (menuBar2); - - w.Add (menuBar); - w.Add (menuBar2); - - // These assertions fail - Assert.Equal (Dim.Fill (), menuBars [0].Width); - Assert.Equal (Dim.Fill (), menuBars [1].Width); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void Resizing_Close_Menus () - { - var menu = new MenuBar - { - Menus = - [ - new ( - "File", - new MenuItem [] - { - new ( - "Open", - "Open a file", - () => { }, - null, - null, - KeyCode.CtrlMask | KeyCode.O - ) - } - ) - ] - }; - var top = new Toplevel (); - top.Add (menu); - SessionToken rs = Application.Begin (top); - - menu.OpenMenu (); - - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - File -┌────────────────────────────┐ -│ Open Open a file Ctrl+O │ -└────────────────────────────┘", - output - ); - - Application.Driver!.SetScreenSize (20, 15); - - AutoInitShutdownAttribute.RunIteration (); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" - File", - output - ); - - Application.End (rs); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - public void Separator_Does_Not_Throws_Pressing_Menu_Hotkey () - { - var menu = new MenuBar - { - Menus = - [ - new ( - "File", - new MenuItem [] { new ("_New", "", null), null, new ("_Quit", "", null) } - ) - ] - }; - Assert.False (menu.NewKeyDownEvent (Key.Q.WithAlt)); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - public void SetMenus_With_Same_HotKey_Does_Not_Throws () - { - var mb = new MenuBar (); - - var i1 = new MenuBarItem ("_heey", "fff", () => { }, () => true); - - mb.Menus = new [] { i1 }; - mb.Menus = new [] { i1 }; - - Assert.Equal (Key.H, mb.Menus [0].HotKey); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void ShortCut_Activates () - { - var saveAction = false; - - var menu = new MenuBar - { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new ( - "_Save", - "Saves the file.", - () => { saveAction = true; }, - null, - null, - (KeyCode)Key.S.WithCtrl - ) - } - ) - ] - }; - - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - Application.RaiseKeyDownEvent (Key.S.WithCtrl); - AutoInitShutdownAttribute.RunIteration (); - - Assert.True (saveAction); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - public void Update_ShortcutKey_KeyBindings_Old_ShortcutKey_Is_Removed () - { - var menuBar = new MenuBar - { - Menus = - [ - new ( - "_File", - new MenuItem [] - { - new ("New", "Create New", null, null, null, Key.A.WithCtrl) - } - ) - ] - }; - - Assert.True (menuBar.HotKeyBindings.TryGet (Key.A.WithCtrl, out _)); - - menuBar.Menus [0].Children! [0].ShortcutKey = Key.B.WithCtrl; - - Assert.False (menuBar.HotKeyBindings.TryGet (Key.A.WithCtrl, out _)); - Assert.True (menuBar.HotKeyBindings.TryGet (Key.B.WithCtrl, out _)); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - public void UseKeysUpDownAsKeysLeftRight_And_UseSubMenusSingleFrame_Cannot_Be_Both_True () - { - var menu = new MenuBar (); - Assert.False (menu.UseKeysUpDownAsKeysLeftRight); - Assert.False (menu.UseSubMenusSingleFrame); - - menu.UseKeysUpDownAsKeysLeftRight = true; - Assert.True (menu.UseKeysUpDownAsKeysLeftRight); - Assert.False (menu.UseSubMenusSingleFrame); - - menu.UseSubMenusSingleFrame = true; - Assert.False (menu.UseKeysUpDownAsKeysLeftRight); - Assert.True (menu.UseSubMenusSingleFrame); - } - - [Fact (Skip = "#3798 Broke. Will fix in #2975")] - [AutoInitShutdown] - public void UseSubMenusSingleFrame_False_By_Keyboard () - { - var menu = new MenuBar - { - Menus = new MenuBarItem [] - { - new ( - "Numbers", - new MenuItem [] - { - new ("One", "", null), - new MenuBarItem ( - "Two", - new MenuItem [] - { - new ("Sub-Menu 1", "", null), - new ("Sub-Menu 2", "", null) - } - ), - new ("Three", "", null) - } - ) - } - }; - menu.UseKeysUpDownAsKeysLeftRight = true; - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - Assert.Equal (Point.Empty, new (menu.Frame.X, menu.Frame.Y)); - Assert.False (menu.UseSubMenusSingleFrame); - - top.Draw (); - - var expected = @" - Numbers -"; - - Rectangle pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - - Assert.True (menu.NewKeyDownEvent (menu.Key)); - top.Draw (); - - expected = @" - Numbers -┌────────┐ -│ One │ -│ Two ►│ -│ Three │ -└────────┘ -"; - - pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - - Assert.True (Application.Top.SubViews.ElementAt (1).NewKeyDownEvent (Key.CursorDown)); - top.Draw (); - - expected = @" - Numbers -┌────────┐ -│ One │ -│ Two ►│┌─────────────┐ -│ Three ││ Sub-Menu 1 │ -└────────┘│ Sub-Menu 2 │ - └─────────────┘ -"; - - pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - - Assert.True (Application.Top.SubViews.ElementAt (2).NewKeyDownEvent (Key.CursorLeft)); - top.Draw (); - - expected = @" - Numbers -┌────────┐ -│ One │ -│ Two ►│ -│ Three │ -└────────┘ -"; - - pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - - Assert.True (Application.Top.SubViews.ElementAt (1).NewKeyDownEvent (Key.Esc)); - top.Draw (); - - expected = @" - Numbers -"; - - pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - top.Dispose (); - } - - [Fact (Skip = "#3798 Broke. Will fix in #2975")] - [AutoInitShutdown] - public void UseSubMenusSingleFrame_False_By_Mouse () - { - var menu = new MenuBar - { - Menus = - [ - new ( - "Numbers", - new MenuItem [] - { - new ("One", "", null), - new MenuBarItem ( - "Two", - new MenuItem [] - { - new ( - "Sub-Menu 1", - "", - null - ), - new ( - "Sub-Menu 2", - "", - null - ) - } - ), - new ("Three", "", null) - } - ) - ] - }; - - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - Assert.Equal (Point.Empty, new (menu.Frame.X, menu.Frame.Y)); - Assert.False (menu.UseSubMenusSingleFrame); - - top.Draw (); - - var expected = @" - Numbers -"; - - Rectangle pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (1, 0, 8, 1), pos); - - menu.NewMouseEvent ( - new () { Position = new (1, 0), Flags = MouseFlags.Button1Pressed, View = menu } - ); - top.Draw (); - - expected = @" - Numbers -┌────────┐ -│ One │ -│ Two ►│ -│ Three │ -└────────┘ -"; - - pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (1, 0, 10, 6), pos); - - menu.NewMouseEvent ( - new () - { - Position = new (1, 2), Flags = MouseFlags.ReportMousePosition, View = Application.Top.SubViews.ElementAt (1) - } - ); - top.Draw (); - - expected = @" - Numbers -┌────────┐ -│ One │ -│ Two ►│┌─────────────┐ -│ Three ││ Sub-Menu 1 │ -└────────┘│ Sub-Menu 2 │ - └─────────────┘ -"; - - pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (1, 0, 25, 7), pos); - - Assert.False ( - menu.NewMouseEvent ( - new () - { - Position = new (1, 1), Flags = MouseFlags.ReportMousePosition, View = Application.Top.SubViews.ElementAt (1) - } - ) - ); - top.Draw (); - - expected = @" - Numbers -┌────────┐ -│ One │ -│ Two ►│ -│ Three │ -└────────┘ -"; - - pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (1, 0, 10, 6), pos); - - menu.NewMouseEvent ( - new () { Position = new (70, 2), Flags = MouseFlags.Button1Clicked, View = Application.Top } - ); - top.Draw (); - - expected = @" - Numbers -"; - - pos = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - Assert.Equal (new (1, 0, 8, 1), pos); - top.Dispose (); - } - - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void Visible_False_Key_Does_Not_Open_And_Close_All_Opened_Menus () - { - var menu = new MenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }) - ] - }; - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - Assert.True (menu.Visible); - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu.IsMenuOpen); - - menu.Visible = false; - Assert.False (menu.IsMenuOpen); - - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.False (menu.IsMenuOpen); - top.Dispose (); - } - - [Fact (Skip = "v2 fake driver broke. Menu still works; disabling tests.")] - [AutoInitShutdown] - public void CanFocus_True_Key_Esc_Exit_Toplevel_If_IsMenuOpen_False () - { - var menu = new MenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }) - ], - CanFocus = true - }; - var top = new Toplevel (); - top.Add (menu); - Application.Begin (top); - - Assert.True (menu.CanFocus); - Assert.True (menu.NewKeyDownEvent (menu.Key)); - Assert.True (menu.IsMenuOpen); - - Assert.True (menu.NewKeyDownEvent (Key.Esc)); - Assert.False (menu.IsMenuOpen); - - Assert.False (menu.NewKeyDownEvent (Key.Esc)); - Assert.False (menu.IsMenuOpen); - top.Dispose (); - } - - // Defines the expected strings for a Menu. Currently supports - // - MenuBar with any number of MenuItems - // - Each top-level MenuItem can have a SINGLE sub-menu - // - // TODO: Enable multiple sub-menus - // TODO: Enable checked sub-menus - // TODO: Enable sub-menus with sub-menus (perhaps better to put this in a separate class with focused unit tests?) - // - // E.g: - // - // File Edit - // New Copy - public class ExpectedMenuBar : MenuBar - { - - // The expected strings when the menu is closed - public string ClosedMenuText => MenuBarText + "\n"; - - public string ExpectedBottomRow (int i) - { - return $"{Glyphs.LLCorner}{new (Glyphs.HLine.ToString () [0], Menus [i].Children [0].TitleLength + 3)}{Glyphs.LRCorner} \n"; - } - - // The 3 spaces at end are a result of Menu.cs line 1062 where `pos` is calculated (` + spacesAfterTitle`) - public string ExpectedMenuItemRow (int i) { return $"{Glyphs.VLine} {Menus [i].Children [0].Title} {Glyphs.VLine} \n"; } - - // The full expected string for an open sub menu - public string ExpectedSubMenuOpen (int i) - { - return ClosedMenuText - + (Menus [i].Children.Length > 0 - ? ExpectedPadding (i) - + ExpectedTopRow (i) - + ExpectedPadding (i) - + ExpectedMenuItemRow (i) - + ExpectedPadding (i) - + ExpectedBottomRow (i) - : ""); - } - - // Define expected menu frame - // "┌──────┐" - // "│ New │" - // "└──────┘" - // - // The width of the Frame is determined in Menu.cs line 144, where `Width` is calculated - // 1 space before the Title and 2 spaces after the Title/Check/Help - public string ExpectedTopRow (int i) - { - return $"{Glyphs.ULCorner}{new (Glyphs.HLine.ToString () [0], Menus [i].Children [0].TitleLength + 3)}{Glyphs.URCorner} \n"; - } - - // Each MenuBar title has a 1 space pad on each side - // See `static int leftPadding` and `static int rightPadding` on line 1037 of Menu.cs - public string MenuBarText - { - get - { - var txt = string.Empty; - - foreach (MenuBarItem m in Menus) - { - txt += " " + m.Title + " "; - } - - return txt; - } - } - - // Padding for the X of the sub menu Frame - // Menu.cs - Line 1239 in `internal void OpenMenu` is where the Menu is created - private string ExpectedPadding (int i) - { - var n = 0; - - while (i > 0) - { - n += Menus [i - 1].TitleLength + 2; - i--; - } - - return new (' ', n); - } - } - - private class CustomWindow : Window - { - public CustomWindow () - { - var menu = new MenuBar - { - Menus = - [ - new ("File", new MenuItem [] { new ("New", "", null) }), - new ( - "Edit", - new MenuItem [] - { - new MenuBarItem ( - "Delete", - new MenuItem [] - { new ("All", "", null), new ("Selected", "", null) } - ) - } - ) - ] - }; - Add (menu); - } - } -} -#pragma warning restore CS0618 // Type or member is obsolete diff --git a/Tests/UnitTests/Views/Menuv1/Menuv1Tests.cs b/Tests/UnitTests/Views/Menuv1/Menuv1Tests.cs deleted file mode 100644 index 86f8bfc32..000000000 --- a/Tests/UnitTests/Views/Menuv1/Menuv1Tests.cs +++ /dev/null @@ -1,111 +0,0 @@ -using Xunit.Abstractions; - -//using static Terminal.Gui.ViewTests.MenuTests; - -namespace UnitTests.ViewsTests; - -#pragma warning disable CS0618 // Type or member is obsolete -public class Menuv1Tests -{ - private readonly ITestOutputHelper _output; - public Menuv1Tests (ITestOutputHelper output) { _output = output; } - - // TODO: Create more low-level unit tests for Menu and MenuItem - - [Fact] - public void Menu_Constructors_Defaults () - { - Assert.Throws (() => new Menu { Host = null, BarItems = new MenuBarItem () }); - Assert.Throws (() => new Menu { Host = new MenuBar (), BarItems = null }); - - var menu = new Menu { Host = new MenuBar (), X = 0, Y = 0, BarItems = new MenuBarItem () }; - Assert.Empty (menu.Title); - Assert.Empty (menu.Text); - } - - [Fact] - public void MenuItem_Constructors_Defaults () - { - var menuItem = new MenuItem (); - Assert.Equal ("", menuItem.Title); - Assert.Equal ("", menuItem.Help); - Assert.Null (menuItem.Action); - Assert.Null (menuItem.CanExecute); - Assert.Null (menuItem.Parent); - Assert.Equal (Key.Empty, menuItem.ShortcutKey); - - menuItem = new MenuItem ("Test", "Help", Run, () => { return true; }, new MenuItem (), KeyCode.F1); - Assert.Equal ("Test", menuItem.Title); - Assert.Equal ("Help", menuItem.Help); - Assert.Equal (Run, menuItem.Action); - Assert.NotNull (menuItem.CanExecute); - Assert.NotNull (menuItem.Parent); - Assert.Equal (KeyCode.F1, menuItem.ShortcutKey); - - void Run () { } - } - - [Fact] - public void MenuBarItem_SubMenu_Can_Return_Null () - { - var menuItem = new MenuItem (); - var menuBarItem = new MenuBarItem (); - Assert.Null (menuBarItem.SubMenu (menuItem)); - } - - [Fact] - public void MenuBarItem_Constructors_Defaults () - { - var menuBarItem = new MenuBarItem (); - Assert.Equal ("", menuBarItem.Title); - Assert.Equal ("", menuBarItem.Help); - Assert.Null (menuBarItem.Action); - Assert.Null (menuBarItem.CanExecute); - Assert.Null (menuBarItem.Parent); - Assert.Equal (Key.Empty, menuBarItem.ShortcutKey); - Assert.Equal ([], menuBarItem.Children); - Assert.False (menuBarItem.IsTopLevel); - - menuBarItem = new MenuBarItem (null!, null!, Run, () => true, new ()); - Assert.Equal ("", menuBarItem.Title); - Assert.Equal ("", menuBarItem.Help); - Assert.Equal (Run, menuBarItem.Action); - Assert.NotNull (menuBarItem.CanExecute); - Assert.NotNull (menuBarItem.Parent); - Assert.Equal (Key.Empty, menuBarItem.ShortcutKey); - Assert.Null (menuBarItem.Children); - Assert.False (menuBarItem.IsTopLevel); - - menuBarItem = new MenuBarItem (null!, Array.Empty (), new ()); - Assert.Equal ("", menuBarItem.Title); - Assert.Equal ("", menuBarItem.Help); - Assert.Null (menuBarItem.Action); - Assert.Null (menuBarItem.CanExecute); - Assert.NotNull (menuBarItem.Parent); - Assert.Equal (Key.Empty, menuBarItem.ShortcutKey); - Assert.Equal ([], menuBarItem.Children); - Assert.False (menuBarItem.IsTopLevel); - - menuBarItem = new MenuBarItem (null!, new List (), new ()); - Assert.Equal ("", menuBarItem.Title); - Assert.Equal ("", menuBarItem.Help); - Assert.Null (menuBarItem.Action); - Assert.Null (menuBarItem.CanExecute); - Assert.NotNull (menuBarItem.Parent); - Assert.Equal (Key.Empty, menuBarItem.ShortcutKey); - Assert.Equal ([], menuBarItem.Children); - Assert.False (menuBarItem.IsTopLevel); - - menuBarItem = new MenuBarItem ([]); - Assert.Equal ("", menuBarItem.Title); - Assert.Equal ("", menuBarItem.Help); - Assert.Null (menuBarItem.Action); - Assert.Null (menuBarItem.CanExecute); - Assert.Null (menuBarItem.Parent); - Assert.Equal (Key.Empty, menuBarItem.ShortcutKey); - Assert.Equal ([], menuBarItem.Children); - Assert.False (menuBarItem.IsTopLevel); - - void Run () { } - } -} diff --git a/Tests/UnitTests/Views/ProgressBarTests.cs b/Tests/UnitTests/Views/ProgressBarTests.cs index 26b70fe0e..7f4e7b1b7 100644 --- a/Tests/UnitTests/Views/ProgressBarTests.cs +++ b/Tests/UnitTests/Views/ProgressBarTests.cs @@ -26,9 +26,13 @@ public class ProgressBarTests [AutoInitShutdown] public void Fraction_Redraw () { - var driver = Application.Driver; + var driver = ApplicationImpl.Instance.Driver; - var pb = new ProgressBar { Width = 5 }; + var pb = new ProgressBar + { + Driver = driver, + Width = 5 + }; pb.BeginInit (); pb.EndInit (); @@ -37,62 +41,62 @@ public class ProgressBarTests for (var i = 0; i <= pb.Frame.Width; i++) { pb.Fraction += 0.2F; - View.SetClipToScreen (); + pb.SetClipToScreen (); pb.Draw (); if (i == 0) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); } else if (i == 1) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); } else if (i == 2) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); } else if (i == 3) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); } else if (i == 4) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); } else if (i == 5) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); } } } @@ -161,10 +165,11 @@ public class ProgressBarTests [AutoInitShutdown] public void Pulse_Redraw_BidirectionalMarquee_False () { - var driver = Application.Driver; + var driver = ApplicationImpl.Instance.Driver; var pb = new ProgressBar { + Driver = driver, Width = 15, ProgressBarStyle = ProgressBarStyle.MarqueeBlocks, BidirectionalMarquee = false }; @@ -175,692 +180,692 @@ public class ProgressBarTests for (var i = 0; i < 38; i++) { pb.Pulse (); - View.SetClipToScreen (); + pb.SetClipToScreen (); pb.Draw (); if (i == 0) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 1) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 2) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 3) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 4) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 5) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 6) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 7) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 8) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 9) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 10) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 11) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 12) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 13) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 14) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 15) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 16) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 17) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 18) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 19) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 20) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 21) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 22) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 23) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 24) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 25) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 26) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 27) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 28) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 29) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 30) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 31) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 32) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 33) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 34) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 35) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 36) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 37) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } } } @@ -869,9 +874,13 @@ public class ProgressBarTests [AutoInitShutdown] public void Pulse_Redraw_BidirectionalMarquee_True_Default () { - var driver = Application.Driver; + var driver = ApplicationImpl.Instance.Driver; - var pb = new ProgressBar { Width = 15, ProgressBarStyle = ProgressBarStyle.MarqueeBlocks }; + var pb = new ProgressBar + { + Driver = driver, + Width = 15, ProgressBarStyle = ProgressBarStyle.MarqueeBlocks + }; pb.BeginInit (); pb.EndInit (); @@ -880,692 +889,692 @@ public class ProgressBarTests for (var i = 0; i < 38; i++) { pb.Pulse (); - View.SetClipToScreen (); + pb.SetClipToScreen (); pb.Draw (); if (i == 0) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 1) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 2) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 3) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 4) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 5) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 6) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 7) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 8) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 9) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 10) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 11) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 12) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 13) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 14) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 15) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 16) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 17) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 18) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 19) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 20) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 21) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 22) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 14].Grapheme); } else if (i == 23) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 24) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 25) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 26) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 27) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 28) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 29) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 30) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 31) { - Assert.Equal ((Rune)' ', driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 32) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 33) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 34) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 35) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 36) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } else if (i == 37) { - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 0].Rune); - Assert.Equal (Glyphs.BlocksMeterSegment, driver.Contents [0, 1].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 2].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 3].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 4].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 5].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 6].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 7].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 8].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 9].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 10].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 11].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 12].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 13].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 14].Rune); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 0].Grapheme); + Assert.Equal (Glyphs.BlocksMeterSegment.ToString (), driver.Contents [0, 1].Grapheme); + Assert.Equal (" ", driver.Contents [0, 2].Grapheme); + Assert.Equal (" ", driver.Contents [0, 3].Grapheme); + Assert.Equal (" ", driver.Contents [0, 4].Grapheme); + Assert.Equal (" ", driver.Contents [0, 5].Grapheme); + Assert.Equal (" ", driver.Contents [0, 6].Grapheme); + Assert.Equal (" ", driver.Contents [0, 7].Grapheme); + Assert.Equal (" ", driver.Contents [0, 8].Grapheme); + Assert.Equal (" ", driver.Contents [0, 9].Grapheme); + Assert.Equal (" ", driver.Contents [0, 10].Grapheme); + Assert.Equal (" ", driver.Contents [0, 11].Grapheme); + Assert.Equal (" ", driver.Contents [0, 12].Grapheme); + Assert.Equal (" ", driver.Contents [0, 13].Grapheme); + Assert.Equal (" ", driver.Contents [0, 14].Grapheme); } } } diff --git a/Tests/UnitTests/Views/ScrollBarTests.cs b/Tests/UnitTests/Views/ScrollBarTests.cs index 9d0433832..d2cdb838b 100644 --- a/Tests/UnitTests/Views/ScrollBarTests.cs +++ b/Tests/UnitTests/Views/ScrollBarTests.cs @@ -495,6 +495,8 @@ public class ScrollBarTests (ITestOutputHelper output) { var super = new Window { + Driver = ApplicationImpl.Instance.Driver, + Id = "super", Width = width + 2, Height = height + 2, @@ -534,7 +536,7 @@ public class ScrollBarTests (ITestOutputHelper output) [AutoInitShutdown] public void Mouse_Click_DecrementButton_Decrements ([CombinatorialRange (1, 3, 1)] int increment, Orientation orientation) { - var top = new Toplevel () + var top = new Runnable () { Id = "top", Width = 10, @@ -583,7 +585,7 @@ public class ScrollBarTests (ITestOutputHelper output) [AutoInitShutdown] public void Mouse_Click_IncrementButton_Increments ([CombinatorialRange (1, 3, 1)] int increment, Orientation orientation) { - var top = new Toplevel () + var top = new Runnable () { Id = "top", Width = 10, diff --git a/Tests/UnitTests/Views/ScrollSliderTests.cs b/Tests/UnitTests/Views/ScrollSliderTests.cs deleted file mode 100644 index 5397b16b1..000000000 --- a/Tests/UnitTests/Views/ScrollSliderTests.cs +++ /dev/null @@ -1,340 +0,0 @@ -using UnitTests; -using Xunit.Abstractions; - -namespace UnitTests.ViewsTests; - -public class ScrollSliderTests (ITestOutputHelper output) -{ - [Theory] - [SetupFakeApplication] - [InlineData ( - 3, - 10, - 1, - 0, - Orientation.Vertical, - @" -┌───┐ -│███│ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -└───┘")] - [InlineData ( - 10, - 1, - 3, - 0, - Orientation.Horizontal, - @" -┌──────────┐ -│███ │ -└──────────┘")] - [InlineData ( - 3, - 10, - 3, - 0, - Orientation.Vertical, - @" -┌───┐ -│███│ -│███│ -│███│ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -│ │ -└───┘")] - - - - [InlineData ( - 3, - 10, - 5, - 0, - Orientation.Vertical, - @" -┌───┐ -│███│ -│███│ -│███│ -│███│ -│███│ -│ │ -│ │ -│ │ -│ │ -│ │ -└───┘")] - - [InlineData ( - 3, - 10, - 5, - 1, - Orientation.Vertical, - @" -┌───┐ -│ │ -│███│ -│███│ -│███│ -│███│ -│███│ -│ │ -│ │ -│ │ -│ │ -└───┘")] - [InlineData ( - 3, - 10, - 5, - 4, - Orientation.Vertical, - @" -┌───┐ -│ │ -│ │ -│ │ -│ │ -│███│ -│███│ -│███│ -│███│ -│███│ -│ │ -└───┘")] - [InlineData ( - 3, - 10, - 5, - 5, - Orientation.Vertical, - @" -┌───┐ -│ │ -│ │ -│ │ -│ │ -│ │ -│███│ -│███│ -│███│ -│███│ -│███│ -└───┘")] - [InlineData ( - 3, - 10, - 5, - 6, - Orientation.Vertical, - @" -┌───┐ -│ │ -│ │ -│ │ -│ │ -│ │ -│███│ -│███│ -│███│ -│███│ -│███│ -└───┘")] - - [InlineData ( - 3, - 10, - 10, - 0, - Orientation.Vertical, - @" -┌───┐ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -└───┘")] - - [InlineData ( - 3, - 10, - 10, - 5, - Orientation.Vertical, - @" -┌───┐ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -└───┘")] - [InlineData ( - 3, - 10, - 11, - 0, - Orientation.Vertical, - @" -┌───┐ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -│███│ -└───┘")] - - [InlineData ( - 10, - 3, - 5, - 0, - Orientation.Horizontal, - @" -┌──────────┐ -│█████ │ -│█████ │ -│█████ │ -└──────────┘")] - - [InlineData ( - 10, - 3, - 5, - 1, - Orientation.Horizontal, - @" -┌──────────┐ -│ █████ │ -│ █████ │ -│ █████ │ -└──────────┘")] - [InlineData ( - 10, - 3, - 5, - 4, - Orientation.Horizontal, - @" -┌──────────┐ -│ █████ │ -│ █████ │ -│ █████ │ -└──────────┘")] - [InlineData ( - 10, - 3, - 5, - 5, - Orientation.Horizontal, - @" -┌──────────┐ -│ █████│ -│ █████│ -│ █████│ -└──────────┘")] - [InlineData ( - 10, - 3, - 5, - 6, - Orientation.Horizontal, - @" -┌──────────┐ -│ █████│ -│ █████│ -│ █████│ -└──────────┘")] - - [InlineData ( - 10, - 3, - 10, - 0, - Orientation.Horizontal, - @" -┌──────────┐ -│██████████│ -│██████████│ -│██████████│ -└──────────┘")] - - [InlineData ( - 10, - 3, - 10, - 5, - Orientation.Horizontal, - @" -┌──────────┐ -│██████████│ -│██████████│ -│██████████│ -└──────────┘")] - [InlineData ( - 10, - 3, - 11, - 0, - Orientation.Horizontal, - @" -┌──────────┐ -│██████████│ -│██████████│ -│██████████│ -└──────────┘")] - public void Draws_Correctly (int superViewportWidth, int superViewportHeight, int sliderSize, int position, Orientation orientation, string expected) - { - var super = new Window - { - Id = "super", - Width = superViewportWidth + 2, - Height = superViewportHeight + 2 - }; - - var scrollSlider = new ScrollSlider - { - Orientation = orientation, - Size = sliderSize, - //Position = position, - }; - Assert.Equal (sliderSize, scrollSlider.Size); - super.Add (scrollSlider); - scrollSlider.Position = position; - - super.Layout (); - super.Draw (); - - _ = DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - } -} diff --git a/Tests/UnitTests/Views/ShortcutTests.cs b/Tests/UnitTests/Views/ShortcutTests.cs index 09b4e66d1..c517afc96 100644 --- a/Tests/UnitTests/Views/ShortcutTests.cs +++ b/Tests/UnitTests/Views/ShortcutTests.cs @@ -23,7 +23,7 @@ public class ShortcutTests [InlineData (9, 0)] public void MouseClick_Raises_Accepted (int x, int expectedAccepted) { - Application.Top = new (); + Application.Begin (new Runnable ()); var shortcut = new Shortcut { @@ -31,8 +31,8 @@ public class ShortcutTests Text = "0", Title = "C" }; - Application.Top.Add (shortcut); - Application.Top.Layout (); + Application.TopRunnableView.Add (shortcut); + Application.TopRunnableView.Layout (); var accepted = 0; shortcut.Accepting += (s, e) => accepted++; @@ -46,7 +46,7 @@ public class ShortcutTests Assert.Equal (expectedAccepted, accepted); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); Application.ResetState (true); } @@ -74,7 +74,7 @@ public class ShortcutTests int expectedShortcutSelected ) { - Application.Top = new (); + Application.Begin (new Runnable ()); var shortcut = new Shortcut { @@ -93,9 +93,9 @@ public class ShortcutTests var shortcutSelectCount = 0; shortcut.Selecting += (s, e) => { shortcutSelectCount++; }; - Application.Top.Add (shortcut); - Application.Top.SetRelativeLayout (new (100, 100)); - Application.Top.LayoutSubViews (); + Application.TopRunnableView.Add (shortcut); + Application.TopRunnableView.SetRelativeLayout (new (100, 100)); + Application.TopRunnableView.LayoutSubViews (); Application.RaiseMouseEvent ( new () @@ -109,7 +109,7 @@ public class ShortcutTests Assert.Equal (expectedCommandViewAccepted, commandViewAcceptCount); Assert.Equal (expectedCommandViewSelected, commandViewSelectCount); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); Application.ResetState (true); } @@ -130,7 +130,7 @@ public class ShortcutTests [InlineData (9, 0, 0)] public void MouseClick_Button_CommandView_Raises_Shortcut_Accepted (int mouseX, int expectedAccept, int expectedButtonAccept) { - Application.Top = new (); + Application.Begin (new Runnable ()); var shortcut = new Shortcut { @@ -147,9 +147,9 @@ public class ShortcutTests }; var buttonAccepted = 0; shortcut.CommandView.Accepting += (s, e) => { buttonAccepted++; }; - Application.Top.Add (shortcut); - Application.Top.SetRelativeLayout (new (100, 100)); - Application.Top.LayoutSubViews (); + Application.TopRunnableView.Add (shortcut); + Application.TopRunnableView.SetRelativeLayout (new (100, 100)); + Application.TopRunnableView.LayoutSubViews (); var accepted = 0; shortcut.Accepting += (s, e) => { accepted++; }; @@ -164,7 +164,7 @@ public class ShortcutTests Assert.Equal (expectedAccept, accepted); Assert.Equal (expectedButtonAccept, buttonAccepted); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); Application.ResetState (true); } @@ -186,7 +186,7 @@ public class ShortcutTests [InlineData (10, 1, 0)] public void MouseClick_CheckBox_CommandView_Raises_Shortcut_Accepted_Selected_Correctly (int mouseX, int expectedAccepted, int expectedCheckboxAccepted) { - Application.Top = new (); + Application.Begin (new Runnable ()); var shortcut = new Shortcut { @@ -212,9 +212,9 @@ public class ShortcutTests checkboxSelected++; }; - Application.Top.Add (shortcut); - Application.Top.SetRelativeLayout (new (100, 100)); - Application.Top.LayoutSubViews (); + Application.TopRunnableView.Add (shortcut); + Application.TopRunnableView.SetRelativeLayout (new (100, 100)); + Application.TopRunnableView.LayoutSubViews (); var selected = 0; shortcut.Selecting += (s, e) => @@ -241,7 +241,7 @@ public class ShortcutTests Assert.Equal (expectedCheckboxAccepted, checkboxAccepted); Assert.Equal (expectedCheckboxAccepted, checkboxSelected); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); Application.ResetState (true); } @@ -260,7 +260,7 @@ public class ShortcutTests [InlineData (false, KeyCode.F1, 0, 0)] public void KeyDown_Raises_Accepted_Selected (bool canFocus, KeyCode key, int expectedAccept, int expectedSelect) { - Application.Top = new (); + Application.Begin (new Runnable ()); var shortcut = new Shortcut { @@ -269,7 +269,7 @@ public class ShortcutTests Title = "_C", CanFocus = canFocus }; - Application.Top.Add (shortcut); + Application.TopRunnableView.Add (shortcut); shortcut.SetFocus (); Assert.Equal (canFocus, shortcut.HasFocus); @@ -285,61 +285,10 @@ public class ShortcutTests Assert.Equal (expectedAccept, accepted); Assert.Equal (expectedSelect, selected); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); Application.ResetState (true); } - - [Theory] - [InlineData (true, KeyCode.A, 1, 1)] - [InlineData (true, KeyCode.C, 1, 1)] - [InlineData (true, KeyCode.C | KeyCode.AltMask, 1, 1)] - [InlineData (true, KeyCode.Enter, 1, 1)] - [InlineData (true, KeyCode.Space, 1, 1)] - [InlineData (true, KeyCode.F1, 0, 0)] - [InlineData (false, KeyCode.A, 1, 1)] - [InlineData (false, KeyCode.C, 1, 1)] - [InlineData (false, KeyCode.C | KeyCode.AltMask, 1, 1)] - [InlineData (false, KeyCode.Enter, 0, 0)] - [InlineData (false, KeyCode.Space, 0, 0)] - [InlineData (false, KeyCode.F1, 0, 0)] - public void KeyDown_CheckBox_Raises_Accepted_Selected (bool canFocus, KeyCode key, int expectedAccept, int expectedSelect) - { - Application.Top = new (); - - var shortcut = new Shortcut - { - Key = Key.A, - Text = "0", - CommandView = new CheckBox () - { - Title = "_C" - }, - CanFocus = canFocus - }; - Application.Top.Add (shortcut); - shortcut.SetFocus (); - - Assert.Equal (canFocus, shortcut.HasFocus); - - var accepted = 0; - shortcut.Accepting += (s, e) => - { - accepted++; - e.Handled = true; - }; - - var selected = 0; - shortcut.Selecting += (s, e) => selected++; - - Application.RaiseKeyDownEvent (key); - - Assert.Equal (expectedAccept, accepted); - Assert.Equal (expectedSelect, selected); - - Application.Top.Dispose (); - Application.ResetState (true); - } [Theory] [InlineData (KeyCode.A, 1)] [InlineData (KeyCode.C, 1)] @@ -349,17 +298,17 @@ public class ShortcutTests [InlineData (KeyCode.F1, 0)] public void KeyDown_App_Scope_Invokes_Accept (KeyCode key, int expectedAccept) { - Application.Top = new (); + Application.Begin (new Runnable ()); var shortcut = new Shortcut { Key = Key.A, - BindKeyToApplication = true, Text = "0", Title = "_C" }; - Application.Top.Add (shortcut); - Application.Top.SetFocus (); + Application.TopRunnableView.Add (shortcut); + shortcut.BindKeyToApplication = true; + Application.TopRunnableView.SetFocus (); var accepted = 0; shortcut.Accepting += (s, e) => accepted++; @@ -368,7 +317,7 @@ public class ShortcutTests Assert.Equal (expectedAccept, accepted); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); Application.ResetState (true); } @@ -388,7 +337,7 @@ public class ShortcutTests [AutoInitShutdown] public void KeyDown_Invokes_Action (bool canFocus, KeyCode key, int expectedAction) { - var current = new Toplevel (); + var current = new Runnable (); var shortcut = new Shortcut { @@ -427,19 +376,21 @@ public class ShortcutTests [InlineData (false, KeyCode.F1, 0)] public void KeyDown_App_Scope_Invokes_Action (bool canFocus, KeyCode key, int expectedAction) { - Application.Top = new (); + Application.Begin (new Runnable ()); var shortcut = new Shortcut { - Key = Key.A, + App = ApplicationImpl.Instance, // HACK: Move to Parallel and get rid of this BindKeyToApplication = true, + Key = Key.A, Text = "0", Title = "_C", - CanFocus = canFocus + CanFocus = canFocus, }; - Application.Top.Add (shortcut); - Application.Top.SetFocus (); + Application.TopRunnableView.Add (shortcut); + + Application.TopRunnableView.SetFocus (); var action = 0; shortcut.Action += () => action++; @@ -448,7 +399,7 @@ public class ShortcutTests Assert.Equal (expectedAction, action); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); Application.ResetState (true); } @@ -456,11 +407,11 @@ public class ShortcutTests [Fact] public void Scheme_SetScheme_Does_Not_Fault_3664 () { - Application.Top = new (); - Application.Navigation = new (); + Application.Begin (new Runnable ()); + var shortcut = new Shortcut (); - Application.Top.SetScheme (null); + Application.TopRunnableView.SetScheme (null); Assert.False (shortcut.HasScheme); Assert.NotNull (shortcut.GetScheme ()); @@ -470,7 +421,7 @@ public class ShortcutTests Assert.False (shortcut.HasScheme); Assert.NotNull (shortcut.GetScheme ()); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); Application.ResetState (); } } diff --git a/Tests/UnitTests/Views/SpinnerViewTests.cs b/Tests/UnitTests/Views/SpinnerViewTests.cs index f68b96b0a..abcecf470 100644 --- a/Tests/UnitTests/Views/SpinnerViewTests.cs +++ b/Tests/UnitTests/Views/SpinnerViewTests.cs @@ -40,7 +40,7 @@ public class SpinnerViewTests (ITestOutputHelper output) // Dispose clears timeout view.Dispose (); Assert.Empty (Application.TimedEvents.Timeouts); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -57,12 +57,12 @@ public class SpinnerViewTests (ITestOutputHelper output) DriverAssert.AssertDriverContentsWithFrameAre (expected, output); view.AdvanceAnimation (); - View.SetClipToScreen (); + view.SetClipToScreen (); view.Draw (); expected = "/"; DriverAssert.AssertDriverContentsWithFrameAre (expected, output); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -95,14 +95,14 @@ public class SpinnerViewTests (ITestOutputHelper output) //expected = "|"; //DriverAsserts.AssertDriverContentsWithFrameAre (expected, output); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } private SpinnerView GetSpinnerView () { var view = new SpinnerView (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (view); Application.Begin (top); diff --git a/Tests/UnitTests/Views/StatusBarTests.cs b/Tests/UnitTests/Views/StatusBarTests.cs index c19e99a95..9e39707e5 100644 --- a/Tests/UnitTests/Views/StatusBarTests.cs +++ b/Tests/UnitTests/Views/StatusBarTests.cs @@ -1,5 +1,4 @@ -using UnitTests; -using Xunit.Abstractions; +#nullable enable namespace UnitTests.ViewsTests; public class StatusBarTests @@ -21,7 +20,7 @@ public class StatusBarTests Assert.Equal ("Close", sb.SubViews.ElementAt (2).Title); Assert.Equal ("Quit", sb.SubViews.ToArray () [^1].Title); - Assert.Equal ("Save", sb.RemoveShortcut (1).Title); + Assert.Equal ("Save", sb.RemoveShortcut (1)!.Title); Assert.Equal ("Open", sb.SubViews.ElementAt (0).Title); Assert.Equal ("Close", sb.SubViews.ElementAt (1).Title); @@ -57,7 +56,7 @@ public class StatusBarTests // ) // } // ); - // Toplevel top = new (); + // Runnable top = new (); // top.Add (statusBar); // bool CanExecuteNew () { return win == null; } @@ -101,12 +100,12 @@ public class StatusBarTests var iteration = 0; Application.Iteration += OnApplicationOnIteration; - Application.Run ().Dispose (); + Application.Run (); Application.Iteration -= OnApplicationOnIteration; return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object? s, EventArgs a) { if (iteration == 0) { diff --git a/Tests/UnitTests/Views/TabViewTests.cs b/Tests/UnitTests/Views/TabViewTests.cs index 746f0307d..f4cf528db 100644 --- a/Tests/UnitTests/Views/TabViewTests.cs +++ b/Tests/UnitTests/Views/TabViewTests.cs @@ -119,7 +119,7 @@ public class TabViewTests (ITestOutputHelper output) tv.TabClicked += (s, e) => { clicked = e.Tab; }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); @@ -211,7 +211,7 @@ public class TabViewTests (ITestOutputHelper output) newChanged = e.NewTab; }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); @@ -301,7 +301,7 @@ public class TabViewTests (ITestOutputHelper output) newChanged = e.NewTab; }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); @@ -369,7 +369,7 @@ public class TabViewTests (ITestOutputHelper output) Text = "Ok" }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv, btn); Application.Begin (top); @@ -406,7 +406,7 @@ public class TabViewTests (ITestOutputHelper output) Assert.Equal (tv, top.Focused); Assert.Equal (tv.MostFocused, top.Focused.MostFocused); - // Press the cursor down key. Since the selected tab has no focusable views, the focus should move to the next view in the toplevel + // Press the cursor down key. Since the selected tab has no focusable views, the focus should move to the next view in the runnable Assert.True (Application.RaiseKeyDownEvent (Key.CursorDown)); Assert.Equal (tab2, tv.SelectedTab); Assert.Equal (btn, top.MostFocused); @@ -448,7 +448,7 @@ public class TabViewTests (ITestOutputHelper output) Assert.True (Application.RaiseKeyDownEvent (Key.CursorDown)); Assert.Equal (btn, top.MostFocused); - // Press the cursor down key again will focus next view in the toplevel, which is the TabView + // Press the cursor down key again will focus next view in the runnable, which is the TabView Assert.True (Application.RaiseKeyDownEvent (Key.CursorDown)); Assert.Equal (tab2, tv.SelectedTab); Assert.Equal (tv, top.Focused); @@ -664,7 +664,7 @@ public class TabViewTests (ITestOutputHelper output) Assert.Equal (tab2, tv.SubViews.First (v => v.Id.Contains ("tabRow")).MostFocused); tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -683,7 +683,7 @@ public class TabViewTests (ITestOutputHelper output) tab1.DisplayText = "12345678910"; tab2.DisplayText = "13"; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -700,7 +700,7 @@ public class TabViewTests (ITestOutputHelper output) tv.SelectedTab = tab2; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -717,7 +717,7 @@ public class TabViewTests (ITestOutputHelper output) tab2.DisplayText = "abcdefghijklmnopq"; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -810,7 +810,7 @@ public class TabViewTests (ITestOutputHelper output) Assert.Equal (tab2, tv.SubViews.First (v => v.Id.Contains ("tabRow")).MostFocused); tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -830,7 +830,7 @@ public class TabViewTests (ITestOutputHelper output) tab2.DisplayText = "13"; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -847,7 +847,7 @@ public class TabViewTests (ITestOutputHelper output) tv.SelectedTab = tab2; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -865,7 +865,7 @@ public class TabViewTests (ITestOutputHelper output) tab2.DisplayText = "abcdefghijklmnopq"; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -910,7 +910,7 @@ public class TabViewTests (ITestOutputHelper output) tv.Height = 5; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -952,7 +952,7 @@ public class TabViewTests (ITestOutputHelper output) tv.SelectedTab = tab2; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -972,7 +972,7 @@ public class TabViewTests (ITestOutputHelper output) tab2.DisplayText = "13"; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -989,7 +989,7 @@ public class TabViewTests (ITestOutputHelper output) tv.SelectedTab = tab2; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1007,7 +1007,7 @@ public class TabViewTests (ITestOutputHelper output) tab2.DisplayText = "abcdefghijklmnopq"; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1049,7 +1049,7 @@ public class TabViewTests (ITestOutputHelper output) tv.SelectedTab = tab2; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1144,7 +1144,7 @@ public class TabViewTests (ITestOutputHelper output) tab2.DisplayText = "13"; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1161,7 +1161,7 @@ public class TabViewTests (ITestOutputHelper output) tv.SelectedTab = tab2; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1179,7 +1179,7 @@ public class TabViewTests (ITestOutputHelper output) tab2.DisplayText = "abcdefghijklmnopq"; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1223,7 +1223,7 @@ public class TabViewTests (ITestOutputHelper output) tv.SelectedTab = tab2; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1337,7 +1337,7 @@ public class TabViewTests (ITestOutputHelper output) tv.SelectedTab = tab2; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1354,7 +1354,7 @@ public class TabViewTests (ITestOutputHelper output) tv.SelectedTab = tab3; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1404,7 +1404,7 @@ public class TabViewTests (ITestOutputHelper output) tv.SelectedTab = tab2; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1421,7 +1421,7 @@ public class TabViewTests (ITestOutputHelper output) tv.SelectedTab = tab3; tv.Layout (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1445,7 +1445,7 @@ public class TabViewTests (ITestOutputHelper output) tv.Width = 20; tv.Height = 5; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -1465,7 +1465,7 @@ public class TabViewTests (ITestOutputHelper output) tv.Width = 20; tv.Height = 5; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -1489,7 +1489,11 @@ public class TabViewTests (ITestOutputHelper output) private TabView GetTabView (out Tab tab1, out Tab tab2) { - var tv = new TabView () { Id = "tv " }; + var tv = new TabView () + { + Driver = ApplicationImpl.Instance.Driver, + Id = "tv " + }; tv.BeginInit (); tv.EndInit (); //tv.Scheme = new (); diff --git a/Tests/UnitTests/Views/TableViewTests.cs b/Tests/UnitTests/Views/TableViewTests.cs index 885bb435a..791501a08 100644 --- a/Tests/UnitTests/Views/TableViewTests.cs +++ b/Tests/UnitTests/Views/TableViewTests.cs @@ -25,39 +25,43 @@ public class TableViewTests (ITestOutputHelper output) public static DataTableSource BuildTable (int cols, int rows) { return BuildTable (cols, rows, out _); } - /// Builds a simple table of string columns with the requested number of columns and rows - /// - /// - /// - public static DataTableSource BuildTable (int cols, int rows, out DataTable dt) - { - dt = new (); - - for (var c = 0; c < cols; c++) + /// Builds a simple table of string columns with the requested number of columns and rows + /// + /// + /// + public static DataTableSource BuildTable (int cols, int rows, out DataTable dt) { - dt.Columns.Add ("Col" + c); - } - - for (var r = 0; r < rows; r++) - { - DataRow newRow = dt.NewRow (); + dt = new (); for (var c = 0; c < cols; c++) { - newRow [c] = $"R{r}C{c}"; + dt.Columns.Add ("Col" + c); } - dt.Rows.Add (newRow); - } + for (var r = 0; r < rows; r++) + { + DataRow newRow = dt.NewRow (); - return new (dt); - } + for (var c = 0; c < cols; c++) + { + newRow [c] = $"R{r}C{c}"; + } + + dt.Rows.Add (newRow); + } + + return new (dt); + } [Fact] [AutoInitShutdown] public void CellEventsBackgroundFill () { - var tv = new TableView { Width = 20, Height = 4 }; + var tv = new TableView + { + App = ApplicationImpl.Instance, + Width = 20, Height = 4 + }; var dt = new DataTable (); dt.Columns.Add ("C1"); @@ -415,11 +419,11 @@ public class TableViewTests (ITestOutputHelper output) { var tableView = new TableView (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (tableView); SessionToken rs = Application.Begin (top); - tableView.SchemeName = "TopLevel"; + tableView.SchemeName = "Runnable"; // 25 characters can be printed into table tableView.Viewport = new (0, 0, 25, 5); @@ -606,7 +610,7 @@ public class TableViewTests (ITestOutputHelper output) tableView.Style.AlwaysShowHeaders = false; // ensure that TableView has the input focus - var top = new Toplevel (); + var top = new Runnable (); top.Add (tableView); Application.Begin (top); @@ -677,11 +681,14 @@ public class TableViewTests (ITestOutputHelper output) [SetupFakeApplication] public void ScrollIndicators () { - var tableView = new TableView (); + var tableView = new TableView () + { + App = ApplicationImpl.Instance + }; tableView.BeginInit (); tableView.EndInit (); - tableView.SchemeName = "TopLevel"; + tableView.SchemeName = "Runnable"; // 3 columns are visibile tableView.Viewport = new (0, 0, 7, 5); @@ -722,7 +729,7 @@ public class TableViewTests (ITestOutputHelper output) // since A is now pushed off screen we get indicator showing // that user can scroll left to see first column - View.SetClipToScreen (); + tableView.SetClipToScreen (); tableView.Draw (); expected = @@ -737,7 +744,7 @@ public class TableViewTests (ITestOutputHelper output) tableView.NewKeyDownEvent (new () { KeyCode = KeyCode.CursorRight }); tableView.NewKeyDownEvent (new () { KeyCode = KeyCode.CursorRight }); - View.SetClipToScreen (); + tableView.SetClipToScreen (); tableView.Draw (); expected = @@ -756,11 +763,14 @@ public class TableViewTests (ITestOutputHelper output) [SetupFakeApplication] public void ScrollRight_SmoothScrolling () { - var tableView = new TableView (); + var tableView = new TableView () + { + App = ApplicationImpl.Instance + }; tableView.BeginInit (); tableView.EndInit (); - tableView.SchemeName = "TopLevel"; + tableView.SchemeName = "Runnable"; tableView.LayoutSubViews (); // 3 columns are visibile @@ -796,7 +806,7 @@ public class TableViewTests (ITestOutputHelper output) // Scroll right tableView.NewKeyDownEvent (new () { KeyCode = KeyCode.CursorRight }); - View.SetClipToScreen (); + tableView.SetClipToScreen (); tableView.Draw (); // Note that with SmoothHorizontalScrolling only a single new column @@ -818,10 +828,14 @@ public class TableViewTests (ITestOutputHelper output) [SetupFakeApplication] public void ScrollRight_WithoutSmoothScrolling () { - var tableView = new TableView (); + var tableView = new TableView () + { + App = ApplicationImpl.Instance + }; + tableView.BeginInit (); tableView.EndInit (); - tableView.SchemeName = "TopLevel"; + tableView.SchemeName = "Runnable"; // 3 columns are visibile tableView.Viewport = new (0, 0, 7, 5); @@ -844,7 +858,7 @@ public class TableViewTests (ITestOutputHelper output) // select last visible column tableView.SelectedColumn = 2; // column C - View.SetClipToScreen (); + tableView.SetClipToScreen (); tableView.Draw (); var expected = @@ -856,7 +870,7 @@ public class TableViewTests (ITestOutputHelper output) // Scroll right tableView.NewKeyDownEvent (new () { KeyCode = KeyCode.CursorRight }); - View.SetClipToScreen (); + tableView.SetClipToScreen (); tableView.Draw (); // notice that without smooth scrolling we just update the first column @@ -935,7 +949,7 @@ public class TableViewTests (ITestOutputHelper output) { TableView tableView = GetABCDEFTableView (out _); - tableView.SchemeName = "TopLevel"; + tableView.SchemeName = "Runnable"; // 3 columns are visibile tableView.Viewport = new (0, 0, 7, 5); @@ -966,7 +980,7 @@ public class TableViewTests (ITestOutputHelper output) { TableView tableView = GetABCDEFTableView (out _); - tableView.SchemeName = "TopLevel"; + tableView.SchemeName = "Runnable"; // 3 columns are visibile tableView.Viewport = new (0, 0, 7, 5); @@ -998,7 +1012,7 @@ public class TableViewTests (ITestOutputHelper output) var tv = new TableView (BuildTable (1, 1)); tv.CellActivated += (s, c) => activatedValue = c.Table [c.Row, c.Col].ToString (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); @@ -1059,7 +1073,7 @@ public class TableViewTests (ITestOutputHelper output) bStyle.ColorGetter = a => Convert.ToInt32 (a.CellValue) == 2 ? cellHighlight : null; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); SessionToken rs = Application.Begin (top); @@ -1155,7 +1169,7 @@ public class TableViewTests (ITestOutputHelper output) // when B is 2 use the custom highlight color for the row tv.Style.RowColorGetter += e => Convert.ToInt32 (e.Table [e.RowIndex, 1]) == 2 ? rowHighlight : null; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); SessionToken rs = Application.Begin (top); @@ -1236,7 +1250,7 @@ public class TableViewTests (ITestOutputHelper output) // width exactly matches the max col widths tv.Viewport = new (0, 0, 5, 4); - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); @@ -1563,8 +1577,11 @@ public class TableViewTests (ITestOutputHelper output) [AutoInitShutdown] public void Test_CollectionNavigator () { - var tv = new TableView (); - tv.SchemeName = "TopLevel"; + var tv = new TableView () + { + App = ApplicationImpl.Instance + }; + tv.SchemeName = "Runnable"; tv.Viewport = new (0, 0, 50, 7); tv.Table = new EnumerableTableSource ( @@ -1602,7 +1619,7 @@ public class TableViewTests (ITestOutputHelper output) Assert.Equal (0, tv.SelectedRow); // ensure that TableView has the input focus - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); @@ -1974,7 +1991,7 @@ public class TableViewTests (ITestOutputHelper output) ◄─┼─┼─┤ │2│3│4│"; tableView.SetNeedsDraw (); - View.SetClipToScreen (); + tableView.SetClipToScreen (); tableView.Draw (); DriverAssert.AssertDriverContentsAre (expected, output); @@ -1988,7 +2005,7 @@ public class TableViewTests (ITestOutputHelper output) ├─┼─┼─┤ │2│3│4│"; tableView.SetNeedsDraw (); - View.SetClipToScreen (); + tableView.SetClipToScreen (); tableView.Draw (); DriverAssert.AssertDriverContentsAre (expected, output); @@ -2004,7 +2021,7 @@ public class TableViewTests (ITestOutputHelper output) tableView.Style.ShowHorizontalHeaderUnderline = true; tableView.LayoutSubViews (); tableView.SetNeedsDraw (); - View.SetClipToScreen (); + tableView.SetClipToScreen (); tableView.Draw (); // normally we should have scroll indicators because DEF are of screen @@ -2027,7 +2044,7 @@ public class TableViewTests (ITestOutputHelper output) ├─┼─┼─┤ │1│2│3│"; tableView.SetNeedsDraw (); - View.SetClipToScreen (); + tableView.SetClipToScreen (); tableView.Draw (); DriverAssert.AssertDriverContentsAre (expected, output); } @@ -2206,9 +2223,12 @@ public class TableViewTests (ITestOutputHelper output) [SetupFakeApplication] public void TestEnumerableDataSource_BasicTypes () { - Application.Driver!.SetScreenSize (100, 100); - var tv = new TableView (); - tv.SchemeName = "TopLevel"; + ApplicationImpl.Instance.Driver!.SetScreenSize (100, 100); + var tv = new TableView () + { + App = ApplicationImpl.Instance + }; + tv.SchemeName = "Runnable"; tv.Viewport = new (0, 0, 50, 6); tv.Table = new EnumerableTableSource ( @@ -2411,10 +2431,13 @@ A B C { IList list = BuildList (16); - var tv = new TableView (); + var tv = new TableView () + { + App = ApplicationImpl.Instance + }; //tv.BeginInit (); tv.EndInit (); - tv.SchemeName = "TopLevel"; + tv.SchemeName = "Runnable"; tv.Viewport = new (0, 0, 25, 4); tv.Style = new () @@ -2600,7 +2623,7 @@ A B C Assert.True (pets.First ().IsPicked); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -2620,7 +2643,7 @@ A B C Assert.True (pets.ElementAt (0).IsPicked); Assert.True (pets.ElementAt (1).IsPicked); Assert.False (pets.ElementAt (2).IsPicked); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -2640,7 +2663,7 @@ A B C Assert.False (pets.ElementAt (0).IsPicked); Assert.True (pets.ElementAt (1).IsPicked); Assert.False (pets.ElementAt (2).IsPicked); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -2668,7 +2691,7 @@ A B C wrapper.CheckedRows.Add (0); wrapper.CheckedRows.Add (2); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); var expected = @@ -2692,7 +2715,7 @@ A B C Assert.Contains (2, wrapper.CheckedRows); Assert.Equal (3, wrapper.CheckedRows.Count); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -2708,7 +2731,7 @@ A B C // Untoggle the top 2 tv.NewKeyDownEvent (Key.Space); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -2737,7 +2760,7 @@ A B C tv.NewKeyDownEvent (Key.A.WithCtrl); tv.NewKeyDownEvent (Key.Space); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); var expected = @@ -2757,7 +2780,7 @@ A B C // Untoggle all again tv.NewKeyDownEvent (Key.Space); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -2798,7 +2821,7 @@ A B C Assert.True (pets.All (p => p.IsPicked)); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); var expected = @@ -2818,7 +2841,7 @@ A B C Assert.Empty (pets.Where (p => p.IsPicked)); #pragma warning restore xUnit2029 - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -2845,7 +2868,7 @@ A B C var wrapper = new CheckBoxTableSourceWrapperByIndex (tv, tv.Table); tv.Table = wrapper; - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); var expected = @@ -2865,7 +2888,7 @@ A B C Assert.Single (wrapper.CheckedRows, 0); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -2885,7 +2908,7 @@ A B C Assert.Contains (1, wrapper.CheckedRows); Assert.Equal (2, wrapper.CheckedRows.Count); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -2904,7 +2927,7 @@ A B C Assert.Single (wrapper.CheckedRows, 1); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -2936,7 +2959,7 @@ A B C wrapper.UseRadioButtons = true; tv.Table = wrapper; - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); var expected = @@ -2959,7 +2982,7 @@ A B C Assert.True (pets.First ().IsPicked); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -2980,7 +3003,7 @@ A B C Assert.True (pets.ElementAt (1).IsPicked); Assert.False (pets.ElementAt (2).IsPicked); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -3001,7 +3024,7 @@ A B C Assert.False (pets.ElementAt (1).IsPicked); Assert.False (pets.ElementAt (2).IsPicked); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -3224,141 +3247,6 @@ A B C Assert.Equal ("Column Name 2", cn [1]); } - [Fact] - public void CanTabOutOfTableViewUsingCursor_Left () - { - GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2); - - // Make the selected cell one in - tableView.SelectedColumn = 1; - - // Pressing left should move us to the first column without changing focus - Application.RaiseKeyDownEvent (Key.CursorLeft); - Assert.Same (tableView, Application.Top!.MostFocused); - Assert.True (tableView.HasFocus); - - // Because we are now on the leftmost cell a further left press should move focus - Application.RaiseKeyDownEvent (Key.CursorLeft); - - Assert.NotSame (tableView, Application.Top.MostFocused); - Assert.False (tableView.HasFocus); - - Assert.Same (tf1, Application.Top.MostFocused); - Assert.True (tf1.HasFocus); - - Application.Top.Dispose (); - } - - [Fact] - public void CanTabOutOfTableViewUsingCursor_Up () - { - GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2); - - // Make the selected cell one in - tableView.SelectedRow = 1; - - // First press should move us up - Application.RaiseKeyDownEvent (Key.CursorUp); - Assert.Same (tableView, Application.Top!.MostFocused); - Assert.True (tableView.HasFocus); - - // Because we are now on the top row a further press should move focus - Application.RaiseKeyDownEvent (Key.CursorUp); - - Assert.NotSame (tableView, Application.Top.MostFocused); - Assert.False (tableView.HasFocus); - - Assert.Same (tf1, Application.Top.MostFocused); - Assert.True (tf1.HasFocus); - - Application.Top.Dispose (); - } - - [Fact] - public void CanTabOutOfTableViewUsingCursor_Right () - { - GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2); - - // Make the selected cell one in from the rightmost column - tableView.SelectedColumn = tableView.Table.Columns - 2; - - // First press should move us to the rightmost column without changing focus - Application.RaiseKeyDownEvent (Key.CursorRight); - Assert.Same (tableView, Application.Top!.MostFocused); - Assert.True (tableView.HasFocus); - - // Because we are now on the rightmost cell, a further right press should move focus - Application.RaiseKeyDownEvent (Key.CursorRight); - - Assert.NotSame (tableView, Application.Top.MostFocused); - Assert.False (tableView.HasFocus); - - Assert.Same (tf2, Application.Top.MostFocused); - Assert.True (tf2.HasFocus); - - Application.Top.Dispose (); - } - - [Fact] - public void CanTabOutOfTableViewUsingCursor_Down () - { - GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2); - - // Make the selected cell one in from the bottommost row - tableView.SelectedRow = tableView.Table.Rows - 2; - - // First press should move us to the bottommost row without changing focus - Application.RaiseKeyDownEvent (Key.CursorDown); - Assert.Same (tableView, Application.Top!.MostFocused); - Assert.True (tableView.HasFocus); - - // Because we are now on the bottommost cell, a further down press should move focus - Application.RaiseKeyDownEvent (Key.CursorDown); - - Assert.NotSame (tableView, Application.Top.MostFocused); - Assert.False (tableView.HasFocus); - - Assert.Same (tf2, Application.Top.MostFocused); - Assert.True (tf2.HasFocus); - - Application.Top.Dispose (); - } - - [Fact] - public void CanTabOutOfTableViewUsingCursor_Left_ClearsSelectionFirst () - { - GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2); - - // Make the selected cell one in - tableView.SelectedColumn = 1; - - // Pressing shift-left should give us a multi selection - Application.RaiseKeyDownEvent (Key.CursorLeft.WithShift); - Assert.Same (tableView, Application.Top!.MostFocused); - Assert.True (tableView.HasFocus); - Assert.Equal (2, tableView.GetAllSelectedCells ().Count ()); - - // Because we are now on the leftmost cell a further left press would normally move focus - // However there is an ongoing selection so instead the operation clears the selection and - // gets swallowed (not resulting in a focus change) - Application.RaiseKeyDownEvent (Key.CursorLeft); - - // Selection 'clears' just to the single cell and we remain focused - Assert.Single (tableView.GetAllSelectedCells ()); - Assert.Same (tableView, Application.Top.MostFocused); - Assert.True (tableView.HasFocus); - - // A further left will switch focus - Application.RaiseKeyDownEvent (Key.CursorLeft); - - Assert.NotSame (tableView, Application.Top.MostFocused); - Assert.False (tableView.HasFocus); - - Assert.Same (tf1, Application.Top.MostFocused); - Assert.True (tf1.HasFocus); - - Application.Top.Dispose (); - } [Theory] [InlineData (true, 0, 1)] @@ -3383,44 +3271,16 @@ A B C Assert.Equal (expectedRow, tableView.CollectionNavigator.GetNextMatchingItem (0, "3".ToCharArray () [0])); } - /// - /// Creates 3 views on with the focus in the - /// . This is a helper method to setup tests that want to - /// explore moving input focus out of a tableview. - /// - /// - /// - /// - private void GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2) - { - tableView = new (); - tableView.BeginInit (); - tableView.EndInit (); - - Application.Navigation = new (); - Application.Top = new (); - tf1 = new (); - tf2 = new (); - Application.Top.Add (tf1); - Application.Top.Add (tableView); - Application.Top.Add (tf2); - - tableView.SetFocus (); - - Assert.Same (tableView, Application.Top.MostFocused); - Assert.True (tableView.HasFocus); - - // Set big table - tableView.Table = BuildTable (25, 50); - } - private TableView GetABCDEFTableView (out DataTable dt) { - var tableView = new TableView (); + var tableView = new TableView () + { + App = ApplicationImpl.Instance + }; tableView.BeginInit (); tableView.EndInit (); - tableView.SchemeName = "TopLevel"; + tableView.SchemeName = "Runnable"; // 3 columns are visible tableView.Viewport = new (0, 0, 7, 5); @@ -3445,9 +3305,12 @@ A B C private TableView GetPetTable (out EnumerableTableSource source) { - var tv = new TableView (); - tv.SchemeName = "TopLevel"; - tv.Viewport = new (0, 0, 25, 6); + var tv = new TableView () + { + App = ApplicationImpl.Instance, + SchemeName = "Runnable", + Viewport = new (0, 0, 25, 6) + }; List pets = new () { @@ -3473,8 +3336,11 @@ A B C private TableView GetTwoRowSixColumnTable (out DataTable dt) { - var tableView = new TableView (); - tableView.SchemeName = "TopLevel"; + var tableView = new TableView () + { + App = ApplicationImpl.Instance + }; + tableView.SchemeName = "Runnable"; // 3 columns are visible tableView.Viewport = new (0, 0, 7, 5); @@ -3503,7 +3369,10 @@ A B C private TableView SetUpMiniTable (out DataTable dt) { - var tv = new TableView (); + var tv = new TableView () + { + App = ApplicationImpl.Instance + }; tv.BeginInit (); tv.EndInit (); tv.Viewport = new (0, 0, 10, 4); diff --git a/Tests/UnitTests/Views/TextFieldTests.cs b/Tests/UnitTests/Views/TextFieldTests.cs index b4d27b93b..1207a9ae0 100644 --- a/Tests/UnitTests/Views/TextFieldTests.cs +++ b/Tests/UnitTests/Views/TextFieldTests.cs @@ -15,7 +15,7 @@ public class TextFieldTests (ITestOutputHelper output) [TextFieldTestsAutoInitShutdown] public void CanFocus_False_Wont_Focus_With_Mouse () { - Toplevel top = new (); + Runnable top = new (); var tf = new TextField { Width = Dim.Fill (), CanFocus = false, ReadOnly = true, Text = "some text" }; var fv = new FrameView @@ -84,7 +84,7 @@ public class TextFieldTests (ITestOutputHelper output) tf.Draw (); DriverAssert.AssertDriverContentsAre (expectedRender, output); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -95,6 +95,7 @@ public class TextFieldTests (ITestOutputHelper output) Assert.Equal (11, caption.Length); Assert.Equal (10, caption.EnumerateRunes ().Sum (c => c.GetColumns ())); + Assert.Equal (10, caption.GetColumns ()); TextField tf = GetTextFieldsInView (); @@ -104,7 +105,7 @@ public class TextFieldTests (ITestOutputHelper output) tf.Draw (); DriverAssert.AssertDriverContentsAre ("Misérables", output); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Theory (Skip = "Broke with ContextMenuv2")] @@ -123,16 +124,16 @@ public class TextFieldTests (ITestOutputHelper output) // Caption should appear when not focused and no text Assert.False (tf.HasFocus); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); DriverAssert.AssertDriverContentsAre ("Enter txt", output); // but disapear when text is added tf.Text = content; - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); DriverAssert.AssertDriverContentsAre (content, output); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -147,17 +148,17 @@ public class TextFieldTests (ITestOutputHelper output) // Caption has no effect when focused tf.Title = "Enter txt"; Assert.True (tf.HasFocus); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); DriverAssert.AssertDriverContentsAre ("", output); Application.RaiseKeyDownEvent ('\t'); Assert.False (tf.HasFocus); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); DriverAssert.AssertDriverContentsAre ("Enter txt", output); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -173,7 +174,7 @@ public class TextFieldTests (ITestOutputHelper output) Application.RaiseKeyDownEvent ('\t'); Assert.False (tf.HasFocus); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); // Verify the caption text is rendered @@ -187,7 +188,7 @@ public class TextFieldTests (ITestOutputHelper output) // All characters in "Enter text" should have the caption attribute DriverAssert.AssertDriverAttributesAre ("0000000000", output, Application.Driver, captionAttr); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -203,7 +204,7 @@ public class TextFieldTests (ITestOutputHelper output) Application.RaiseKeyDownEvent ('\t'); Assert.False (tf.HasFocus); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); // The hotkey character 'F' should be rendered (without the underscore in the actual text) @@ -221,7 +222,7 @@ public class TextFieldTests (ITestOutputHelper output) // F is underlined (index 1), remaining characters use normal caption attribute (index 0) DriverAssert.AssertDriverAttributesAre ("1000", output, Application.Driver, captionAttr, hotkeyAttr); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -237,7 +238,7 @@ public class TextFieldTests (ITestOutputHelper output) Application.RaiseKeyDownEvent ('\t'); Assert.False (tf.HasFocus); - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); // The underscore should not be rendered, 'T' should be underlined @@ -255,7 +256,7 @@ public class TextFieldTests (ITestOutputHelper output) // "Enter " (6 chars) + "T" (underlined) + "ext" (3 chars) DriverAssert.AssertDriverAttributesAre ("0000001000", output, Application.Driver, captionAttr, hotkeyAttr); - Application.Top.Dispose (); + Application.TopRunnableView.Dispose (); } [Fact] @@ -451,7 +452,7 @@ public class TextFieldTests (ITestOutputHelper output) oldText = tf.Text; }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tf); Application.Begin (top); @@ -520,7 +521,7 @@ public class TextFieldTests (ITestOutputHelper output) [SetupFakeApplication] public void KeyBindings_Command () { - var tf = new TextField { Width = 20, Text = "This is a test." }; + var tf = new TextField { Width = 20, Text = "This is a test.", App = ApplicationImpl.Instance }; tf.BeginInit (); tf.EndInit (); @@ -835,7 +836,7 @@ public class TextFieldTests (ITestOutputHelper output) // Proves #3022 is fixed (TextField selected text does not show in v2) _textField.CursorPosition = 0; - var top = new Toplevel (); + var top = new Runnable (); top.Add (_textField); SessionToken rs = Application.Begin (top); @@ -918,7 +919,7 @@ public class TextFieldTests (ITestOutputHelper output) var clickCounter = 0; tf.MouseClick += (s, m) => { clickCounter++; }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tf); Application.Begin (top); @@ -1620,7 +1621,11 @@ public class TextFieldTests (ITestOutputHelper output) [SetupFakeApplication] public void Words_With_Accents_Incorrect_Order_Will_Result_With_Wrong_Accent_Place () { - var tf = new TextField { Width = 30, Text = "Les Misérables" }; + var tf = new TextField + { + Driver = ApplicationImpl.Instance.Driver, + Width = 30, Text = "Les Misérables" + }; tf.SetRelativeLayout (new (100, 100)); tf.Draw (); @@ -1641,7 +1646,7 @@ Les Misérables", // incorrect order will result with a wrong accent place tf.Text = "Les Mis" + char.ConvertFromUtf32 (int.Parse ("0301", NumberStyles.HexNumber)) + "erables"; - View.SetClipToScreen (); + tf.SetClipToScreen (); tf.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -1656,7 +1661,7 @@ Les Miśerables", var tf = new TextField { Width = 10 }; var tf2 = new TextField { Y = 1, Width = 10 }; - Toplevel top = new (); + Runnable top = new (); top.Add (tf); top.Add (tf2); @@ -1686,13 +1691,14 @@ Les Miśerables", { base.Before (methodUnderTest); - //Application.Top.Scheme = Colors.Schemes ["Base"]; + //Application.TopRunnable.Scheme = Colors.Schemes ["Base"]; _textField = new () { // 1 2 3 // 01234567890123456789012345678901=32 (Length) Text = "TAB to jump between text fields.", - Width = 32 + Width = 32, + App = ApplicationImpl.Instance }; } } @@ -1701,7 +1707,11 @@ Les Miśerables", [AutoInitShutdown] public void Draw_Esc_Rune () { - var tf = new TextField { Width = 5, Text = "\u001b" }; + var tf = new TextField + { + Driver = ApplicationImpl.Instance.Driver, + Width = 5, Text = "\u001b" + }; tf.BeginInit (); tf.EndInit (); tf.Draw (); diff --git a/Tests/UnitTests/Views/TextViewTests.cs b/Tests/UnitTests/Views/TextViewTests.cs index d00000d2e..ece72d13d 100644 --- a/Tests/UnitTests/Views/TextViewTests.cs +++ b/Tests/UnitTests/Views/TextViewTests.cs @@ -60,7 +60,7 @@ public class TextViewTests [TextViewTestsSetupFakeApplication] public void BackTab_Test_Follow_By_Tab () { - var top = new Toplevel (); + var top = new Runnable (); top.Add (_textView); Application.Iteration += OnApplicationOnIteration; @@ -71,7 +71,7 @@ public class TextViewTests return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object s, EventArgs a) { int width = _textView.Viewport.Width - 1; Assert.Equal (30, width + 1); @@ -109,7 +109,7 @@ public class TextViewTests Assert.Equal (leftCol, _textView.LeftColumn); } - Application.Top.Remove (_textView); + Application.TopRunnableView.Remove (_textView); Application.RequestStop (); } } @@ -118,7 +118,7 @@ public class TextViewTests [TextViewTestsSetupFakeApplication] public void CanFocus_False_Wont_Focus_With_Mouse () { - Toplevel top = new (); + Runnable top = new (); var tv = new TextView { Width = Dim.Fill (), CanFocus = false, ReadOnly = true, Text = "some text" }; var fv = new FrameView @@ -200,7 +200,7 @@ public class TextViewTests Assert.Equal (expectedCol, e.Col); }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); Assert.Equal (1, eventcount); @@ -266,7 +266,7 @@ public class TextViewTests Assert.Equal ("abc", tv.Text); - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); SessionToken rs = Application.Begin (top); Assert.Equal (1, eventcount); // for Initialize @@ -296,7 +296,7 @@ public class TextViewTests Assert.Equal (expectedCol, e.Col); }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); SessionToken rs = Application.Begin (top); Assert.Equal (1, eventcount); // for Initialize @@ -649,7 +649,7 @@ public class TextViewTests const string text = "This is the first line.\nThis is the second line.\n"; var tv = new TextView { Width = Dim.Fill (), Height = Dim.Fill (), Text = text }; string envText = tv.Text; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); SessionToken rs = Application.Begin (top); SetupFakeApplicationAttribute.RunIteration (); @@ -723,7 +723,7 @@ This is the second line. const string text = "This is the first line.\nThis is the second line.\n"; var tv = new TextView { Width = Dim.Fill (), Height = Dim.Fill (), Text = text, WordWrap = true }; string envText = tv.Text; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); SessionToken rs = Application.Begin (top); SetupFakeApplicationAttribute.RunIteration (); @@ -798,7 +798,7 @@ This is the second line. const string text = "This is the first line.\nThis is the second line.\n"; var tv = new TextView { Width = Dim.Fill (), Height = Dim.Fill (), Text = text }; string envText = tv.Text; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); SessionToken rs = Application.Begin (top); SetupFakeApplicationAttribute.RunIteration (); @@ -871,7 +871,7 @@ This is the second line. const string text = "This is the first line.\nThis is the second line.\n"; var tv = new TextView { Width = Dim.Fill (), Height = Dim.Fill (), Text = text, WordWrap = true }; string envText = tv.Text; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); SessionToken rs = Application.Begin (top); SetupFakeApplicationAttribute.RunIteration (); @@ -952,7 +952,7 @@ This is the second line. var tv = new TextView { Width = 10, Height = 10 }; tv.Text = text; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); @@ -1005,7 +1005,7 @@ This is the second line. var tv = new TextView { Width = 10, Height = 10 }; tv.Text = text; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); @@ -1050,7 +1050,7 @@ This is the second line. public void HistoryText_Undo_Redo_Copy_Without_Selection_Multi_Line_Paste () { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; - var tv = new TextView { Text = text }; + var tv = new TextView { App = ApplicationImpl.Instance, Text = text }; tv.CursorPosition = new (23, 0); @@ -1100,7 +1100,11 @@ This is the second line. public void HistoryText_Undo_Redo_Cut_Multi_Line_Another_Selected_Paste () { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; - var tv = new TextView { Text = text }; + var tv = new TextView + { + App = ApplicationImpl.Instance, + Text = text + }; tv.SelectionStartColumn = 12; tv.CursorPosition = new (17, 0); @@ -1172,7 +1176,11 @@ This is the second line. public void HistoryText_Undo_Redo_Cut_Multi_Line_Selected_Paste () { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; - var tv = new TextView { Text = text }; + var tv = new TextView + { + App = ApplicationImpl.Instance, + Text = text + }; tv.SelectionStartColumn = 12; tv.CursorPosition = new (17, 0); @@ -1217,7 +1225,11 @@ This is the second line. public void HistoryText_Undo_Redo_Cut_Simple_Paste_Starting () { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; - var tv = new TextView { Text = text }; + var tv = new TextView + { + App = ApplicationImpl.Instance, + Text = text + }; tv.SelectionStartColumn = 12; tv.CursorPosition = new (18, 1); @@ -1261,7 +1273,11 @@ This is the second line. public void HistoryText_Undo_Redo_Empty_Copy_Without_Selection_Multi_Line_Selected_Paste () { var text = "\nThis is the first line.\nThis is the second line."; - var tv = new TextView { Text = text }; + var tv = new TextView + { + App = ApplicationImpl.Instance, + Text = text + }; Assert.True (tv.NewKeyDownEvent (Key.C.WithCtrl)); @@ -1308,7 +1324,11 @@ This is the second line. public void HistoryText_Undo_Redo_KillToEndOfLine () { var text = "First line.\nSecond line."; - var tv = new TextView { Text = text }; + var tv = new TextView + { + App = ApplicationImpl.Instance, + Text = text + }; Assert.True (tv.NewKeyDownEvent (Key.K.WithCtrl)); Assert.Equal ($"{Environment.NewLine}Second line.", tv.Text); @@ -1369,7 +1389,11 @@ This is the second line. public void HistoryText_Undo_Redo_KillToLeftStart () { var text = "First line.\nSecond line."; - var tv = new TextView { Text = text }; + var tv = new TextView + { + App = ApplicationImpl.Instance, + Text = text + }; Assert.True (tv.NewKeyDownEvent (Key.End.WithCtrl)); Assert.Equal ($"First line.{Environment.NewLine}Second line.", tv.Text); @@ -1437,7 +1461,7 @@ This is the second line. { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -1655,7 +1679,7 @@ This is the second line. { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -1789,7 +1813,7 @@ This is the second line. { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -1910,7 +1934,11 @@ This is the second line. public void HistoryText_Undo_Redo_Multi_Line_Selected_Copy_Simple_Paste_Starting_On_Letter () { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; - var tv = new TextView { Text = text }; + var tv = new TextView + { + App = ApplicationImpl.Instance, + Text = text + }; tv.SelectionStartColumn = 12; tv.CursorPosition = new (18, 1); @@ -1963,7 +1991,11 @@ This is the second line. public void HistoryText_Undo_Redo_Multi_Line_Selected_Copy_Simple_Paste_Starting_On_Space () { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; - var tv = new TextView { Text = text }; + var tv = new TextView + { + App = ApplicationImpl.Instance, + Text = text + }; tv.SelectionStartColumn = 12; tv.CursorPosition = new (18, 1); @@ -2017,7 +2049,7 @@ This is the second line. var text = $"This is the first line.{Environment.NewLine}This is the second line.\nThis is the third line."; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -2186,7 +2218,7 @@ This is the second line. { var text = "One\nTwo\nThree"; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -2250,7 +2282,7 @@ This is the second line. { var text = "One\nTwo\nThree\n"; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -2313,7 +2345,7 @@ This is the second line. public void HistoryText_Undo_Redo_Multi_Line_Selected_With_Empty_Text () { var tv = new TextView { Width = 10, Height = 2 }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -2669,7 +2701,7 @@ This is the second line. public void HistoryText_Undo_Redo_Multi_Line_With_Empty_Text () { var tv = new TextView { Width = 10, Height = 2 }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -2951,7 +2983,11 @@ This is the second line. public void HistoryText_Undo_Redo_Setting_Clipboard_Multi_Line_Selected_Paste () { var text = "This is the first line.\nThis is the second line."; - var tv = new TextView { Text = text }; + var tv = new TextView + { + App = ApplicationImpl.Instance, + Text = text + }; Clipboard.Contents = "Inserted\nNewLine"; @@ -2991,7 +3027,11 @@ This is the second line. public void HistoryText_Undo_Redo_Simple_Copy_Multi_Line_Selected_Paste () { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; - var tv = new TextView { Text = text }; + var tv = new TextView + { + App = ApplicationImpl.Instance, + Text = text + }; tv.SelectionStartColumn = 12; tv.CursorPosition = new (17, 0); @@ -3037,7 +3077,7 @@ This is the second line. { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -3095,7 +3135,7 @@ This is the second line. { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -3153,7 +3193,7 @@ This is the second line. { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -3207,7 +3247,7 @@ This is the second line. { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -3277,7 +3317,7 @@ This is the second line. { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -3347,7 +3387,7 @@ This is the second line. { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -3413,7 +3453,7 @@ This is the second line. { var text = "This is the first line.\nThis is the second line.\nThis is the third line."; var tv = new TextView { Width = 10, Height = 2, Text = text }; - Toplevel top = new (); + Runnable top = new (); top.Add (tv); Application.Begin (top); @@ -4519,7 +4559,7 @@ This is the second line. } } - [Fact (Skip = "Fake Clipboard is broken")] + [Fact] [TextViewTestsSetupFakeApplication] public void Kill_To_End_Delete_Forwards_Copy_To_The_Clipboard_And_Paste () { @@ -4581,7 +4621,7 @@ This is the second line. } } - [Fact (Skip = "FakeClipboard is broken in some way, causing this unit test to fail intermittently.")] + [Fact] [TextViewTestsSetupFakeApplication] public void Kill_To_Start_Delete_Backwards_Copy_To_The_Clipboard_And_Paste () { @@ -4818,7 +4858,7 @@ This is the second line. public void Selected_Text_Shows () { // Proves #3022 is fixed (TextField selected text does not show in v2) - Toplevel top = new (); + Runnable top = new (); top.Add (_textView); SessionToken rs = Application.Begin (top); @@ -4905,7 +4945,7 @@ This is the second line. [TextViewTestsSetupFakeApplication] public void Tab_Test_Follow_By_BackTab () { - var top = new Toplevel (); + var top = new Runnable (); top.Add (_textView); Application.Iteration += OnApplicationOnIteration; @@ -4916,7 +4956,7 @@ This is the second line. return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object s, EventArgs a) { int width = _textView.Viewport.Width - 1; Assert.Equal (30, width + 1); @@ -4953,7 +4993,7 @@ This is the second line. [TextViewTestsSetupFakeApplication] public void Tab_Test_Follow_By_BackTab_With_Text () { - var top = new Toplevel (); + var top = new Runnable (); top.Add (_textView); Application.Iteration += OnApplicationOnIteration; @@ -4964,7 +5004,7 @@ This is the second line. return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object s, EventArgs a) { int width = _textView.Viewport.Width - 1; Assert.Equal (30, width + 1); @@ -5001,7 +5041,7 @@ This is the second line. [TextViewTestsSetupFakeApplication] public void Tab_Test_Follow_By_CursorLeft_And_Then_Follow_By_CursorRight () { - var top = new Toplevel (); + var top = new Runnable (); top.Add (_textView); Application.Iteration += OnApplicationOnIteration; @@ -5012,7 +5052,7 @@ This is the second line. return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object s, EventArgs a) { int width = _textView.Viewport.Width - 1; Assert.Equal (30, width + 1); @@ -5058,7 +5098,7 @@ This is the second line. [TextViewTestsSetupFakeApplication] public void Tab_Test_Follow_By_CursorLeft_And_Then_Follow_By_CursorRight_With_Text () { - var top = new Toplevel (); + var top = new Runnable (); top.Add (_textView); Application.Iteration += OnApplicationOnIteration; @@ -5069,7 +5109,7 @@ This is the second line. return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object s, EventArgs a) { int width = _textView.Viewport.Width - 1; Assert.Equal (30, width + 1); @@ -5117,7 +5157,7 @@ This is the second line. [TextViewTestsSetupFakeApplication] public void Tab_Test_Follow_By_Home_And_Then_Follow_By_End_And_Then_Follow_By_BackTab_With_Text () { - var top = new Toplevel (); + var top = new Runnable (); top.Add (_textView); Application.Iteration += OnApplicationOnIteration; @@ -5128,7 +5168,7 @@ This is the second line. return; - void OnApplicationOnIteration (object s, IterationEventArgs a) + void OnApplicationOnIteration (object s, EventArgs a) { int width = _textView.Viewport.Width - 1; Assert.Equal (30, width + 1); @@ -5192,7 +5232,7 @@ This is the second line. [TextViewTestsSetupFakeApplication] public void TabWidth_Setting_To_Zero_Keeps_AllowsTab () { - var top = new Toplevel (); + var top = new Runnable (); top.Add (_textView); Application.Begin (top); @@ -5289,7 +5329,7 @@ TAB to jump between text field", var win = new Window (); win.Add (tv); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Application.Begin (top); Application.Driver!.SetScreenSize (15, 15); @@ -5367,7 +5407,7 @@ TAB to jump between text field", var win = new Window (); win.Add (tv); - var top = new Toplevel (); + var top = new Runnable (); top.Add (win); Application.Begin (top); Application.Driver!.SetScreenSize (15, 15); @@ -5452,7 +5492,7 @@ TAB to jump between text field", Width = Dim.Fill (), Height = Dim.Fill (), Text = "This is the first line.\nThis is the second line.\n" }; tv.UnwrappedCursorPosition += (s, e) => { cp = e; }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); SetupFakeApplicationAttribute.RunIteration (); @@ -5484,7 +5524,7 @@ This is the second line. ); Application.Driver!.SetScreenSize (6, 25); - tv.SetRelativeLayout (Application.Screen.Size); + Application.LayoutAndDraw (); tv.Draw (); Assert.Equal (new (4, 2), tv.CursorPosition); Assert.Equal (new (12, 0), cp); @@ -6657,7 +6697,7 @@ line. public void WordWrap_Deleting_Backwards () { var tv = new TextView { Width = 5, Height = 2, WordWrap = true, Text = "aaaa" }; - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); SetupFakeApplicationAttribute.RunIteration (); @@ -6735,7 +6775,7 @@ a [InlineData (KeyCode.Delete)] public void WordWrap_Draw_Typed_Keys_After_Text_Is_Deleted (KeyCode del) { - var top = new Toplevel (); + var top = new Runnable (); top.Add (_textView); _textView.Text = "Line 1.\nLine 2."; _textView.WordWrap = true; @@ -6796,7 +6836,12 @@ Line 2.", { // 0123456789 var text = "This is the first line.\nThis is the second line.\n"; - var tv = new TextView { Width = 11, Height = 9 }; + var tv = new TextView + { + Width = 11, + Height = 9, + App = ApplicationImpl.Instance + }; tv.Text = text; Assert.Equal ( @@ -6805,7 +6850,10 @@ Line 2.", ); tv.WordWrap = true; - var top = new Toplevel (); + var top = new Runnable () + { + Driver = ApplicationImpl.Instance.Driver, + }; top.Add (tv); top.Layout (); tv.Draw (); @@ -6827,7 +6875,7 @@ line. tv.CursorPosition = new (6, 2); Assert.Equal (new (5, 2), tv.CursorPosition); top.LayoutSubViews (); - View.SetClipToScreen (); + top.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsWithFrameAre ( @@ -6891,7 +6939,10 @@ line. ); tv.WordWrap = true; - var top = new Toplevel (); + var top = new Runnable () + { + Driver = ApplicationImpl.Instance.Driver, + }; top.Add (tv); top.Layout (); @@ -6916,7 +6967,7 @@ line. { string [] lines = _textView.Text.Split (Environment.NewLine); - if (lines == null || lines.Length == 0) + if (lines is { Length: 0 }) { return 0; } @@ -6996,7 +7047,11 @@ line. // 01234567890123456789012345678901=32 (Length) byte [] buff = Encoding.Unicode.GetBytes (Txt); byte [] ms = new MemoryStream (buff).ToArray (); - _textView = new () { Width = 30, Height = 10, SchemeName = "Base" }; + _textView = new () + { + App = ApplicationImpl.Instance, + Width = 30, Height = 10, SchemeName = "Base" + }; _textView.Text = Encoding.Unicode.GetString (ms); } } @@ -7005,7 +7060,11 @@ line. [SetupFakeApplication] public void Draw_Esc_Rune () { - var tv = new TextView { Width = 5, Height = 1, Text = "\u001b" }; + var tv = new TextView + { + Driver = ApplicationImpl.Instance.Driver, + Width = 5, Height = 1, Text = "\u001b" + }; tv.BeginInit (); tv.EndInit (); tv.Draw (); @@ -7024,11 +7083,11 @@ line. List> text = [ Cell.ToCells ( - "This is the first line.".ToRunes () + "This is the first line.".ToStringList () ), Cell.ToCells ( - "This is the second line.".ToRunes () + "This is the second line.".ToStringList () ) ]; TextView tv = CreateTextView (); @@ -7045,7 +7104,7 @@ line. tv.Text = $"{Cell.ToString (text [0])}\n{Cell.ToString (text [1])}\n"; Assert.False (tv.WordWrap); - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); SetupFakeApplicationAttribute.RunIteration (); @@ -7091,17 +7150,14 @@ line. ", { string csName = color.Key; - foreach (Rune rune in csName.EnumerateRunes ()) - { - cells.Add (new () { Rune = rune, Attribute = color.Value.Normal }); - } + cells.AddRange (Cell.ToCellList (csName, color.Value.Normal)); - cells.Add (new () { Rune = (Rune)'\n', Attribute = color.Value.Focus }); + cells.Add (new () { Grapheme = "\n", Attribute = color.Value.Focus }); } TextView tv = CreateTextView (); tv.Load (cells); - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); SessionToken rs = Application.Begin (top); SetupFakeApplicationAttribute.RunIteration (); @@ -7109,7 +7165,7 @@ line. ", Assert.True (tv.InheritsPreviousAttribute); var expectedText = @" -TopLevel +Runnable Base Dialog Menu @@ -7119,7 +7175,7 @@ Error "; Attribute [] attributes = { // 0 - SchemeManager.GetSchemes () ["TopLevel"].Normal, + SchemeManager.GetSchemes () ["Runnable"].Normal, // 1 SchemeManager.GetSchemes () ["Base"].Normal, @@ -7153,7 +7209,7 @@ Error "; tv.CursorPosition = new (6, 2); tv.SelectionStartColumn = 0; tv.SelectionStartRow = 0; - Assert.Equal ($"TopLevel{Environment.NewLine}Base{Environment.NewLine}Dialog", tv.SelectedText); + Assert.Equal ($"Runnable{Environment.NewLine}Base{Environment.NewLine}Dialog", tv.SelectedText); tv.Copy (); tv.IsSelecting = false; tv.CursorPosition = new (2, 4); @@ -7161,11 +7217,11 @@ Error "; SetupFakeApplicationAttribute.RunIteration (); expectedText = @" -TopLevel +Runnable Base Dialog Menu -ErTopLevel +ErRunnable Base Dialogror "; DriverAssert.AssertDriverContentsWithFrameAre (expectedText, _output); @@ -7186,7 +7242,7 @@ Dialogror "; tv.SelectionStartRow = 0; Assert.Equal ( - $"TopLevel{Environment.NewLine}Base{Environment.NewLine}Dialog{Environment.NewLine}", + $"Runnable{Environment.NewLine}Base{Environment.NewLine}Dialog{Environment.NewLine}", tv.SelectedText ); tv.Copy (); @@ -7196,11 +7252,11 @@ Dialogror "; SetupFakeApplicationAttribute.RunIteration (); expectedText = @" -TopLevel +Runnable Base Dialog Menu -ErTopLevel +ErRunnable Base Dialog ror "; @@ -7226,7 +7282,7 @@ ror "; public void IsSelecting_False_If_SelectedLength_Is_Zero_On_Mouse_Click () { _textView.Text = "This is the first line."; - var top = new Toplevel (); + var top = new Runnable (); top.Add (_textView); Application.Begin (top); diff --git a/Tests/UnitTests/Views/ToplevelTests.cs b/Tests/UnitTests/Views/ToplevelTests.cs deleted file mode 100644 index ad47948a0..000000000 --- a/Tests/UnitTests/Views/ToplevelTests.cs +++ /dev/null @@ -1,902 +0,0 @@ -namespace UnitTests.ViewsTests; - -public class ToplevelTests -{ - [Fact] - public void Constructor_Default () - { - var top = new Toplevel (); - - Assert.Equal ("Toplevel", top.SchemeName); - Assert.Equal ("Fill(Absolute(0))", top.Width.ToString ()); - Assert.Equal ("Fill(Absolute(0))", top.Height.ToString ()); - Assert.False (top.Running); - Assert.False (top.Modal); - Assert.Null (top.MenuBar); - - //Assert.Null (top.StatusBar); - } - - [Fact] - public void Arrangement_Default_Is_Overlapped () - { - var top = new Toplevel (); - Assert.Equal (ViewArrangement.Overlapped, top.Arrangement); - } - - [Fact] - [AutoInitShutdown] - public void Internal_Tests () - { - var top = new Toplevel (); - - var eventInvoked = ""; - - top.Loaded += (s, e) => eventInvoked = "Loaded"; - top.OnLoaded (); - Assert.Equal ("Loaded", eventInvoked); - top.Ready += (s, e) => eventInvoked = "Ready"; - top.OnReady (); - Assert.Equal ("Ready", eventInvoked); - top.Unloaded += (s, e) => eventInvoked = "Unloaded"; - top.OnUnloaded (); - Assert.Equal ("Unloaded", eventInvoked); - - top.Add (new MenuBar ()); - Assert.NotNull (top.MenuBar); - - //top.Add (new StatusBar ()); - //Assert.NotNull (top.StatusBar); - MenuBar menuBar = top.MenuBar; - top.Remove (top.MenuBar); - Assert.Null (top.MenuBar); - Assert.NotNull (menuBar); - - //var statusBar = top.StatusBar; - //top.Remove (top.StatusBar); - //Assert.Null (top.StatusBar); - //Assert.NotNull (statusBar); -#if DEBUG_IDISPOSABLE - Assert.False (menuBar.WasDisposed); - - //Assert.False (statusBar.WasDisposed); - menuBar.Dispose (); - - //statusBar.Dispose (); - Assert.True (menuBar.WasDisposed); - - //Assert.True (statusBar.WasDisposed); -#endif - - Application.Begin (top); - Assert.Equal (top, Application.Top); - - // Application.Top without menu and status bar. - View supView = View.GetLocationEnsuringFullVisibility (top, 2, 2, out int nx, out int ny /*, out StatusBar sb*/); - Assert.Equal (Application.Top, supView); - Assert.Equal (0, nx); - Assert.Equal (0, ny); - - //Assert.Null (sb); - - top.Add (new MenuBar ()); - Assert.NotNull (top.MenuBar); - - // Application.Top with a menu and without status bar. - View.GetLocationEnsuringFullVisibility (top, 2, 2, out nx, out ny /*, out sb*/); - Assert.Equal (0, nx); - Assert.Equal (1, ny); - - //Assert.Null (sb); - - //top.Add (new StatusBar ()); - //Assert.NotNull (top.StatusBar); - - // Application.Top with a menu and status bar. - View.GetLocationEnsuringFullVisibility (top, 2, 2, out nx, out ny /*, out sb*/); - Assert.Equal (0, nx); - - // The available height is lower than the Application.Top height minus - // the menu bar and status bar, then the top can go beyond the bottom - // Assert.Equal (2, ny); - //Assert.NotNull (sb); - - menuBar = top.MenuBar; - top.Remove (top.MenuBar); - Assert.Null (top.MenuBar); - Assert.NotNull (menuBar); - - // Application.Top without a menu and with a status bar. - View.GetLocationEnsuringFullVisibility (top, 2, 2, out nx, out ny /*, out sb*/); - Assert.Equal (0, nx); - - // The available height is lower than the Application.Top height minus - // the status bar, then the top can go beyond the bottom - // Assert.Equal (2, ny); - //Assert.NotNull (sb); - - //statusBar = top.StatusBar; - //top.Remove (top.StatusBar); - //Assert.Null (top.StatusBar); - //Assert.NotNull (statusBar); - Assert.Null (top.MenuBar); - - var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; - top.Add (win); - top.LayoutSubViews (); - - // The SuperView is always the same regardless of the caller. - supView = View.GetLocationEnsuringFullVisibility (win, 0, 0, out nx, out ny /*, out sb*/); - Assert.Equal (Application.Top, supView); - supView = View.GetLocationEnsuringFullVisibility (win, 0, 0, out nx, out ny /*, out sb*/); - Assert.Equal (Application.Top, supView); - - // Application.Top without menu and status bar. - View.GetLocationEnsuringFullVisibility (win, 0, 0, out nx, out ny /*, out sb*/); - Assert.Equal (0, nx); - Assert.Equal (0, ny); - - //Assert.Null (sb); - - top.Add (new MenuBar ()); - Assert.NotNull (top.MenuBar); - - // Application.Top with a menu and without status bar. - View.GetLocationEnsuringFullVisibility (win, 2, 2, out nx, out ny /*, out sb*/); - Assert.Equal (0, nx); - Assert.Equal (1, ny); - - //Assert.Null (sb); - - top.Add (new StatusBar ()); - - //Assert.NotNull (top.StatusBar); - - // Application.Top with a menu and status bar. - View.GetLocationEnsuringFullVisibility (win, 30, 20, out nx, out ny /*, out sb*/); - Assert.Equal (0, nx); - - // The available height is lower than the Application.Top height minus - // the menu bar and status bar, then the top can go beyond the bottom - //Assert.Equal (20, ny); - //Assert.NotNull (sb); - - menuBar = top.MenuBar; - - //statusBar = top.StatusBar; - top.Remove (top.MenuBar); - Assert.Null (top.MenuBar); - Assert.NotNull (menuBar); - - //top.Remove (top.StatusBar); - //Assert.Null (top.StatusBar); - //Assert.NotNull (statusBar); - - top.Remove (win); - - win = new () { Width = 60, Height = 15 }; - top.Add (win); - - // Application.Top without menu and status bar. - View.GetLocationEnsuringFullVisibility (win, 0, 0, out nx, out ny /*, out sb*/); - Assert.Equal (0, nx); - Assert.Equal (0, ny); - - //Assert.Null (sb); - - top.Add (new MenuBar ()); - Assert.NotNull (top.MenuBar); - - // Application.Top with a menu and without status bar. - View.GetLocationEnsuringFullVisibility (win, 2, 2, out nx, out ny /*, out sb*/); - Assert.Equal (2, nx); - Assert.Equal (2, ny); - - //Assert.Null (sb); - - top.Add (new StatusBar ()); - - //Assert.NotNull (top.StatusBar); - - // Application.Top with a menu and status bar. - View.GetLocationEnsuringFullVisibility (win, 30, 20, out nx, out ny /*, out sb*/); - Assert.Equal (20, nx); // 20+60=80 - - //Assert.Equal (9, ny); // 9+15+1(mb)=25 - //Assert.NotNull (sb); - - //Assert.Null (Toplevel._dragPosition); - win.NewMouseEvent (new () { Position = new (6, 0), Flags = MouseFlags.Button1Pressed }); - - // Assert.Equal (new Point (6, 0), Toplevel._dragPosition); - win.NewMouseEvent (new () { Position = new (6, 0), Flags = MouseFlags.Button1Released }); - - //Assert.Null (Toplevel._dragPosition); - win.CanFocus = false; - win.NewMouseEvent (new () { Position = new (6, 0), Flags = MouseFlags.Button1Pressed }); - - //Assert.Null (Toplevel._dragPosition); -#if DEBUG_IDISPOSABLE - - Assert.False (top.MenuBar.WasDisposed); - - //Assert.False (top.StatusBar.WasDisposed); -#endif - menuBar = top.MenuBar; - - //statusBar = top.StatusBar; - top.Dispose (); - Assert.Null (top.MenuBar); - - //Assert.Null (top.StatusBar); - Assert.NotNull (menuBar); - - //Assert.NotNull (statusBar); -#if DEBUG_IDISPOSABLE - Assert.True (menuBar.WasDisposed); - - //Assert.True (statusBar.WasDisposed); -#endif - } - - [Fact] - public void SuperViewChanged_Should_Not_Be_Used_To_Initialize_Toplevel_Events () - { - var wasAdded = false; - - var view = new View (); - view.SuperViewChanged += SuperViewChanged; - - var win = new Window (); - win.Add (view); - Application.Init (null, "fake"); - Toplevel top = new (); - top.Add (win); - - Assert.True (wasAdded); - - Application.Shutdown (); - - return; - - void SuperViewChanged (object sender, SuperViewChangedEventArgs _) - { - Assert.False (wasAdded); - wasAdded = true; - view.SuperViewChanged -= SuperViewChanged; - } - } - - [Fact] - [AutoInitShutdown] - public void Mouse_Drag_On_Top_With_Superview_Null () - { - var win = new Window (); - Toplevel top = new (); - top.Add (win); - int iterations = -1; - Window testWindow; - - Application.Iteration += OnApplicationOnIteration; - - Application.Run (top); - Application.Iteration -= OnApplicationOnIteration; - top.Dispose (); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - iterations++; - - if (iterations == 0) - { - Application.Driver?.SetScreenSize (15, 7); - - // Don't use MessageBox here; it's too complicated for this unit test; just use Window - testWindow = new () - { - Text = "Hello", - X = 2, - Y = 2, - Width = 10, - Height = 3, - Arrangement = ViewArrangement.Movable - }; - Application.Run (testWindow); - } - else if (iterations == 1) - { - Assert.Equal (new (2, 2), Application.Top!.Frame.Location); - } - else if (iterations == 2) - { - Assert.Null (Application.Mouse.MouseGrabView); - - // Grab the mouse - Application.RaiseMouseEvent (new () { ScreenPosition = new (3, 2), Flags = MouseFlags.Button1Pressed }); - - Assert.Equal (Application.Top!.Border, Application.Mouse.MouseGrabView); - Assert.Equal (new (2, 2, 10, 3), Application.Top.Frame); - } - else if (iterations == 3) - { - Assert.Equal (Application.Top!.Border, Application.Mouse.MouseGrabView); - - // Drag to left - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (2, 2), - Flags = MouseFlags.Button1Pressed - | MouseFlags.ReportMousePosition - }); - AutoInitShutdownAttribute.RunIteration (); - - Assert.Equal (Application.Top.Border, Application.Mouse.MouseGrabView); - Assert.Equal (new (1, 2, 10, 3), Application.Top.Frame); - } - else if (iterations == 4) - { - Assert.Equal (Application.Top!.Border, Application.Mouse.MouseGrabView); - Assert.Equal (new (1, 2), Application.Top.Frame.Location); - - Assert.Equal (Application.Top.Border, Application.Mouse.MouseGrabView); - } - else if (iterations == 5) - { - Assert.Equal (Application.Top!.Border, Application.Mouse.MouseGrabView); - - // Drag up - Application.RaiseMouseEvent (new () { ScreenPosition = new (2, 1), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition }); - AutoInitShutdownAttribute.RunIteration (); - - Assert.Equal (Application.Top!.Border, Application.Mouse.MouseGrabView); - Assert.Equal (new (1, 1, 10, 3), Application.Top.Frame); - } - else if (iterations == 6) - { - Assert.Equal (Application.Top!.Border, Application.Mouse.MouseGrabView); - Assert.Equal (new (1, 1), Application.Top.Frame.Location); - - Assert.Equal (Application.Top.Border, Application.Mouse.MouseGrabView); - Assert.Equal (new (1, 1, 10, 3), Application.Top.Frame); - } - else if (iterations == 7) - { - Assert.Equal (Application.Top!.Border, Application.Mouse.MouseGrabView); - - // Ungrab the mouse - Application.RaiseMouseEvent (new () { ScreenPosition = new (2, 1), Flags = MouseFlags.Button1Released }); - AutoInitShutdownAttribute.RunIteration (); - - Assert.Null (Application.Mouse.MouseGrabView); - } - else if (iterations == 8) - { - Application.RequestStop (); - } - else if (iterations == 9) - { - Application.RequestStop (); - } - } - } - - [Fact] - [AutoInitShutdown] - public void Mouse_Drag_On_Top_With_Superview_Not_Null () - { - var win = new Window { X = 3, Y = 2, Width = 10, Height = 5, Arrangement = ViewArrangement.Movable }; - Toplevel top = new (); - top.Add (win); - - int iterations = -1; - - var movex = 0; - var movey = 0; - - var location = new Rectangle (win.Frame.X, win.Frame.Y, 7, 3); - - Application.Iteration += OnApplicationOnIteration; - - Application.Run (top); - Application.Iteration -= OnApplicationOnIteration; - top.Dispose (); - - return; - - void OnApplicationOnIteration (object s, IterationEventArgs a) - { - iterations++; - - if (iterations == 0) - { - Application.Driver?.SetScreenSize (30, 10); - } - else if (iterations == 1) - { - location = win.Frame; - - Assert.Null (Application.Mouse.MouseGrabView); - - // Grab the mouse - Application.RaiseMouseEvent (new () { ScreenPosition = new (win.Frame.X, win.Frame.Y), Flags = MouseFlags.Button1Pressed }); - - Assert.Equal (win.Border, Application.Mouse.MouseGrabView); - } - else if (iterations == 2) - { - Assert.Equal (win.Border, Application.Mouse.MouseGrabView); - - // Drag to left - movex = 1; - movey = 0; - - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (win.Frame.X + movex, win.Frame.Y + movey), - Flags = MouseFlags.Button1Pressed - | MouseFlags.ReportMousePosition - }); - - Assert.Equal (win.Border, Application.Mouse.MouseGrabView); - } - else if (iterations == 3) - { - // we should have moved +1, +0 - Assert.Equal (win.Border, Application.Mouse.MouseGrabView); - Assert.Equal (win.Border, Application.Mouse.MouseGrabView); - location.Offset (movex, movey); - } - else if (iterations == 4) - { - Assert.Equal (win.Border, Application.Mouse.MouseGrabView); - - // Drag up - movex = 0; - movey = -1; - - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (win.Frame.X + movex, win.Frame.Y + movey), - Flags = MouseFlags.Button1Pressed - | MouseFlags.ReportMousePosition - }); - - Assert.Equal (win.Border, Application.Mouse.MouseGrabView); - } - else if (iterations == 5) - { - // we should have moved +0, -1 - Assert.Equal (win.Border, Application.Mouse.MouseGrabView); - location.Offset (movex, movey); - Assert.Equal (location, win.Frame); - } - else if (iterations == 6) - { - Assert.Equal (win.Border, Application.Mouse.MouseGrabView); - - // Ungrab the mouse - movex = 0; - movey = 0; - - Application.RaiseMouseEvent (new () { ScreenPosition = new (win.Frame.X + movex, win.Frame.Y + movey), Flags = MouseFlags.Button1Released }); - - Assert.Null (Application.Mouse.MouseGrabView); - } - else if (iterations == 7) - { - Application.RequestStop (); - } - } - } - - [Fact] - [SetupFakeApplication] - public void GetLocationThatFits_With_Border_Null_Not_Throws () - { - var top = new Toplevel (); - top.BeginInit (); - top.EndInit (); - - Exception exception = Record.Exception (() => Application.Driver!.SetScreenSize (0, 10)); - Assert.Null (exception); - - exception = Record.Exception (() => Application.Driver!.SetScreenSize (10, 0)); - Assert.Null (exception); - } - - [Fact] - [AutoInitShutdown] - public void PositionCursor_SetCursorVisibility_To_Invisible_If_Focused_Is_Null () - { - var tf = new TextField { Width = 5, Text = "test" }; - var view = new View { Width = 10, Height = 10, CanFocus = true }; - view.Add (tf); - var top = new Toplevel (); - top.Add (view); - Application.Begin (top); - - Assert.True (tf.HasFocus); - Application.PositionCursor (); - Application.Driver!.GetCursorVisibility (out CursorVisibility cursor); - Assert.Equal (CursorVisibility.Default, cursor); - - view.Enabled = false; - Assert.False (tf.HasFocus); - Application.PositionCursor (); - Application.Driver!.GetCursorVisibility (out cursor); - Assert.Equal (CursorVisibility.Invisible, cursor); - top.Dispose (); - } - - [Fact] - [AutoInitShutdown] - public void IsLoaded_Application_Begin () - { - Toplevel top = new (); - Assert.False (top.IsLoaded); - - Application.Begin (top); - Assert.True (top.IsLoaded); - top.Dispose (); - } - - [Fact] - [AutoInitShutdown] - public void IsLoaded_With_Sub_Toplevel_Application_Begin_NeedDisplay () - { - Toplevel top = new (); - var subTop = new Toplevel (); - var view = new View { Frame = new (0, 0, 20, 10) }; - subTop.Add (view); - top.Add (subTop); - - Assert.False (top.IsLoaded); - Assert.False (subTop.IsLoaded); - Assert.Equal (new (0, 0, 20, 10), view.Frame); - - view.SubViewLayout += ViewLayoutStarted; - - void ViewLayoutStarted (object sender, LayoutEventArgs e) - { - Assert.Equal (new (0, 0, 20, 10), view.NeedsDrawRect); - view.SubViewLayout -= ViewLayoutStarted; - } - - Application.Begin (top); - - Assert.True (top.IsLoaded); - Assert.True (subTop.IsLoaded); - Assert.Equal (new (0, 0, 20, 10), view.Frame); - - view.Frame = new (1, 3, 10, 5); - Assert.Equal (new (1, 3, 10, 5), view.Frame); - Assert.Equal (new (0, 0, 10, 5), view.NeedsDrawRect); - - view.Frame = new (1, 3, 10, 5); - top.Layout (); - Assert.Equal (new (1, 3, 10, 5), view.Frame); - Assert.Equal (new (0, 0, 10, 5), view.NeedsDrawRect); - top.Dispose (); - } - - [Fact] - [AutoInitShutdown] - public void Window_Viewport_Bigger_Than_Driver_Cols_And_Rows_Allow_Drag_Beyond_Left_Right_And_Bottom () - { - Toplevel top = new (); - var window = new Window { Width = 20, Height = 3, Arrangement = ViewArrangement.Movable }; - SessionToken rsTop = Application.Begin (top); - Application.Driver?.SetScreenSize (40, 10); - - SessionToken rsWindow = Application.Begin (window); - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (new (0, 0, 40, 10), top.Frame); - Assert.Equal (new (0, 0, 20, 3), window.Frame); - - Assert.Null (Application.Mouse.MouseGrabView); - - Application.RaiseMouseEvent (new () { ScreenPosition = new (0, 0), Flags = MouseFlags.Button1Pressed }); - - Assert.Equal (window.Border, Application.Mouse.MouseGrabView); - - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (-11, -4), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition - }); - - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (new (0, 0, 40, 10), top.Frame); - Assert.Equal (new (-11, -4, 20, 3), window.Frame); - - // Changes Top size to same size as Dialog more menu and scroll bar - Application.Driver?.SetScreenSize (20, 3); - - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (-1, -1), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition - }); - - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (new (0, 0, 20, 3), top.Frame); - Assert.Equal (new (-1, -1, 20, 3), window.Frame); - - // Changes Top size smaller than Dialog size - Application.Driver?.SetScreenSize (19, 2); - - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (-1, -1), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition - }); - - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (new (0, 0, 19, 2), top.Frame); - Assert.Equal (new (-1, -1, 20, 3), window.Frame); - - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (18, 1), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition - }); - - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (new (0, 0, 19, 2), top.Frame); - Assert.Equal (new (18, 1, 20, 3), window.Frame); - - // On a real app we can't go beyond the SuperView bounds - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (19, 2), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition - }); - - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (new (0, 0, 19, 2), top.Frame); - Assert.Equal (new (19, 2, 20, 3), window.Frame); - - //DriverAsserts.AssertDriverContentsWithFrameAre (@"", output); - - Application.End (rsWindow); - Application.End (rsTop); - top.Dispose (); - } - - [Fact] - [AutoInitShutdown] - public void Modal_As_Top_Will_Drag_Cleanly () - { - // Don't use Dialog as a Top, use a Window instead - dialog has complex layout behavior that is not needed here. - var window = new Window { Width = 10, Height = 3, Arrangement = ViewArrangement.Movable }; - - window.Add ( - new Label - { - X = Pos.Center (), - Y = Pos.Center (), - Width = Dim.Fill (), - Height = Dim.Fill (), - TextAlignment = Alignment.Center, - VerticalTextAlignment = Alignment.Center, - Text = "Test" - } - ); - - SessionToken rs = Application.Begin (window); - - Assert.Null (Application.Mouse.MouseGrabView); - Assert.Equal (new (0, 0, 10, 3), window.Frame); - - Application.RaiseMouseEvent (new () { ScreenPosition = new (0, 0), Flags = MouseFlags.Button1Pressed }); - - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (window.Border, Application.Mouse.MouseGrabView); - - Assert.Equal (new (0, 0, 10, 3), window.Frame); - - Application.RaiseMouseEvent ( - new () - { - ScreenPosition = new (1, 1), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition - }); - - AutoInitShutdownAttribute.RunIteration (); - Assert.Equal (window.Border, Application.Mouse.MouseGrabView); - Assert.Equal (new (1, 1, 10, 3), window.Frame); - - Application.End (rs); - window.Dispose (); - } - - [Fact] - [AutoInitShutdown] - public void Activating_MenuBar_By_Alt_Key_Does_Not_Throw () - { - var menu = new MenuBar - { - Menus = - [ - new ("Child", new MenuItem [] { new ("_Create Child", "", null) }) - ] - }; - var topChild = new Toplevel (); - topChild.Add (menu); - var top = new Toplevel (); - top.Add (topChild); - Application.Begin (top); - - Exception exception = Record.Exception (() => topChild.NewKeyDownEvent (KeyCode.AltMask)); - Assert.Null (exception); - top.Dispose (); - } - - [Fact] - public void Multi_Thread_Toplevels () - { - Application.Init (null, "fake"); - - Toplevel t = new (); - var w = new Window (); - t.Add (w); - - int count = 0, count1 = 0, count2 = 0; - bool log = false, log1 = false, log2 = false; - var fromTopStillKnowFirstIsRunning = false; - var fromTopStillKnowSecondIsRunning = false; - var fromFirstStillKnowSecondIsRunning = false; - - Application.AddTimeout ( - TimeSpan.FromMilliseconds (100), - () => - { - count++; - - if (count1 == 5) - { - log1 = true; - } - - if (count1 == 14 && count2 == 10 && count == 15) - { - // count2 is already stopped - fromTopStillKnowFirstIsRunning = true; - } - - if (count1 == 7 && count2 == 7 && count == 8) - { - fromTopStillKnowSecondIsRunning = true; - } - - if (count == 30) - { - Assert.Equal (30, count); - Assert.Equal (20, count1); - Assert.Equal (10, count2); - - Assert.True (log); - Assert.True (log1); - Assert.True (log2); - - Assert.True (fromTopStillKnowFirstIsRunning); - Assert.True (fromTopStillKnowSecondIsRunning); - Assert.True (fromFirstStillKnowSecondIsRunning); - - Application.RequestStop (); - - return false; - } - - return true; - } - ); - - t.Ready += FirstWindow; - - void FirstWindow (object sender, EventArgs args) - { - var firstWindow = new Window (); - firstWindow.Ready += SecondWindow; - - Application.AddTimeout ( - TimeSpan.FromMilliseconds (100), - () => - { - count1++; - - if (count2 == 5) - { - log2 = true; - } - - if (count2 == 4 && count1 == 5 && count == 5) - { - fromFirstStillKnowSecondIsRunning = true; - } - - if (count1 == 20) - { - Assert.Equal (20, count1); - Application.RequestStop (); - - return false; - } - - return true; - } - ); - - Application.Run (firstWindow); - firstWindow.Dispose (); - } - - void SecondWindow (object sender, EventArgs args) - { - var testWindow = new Window (); - - Application.AddTimeout ( - TimeSpan.FromMilliseconds (100), - () => - { - count2++; - - if (count < 30) - { - log = true; - } - - if (count2 == 10) - { - Assert.Equal (10, count2); - Application.RequestStop (); - - return false; - } - - return true; - } - ); - - Application.Run (testWindow); - testWindow.Dispose (); - } - - Application.Run (t); - t.Dispose (); - Application.Shutdown (); - } - - [Fact] - public void Remove_Do_Not_Dispose_MenuBar_Or_StatusBar () - { - var mb = new MenuBar (); - var sb = new StatusBar (); - var tl = new Toplevel (); - -#if DEBUG - Assert.False (mb.WasDisposed); - Assert.False (sb.WasDisposed); -#endif - tl.Add (mb, sb); - Assert.NotNull (tl.MenuBar); - - //Assert.NotNull (tl.StatusBar); -#if DEBUG - Assert.False (mb.WasDisposed); - Assert.False (sb.WasDisposed); -#endif - tl.RemoveAll (); - Assert.Null (tl.MenuBar); - - //Assert.Null (tl.StatusBar); -#if DEBUG - Assert.False (mb.WasDisposed); - Assert.False (sb.WasDisposed); -#endif - } -} diff --git a/Tests/UnitTests/Views/TreeTableSourceTests.cs b/Tests/UnitTests/Views/TreeTableSourceTests.cs index 43d5a2059..e8b884c7e 100644 --- a/Tests/UnitTests/Views/TreeTableSourceTests.cs +++ b/Tests/UnitTests/Views/TreeTableSourceTests.cs @@ -55,7 +55,7 @@ public class TreeTableSourceTests : IDisposable // when pressing right we should expand the top route tv.NewKeyDownEvent (Key.CursorRight); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -73,7 +73,7 @@ public class TreeTableSourceTests : IDisposable // when pressing left we should collapse the top route again tv.NewKeyDownEvent (Key.CursorLeft); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -97,7 +97,7 @@ public class TreeTableSourceTests : IDisposable tv.Style.GetOrCreateColumnStyle (1).MinAcceptableWidth = 1; - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); var expected = @@ -117,7 +117,7 @@ public class TreeTableSourceTests : IDisposable Assert.True (tv.NewMouseEvent (new MouseEventArgs { Position = new (2, 2), Flags = MouseFlags.Button1Clicked })); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -142,7 +142,7 @@ public class TreeTableSourceTests : IDisposable // Clicking on the + again should collapse tv.NewMouseEvent (new MouseEventArgs { Position = new (2, 2), Flags = MouseFlags.Button1Clicked }); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -159,7 +159,7 @@ public class TreeTableSourceTests : IDisposable [AutoInitShutdown] public void TestTreeTableSource_CombinedWithCheckboxes () { - Toplevel top = new (); + Runnable top = new (); TableView tv = GetTreeTable (out TreeView treeSource); CheckBoxTableSourceWrapperByIndex checkSource; @@ -195,7 +195,7 @@ public class TreeTableSourceTests : IDisposable Application.RaiseKeyDownEvent (Key.CursorRight); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -213,7 +213,7 @@ public class TreeTableSourceTests : IDisposable tv.NewKeyDownEvent (Key.CursorDown); tv.NewKeyDownEvent (Key.Space); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); expected = @@ -239,8 +239,11 @@ public class TreeTableSourceTests : IDisposable private TableView GetTreeTable (out TreeView tree) { - var tableView = new TableView (); - tableView.SchemeName = "TopLevel"; + var tableView = new TableView () + { + Driver = ApplicationImpl.Instance.Driver, + }; + tableView.SchemeName = "Runnable"; tableView.Viewport = new Rectangle (0, 0, 40, 6); tableView.Style.ShowHorizontalHeaderUnderline = true; @@ -294,7 +297,7 @@ public class TreeTableSourceTests : IDisposable tableView.EndInit (); tableView.LayoutSubViews (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (tableView); top.SetFocus (); Assert.Equal (tableView, top.MostFocused); diff --git a/Tests/UnitTests/Views/TreeViewTests.cs b/Tests/UnitTests/Views/TreeViewTests.cs index 88b9cde4b..af95f268e 100644 --- a/Tests/UnitTests/Views/TreeViewTests.cs +++ b/Tests/UnitTests/Views/TreeViewTests.cs @@ -93,14 +93,14 @@ public class TreeViewTests (ITestOutputHelper output) [AutoInitShutdown] public void CursorVisibility_MultiSelect () { - var tv = new TreeView { Width = 20, Height = 10 }; + var tv = new TreeView () { Driver = ApplicationImpl.Instance.Driver, Width = 20, Height = 10 }; var n1 = new TreeNode ("normal"); var n2 = new TreeNode ("pink"); tv.AddObject (n1); tv.AddObject (n2); - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); Application.Begin (top); @@ -698,7 +698,11 @@ public class TreeViewTests (ITestOutputHelper output) [SetupFakeApplication] public void TestBottomlessTreeView_MaxDepth_3 () { - TreeView tv = new () { Width = 20, Height = 10 }; + TreeView tv = new () + { + Driver = ApplicationImpl.Instance.Driver, + Width = 20, Height = 10 + }; tv.TreeBuilder = new DelegateTreeBuilder ( s => new [] { (int.Parse (s) + 1).ToString () } @@ -718,7 +722,7 @@ public class TreeViewTests (ITestOutputHelper output) ); tv.MaxDepth = 3; tv.ExpandAll (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); // Normal drawing of the tree view @@ -737,7 +741,7 @@ public class TreeViewTests (ITestOutputHelper output) [SetupFakeApplication] public void TestBottomlessTreeView_MaxDepth_5 () { - TreeView tv = new () { Width = 20, Height = 10 }; + TreeView tv = new () { Driver = ApplicationImpl.Instance.Driver, Width = 20, Height = 10 }; tv.TreeBuilder = new DelegateTreeBuilder ( s => new [] { (int.Parse (s) + 1).ToString () } @@ -757,7 +761,7 @@ public class TreeViewTests (ITestOutputHelper output) ); tv.MaxDepth = 5; tv.ExpandAll (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); @@ -785,7 +789,7 @@ public class TreeViewTests (ITestOutputHelper output) Assert.True (tv.CanExpand ("5")); Assert.False (tv.IsExpanded ("5")); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); @@ -806,7 +810,7 @@ public class TreeViewTests (ITestOutputHelper output) [SetupFakeApplication] public void TestGetObjectOnRow () { - var tv = new TreeView { Width = 20, Height = 10 }; + var tv = new TreeView () { Driver = ApplicationImpl.Instance.Driver, Width = 20, Height = 10 }; tv.BeginInit (); tv.EndInit (); var n1 = new TreeNode ("normal"); @@ -840,7 +844,7 @@ public class TreeViewTests (ITestOutputHelper output) Assert.Null (tv.GetObjectOnRow (4)); tv.Collapse (n1); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); @@ -862,7 +866,7 @@ public class TreeViewTests (ITestOutputHelper output) [SetupFakeApplication] public void TestGetObjectRow () { - var tv = new TreeView { Width = 20, Height = 10 }; + var tv = new TreeView () { Driver = ApplicationImpl.Instance.Driver, Width = 20, Height = 10 }; var n1 = new TreeNode ("normal"); var n1_1 = new TreeNode ("pink"); @@ -877,7 +881,7 @@ public class TreeViewTests (ITestOutputHelper output) tv.SetScheme (new Scheme ()); tv.LayoutSubViews (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsAre ( @@ -897,7 +901,7 @@ public class TreeViewTests (ITestOutputHelper output) tv.Collapse (n1); tv.LayoutSubViews (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsAre ( @@ -915,7 +919,7 @@ public class TreeViewTests (ITestOutputHelper output) tv.ScrollOffsetVertical = 1; tv.LayoutSubViews (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsAre ( @@ -933,7 +937,7 @@ public class TreeViewTests (ITestOutputHelper output) [SetupFakeApplication] public void TestTreeView_DrawLineEvent () { - var tv = new TreeView { Width = 20, Height = 10 }; + var tv = new TreeView () { Driver = ApplicationImpl.Instance.Driver, Width = 20, Height = 10 }; List> eventArgs = new (); @@ -952,7 +956,7 @@ public class TreeViewTests (ITestOutputHelper output) tv.SetScheme (new Scheme ()); tv.LayoutSubViews (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); // Normal drawing of the tree view @@ -975,10 +979,10 @@ public class TreeViewTests (ITestOutputHelper output) Assert.All (eventArgs, ea => Assert.Equal (ea.Tree, tv)); Assert.All (eventArgs, ea => Assert.False (ea.Handled)); - Assert.Equal ("├-root one", eventArgs [0].Cells.Aggregate ("", (s, n) => s += n.Rune).TrimEnd ()); - Assert.Equal ("│ ├─leaf 1", eventArgs [1].Cells.Aggregate ("", (s, n) => s += n.Rune).TrimEnd ()); - Assert.Equal ("│ └─leaf 2", eventArgs [2].Cells.Aggregate ("", (s, n) => s += n.Rune).TrimEnd ()); - Assert.Equal ("└─root two", eventArgs [3].Cells.Aggregate ("", (s, n) => s += n.Rune).TrimEnd ()); + Assert.Equal ("├-root one", eventArgs [0].Cells.Aggregate ("", (s, n) => s += n.Grapheme).TrimEnd ()); + Assert.Equal ("│ ├─leaf 1", eventArgs [1].Cells.Aggregate ("", (s, n) => s += n.Grapheme).TrimEnd ()); + Assert.Equal ("│ └─leaf 2", eventArgs [2].Cells.Aggregate ("", (s, n) => s += n.Grapheme).TrimEnd ()); + Assert.Equal ("└─root two", eventArgs [3].Cells.Aggregate ("", (s, n) => s += n.Grapheme).TrimEnd ()); Assert.Equal (1, eventArgs [0].IndexOfExpandCollapseSymbol); Assert.Equal (3, eventArgs [1].IndexOfExpandCollapseSymbol); @@ -1000,7 +1004,7 @@ public class TreeViewTests (ITestOutputHelper output) [SetupFakeApplication] public void TestTreeView_DrawLineEvent_Handled () { - var tv = new TreeView { Width = 20, Height = 10 }; + var tv = new TreeView () { Driver = ApplicationImpl.Instance.Driver, Width = 20, Height = 10 }; tv.DrawLine += (s, e) => { @@ -1046,7 +1050,7 @@ FFFFFFFFFF [SetupFakeApplication] public void TestTreeView_DrawLineEvent_WithScrolling () { - var tv = new TreeView { Width = 20, Height = 10 }; + var tv = new TreeView () { Driver = ApplicationImpl.Instance.Driver, Width = 20, Height = 10 }; List> eventArgs = new (); @@ -1088,9 +1092,9 @@ oot two Assert.All (eventArgs, ea => Assert.Equal (ea.Tree, tv)); Assert.All (eventArgs, ea => Assert.False (ea.Handled)); - Assert.Equal ("─leaf 1", eventArgs [0].Cells.Aggregate ("", (s, n) => s += n.Rune).TrimEnd ()); - Assert.Equal ("─leaf 2", eventArgs [1].Cells.Aggregate ("", (s, n) => s += n.Rune).TrimEnd ()); - Assert.Equal ("oot two", eventArgs [2].Cells.Aggregate ("", (s, n) => s += n.Rune).TrimEnd ()); + Assert.Equal ("─leaf 1", eventArgs [0].Cells.Aggregate ("", (s, n) => s += n.Grapheme).TrimEnd ()); + Assert.Equal ("─leaf 2", eventArgs [1].Cells.Aggregate ("", (s, n) => s += n.Grapheme).TrimEnd ()); + Assert.Equal ("oot two", eventArgs [2].Cells.Aggregate ("", (s, n) => s += n.Grapheme).TrimEnd ()); Assert.Equal (0, eventArgs [0].IndexOfExpandCollapseSymbol); Assert.Equal (0, eventArgs [1].IndexOfExpandCollapseSymbol); @@ -1109,7 +1113,7 @@ oot two [SetupFakeApplication] public void TestTreeView_Filter () { - var tv = new TreeView { Width = 20, Height = 10 }; + var tv = new TreeView () { Driver = ApplicationImpl.Instance.Driver, Width = 20, Height = 10 }; var n1 = new TreeNode ("root one"); var n1_1 = new TreeNode ("leaf 1"); @@ -1141,7 +1145,7 @@ oot two // matches nothing filter.Text = "asdfjhasdf"; - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); // Normal drawing of the tree view @@ -1152,7 +1156,7 @@ oot two // Matches everything filter.Text = "root"; - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsAre ( @@ -1167,7 +1171,7 @@ oot two // Matches 2 leaf nodes filter.Text = "leaf"; - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsAre ( @@ -1181,7 +1185,7 @@ oot two // Matches 1 leaf nodes filter.Text = "leaf 1"; - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); DriverAssert.AssertDriverContentsAre ( @@ -1197,7 +1201,7 @@ oot two [SetupFakeApplication] public void TestTreeViewColor () { - var tv = new TreeView { Width = 20, Height = 10 }; + var tv = new TreeView () { Driver = ApplicationImpl.Instance.Driver, Width = 20, Height = 10 }; tv.BeginInit (); tv.EndInit (); var n1 = new TreeNode ("normal"); @@ -1253,7 +1257,7 @@ oot two // redraw now that the custom color // delegate is registered tv.SetNeedsDraw (); - View.SetClipToScreen (); + tv.SetClipToScreen (); tv.Draw (); // Same text diff --git a/Tests/UnitTests/Views/ViewDisposalTest.cs b/Tests/UnitTests/Views/ViewDisposalTest.cs index dc2bc58ea..0d47d6a5a 100644 --- a/Tests/UnitTests/Views/ViewDisposalTest.cs +++ b/Tests/UnitTests/Views/ViewDisposalTest.cs @@ -34,7 +34,7 @@ public class ViewDisposalTest (ITestOutputHelper output) { GetSpecialParams (); var container = new View () { Id = "container" }; - Toplevel top = new () { Id = "top" }; + Runnable top = new () { Id = "top" }; List views = GetViews (); foreach (Type view in views) diff --git a/Tests/UnitTests/Views/WindowTests.cs b/Tests/UnitTests/Views/WindowTests.cs index 32d524549..26abfd270 100644 --- a/Tests/UnitTests/Views/WindowTests.cs +++ b/Tests/UnitTests/Views/WindowTests.cs @@ -3,117 +3,8 @@ using Xunit.Abstractions; namespace UnitTests.ViewsTests; -public class WindowTests (ITestOutputHelper output) +public class WindowTests () { - [Fact] - [AutoInitShutdown] - public void Activating_MenuBar_By_Alt_Key_Does_Not_Throw () - { - var menu = new MenuBar - { - Menus = - [ - new MenuBarItem ("Child", new MenuItem [] { new ("_Create Child", "", null) }) - ] - }; - var win = new Window (); - win.Add (menu); - var top = new Toplevel (); - top.Add (win); - Application.Begin (top); - - Exception exception = Record.Exception (() => win.NewKeyDownEvent (KeyCode.AltMask)); - Assert.Null (exception); - top.Dispose (); - } - - [Fact] - [AutoInitShutdown] - public void MenuBar_And_StatusBar_Inside_Window () - { - var menu = new MenuBar - { - Menus = - [ - new MenuBarItem ("File", new MenuItem [] { new ("Open", "", null), new ("Quit", "", null) }), - new MenuBarItem ( - "Edit", - new MenuItem [] { new ("Copy", "", null) } - ) - ] - }; - - var sb = new StatusBar (); - - var fv = new FrameView { Y = 1, Width = Dim.Fill (), Height = Dim.Fill (1), Title = "Frame View", BorderStyle = LineStyle.Single }; - var win = new Window (); - win.Add (menu, sb, fv); - Toplevel top = new (); - top.Add (win); - Application.Begin (top); - Application.Driver!.SetScreenSize (20, 10); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────┐ -│ File Edit │ -│┌┤Frame View├────┐│ -││ ││ -││ ││ -││ ││ -││ ││ -│└────────────────┘│ -│ │ -└──────────────────┘", - output - ); - - Application.Driver!.SetScreenSize (40, 20); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────────────────────────┐ -│ File Edit │ -│┌┤Frame View├────────────────────────┐│ -││ ││ -││ ││ -││ ││ -││ ││ -││ ││ -││ ││ -││ ││ -││ ││ -││ ││ -││ ││ -││ ││ -││ ││ -││ ││ -││ ││ -│└────────────────────────────────────┘│ -│ │ -└──────────────────────────────────────┘", - output - ); - - Application.Driver!.SetScreenSize (20, 10); - - DriverAssert.AssertDriverContentsWithFrameAre ( - @" -┌──────────────────┐ -│ File Edit │ -│┌┤Frame View├────┐│ -││ ││ -││ ││ -││ ││ -││ ││ -│└────────────────┘│ -│ │ -└──────────────────┘", - output - ); - top.Dispose (); - } - [Fact] public void New_Initializes () { @@ -123,7 +14,7 @@ public class WindowTests (ITestOutputHelper output) Assert.NotNull (defaultWindow); Assert.Equal (string.Empty, defaultWindow.Title); - // Toplevels have Width/Height set to Dim.Fill + // Runnables have Width/Height set to Dim.Fill // If there's no SuperView, Top, or Driver, the default Fill width is int.MaxValue Assert.Equal ($"Window(){defaultWindow.Frame}", defaultWindow.ToString ()); diff --git a/Tests/UnitTestsParallelizable/Application/Application.NavigationTests.cs b/Tests/UnitTestsParallelizable/Application/Application.NavigationTests.cs new file mode 100644 index 000000000..6d25610bd --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/Application.NavigationTests.cs @@ -0,0 +1,149 @@ +using Xunit.Abstractions; + +namespace ApplicationTests; + +public class ApplicationNavigationTests (ITestOutputHelper output) +{ + private readonly ITestOutputHelper _output = output; + + [Theory] + [InlineData (TabBehavior.NoStop)] + [InlineData (TabBehavior.TabStop)] + [InlineData (TabBehavior.TabGroup)] + public void Begin_SetsFocus_On_Deepest_Focusable_View (TabBehavior behavior) + { + using IApplication? application = Application.Create (); + + Runnable runnable = new() + { + TabStop = behavior, + CanFocus = true + }; + + View subView = new () + { + CanFocus = true, + TabStop = behavior + }; + runnable.Add (subView); + + View subSubView = new () + { + CanFocus = true, + TabStop = TabBehavior.NoStop + }; + subView.Add (subSubView); + + SessionToken? rs = application.Begin (runnable); + Assert.True (runnable.HasFocus); + Assert.True (subView.HasFocus); + Assert.True (subSubView.HasFocus); + + runnable.Dispose (); + } + + [Fact] + public void Begin_SetsFocus_On_Top () + { + using IApplication? application = Application.Create (); + + Runnable runnable = new () { CanFocus = true }; + Assert.False (runnable.HasFocus); + + application.Begin (runnable); + Assert.True (runnable.HasFocus); + + runnable.Dispose (); + } + + [Fact] + public void Focused_Change_Raises_FocusedChanged () + { + using IApplication? application = Application.Create (); + + var raised = false; + + application.Navigation!.FocusedChanged += ApplicationNavigationOnFocusedChanged; + + application.Navigation.SetFocused (new () { CanFocus = true, HasFocus = true }); + + Assert.True (raised); + + application.Navigation.FocusedChanged -= ApplicationNavigationOnFocusedChanged; + + return; + + void ApplicationNavigationOnFocusedChanged (object? sender, EventArgs e) { raised = true; } + } + + [Fact] + public void GetFocused_Returns_Focused_View () + { + using IApplication app = Application.Create (); + + app.Begin ( + new Runnable + { + Id = "top", + CanFocus = true, + App = app + }); + + var subView1 = new View + { + Id = "subView1", + CanFocus = true + }; + + var subView2 = new View + { + Id = "subView2", + CanFocus = true + }; + + app.TopRunnableView?.Add (subView1, subView2); + subView1.SetFocus (); + + //app.TopRunnableView?.SetFocus (); + Assert.True (subView1.HasFocus); + Assert.Equal (subView1, app.Navigation?.GetFocused ()); + + app.Navigation?.AdvanceFocus (NavigationDirection.Forward, null); + Assert.Equal (subView2, app.Navigation?.GetFocused ()); + } + + [Fact] + public void GetFocused_Returns_Null_If_No_Focused_View () + { + using IApplication app = Application.Create (); + + app.Begin ( + new Runnable + { + Id = "top", + CanFocus = true, + App = app + }); + + var subView1 = new View + { + Id = "subView1", + CanFocus = true + }; + + app.TopRunnableView!.Add (subView1); + + app.TopRunnableView.SetFocus (); + Assert.True (subView1.HasFocus); + Assert.Equal (subView1, app.Navigation!.GetFocused ()); + + subView1.HasFocus = false; + Assert.False (subView1.HasFocus); + Assert.True (app.TopRunnableView.HasFocus); + Assert.Equal (app.TopRunnableView, app.Navigation.GetFocused ()); + + app.TopRunnableView.HasFocus = false; + Assert.False (app.TopRunnableView.HasFocus); + Assert.Null (app.Navigation.GetFocused ()); + } +} diff --git a/Tests/UnitTestsParallelizable/Application/ApplicationImplBeginEndTests.cs b/Tests/UnitTestsParallelizable/Application/ApplicationImplBeginEndTests.cs new file mode 100644 index 000000000..c331e7a15 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/ApplicationImplBeginEndTests.cs @@ -0,0 +1,407 @@ +using Xunit.Abstractions; + +namespace ApplicationTests; + +/// +/// Comprehensive tests for ApplicationImpl.Begin/End logic that manages Current and SessionStack. +/// These tests ensure the fragile state management logic is robust and catches regressions. +/// Tests work directly with ApplicationImpl instances to avoid global Application state issues. +/// +public class ApplicationImplBeginEndTests (ITestOutputHelper output) +{ + private readonly ITestOutputHelper _output = output; + + [Fact] + public void Begin_WithNullRunnable_ThrowsArgumentNullException () + { + IApplication app = Application.Create (); + + try + { + Assert.Throws (() => app.Begin (null!)); + } + finally + { + app.Dispose (); + } + } + + [Fact] + public void Begin_SetsCurrent_WhenCurrentIsNull () + { + IApplication app = Application.Create (); + Runnable? runnable = null; + + try + { + runnable = new (); + Assert.Null (app.TopRunnableView); + + app.Begin (runnable); + + Assert.NotNull (app.TopRunnableView); + Assert.Same (runnable, app.TopRunnableView); + Assert.Single (app.SessionStack!); + } + finally + { + runnable?.Dispose (); + app.Dispose (); + } + } + + [Fact] + public void Begin_PushesToSessionStack () + { + IApplication app = Application.Create (); + Runnable? runnable1 = null; + Runnable? runnable2 = null; + + try + { + runnable1 = new () { Id = "1" }; + runnable2 = new () { Id = "2" }; + + app.Begin (runnable1); + Assert.Single (app.SessionStack!); + Assert.Same (runnable1, app.TopRunnableView); + + app.Begin (runnable2); + Assert.Equal (2, app.SessionStack!.Count); + Assert.Same (runnable2, app.TopRunnableView); + } + finally + { + runnable1?.Dispose (); + runnable2?.Dispose (); + app.Dispose (); + } + } + + [Fact] + public void End_WithNullSessionToken_ThrowsArgumentNullException () + { + IApplication app = Application.Create (); + + try + { + Assert.Throws (() => app.End (null!)); + } + finally + { + app.Dispose (); + } + } + + [Fact] + public void End_PopsSessionStack () + { + IApplication app = Application.Create (); + Runnable? runnable1 = null; + Runnable? runnable2 = null; + + try + { + runnable1 = new () { Id = "1" }; + runnable2 = new () { Id = "2" }; + + SessionToken token1 = app.Begin (runnable1)!; + SessionToken token2 = app.Begin (runnable2)!; + + Assert.Equal (2, app.SessionStack!.Count); + + app.End (token2); + + Assert.Single (app.SessionStack!); + Assert.Same (runnable1, app.TopRunnableView); + + app.End (token1); + + Assert.Empty (app.SessionStack!); + } + finally + { + runnable1?.Dispose (); + runnable2?.Dispose (); + app.Dispose (); + } + } + + [Fact (Skip = "This test may be bogus. What's wrong with ending a non-top session?")] + public void End_ThrowsArgumentException_WhenNotBalanced () + { + IApplication app = Application.Create (); + Runnable? runnable1 = null; + Runnable? runnable2 = null; + + try + { + runnable1 = new () { Id = "1" }; + runnable2 = new () { Id = "2" }; + + SessionToken? token1 = app.Begin (runnable1); + SessionToken? token2 = app.Begin (runnable2); + + // Trying to end token1 when token2 is on top should throw + // NOTE: This throws but has the side effect of popping token2 from the stack + Assert.Throws (() => app.End (token1!)); + + // Don't try to clean up with more End calls - the state is now inconsistent + // Let Shutdown/ResetState handle cleanup + } + finally + { + // Dispose runnables BEFORE Shutdown to satisfy DEBUG_IDISPOSABLE assertions + runnable1?.Dispose (); + runnable2?.Dispose (); + + // Shutdown will call ResetState which clears any remaining state + app.Dispose (); + } + } + + [Fact] + public void End_RestoresCurrentToPreviousRunnable () + { + IApplication app = Application.Create (); + Runnable? runnable1 = null; + Runnable? runnable2 = null; + Runnable? runnable3 = null; + + try + { + runnable1 = new () { Id = "1" }; + runnable2 = new () { Id = "2" }; + runnable3 = new () { Id = "3" }; + + SessionToken? token1 = app.Begin (runnable1); + SessionToken? token2 = app.Begin (runnable2); + SessionToken? token3 = app.Begin (runnable3); + + Assert.Same (runnable3, app.TopRunnableView); + + app.End (token3!); + Assert.Same (runnable2, app.TopRunnableView); + + app.End (token2!); + Assert.Same (runnable1, app.TopRunnableView); + + app.End (token1!); + } + finally + { + runnable1?.Dispose (); + runnable2?.Dispose (); + runnable3?.Dispose (); + app.Dispose (); + } + } + + [Fact] + public void MultipleBeginEnd_MaintainsStackIntegrity () + { + IApplication app = Application.Create (); + List runnables = new (); + List tokens = new (); + + try + { + // Begin multiple runnables + for (var i = 0; i < 5; i++) + { + var runnable = new Runnable { Id = $"runnable-{i}" }; + runnables.Add (runnable); + SessionToken? token = app.Begin (runnable); + tokens.Add (token!); + } + + Assert.Equal (5, app.SessionStack!.Count); + Assert.Same (runnables [4], app.TopRunnableView); + + // End them in reverse order (LIFO) + for (var i = 4; i >= 0; i--) + { + app.End (tokens [i]); + + if (i > 0) + { + Assert.Equal (i, app.SessionStack.Count); + Assert.Same (runnables [i - 1], app.TopRunnableView); + } + else + { + Assert.Empty (app.SessionStack); + } + } + } + finally + { + foreach (Runnable runnable in runnables) + { + runnable.Dispose (); + } + + app.Dispose (); + } + } + + [Fact] + public void End_NullsSessionTokenRunnable () + { + IApplication app = Application.Create (); + Runnable? runnable = null; + + try + { + runnable = new (); + + SessionToken? token = app.Begin (runnable); + Assert.Same (runnable, token!.Runnable); + + app.End (token); + + Assert.Null (token.Runnable); + } + finally + { + runnable?.Dispose (); + app.Dispose (); + } + } + + [Fact] + public void ResetState_ClearsSessionStack () + { + IApplication app = Application.Create (); + Runnable? runnable1 = null; + Runnable? runnable2 = null; + + try + { + runnable1 = new () { Id = "1" }; + runnable2 = new () { Id = "2" }; + + app.Begin (runnable1); + app.Begin (runnable2); + + Assert.Equal (2, app.SessionStack!.Count); + Assert.NotNull (app.TopRunnableView); + } + finally + { + // Dispose runnables BEFORE Shutdown to satisfy DEBUG_IDISPOSABLE assertions + runnable1?.Dispose (); + runnable2?.Dispose (); + + // Shutdown calls ResetState, which will clear SessionStack and set Current to null + app.Dispose (); + + // Verify cleanup happened + Assert.Empty (app.SessionStack!); + Assert.Null (app.TopRunnableView); + } + } + + [Fact] + public void ResetState_StopsAllRunningRunnables () + { + IApplication app = Application.Create (); + Runnable? runnable1 = null; + Runnable? runnable2 = null; + + try + { + runnable1 = new () { Id = "1" }; + runnable2 = new () { Id = "2" }; + + app.Begin (runnable1); + app.Begin (runnable2); + + Assert.True (runnable1.IsRunning); + Assert.True (runnable2.IsRunning); + } + finally + { + // Dispose runnables BEFORE Shutdown to satisfy DEBUG_IDISPOSABLE assertions + runnable1?.Dispose (); + runnable2?.Dispose (); + + // Shutdown calls ResetState, which will stop all running runnables + app.Dispose (); + + // Verify runnables were stopped + Assert.False (runnable1!.IsRunning); + Assert.False (runnable2!.IsRunning); + } + } + + //[Fact] + //public void Begin_ActivatesNewRunnable_WhenCurrentExists () + //{ + // IApplication app = Application.Create (); + // Runnable? runnable1 = null; + // Runnable? runnable2 = null; + + // try + // { + // runnable1 = new () { Id = "1" }; + // runnable2 = new () { Id = "2" }; + + // var runnable1Deactivated = false; + // var runnable2Activated = false; + + // runnable1.Deactivate += (s, e) => runnable1Deactivated = true; + // runnable2.Activate += (s, e) => runnable2Activated = true; + + // app.Begin (runnable1); + // app.Begin (runnable2); + + // Assert.True (runnable1Deactivated); + // Assert.True (runnable2Activated); + // Assert.Same (runnable2, app.TopRunnable); + // } + // finally + // { + // runnable1?.Dispose (); + // runnable2?.Dispose (); + // app.Dispose (); + // } + //} + + [Fact] + public void SessionStack_ContainsAllBegunRunnables () + { + IApplication app = Application.Create (); + List runnables = new (); + + try + { + for (var i = 0; i < 10; i++) + { + var runnable = new Runnable { Id = $"runnable-{i}" }; + runnables.Add (runnable); + app.Begin (runnable); + } + + // All runnables should be in the stack + Assert.Equal (10, app.SessionStack!.Count); + + // Verify stack contains all runnables + List stackList = app.SessionStack.ToList (); + + foreach (Runnable runnable in runnables) + { + Assert.Contains (runnable, stackList.Select (r => r.Runnable)); + } + } + finally + { + foreach (Runnable runnable in runnables) + { + runnable.Dispose (); + } + + app.Dispose (); + } + } +} diff --git a/Tests/UnitTestsParallelizable/Application/ApplicationImplTests.cs b/Tests/UnitTestsParallelizable/Application/ApplicationImplTests.cs new file mode 100644 index 000000000..69478dbca --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/ApplicationImplTests.cs @@ -0,0 +1,561 @@ +using System.Collections.Concurrent; +using Moq; + +namespace ApplicationTests; + +public class ApplicationImplTests +{ + /// + /// Crates a new ApplicationImpl instance for testing. The input, output, and size monitor components are mocked. + /// + private IApplication NewMockedApplicationImpl () + { + Mock netInput = new (); + SetupRunInputMockMethodToBlock (netInput); + + Mock> m = new (); + m.Setup (f => f.CreateInput ()).Returns (netInput.Object); + m.Setup (f => f.CreateInputProcessor (It.IsAny> ())).Returns (Mock.Of ()); + + Mock consoleOutput = new (); + var size = new Size (80, 25); + + consoleOutput.Setup (o => o.SetSize (It.IsAny (), It.IsAny ())) + .Callback ((w, h) => size = new (w, h)); + consoleOutput.Setup (o => o.GetSize ()).Returns (() => size); + m.Setup (f => f.CreateOutput ()).Returns (consoleOutput.Object); + m.Setup (f => f.CreateSizeMonitor (It.IsAny (), It.IsAny ())).Returns (Mock.Of ()); + + return new ApplicationImpl (m.Object); + } + + private void SetupRunInputMockMethodToBlock (Mock netInput) + { + netInput.Setup (r => r.Run (It.IsAny ())) + .Callback (token => + { + // Simulate an infinite loop that checks for cancellation + while (!token.IsCancellationRequested) + { + // Perform the action that should repeat in the loop + // This could be some mock behavior or just an empty loop depending on the context + } + }) + .Verifiable (Times.Once); + } + + [Fact] + public void Init_CreatesKeybindings () + { + IApplication app = NewMockedApplicationImpl (); + + app.Keyboard.KeyBindings.Clear (); + + Assert.Empty (app.Keyboard.KeyBindings.GetBindings ()); + + app.Init ("fake"); + + Assert.NotEmpty (app.Keyboard.KeyBindings.GetBindings ()); + + app.Dispose (); + } + + [Fact] + public void NoInitThrowOnRun () + { + IApplication app = NewMockedApplicationImpl (); + var ex = Assert.Throws (() => app.Run (new Window ())); + app.Dispose (); + } + + [Fact] + public void InitRunShutdown_Top_Set_To_Null_After_Shutdown () + { + IApplication app = NewMockedApplicationImpl (); + + app.Init ("fake"); + + object? timeoutToken = app.AddTimeout ( + TimeSpan.FromMilliseconds (150), + () => + { + if (app.TopRunnableView is { }) + { + app.RequestStop (); + + return false; + } + + return false; + } + ); + Assert.Null (app.TopRunnableView); + + // Blocks until the timeout call is hit + + app.Run (new Window ()); + + // We returned false above, so we should not have to remove the timeout + Assert.False (app.RemoveTimeout (timeoutToken!)); + + Assert.Null (app.TopRunnableView); + app.Dispose (); + Assert.Null (app.TopRunnableView); + } + + [Fact] + public void InitRunShutdown_Running_Set_To_False () + { + IApplication app = NewMockedApplicationImpl ()!; + + app.Init ("fake"); + + IRunnable top = new Window + { + Title = "InitRunShutdown_Running_Set_To_False" + }; + + object? timeoutToken = app.AddTimeout ( + TimeSpan.FromMilliseconds (150), + () => + { + Assert.True (top!.IsRunning); + + if (app.TopRunnableView != null) + { + app.RequestStop (); + + return false; + } + + return false; + } + ); + + Assert.False (top.IsRunning); + + // Blocks until the timeout call is hit + app.Run (top); + + // We returned false above, so we should not have to remove the timeout + Assert.False (app.RemoveTimeout (timeoutToken!)); + + Assert.False (top.IsRunning); + + // BUGBUG: Shutdown sets Top to null, not End. + //Assert.Null (Application.TopRunnable); + app.TopRunnableView?.Dispose (); + app.Dispose (); + } + + [Fact] + public void InitRunShutdown_StopAfterFirstIteration_Stops () + { + IApplication app = NewMockedApplicationImpl ()!; + + Assert.Null (app.TopRunnableView); + Assert.Null (app.Driver); + + app.Init ("fake"); + + IRunnable top = new Window (); + var isIsModalChanged = 0; + + top.IsModalChanged + += (_, a) => { isIsModalChanged++; }; + + var isRunningChangedCount = 0; + + top.IsRunningChanged + += (_, a) => { isRunningChangedCount++; }; + + object? timeoutToken = app.AddTimeout ( + TimeSpan.FromMilliseconds (150), + () => + { + //Assert.Fail (@"Didn't stop after first iteration."); + + return false; + } + ); + + Assert.Equal (0, isIsModalChanged); + Assert.Equal (0, isRunningChangedCount); + + app.StopAfterFirstIteration = true; + app.Run (top); + + Assert.Equal (2, isIsModalChanged); + Assert.Equal (2, isRunningChangedCount); + + app.TopRunnableView?.Dispose (); + app.Dispose (); + Assert.Equal (2, isIsModalChanged); + Assert.Equal (2, isRunningChangedCount); + } + + [Fact] + public void InitRunShutdown_End_Is_Called () + { + IApplication app = NewMockedApplicationImpl ()!; + + Assert.Null (app.TopRunnableView); + Assert.Null (app.Driver); + + app.Init ("fake"); + + IRunnable top = new Window (); + + var isIsModalChanged = 0; + + top.IsModalChanged + += (_, a) => { isIsModalChanged++; }; + + var isRunningChangedCount = 0; + + top.IsRunningChanged + += (_, a) => { isRunningChangedCount++; }; + + object? timeoutToken = app.AddTimeout ( + TimeSpan.FromMilliseconds (150), + () => + { + Assert.True (top!.IsRunning); + + if (app.TopRunnableView != null) + { + app.RequestStop (); + + return false; + } + + return false; + } + ); + + Assert.Equal (0, isIsModalChanged); + Assert.Equal (0, isRunningChangedCount); + + // Blocks until the timeout call is hit + app.Run (top); + + Assert.Equal (2, isIsModalChanged); + Assert.Equal (2, isRunningChangedCount); + + // We returned false above, so we should not have to remove the timeout + Assert.False (app.RemoveTimeout (timeoutToken!)); + + app.TopRunnableView?.Dispose (); + app.Dispose (); + Assert.Equal (2, isIsModalChanged); + Assert.Equal (2, isRunningChangedCount); + } + + [Fact] + public void InitRunShutdown_QuitKey_Quits () + { + IApplication app = NewMockedApplicationImpl ()!; + + app.Init ("fake"); + + IRunnable top = new Window + { + Title = "InitRunShutdown_QuitKey_Quits" + }; + + object? timeoutToken = app.AddTimeout ( + TimeSpan.FromMilliseconds (150), + () => + { + Assert.True (top!.IsRunning); + + if (app.TopRunnableView != null) + { + app.Keyboard.RaiseKeyDownEvent (app.Keyboard.QuitKey); + } + + return false; + } + ); + + Assert.False (top!.IsRunning); + + // Blocks until the timeout call is hit + app.Run (top); + + // We returned false above, so we should not have to remove the timeout + Assert.False (app.RemoveTimeout (timeoutToken!)); + + Assert.False (top!.IsRunning); + + Assert.Null (app.TopRunnableView); + ((top as Window)!).Dispose (); + app.Dispose (); + Assert.Null (app.TopRunnableView); + } + + [Fact] + public void InitRunShutdown_Generic_IdleForExit () + { + IApplication app = NewMockedApplicationImpl ()!; + + app.Init ("fake"); + + app.AddTimeout (TimeSpan.Zero, () => IdleExit (app)); + Assert.Null (app.TopRunnableView); + + // Blocks until the timeout call is hit + + app.Run (); + + Assert.Null (app.TopRunnableView); + app.Dispose (); + Assert.Null (app.TopRunnableView); + } + + [Fact] + public void Run_IsRunningChanging_And_IsRunningChanged_Raised () + { + IApplication app = NewMockedApplicationImpl ()!; + + app.Init ("fake"); + + var isRunningChanging = 0; + var isRunningChanged = 0; + Runnable t = new (); + + t.IsRunningChanging + += (_, a) => { isRunningChanging++; }; + + t.IsRunningChanged + += (_, a) => { isRunningChanged++; }; + + app.AddTimeout (TimeSpan.Zero, () => IdleExit (app)); + + // Blocks until the timeout call is hit + app.Run (t); + + Assert.Equal (2, isRunningChanging); + Assert.Equal (2, isRunningChanged); + } + + [Fact] + public void Run_IsRunningChanging_Cancel_IsRunningChanged_Not_Raised () + { + IApplication app = NewMockedApplicationImpl ()!; + + app.Init ("fake"); + + var isRunningChanging = 0; + var isRunningChanged = 0; + Runnable t = new (); + + t.IsRunningChanging + += (_, a) => + { + // Cancel the first time + if (isRunningChanging == 0) + { + a.Cancel = true; + } + + isRunningChanging++; + }; + + t.IsRunningChanged + += (_, a) => { isRunningChanged++; }; + + app.AddTimeout (TimeSpan.Zero, () => IdleExit (app)); + + // Blocks until the timeout call is hit + + app.Run (t); + + Assert.Equal (1, isRunningChanging); + Assert.Equal (0, isRunningChanged); + } + + private bool IdleExit (IApplication app) + { + if (app.TopRunnableView != null) + { + app.RequestStop (); + + return true; + } + + return true; + } + + [Fact] + public void Open_Calls_ContinueWith_On_UIThread () + { + IApplication app = NewMockedApplicationImpl ()!; + + app.Init ("fake"); + var b = new Button (); + + var result = false; + + b.Accepting += + (_, _) => + { + Task.Run (() => { Task.Delay (300).Wait (); }) + .ContinueWith ( + (t, _) => + { + // no longer loading + app.Invoke (() => + { + result = true; + app.RequestStop (); + }); + }, + TaskScheduler.FromCurrentSynchronizationContext ()); + }; + + app.AddTimeout ( + TimeSpan.FromMilliseconds (150), + () => + { + // Run asynchronous logic inside Task.Run + if (app.TopRunnableView != null) + { + b.NewKeyDownEvent (Key.Enter); + b.NewKeyUpEvent (Key.Enter); + } + + return false; + }); + + Assert.Null (app.TopRunnableView); + + var w = new Window + { + Title = "Open_CallsContinueWithOnUIThread" + }; + w.Add (b); + + // Blocks until the timeout call is hit + app.Run (w); + + w?.Dispose (); + app.Dispose (); + + Assert.True (result); + } + + [Fact] + public void ApplicationImpl_UsesInstanceFields_NotStaticReferences () + { + // This test verifies that ApplicationImpl uses instance fields instead of static Application references + IApplication v2 = NewMockedApplicationImpl ()!; + + // Before Init, all fields should be null/default + Assert.Null (v2.Driver); + Assert.False (v2.Initialized); + + //Assert.Null (v2.Popover); + //Assert.Null (v2.Navigation); + Assert.Null (v2.TopRunnableView); + Assert.Empty (v2.SessionStack!); + + // Init should populate instance fields + v2.Init ("fake"); + + // After Init, Driver, Navigation, and Popover should be populated + Assert.NotNull (v2.Driver); + Assert.True (v2.Initialized); + Assert.NotNull (v2.Popover); + Assert.NotNull (v2.Navigation); + Assert.Null (v2.TopRunnableView); // Top is still null until Run + + // Shutdown should clean up instance fields + v2.Dispose (); + + Assert.Null (v2.Driver); + Assert.False (v2.Initialized); + + //Assert.Null (v2.Popover); + //Assert.Null (v2.Navigation); + Assert.Null (v2.TopRunnableView); + Assert.Empty (v2.SessionStack!); + } + + [Fact] + public void Init_Begin_End_Cleans_Up () + { + IApplication? app = Application.Create (); + + SessionToken? newSessionToken = null; + + EventHandler newSessionTokenFn = (s, e) => + { + Assert.NotNull (e.State); + newSessionToken = e.State; + }; + app.SessionBegun += newSessionTokenFn; + + Runnable runnable = new (); + SessionToken sessionToken = app.Begin (runnable)!; + Assert.NotNull (sessionToken); + Assert.NotNull (newSessionToken); + Assert.Equal (sessionToken, newSessionToken); + + // Assert.Equal (runnable, Application.TopRunnable); + + app.SessionBegun -= newSessionTokenFn; + app.End (newSessionToken); + + Assert.Null (app.TopRunnable); + Assert.Null (app.Driver); + + runnable.Dispose (); + } + + [Fact] + public void Run_RequestStop_Stops () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + + var top = new Runnable (); + SessionToken? sessionToken = app.Begin (top); + Assert.NotNull (sessionToken); + + app.Iteration += OnApplicationOnIteration; + app.Run (top); + app.Iteration -= OnApplicationOnIteration; + + top.Dispose (); + + return; + + void OnApplicationOnIteration (object? s, EventArgs a) { app.RequestStop (); } + } + + [Fact] + public void Run_T_Init_Driver_Cleared_with_Runnable_Throws () + { + IApplication? app = Application.Create (); + + app.Init ("fake"); + app.Driver = null; + + app.StopAfterFirstIteration = true; + + // Init has been called, but Driver has been set to null. Bad. + Assert.Throws (() => app.Run ()); + } + + [Fact] + public void Init_Unbalanced_Throws () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + + Assert.Throws (() => + app.Init ("fake") + ); + } +} diff --git a/Tests/UnitTestsParallelizable/Application/ApplicationMouseEnterLeaveTests.cs b/Tests/UnitTestsParallelizable/Application/ApplicationMouseEnterLeaveTests.cs new file mode 100644 index 000000000..c03a1d477 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/ApplicationMouseEnterLeaveTests.cs @@ -0,0 +1,454 @@ +#nullable enable +using System.ComponentModel; + +namespace ApplicationTests; + +[Trait ("Category", "Input")] +public class ApplicationMouseEnterLeaveTests +{ + private class TestView : View + { + public TestView () + { + X = 1; + Y = 1; + Width = 1; + Height = 1; + } + + // public bool CancelOnEnter { get; } + public int OnMouseEnterCalled { get; private set; } + public int OnMouseLeaveCalled { get; private set; } + + protected override bool OnMouseEnter (CancelEventArgs eventArgs) + { + OnMouseEnterCalled++; + // eventArgs.Cancel = CancelOnEnter; + + base.OnMouseEnter (eventArgs); + + return eventArgs.Cancel; + } + + protected override void OnMouseLeave () + { + OnMouseLeaveCalled++; + + base.OnMouseLeave (); + } + } + + [Fact] + public void RaiseMouseEnterLeaveEvents_MouseEntersView_CallsOnMouseEnter () + { + IApplication? app = Application.Create (); + Runnable runnable = new () { Frame = new (0, 0, 10, 10) }; + app.Begin (runnable); + + // Arrange + var view = new TestView (); + runnable.Add (view); + var mousePosition = new Point (1, 1); + List currentViewsUnderMouse = [view]; + + var mouseEvent = new MouseEventArgs + { + Position = mousePosition, + ScreenPosition = mousePosition + }; + + app.Mouse.CachedViewsUnderMouse.Clear (); + + try + { + // Act + app.Mouse.RaiseMouseEnterLeaveEvents (mousePosition, currentViewsUnderMouse); + + // Assert + Assert.Equal (1, view.OnMouseEnterCalled); + } + finally + { + // Cleanup + app.Mouse.ResetState (); + } + } + + [Fact] + public void RaiseMouseEnterLeaveEvents_MouseLeavesView_CallsOnMouseLeave () + { + // Arrange + IApplication? app = Application.Create (); + Runnable runnable = new () { Frame = new (0, 0, 10, 10) }; + app.Begin (runnable); + + var view = new TestView (); + runnable.Add (view); + var mousePosition = new Point (0, 0); + List currentViewsUnderMouse = new (); + var mouseEvent = new MouseEventArgs (); + + app.Mouse.CachedViewsUnderMouse.Clear (); + app.Mouse.CachedViewsUnderMouse.Add (view); + + // Act + app.Mouse.RaiseMouseEnterLeaveEvents (mousePosition, currentViewsUnderMouse); + + // Assert + Assert.Equal (0, view.OnMouseEnterCalled); + Assert.Equal (1, view.OnMouseLeaveCalled); + } + + [Fact] + public void RaiseMouseEnterLeaveEvents_MouseMovesBetweenAdjacentViews_CallsOnMouseEnterAndLeave () + { + // Arrange + IApplication? app = Application.Create (); + Runnable runnable = new () { Frame = new (0, 0, 10, 10) }; + app.Begin (runnable); + var view1 = new TestView (); // at 1,1 to 2,2 + + var view2 = new TestView () // at 2,2 to 3,3 + { + X = 2, + Y = 2 + }; + runnable.Add (view1); + runnable.Add (view2); + + app.Mouse.CachedViewsUnderMouse.Clear (); + + // Act + var mousePosition = new Point (0, 0); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (0, view1.OnMouseEnterCalled); + Assert.Equal (0, view1.OnMouseLeaveCalled); + Assert.Equal (0, view2.OnMouseEnterCalled); + Assert.Equal (0, view2.OnMouseLeaveCalled); + + // Act + mousePosition = new (1, 1); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (0, view1.OnMouseLeaveCalled); + Assert.Equal (0, view2.OnMouseEnterCalled); + Assert.Equal (0, view2.OnMouseLeaveCalled); + + // Act + mousePosition = new (2, 2); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (1, view1.OnMouseLeaveCalled); + Assert.Equal (1, view2.OnMouseEnterCalled); + Assert.Equal (0, view2.OnMouseLeaveCalled); + + // Act + mousePosition = new (3, 3); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (1, view1.OnMouseLeaveCalled); + Assert.Equal (1, view2.OnMouseEnterCalled); + Assert.Equal (1, view2.OnMouseLeaveCalled); + + // Act + mousePosition = new (0, 0); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (1, view1.OnMouseLeaveCalled); + Assert.Equal (1, view2.OnMouseEnterCalled); + Assert.Equal (1, view2.OnMouseLeaveCalled); + + } + + [Fact] + public void RaiseMouseEnterLeaveEvents_NoViewsUnderMouse_DoesNotCallOnMouseEnterOrLeave () + { + // Arrange + IApplication? app = Application.Create (); + Runnable runnable = new () { Frame = new (0, 0, 10, 10) }; + app.Begin (runnable); + var view = new TestView (); + runnable.Add (view); + var mousePosition = new Point (0, 0); + List currentViewsUnderMouse = new (); + var mouseEvent = new MouseEventArgs (); + + app.Mouse.CachedViewsUnderMouse.Clear (); + + // Act + app.Mouse.RaiseMouseEnterLeaveEvents (mousePosition, currentViewsUnderMouse); + + // Assert + Assert.Equal (0, view.OnMouseEnterCalled); + Assert.Equal (0, view.OnMouseLeaveCalled); + + } + + [Fact] + public void RaiseMouseEnterLeaveEvents_MouseMovesBetweenOverlappingPeerViews_CallsOnMouseEnterAndLeave () + { + // Arrange + IApplication? app = Application.Create (); + Runnable runnable = new () { Frame = new (0, 0, 10, 10) }; + app.Begin (runnable); + + var view1 = new TestView + { + Width = 2 + }; // at 1,1 to 3,2 + + var view2 = new TestView () // at 2,2 to 4,3 + { + Width = 2, + X = 2, + Y = 2 + }; + runnable.Add (view1); + runnable.Add (view2); + + app.Mouse.CachedViewsUnderMouse.Clear (); + + // Act + var mousePosition = new Point (0, 0); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (0, view1.OnMouseEnterCalled); + Assert.Equal (0, view1.OnMouseLeaveCalled); + Assert.Equal (0, view2.OnMouseEnterCalled); + Assert.Equal (0, view2.OnMouseLeaveCalled); + + // Act + mousePosition = new (1, 1); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (0, view1.OnMouseLeaveCalled); + Assert.Equal (0, view2.OnMouseEnterCalled); + Assert.Equal (0, view2.OnMouseLeaveCalled); + + // Act + mousePosition = new (2, 2); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (1, view1.OnMouseLeaveCalled); + Assert.Equal (1, view2.OnMouseEnterCalled); + Assert.Equal (0, view2.OnMouseLeaveCalled); + + // Act + mousePosition = new (3, 3); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (1, view1.OnMouseLeaveCalled); + Assert.Equal (1, view2.OnMouseEnterCalled); + Assert.Equal (1, view2.OnMouseLeaveCalled); + + // Act + mousePosition = new (0, 0); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (1, view1.OnMouseLeaveCalled); + Assert.Equal (1, view2.OnMouseEnterCalled); + Assert.Equal (1, view2.OnMouseLeaveCalled); + + // Act + mousePosition = new (2, 2); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (1, view1.OnMouseLeaveCalled); + Assert.Equal (2, view2.OnMouseEnterCalled); + Assert.Equal (1, view2.OnMouseLeaveCalled); + + } + + [Fact] + public void RaiseMouseEnterLeaveEvents_MouseMovesBetweenOverlappingSubViews_CallsOnMouseEnterAndLeave () + { + // Arrange + IApplication? app = Application.Create (); + Runnable runnable = new () { Frame = new (0, 0, 10, 10) }; + app.Begin (runnable); + + var view1 = new TestView + { + Id = "view1", + Width = 2, + Height = 2, + Arrangement = ViewArrangement.Overlapped + }; // at 1,1 to 3,3 (screen) + + var subView = new TestView + { + Id = "subView", + Width = 2, + Height = 2, + X = 1, + Y = 1, + Arrangement = ViewArrangement.Overlapped + }; // at 2,2 to 4,4 (screen) + view1.Add (subView); + runnable.Add (view1); + + app.Mouse.CachedViewsUnderMouse.Clear (); + + Assert.Equal (1, view1.FrameToScreen ().X); + Assert.Equal (2, subView.FrameToScreen ().X); + + // Act + var mousePosition = new Point (0, 0); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (0, view1.OnMouseEnterCalled); + Assert.Equal (0, view1.OnMouseLeaveCalled); + Assert.Equal (0, subView.OnMouseEnterCalled); + Assert.Equal (0, subView.OnMouseLeaveCalled); + + // Act + mousePosition = new (1, 1); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (0, view1.OnMouseLeaveCalled); + Assert.Equal (0, subView.OnMouseEnterCalled); + Assert.Equal (0, subView.OnMouseLeaveCalled); + + // Act + mousePosition = new (2, 2); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (0, view1.OnMouseLeaveCalled); + Assert.Equal (1, subView.OnMouseEnterCalled); + Assert.Equal (0, subView.OnMouseLeaveCalled); + + // Act + mousePosition = new (0, 0); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (1, view1.OnMouseEnterCalled); + Assert.Equal (1, view1.OnMouseLeaveCalled); + Assert.Equal (1, subView.OnMouseEnterCalled); + Assert.Equal (1, subView.OnMouseLeaveCalled); + + // Act + mousePosition = new (2, 2); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (2, view1.OnMouseEnterCalled); + Assert.Equal (1, view1.OnMouseLeaveCalled); + Assert.Equal (2, subView.OnMouseEnterCalled); + Assert.Equal (1, subView.OnMouseLeaveCalled); + + // Act + mousePosition = new (3, 3); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (2, view1.OnMouseEnterCalled); + Assert.Equal (2, view1.OnMouseLeaveCalled); + Assert.Equal (2, subView.OnMouseEnterCalled); + Assert.Equal (2, subView.OnMouseLeaveCalled); + + // Act + mousePosition = new (0, 0); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (2, view1.OnMouseEnterCalled); + Assert.Equal (2, view1.OnMouseLeaveCalled); + Assert.Equal (2, subView.OnMouseEnterCalled); + Assert.Equal (2, subView.OnMouseLeaveCalled); + + // Act + mousePosition = new (2, 2); + + app.Mouse.RaiseMouseEnterLeaveEvents ( + mousePosition, + runnable.GetViewsUnderLocation (mousePosition, ViewportSettingsFlags.TransparentMouse)); + + // Assert + Assert.Equal (3, view1.OnMouseEnterCalled); + Assert.Equal (2, view1.OnMouseLeaveCalled); + Assert.Equal (3, subView.OnMouseEnterCalled); + Assert.Equal (2, subView.OnMouseLeaveCalled); + + } +} diff --git a/Tests/UnitTestsParallelizable/Application/ApplicationPopoverTests.cs b/Tests/UnitTestsParallelizable/Application/ApplicationPopoverTests.cs index 5bb470c7e..67cda869d 100644 --- a/Tests/UnitTestsParallelizable/Application/ApplicationPopoverTests.cs +++ b/Tests/UnitTestsParallelizable/Application/ApplicationPopoverTests.cs @@ -1,7 +1,8 @@ -#nullable enable +#nullable enable using Moq; +using Terminal.Gui.App; -namespace UnitTests_Parallelizable.ApplicationTests; +namespace ApplicationTests; public class ApplicationPopoverTests { @@ -42,6 +43,7 @@ public class ApplicationPopoverTests // Arrange var popover = new Mock ().Object; var popoverManager = new ApplicationPopover (); + popoverManager.Register (popover); // Act popoverManager.Show (popover); @@ -56,6 +58,7 @@ public class ApplicationPopoverTests // Arrange var popover = new Mock ().Object; var popoverManager = new ApplicationPopover (); + popoverManager.Register (popover); popoverManager.Show (popover); // Act @@ -72,6 +75,8 @@ public class ApplicationPopoverTests // Arrange var popover = new PopoverTestClass (); var popoverManager = new ApplicationPopover (); + popoverManager.Register (popover); + popoverManager.Show (popover); // Act @@ -88,6 +93,7 @@ public class ApplicationPopoverTests // Arrange var popover = new PopoverTestClass (); var popoverManager = new ApplicationPopover (); + popoverManager.Register (popover); popoverManager.Show (popover); // Act @@ -106,6 +112,8 @@ public class ApplicationPopoverTests var activePopover = new PopoverTestClass () { Id = "activePopover" }; var inactivePopover = new PopoverTestClass () { Id = "inactivePopover" }; ; var popoverManager = new ApplicationPopover (); + + popoverManager.Register (activePopover); popoverManager.Show (activePopover); popoverManager.Register (inactivePopover); @@ -126,6 +134,8 @@ public class ApplicationPopoverTests var activePopover = new PopoverTestClass (); var inactivePopover = new PopoverTestClass (); var popoverManager = new ApplicationPopover (); + popoverManager.Register (activePopover); + popoverManager.Show (activePopover); popoverManager.Register (inactivePopover); @@ -181,6 +191,6 @@ public class ApplicationPopoverTests } /// - public Toplevel? Toplevel { get; set; } + public IRunnable? Current { get; set; } } } diff --git a/Tests/UnitTestsParallelizable/Application/ApplicationTests.cs b/Tests/UnitTestsParallelizable/Application/ApplicationTests.cs new file mode 100644 index 000000000..a2608b703 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/ApplicationTests.cs @@ -0,0 +1,550 @@ +#nullable enable +using Xunit.Abstractions; + +namespace ApplicationTests; + +/// +/// Parallelizable tests for IApplication that don't require the main event loop. +/// Tests using the modern non-static IApplication API. +/// +public class ApplicationTests (ITestOutputHelper output) +{ + private readonly ITestOutputHelper _output = output; + + [Fact] + public void AddTimeout_Fires () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + uint timeoutTime = 100; + var timeoutFired = false; + + // Setup a timeout that will fire + app.AddTimeout ( + TimeSpan.FromMilliseconds (timeoutTime), + () => + { + timeoutFired = true; + + // Return false so the timer does not repeat + return false; + } + ); + + // The timeout has not fired yet + Assert.False (timeoutFired); + + // Block the thread to prove the timeout does not fire on a background thread + Thread.Sleep ((int)timeoutTime * 2); + Assert.False (timeoutFired); + + app.StopAfterFirstIteration = true; + app.Run (); + + // The timeout should have fired + Assert.True (timeoutFired); + + app.Dispose (); + } + + [Fact] + public void Begin_Null_Runnable_Throws () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + // Test null Runnable + Assert.Throws (() => app.Begin (null!)); + + app.Dispose (); + } + + [Fact] + public void Begin_Sets_Application_Top_To_Console_Size () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + Assert.Null (app.TopRunnableView); + app.Driver!.SetScreenSize (80, 25); + Runnable top = new (); + SessionToken? token = app.Begin (top); + Assert.Equal (new (0, 0, 80, 25), app.TopRunnableView!.Frame); + app.Driver!.SetScreenSize (5, 5); + app.LayoutAndDraw (); + Assert.Equal (new (0, 0, 5, 5), app.TopRunnableView!.Frame); + + if (token is { }) + { + app.End (token); + } + top.Dispose (); + + app.Dispose (); + } + + [Fact] + public void Init_Null_Driver_Should_Pick_A_Driver () + { + IApplication app = Application.Create (); + app.Init (); + + Assert.NotNull (app.Driver); + + app.Dispose (); + } + + [Fact] + public void Init_Dispose_Cleans_Up () + { + IApplication app = Application.Create (); + + app.Init ("fake"); + + app.Dispose (); + +#if DEBUG_IDISPOSABLE + // Validate there are no outstanding Responder-based instances + // after cleanup + // Note: We can't check View.Instances in parallel tests as it's a static field + // that would be shared across parallel test runs +#endif + } + + [Fact] + public void Init_Dispose_Fire_InitializedChanged () + { + var initialized = false; + var Dispose = false; + + IApplication app = Application.Create (); + + app.InitializedChanged += OnApplicationOnInitializedChanged; + + app.Init (driverName: "fake"); + Assert.True (initialized); + Assert.False (Dispose); + + app.Dispose (); + Assert.True (initialized); + Assert.True (Dispose); + + app.InitializedChanged -= OnApplicationOnInitializedChanged; + + return; + + void OnApplicationOnInitializedChanged (object? s, EventArgs a) + { + if (a.Value) + { + initialized = true; + } + else + { + Dispose = true; + } + } + } + + [Fact] + public void Init_KeyBindings_Are_Not_Reset () + { + IApplication app = Application.Create (); + + // Set via Keyboard property (modern API) + app.Keyboard.QuitKey = Key.Q; + Assert.Equal (Key.Q, app.Keyboard.QuitKey); + + app.Init ("fake"); + + Assert.Equal (Key.Q, app.Keyboard.QuitKey); + + app.Dispose (); + } + + [Fact] + public void Init_NoParam_ForceDriver_Works () + { + using IApplication app = Application.Create (); + + app.ForceDriver = "fake"; + // Note: Init() without params picks up driver configuration + app.Init (); + + Assert.Equal ("fake", app.Driver!.GetName ()); + } + + [Fact] + public void Init_Dispose_Resets_Instance_Properties () + { + IApplication app = Application.Create (); + + // Init the app + app.Init (driverName: "fake"); + + // Verify initialized + Assert.True (app.Initialized); + Assert.NotNull (app.Driver); + + // Dispose cleans up + app.Dispose (); + + // Check reset state on the instance + CheckReset (app); + + // Create a new instance and set values + app = Application.Create (); + app.Init ("fake"); + + app.StopAfterFirstIteration = true; + app.Keyboard.PrevTabGroupKey = Key.A; + app.Keyboard.NextTabGroupKey = Key.B; + app.Keyboard.QuitKey = Key.C; + app.Keyboard.KeyBindings.Add (Key.D, Command.Cancel); + + app.Mouse.CachedViewsUnderMouse.Clear (); + app.Mouse.LastMousePosition = new Point (1, 1); + + // Dispose and check reset + app.Dispose (); + CheckReset (app); + + return; + + void CheckReset (IApplication application) + { + // Check that all fields and properties are reset on the instance + + // Public Properties + Assert.Null (application.TopRunnableView); + Assert.Null (application.Mouse.MouseGrabView); + Assert.Null (application.Driver); + Assert.False (application.StopAfterFirstIteration); + + // Internal properties + Assert.False (application.Initialized); + Assert.Null (application.MainThreadId); + Assert.Empty (application.Mouse.CachedViewsUnderMouse); + } + } + + [Fact] + public void Internal_Properties_Correct () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + Assert.True (app.Initialized); + Assert.Null (app.TopRunnableView); + SessionToken? rs = app.Begin (new Runnable ()); + Assert.Equal (app.TopRunnable, rs!.Runnable); + Assert.Null (app.Mouse.MouseGrabView); // public + + app.Dispose (); + } + + [Fact] + public void Invoke_Adds_Idle () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + Runnable top = new (); + SessionToken? rs = app.Begin (top); + + var actionCalled = 0; + app.Invoke ((_) => { actionCalled++; }); + app.TimedEvents!.RunTimers (); + Assert.Equal (1, actionCalled); + top.Dispose (); + + app.Dispose (); + } + + [Fact] + public void Run_Iteration_Fires () + { + var iteration = 0; + + IApplication app = Application.Create (); + app.Init ("fake"); + + app.Iteration += Application_Iteration; + app.Run (); + app.Iteration -= Application_Iteration; + + Assert.Equal (1, iteration); + app.Dispose (); + + return; + + void Application_Iteration (object? sender, EventArgs e) + { + if (iteration > 0) + { + Assert.Fail (); + } + + iteration++; + app.RequestStop (); + } + } + + [Fact] + public void Screen_Size_Changes () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + IDriver? driver = app.Driver; + + app.Driver!.SetScreenSize (80, 25); + + Assert.Equal (new (0, 0, 80, 25), driver!.Screen); + Assert.Equal (new (0, 0, 80, 25), app.Screen); + + // TODO: Should not be possible to manually change these at whim! + driver.Cols = 100; + driver.Rows = 30; + + app.Driver!.SetScreenSize (100, 30); + + Assert.Equal (new (0, 0, 100, 30), driver.Screen); + + app.Screen = new (0, 0, driver.Cols, driver.Rows); + Assert.Equal (new (0, 0, 100, 30), driver.Screen); + + app.Dispose (); + } + + [Fact] + public void Dispose_Alone_Does_Nothing () + { + IApplication app = Application.Create (); + app.Dispose (); + } + + #region RunTests + + [Fact] + public void Run_T_After_InitWithDriver_with_Runnable_and_Driver_Does_Not_Throw () + { + IApplication app = Application.Create (); + app.StopAfterFirstIteration = true; + + // Run> when already initialized or not with a Driver will not throw (because Window is derived from Runnable) + // Using another type not derived from Runnable will throws at compile time + app.Run (null, "fake"); + + // Run> when already initialized or not with a Driver will not throw (because Dialog is derived from Runnable) + app.Run (null, "fake"); + + app.Dispose (); + } + + [Fact] + public void Run_T_After_Init_Does_Not_Disposes_Application_Top () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + // Init doesn't create a Runnable and assigned it to app.TopRunnable + // but Begin does + var initTop = new Runnable (); + + app.Iteration += OnApplicationOnIteration; + + app.Run (); + app.Iteration -= OnApplicationOnIteration; + +#if DEBUG_IDISPOSABLE + Assert.False (initTop.WasDisposed); + initTop.Dispose (); + Assert.True (initTop.WasDisposed); +#endif + initTop.Dispose (); + + app.Dispose (); + + return; + + void OnApplicationOnIteration (object? s, EventArgs a) + { + Assert.NotEqual (initTop, app.TopRunnableView); +#if DEBUG_IDISPOSABLE + Assert.False (initTop.WasDisposed); +#endif + app.RequestStop (); + } + } + + [Fact] + public void Run_T_After_InitWithDriver_with_TestRunnable_DoesNotThrow () + { + IApplication app = Application.Create (); + app.Init ("fake"); + app.StopAfterFirstIteration = true; + + // Init has been called and we're passing no driver to Run. This is ok. + app.Run (); + + app.Dispose (); + } + + [Fact] + public void Run_T_After_InitNullDriver_with_TestRunnable_DoesNotThrow () + { + IApplication app = Application.Create (); + app.Init ("fake"); + app.StopAfterFirstIteration = true; + + // Init has been called, selecting FakeDriver; we're passing no driver to Run. Should be fine. + app.Run (); + + app.Dispose (); + } + + [Fact] + public void Run_T_NoInit_DoesNotThrow () + { + IApplication app = Application.Create (); + app.StopAfterFirstIteration = true; + + app.Run (); + + app.Dispose (); + } + + [Fact] + public void Run_T_NoInit_WithDriver_DoesNotThrow () + { + IApplication app = Application.Create (); + app.StopAfterFirstIteration = true; + + // Init has NOT been called and we're passing a valid driver to Run. This is ok. + app.Run (null, "fake"); + + app.Dispose (); + } + + [Fact] + public void Run_Sets_Running_True () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + var top = new Runnable (); + SessionToken? rs = app.Begin (top); + Assert.NotNull (rs); + + app.Iteration += OnApplicationOnIteration; + app.Run (top); + app.Iteration -= OnApplicationOnIteration; + + top.Dispose (); + + app.Dispose (); + + return; + + void OnApplicationOnIteration (object? s, EventArgs a) + { + Assert.True (top.IsRunning); + top.RequestStop (); + } + } + + [Fact] + public void Run_A_Modal_Runnable_Refresh_Background_On_Moving () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + // Don't use Dialog here as it has more layout logic. Use Window instead. + var w = new Window + { + Width = 5, Height = 5, + Arrangement = ViewArrangement.Movable + }; + app.Driver!.SetScreenSize (10, 10); + SessionToken? rs = app.Begin (w); + + // Don't use visuals to test as style of border can change over time. + Assert.Equal (new (0, 0), w.Frame.Location); + + app.Mouse.RaiseMouseEvent (new () { Flags = MouseFlags.Button1Pressed }); + Assert.Equal (w.Border, app.Mouse.MouseGrabView); + Assert.Equal (new (0, 0), w.Frame.Location); + + // Move down and to the right. + app.Mouse.RaiseMouseEvent (new () { ScreenPosition = new (1, 1), Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition }); + Assert.Equal (new (1, 1), w.Frame.Location); + + app.End (rs!); + w.Dispose (); + + app.Dispose (); + } + + [Fact] + public void Run_T_Creates_Top_Without_Init () + { + IApplication app = Application.Create (); + app.StopAfterFirstIteration = true; + + app.SessionEnded += OnApplicationOnSessionEnded; + + app.Run (null, "fake"); + + Assert.Null (app.TopRunnableView); + + app.Dispose (); + Assert.Null (app.TopRunnableView); + + return; + + void OnApplicationOnSessionEnded (object? sender, SessionTokenEventArgs e) + { + app.SessionEnded -= OnApplicationOnSessionEnded; + e.State.Result = (e.State.Runnable as IRunnable)?.Result; + } + } + + #endregion + + #region DisposeTests + + [Fact] + public async Task Dispose_Allows_Async () + { + var isCompletedSuccessfully = false; + + async Task TaskWithAsyncContinuation () + { + await Task.Yield (); + await Task.Yield (); + + isCompletedSuccessfully = true; + } + + IApplication app = Application.Create (); + app.Dispose (); + + Assert.False (isCompletedSuccessfully); + await TaskWithAsyncContinuation (); + Thread.Sleep (100); + Assert.True (isCompletedSuccessfully); + } + + [Fact] + public void Dispose_Resets_SyncContext () + { + IApplication app = Application.Create (); + app.Dispose (); + Assert.Null (SynchronizationContext.Current); + } + + #endregion + +} diff --git a/Tests/UnitTestsParallelizable/Application/CWP/ResultEventArgsTests.cs b/Tests/UnitTestsParallelizable/Application/CWP/ResultEventArgsTests.cs index 11e33fa44..2a6d038d1 100644 --- a/Tests/UnitTestsParallelizable/Application/CWP/ResultEventArgsTests.cs +++ b/Tests/UnitTestsParallelizable/Application/CWP/ResultEventArgsTests.cs @@ -2,7 +2,7 @@ using System; using Terminal.Gui.App; using Xunit; -namespace UnitTests_Parallelizable.ApplicationTests; +namespace ApplicationTests; public class ResultEventArgsTests { diff --git a/Tests/UnitTestsParallelizable/Application/IApplicationScreenChangedTests.cs b/Tests/UnitTestsParallelizable/Application/IApplicationScreenChangedTests.cs new file mode 100644 index 000000000..112860cd0 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/IApplicationScreenChangedTests.cs @@ -0,0 +1,453 @@ +using Xunit.Abstractions; + +namespace ApplicationTests; + +/// +/// Parallelizable tests for IApplication.ScreenChanged event and Screen property. +/// Tests using the modern instance-based IApplication API. +/// +public class IApplicationScreenChangedTests (ITestOutputHelper output) +{ + private readonly ITestOutputHelper _output = output; + + #region ScreenChanged Event Tests + + [Fact] + public void ScreenChanged_Event_Fires_When_Driver_Size_Changes () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + var eventFired = false; + Rectangle? newScreen = null; + + EventHandler> handler = (sender, args) => + { + eventFired = true; + newScreen = args.Value; + }; + + app.ScreenChanged += handler; + + try + { + // Act + app.Driver!.SetScreenSize (100, 40); + + // Assert + Assert.True (eventFired); + Assert.NotNull (newScreen); + Assert.Equal (new (0, 0, 100, 40), newScreen.Value); + } + finally + { + app.ScreenChanged -= handler; + } + } + + [Fact] + public void ScreenChanged_Event_Updates_Application_Screen_Property () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + Rectangle initialScreen = app.Screen; + Assert.Equal (new (0, 0, 80, 25), initialScreen); + + // Act + app.Driver!.SetScreenSize (120, 50); + + // Assert + Assert.Equal (new (0, 0, 120, 50), app.Screen); + } + + [Fact] + public void ScreenChanged_Event_Sender_Is_IApplication () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + object? eventSender = null; + + EventHandler> handler = (sender, args) => { eventSender = sender; }; + + app.ScreenChanged += handler; + + try + { + // Act + app.Driver!.SetScreenSize (100, 30); + + // Assert + Assert.NotNull (eventSender); + Assert.IsAssignableFrom (eventSender); + } + finally + { + app.ScreenChanged -= handler; + } + } + + [Fact] + public void ScreenChanged_Event_Provides_Correct_Rectangle_In_EventArgs () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + Rectangle? capturedRectangle = null; + + EventHandler> handler = (sender, args) => { capturedRectangle = args.Value; }; + + app.ScreenChanged += handler; + + try + { + // Act + app.Driver!.SetScreenSize (200, 60); + + // Assert + Assert.NotNull (capturedRectangle); + Assert.Equal (0, capturedRectangle.Value.X); + Assert.Equal (0, capturedRectangle.Value.Y); + Assert.Equal (200, capturedRectangle.Value.Width); + Assert.Equal (60, capturedRectangle.Value.Height); + } + finally + { + app.ScreenChanged -= handler; + } + } + + [Fact] + public void ScreenChanged_Event_Fires_Multiple_Times_For_Multiple_Resizes () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + var eventCount = 0; + List sizes = new (); + + EventHandler> handler = (sender, args) => + { + eventCount++; + sizes.Add (args.Value.Size); + }; + + app.ScreenChanged += handler; + + try + { + // Act + app.Driver!.SetScreenSize (100, 30); + app.Driver!.SetScreenSize (120, 40); + app.Driver!.SetScreenSize (80, 25); + + // Assert + Assert.Equal (3, eventCount); + Assert.Equal (3, sizes.Count); + Assert.Equal (new (100, 30), sizes [0]); + Assert.Equal (new (120, 40), sizes [1]); + Assert.Equal (new (80, 25), sizes [2]); + } + finally + { + app.ScreenChanged -= handler; + } + } + + [Fact] + public void ScreenChanged_Event_Does_Not_Fire_When_No_Resize_Occurs () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + var eventFired = false; + + EventHandler> handler = (sender, args) => { eventFired = true; }; + + app.ScreenChanged += handler; + + try + { + // Act - Don't resize, just access Screen property + Rectangle screen = app.Screen; + + // Assert + Assert.False (eventFired); + Assert.Equal (new (0, 0, 80, 25), screen); + } + finally + { + app.ScreenChanged -= handler; + } + } + + [Fact] + public void ScreenChanged_Event_Can_Be_Unsubscribed () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + var eventCount = 0; + + EventHandler> handler = (sender, args) => { eventCount++; }; + + app.ScreenChanged += handler; + + // Act - First resize should fire + app.Driver!.SetScreenSize (100, 30); + Assert.Equal (1, eventCount); + + // Unsubscribe + app.ScreenChanged -= handler; + + // Second resize should not fire + app.Driver!.SetScreenSize (120, 40); + + // Assert + Assert.Equal (1, eventCount); + } + + [Fact] + public void ScreenChanged_Event_Sets_Runnables_To_NeedsLayout () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + using var runnable = new Runnable (); + SessionToken? token = app.Begin (runnable); + + Assert.NotNull (app.TopRunnableView); + app.LayoutAndDraw (); + + // Clear the NeedsLayout flag + Assert.False (app.TopRunnableView.NeedsLayout); + + try + { + // Act + app.Driver!.SetScreenSize (100, 30); + + // Assert + Assert.True (app.TopRunnableView.NeedsLayout); + } + finally + { + // Cleanup + if (token is { }) + { + app.End (token); + } + } + } + + [Fact] + public void ScreenChanged_Event_Handles_Multiple_Runnables_In_Session_Stack () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + using var runnable1 = new Runnable (); + SessionToken? token1 = app.Begin (runnable1); + app.LayoutAndDraw (); + + using var runnable2 = new Runnable (); + SessionToken? token2 = app.Begin (runnable2); + app.LayoutAndDraw (); + + // Both should not need layout after drawing + Assert.False (runnable1.NeedsLayout); + Assert.False (runnable2.NeedsLayout); + + try + { + // Act - Resize should mark both as needing layout + app.Driver!.SetScreenSize (100, 30); + + // Assert + Assert.True (runnable1.NeedsLayout); + Assert.True (runnable2.NeedsLayout); + } + finally + { + // Cleanup + if (token2 is { }) + { + app.End (token2); + } + + if (token1 is { }) + { + app.End (token1); + } + } + } + + [Fact] + public void ScreenChanged_Event_With_No_Active_Runnables_Does_Not_Throw () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + var eventFired = false; + + EventHandler> handler = (sender, args) => { eventFired = true; }; + + app.ScreenChanged += handler; + + try + { + // Act - Resize with no runnables + Exception? exception = Record.Exception (() => app.Driver!.SetScreenSize (100, 30)); + + // Assert + Assert.Null (exception); + Assert.True (eventFired); + } + finally + { + app.ScreenChanged -= handler; + } + } + + #endregion ScreenChanged Event Tests + + #region Screen Property Tests + + [Fact] + public void Screen_Property_Returns_Driver_Screen_When_Not_Set () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + // Act + Rectangle screen = app.Screen; + + // Assert + Assert.Equal (app.Driver!.Screen, screen); + Assert.Equal (new (0, 0, 80, 25), screen); + } + + [Fact] + public void Screen_Property_Returns_Default_Size_When_Driver_Not_Initialized () + { + // Arrange + using IApplication app = Application.Create (); + + // Act - Don't call Init + Rectangle screen = app.Screen; + + // Assert - Should return default size + Assert.Equal (new (0, 0, 2048, 2048), screen); + } + + [Fact] + public void Screen_Property_Throws_When_Setting_Non_Zero_Origin () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + // Act & Assert + var exception = Assert.Throws (() => + app.Screen = new (10, 10, 80, 25)); + + Assert.Contains ("Screen locations other than 0, 0", exception.Message); + } + + [Fact] + public void Screen_Property_Allows_Setting_With_Zero_Origin () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + // Act + Exception? exception = Record.Exception (() => + app.Screen = new (0, 0, 100, 50)); + + // Assert + Assert.Null (exception); + Assert.Equal (new (0, 0, 100, 50), app.Screen); + } + + [Fact] + public void Screen_Property_Setting_Does_Not_Fire_ScreenChanged_Event () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + var eventFired = false; + + EventHandler> handler = (sender, args) => { eventFired = true; }; + + app.ScreenChanged += handler; + + try + { + // Act - Manually set Screen property (not via driver resize) + app.Screen = new (0, 0, 100, 50); + + // Assert - Event should not fire for manual property setting + Assert.False (eventFired); + Assert.Equal (new (0, 0, 100, 50), app.Screen); + } + finally + { + app.ScreenChanged -= handler; + } + } + + [Fact] + public void Screen_Property_Thread_Safe_Access () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + List exceptions = new (); + List tasks = new (); + + // Act - Access Screen property from multiple threads + for (var i = 0; i < 10; i++) + { + tasks.Add ( + Task.Run (() => + { + try + { + Rectangle screen = app.Screen; + Assert.NotEqual (Rectangle.Empty, screen); + } + catch (Exception ex) + { + lock (exceptions) + { + exceptions.Add (ex); + } + } + })); + } + +#pragma warning disable xUnit1031 + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert - No exceptions should occur + Assert.Empty (exceptions); + } + + #endregion Screen Property Tests +} diff --git a/Tests/UnitTestsParallelizable/Application/KeyboardImplThreadSafetyTests.cs b/Tests/UnitTestsParallelizable/Application/KeyboardImplThreadSafetyTests.cs new file mode 100644 index 000000000..4b74a2424 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/KeyboardImplThreadSafetyTests.cs @@ -0,0 +1,520 @@ +// ReSharper disable AccessToDisposedClosure + +#nullable enable +namespace ApplicationTests; + +/// +/// Tests to verify that KeyboardImpl is thread-safe for concurrent access scenarios. +/// +public class KeyboardImplThreadSafetyTests +{ + [Fact] + public void AddCommand_ConcurrentAccess_NoExceptions () + { + // Arrange + var keyboard = new KeyboardImpl (); + List exceptions = []; + const int NUM_THREADS = 10; + const int OPERATIONS_PER_THREAD = 50; + + // Act + List tasks = []; + + for (var i = 0; i < NUM_THREADS; i++) + { + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + // AddKeyBindings internally calls AddCommand multiple times + keyboard.AddKeyBindings (); + } + catch (InvalidOperationException) + { + // Expected - AddKeyBindings tries to add keys that already exist + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + keyboard.Dispose (); + } + + [Fact] + public void Dispose_WhileOperationsInProgress_NoExceptions () + { + // Arrange + IApplication? app = Application.Create (); + app.Init ("fake"); + var keyboard = new KeyboardImpl { App = app }; + keyboard.AddKeyBindings (); + List exceptions = []; + var continueRunning = true; + + // Act + Task operationsTask = Task.Run (() => + { + while (continueRunning) + { + try + { + keyboard.InvokeCommandsBoundToKey (Key.Q.WithCtrl); + IEnumerable> bindings = keyboard.KeyBindings.GetBindings (); + int count = bindings.Count (); + } + catch (ObjectDisposedException) + { + // Expected - keyboard was disposed + break; + } + catch (Exception ex) + { + exceptions.Add (ex); + + break; + } + } + }); + + // Give operations a chance to start + Thread.Sleep (10); + + // Dispose while operations are running + keyboard.Dispose (); + continueRunning = false; + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + operationsTask.Wait (TimeSpan.FromSeconds (2)); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + app.Dispose (); + } + + [Fact] + public void InvokeCommand_ConcurrentAccess_NoExceptions () + { + // Arrange + IApplication? app = Application.Create (); + app.Init ("fake"); + var keyboard = new KeyboardImpl { App = app }; + keyboard.AddKeyBindings (); + List exceptions = []; + const int NUM_THREADS = 10; + const int OPERATIONS_PER_THREAD = 50; + + // Act + List tasks = new (); + + for (var i = 0; i < NUM_THREADS; i++) + { + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + var binding = new KeyBinding ([Command.Quit]); + keyboard.InvokeCommand (Command.Quit, Key.Q.WithCtrl, binding); + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + keyboard.Dispose (); + app.Dispose (); + } + + [Fact] + public void InvokeCommandsBoundToKey_ConcurrentAccess_NoExceptions () + { + // Arrange + IApplication? app = Application.Create (); + app.Init ("fake"); + var keyboard = new KeyboardImpl { App = app }; + keyboard.AddKeyBindings (); + List exceptions = []; + const int NUM_THREADS = 10; + const int OPERATIONS_PER_THREAD = 50; + + // Act + List tasks = []; + + for (var i = 0; i < NUM_THREADS; i++) + { + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + keyboard.InvokeCommandsBoundToKey (Key.Q.WithCtrl); + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + keyboard.Dispose (); + app.Dispose (); + } + + [Fact] + public void KeyBindings_ConcurrentAdd_NoExceptions () + { + // Arrange + var keyboard = new KeyboardImpl (); + + // Don't call AddKeyBindings here to avoid conflicts + List exceptions = []; + const int NUM_THREADS = 10; + const int OPERATIONS_PER_THREAD = 50; + + // Act + List tasks = new (); + + for (var i = 0; i < NUM_THREADS; i++) + { + int threadId = i; + + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + // Use unique keys per thread to avoid conflicts + Key key = Key.F1 + threadId * OPERATIONS_PER_THREAD + j; + keyboard.KeyBindings.Add (key, Command.Refresh); + } + catch (InvalidOperationException) + { + // Expected - duplicate key + } + catch (ArgumentException) + { + // Expected - invalid key + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + keyboard.Dispose (); + } + + [Fact] + public void KeyDown_KeyUp_Events_ConcurrentSubscription_NoExceptions () + { + // Arrange + var keyboard = new KeyboardImpl (); + keyboard.AddKeyBindings (); + List exceptions = []; + const int NUM_THREADS = 10; + const int OPERATIONS_PER_THREAD = 20; + var keyDownCount = 0; + var keyUpCount = 0; + + // Act + List tasks = new (); + + // Threads subscribing to events + for (var i = 0; i < NUM_THREADS; i++) + { + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + EventHandler handler = (s, e) => { Interlocked.Increment (ref keyDownCount); }; + keyboard.KeyDown += handler; + keyboard.KeyDown -= handler; + + EventHandler upHandler = (s, e) => { Interlocked.Increment (ref keyUpCount); }; + keyboard.KeyUp += upHandler; + keyboard.KeyUp -= upHandler; + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + keyboard.Dispose (); + } + + [Fact] + public void KeyProperty_Setters_ConcurrentAccess_NoExceptions () + { + // Arrange + var keyboard = new KeyboardImpl (); + + // Initialize once before concurrent access + keyboard.AddKeyBindings (); + List exceptions = []; + const int NUM_THREADS = 10; + const int OPERATIONS_PER_THREAD = 20; + + // Act + List tasks = new (); + + for (var i = 0; i < NUM_THREADS; i++) + { + int threadId = i; + + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + // Cycle through different key combinations + switch (j % 6) + { + case 0: + keyboard.QuitKey = Key.Q.WithCtrl; + + break; + case 1: + keyboard.ArrangeKey = Key.F6.WithCtrl; + + break; + case 2: + keyboard.NextTabKey = Key.Tab; + + break; + case 3: + keyboard.PrevTabKey = Key.Tab.WithShift; + + break; + case 4: + keyboard.NextTabGroupKey = Key.F6; + + break; + case 5: + keyboard.PrevTabGroupKey = Key.F6.WithShift; + + break; + } + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + keyboard.Dispose (); + } + + [Fact] + public void MixedOperations_ConcurrentAccess_NoExceptions () + { + // Arrange + IApplication? app = Application.Create (); + app.Init ("fake"); + var keyboard = new KeyboardImpl { App = app }; + keyboard.AddKeyBindings (); + List exceptions = []; + const int OPERATIONS_PER_THREAD = 30; + + // Act + List tasks = new (); + + // Thread 1: Add bindings with unique keys + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + // Use high key codes to avoid conflicts + var key = new Key ((KeyCode)((int)KeyCode.F20 + j)); + keyboard.KeyBindings.Add (key, Command.Refresh); + } + catch (InvalidOperationException) + { + // Expected - duplicate + } + catch (ArgumentException) + { + // Expected - invalid key + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + + // Thread 2: Invoke commands + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + keyboard.InvokeCommandsBoundToKey (Key.Q.WithCtrl); + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + + // Thread 3: Read bindings + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + IEnumerable> bindings = keyboard.KeyBindings.GetBindings (); + int count = bindings.Count (); + Assert.True (count >= 0); + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + + // Thread 4: Change key properties + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + keyboard.QuitKey = j % 2 == 0 ? Key.Q.WithCtrl : Key.Esc; + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + keyboard.Dispose (); + app.Dispose (); + } + + [Fact] + public void RaiseKeyDownEvent_ConcurrentAccess_NoExceptions () + { + // Arrange + IApplication? app = Application.Create (); + app.Init ("fake"); + var keyboard = new KeyboardImpl { App = app }; + keyboard.AddKeyBindings (); + List exceptions = []; + const int NUM_THREADS = 5; + const int OPERATIONS_PER_THREAD = 20; + + // Act + List tasks = new (); + + for (var i = 0; i < NUM_THREADS; i++) + { + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + keyboard.RaiseKeyDownEvent (Key.A); + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + keyboard.Dispose (); + app.Dispose (); + } +} diff --git a/Tests/UnitTestsParallelizable/Application/KeyboardTests.cs b/Tests/UnitTestsParallelizable/Application/KeyboardTests.cs index 45b094419..f275e96da 100644 --- a/Tests/UnitTestsParallelizable/Application/KeyboardTests.cs +++ b/Tests/UnitTestsParallelizable/Application/KeyboardTests.cs @@ -1,7 +1,7 @@ #nullable enable using Terminal.Gui.App; -namespace UnitTests_Parallelizable.ApplicationTests; +namespace ApplicationTests; /// /// Parallelizable tests for keyboard handling. diff --git a/Tests/UnitTestsParallelizable/Application/LogarithmicTimeoutTests.cs b/Tests/UnitTestsParallelizable/Application/LogarithmicTimeoutTests.cs index 00d7b245d..fba071860 100644 --- a/Tests/UnitTestsParallelizable/Application/LogarithmicTimeoutTests.cs +++ b/Tests/UnitTestsParallelizable/Application/LogarithmicTimeoutTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.ApplicationTests; +namespace ApplicationTests; public class LogarithmicTimeoutTests { diff --git a/Tests/UnitTestsParallelizable/Application/MainLoopCoordinatorTests.cs b/Tests/UnitTestsParallelizable/Application/MainLoopCoordinatorTests.cs new file mode 100644 index 000000000..ea9ef3d12 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/MainLoopCoordinatorTests.cs @@ -0,0 +1,212 @@ +#nullable enable +using System.Collections.Concurrent; +using System.Diagnostics; +// ReSharper disable AccessToDisposedClosure +#pragma warning disable xUnit1031 + +namespace ApplicationTests; + +/// +/// Tests for to verify input loop lifecycle. +/// These tests ensure that the input thread starts, runs, and stops correctly when applications +/// are created, initialized, and disposed. +/// +public class MainLoopCoordinatorTests : IDisposable +{ + private readonly List _createdApps = new (); + + public void Dispose () + { + // Cleanup any apps that weren't disposed in tests + foreach (IApplication app in _createdApps) + { + try + { + app.Dispose (); + } + catch + { + // Ignore cleanup errors + } + } + + _createdApps.Clear (); + } + + private IApplication CreateApp () + { + IApplication app = Application.Create (); + _createdApps.Add (app); + + return app; + } + + /// + /// Verifies that Dispose() stops the input loop when using Application.Create(). + /// This is the key test that proves the input thread respects cancellation. + /// + [Fact] + public void Application_Dispose_Stops_Input_Loop () + { + // Arrange + IApplication app = CreateApp (); + app.Init ("fake"); + + // The input thread should now be running + Assert.NotNull (app.Driver); + Assert.True (app.Initialized); + + // Act - Dispose the application + var sw = Stopwatch.StartNew (); + app.Dispose (); + sw.Stop (); + + // Assert - Dispose should complete quickly (within 1 second) + // If the input thread doesn't stop, this will hang and the test will timeout + Assert.True (sw.ElapsedMilliseconds < 1000, $"Dispose() took {sw.ElapsedMilliseconds}ms - input thread may not have stopped"); + + // Verify the application is properly disposed + Assert.Null (app.Driver); + Assert.False (app.Initialized); + + _createdApps.Remove (app); + } + + /// + /// Verifies that calling Dispose() multiple times doesn't cause issues. + /// + [Fact] + public void Dispose_Called_Multiple_Times_Does_Not_Throw () + { + // Arrange + IApplication app = CreateApp (); + app.Init ("fake"); + + // Act - Call Dispose() multiple times + Exception? exception = Record.Exception (() => + { + app.Dispose (); + app.Dispose (); + app.Dispose (); + }); + + // Assert - Should not throw + Assert.Null (exception); + + _createdApps.Remove (app); + } + + /// + /// Verifies that multiple applications can be created and disposed without thread leaks. + /// This simulates the ColorPicker test scenario where multiple ApplicationImpl instances + /// are created in parallel tests and must all be properly cleaned up. + /// + [Fact] + public void Multiple_Applications_Dispose_Without_Thread_Leaks () + { + const int COUNT = 5; + IApplication [] apps = new IApplication [COUNT]; + + // Arrange - Create multiple applications (simulating parallel test scenario) + for (var i = 0; i < COUNT; i++) + { + apps [i] = Application.Create (); + apps [i].Init ("fake"); + } + + // Act - Dispose all applications + var sw = Stopwatch.StartNew (); + + for (var i = 0; i < COUNT; i++) + { + apps [i].Dispose (); + } + + sw.Stop (); + + // Assert - All disposals should complete quickly + // If input threads don't stop, this will hang or take a very long time + Assert.True (sw.ElapsedMilliseconds < 5000, $"Disposing {COUNT} apps took {sw.ElapsedMilliseconds}ms - input threads may not have stopped"); + } + + /// + /// Verifies that the 20ms throttle limits the input loop poll rate to prevent CPU spinning. + /// This test proves throttling exists by verifying the poll rate is bounded (not millions of calls). + /// The test uses an upper bound approach to avoid timing sensitivity issues during parallel execution. + /// + [Fact (Skip = "Can't get this to run reliably.")] + public void InputLoop_Throttle_Limits_Poll_Rate () + { + // Arrange - Create a FakeInput and manually run it with throttling + FakeInput input = new FakeInput (); + ConcurrentQueue queue = new ConcurrentQueue (); + input.Initialize (queue); + + CancellationTokenSource cts = new CancellationTokenSource (); + + // Act - Run the input loop for 500ms + // Short duration reduces test time while still proving throttle exists + Task inputTask = Task.Run (() => input.Run (cts.Token), cts.Token); + + Thread.Sleep (500); + + int peekCount = input.PeekCallCount; + cts.Cancel (); + + // Wait for task to complete + bool completed = inputTask.Wait (TimeSpan.FromSeconds (10)); + Assert.True (completed, "Input task did not complete within timeout"); + + // Assert - The key insight: throttle prevents CPU spinning + // With 20ms throttle: ~25 calls in 500ms (but can be much less under load) + // WITHOUT throttle: Would be 10,000+ calls minimum (tight spin loop) + // + // We use an upper bound test: verify it's NOT spinning wildly + // This is much more reliable than testing exact timing under parallel load + // + // Max 500 calls = average 1ms between polls (still proves 20ms throttle exists) + // Without throttle = millions of calls (tight loop) + Assert.True (peekCount < 500, $"Poll count {peekCount} suggests no throttling (expected <500 with 20ms throttle)"); + + // Also verify the thread actually ran (not immediately cancelled) + Assert.True (peekCount > 0, $"Poll count was {peekCount} - thread may not have started"); + + input.Dispose (); + } + + /// + /// Verifies that the 20ms throttle prevents CPU spinning even with many leaked applications. + /// Before the throttle fix, 10+ leaked apps would saturate the CPU with tight spin loops. + /// + [Fact] + public void Throttle_Prevents_CPU_Saturation_With_Leaked_Apps () + { + const int COUNT = 10; + IApplication [] apps = new IApplication [COUNT]; + + // Arrange - Create multiple applications WITHOUT disposing them (simulating the leak) + for (var i = 0; i < COUNT; i++) + { + apps [i] = Application.Create (); + apps [i].Init ("fake"); + } + + // Let them run for a moment + Thread.Sleep (100); + + // Act - Now dispose them all and measure how long it takes + var sw = Stopwatch.StartNew (); + + for (var i = 0; i < COUNT; i++) + { + apps [i].Dispose (); + } + + sw.Stop (); + + // Assert - Even with 10 leaked apps, disposal should be fast + // Before the throttle fix, this would take many seconds due to CPU saturation + // With the throttle, each thread does Task.Delay(20ms) and exits within ~20-40ms + Assert.True (sw.ElapsedMilliseconds < 2000, $"Disposing {COUNT} apps took {sw.ElapsedMilliseconds}ms - CPU may be saturated"); + } +} diff --git a/Tests/UnitTestsParallelizable/Application/MouseInterfaceTests.cs b/Tests/UnitTestsParallelizable/Application/MouseInterfaceTests.cs index 69b64f51a..1ebda8b62 100644 --- a/Tests/UnitTestsParallelizable/Application/MouseInterfaceTests.cs +++ b/Tests/UnitTestsParallelizable/Application/MouseInterfaceTests.cs @@ -2,7 +2,7 @@ using Terminal.Gui.App; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ApplicationTests; +namespace ApplicationTests; /// /// Parallelizable tests for IMouse interface. @@ -41,7 +41,7 @@ public class MouseInterfaceTests (ITestOutputHelper output) // Assert Assert.Equal (testPosition, mouse.LastMousePosition); - Assert.Equal (testPosition, mouse.GetLastMousePosition ()); + Assert.Equal (testPosition, mouse.LastMousePosition); } [Fact] diff --git a/Tests/UnitTestsParallelizable/Application/MouseTests.cs b/Tests/UnitTestsParallelizable/Application/MouseTests.cs index fdd3260a4..71dbd6b09 100644 --- a/Tests/UnitTestsParallelizable/Application/MouseTests.cs +++ b/Tests/UnitTestsParallelizable/Application/MouseTests.cs @@ -1,16 +1,13 @@ -using Terminal.Gui.App; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ApplicationTests; +namespace ApplicationTests; /// /// Tests for the interface and implementation. /// These tests demonstrate the decoupled mouse handling that enables parallel test execution. /// -public class MouseTests (ITestOutputHelper output) +public class MouseTests { - private readonly ITestOutputHelper _output = output; - [Fact] public void Mouse_Instance_CreatedSuccessfully () { @@ -32,7 +29,7 @@ public class MouseTests (ITestOutputHelper output) // Act mouse.LastMousePosition = expectedPosition; - Point? actualPosition = mouse.GetLastMousePosition (); + Point? actualPosition = mouse.LastMousePosition; // Assert Assert.Equal (expectedPosition, actualPosition); @@ -76,7 +73,7 @@ public class MouseTests (ITestOutputHelper output) // Assert - CachedViewsUnderMouse should be cleared Assert.Empty (mouse.CachedViewsUnderMouse); - + // Event handlers should be cleared MouseEventArgs mouseEvent = new () { ScreenPosition = new Point (0, 0), Flags = MouseFlags.Button1Pressed }; mouse.RaiseMouseEvent (mouseEvent); @@ -122,4 +119,103 @@ public class MouseTests (ITestOutputHelper output) // Assert - Event count unchanged Assert.Equal (1, eventCount); } + + + /// + /// Tests that the mouse coordinates passed to the focused view are correct when the mouse is clicked. With + /// Frames; Frame != Viewport + /// + [Theory] + + // click on border + [InlineData (0, 0, 0, 0, 0, false)] + [InlineData (0, 1, 0, 0, 0, false)] + [InlineData (0, 0, 1, 0, 0, false)] + [InlineData (0, 9, 0, 0, 0, false)] + [InlineData (0, 0, 9, 0, 0, false)] + + // outside border + [InlineData (0, 10, 0, 0, 0, false)] + [InlineData (0, 0, 10, 0, 0, false)] + + // view is offset from origin ; click is on border + [InlineData (1, 1, 1, 0, 0, false)] + [InlineData (1, 2, 1, 0, 0, false)] + [InlineData (1, 1, 2, 0, 0, false)] + [InlineData (1, 10, 1, 0, 0, false)] + [InlineData (1, 1, 10, 0, 0, false)] + + // outside border + [InlineData (1, -1, 0, 0, 0, false)] + [InlineData (1, 0, -1, 0, 0, false)] + [InlineData (1, 10, 10, 0, 0, false)] + [InlineData (1, 11, 11, 0, 0, false)] + + // view is at origin, click is inside border + [InlineData (0, 1, 1, 0, 0, true)] + [InlineData (0, 2, 1, 1, 0, true)] + [InlineData (0, 1, 2, 0, 1, true)] + [InlineData (0, 8, 1, 7, 0, true)] + [InlineData (0, 1, 8, 0, 7, true)] + [InlineData (0, 8, 8, 7, 7, true)] + + // view is offset from origin ; click inside border + // our view is 10x10, but has a border, so it's bounds is 8x8 + [InlineData (1, 2, 2, 0, 0, true)] + [InlineData (1, 3, 2, 1, 0, true)] + [InlineData (1, 2, 3, 0, 1, true)] + [InlineData (1, 9, 2, 7, 0, true)] + [InlineData (1, 2, 9, 0, 7, true)] + [InlineData (1, 9, 9, 7, 7, true)] + [InlineData (1, 10, 10, 7, 7, false)] + + //01234567890123456789 + // |12345678| + // |xxxxxxxx + public void MouseCoordinatesTest_Border ( + int offset, + int clickX, + int clickY, + int expectedX, + int expectedY, + bool expectedClicked + ) + { + Size size = new (10, 10); + Point pos = new (offset, offset); + + var clicked = false; + + using IApplication? application = Application.Create (); + + application.Begin (new Window () + { + Id = "top", + }); + application.TopRunnableView!.X = 0; + application.TopRunnableView.Y = 0; + application.TopRunnableView.Width = size.Width * 2; + application.TopRunnableView.Height = size.Height * 2; + application.TopRunnableView.BorderStyle = LineStyle.None; + + var view = new View { Id = "view", X = pos.X, Y = pos.Y, Width = size.Width, Height = size.Height }; + + // Give the view a border. With PR #2920, mouse clicks are only passed if they are inside the view's Viewport. + view.BorderStyle = LineStyle.Single; + view.CanFocus = true; + + application.TopRunnableView.Add (view); + + var mouseEvent = new MouseEventArgs { Position = new (clickX, clickY), ScreenPosition = new (clickX, clickY), Flags = MouseFlags.Button1Clicked }; + + view.MouseClick += (s, e) => + { + Assert.Equal (expectedX, e.Position.X); + Assert.Equal (expectedY, e.Position.Y); + clicked = true; + }; + + application.Mouse.RaiseMouseEvent (mouseEvent); + Assert.Equal (expectedClicked, clicked); + } } diff --git a/Tests/UnitTestsParallelizable/Application/PopoverBaseImplTests.cs b/Tests/UnitTestsParallelizable/Application/PopoverBaseImplTests.cs index 69b795479..0e1917303 100644 --- a/Tests/UnitTestsParallelizable/Application/PopoverBaseImplTests.cs +++ b/Tests/UnitTestsParallelizable/Application/PopoverBaseImplTests.cs @@ -2,7 +2,7 @@ using System; using Terminal.Gui; using Terminal.Gui.App; using Xunit; -namespace UnitTests_Parallelizable.ApplicationTests; +namespace ApplicationTests; public class PopoverBaseImplTests { @@ -23,12 +23,12 @@ public class PopoverBaseImplTests } [Fact] - public void Toplevel_Property_CanBeSetAndGet () + public void Runnable_Property_CanBeSetAndGet () { var popover = new TestPopover (); - var top = new Toplevel (); - popover.Toplevel = top; - Assert.Same (top, popover.Toplevel); + var top = new Runnable (); + popover.Current = top; + Assert.Same (top, popover.Current); } [Fact] @@ -59,11 +59,11 @@ public class PopoverBaseImplTests } [Fact] - public void Show_DoesNotThrow_BasePopoverImpl () + public void Show_Throw_If_Not_Registered () { var popover = new TestPopover (); var popoverManager = new ApplicationPopover (); - popoverManager.Show (popover); + Assert.Throws (() => popoverManager.Show (popover)); } } diff --git a/Tests/UnitTestsParallelizable/Application/Runnable/RunnableEdgeCasesTests.cs b/Tests/UnitTestsParallelizable/Application/Runnable/RunnableEdgeCasesTests.cs new file mode 100644 index 000000000..6fcbd47c5 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/Runnable/RunnableEdgeCasesTests.cs @@ -0,0 +1,294 @@ +#nullable enable +using Xunit.Abstractions; + +namespace ApplicationTests; + +/// +/// Tests for edge cases and error conditions in IRunnable implementation. +/// +public class RunnableEdgeCasesTests (ITestOutputHelper output) +{ + private readonly ITestOutputHelper _output = output; + + [Fact] + public void Runnable_MultipleEventSubscribers_AllInvoked () + { + // Arrange + Runnable runnable = new (); + var subscriber1Called = false; + var subscriber2Called = false; + var subscriber3Called = false; + + runnable.IsRunningChanging += (s, e) => subscriber1Called = true; + runnable.IsRunningChanging += (s, e) => subscriber2Called = true; + runnable.IsRunningChanging += (s, e) => subscriber3Called = true; + + // Act + runnable.RaiseIsRunningChanging (false, true); + + // Assert + Assert.True (subscriber1Called); + Assert.True (subscriber2Called); + Assert.True (subscriber3Called); + } + + [Fact] + public void Runnable_EventSubscriber_CanCancelAfterOthers () + { + // Arrange + Runnable runnable = new (); + var subscriber1Called = false; + var subscriber2Called = false; + + runnable.IsRunningChanging += (s, e) => subscriber1Called = true; + + runnable.IsRunningChanging += (s, e) => + { + subscriber2Called = true; + e.Cancel = true; // Second subscriber cancels + }; + + // Act + bool canceled = runnable.RaiseIsRunningChanging (false, true); + + // Assert + Assert.True (subscriber1Called); + Assert.True (subscriber2Called); + Assert.True (canceled); + } + + [Fact] + public void Runnable_Result_CanBeSetMultipleTimes () + { + // Arrange + Runnable runnable = new (); + + // Act + runnable.Result = 1; + runnable.Result = 2; + runnable.Result = 3; + + // Assert + Assert.Equal (3, runnable.Result); + } + + [Fact] + public void Runnable_Result_ClearedOnMultipleStarts () + { + // Arrange + Runnable runnable = new () { Result = 42 }; + + // Act & Assert - First start + runnable.RaiseIsRunningChanging (false, true); + Assert.Equal (0, runnable.Result); + + // Set result again + runnable.Result = 99; + Assert.Equal (99, runnable.Result); + + // Second start should clear again + runnable.RaiseIsRunningChanging (false, true); + Assert.Equal (0, runnable.Result); + } + + [Fact] + public void Runnable_NullableResult_DefaultsToNull () + { + // Arrange & Act + Runnable runnable = new (); + + // Assert + Assert.Null (runnable.Result); + } + + [Fact] + public void Runnable_NullableResult_CanBeExplicitlyNull () + { + // Arrange + Runnable runnable = new () { Result = "test" }; + + // Act + runnable.Result = null; + + // Assert + Assert.Null (runnable.Result); + } + + [Fact] + public void Runnable_ComplexType_Result () + { + // Arrange + Runnable runnable = new (); + ComplexResult result = new () { Value = 42, Text = "test" }; + + // Act + runnable.Result = result; + + // Assert + Assert.NotNull (runnable.Result); + Assert.Equal (42, runnable.Result.Value); + Assert.Equal ("test", runnable.Result.Text); + } + + [Fact] + public void Runnable_IsRunning_WithNoApp () + { + // Arrange + Runnable runnable = new (); + + // Don't set App property + + // Act & Assert + Assert.False (runnable.IsRunning); + } + + [Fact] + public void Runnable_IsModal_WithNoApp () + { + // Arrange + Runnable runnable = new (); + + // Don't set App property + + // Act & Assert + Assert.False (runnable.IsModal); + } + + [Fact] + public void Runnable_VirtualMethods_CanBeOverridden () + { + // Arrange + OverriddenRunnable runnable = new (); + + // Act + bool canceledRunning = runnable.RaiseIsRunningChanging (false, true); + runnable.RaiseIsRunningChangedEvent (true); + runnable.RaiseIsModalChangedEvent (true); + + // Assert + Assert.True (runnable.OnIsRunningChangingCalled); + Assert.True (runnable.OnIsRunningChangedCalled); + Assert.True (runnable.OnIsModalChangedCalled); + } + + [Fact] + public void Runnable_RequestStop_WithNoApp () + { + // Arrange + Runnable runnable = new (); + + // Don't set App property + + // Act & Assert - Should not throw + runnable.RequestStop (); + } + + [Fact] + public void RunnableSessionToken_Constructor_RequiresRunnable () + { + // This is implicitly tested by the constructor signature, + // but let's verify it creates with non-null runnable + + // Arrange + Runnable runnable = new (); + + // Act + SessionToken token = new (runnable); + + // Assert + Assert.NotNull (token.Runnable); + } + + [Fact] + public void Runnable_EventArgs_PreservesValues () + { + // Arrange + Runnable runnable = new (); + bool? capturedOldValue = null; + bool? capturedNewValue = null; + + runnable.IsRunningChanging += (s, e) => + { + capturedOldValue = e.CurrentValue; + capturedNewValue = e.NewValue; + }; + + // Act + runnable.RaiseIsRunningChanging (false, true); + + // Assert + Assert.NotNull (capturedOldValue); + Assert.NotNull (capturedNewValue); + Assert.False (capturedOldValue.Value); + Assert.True (capturedNewValue.Value); + } + + [Fact] + public void Runnable_IsModalChanged_EventArgs_PreservesValue () + { + // Arrange + Runnable runnable = new (); + bool? capturedValue = null; + + runnable.IsModalChanged += (s, e) => { capturedValue = e.Value; }; + + // Act + runnable.RaiseIsModalChangedEvent (true); + + // Assert + Assert.NotNull (capturedValue); + Assert.True (capturedValue.Value); + } + + [Fact] + public void Runnable_DifferentGenericTypes_Independent () + { + // Arrange & Act + Runnable intRunnable = new () { Result = 42 }; + Runnable stringRunnable = new () { Result = "test" }; + Runnable boolRunnable = new () { Result = true }; + + // Assert + Assert.Equal (42, intRunnable.Result); + Assert.Equal ("test", stringRunnable.Result); + Assert.True (boolRunnable.Result); + } + + /// + /// Complex result type for testing. + /// + private class ComplexResult + { + public int Value { get; set; } + public string? Text { get; set; } + } + + /// + /// Runnable that tracks virtual method calls. + /// + private class OverriddenRunnable : Runnable + { + public bool OnIsRunningChangingCalled { get; private set; } + public bool OnIsRunningChangedCalled { get; private set; } + public bool OnIsModalChangedCalled { get; private set; } + + protected override bool OnIsRunningChanging (bool oldIsRunning, bool newIsRunning) + { + OnIsRunningChangingCalled = true; + + return base.OnIsRunningChanging (oldIsRunning, newIsRunning); + } + + protected override void OnIsRunningChanged (bool newIsRunning) + { + OnIsRunningChangedCalled = true; + base.OnIsRunningChanged (newIsRunning); + } + + protected override void OnIsModalChanged (bool newIsModal) + { + OnIsModalChangedCalled = true; + base.OnIsModalChanged (newIsModal); + } + } +} diff --git a/Tests/UnitTestsParallelizable/Application/Runnable/RunnableIntegrationTests.cs b/Tests/UnitTestsParallelizable/Application/Runnable/RunnableIntegrationTests.cs new file mode 100644 index 000000000..e38a77cb1 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/Runnable/RunnableIntegrationTests.cs @@ -0,0 +1,515 @@ +#nullable enable +using Xunit.Abstractions; + +namespace ApplicationTests; + +/// +/// Integration tests for IApplication's IRunnable support. +/// Tests the full lifecycle of IRunnable instances through Application methods. +/// +public class ApplicationRunnableIntegrationTests (ITestOutputHelper output) : IDisposable +{ + private readonly ITestOutputHelper _output = output; + private IApplication? _app; + + public void Dispose () + { + _app?.Dispose (); + _app = null; + } + + [Fact] + public void Begin_AddsRunnableToStack () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + int stackCountBefore = app.SessionStack?.Count ?? 0; + + // Act + SessionToken? token = app.Begin (runnable); + + // Assert + Assert.NotNull (token); + Assert.NotNull (token.Runnable); + Assert.Same (runnable, token.Runnable); + Assert.Equal (stackCountBefore + 1, app.SessionStack?.Count ?? 0); + + // Cleanup + app.End (token!); + } + + [Fact] + public void Begin_CanBeCanceled_ByIsRunningChanging () + { + // Arrange + IApplication app = GetApp (); + CancelableRunnable runnable = new () { CancelStart = true }; + + // Act + SessionToken? token = app.Begin (runnable); + + // Assert - Should not be added to stack if canceled + Assert.False (runnable.IsRunning); + + // Token not created + Assert.Null (token); + } + + [Fact] + public void Begin_RaisesIsModalChangedEvent () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + var isModalChangedRaised = false; + bool? receivedValue = null; + + runnable.IsModalChanged += (s, e) => + { + isModalChangedRaised = true; + receivedValue = e.Value; + }; + + // Act + SessionToken? token = app.Begin (runnable); + + // Assert + Assert.True (isModalChangedRaised); + Assert.True (receivedValue); + + // Cleanup + app.End (token!); + } + + [Fact] + public void Begin_RaisesIsRunningChangedEvent () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + var isRunningChangedRaised = false; + bool? receivedValue = null; + + runnable.IsRunningChanged += (s, e) => + { + isRunningChangedRaised = true; + receivedValue = e.Value; + }; + + // Act + SessionToken? token = app.Begin (runnable); + + // Assert + Assert.True (isRunningChangedRaised); + Assert.True (receivedValue); + + // Cleanup + app.End (token!); + } + + [Fact] + public void Begin_RaisesIsRunningChangingEvent () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + var isRunningChangingRaised = false; + bool? oldValue = null; + bool? newValue = null; + + runnable.IsRunningChanging += (s, e) => + { + isRunningChangingRaised = true; + oldValue = e.CurrentValue; + newValue = e.NewValue; + }; + + // Act + SessionToken? token = app.Begin (runnable); + + // Assert + Assert.True (isRunningChangingRaised); + Assert.False (oldValue); + Assert.True (newValue); + + // Cleanup + app.End (token!); + } + + [Fact] + public void Begin_SetsIsModalToTrue () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + + // Act + SessionToken? token = app.Begin (runnable); + + // Assert + Assert.True (runnable.IsModal); + + // Cleanup + app.End (token!); + } + + [Fact] + public void Begin_SetsIsRunningToTrue () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + + // Act + SessionToken? token = app.Begin (runnable); + + // Assert + Assert.True (runnable.IsRunning); + + // Cleanup + app.End (token!); + } + + [Fact] + public void Begin_ThrowsOnNullRunnable () + { + // Arrange + IApplication app = GetApp (); + + // Act & Assert + Assert.Throws (() => app.Begin ((IRunnable)null!)); + } + + [Fact] + public void End_CanBeCanceled_ByIsRunningChanging () + { + // Arrange + IApplication app = GetApp (); + CancelableRunnable runnable = new () { CancelStop = true }; + SessionToken? token = app.Begin (runnable); + runnable.CancelStop = true; // Enable cancellation + + // Act + app.End (token!); + + // Assert - Should still be running if canceled + Assert.True (runnable.IsRunning); + + // Force end by disabling cancellation + runnable.CancelStop = false; + app.End (token!); + } + + [Fact] + public void End_ClearsTokenRunnable () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + SessionToken? token = app.Begin (runnable); + + // Act + app.End (token!); + + // Assert + Assert.Null (token!.Runnable); + } + + [Fact] + public void End_RaisesIsRunningChangedEvent () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + SessionToken? token = app.Begin (runnable); + var isRunningChangedRaised = false; + bool? receivedValue = null; + + runnable.IsRunningChanged += (s, e) => + { + isRunningChangedRaised = true; + receivedValue = e.Value; + }; + + // Act + app.End (token!); + + // Assert + Assert.True (isRunningChangedRaised); + Assert.False (receivedValue); + } + + [Fact] + public void End_RaisesIsRunningChangingEvent () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + SessionToken? token = app.Begin (runnable); + var isRunningChangingRaised = false; + bool? oldValue = null; + bool? newValue = null; + + runnable.IsRunningChanging += (s, e) => + { + isRunningChangingRaised = true; + oldValue = e.CurrentValue; + newValue = e.NewValue; + }; + + // Act + app.End (token!); + + // Assert + Assert.True (isRunningChangingRaised); + Assert.True (oldValue); + Assert.False (newValue); + } + + [Fact] + public void End_RemovesRunnableFromStack () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + SessionToken? token = app.Begin (runnable); + int stackCountBefore = app.SessionStack?.Count ?? 0; + + // Act + app.End (token!); + + // Assert + Assert.Equal (stackCountBefore - 1, app.SessionStack?.Count ?? 0); + } + + [Fact] + public void End_SetsIsModalToFalse () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + SessionToken? token = app.Begin (runnable); + + // Act + app.End (token!); + + // Assert + Assert.False (runnable.IsModal); + } + + [Fact] + public void End_SetsIsRunningToFalse () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable = new (); + SessionToken? token = app.Begin (runnable); + + // Act + app.End (token!); + + // Assert + Assert.False (runnable.IsRunning); + } + + [Fact] + public void End_ThrowsOnNullToken () + { + // Arrange + IApplication app = GetApp (); + + // Act & Assert + Assert.Throws (() => app.End ((SessionToken)null!)); + } + + [Fact] + public void MultipleRunnables_IndependentResults () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable1 = new (); + Runnable runnable2 = new (); + + // Act + runnable1.Result = 42; + runnable2.Result = "test"; + + // Assert + Assert.Equal (42, runnable1.Result); + Assert.Equal ("test", runnable2.Result); + } + + [Fact] + public void NestedBegin_MaintainsStackOrder () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable1 = new () { Id = "1" }; + Runnable runnable2 = new () { Id = "2" }; + + // Act + SessionToken token1 = app.Begin (runnable1)!; + SessionToken token2 = app.Begin (runnable2)!; + + // Assert - runnable2 should be on top + Assert.True (runnable2.IsModal); + Assert.False (runnable1.IsModal); + Assert.True (runnable1.IsRunning); // Still running, just not modal + Assert.True (runnable2.IsRunning); + + // Cleanup + app.End (token2); + app.End (token1); + } + + [Fact] + public void NestedEnd_RestoresPreviousModal () + { + // Arrange + IApplication app = GetApp (); + Runnable runnable1 = new () { Id = "1" }; + Runnable runnable2 = new () { Id = "2" }; + SessionToken token1 = app.Begin (runnable1)!; + SessionToken token2 = app.Begin (runnable2)!; + + // Act - End the top runnable + app.End (token2); + + // Assert - runnable1 should become modal again + Assert.True (runnable1.IsModal); + Assert.False (runnable2.IsModal); + Assert.True (runnable1.IsRunning); + Assert.False (runnable2.IsRunning); + + // Cleanup + app.End (token1); + } + + [Fact] + public void RequestStop_WithIRunnable_WorksCorrectly () + { + // Arrange + IApplication app = GetApp (); + StoppableRunnable runnable = new (); + SessionToken? token = app.Begin (runnable); + + // Act + app.RequestStop (runnable); + + // Assert - RequestStop should trigger End eventually + // For now, just verify it doesn't throw + Assert.NotNull (runnable); + + // Cleanup + app.End (token!); + } + + [Fact] + public void RequestStop_WithNull_UsesTopRunnable () + { + // Arrange + IApplication app = GetApp (); + StoppableRunnable runnable = new (); + SessionToken? token = app.Begin (runnable); + + // Act + app.RequestStop ((IRunnable?)null); + + // Assert - Should not throw + Assert.NotNull (runnable); + + // Cleanup + app.End (token!); + } + + [Fact (Skip = "Run methods with main loop are not suitable for parallel tests - use non-parallel UnitTests instead")] + public void RunGeneric_CreatesAndReturnsRunnable () + { + // Arrange + IApplication app = GetApp (); + app.StopAfterFirstIteration = true; + + // Act - With fluent API, Run() returns IApplication for chaining + IApplication result = app.Run (); + + // Assert + Assert.NotNull (result); + Assert.Same (app, result); // Fluent API returns this + + // Note: Run blocks until stopped, but StopAfterFirstIteration makes it return immediately + // The runnable is automatically disposed by Dispose() + } + + [Fact (Skip = "Run methods with main loop are not suitable for parallel tests - use non-parallel UnitTests instead")] + public void RunGeneric_ThrowsIfNotInitialized () + { + // Arrange + IApplication app = Application.Create (); + + // Don't call Init + + // Act & Assert + Assert.Throws (() => app.Run ()); + + // Cleanup + app.Dispose (); + } + + private IApplication GetApp () + { + if (_app is null) + { + _app = Application.Create (); + _app.Init ("fake"); + } + + return _app; + } + + /// + /// Test runnable that can cancel lifecycle changes. + /// + private class CancelableRunnable : Runnable + { + public bool CancelStart { get; set; } + public bool CancelStop { get; set; } + + protected override bool OnIsRunningChanging (bool oldIsRunning, bool newIsRunning) + { + if (newIsRunning && CancelStart) + { + return true; // Cancel starting + } + + if (!newIsRunning && CancelStop) + { + return true; // Cancel stopping + } + + return base.OnIsRunningChanging (oldIsRunning, newIsRunning); + } + } + + /// + /// Test runnable that can be stopped. + /// + private class StoppableRunnable : Runnable + { + public override void RequestStop () + { + WasStopRequested = true; + base.RequestStop (); + } + + public bool WasStopRequested { get; private set; } + } + + /// + /// Test runnable for generic Run tests. + /// + private class TestRunnable : Runnable + { + public TestRunnable () { Id = "TestRunnable"; } + } +} diff --git a/Tests/UnitTestsParallelizable/Application/Runnable/RunnableLifecycleTests.cs b/Tests/UnitTestsParallelizable/Application/Runnable/RunnableLifecycleTests.cs new file mode 100644 index 000000000..0b05fb53a --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/Runnable/RunnableLifecycleTests.cs @@ -0,0 +1,157 @@ +#nullable enable +using Xunit.Abstractions; + +namespace ViewsTests; + +/// +/// Tests for IRunnable lifecycle behavior. +/// +public class RunnableLifecycleTests (ITestOutputHelper output) +{ + private readonly ITestOutputHelper _output = output; + + [Fact] + public void Runnable_OnIsRunningChanging_CanExtractResult () + { + // Arrange + ResultExtractingRunnable runnable = new (); + runnable.TestValue = "extracted"; + + // Act + bool canceled = runnable.RaiseIsRunningChanging (true, false); // Stopping + + // Assert + Assert.False (canceled); + Assert.Equal ("extracted", runnable.Result); + } + + [Fact] + public void Runnable_OnIsRunningChanging_ClearsResultWhenStarting () + { + // Arrange + ResultExtractingRunnable runnable = new () { Result = "previous" }; + + // Act + bool canceled = runnable.RaiseIsRunningChanging (false, true); // Starting + + // Assert + Assert.False (canceled); + Assert.Null (runnable.Result); // Result should be cleared + } + + [Fact] + public void Runnable_CanCancelStoppingWithUnsavedChanges () + { + // Arrange + UnsavedChangesRunnable runnable = new () { HasUnsavedChanges = true }; + + // Act + bool canceled = runnable.RaiseIsRunningChanging (true, false); // Stopping + + // Assert + Assert.True (canceled); // Should be canceled + } + + [Fact] + public void Runnable_AllowsStoppingWithoutUnsavedChanges () + { + // Arrange + UnsavedChangesRunnable runnable = new () { HasUnsavedChanges = false }; + + // Act + bool canceled = runnable.RaiseIsRunningChanging (true, false); // Stopping + + // Assert + Assert.False (canceled); // Should not be canceled + } + + [Fact] + public void Runnable_OnIsRunningChanged_CalledAfterStateChange () + { + // Arrange + TrackedRunnable runnable = new (); + + // Act + runnable.RaiseIsRunningChangedEvent (true); + + // Assert + Assert.True (runnable.OnIsRunningChangedCalled); + Assert.True (runnable.LastIsRunningValue); + } + + [Fact] + public void Runnable_OnIsModalChanged_CalledAfterStateChange () + { + // Arrange + TrackedRunnable runnable = new (); + + // Act + runnable.RaiseIsModalChangedEvent (true); + + // Assert + Assert.True (runnable.OnIsModalChangedCalled); + Assert.True (runnable.LastIsModalValue); + } + + /// + /// Test runnable that extracts result in OnIsRunningChanging. + /// + private class ResultExtractingRunnable : Runnable + { + public string? TestValue { get; set; } + + protected override bool OnIsRunningChanging (bool oldIsRunning, bool newIsRunning) + { + if (!newIsRunning) // Stopping + { + // Extract result before removal from stack + Result = TestValue; + } + + return base.OnIsRunningChanging (oldIsRunning, newIsRunning); + } + } + + /// + /// Test runnable that can prevent stopping with unsaved changes. + /// + private class UnsavedChangesRunnable : Runnable + { + public bool HasUnsavedChanges { get; set; } + + protected override bool OnIsRunningChanging (bool oldIsRunning, bool newIsRunning) + { + if (!newIsRunning && HasUnsavedChanges) // Stopping with unsaved changes + { + return true; // Cancel stopping + } + + return base.OnIsRunningChanging (oldIsRunning, newIsRunning); + } + } + + /// + /// Test runnable that tracks lifecycle method calls. + /// + private class TrackedRunnable : Runnable + { + public bool OnIsRunningChangedCalled { get; private set; } + public bool LastIsRunningValue { get; private set; } + public bool OnIsModalChangedCalled { get; private set; } + public bool LastIsModalValue { get; private set; } + + protected override void OnIsRunningChanged (bool newIsRunning) + { + OnIsRunningChangedCalled = true; + LastIsRunningValue = newIsRunning; + base.OnIsRunningChanged (newIsRunning); + } + + protected override void OnIsModalChanged (bool newIsModal) + { + OnIsModalChangedCalled = true; + LastIsModalValue = newIsModal; + base.OnIsModalChanged (newIsModal); + } + } +} diff --git a/Tests/UnitTestsParallelizable/Application/Runnable/RunnableSessionTokenTests.cs b/Tests/UnitTestsParallelizable/Application/Runnable/RunnableSessionTokenTests.cs new file mode 100644 index 000000000..194f2cbb8 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/Runnable/RunnableSessionTokenTests.cs @@ -0,0 +1,39 @@ +using Xunit.Abstractions; + +namespace ApplicationTests.RunnableTests; + +/// +/// Tests for RunnableSessionToken class. +/// +public class RunnableSessionTokenTests (ITestOutputHelper output) +{ + private readonly ITestOutputHelper _output = output; + + [Fact] + public void RunnableSessionToken_Constructor_SetsRunnable () + { + // Arrange + Runnable runnable = new (); + + // Act + SessionToken token = new (runnable); + + // Assert + Assert.NotNull (token.Runnable); + Assert.Same (runnable, token.Runnable); + } + + [Fact] + public void RunnableSessionToken_Runnable_CanBeSetToNull () + { + // Arrange + Runnable runnable = new (); + SessionToken token = new (runnable); + + // Act + token.Runnable = null; + + // Assert + Assert.Null (token.Runnable); + } +} diff --git a/Tests/UnitTestsParallelizable/Application/Runnable/RunnableTests.cs b/Tests/UnitTestsParallelizable/Application/Runnable/RunnableTests.cs new file mode 100644 index 000000000..250f7d07b --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/Runnable/RunnableTests.cs @@ -0,0 +1,184 @@ +using Xunit.Abstractions; + +namespace ApplicationTests.RunnableTests; + +/// +/// Tests for IRunnable interface and Runnable base class. +/// +public class RunnableTests (ITestOutputHelper output) +{ + private readonly ITestOutputHelper _output = output; + + [Fact] + public void Runnable_Implements_IRunnable () + { + // Arrange & Act + Runnable runnable = new (); + + // Assert + Assert.IsAssignableFrom (runnable); + Assert.IsAssignableFrom> (runnable); + } + + [Fact] + public void Runnable_Result_DefaultsToDefault () + { + // Arrange & Act + Runnable runnable = new (); + + // Assert + Assert.Equal (0, runnable.Result); + } + + [Fact] + public void Runnable_Result_CanBeSet () + { + // Arrange + Runnable runnable = new (); + + // Act + runnable.Result = 42; + + // Assert + Assert.Equal (42, runnable.Result); + } + + [Fact] + public void Runnable_Result_CanBeSetToNull () + { + // Arrange + Runnable runnable = new (); + + // Act + runnable.Result = null; + + // Assert + Assert.Null (runnable.Result); + } + + [Fact] + public void Runnable_IsRunning_ReturnsFalse_WhenNotRunning () + { + // Arrange + IApplication app = Application.Create (); + app.Init (); + Runnable runnable = new (); + + // Act & Assert + Assert.False (runnable.IsRunning); + + // Cleanup + app.Dispose (); + } + + [Fact] + public void Runnable_IsModal_ReturnsFalse_WhenNotRunning () + { + // Arrange + Runnable runnable = new (); + + // Act & Assert + // IsModal should be false when the runnable has no app or is not TopRunnable + Assert.False (runnable.IsModal); + } + + [Fact] + public void RaiseIsRunningChanging_ClearsResult_WhenStarting () + { + // Arrange + Runnable runnable = new () { Result = 42 }; + + // Act + bool canceled = runnable.RaiseIsRunningChanging (false, true); + + // Assert + Assert.False (canceled); + Assert.Equal (0, runnable.Result); // Result should be cleared + } + + [Fact] + public void RaiseIsRunningChanging_CanBeCanceled_ByVirtualMethod () + { + // Arrange + CancelableRunnable runnable = new (); + + // Act + bool canceled = runnable.RaiseIsRunningChanging (false, true); + + // Assert + Assert.True (canceled); + } + + [Fact] + public void RaiseIsRunningChanging_CanBeCanceled_ByEvent () + { + // Arrange + Runnable runnable = new (); + var eventRaised = false; + + runnable.IsRunningChanging += (s, e) => + { + eventRaised = true; + e.Cancel = true; + }; + + // Act + bool canceled = runnable.RaiseIsRunningChanging (false, true); + + // Assert + Assert.True (eventRaised); + Assert.True (canceled); + } + + [Fact] + public void RaiseIsRunningChanged_RaisesEvent () + { + // Arrange + Runnable runnable = new (); + var eventRaised = false; + bool? receivedValue = null; + + runnable.IsRunningChanged += (s, e) => + { + eventRaised = true; + receivedValue = e.Value; + }; + + // Act + runnable.RaiseIsRunningChangedEvent (true); + + // Assert + Assert.True (eventRaised); + Assert.True (receivedValue); + } + + [Fact] + public void RaiseIsModalChanged_RaisesEvent () + { + // Arrange + Runnable runnable = new (); + var eventRaised = false; + bool? receivedValue = null; + + runnable.IsModalChanged += (s, e) => + { + eventRaised = true; + receivedValue = e.Value; + }; + + // Act + runnable.RaiseIsModalChangedEvent (true); + + // Assert + Assert.True (eventRaised); + Assert.True (receivedValue); + } + + /// + /// Test runnable that can cancel lifecycle changes. + /// + private class CancelableRunnable : Runnable + { + protected override bool OnIsRunningChanging (bool oldIsRunning, bool newIsRunning) => true; // Always cancel + } +} diff --git a/Tests/UnitTestsParallelizable/Application/SessionTokenTests.cs b/Tests/UnitTestsParallelizable/Application/SessionTokenTests.cs new file mode 100644 index 000000000..1f3ddf7a9 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Application/SessionTokenTests.cs @@ -0,0 +1,44 @@ + +#nullable enable +namespace ApplicationTests; + +/// These tests focus on Application.SessionToken and the various ways it can be changed. +public class SessionTokenTests +{ + [Fact] + public void Begin_Throws_On_Null () + { + IApplication? app = Application.Create (); + // Test null Runnable + Assert.Throws (() => app.Begin (null!)); + } + + [Fact] + public void Begin_End_Cleans_Up_SessionToken () + { + IApplication? app = Application.Create (); + + Runnable top = new Runnable (); + SessionToken? sessionToken = app.Begin (top); + Assert.NotNull (sessionToken); + app.End (sessionToken); + + Assert.Null (app.TopRunnableView); + + Assert.DoesNotContain(sessionToken, app.SessionStack!); + + top.Dispose (); + + } + + [Fact] + public void New_Creates_SessionToken () + { + var rs = new SessionToken (null!); + Assert.Null (rs.Runnable); + + var top = new Runnable (); + rs = new (top); + Assert.Equal (top, rs.Runnable); + } +} diff --git a/Tests/UnitTestsParallelizable/Application/SmoothAcceleratingTimeoutTests.cs b/Tests/UnitTestsParallelizable/Application/SmoothAcceleratingTimeoutTests.cs index eac966801..9c484cd67 100644 --- a/Tests/UnitTestsParallelizable/Application/SmoothAcceleratingTimeoutTests.cs +++ b/Tests/UnitTestsParallelizable/Application/SmoothAcceleratingTimeoutTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.ApplicationTests; +namespace ApplicationTests; public class SmoothAcceleratingTimeoutTests diff --git a/Tests/UnitTestsParallelizable/Application/StackExtensionsTests.cs b/Tests/UnitTestsParallelizable/Application/StackExtensionsTests.cs deleted file mode 100644 index e11be2a43..000000000 --- a/Tests/UnitTestsParallelizable/Application/StackExtensionsTests.cs +++ /dev/null @@ -1,197 +0,0 @@ -using UnitTests; - -namespace UnitTests_Parallelizable.ApplicationTests; - -public class StackExtensionsTests : FakeDriverBase -{ - [Fact] - public void Stack_topLevels_Contains () - { - Stack topLevels = CreatetopLevels (); - var comparer = new ToplevelEqualityComparer (); - - Assert.True (topLevels.Contains (new Window { Id = "w2" }, comparer)); - Assert.False (topLevels.Contains (new Toplevel { Id = "top2" }, comparer)); - } - - [Fact] - public void Stack_topLevels_CreatetopLevels () - { - Stack topLevels = CreatetopLevels (); - - int index = topLevels.Count - 1; - - foreach (Toplevel top in topLevels) - { - if (top.GetType () == typeof (Toplevel)) - { - Assert.Equal ("Top", top.Id); - } - else - { - Assert.Equal ($"w{index}", top.Id); - } - - index--; - } - - Toplevel [] tops = topLevels.ToArray (); - - Assert.Equal ("w4", tops [0].Id); - Assert.Equal ("w3", tops [1].Id); - Assert.Equal ("w2", tops [2].Id); - Assert.Equal ("w1", tops [3].Id); - Assert.Equal ("Top", tops [^1].Id); - } - - [Fact] - public void Stack_topLevels_FindDuplicates () - { - Stack topLevels = CreatetopLevels (); - var comparer = new ToplevelEqualityComparer (); - - topLevels.Push (new Toplevel { Id = "w4" }); - topLevels.Push (new Toplevel { Id = "w1" }); - - Toplevel [] dup = topLevels.FindDuplicates (comparer).ToArray (); - - Assert.Equal ("w4", dup [0].Id); - Assert.Equal ("w1", dup [^1].Id); - } - - [Fact] - public void Stack_topLevels_MoveNext () - { - Stack topLevels = CreatetopLevels (); - - topLevels.MoveNext (); - - Toplevel [] tops = topLevels.ToArray (); - - Assert.Equal ("w3", tops [0].Id); - Assert.Equal ("w2", tops [1].Id); - Assert.Equal ("w1", tops [2].Id); - Assert.Equal ("Top", tops [3].Id); - Assert.Equal ("w4", tops [^1].Id); - } - - [Fact] - public void Stack_topLevels_MovePrevious () - { - Stack topLevels = CreatetopLevels (); - - topLevels.MovePrevious (); - - Toplevel [] tops = topLevels.ToArray (); - - Assert.Equal ("Top", tops [0].Id); - Assert.Equal ("w4", tops [1].Id); - Assert.Equal ("w3", tops [2].Id); - Assert.Equal ("w2", tops [3].Id); - Assert.Equal ("w1", tops [^1].Id); - } - - [Fact] - public void Stack_topLevels_MoveTo () - { - Stack topLevels = CreatetopLevels (); - - var valueToMove = new Window { Id = "w1" }; - var comparer = new ToplevelEqualityComparer (); - - topLevels.MoveTo (valueToMove, 1, comparer); - - Toplevel [] tops = topLevels.ToArray (); - - Assert.Equal ("w4", tops [0].Id); - Assert.Equal ("w1", tops [1].Id); - Assert.Equal ("w3", tops [2].Id); - Assert.Equal ("w2", tops [3].Id); - Assert.Equal ("Top", tops [^1].Id); - } - - [Fact] - public void Stack_topLevels_MoveTo_From_Last_To_Top () - { - Stack topLevels = CreatetopLevels (); - - var valueToMove = new Window { Id = "Top" }; - var comparer = new ToplevelEqualityComparer (); - - topLevels.MoveTo (valueToMove, 0, comparer); - - Toplevel [] tops = topLevels.ToArray (); - - Assert.Equal ("Top", tops [0].Id); - Assert.Equal ("w4", tops [1].Id); - Assert.Equal ("w3", tops [2].Id); - Assert.Equal ("w2", tops [3].Id); - Assert.Equal ("w1", tops [^1].Id); - } - - [Fact] - public void Stack_topLevels_Replace () - { - Stack topLevels = CreatetopLevels (); - - var valueToReplace = new Window { Id = "w1" }; - var valueToReplaceWith = new Window { Id = "new" }; - var comparer = new ToplevelEqualityComparer (); - - topLevels.Replace (valueToReplace, valueToReplaceWith, comparer); - - Toplevel [] tops = topLevels.ToArray (); - - Assert.Equal ("w4", tops [0].Id); - Assert.Equal ("w3", tops [1].Id); - Assert.Equal ("w2", tops [2].Id); - Assert.Equal ("new", tops [3].Id); - Assert.Equal ("Top", tops [^1].Id); - } - - [Fact] - public void Stack_topLevels_Swap () - { - Stack topLevels = CreatetopLevels (); - - var valueToSwapFrom = new Window { Id = "w3" }; - var valueToSwapTo = new Window { Id = "w1" }; - var comparer = new ToplevelEqualityComparer (); - topLevels.Swap (valueToSwapFrom, valueToSwapTo, comparer); - - Toplevel [] tops = topLevels.ToArray (); - - Assert.Equal ("w4", tops [0].Id); - Assert.Equal ("w1", tops [1].Id); - Assert.Equal ("w2", tops [2].Id); - Assert.Equal ("w3", tops [3].Id); - Assert.Equal ("Top", tops [^1].Id); - } - - [Fact] - public void ToplevelEqualityComparer_GetHashCode () - { - Stack topLevels = CreatetopLevels (); - - // Only allows unique keys - HashSet hCodes = new (); - - foreach (Toplevel top in topLevels) - { - Assert.True (hCodes.Add (top.GetHashCode ())); - } - } - - private Stack CreatetopLevels () - { - Stack topLevels = new (); - - topLevels.Push (new Toplevel { Id = "Top" }); - topLevels.Push (new Window { Id = "w1" }); - topLevels.Push (new Window { Id = "w2" }); - topLevels.Push (new Window { Id = "w3" }); - topLevels.Push (new Window { Id = "w4" }); - - return topLevels; - } -} diff --git a/Tests/UnitTestsParallelizable/Configuration/AttributeJsonConverterTests.cs b/Tests/UnitTestsParallelizable/Configuration/AttributeJsonConverterTests.cs index 2fd24d34f..47ff59c5a 100644 --- a/Tests/UnitTestsParallelizable/Configuration/AttributeJsonConverterTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/AttributeJsonConverterTests.cs @@ -2,7 +2,7 @@ using Moq; using UnitTests; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class AttributeJsonConverterTests { diff --git a/Tests/UnitTestsParallelizable/Configuration/ColorJsonConverterTests.cs b/Tests/UnitTestsParallelizable/Configuration/ColorJsonConverterTests.cs index 732a6f6e4..f01cdc950 100644 --- a/Tests/UnitTestsParallelizable/Configuration/ColorJsonConverterTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/ColorJsonConverterTests.cs @@ -1,6 +1,6 @@ using System.Text.Json; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class ColorJsonConverterTests { diff --git a/Tests/UnitTestsParallelizable/Configuration/ConfigPropertyTests.cs b/Tests/UnitTestsParallelizable/Configuration/ConfigPropertyTests.cs index cbcb73653..48b493a47 100644 --- a/Tests/UnitTestsParallelizable/Configuration/ConfigPropertyTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/ConfigPropertyTests.cs @@ -1,6 +1,6 @@ using System.Collections.Concurrent; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class ConfigPropertyTests { @@ -62,7 +62,7 @@ public class ConfigPropertyTests { var clone = DeepCloner.DeepClone (configProperty); Assert.NotSame (configProperty, clone); - Assert.Equal ("DeepCloneValue", clone.PropertyValue); + Assert.Equal ("DeepCloneValue", clone!.PropertyValue); }); } diff --git a/Tests/UnitTestsParallelizable/Configuration/ConfigurationMangerTests.cs b/Tests/UnitTestsParallelizable/Configuration/ConfigurationMangerTests.cs deleted file mode 100644 index 4fa15e09e..000000000 --- a/Tests/UnitTestsParallelizable/Configuration/ConfigurationMangerTests.cs +++ /dev/null @@ -1,21 +0,0 @@ -#nullable enable -namespace UnitTests_Parallelizable.ConfigurationTests; - -public class ConfigurationManagerTests -{ - [ConfigurationProperty (Scope = typeof (CMTestsScope))] - public static bool? TestProperty { get; set; } - - private class CMTestsScope : Scope - { - } - - [Fact] - public void GetConfigPropertiesByScope_Gets () - { - var props = ConfigurationManager.GetUninitializedConfigPropertiesByScope ("CMTestsScope"); - - Assert.NotNull (props); - Assert.NotEmpty (props); - } -} diff --git a/Tests/UnitTestsParallelizable/Configuration/ConfigurationPropertyAttributeTests.cs b/Tests/UnitTestsParallelizable/Configuration/ConfigurationPropertyAttributeTests.cs index 99eab2dd7..21b383efa 100644 --- a/Tests/UnitTestsParallelizable/Configuration/ConfigurationPropertyAttributeTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/ConfigurationPropertyAttributeTests.cs @@ -4,7 +4,7 @@ using System.Reflection; using System.Text.Json.Serialization; using System.Text.Json.Serialization.Metadata; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class ConfigurationPropertyAttributeTests { diff --git a/Tests/UnitTestsParallelizable/Configuration/DeepClonerTests.cs b/Tests/UnitTestsParallelizable/Configuration/DeepClonerTests.cs index 0f4c671a0..8af27c191 100644 --- a/Tests/UnitTestsParallelizable/Configuration/DeepClonerTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/DeepClonerTests.cs @@ -5,7 +5,7 @@ using System.Collections.Immutable; using System.Diagnostics; using System.Text; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; /// /// Unit tests for the class, ensuring robust deep cloning for diff --git a/Tests/UnitTestsParallelizable/Configuration/KeyCodeJsonConverterTests.cs b/Tests/UnitTestsParallelizable/Configuration/KeyCodeJsonConverterTests.cs index c3e0c13be..c22ee71bd 100644 --- a/Tests/UnitTestsParallelizable/Configuration/KeyCodeJsonConverterTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/KeyCodeJsonConverterTests.cs @@ -1,6 +1,6 @@ using System.Text.Json; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class KeyCodeJsonConverterTests { diff --git a/Tests/UnitTestsParallelizable/Configuration/KeyJsonConverterTests.cs b/Tests/UnitTestsParallelizable/Configuration/KeyJsonConverterTests.cs index d3d7e1571..ce9151b7c 100644 --- a/Tests/UnitTestsParallelizable/Configuration/KeyJsonConverterTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/KeyJsonConverterTests.cs @@ -3,7 +3,7 @@ using System.Text.Encodings.Web; using System.Text.Json; using System.Text.Unicode; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class KeyJsonConverterTests { @@ -49,7 +49,7 @@ public class KeyJsonConverterTests var deserializedKey = JsonSerializer.Deserialize (json, ConfigurationManager.SerializerContext.Options); // Assert - Assert.Equal (expectedStringTo, deserializedKey.ToString ()); + Assert.Equal (expectedStringTo, deserializedKey!.ToString ()); } [Fact] @@ -60,7 +60,7 @@ public class KeyJsonConverterTests // Act string json = "\"Ctrl+Q\""; - Key deserializedKey = JsonSerializer.Deserialize (json, ConfigurationManager.SerializerContext.Options); + Key? deserializedKey = JsonSerializer.Deserialize (json, ConfigurationManager.SerializerContext.Options); // Assert Assert.Equal (key, deserializedKey); diff --git a/Tests/UnitTestsParallelizable/Configuration/MemorySizeEstimator.cs b/Tests/UnitTestsParallelizable/Configuration/MemorySizeEstimator.cs index 8d042533e..701a40e69 100644 --- a/Tests/UnitTestsParallelizable/Configuration/MemorySizeEstimator.cs +++ b/Tests/UnitTestsParallelizable/Configuration/MemorySizeEstimator.cs @@ -1,6 +1,6 @@ #nullable enable -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; using System; using System.Collections; @@ -122,11 +122,11 @@ public static class MemorySizeEstimator return false; } - private static long EstimateSimpleTypeSize (object source, Type type) + private static long EstimateSimpleTypeSize (object? source, Type type) { if (type == typeof (string)) { - string str = (string)source; + string str = (string)source!; // Header + length (4) + char array ref + chars (2 bytes each) return OBJECT_HEADER_SIZE + 4 + POINTER_SIZE + (str.Length * 2); } @@ -142,9 +142,9 @@ public static class MemorySizeEstimator } } - private static long EstimateArraySize (object source, ConcurrentDictionary visited) + private static long EstimateArraySize (object? source, ConcurrentDictionary visited) { - Array array = (Array)source; + Array array = (Array)source!; long size = OBJECT_HEADER_SIZE + 4 + POINTER_SIZE; // Header + length + padding foreach (object? element in array) @@ -155,9 +155,9 @@ public static class MemorySizeEstimator return size; } - private static long EstimateDictionarySize (object source, ConcurrentDictionary visited) + private static long EstimateDictionarySize (object? source, ConcurrentDictionary visited) { - IDictionary dict = (IDictionary)source; + IDictionary dict = (IDictionary)source!; long size = OBJECT_HEADER_SIZE + (POINTER_SIZE * 5); // Header + buckets, entries, comparer, fields size += dict.Count * 4; // Bucket array (~4 bytes per entry) size += dict.Count * (4 + 4 + POINTER_SIZE * 2); // Entry array: hashcode, next, key, value @@ -171,9 +171,9 @@ public static class MemorySizeEstimator return size; } - private static long EstimateCollectionSize (object source, ConcurrentDictionary visited) + private static long EstimateCollectionSize (object? source, ConcurrentDictionary visited) { - Type type = source.GetType (); + Type type = source!.GetType (); long size = OBJECT_HEADER_SIZE + (POINTER_SIZE * 3); // Header + internal array + fields if (type.IsGenericType && type.GetGenericTypeDefinition () == typeof (Dictionary<,>)) @@ -192,7 +192,7 @@ public static class MemorySizeEstimator return size; } - private static long EstimateObjectSize (object source, Type type, ConcurrentDictionary visited) + private static long EstimateObjectSize (object? source, Type type, ConcurrentDictionary visited) { long size = OBJECT_HEADER_SIZE; diff --git a/Tests/UnitTestsParallelizable/Configuration/RuneJsonConverterTests.cs b/Tests/UnitTestsParallelizable/Configuration/RuneJsonConverterTests.cs index e37b47972..c57189389 100644 --- a/Tests/UnitTestsParallelizable/Configuration/RuneJsonConverterTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/RuneJsonConverterTests.cs @@ -1,7 +1,7 @@ using System.Text; using System.Text.Json; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class RuneJsonConverterTests { diff --git a/Tests/UnitTestsParallelizable/Configuration/SchemeJsonConverterTests.cs b/Tests/UnitTestsParallelizable/Configuration/SchemeJsonConverterTests.cs index b057084cc..e6f42ffe8 100644 --- a/Tests/UnitTestsParallelizable/Configuration/SchemeJsonConverterTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/SchemeJsonConverterTests.cs @@ -1,6 +1,6 @@ using System.Text.Json; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class SchemeJsonConverterTests { @@ -78,7 +78,7 @@ public class SchemeJsonConverterTests }; string json = JsonSerializer.Serialize (expected, ConfigurationManager.SerializerContext.Options); - Scheme actual = JsonSerializer.Deserialize (json, ConfigurationManager.SerializerContext.Options); + Scheme? actual = JsonSerializer.Deserialize (json, ConfigurationManager.SerializerContext.Options); Assert.NotNull (actual); diff --git a/Tests/UnitTestsParallelizable/Configuration/SchemeManagerTests.cs b/Tests/UnitTestsParallelizable/Configuration/SchemeManagerTests.cs index c28993fe7..1365d63f0 100644 --- a/Tests/UnitTestsParallelizable/Configuration/SchemeManagerTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/SchemeManagerTests.cs @@ -2,7 +2,7 @@ using System.Diagnostics; using System.Text.Json; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class SchemeManagerTests { @@ -47,7 +47,7 @@ public class SchemeManagerTests Assert.Contains ("Base", names); Assert.Contains ("Menu", names); Assert.Contains ("Dialog", names); - Assert.Contains ("Toplevel", names); + Assert.Contains ("Runnable", names); Assert.Contains ("Error", names); } diff --git a/Tests/UnitTestsParallelizable/Configuration/ScopeJsonConverterTests.cs b/Tests/UnitTestsParallelizable/Configuration/ScopeJsonConverterTests.cs index 290efeba1..52d50ecfa 100644 --- a/Tests/UnitTestsParallelizable/Configuration/ScopeJsonConverterTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/ScopeJsonConverterTests.cs @@ -1,7 +1,7 @@ #nullable enable using System.Text.Json; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class ScopeJsonConverterTests { diff --git a/Tests/UnitTestsParallelizable/Configuration/ScopeTests.cs b/Tests/UnitTestsParallelizable/Configuration/ScopeTests.cs index 000744067..1db3b0fb7 100644 --- a/Tests/UnitTestsParallelizable/Configuration/ScopeTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/ScopeTests.cs @@ -1,7 +1,7 @@ #nullable enable using System.Reflection; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class ScopeTests { diff --git a/Tests/UnitTestsParallelizable/Configuration/SettingsScopeTests.cs b/Tests/UnitTestsParallelizable/Configuration/SettingsScopeTests.cs index 24526de0f..fe1f4b6d8 100644 --- a/Tests/UnitTestsParallelizable/Configuration/SettingsScopeTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/SettingsScopeTests.cs @@ -1,5 +1,5 @@  -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class SettingsScopeTests { diff --git a/Tests/UnitTestsParallelizable/Configuration/SourcesManagerTests.cs b/Tests/UnitTestsParallelizable/Configuration/SourcesManagerTests.cs index 253acc8c0..fd37edbd1 100644 --- a/Tests/UnitTestsParallelizable/Configuration/SourcesManagerTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/SourcesManagerTests.cs @@ -1,13 +1,13 @@ using System.Reflection; using System.Text.Json; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class SourcesManagerTests { #region Update (Stream) [Fact] - public void Update_WithNullSettingsScope_ReturnsFalse () + public void Load_WithNullSettingsScope_ReturnsFalse () { // Arrange var sourcesManager = new SourcesManager (); @@ -23,7 +23,7 @@ public class SourcesManagerTests } [Fact] - public void Update_WithValidStream_UpdatesSettingsScope () + public void Load_WithValidStream_UpdatesSettingsScope () { // Arrange var sourcesManager = new SourcesManager (); @@ -56,7 +56,7 @@ public class SourcesManagerTests } [Fact] - public void Update_WithInvalidJson_AddsJsonError () + public void Load_WithInvalidJson_AddsJsonError () { // Arrange var sourcesManager = new SourcesManager (); @@ -86,7 +86,7 @@ public class SourcesManagerTests #region Update (FilePath) [Fact] - public void Update_WithNonExistentFile_AddsToSourcesAndReturnsTrue () + public void Load_WithNonExistentFile_AddsToSourcesAndReturnsTrue () { // Arrange var sourcesManager = new SourcesManager (); @@ -104,7 +104,7 @@ public class SourcesManagerTests } [Fact] - public void Update_WithValidFile_UpdatesSettingsScope () + public void Load_WithValidFile_UpdatesSettingsScope () { // Arrange var sourcesManager = new SourcesManager (); @@ -140,7 +140,7 @@ public class SourcesManagerTests } [Fact] - public void Update_WithIOException_RetriesAndFailsGracefully () + public void Load_WithIOException_RetriesAndFailsGracefully () { // Arrange var sourcesManager = new SourcesManager (); @@ -174,7 +174,7 @@ public class SourcesManagerTests #region Update (Json String) [Fact] - public void Update_WithNullOrEmptyJson_ReturnsFalse () + public void Load_WithNullOrEmptyJson_ReturnsFalse () { // Arrange var sourcesManager = new SourcesManager (); @@ -193,7 +193,7 @@ public class SourcesManagerTests } [Fact] - public void Update_WithValidJson_UpdatesSettingsScope () + public void Load_WithValidJson_UpdatesSettingsScope () { // Arrange var sourcesManager = new SourcesManager (); @@ -218,6 +218,33 @@ public class SourcesManagerTests Assert.Contains (source, sourcesManager.Sources.Values); } + + //[Fact] + //public void Update_WithValidJson_UpdatesThemeScope () + //{ + // // Arrange + // var sourcesManager = new SourcesManager (); + // var themeScope = new ThemeScope (); + // themeScope.LoadHardCodedDefaults (); + // themeScope ["Button.DefaultShadowStyle"].PropertyValue = ShadowStyle.Opaque; + + // var json = """ + // { + // "Button.DefaultShadowStyle": "None" + // } + // """; + // var source = "test.json"; + // var location = ConfigLocations.HardCoded; + + // // Act + // bool result = sourcesManager.Load (themeScope, json, source, location); + + // // Assert + // Assert.True (result); + // Assert.Equal (Key.Z.WithCtrl, themeScope ["Application.QuitKey"].PropertyValue as Key); + // Assert.Contains (source, sourcesManager.Sources.Values); + //} + #endregion #region Load @@ -235,7 +262,7 @@ public class SourcesManagerTests var location = ConfigLocations.AppResources; // Act - bool result = sourcesManager.Load (settingsScope, assembly, null, location); + bool result = sourcesManager.Load (settingsScope, assembly, string.Empty, location); // Assert Assert.False (result); @@ -354,7 +381,7 @@ public class SourcesManagerTests } [Fact] - public void Update_WhenCalledMultipleTimes_MaintainsLastSourceForLocation () + public void Load_WhenCalledMultipleTimes_MaintainsLastSourceForLocation () { // Arrange var sourcesManager = new SourcesManager (); @@ -374,7 +401,7 @@ public class SourcesManagerTests } [Fact] - public void Update_WithDifferentLocations_AddsAllSourcesToCollection () + public void Load_WithDifferentLocations_AddsAllSourcesToCollection () { // Arrange var sourcesManager = new SourcesManager (); @@ -425,7 +452,7 @@ public class SourcesManagerTests } [Fact] - public void Update_WithNonExistentFileAndDifferentLocations_TracksAllSources () + public void Load_WithNonExistentFileAndDifferentLocations_TracksAllSources () { // Arrange var sourcesManager = new SourcesManager (); @@ -488,47 +515,6 @@ public class SourcesManagerTests Assert.Equal (streamSource, sourcesManager.Sources [location3]); } - [Fact] - public void Sources_StaysConsistentWhenUpdateFails () - { - // Arrange - var sourcesManager = new SourcesManager (); - var settingsScope = new SettingsScope (); - - // Add one successful source - var validSource = "valid.json"; - var validLocation = ConfigLocations.Runtime; - sourcesManager.Load (settingsScope, """{"Application.QuitKey": "Ctrl+Z"}""", validSource, validLocation); - - try - { - // Configure to throw on errors - ConfigurationManager.ThrowOnJsonErrors = true; - - // Act & Assert - attempt to update with invalid JSON - var invalidSource = "invalid.json"; - var invalidLocation = ConfigLocations.AppCurrent; - var invalidJson = "{ invalid json }"; - - Assert.Throws ( - () => - sourcesManager.Load (settingsScope, invalidJson, invalidSource, invalidLocation)); - - // The valid source should still be there - Assert.Single (sourcesManager.Sources); - Assert.Equal (validSource, sourcesManager.Sources [validLocation]); - - // The invalid source should not have been added - Assert.DoesNotContain (invalidLocation, sourcesManager.Sources.Keys); - } - finally - { - // Reset for other tests - ConfigurationManager.ThrowOnJsonErrors = false; - - } - } - #endregion } diff --git a/Tests/UnitTestsParallelizable/Configuration/ThemeScopeTests.cs b/Tests/UnitTestsParallelizable/Configuration/ThemeScopeTests.cs index 4d8427e84..811010e43 100644 --- a/Tests/UnitTestsParallelizable/Configuration/ThemeScopeTests.cs +++ b/Tests/UnitTestsParallelizable/Configuration/ThemeScopeTests.cs @@ -1,7 +1,7 @@ using System.Diagnostics; using System.Text.Json; -namespace UnitTests_Parallelizable.ConfigurationTests; +namespace ConfigurationTests; public class ThemeScopeTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/AlignerTests.cs b/Tests/UnitTestsParallelizable/Drawing/AlignerTests.cs index da50f9517..85e2fd055 100644 --- a/Tests/UnitTestsParallelizable/Drawing/AlignerTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/AlignerTests.cs @@ -2,7 +2,7 @@ using System.Text; using System.Text.Json; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class AlignerTests (ITestOutputHelper output) { diff --git a/Tests/UnitTestsParallelizable/Drawing/AttributeTests.cs b/Tests/UnitTestsParallelizable/Drawing/AttributeTests.cs index 311d0681d..9b6e7b547 100644 --- a/Tests/UnitTestsParallelizable/Drawing/AttributeTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/AttributeTests.cs @@ -2,7 +2,7 @@ using UnitTests; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class AttributeTests : FakeDriverBase { diff --git a/Tests/UnitTestsParallelizable/Drawing/CellTests.cs b/Tests/UnitTestsParallelizable/Drawing/CellTests.cs index 13a088a13..f6da2e852 100644 --- a/Tests/UnitTestsParallelizable/Drawing/CellTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/CellTests.cs @@ -1,17 +1,39 @@ using System.Text; -using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; -public class CellTests () +public class CellTests { [Fact] public void Constructor_Defaults () { var c = new Cell (); Assert.True (c is { }); - Assert.Equal (0, c.Rune.Value); + Assert.Empty (c.Runes); Assert.Null (c.Attribute); + Assert.False (c.IsDirty); + Assert.Null (c.Grapheme); + } + + [Theory] + [InlineData (null, new uint [] { })] + [InlineData ("", new uint [] { })] + [InlineData ("a", new uint [] { 0x0061 })] + [InlineData ("👩‍❤️‍💋‍👨", new uint [] { 0x1F469, 0x200D, 0x2764, 0xFE0F, 0x200D, 0x1F48B, 0x200D, 0x1F468 })] + [InlineData ("æ", new uint [] { 0x00E6 })] + [InlineData ("a︠", new uint [] { 0x0061, 0xFE20 })] + [InlineData ("e︡", new uint [] { 0x0065, 0xFE21 })] + public void Runes_From_Grapheme (string? grapheme, uint [] expected) + { + // Arrange + var c = new Cell { Grapheme = grapheme! }; + + // Act + Rune [] runes = expected.Select (u => new Rune (u)).ToArray (); + + // Assert + Assert.Equal (grapheme, c.Grapheme); + Assert.Equal (runes, c.Runes); } [Fact] @@ -21,32 +43,138 @@ public class CellTests () var c2 = new Cell { - Rune = new ('a'), Attribute = new (Color.Red) + Grapheme = "a", Attribute = new (Color.Red) }; Assert.False (c1.Equals (c2)); Assert.False (c2.Equals (c1)); - c1.Rune = new ('a'); + c1.Grapheme = "a"; c1.Attribute = new (); - Assert.Equal (c1.Rune, c2.Rune); + Assert.Equal (c1.Grapheme, c2.Grapheme); Assert.False (c1.Equals (c2)); Assert.False (c2.Equals (c1)); } [Fact] - public void ToString_Override () + public void Set_Text_With_Invalid_Grapheme_Throws () { - var c1 = new Cell (); - - var c2 = new Cell - { - Rune = new ('a'), Attribute = new (Color.Red) - }; - Assert.Equal ("['\0':]", c1.ToString ()); - - Assert.Equal ( - "['a':[Red,Red,None]]", - c2.ToString () - ); + Assert.Throws (() => new Cell { Grapheme = "ab" }); + Assert.Throws (() => new Cell { Grapheme = "\u0061\u0062" }); // ab } + + [Theory] + [MemberData (nameof (ToStringTestData))] + public void ToString_Override (string text, Attribute? attribute, string expected) + { + var c = new Cell (attribute, true, text); + string result = c.ToString (); + + Assert.Equal (expected, result); + } + + public static IEnumerable ToStringTestData () + { + yield return ["", null, "[\"\":]"]; + yield return ["a", null, "[\"a\":]"]; + yield return ["\t", null, "[\"\\t\":]"]; + yield return ["\r", null, "[\"\\r\":]"]; + yield return ["\n", null, "[\"\\n\":]"]; + yield return ["\r\n", null, "[\"\\r\\n\":]"]; + yield return ["\f", null, "[\"\\f\":]"]; + yield return ["\v", null, "[\"\\v\":]"]; + yield return ["\x1B", null, "[\"\\u001B\":]"]; + yield return ["\\", new Attribute (Color.Blue), "[\"\\\":[Blue,Blue,None]]"]; + yield return ["😀", null, "[\"😀\":]"]; + yield return ["👨‍👩‍👦‍👦", null, "[\"👨‍👩‍👦‍👦\":]"]; + yield return ["A", new Attribute (Color.Red) { Style = TextStyle.Blink }, "[\"A\":[Red,Red,Blink]]"]; + yield return ["\U0001F469\u200D\u2764\uFE0F\u200D\U0001F48B\u200D\U0001F468", null, "[\"👩‍❤️‍💋‍👨\":]"]; + } + + [Fact] + public void Graphemes_Decomposed_Normalize () + { + Cell c1 = new () + { + // 'e' + '◌́' COMBINING ACUTE ACCENT (U+0301) + Grapheme = "e\u0301" // visually "é" + }; + + Cell c2 = new () + { + // NFC single code point (U+00E9) + Grapheme = "é" + }; + + // Validation + Assert.Equal ("é", c1.Grapheme); // Proper normalized grapheme + Assert.Equal (c1.Grapheme, c2.Grapheme); + Assert.Equal (c1.Runes.Count, c2.Runes.Count); + Assert.Equal (new (0x00E9), c2.Runes [0]); + } + + [Fact] + public void Cell_IsDirty_Flag_Works () + { + var c = new Cell (); + Assert.False (c.IsDirty); + c.IsDirty = true; + Assert.True (c.IsDirty); + c.IsDirty = false; + Assert.False (c.IsDirty); + } + + [Theory] + [InlineData ("\uFDD0", false)] + [InlineData ("\uFDEF", false)] + [InlineData ("\uFFFE", true)] + [InlineData ("\uFFFF", false)] + [InlineData ("\U0001FFFE", false)] + [InlineData ("\U0001FFFF", false)] + [InlineData ("\U0010FFFE", false)] + [InlineData ("\U0010FFFF", false)] + public void IsNormalized_ArgumentException (string text, bool throws) + { + try + { + bool normalized = text.IsNormalized (NormalizationForm.FormC); + + Assert.True (normalized); + Assert.False (throws); + } + catch (ArgumentException) + { + Assert.True (throws); + } + + Assert.Null (Record.Exception (() => new Cell { Grapheme = text })); + } + + [Fact] + public void Surrogate_Normalize_Throws_And_Cell_Setter_Throws () + { + // Create the lone high surrogate at runtime (safe) + string s = new string ((char)0xD800, 1); + + // Confirm the runtime string actually contains the surrogate + Assert.Equal (0xD800, s [0]); + + // Normalize should throw + Assert.Throws (() => s.Normalize (NormalizationForm.FormC)); + + // And if your Grapheme setter normalizes, assignment should throw as well + Assert.Throws (() => new Cell () { Grapheme = s }); + + // Create the lone low surrogate at runtime (safe) + s = new string ((char)0xDC00, 1); + + // Confirm the runtime string actually contains the surrogate + Assert.Equal (0xDC00, s [0]); + + // Normalize should throw + Assert.Throws (() => s.Normalize (NormalizationForm.FormC)); + + // And if your Grapheme setter normalizes, assignment should throw as well + Assert.Throws (() => new Cell () { Grapheme = s }); + } + } diff --git a/Tests/UnitTestsParallelizable/Drawing/Color/AnsiColorNameResolverTests.cs b/Tests/UnitTestsParallelizable/Drawing/Color/AnsiColorNameResolverTests.cs index ee3ad49c0..bf40a17bc 100644 --- a/Tests/UnitTestsParallelizable/Drawing/Color/AnsiColorNameResolverTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/Color/AnsiColorNameResolverTests.cs @@ -1,6 +1,6 @@ #nullable enable -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class AnsiColorNameResolverTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/Color/ColorStandardColorTests.cs b/Tests/UnitTestsParallelizable/Drawing/Color/ColorStandardColorTests.cs index 04666d2cd..f69ca4d41 100644 --- a/Tests/UnitTestsParallelizable/Drawing/Color/ColorStandardColorTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/Color/ColorStandardColorTests.cs @@ -1,6 +1,6 @@ using Xunit; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class ColorStandardColorTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/Color/MultiStandardColorNameResolverTests.cs b/Tests/UnitTestsParallelizable/Drawing/Color/MultiStandardColorNameResolverTests.cs index f804e7b49..6614db6ff 100644 --- a/Tests/UnitTestsParallelizable/Drawing/Color/MultiStandardColorNameResolverTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/Color/MultiStandardColorNameResolverTests.cs @@ -4,7 +4,7 @@ using System.Collections.Generic; using Xunit.Abstractions; using Terminal.Gui; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class MultiStandardColorNameResolverTests (ITestOutputHelper output) { diff --git a/Tests/UnitTestsParallelizable/Drawing/Color/StandardColorNameResolverTests.cs b/Tests/UnitTestsParallelizable/Drawing/Color/StandardColorNameResolverTests.cs index 5b6c84eef..0f8391d3d 100644 --- a/Tests/UnitTestsParallelizable/Drawing/Color/StandardColorNameResolverTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/Color/StandardColorNameResolverTests.cs @@ -2,7 +2,7 @@ using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class StandardColorNameResolverTests (ITestOutputHelper output) { diff --git a/Tests/UnitTestsParallelizable/Drawing/ColorTests.Constructors.cs b/Tests/UnitTestsParallelizable/Drawing/ColorTests.Constructors.cs index 7b4122f61..531108ad2 100644 --- a/Tests/UnitTestsParallelizable/Drawing/ColorTests.Constructors.cs +++ b/Tests/UnitTestsParallelizable/Drawing/ColorTests.Constructors.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public partial class ColorTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/ColorTests.Operators.cs b/Tests/UnitTestsParallelizable/Drawing/ColorTests.Operators.cs index 2eecafa12..de0cfeb66 100644 --- a/Tests/UnitTestsParallelizable/Drawing/ColorTests.Operators.cs +++ b/Tests/UnitTestsParallelizable/Drawing/ColorTests.Operators.cs @@ -1,7 +1,7 @@ using System.Numerics; using System.Reflection; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public partial class ColorTests { @@ -195,7 +195,7 @@ public static partial class ColorTestsTheoryDataGenerators public static TheoryData Fields_At_Expected_Offsets () { - TheoryData data = [] + TheoryData data = [] ; data.Add ( @@ -246,6 +246,6 @@ public static partial class ColorTestsTheoryDataGenerators 3 ); - return data; + return data!; } } diff --git a/Tests/UnitTestsParallelizable/Drawing/ColorTests.ParsingAndFormatting.cs b/Tests/UnitTestsParallelizable/Drawing/ColorTests.ParsingAndFormatting.cs index 1967f64b5..0ac9be122 100644 --- a/Tests/UnitTestsParallelizable/Drawing/ColorTests.ParsingAndFormatting.cs +++ b/Tests/UnitTestsParallelizable/Drawing/ColorTests.ParsingAndFormatting.cs @@ -2,7 +2,7 @@ using System.Buffers.Binary; using System.Globalization; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public partial class ColorTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/ColorTests.TypeChecks.cs b/Tests/UnitTestsParallelizable/Drawing/ColorTests.TypeChecks.cs index 07d574191..5ad8f7e37 100644 --- a/Tests/UnitTestsParallelizable/Drawing/ColorTests.TypeChecks.cs +++ b/Tests/UnitTestsParallelizable/Drawing/ColorTests.TypeChecks.cs @@ -1,7 +1,7 @@ using System.Numerics; using System.Runtime.CompilerServices; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public partial class ColorTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/ColorTests.cs b/Tests/UnitTestsParallelizable/Drawing/ColorTests.cs index 396b64769..c1d26d5a2 100644 --- a/Tests/UnitTestsParallelizable/Drawing/ColorTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/ColorTests.cs @@ -1,6 +1,6 @@ #nullable enable -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public partial class ColorTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/DrawContextTests.cs b/Tests/UnitTestsParallelizable/Drawing/DrawContextTests.cs index c6b5c06f7..d33aa0cd3 100644 --- a/Tests/UnitTestsParallelizable/Drawing/DrawContextTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/DrawContextTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class DrawContextTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/FillPairTests.cs b/Tests/UnitTestsParallelizable/Drawing/FillPairTests.cs index 125913706..fe1992003 100644 --- a/Tests/UnitTestsParallelizable/Drawing/FillPairTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/FillPairTests.cs @@ -4,7 +4,7 @@ using System.Linq; using System.Text; using System.Threading.Tasks; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class FillPairTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/GradientFillTests.cs b/Tests/UnitTestsParallelizable/Drawing/GradientFillTests.cs index ffceb13bf..f2e10e8e0 100644 --- a/Tests/UnitTestsParallelizable/Drawing/GradientFillTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/GradientFillTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class GradientFillTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/GradientTests.cs b/Tests/UnitTestsParallelizable/Drawing/GradientTests.cs index 75fcdd397..8a8b69bc2 100644 --- a/Tests/UnitTestsParallelizable/Drawing/GradientTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/GradientTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class GradientTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/LineCanvasTests.cs b/Tests/UnitTestsParallelizable/Drawing/LineCanvasTests.cs index 91530891c..7178ea897 100644 --- a/Tests/UnitTestsParallelizable/Drawing/LineCanvasTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/LineCanvasTests.cs @@ -2,7 +2,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; /// /// Pure unit tests for that don't require Application.Driver or View context. @@ -1410,7 +1410,7 @@ public class LineCanvasTests (ITestOutputHelper output) : FakeDriverBase foreach (Cell? cell in cellMap.Values) { Assert.NotNull (cell); - Assert.Equal (foregroundColor, cell.Value.Attribute.Value.Foreground); + Assert.Equal (foregroundColor, cell.Value.Attribute!.Value.Foreground); Assert.Equal (backgroundColor, cell.Value.Attribute.Value.Background); } } @@ -1439,7 +1439,7 @@ public class LineCanvasTests (ITestOutputHelper output) : FakeDriverBase foreach (Cell? cell in cellMap.Values) { Assert.NotNull (cell); - Assert.Equal (foregroundColor, cell.Value.Attribute.Value.Foreground); + Assert.Equal (foregroundColor, cell.Value.Attribute!.Value.Foreground); Assert.Equal (backgroundColor, cell.Value.Attribute.Value.Background); } } @@ -1468,7 +1468,7 @@ public class LineCanvasTests (ITestOutputHelper output) : FakeDriverBase foreach (Cell? cell in cellMap.Values) { Assert.NotNull (cell); - Assert.Equal (foregroundColor, cell.Value.Attribute.Value.Foreground); + Assert.Equal (foregroundColor, cell.Value.Attribute!.Value.Foreground); Assert.Equal (backgroundColor, cell.Value.Attribute.Value.Background); } } diff --git a/Tests/UnitTestsParallelizable/Drawing/PopularityPaletteWithThresholdTests.cs b/Tests/UnitTestsParallelizable/Drawing/PopularityPaletteWithThresholdTests.cs index 3a8132874..95d772f9d 100644 --- a/Tests/UnitTestsParallelizable/Drawing/PopularityPaletteWithThresholdTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/PopularityPaletteWithThresholdTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class PopularityPaletteWithThresholdTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/Region/DifferenceTests.cs b/Tests/UnitTestsParallelizable/Drawing/Region/DifferenceTests.cs index 683b3adb9..d229190f5 100644 --- a/Tests/UnitTestsParallelizable/Drawing/Region/DifferenceTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/Region/DifferenceTests.cs @@ -1,6 +1,6 @@ using Xunit.Sdk; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class DifferenceTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/Region/DrawOuterBoundaryTests.cs b/Tests/UnitTestsParallelizable/Drawing/Region/DrawOuterBoundaryTests.cs index 43fdb1976..bad986817 100644 --- a/Tests/UnitTestsParallelizable/Drawing/Region/DrawOuterBoundaryTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/Region/DrawOuterBoundaryTests.cs @@ -1,7 +1,7 @@ using System.Collections.Concurrent; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; /// /// Tests for . diff --git a/Tests/UnitTestsParallelizable/Drawing/Region/MergeRectanglesTests.cs b/Tests/UnitTestsParallelizable/Drawing/Region/MergeRectanglesTests.cs index f2bcb695a..b893b029d 100644 --- a/Tests/UnitTestsParallelizable/Drawing/Region/MergeRectanglesTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/Region/MergeRectanglesTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class MergeRectanglesTests diff --git a/Tests/UnitTestsParallelizable/Drawing/Region/RegionTests.cs b/Tests/UnitTestsParallelizable/Drawing/Region/RegionTests.cs index 6827d011c..c51e82a1d 100644 --- a/Tests/UnitTestsParallelizable/Drawing/Region/RegionTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/Region/RegionTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class RegionTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/Region/SubtractRectangleTests.cs b/Tests/UnitTestsParallelizable/Drawing/Region/SubtractRectangleTests.cs index 5568fd3fb..23b9bd5aa 100644 --- a/Tests/UnitTestsParallelizable/Drawing/Region/SubtractRectangleTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/Region/SubtractRectangleTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; using Xunit; diff --git a/Tests/UnitTestsParallelizable/Drawing/RulerTests.cs b/Tests/UnitTestsParallelizable/Drawing/RulerTests.cs index cb059d639..6e305438b 100644 --- a/Tests/UnitTestsParallelizable/Drawing/RulerTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/RulerTests.cs @@ -2,7 +2,7 @@ using Microsoft.VisualStudio.TestPlatform.Utilities; using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; /// /// Pure unit tests for that don't require Application.Driver or View context. @@ -54,7 +54,7 @@ public class RulerTests (ITestOutputHelper output) : FakeDriverBase IDriver driver = CreateFakeDriver (); var r = new Ruler (); - r.Draw (Point.Empty, driver: driver); + r.Draw (driver: driver, location: Point.Empty); DriverAssert.AssertDriverContentsWithFrameAre (@"", output, driver); } @@ -69,7 +69,7 @@ public class RulerTests (ITestOutputHelper output) : FakeDriverBase Assert.Equal (Orientation.Horizontal, r.Orientation); r.Length = len; - r.Draw (Point.Empty, driver: driver); + r.Draw (driver: driver, location: Point.Empty); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -79,7 +79,7 @@ public class RulerTests (ITestOutputHelper output) : FakeDriverBase ); // Postive offset - r.Draw (new (1, 1), driver: driver); + r.Draw (driver: driver, location: new (1, 1)); DriverAssert.AssertDriverContentsAre ( @" @@ -91,7 +91,7 @@ public class RulerTests (ITestOutputHelper output) : FakeDriverBase ); // Negative offset - r.Draw (new (-1, 3), driver: driver); + r.Draw (driver: driver, location: new (-1, 3)); DriverAssert.AssertDriverContentsAre ( @" @@ -114,7 +114,7 @@ public class RulerTests (ITestOutputHelper output) : FakeDriverBase var r = new Ruler (); r.Orientation = Orientation.Vertical; r.Length = len; - r.Draw (Point.Empty, driver: driver); + r.Draw (driver: driver, location: Point.Empty); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -137,7 +137,7 @@ public class RulerTests (ITestOutputHelper output) : FakeDriverBase driver ); - r.Draw (new (1, 1), driver: driver); + r.Draw (driver: driver, location: new (1, 1)); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -162,7 +162,7 @@ public class RulerTests (ITestOutputHelper output) : FakeDriverBase ); // Negative offset - r.Draw (new (2, -1), driver: driver); + r.Draw (driver: driver, location: new (2, -1)); DriverAssert.AssertDriverContentsWithFrameAre ( @" diff --git a/Tests/UnitTestsParallelizable/Drawing/SchemeTests.GetAttributeForRoleAlgorithmTests.cs b/Tests/UnitTestsParallelizable/Drawing/SchemeTests.GetAttributeForRoleAlgorithmTests.cs index ad231702d..48d466fb6 100644 --- a/Tests/UnitTestsParallelizable/Drawing/SchemeTests.GetAttributeForRoleAlgorithmTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/SchemeTests.GetAttributeForRoleAlgorithmTests.cs @@ -1,6 +1,6 @@ using Xunit; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class SchemeGetAttributeForRoleAlgorithmTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/SchemeTests.cs b/Tests/UnitTestsParallelizable/Drawing/SchemeTests.cs index 73cfd3099..f8cf86d37 100644 --- a/Tests/UnitTestsParallelizable/Drawing/SchemeTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/SchemeTests.cs @@ -1,7 +1,7 @@ #nullable enable using System.Reflection; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class SchemeTests { @@ -36,7 +36,7 @@ public class SchemeTests Assert.True (schemes.ContainsKey ("Dialog")); Assert.True (schemes.ContainsKey ("Error")); Assert.True (schemes.ContainsKey ("Menu")); - Assert.True (schemes.ContainsKey ("TopLevel")); + Assert.True (schemes.ContainsKey ("Runnable")); } @@ -66,10 +66,10 @@ public class SchemeTests Assert.NotNull (menuScheme); Assert.Equal (new Attribute (StandardColor.Charcoal, StandardColor.LightBlue, TextStyle.Bold), menuScheme!.Normal); - // Toplevel - var toplevelScheme = schemes ["Toplevel"]; - Assert.NotNull (toplevelScheme); - Assert.Equal (new Attribute (StandardColor.CadetBlue, StandardColor.Charcoal).ToString (), toplevelScheme!.Normal.ToString ()); + // Runnable + var runnableScheme = schemes ["Runnable"]; + Assert.NotNull (runnableScheme); + Assert.Equal (new Attribute (StandardColor.CadetBlue, StandardColor.Charcoal).ToString (), runnableScheme!.Normal.ToString ()); } diff --git a/Tests/UnitTestsParallelizable/Drawing/SixelEncoderTests.cs b/Tests/UnitTestsParallelizable/Drawing/SixelEncoderTests.cs index ab97eed73..3a1ed881a 100644 --- a/Tests/UnitTestsParallelizable/Drawing/SixelEncoderTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/SixelEncoderTests.cs @@ -1,5 +1,5 @@  -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class SixelEncoderTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/SolidFillTests.cs b/Tests/UnitTestsParallelizable/Drawing/SolidFillTests.cs index c335a793f..d1d604141 100644 --- a/Tests/UnitTestsParallelizable/Drawing/SolidFillTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/SolidFillTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class SolidFillTests { diff --git a/Tests/UnitTestsParallelizable/Drawing/StraightLineExtensionsTests.cs b/Tests/UnitTestsParallelizable/Drawing/StraightLineExtensionsTests.cs index 0275e8a23..663a96c31 100644 --- a/Tests/UnitTestsParallelizable/Drawing/StraightLineExtensionsTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/StraightLineExtensionsTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class StraightLineExtensionsTests (ITestOutputHelper output) { diff --git a/Tests/UnitTestsParallelizable/Drawing/StraightLineTests.cs b/Tests/UnitTestsParallelizable/Drawing/StraightLineTests.cs index 7cf11cf4e..b39246e0b 100644 --- a/Tests/UnitTestsParallelizable/Drawing/StraightLineTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/StraightLineTests.cs @@ -1,6 +1,6 @@ using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class StraightLineTests (ITestOutputHelper output) { diff --git a/Tests/UnitTestsParallelizable/Drawing/ThicknessTests.cs b/Tests/UnitTestsParallelizable/Drawing/ThicknessTests.cs index a5cfc0436..c00732549 100644 --- a/Tests/UnitTestsParallelizable/Drawing/ThicknessTests.cs +++ b/Tests/UnitTestsParallelizable/Drawing/ThicknessTests.cs @@ -1,8 +1,9 @@ using System.Text; +using Terminal.Gui.Drivers; using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DrawingTests; +namespace DrawingTests; public class ThicknessTests (ITestOutputHelper output) : FakeDriverBase { @@ -634,7 +635,7 @@ public class ThicknessTests (ITestOutputHelper output) : FakeDriverBase new (0, 0, driver!.Cols, driver!.Rows), (Rune)' ' ); - t.Draw (r, ViewDiagnosticFlags.Thickness, "Test", driver); + t.Draw (driver, r, ViewDiagnosticFlags.Thickness, "Test"); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -650,7 +651,7 @@ public class ThicknessTests (ITestOutputHelper output) : FakeDriverBase new (0, 0, driver!.Cols, driver!.Rows), (Rune)' ' ); - t.Draw (r, ViewDiagnosticFlags.Thickness, "Test", driver); + t.Draw (driver, r, ViewDiagnosticFlags.Thickness, "Test"); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -680,7 +681,7 @@ public class ThicknessTests (ITestOutputHelper output) : FakeDriverBase new (0, 0, driver!.Cols, driver!.Rows), (Rune)' ' ); - t.Draw (r, ViewDiagnosticFlags.Thickness, "Test", driver); + t.Draw (driver, r, ViewDiagnosticFlags.Thickness, "Test"); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -710,7 +711,7 @@ public class ThicknessTests (ITestOutputHelper output) : FakeDriverBase new (0, 0, driver!.Cols, driver!.Rows), (Rune)' ' ); - t.Draw (r, ViewDiagnosticFlags.Thickness, "Test", driver); + t.Draw (driver, r, ViewDiagnosticFlags.Thickness, "Test"); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -744,7 +745,7 @@ public class ThicknessTests (ITestOutputHelper output) : FakeDriverBase f.Driver = driver; driver.SetScreenSize (45, 20); - var top = new Toplevel () { Width = driver.Cols, Height = driver.Rows }; + var top = new Runnable () { Width = driver.Cols, Height = driver.Rows }; top.Driver = driver; top.Add (f); @@ -754,7 +755,8 @@ public class ThicknessTests (ITestOutputHelper output) : FakeDriverBase var r = new Rectangle (2, 2, 40, 15); top.Draw (); - t.Draw (r, ViewDiagnosticFlags.Ruler, "Test", driver); + top.SetClipToScreen (); + t.Draw (driver, r, ViewDiagnosticFlags.Ruler, "Test"); DriverAssert.AssertDriverContentsAre ( @" @@ -786,7 +788,8 @@ public class ThicknessTests (ITestOutputHelper output) : FakeDriverBase r = new (1, 1, 40, 15); top.SetNeedsDraw (); top.Draw (); - t.Draw (r, ViewDiagnosticFlags.Ruler, "Test", driver); + top.SetClipToScreen (); + t.Draw (driver, r, ViewDiagnosticFlags.Ruler, "Test"); DriverAssert.AssertDriverContentsAre ( @" @@ -818,7 +821,8 @@ public class ThicknessTests (ITestOutputHelper output) : FakeDriverBase r = new (2, 2, 40, 15); top.SetNeedsDraw (); top.Draw (); - t.Draw (r, ViewDiagnosticFlags.Ruler, "Test", driver); + top.SetClipToScreen (); + t.Draw (driver, r, ViewDiagnosticFlags.Ruler, "Test"); DriverAssert.AssertDriverContentsWithFrameAre ( @" @@ -850,7 +854,8 @@ public class ThicknessTests (ITestOutputHelper output) : FakeDriverBase r = new (5, 5, 40, 15); top.SetNeedsDraw (); top.Draw (); - t.Draw (r, ViewDiagnosticFlags.Ruler, "Test", driver); + top.SetClipToScreen (); + t.Draw (driver, r, ViewDiagnosticFlags.Ruler, "Test"); DriverAssert.AssertDriverContentsWithFrameAre ( @" diff --git a/Tests/UnitTestsParallelizable/Drivers/AddRuneTests.cs b/Tests/UnitTestsParallelizable/Drivers/AddRuneTests.cs index 2dd2fb769..f0596fc83 100644 --- a/Tests/UnitTestsParallelizable/Drivers/AddRuneTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/AddRuneTests.cs @@ -5,7 +5,7 @@ using Xunit.Abstractions; // Alias Console to MockConsole so we don't accidentally use Console -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class AddRuneTests (ITestOutputHelper output) : FakeDriverBase { @@ -19,7 +19,7 @@ public class AddRuneTests (ITestOutputHelper output) : FakeDriverBase driver.Rows = 25; driver.Cols = 80; driver.AddRune (new Rune ('a')); - Assert.Equal ((Rune)'a', driver.Contents [0, 0].Rune); + Assert.Equal ("a", driver.Contents? [0, 0].Grapheme); driver.End (); } @@ -29,28 +29,30 @@ public class AddRuneTests (ITestOutputHelper output) : FakeDriverBase { IDriver driver = CreateFakeDriver (); - var expected = new Rune ('ắ'); + var expected = "ắ"; var text = "\u1eaf"; driver.AddStr (text); - Assert.Equal (expected, driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); + Assert.Equal (expected, driver.Contents! [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); driver.ClearContents (); driver.Move (0, 0); + expected = "ắ"; text = "\u0103\u0301"; driver.AddStr (text); - Assert.Equal (expected, driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); + Assert.Equal (expected, driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); driver.ClearContents (); driver.Move (0, 0); + expected = "ắ"; text = "\u0061\u0306\u0301"; driver.AddStr (text); - Assert.Equal (expected, driver.Contents [0, 0].Rune); - Assert.Equal ((Rune)' ', driver.Contents [0, 1].Rune); + Assert.Equal (expected, driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [0, 1].Grapheme); // var s = "a\u0301\u0300\u0306"; @@ -86,7 +88,7 @@ public class AddRuneTests (ITestOutputHelper output) : FakeDriverBase { for (var row = 0; row < driver.Rows; row++) { - Assert.Equal ((Rune)' ', driver.Contents [row, col].Rune); + Assert.Equal (" ", driver.Contents? [row, col].Grapheme); } } @@ -99,12 +101,12 @@ public class AddRuneTests (ITestOutputHelper output) : FakeDriverBase IDriver driver = CreateFakeDriver (); driver.AddRune ('a'); - Assert.Equal ((Rune)'a', driver.Contents [0, 0].Rune); + Assert.Equal ("a", driver.Contents? [0, 0].Grapheme); Assert.Equal (0, driver.Row); Assert.Equal (1, driver.Col); driver.AddRune ('b'); - Assert.Equal ((Rune)'b', driver.Contents [0, 1].Rune); + Assert.Equal ("b", driver.Contents? [0, 1].Grapheme); Assert.Equal (0, driver.Row); Assert.Equal (2, driver.Col); @@ -116,7 +118,7 @@ public class AddRuneTests (ITestOutputHelper output) : FakeDriverBase // Add a rune to the last column of the first row; should increment the row or col even though it's now invalid driver.AddRune ('c'); - Assert.Equal ((Rune)'c', driver.Contents [0, lastCol].Rune); + Assert.Equal ("c", driver.Contents? [0, lastCol].Grapheme); Assert.Equal (lastCol + 1, driver.Col); // Add a rune; should succeed but do nothing as it's outside of Contents @@ -127,7 +129,7 @@ public class AddRuneTests (ITestOutputHelper output) : FakeDriverBase { for (var row = 0; row < driver.Rows; row++) { - Assert.NotEqual ((Rune)'d', driver.Contents [row, col].Rune); + Assert.NotEqual ("d", driver.Contents? [row, col].Grapheme); } } @@ -146,12 +148,12 @@ public class AddRuneTests (ITestOutputHelper output) : FakeDriverBase Assert.Equal (2, rune.GetColumns ()); driver.AddRune (rune); - Assert.Equal (rune, driver.Contents [0, 0].Rune); + Assert.Equal (rune.ToString (), driver.Contents? [0, 0].Grapheme); Assert.Equal (0, driver.Row); Assert.Equal (2, driver.Col); //driver.AddRune ('b'); - //Assert.Equal ((Rune)'b', driver.Contents [0, 1].Rune); + //Assert.Equal ((Text)'b', driver.Contents [0, 1].Text); //Assert.Equal (0, driver.Row); //Assert.Equal (2, driver.Col); @@ -163,7 +165,7 @@ public class AddRuneTests (ITestOutputHelper output) : FakeDriverBase //// Add a rune to the last column of the first row; should increment the row or col even though it's now invalid //driver.AddRune ('c'); - //Assert.Equal ((Rune)'c', driver.Contents [0, lastCol].Rune); + //Assert.Equal ((Text)'c', driver.Contents [0, lastCol].Text); //Assert.Equal (lastCol + 1, driver.Col); //// Add a rune; should succeed but do nothing as it's outside of Contents @@ -171,7 +173,7 @@ public class AddRuneTests (ITestOutputHelper output) : FakeDriverBase //Assert.Equal (lastCol + 2, driver.Col); //for (var col = 0; col < driver.Cols; col++) { // for (var row = 0; row < driver.Rows; row++) { - // Assert.NotEqual ((Rune)'d', driver.Contents [row, col].Rune); + // Assert.NotEqual ((Text)'d', driver.Contents [row, col].Text); // } //} diff --git a/Tests/UnitTestsParallelizable/Drivers/AnsiKeyboardParserTests.cs b/Tests/UnitTestsParallelizable/Drivers/AnsiKeyboardParserTests.cs index e1f8e93a8..ab8e3de3d 100644 --- a/Tests/UnitTestsParallelizable/Drivers/AnsiKeyboardParserTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/AnsiKeyboardParserTests.cs @@ -1,5 +1,5 @@ #nullable enable -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class AnsiKeyboardParserTests { diff --git a/Tests/UnitTestsParallelizable/Drivers/AnsiMouseParserTests.cs b/Tests/UnitTestsParallelizable/Drivers/AnsiMouseParserTests.cs index 38c42ec9f..621396098 100644 --- a/Tests/UnitTestsParallelizable/Drivers/AnsiMouseParserTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/AnsiMouseParserTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class AnsiMouseParserTests { @@ -23,7 +23,7 @@ public class AnsiMouseParserTests public void ProcessMouseInput_ReturnsCorrectFlags (string input, int expectedX, int expectedY, MouseFlags expectedFlags) { // Act - MouseEventArgs result = _parser.ProcessMouseInput (input); + MouseEventArgs? result = _parser.ProcessMouseInput (input); // Assert if (expectedFlags == MouseFlags.None) diff --git a/Tests/UnitTestsParallelizable/Drivers/AnsiRequestSchedulerTests.cs b/Tests/UnitTestsParallelizable/Drivers/AnsiRequestSchedulerTests.cs index d643c5112..f5ce41d7b 100644 --- a/Tests/UnitTestsParallelizable/Drivers/AnsiRequestSchedulerTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/AnsiRequestSchedulerTests.cs @@ -1,6 +1,6 @@ using Moq; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class AnsiRequestSchedulerTests { @@ -31,10 +31,10 @@ public class AnsiRequestSchedulerTests _parserMock.Setup (p => p.IsExpecting ("c")).Returns (false).Verifiable (Times.Once); // then we should execute our request - _parserMock.Setup (p => p.ExpectResponse ("c", It.IsAny> (), null, false)).Verifiable (Times.Once); + _parserMock.Setup (p => p.ExpectResponse ("c", It.IsAny> ()!, null, false)).Verifiable (Times.Once); // Act - bool result = _scheduler.SendOrSchedule (request); + bool result = _scheduler.SendOrSchedule (null, request); // Assert Assert.Empty (_scheduler.QueuedRequests); // We sent it i.e. we did not queue it for later @@ -57,7 +57,7 @@ public class AnsiRequestSchedulerTests _parserMock.Setup (p => p.IsExpecting ("c")).Returns (true).Verifiable (Times.Once); // Act - bool result = _scheduler.SendOrSchedule (request1); + bool result = _scheduler.SendOrSchedule (null, request1); // Assert Assert.Single (_scheduler.QueuedRequests); // Ensure only one request is in the queue @@ -78,9 +78,9 @@ public class AnsiRequestSchedulerTests // Set up to expect no outstanding request for "c" i.e. parser instantly gets response and resolves it _parserMock.Setup (p => p.IsExpecting ("c")).Returns (false).Verifiable (Times.Exactly (2)); - _parserMock.Setup (p => p.ExpectResponse ("c", It.IsAny> (), null, false)).Verifiable (Times.Exactly (2)); + _parserMock.Setup (p => p.ExpectResponse ("c", It.IsAny> ()!, null, false)).Verifiable (Times.Exactly (2)); - _scheduler.SendOrSchedule (request); + _scheduler.SendOrSchedule (null, request); // Simulate time passing beyond throttle SetTime (101); // Exceed throttle limit @@ -88,7 +88,7 @@ public class AnsiRequestSchedulerTests // Act // Send another request after the throttled time limit - bool result = _scheduler.SendOrSchedule (request); + bool result = _scheduler.SendOrSchedule (null, request); // Assert Assert.Empty (_scheduler.QueuedRequests); // Should send and clear the request @@ -109,9 +109,9 @@ public class AnsiRequestSchedulerTests // Set up to expect no outstanding request for "c" i.e. parser instantly gets response and resolves it _parserMock.Setup (p => p.IsExpecting ("c")).Returns (false).Verifiable (Times.Exactly (2)); - _parserMock.Setup (p => p.ExpectResponse ("c", It.IsAny> (), null, false)).Verifiable (Times.Exactly (2)); + _parserMock.Setup (p => p.ExpectResponse ("c", It.IsAny> ()!, null, false)).Verifiable (Times.Exactly (2)); - _scheduler.SendOrSchedule (request); + _scheduler.SendOrSchedule (null, request); // Simulate time passing SetTime (55); // Does not exceed throttle limit @@ -119,24 +119,24 @@ public class AnsiRequestSchedulerTests // Act // Send another request after the throttled time limit - bool result = _scheduler.SendOrSchedule (request); + bool result = _scheduler.SendOrSchedule (null, request); // Assert Assert.Single (_scheduler.QueuedRequests); // Should have been queued Assert.False (result); // Should have been queued // Throttle still not exceeded - Assert.False (_scheduler.RunSchedule ()); + Assert.False (_scheduler.RunSchedule (null)); SetTime (90); // Throttle still not exceeded - Assert.False (_scheduler.RunSchedule ()); + Assert.False (_scheduler.RunSchedule (null)); SetTime (105); // Throttle exceeded - so send the request - Assert.True (_scheduler.RunSchedule ()); + Assert.True (_scheduler.RunSchedule (null)); _parserMock.Verify (); } @@ -154,15 +154,15 @@ public class AnsiRequestSchedulerTests // Send _parserMock.Setup (p => p.IsExpecting ("c")).Returns (false).Verifiable (Times.Once); - _parserMock.Setup (p => p.ExpectResponse ("c", It.IsAny> (), null, false)).Verifiable (Times.Exactly (2)); + _parserMock.Setup (p => p.ExpectResponse ("c", It.IsAny> ()!, null, false)).Verifiable (Times.Exactly (2)); - Assert.True (_scheduler.SendOrSchedule (request1)); + Assert.True (_scheduler.SendOrSchedule (null, request1)); // Parser already has an ongoing request for "c" _parserMock.Setup (p => p.IsExpecting ("c")).Returns (true).Verifiable (Times.Exactly (2)); // Cannot send because there is already outstanding request - Assert.False (_scheduler.SendOrSchedule (request1)); + Assert.False (_scheduler.SendOrSchedule (null, request1)); Assert.Single (_scheduler.QueuedRequests); // Simulate request going stale @@ -178,7 +178,7 @@ public class AnsiRequestSchedulerTests .Verifiable (); // When we send again the evicted one should be - bool evicted = _scheduler.RunSchedule (); + bool evicted = _scheduler.RunSchedule (null); Assert.True (evicted); // Stale request should be evicted Assert.Empty (_scheduler.QueuedRequests); @@ -191,7 +191,7 @@ public class AnsiRequestSchedulerTests public void RunSchedule_DoesNothing_WhenQueueIsEmpty () { // Act - bool result = _scheduler.RunSchedule (); + bool result = _scheduler.RunSchedule (null); // Assert Assert.False (result); // No requests to process @@ -210,11 +210,11 @@ public class AnsiRequestSchedulerTests // 'x' is free _parserMock.Setup (p => p.IsExpecting ("x")).Returns (false).Verifiable (Times.Once); - _parserMock.Setup (p => p.ExpectResponse ("x", It.IsAny> (), null, false)).Verifiable (Times.Once); + _parserMock.Setup (p => p.ExpectResponse ("x", It.IsAny> ()!, null, false)).Verifiable (Times.Once); // Act - bool a = _scheduler.SendOrSchedule (request1); - bool b = _scheduler.SendOrSchedule (request2); + bool a = _scheduler.SendOrSchedule (null, request1); + bool b = _scheduler.SendOrSchedule (null, request2); // Assert Assert.False (a); diff --git a/Tests/UnitTestsParallelizable/Drivers/AnsiResponseParserTests.cs b/Tests/UnitTestsParallelizable/Drivers/AnsiResponseParserTests.cs index 506edf93a..ebe92cbe4 100644 --- a/Tests/UnitTestsParallelizable/Drivers/AnsiResponseParserTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/AnsiResponseParserTests.cs @@ -3,7 +3,7 @@ using System.Diagnostics; using System.Text; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; // BUGBUG: These tests use TInputRecord of `int`, but that's not a realistic type for keyboard input. public class AnsiResponseParserTests (ITestOutputHelper output) diff --git a/Tests/UnitTestsParallelizable/Drivers/ClipRegionTests.cs b/Tests/UnitTestsParallelizable/Drivers/ClipRegionTests.cs new file mode 100644 index 000000000..a8a2a5531 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Drivers/ClipRegionTests.cs @@ -0,0 +1,98 @@ +#nullable enable +using UnitTests; +using Xunit.Abstractions; + +namespace DriverTests; + +public class ClipRegionTests (ITestOutputHelper output) : FakeDriverBase +{ + private readonly ITestOutputHelper _output = output; + + [Fact] + public void AddRune_Is_Clipped () + { + IDriver? driver = CreateFakeDriver (); + + driver.Move (0, 0); + driver.AddRune ('x'); + Assert.Equal ("x", driver.Contents! [0, 0].Grapheme); + + driver.Move (5, 5); + driver.AddRune ('x'); + Assert.Equal ("x", driver.Contents [5, 5].Grapheme); + + // Clear the contents + driver.FillRect (new Rectangle (0, 0, driver.Rows, driver.Cols), ' '); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + + // Setup the region with a single rectangle, fill screen with 'x' + driver.Clip = new (new Rectangle (5, 5, 5, 5)); + driver.FillRect (new Rectangle (0, 0, driver.Rows, driver.Cols), 'x'); + Assert.Equal (" ", driver.Contents [0, 0].Grapheme); + Assert.Equal (" ", driver.Contents [4, 9].Grapheme); + Assert.Equal ("x", driver.Contents [5, 5].Grapheme); + Assert.Equal ("x", driver.Contents [9, 9].Grapheme); + Assert.Equal (" ", driver.Contents [10, 10].Grapheme); + } + + [Fact] + public void Clip_Set_To_Empty_AllInvalid () + { + IDriver? driver = CreateFakeDriver (); + + // Define a clip rectangle + driver.Clip = new (Rectangle.Empty); + + // negative + Assert.False (driver.IsValidLocation (null!, 4, 5)); + Assert.False (driver.IsValidLocation (null!, 5, 4)); + Assert.False (driver.IsValidLocation (null!, 10, 9)); + Assert.False (driver.IsValidLocation (null!, 9, 10)); + Assert.False (driver.IsValidLocation (null!, -1, 0)); + Assert.False (driver.IsValidLocation (null!, 0, -1)); + Assert.False (driver.IsValidLocation (null!, -1, -1)); + Assert.False (driver.IsValidLocation (null!, driver.Cols, driver.Rows - 1)); + Assert.False (driver.IsValidLocation (null!, driver.Cols, driver.Rows - 1)); + Assert.False (driver.IsValidLocation (null!, driver.Cols, driver.Rows)); + } + + [Fact] + public void IsValidLocation () + { + IDriver? driver = CreateFakeDriver (); + driver.Rows = 10; + driver.Cols = 10; + + // positive + Assert.True (driver.IsValidLocation (null!, 0, 0)); + Assert.True (driver.IsValidLocation (null!, 1, 1)); + Assert.True (driver.IsValidLocation (null!, driver.Cols - 1, driver.Rows - 1)); + + // negative + Assert.False (driver.IsValidLocation (null!, -1, 0)); + Assert.False (driver.IsValidLocation (null!, 0, -1)); + Assert.False (driver.IsValidLocation (null!, -1, -1)); + Assert.False (driver.IsValidLocation (null!, driver.Cols, driver.Rows - 1)); + Assert.False (driver.IsValidLocation (null!, driver.Cols, driver.Rows - 1)); + Assert.False (driver.IsValidLocation (null!, driver.Cols, driver.Rows)); + + // Define a clip rectangle + driver.Clip = new (new Rectangle (5, 5, 5, 5)); + + // positive + Assert.True (driver.IsValidLocation (null!, 5, 5)); + Assert.True (driver.IsValidLocation (null!, 9, 9)); + + // negative + Assert.False (driver.IsValidLocation (null!, 4, 5)); + Assert.False (driver.IsValidLocation (null!, 5, 4)); + Assert.False (driver.IsValidLocation (null!, 10, 9)); + Assert.False (driver.IsValidLocation (null!, 9, 10)); + Assert.False (driver.IsValidLocation (null!, -1, 0)); + Assert.False (driver.IsValidLocation (null!, 0, -1)); + Assert.False (driver.IsValidLocation (null!, -1, -1)); + Assert.False (driver.IsValidLocation (null!, driver.Cols, driver.Rows - 1)); + Assert.False (driver.IsValidLocation (null!, driver.Cols, driver.Rows - 1)); + Assert.False (driver.IsValidLocation (null!, driver.Cols, driver.Rows)); + } +} diff --git a/Tests/UnitTestsParallelizable/Drivers/ConsoleKeyMappingTests.cs b/Tests/UnitTestsParallelizable/Drivers/ConsoleKeyMappingTests.cs index 3f16aea96..850c4fa02 100644 --- a/Tests/UnitTestsParallelizable/Drivers/ConsoleKeyMappingTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/ConsoleKeyMappingTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class ConsoleKeyMappingTests { diff --git a/Tests/UnitTestsParallelizable/Drivers/ContentsTests.cs b/Tests/UnitTestsParallelizable/Drivers/ContentsTests.cs index ceaccc042..917f36f4f 100644 --- a/Tests/UnitTestsParallelizable/Drivers/ContentsTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/ContentsTests.cs @@ -4,7 +4,7 @@ using Xunit.Abstractions; // Alias Console to MockConsole so we don't accidentally use Console -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class ContentsTests (ITestOutputHelper output) : FakeDriverBase { @@ -36,7 +36,7 @@ public class ContentsTests (ITestOutputHelper output) : FakeDriverBase // a + ogonek + acute = ( ą́ ) var oGonek = new Rune (0x0328); // Combining ogonek (a small hook or comma shape) combined = "a" + oGonek + acuteAccent; - expected = ("a" + oGonek).Normalize (NormalizationForm.FormC); // See Issue #2616 + expected = ("a" + oGonek + acuteAccent).Normalize (NormalizationForm.FormC); // See Issue #2616 driver.Move (0, 0); driver.AddStr (combined); @@ -44,7 +44,7 @@ public class ContentsTests (ITestOutputHelper output) : FakeDriverBase // e + ogonek + acute = ( ę́́ ) combined = "e" + oGonek + acuteAccent; - expected = ("e" + oGonek).Normalize (NormalizationForm.FormC); // See Issue #2616 + expected = ("e" + oGonek + acuteAccent).Normalize (NormalizationForm.FormC); // See Issue #2616 driver.Move (0, 0); driver.AddStr (combined); @@ -52,7 +52,7 @@ public class ContentsTests (ITestOutputHelper output) : FakeDriverBase // i + ogonek + acute = ( į́́́ ) combined = "i" + oGonek + acuteAccent; - expected = ("i" + oGonek).Normalize (NormalizationForm.FormC); // See Issue #2616 + expected = ("i" + oGonek + acuteAccent).Normalize (NormalizationForm.FormC); // See Issue #2616 driver.Move (0, 0); driver.AddStr (combined); @@ -60,7 +60,7 @@ public class ContentsTests (ITestOutputHelper output) : FakeDriverBase // u + ogonek + acute = ( ų́́́́ ) combined = "u" + oGonek + acuteAccent; - expected = ("u" + oGonek).Normalize (NormalizationForm.FormC); // See Issue #2616 + expected = ("u" + oGonek + acuteAccent).Normalize (NormalizationForm.FormC); // See Issue #2616 driver.Move (0, 0); driver.AddStr (combined); diff --git a/Tests/UnitTestsParallelizable/Drivers/NetInputProcessorTests.cs b/Tests/UnitTestsParallelizable/Drivers/Dotnet/NetInputProcessorTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/Drivers/NetInputProcessorTests.cs rename to Tests/UnitTestsParallelizable/Drivers/Dotnet/NetInputProcessorTests.cs index c9ff9584f..fbee752fb 100644 --- a/Tests/UnitTestsParallelizable/Drivers/NetInputProcessorTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/Dotnet/NetInputProcessorTests.cs @@ -1,7 +1,7 @@ using System.Collections.Concurrent; using System.Text; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class NetInputProcessorTests { diff --git a/Tests/UnitTestsParallelizable/Drivers/DriverColorTests.cs b/Tests/UnitTestsParallelizable/Drivers/DriverColorTests.cs index 29b5ecb19..83d133a93 100644 --- a/Tests/UnitTestsParallelizable/Drivers/DriverColorTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/DriverColorTests.cs @@ -2,7 +2,7 @@ using UnitTests; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class DriverColorTests : FakeDriverBase { diff --git a/Tests/UnitTestsParallelizable/Drivers/DriverTests.cs b/Tests/UnitTestsParallelizable/Drivers/DriverTests.cs index 9f87d80d0..928dd923b 100644 --- a/Tests/UnitTestsParallelizable/Drivers/DriverTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/DriverTests.cs @@ -1,6 +1,106 @@ -using UnitTests; +#nullable enable +using UnitTests; +using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; -public class DriverTests : FakeDriverBase -{ } +public class DriverTests (ITestOutputHelper output) : FakeDriverBase +{ + [Theory] + [InlineData ("", true)] + [InlineData ("a", true)] + [InlineData ("👩‍❤️‍💋‍👨", false)] + public void IsValidLocation (string text, bool positive) + { + IDriver driver = CreateFakeDriver (); + driver.SetScreenSize (10, 10); + + // positive + Assert.True (driver.IsValidLocation (text, 0, 0)); + Assert.True (driver.IsValidLocation (text, 1, 1)); + Assert.Equal (positive, driver.IsValidLocation (text, driver.Cols - 1, driver.Rows - 1)); + + // negative + Assert.False (driver.IsValidLocation (text, -1, 0)); + Assert.False (driver.IsValidLocation (text, 0, -1)); + Assert.False (driver.IsValidLocation (text, -1, -1)); + Assert.False (driver.IsValidLocation (text, driver.Cols, driver.Rows - 1)); + Assert.False (driver.IsValidLocation (text, driver.Cols, driver.Rows - 1)); + Assert.False (driver.IsValidLocation (text, driver.Cols, driver.Rows)); + + // Define a clip rectangle + driver.Clip = new (new Rectangle (5, 5, 5, 5)); + + // positive + Assert.True (driver.IsValidLocation (text, 5, 5)); + Assert.Equal (positive, driver.IsValidLocation (text, 9, 9)); + + // negative + Assert.False (driver.IsValidLocation (text, 4, 5)); + Assert.False (driver.IsValidLocation (text, 5, 4)); + Assert.False (driver.IsValidLocation (text, 10, 9)); + Assert.False (driver.IsValidLocation (text, 9, 10)); + Assert.False (driver.IsValidLocation (text, -1, 0)); + Assert.False (driver.IsValidLocation (text, 0, -1)); + Assert.False (driver.IsValidLocation (text, -1, -1)); + Assert.False (driver.IsValidLocation (text, driver.Cols, driver.Rows - 1)); + Assert.False (driver.IsValidLocation (text, driver.Cols, driver.Rows - 1)); + Assert.False (driver.IsValidLocation (text, driver.Cols, driver.Rows)); + + driver.End (); + } + + [Theory] + [InlineData ("fake")] + [InlineData ("windows")] + [InlineData ("dotnet")] + [InlineData ("unix")] + public void All_Drivers_Init_Dispose_Cross_Platform (string driverName) + { + IApplication? app = Application.Create (); + app.Init (driverName); + app.Dispose (); + } + + [Theory] + [InlineData ("fake")] + [InlineData ("windows")] + [InlineData ("dotnet")] + [InlineData ("unix")] + public void All_Drivers_Run_Cross_Platform (string driverName) + { + IApplication? app = Application.Create (); + app.Init (driverName); + app.StopAfterFirstIteration = true; + app.Run> (); + app.Dispose (); + } + + [Theory] + [InlineData ("fake")] + [InlineData ("windows")] + [InlineData ("dotnet")] + [InlineData ("unix")] + public void All_Drivers_LayoutAndDraw_Cross_Platform (string driverName) + { + IApplication? app = Application.Create (); + app.Init (driverName); + app.StopAfterFirstIteration = true; + app.Run (); + + DriverAssert.AssertDriverContentsWithFrameAre (driverName!, output, app.Driver); + + app.Dispose (); + } +} + +public class TestTop : Runnable +{ + /// + public override void BeginInit () + { + Text = Driver!.GetName ()!; + BorderStyle = LineStyle.None; + base.BeginInit (); + } +} diff --git a/Tests/UnitTestsParallelizable/Drivers/EscSeqRequestsTests.cs b/Tests/UnitTestsParallelizable/Drivers/EscSeqRequestsTests.cs index f0c4990c1..077860c3d 100644 --- a/Tests/UnitTestsParallelizable/Drivers/EscSeqRequestsTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/EscSeqRequestsTests.cs @@ -1,6 +1,6 @@ using UnitTests; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class EscSeqRequestsTests : FakeDriverBase { @@ -82,7 +82,7 @@ public class EscSeqRequestsTests : FakeDriverBase [Theory] [InlineData (null)] [InlineData ("")] - public void Add_Null_Or_Empty_Terminator_Throws (string terminator) + public void Add_Null_Or_Empty_Terminator_Throws (string? terminator) { if (terminator is null) { @@ -95,7 +95,6 @@ public class EscSeqRequestsTests : FakeDriverBase } [Theory] - [InlineData (null)] [InlineData ("")] public void HasResponse_Null_Or_Empty_Terminator_Does_Not_Throws (string terminator) { @@ -107,20 +106,12 @@ public class EscSeqRequestsTests : FakeDriverBase } [Theory] - [InlineData (null)] [InlineData ("")] public void Remove_Null_Or_Empty_Terminator_Throws (string terminator) { EscSeqRequests.Add ("t"); - if (terminator is null) - { - Assert.Throws (() => EscSeqRequests.Remove (terminator)); - } - else - { - Assert.Throws (() => EscSeqRequests.Remove (terminator)); - } + Assert.Throws (() => EscSeqRequests.Remove (terminator)); EscSeqRequests.Clear (); } diff --git a/Tests/UnitTestsParallelizable/Drivers/EscSeqUtilsTests.cs b/Tests/UnitTestsParallelizable/Drivers/EscSeqUtilsTests.cs index 99537e799..cc3305c3e 100644 --- a/Tests/UnitTestsParallelizable/Drivers/EscSeqUtilsTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/EscSeqUtilsTests.cs @@ -2,7 +2,7 @@ // ReSharper disable HeuristicUnreachableCode -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class EscSeqUtilsTests { diff --git a/Tests/UnitTestsParallelizable/Drivers/FakeDriverTests.cs b/Tests/UnitTestsParallelizable/Drivers/FakeDriverTests.cs index 251a26344..bb9d6b52e 100644 --- a/Tests/UnitTestsParallelizable/Drivers/FakeDriverTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/FakeDriverTests.cs @@ -2,7 +2,7 @@ using System.Text; using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; /// /// Tests for the FakeDriver to ensure it works properly with the modern component factory architecture. @@ -49,7 +49,7 @@ public class FakeDriverTests (ITestOutputHelper output) : FakeDriverBase driver?.SetScreenSize (100, 30); // Verify new size - Assert.Equal (100, driver.Cols); + Assert.Equal (100, driver!.Cols); Assert.Equal (30, driver.Rows); Assert.Equal (new (0, 0, 100, 30), driver.Screen); } @@ -155,7 +155,7 @@ public class FakeDriverTests (ITestOutputHelper output) : FakeDriverBase { for (int col = rect.X; col < rect.X + rect.Width; col++) { - Assert.Equal ((Rune)'X', driver.Contents [row, col].Rune); + Assert.Equal ("X", driver.Contents [row, col].Grapheme); } } } @@ -177,7 +177,7 @@ public class FakeDriverTests (ITestOutputHelper output) : FakeDriverBase driver?.SetScreenSize (100, 30); // Verify new size - Assert.Equal (100, driver.Cols); + Assert.Equal (100, driver!.Cols); Assert.Equal (30, driver.Rows); // Verify buffer is clean (no stale runes from previous size) @@ -192,7 +192,7 @@ public class FakeDriverTests (ITestOutputHelper output) : FakeDriverBase driver?.SetScreenSize (80, 25); // Verify size is back - Assert.Equal (80, driver.Cols); + Assert.Equal (80, driver!.Cols); Assert.Equal (25, driver.Rows); // Verify buffer dimensions match @@ -254,7 +254,7 @@ public class FakeDriverTests (ITestOutputHelper output) : FakeDriverBase Assert.Equal (40, eventSize.Value.Height); // Verify driver.Screen was updated - Assert.Equal (new (0, 0, 120, 40), driver.Screen); + Assert.Equal (new (0, 0, 120, 40), driver!.Screen); Assert.Equal (120, driver.Cols); Assert.Equal (40, driver.Rows); } @@ -266,20 +266,13 @@ public class FakeDriverTests (ITestOutputHelper output) : FakeDriverBase IDriver driver = CreateFakeDriver (); var sizeChangedFired = false; - var screenChangedFired = false; -#pragma warning disable CS0618 // Type or member is obsolete driver.SizeChanged += (sender, args) => { sizeChangedFired = true; }; -#pragma warning restore CS0618 // Type or member is obsolete - - driver.SizeChanged += (sender, args) => { screenChangedFired = true; }; // Trigger resize using FakeResize driver?.SetScreenSize (90, 35); - // Both events should fire for compatibility Assert.True (sizeChangedFired); - Assert.True (screenChangedFired); } #endregion diff --git a/Tests/UnitTestsParallelizable/Drivers/KeyCodeTests.cs b/Tests/UnitTestsParallelizable/Drivers/KeyCodeTests.cs index 1dd14e9c1..0a84b1236 100644 --- a/Tests/UnitTestsParallelizable/Drivers/KeyCodeTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/KeyCodeTests.cs @@ -1,6 +1,6 @@ using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class KeyCodeTests { diff --git a/Tests/UnitTestsParallelizable/Drivers/LowLevel/IInputOutputTests.cs b/Tests/UnitTestsParallelizable/Drivers/LowLevel/IInputOutputTests.cs index 231786279..1ad380981 100644 --- a/Tests/UnitTestsParallelizable/Drivers/LowLevel/IInputOutputTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/LowLevel/IInputOutputTests.cs @@ -3,7 +3,7 @@ using System.Collections.Concurrent; using Xunit.Abstractions; using Xunit.Sdk; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; /// /// Low-level tests for IInput and IOutput implementations across all drivers. diff --git a/Tests/UnitTestsParallelizable/Drivers/MouseInterpreterTests.cs b/Tests/UnitTestsParallelizable/Drivers/MouseInterpreterTests.cs index 71f92d10b..022c44f4d 100644 --- a/Tests/UnitTestsParallelizable/Drivers/MouseInterpreterTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/MouseInterpreterTests.cs @@ -1,4 +1,5 @@ -namespace UnitTests_Parallelizable.DriverTests; +#nullable disable +namespace DriverTests; public class MouseInterpreterTests { diff --git a/Tests/UnitTestsParallelizable/Drivers/ToAnsiTests.cs b/Tests/UnitTestsParallelizable/Drivers/ToAnsiTests.cs new file mode 100644 index 000000000..7db07eeca --- /dev/null +++ b/Tests/UnitTestsParallelizable/Drivers/ToAnsiTests.cs @@ -0,0 +1,377 @@ +using System.Text; +using UnitTests; +using Xunit.Abstractions; + +namespace DriverTests; + +/// +/// Tests for the ToAnsi functionality that generates ANSI escape sequences from buffer contents. +/// +public class ToAnsiTests : FakeDriverBase +{ + [Fact] + public void ToAnsi_Empty_Buffer () + { + IDriver driver = CreateFakeDriver (10, 5); + string ansi = driver.ToAnsi (); + + // Empty buffer should have newlines for each row + Assert.Contains ("\n", ansi); + // Should have 5 newlines (one per row) + Assert.Equal (5, ansi.Count (c => c == '\n')); + } + + [Fact] + public void ToAnsi_Simple_Text () + { + IDriver driver = CreateFakeDriver (10, 3); + driver.AddStr ("Hello"); + driver.Move (0, 1); + driver.AddStr ("World"); + + string ansi = driver.ToAnsi (); + + // Should contain the text + Assert.Contains ("Hello", ansi); + Assert.Contains ("World", ansi); + + // Should have proper structure with newlines + string[] lines = ansi.Split (['\r', '\n'], StringSplitOptions.RemoveEmptyEntries); + Assert.Equal (3, lines.Length); + } + + [Theory] + [InlineData (true, "\u001b[31m", "\u001b[34m")] + [InlineData (false, "\u001b[38;2;255;0;0m", "\u001b[38;2;0;0;255")] + public void ToAnsi_With_Colors (bool force16Colors, string expectedRed, string expectedBue) + { + IDriver driver = CreateFakeDriver (10, 2); + driver.Force16Colors = force16Colors; + + // Set red foreground + driver.CurrentAttribute = new Attribute (Color.Red, Color.Black); + driver.AddStr ("Red"); + driver.Move (0, 1); + + // Set blue foreground + driver.CurrentAttribute = new Attribute (Color.Blue, Color.Black); + driver.AddStr ("Blue"); + + string ansi = driver.ToAnsi (); + + Assert.True (driver.Force16Colors == force16Colors); + // Should contain ANSI color codes + Assert.Contains (expectedRed, ansi); // Red foreground + Assert.Contains (expectedBue, ansi); // Blue foreground + Assert.Contains ("Red", ansi); + Assert.Contains ("Blue", ansi); + } + + [Theory (Skip = "Uses Application.")] + [InlineData (false, "\u001b[48;2;")] + [InlineData (true, "\u001b[41m")] + public void ToAnsi_With_Background_Colors (bool force16Colors, string expected) + { + IDriver driver = CreateFakeDriver (10, 2); + Application.Force16Colors = force16Colors; + + // Set background color + driver.CurrentAttribute = new (Color.White, Color.Red); + driver.AddStr ("WhiteOnRed"); + + string ansi = driver.ToAnsi (); + + /* + The ANSI escape sequence for red background (8-color) is ESC[41m where ESC is \x1b (or \u001b). + Examples: + C# string: "\u001b[41m" or "\x1b[41m" + Reset (clear attributes): "\u001b[0m" + Notes: + Bright/red background (16-color bright variant) uses ESC[101m ("\u001b[101m"). + For 24-bit RGB background use ESC[48;2;;;m, e.g. "\u001b[48;2;255;0;0m" for pure red. + */ + + Assert.True (driver.Force16Colors == force16Colors); + + // Should contain ANSI background color code + Assert.Contains (expected, ansi); // Red background + Assert.Contains ("WhiteOnRed", ansi); + } + + [Fact] + public void ToAnsi_With_Text_Styles () + { + IDriver driver = CreateFakeDriver (10, 3); + + // Bold text + driver.CurrentAttribute = new Attribute (Color.White, Color.Black, TextStyle.Bold); + driver.AddStr ("Bold"); + driver.Move (0, 1); + + // Italic text + driver.CurrentAttribute = new Attribute (Color.White, Color.Black, TextStyle.Italic); + driver.AddStr ("Italic"); + driver.Move (0, 2); + + // Underline text + driver.CurrentAttribute = new Attribute (Color.White, Color.Black, TextStyle.Underline); + driver.AddStr ("Underline"); + + string ansi = driver.ToAnsi (); + + // Should contain ANSI style codes + Assert.Contains ("\u001b[1m", ansi); // Bold + Assert.Contains ("\u001b[3m", ansi); // Italic + Assert.Contains ("\u001b[4m", ansi); // Underline + } + + [Fact] + public void ToAnsi_With_Wide_Characters () + { + IDriver driver = CreateFakeDriver (10, 2); + + // Add a wide character (Chinese character) + driver.AddStr ("??"); + driver.Move (0, 1); + driver.AddStr ("??"); + + string ansi = driver.ToAnsi (); + + Assert.Contains ("??", ansi); + Assert.Contains ("??", ansi); + } + + [Fact] + public void ToAnsi_With_Unicode_Characters () + { + IDriver driver = CreateFakeDriver (10, 2); + + // Add various Unicode characters + driver.AddStr ("???"); // Greek letters + driver.Move (0, 1); + driver.AddStr ("???"); // Emoji + + string ansi = driver.ToAnsi (); + + Assert.Contains ("???", ansi); + Assert.Contains ("???", ansi); + } + + [Theory] + [InlineData (true, "\u001b[31m", "\u001b[34m")] + [InlineData (false, "\u001b[38;2;", "\u001b[48;2;")] + public void ToAnsi_Attribute_Changes_Within_Line (bool force16Colors, string expectedRed, string expectedBlue) + { + IDriver driver = CreateFakeDriver (20, 1); + driver.Force16Colors = force16Colors; + + driver.AddStr ("Normal"); + driver.CurrentAttribute = new Attribute (Color.Red, Color.Black); + driver.AddStr ("Red"); + driver.CurrentAttribute = new Attribute (Color.Blue, Color.Black); + driver.AddStr ("Blue"); + + string ansi = driver.ToAnsi (); + + Assert.True (driver.Force16Colors == force16Colors); + // Should contain color changes within the line + Assert.Contains ("Normal", ansi); + Assert.Contains (expectedRed, ansi); // Red + Assert.Contains (expectedBlue, ansi); // Blue + } + + [Fact] + public void ToAnsi_Large_Buffer () + { + // Test with a larger buffer to stress performance + IDriver driver = CreateFakeDriver (200, 50); + + // Fill with some content + for (int row = 0; row < 50; row++) + { + driver.Move (0, row); + driver.CurrentAttribute = new Attribute ((ColorName16)(row % 16), Color.Black); + driver.AddStr ($"Row {row:D2} content"); + } + + string ansi = driver.ToAnsi (); + + // Should contain all rows + Assert.Contains ("Row 00", ansi); + Assert.Contains ("Row 49", ansi); + + // Should have proper newlines (50 content lines + 50 newlines) + Assert.Equal (50, ansi.Count (c => c == '\n')); + } + + [Fact (Skip = "Use Application.")] + public void ToAnsi_RGB_Colors () + { + IDriver driver = CreateFakeDriver (10, 1); + + // Use RGB colors (when not forcing 16 colors) + Application.Force16Colors = false; + try + { + driver.CurrentAttribute = new Attribute (new Color (255, 0, 0), new Color (0, 255, 0)); + driver.AddStr ("RGB"); + + string ansi = driver.ToAnsi (); + + // Should contain RGB color codes + Assert.Contains ("\u001b[38;2;255;0;0m", ansi); // Red foreground RGB + Assert.Contains ("\u001b[48;2;0;255;0m", ansi); // Green background RGB + } + finally + { + Application.Force16Colors = true; // Reset + } + } + + [Fact (Skip = "Use Application.")] + public void ToAnsi_Force16Colors () + { + IDriver driver = CreateFakeDriver (10, 1); + + // Force 16 colors + Application.Force16Colors = true; + driver.CurrentAttribute = new Attribute (Color.Red, Color.Blue); + driver.AddStr ("16Color"); + + string ansi = driver.ToAnsi (); + + // Should contain 16-color codes, not RGB + Assert.Contains ("\u001b[31m", ansi); // Red foreground (16-color) + Assert.Contains ("\u001b[44m", ansi); // Blue background (16-color) + Assert.DoesNotContain ("\u001b[38;2;", ansi); // No RGB codes + } + + [Theory] + [InlineData (true, "\u001b[31m", "\u001b[32m", "\u001b[34m", "\u001b[33m", "\u001b[35m", "\u001b[36m")] + [InlineData (false, "\u001b[38;2;255;0;0m", "\u001b[38;2;0;128;0m", "\u001b[38;2;0;0;255", "\u001b[38;2;255;255;0m", "\u001b[38;2;255;0;255m", "\u001b[38;2;0;255;255m")] + public void ToAnsi_Multiple_Attributes_Per_Line ( + bool force16Colors, + string expectedRed, + string expectedGreen, + string expectedBlue, + string expectedYellow, + string expectedMagenta, + string expectedCyan + ) + { + IDriver driver = CreateFakeDriver (50, 1); + driver.Force16Colors = force16Colors; + + // Create a line with many attribute changes + string [] colors = { "Red", "Green", "Blue", "Yellow", "Magenta", "Cyan" }; + + foreach (string colorName in colors) + { + Color fg = colorName switch + { + "Red" => Color.Red, + "Green" => Color.Green, + "Blue" => Color.Blue, + "Yellow" => Color.Yellow, + "Magenta" => Color.Magenta, + "Cyan" => Color.Cyan, + _ => Color.White + }; + + driver.CurrentAttribute = new (fg, Color.Black); + driver.AddStr (colorName); + } + + string ansi = driver.ToAnsi (); + + Assert.True (driver.Force16Colors == force16Colors); + // Should contain multiple color codes + Assert.Contains (expectedRed, ansi); // Red + Assert.Contains (expectedGreen, ansi); // Green + Assert.Contains (expectedBlue, ansi); // Blue + Assert.Contains (expectedYellow, ansi); // Yellow + Assert.Contains (expectedMagenta, ansi); // Magenta + Assert.Contains (expectedCyan, ansi); // Cyan + } + + [Fact] + public void ToAnsi_Special_Characters () + { + IDriver driver = CreateFakeDriver (20, 1); + + // Test backslash character + driver.AddStr ("Backslash:"); + driver.AddRune ('\\'); + + string ansi = driver.ToAnsi (); + + Assert.Contains ("Backslash:", ansi); + Assert.Contains ("\\", ansi); + } + + [Fact] + public void ToAnsi_Buffer_Boundary_Conditions () + { + // Test with minimum buffer size + IDriver driver = CreateFakeDriver (1, 1); + driver.AddStr ("X"); + + string ansi = driver.ToAnsi (); + + Assert.Contains ("X", ansi); + Assert.Contains ("\n", ansi); + + // Test with very wide buffer + driver = CreateFakeDriver (1000, 1); + driver.AddStr ("Wide"); + + ansi = driver.ToAnsi (); + + Assert.Contains ("Wide", ansi); + Assert.True (ansi.Length > 1000); // Should have many spaces + } + + [Fact] + public void ToAnsi_Empty_Lines () + { + IDriver driver = CreateFakeDriver (10, 3); + + // Only write to first and third lines + driver.AddStr ("First"); + driver.Move (0, 2); + driver.AddStr ("Third"); + + string ansi = driver.ToAnsi (); + + string[] lines = ansi.Split ('\n'); + Assert.Equal (4, lines.Length); // 3 content lines + 1 empty line at end + Assert.Contains ("First", lines[0]); + Assert.Contains ("Third", lines[2]); + } + + [Fact] + public void ToAnsi_Performance_Stress_Test () + { + // Create a large buffer and fill it completely + const int width = 200; + const int height = 100; + IDriver driver = CreateFakeDriver (width, height); + + // Fill every cell with different content and colors + for (int row = 0; row < height; row++) + { + for (int col = 0; col < width; col++) + { + driver.Move (col, row); + driver.CurrentAttribute = new Attribute ((ColorName16)((row + col) % 16), Color.Black); + driver.AddRune ((char)('A' + ((row + col) % 26))); + } + } + + // This should complete in reasonable time and not throw + string ansi = driver.ToAnsi (); + + Assert.NotNull (ansi); + Assert.True (ansi.Length > width * height); // Should contain all characters plus ANSI codes + } +} \ No newline at end of file diff --git a/Tests/UnitTestsParallelizable/Drivers/UrlHyperlinkerTests.cs b/Tests/UnitTestsParallelizable/Drivers/UrlHyperlinkerTests.cs index 309528ea2..86fbf66c0 100644 --- a/Tests/UnitTestsParallelizable/Drivers/UrlHyperlinkerTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/UrlHyperlinkerTests.cs @@ -2,7 +2,7 @@ using System.Text; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class Osc8UrlLinkerTests (ITestOutputHelper output) { diff --git a/Tests/UnitTestsParallelizable/Drivers/WindowSizeMonitorTests.cs b/Tests/UnitTestsParallelizable/Drivers/Windows/WindowSizeMonitorTests.cs similarity index 97% rename from Tests/UnitTestsParallelizable/Drivers/WindowSizeMonitorTests.cs rename to Tests/UnitTestsParallelizable/Drivers/Windows/WindowSizeMonitorTests.cs index 4906f30cd..1038cd0c4 100644 --- a/Tests/UnitTestsParallelizable/Drivers/WindowSizeMonitorTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/Windows/WindowSizeMonitorTests.cs @@ -1,6 +1,6 @@ using Moq; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class WindowSizeMonitorTests { diff --git a/Tests/UnitTestsParallelizable/Drivers/WindowsInputProcessorTests.cs b/Tests/UnitTestsParallelizable/Drivers/Windows/WindowsInputProcessorTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/Drivers/WindowsInputProcessorTests.cs rename to Tests/UnitTestsParallelizable/Drivers/Windows/WindowsInputProcessorTests.cs index 1145fc90a..4701d4963 100644 --- a/Tests/UnitTestsParallelizable/Drivers/WindowsInputProcessorTests.cs +++ b/Tests/UnitTestsParallelizable/Drivers/Windows/WindowsInputProcessorTests.cs @@ -5,7 +5,7 @@ using EventFlags = Terminal.Gui.Drivers.WindowsConsole.EventFlags; using ControlKeyState = Terminal.Gui.Drivers.WindowsConsole.ControlKeyState; using MouseEventRecord = Terminal.Gui.Drivers.WindowsConsole.MouseEventRecord; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; public class WindowsInputProcessorTests { diff --git a/Tests/UnitTestsParallelizable/Drivers/Windows/WindowsKeyConverterTests.cs b/Tests/UnitTestsParallelizable/Drivers/Windows/WindowsKeyConverterTests.cs new file mode 100644 index 000000000..2cad545da --- /dev/null +++ b/Tests/UnitTestsParallelizable/Drivers/Windows/WindowsKeyConverterTests.cs @@ -0,0 +1,798 @@ +using System.Runtime.InteropServices; + +namespace DriverTests; + +[Collection ("Global Test Setup")] +[Trait ("Platform", "Windows")] +public class WindowsKeyConverterTests +{ + private readonly WindowsKeyConverter _converter = new (); + + #region ToKey Tests - Basic Characters + + [Theory] + [InlineData ('a', ConsoleKey.A, false, false, false, KeyCode.A)] // lowercase a + [InlineData ('A', ConsoleKey.A, true, false, false, KeyCode.A | KeyCode.ShiftMask)] // uppercase A + [InlineData ('z', ConsoleKey.Z, false, false, false, KeyCode.Z)] + [InlineData ('Z', ConsoleKey.Z, true, false, false, KeyCode.Z | KeyCode.ShiftMask)] + public void ToKey_LetterKeys_ReturnsExpectedKeyCode ( + char unicodeChar, + ConsoleKey consoleKey, + bool shift, + bool alt, + bool ctrl, + KeyCode expectedKeyCode + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + WindowsConsole.InputRecord inputRecord = CreateInputRecord (unicodeChar, consoleKey, shift, alt, ctrl); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal (expectedKeyCode, result.KeyCode); + } + + [Theory] + [InlineData ('0', ConsoleKey.D0, false, false, false, KeyCode.D0)] + [InlineData ('1', ConsoleKey.D1, false, false, false, KeyCode.D1)] + [InlineData ('9', ConsoleKey.D9, false, false, false, KeyCode.D9)] + public void ToKey_NumberKeys_ReturnsExpectedKeyCode ( + char unicodeChar, + ConsoleKey consoleKey, + bool shift, + bool alt, + bool ctrl, + KeyCode expectedKeyCode + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + WindowsConsole.InputRecord inputRecord = CreateInputRecord (unicodeChar, consoleKey, shift, alt, ctrl); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal (expectedKeyCode, result.KeyCode); + } + + #endregion + + #region ToKey Tests - Modifiers + + [Theory] + [InlineData ('a', ConsoleKey.A, false, false, true, KeyCode.A | KeyCode.CtrlMask)] // Ctrl+A + [InlineData ('A', ConsoleKey.A, true, false, true, KeyCode.A | KeyCode.ShiftMask | KeyCode.CtrlMask)] // Ctrl+Shift+A (Windows keeps ShiftMask) + [InlineData ('a', ConsoleKey.A, false, true, false, KeyCode.A | KeyCode.AltMask)] // Alt+A + [InlineData ('A', ConsoleKey.A, true, true, false, KeyCode.A | KeyCode.ShiftMask | KeyCode.AltMask)] // Alt+Shift+A + [InlineData ('a', ConsoleKey.A, false, true, true, KeyCode.A | KeyCode.CtrlMask | KeyCode.AltMask)] // Ctrl+Alt+A + public void ToKey_WithModifiers_ReturnsExpectedKeyCode ( + char unicodeChar, + ConsoleKey consoleKey, + bool shift, + bool alt, + bool ctrl, + KeyCode expectedKeyCode + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + WindowsConsole.InputRecord inputRecord = CreateInputRecord (unicodeChar, consoleKey, shift, alt, ctrl); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal (expectedKeyCode, result.KeyCode); + } + + #endregion + + #region ToKey Tests - Special Keys + + [Theory] + [InlineData (ConsoleKey.Enter, KeyCode.Enter)] + [InlineData (ConsoleKey.Escape, KeyCode.Esc)] + [InlineData (ConsoleKey.Tab, KeyCode.Tab)] + [InlineData (ConsoleKey.Backspace, KeyCode.Backspace)] + [InlineData (ConsoleKey.Delete, KeyCode.Delete)] + [InlineData (ConsoleKey.Insert, KeyCode.Insert)] + [InlineData (ConsoleKey.Home, KeyCode.Home)] + [InlineData (ConsoleKey.End, KeyCode.End)] + [InlineData (ConsoleKey.PageUp, KeyCode.PageUp)] + [InlineData (ConsoleKey.PageDown, KeyCode.PageDown)] + [InlineData (ConsoleKey.UpArrow, KeyCode.CursorUp)] + [InlineData (ConsoleKey.DownArrow, KeyCode.CursorDown)] + [InlineData (ConsoleKey.LeftArrow, KeyCode.CursorLeft)] + [InlineData (ConsoleKey.RightArrow, KeyCode.CursorRight)] + public void ToKey_SpecialKeys_ReturnsExpectedKeyCode (ConsoleKey consoleKey, KeyCode expectedKeyCode) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + char unicodeChar = consoleKey switch + { + ConsoleKey.Enter => '\r', + ConsoleKey.Escape => '\u001B', + ConsoleKey.Tab => '\t', + ConsoleKey.Backspace => '\b', + _ => '\0' + }; + WindowsConsole.InputRecord inputRecord = CreateInputRecord (unicodeChar, consoleKey, false, false, false); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal (expectedKeyCode, result.KeyCode); + } + + [Theory] + [InlineData (ConsoleKey.F1, KeyCode.F1)] + [InlineData (ConsoleKey.F2, KeyCode.F2)] + [InlineData (ConsoleKey.F3, KeyCode.F3)] + [InlineData (ConsoleKey.F4, KeyCode.F4)] + [InlineData (ConsoleKey.F5, KeyCode.F5)] + [InlineData (ConsoleKey.F6, KeyCode.F6)] + [InlineData (ConsoleKey.F7, KeyCode.F7)] + [InlineData (ConsoleKey.F8, KeyCode.F8)] + [InlineData (ConsoleKey.F9, KeyCode.F9)] + [InlineData (ConsoleKey.F10, KeyCode.F10)] + [InlineData (ConsoleKey.F11, KeyCode.F11)] + [InlineData (ConsoleKey.F12, KeyCode.F12)] + public void ToKey_FunctionKeys_ReturnsExpectedKeyCode (ConsoleKey consoleKey, KeyCode expectedKeyCode) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + WindowsConsole.InputRecord inputRecord = CreateInputRecord ('\0', consoleKey, false, false, false); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal (expectedKeyCode, result.KeyCode); + } + + #endregion + + #region ToKey Tests - VK_PACKET (Unicode/IME) + + [Theory] + [InlineData ('中')] // Chinese character + [InlineData ('日')] // Japanese character + [InlineData ('한')] // Korean character + [InlineData ('é')] // Accented character + [InlineData ('€')] // Euro symbol + [InlineData ('Ω')] // Greek character + public void ToKey_VKPacket_Unicode_ReturnsExpectedCharacter (char unicodeChar) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + WindowsConsole.InputRecord inputRecord = CreateVKPacketInputRecord (unicodeChar); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal ((KeyCode)unicodeChar, result.KeyCode); + } + + [Fact] + public void ToKey_VKPacket_ZeroChar_ReturnsNull () + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + WindowsConsole.InputRecord inputRecord = CreateVKPacketInputRecord ('\0'); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal (KeyCode.Null, result.KeyCode); + } + + [Fact] + public void ToKey_VKPacket_SurrogatePair_DocumentsCurrentLimitation () + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Emoji '😀' (U+1F600) requires a surrogate pair: High=U+D83D, Low=U+DE00 + // Windows sends this as TWO consecutive VK_PACKET events (one for each char) + // because KeyEventRecord.UnicodeChar is a single 16-bit char field. + // + // CURRENT LIMITATION: WindowsKeyConverter processes each event independently + // and does not combine surrogate pairs into a single Rune/KeyCode. + // This test documents the current (incorrect) behavior. + // + // TODO: Implement proper surrogate pair handling at the InputProcessor level + // to combine consecutive high+low surrogate events into a single Key with the + // complete Unicode codepoint. + // See: https://docs.microsoft.com/en-us/windows/console/key-event-record + + var highSurrogate = '\uD83D'; // High surrogate for 😀 + var lowSurrogate = '\uDE00'; // Low surrogate for 😀 + + // First event with high surrogate + WindowsConsole.InputRecord highRecord = CreateVKPacketInputRecord (highSurrogate); + var highResult = _converter.ToKey (highRecord); + + // Second event with low surrogate + WindowsConsole.InputRecord lowRecord = CreateVKPacketInputRecord (lowSurrogate); + var lowResult = _converter.ToKey (lowRecord); + + // Currently each surrogate half is processed independently as invalid KeyCodes + // These assertions document the current (broken) behavior + Assert.Equal ((KeyCode)highSurrogate, highResult.KeyCode); + Assert.Equal ((KeyCode)lowSurrogate, lowResult.KeyCode); + + // What SHOULD happen (future fix): + // The InputProcessor should detect the surrogate pair and combine them: + // var expectedRune = new Rune(0x1F600); // 😀 + // Assert.Equal((KeyCode)expectedRune.Value, combinedResult.KeyCode); + } + + #endregion + + #region ToKey Tests - OEM Keys + + [Theory] + [InlineData (';', ConsoleKey.Oem1, false, (KeyCode)';')] + [InlineData (':', ConsoleKey.Oem1, true, (KeyCode)':')] + [InlineData ('/', ConsoleKey.Oem2, false, (KeyCode)'/')] + [InlineData ('?', ConsoleKey.Oem2, true, (KeyCode)'?')] + [InlineData (',', ConsoleKey.OemComma, false, (KeyCode)',')] + [InlineData ('<', ConsoleKey.OemComma, true, (KeyCode)'<')] + [InlineData ('.', ConsoleKey.OemPeriod, false, (KeyCode)'.')] + [InlineData ('>', ConsoleKey.OemPeriod, true, (KeyCode)'>')] + [InlineData ('=', ConsoleKey.OemPlus, false, (KeyCode)'=')] // Un-shifted OemPlus is '=' + [InlineData ('+', ConsoleKey.OemPlus, true, (KeyCode)'+')] // Shifted OemPlus is '+' + [InlineData ('-', ConsoleKey.OemMinus, false, (KeyCode)'-')] + [InlineData ('_', ConsoleKey.OemMinus, true, (KeyCode)'_')] // Shifted OemMinus is '_' + public void ToKey_OEMKeys_ReturnsExpectedKeyCode ( + char unicodeChar, + ConsoleKey consoleKey, + bool shift, + KeyCode expectedKeyCode + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + WindowsConsole.InputRecord inputRecord = CreateInputRecord (unicodeChar, consoleKey, shift, false, false); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal (expectedKeyCode, result.KeyCode); + } + + #endregion + + #region ToKey Tests - NumPad + + [Theory] + [InlineData ('0', ConsoleKey.NumPad0, KeyCode.D0)] + [InlineData ('1', ConsoleKey.NumPad1, KeyCode.D1)] + [InlineData ('5', ConsoleKey.NumPad5, KeyCode.D5)] + [InlineData ('9', ConsoleKey.NumPad9, KeyCode.D9)] + public void ToKey_NumPadKeys_ReturnsExpectedKeyCode ( + char unicodeChar, + ConsoleKey consoleKey, + KeyCode expectedKeyCode + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + WindowsConsole.InputRecord inputRecord = CreateInputRecord (unicodeChar, consoleKey, false, false, false); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal (expectedKeyCode, result.KeyCode); + } + + [Theory] + [InlineData ('*', ConsoleKey.Multiply, (KeyCode)'*')] + [InlineData ('+', ConsoleKey.Add, (KeyCode)'+')] + [InlineData ('-', ConsoleKey.Subtract, (KeyCode)'-')] + [InlineData ('.', ConsoleKey.Decimal, (KeyCode)'.')] + [InlineData ('/', ConsoleKey.Divide, (KeyCode)'/')] + public void ToKey_NumPadOperators_ReturnsExpectedKeyCode ( + char unicodeChar, + ConsoleKey consoleKey, + KeyCode expectedKeyCode + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + WindowsConsole.InputRecord inputRecord = CreateInputRecord (unicodeChar, consoleKey, false, false, false); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal (expectedKeyCode, result.KeyCode); + } + + #endregion + + #region ToKey Tests - Null/Empty + + [Fact] + public void ToKey_NullKey_ReturnsEmpty () + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + WindowsConsole.InputRecord inputRecord = CreateInputRecord ('\0', ConsoleKey.None, false, false, false); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal (Key.Empty, result); + } + + #endregion + + #region ToKeyInfo Tests - Basic Keys + + [Theory] + [InlineData (KeyCode.A, ConsoleKey.A, 'a')] + [InlineData (KeyCode.A | KeyCode.ShiftMask, ConsoleKey.A, 'A')] + [InlineData (KeyCode.Z, ConsoleKey.Z, 'z')] + [InlineData (KeyCode.Z | KeyCode.ShiftMask, ConsoleKey.Z, 'Z')] + public void ToKeyInfo_LetterKeys_ReturnsExpectedInputRecord ( + KeyCode keyCode, + ConsoleKey expectedConsoleKey, + char expectedChar + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + var key = new Key (keyCode); + + // Act + WindowsConsole.InputRecord result = _converter.ToKeyInfo (key); + + // Assert + Assert.Equal (WindowsConsole.EventType.Key, result.EventType); + Assert.Equal ((VK)expectedConsoleKey, result.KeyEvent.wVirtualKeyCode); + Assert.Equal (expectedChar, result.KeyEvent.UnicodeChar); + Assert.True (result.KeyEvent.bKeyDown); + Assert.Equal ((ushort)1, result.KeyEvent.wRepeatCount); + } + + [Theory] + [InlineData (KeyCode.D0, ConsoleKey.D0, '0')] + [InlineData (KeyCode.D1, ConsoleKey.D1, '1')] + [InlineData (KeyCode.D9, ConsoleKey.D9, '9')] + public void ToKeyInfo_NumberKeys_ReturnsExpectedInputRecord ( + KeyCode keyCode, + ConsoleKey expectedConsoleKey, + char expectedChar + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + var key = new Key (keyCode); + + // Act + WindowsConsole.InputRecord result = _converter.ToKeyInfo (key); + + // Assert + Assert.Equal ((VK)expectedConsoleKey, result.KeyEvent.wVirtualKeyCode); + Assert.Equal (expectedChar, result.KeyEvent.UnicodeChar); + } + + #endregion + + #region ToKeyInfo Tests - Special Keys + + [Theory] + [InlineData (KeyCode.Enter, ConsoleKey.Enter, '\r')] + [InlineData (KeyCode.Esc, ConsoleKey.Escape, '\u001B')] + [InlineData (KeyCode.Tab, ConsoleKey.Tab, '\t')] + [InlineData (KeyCode.Backspace, ConsoleKey.Backspace, '\b')] + [InlineData (KeyCode.Space, ConsoleKey.Spacebar, ' ')] + public void ToKeyInfo_SpecialKeys_ReturnsExpectedInputRecord ( + KeyCode keyCode, + ConsoleKey expectedConsoleKey, + char expectedChar + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + var key = new Key (keyCode); + + // Act + WindowsConsole.InputRecord result = _converter.ToKeyInfo (key); + + // Assert + Assert.Equal ((VK)expectedConsoleKey, result.KeyEvent.wVirtualKeyCode); + Assert.Equal (expectedChar, result.KeyEvent.UnicodeChar); + } + + [Theory] + [InlineData (KeyCode.Delete, ConsoleKey.Delete)] + [InlineData (KeyCode.Insert, ConsoleKey.Insert)] + [InlineData (KeyCode.Home, ConsoleKey.Home)] + [InlineData (KeyCode.End, ConsoleKey.End)] + [InlineData (KeyCode.PageUp, ConsoleKey.PageUp)] + [InlineData (KeyCode.PageDown, ConsoleKey.PageDown)] + [InlineData (KeyCode.CursorUp, ConsoleKey.UpArrow)] + [InlineData (KeyCode.CursorDown, ConsoleKey.DownArrow)] + [InlineData (KeyCode.CursorLeft, ConsoleKey.LeftArrow)] + [InlineData (KeyCode.CursorRight, ConsoleKey.RightArrow)] + public void ToKeyInfo_NavigationKeys_ReturnsExpectedInputRecord (KeyCode keyCode, ConsoleKey expectedConsoleKey) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + var key = new Key (keyCode); + + // Act + WindowsConsole.InputRecord result = _converter.ToKeyInfo (key); + + // Assert + Assert.Equal ((VK)expectedConsoleKey, result.KeyEvent.wVirtualKeyCode); + } + + [Theory] + [InlineData (KeyCode.F1, ConsoleKey.F1)] + [InlineData (KeyCode.F5, ConsoleKey.F5)] + [InlineData (KeyCode.F10, ConsoleKey.F10)] + [InlineData (KeyCode.F12, ConsoleKey.F12)] + public void ToKeyInfo_FunctionKeys_ReturnsExpectedInputRecord (KeyCode keyCode, ConsoleKey expectedConsoleKey) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + var key = new Key (keyCode); + + // Act + WindowsConsole.InputRecord result = _converter.ToKeyInfo (key); + + // Assert + Assert.Equal ((VK)expectedConsoleKey, result.KeyEvent.wVirtualKeyCode); + } + + #endregion + + #region ToKeyInfo Tests - Modifiers + + [Theory] + [InlineData (KeyCode.A | KeyCode.ShiftMask, WindowsConsole.ControlKeyState.ShiftPressed)] + [InlineData (KeyCode.A | KeyCode.CtrlMask, WindowsConsole.ControlKeyState.LeftControlPressed)] + [InlineData (KeyCode.A | KeyCode.AltMask, WindowsConsole.ControlKeyState.LeftAltPressed)] + [InlineData ( + KeyCode.A | KeyCode.CtrlMask | KeyCode.AltMask, + WindowsConsole.ControlKeyState.LeftControlPressed | WindowsConsole.ControlKeyState.LeftAltPressed)] + [InlineData ( + KeyCode.A | KeyCode.ShiftMask | KeyCode.CtrlMask | KeyCode.AltMask, + WindowsConsole.ControlKeyState.ShiftPressed + | WindowsConsole.ControlKeyState.LeftControlPressed + | WindowsConsole.ControlKeyState.LeftAltPressed)] + public void ToKeyInfo_WithModifiers_ReturnsExpectedControlKeyState ( + KeyCode keyCode, + WindowsConsole.ControlKeyState expectedState + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + var key = new Key (keyCode); + + // Act + WindowsConsole.InputRecord result = _converter.ToKeyInfo (key); + + // Assert + Assert.Equal (expectedState, result.KeyEvent.dwControlKeyState); + } + + #endregion + + #region ToKeyInfo Tests - Scan Codes + + [Theory] + [InlineData (KeyCode.A, 30)] + [InlineData (KeyCode.Enter, 28)] + [InlineData (KeyCode.Esc, 1)] + [InlineData (KeyCode.Space, 57)] + [InlineData (KeyCode.F1, 59)] + [InlineData (KeyCode.F10, 68)] + [InlineData (KeyCode.CursorUp, 72)] + [InlineData (KeyCode.Home, 71)] + public void ToKeyInfo_ScanCodes_ReturnsExpectedScanCode (KeyCode keyCode, ushort expectedScanCode) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + var key = new Key (keyCode); + + // Act + WindowsConsole.InputRecord result = _converter.ToKeyInfo (key); + + // Assert + Assert.Equal (expectedScanCode, result.KeyEvent.wVirtualScanCode); + } + + #endregion + + #region Round-Trip Tests + + [Theory] + [InlineData (KeyCode.A)] + [InlineData (KeyCode.A | KeyCode.ShiftMask)] + [InlineData (KeyCode.A | KeyCode.CtrlMask)] + [InlineData (KeyCode.Enter)] + [InlineData (KeyCode.F1)] + [InlineData (KeyCode.CursorUp)] + [InlineData (KeyCode.Delete)] + [InlineData (KeyCode.D5)] + [InlineData (KeyCode.Space)] + public void RoundTrip_ToKeyInfo_ToKey_PreservesKeyCode (KeyCode originalKeyCode) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + var originalKey = new Key (originalKeyCode); + + // Act + WindowsConsole.InputRecord inputRecord = _converter.ToKeyInfo (originalKey); + var roundTrippedKey = _converter.ToKey (inputRecord); + + // Assert + Assert.Equal (originalKeyCode, roundTrippedKey.KeyCode); + } + + [Theory] + [InlineData ('a', ConsoleKey.A, false, false, false)] + [InlineData ('A', ConsoleKey.A, true, false, false)] + [InlineData ('a', ConsoleKey.A, false, false, true)] // Ctrl+A + [InlineData ('0', ConsoleKey.D0, false, false, false)] + public void RoundTrip_ToKey_ToKeyInfo_PreservesData ( + char unicodeChar, + ConsoleKey consoleKey, + bool shift, + bool alt, + bool ctrl + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + // Arrange + WindowsConsole.InputRecord originalRecord = CreateInputRecord (unicodeChar, consoleKey, shift, alt, ctrl); + + // Act + var key = _converter.ToKey (originalRecord); + WindowsConsole.InputRecord roundTrippedRecord = _converter.ToKeyInfo (key); + + // Assert + Assert.Equal ((VK)consoleKey, roundTrippedRecord.KeyEvent.wVirtualKeyCode); + + // Check modifiers match + var expectedState = WindowsConsole.ControlKeyState.NoControlKeyPressed; + + if (shift) + { + expectedState |= WindowsConsole.ControlKeyState.ShiftPressed; + } + + if (alt) + { + expectedState |= WindowsConsole.ControlKeyState.LeftAltPressed; + } + + if (ctrl) + { + expectedState |= WindowsConsole.ControlKeyState.LeftControlPressed; + } + + Assert.True (roundTrippedRecord.KeyEvent.dwControlKeyState.HasFlag (expectedState)); + } + + #endregion + + #region CapsLock/NumLock Tests + + [Theory] + [InlineData ('a', ConsoleKey.A, false, true)] // CapsLock on, no shift + [InlineData ('A', ConsoleKey.A, true, true)] // CapsLock on, shift (should be lowercase from mapping) + public void ToKey_WithCapsLock_ReturnsExpectedKeyCode ( + char unicodeChar, + ConsoleKey consoleKey, + bool shift, + bool capsLock + ) + { + if (!RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) + { + return; + } + + WindowsConsole.InputRecord inputRecord = CreateInputRecordWithLockStates ( + unicodeChar, + consoleKey, + shift, + false, + false, + capsLock, + false, + false); + + // Act + var result = _converter.ToKey (inputRecord); + + // Assert + // The mapping should handle CapsLock properly via WindowsKeyHelper.MapKey + Assert.NotEqual (KeyCode.Null, result.KeyCode); + } + + #endregion + + #region Helper Methods + + private static WindowsConsole.InputRecord CreateInputRecord ( + char unicodeChar, + ConsoleKey consoleKey, + bool shift, + bool alt, + bool ctrl + ) => + CreateInputRecordWithLockStates (unicodeChar, consoleKey, shift, alt, ctrl, false, false, false); + + private static WindowsConsole.InputRecord CreateInputRecordWithLockStates ( + char unicodeChar, + ConsoleKey consoleKey, + bool shift, + bool alt, + bool ctrl, + bool capsLock, + bool numLock, + bool scrollLock + ) + { + var controlKeyState = WindowsConsole.ControlKeyState.NoControlKeyPressed; + + if (shift) + { + controlKeyState |= WindowsConsole.ControlKeyState.ShiftPressed; + } + + if (alt) + { + controlKeyState |= WindowsConsole.ControlKeyState.LeftAltPressed; + } + + if (ctrl) + { + controlKeyState |= WindowsConsole.ControlKeyState.LeftControlPressed; + } + + if (capsLock) + { + controlKeyState |= WindowsConsole.ControlKeyState.CapslockOn; + } + + if (numLock) + { + controlKeyState |= WindowsConsole.ControlKeyState.NumlockOn; + } + + if (scrollLock) + { + controlKeyState |= WindowsConsole.ControlKeyState.ScrolllockOn; + } + + return new () + { + EventType = WindowsConsole.EventType.Key, + KeyEvent = new () + { + bKeyDown = true, + wRepeatCount = 1, + wVirtualKeyCode = (VK)consoleKey, + wVirtualScanCode = 0, + UnicodeChar = unicodeChar, + dwControlKeyState = controlKeyState + } + }; + } + + private static WindowsConsole.InputRecord CreateVKPacketInputRecord (char unicodeChar) => + new () + { + EventType = WindowsConsole.EventType.Key, + KeyEvent = new () + { + bKeyDown = true, + wRepeatCount = 1, + wVirtualKeyCode = VK.PACKET, + wVirtualScanCode = 0, + UnicodeChar = unicodeChar, + dwControlKeyState = WindowsConsole.ControlKeyState.NoControlKeyPressed + } + }; + + #endregion +} diff --git a/Tests/UnitTestsParallelizable/FileServices/FileSystemColorProviderTests.cs b/Tests/UnitTestsParallelizable/FileServices/FileSystemColorProviderTests.cs index 4c01895df..8e6ea7f1d 100644 --- a/Tests/UnitTestsParallelizable/FileServices/FileSystemColorProviderTests.cs +++ b/Tests/UnitTestsParallelizable/FileServices/FileSystemColorProviderTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.FileServicesTests; +namespace FileServicesTests; public class FileSystemColorProviderTests { diff --git a/Tests/UnitTestsParallelizable/FileServices/FileSystemIconProviderTests.cs b/Tests/UnitTestsParallelizable/FileServices/FileSystemIconProviderTests.cs index 37bd3acde..edd507830 100644 --- a/Tests/UnitTestsParallelizable/FileServices/FileSystemIconProviderTests.cs +++ b/Tests/UnitTestsParallelizable/FileServices/FileSystemIconProviderTests.cs @@ -3,7 +3,7 @@ using System.IO.Abstractions.TestingHelpers; using System.Runtime.InteropServices; using System.Text; -namespace UnitTests_Parallelizable.FileServicesTests; +namespace FileServicesTests; public class FileSystemIconProviderTests { diff --git a/Tests/UnitTestsParallelizable/FileServices/NerdFontsTests.cs b/Tests/UnitTestsParallelizable/FileServices/NerdFontsTests.cs index 580df348e..eced78aef 100644 --- a/Tests/UnitTestsParallelizable/FileServices/NerdFontsTests.cs +++ b/Tests/UnitTestsParallelizable/FileServices/NerdFontsTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.FileServicesTests; +namespace FileServicesTests; public class NerdFontTests { diff --git a/Tests/UnitTestsParallelizable/Input/EnqueueKeyEventTests.cs b/Tests/UnitTestsParallelizable/Input/EnqueueKeyEventTests.cs index 123f1ffcd..af071adb8 100644 --- a/Tests/UnitTestsParallelizable/Input/EnqueueKeyEventTests.cs +++ b/Tests/UnitTestsParallelizable/Input/EnqueueKeyEventTests.cs @@ -2,7 +2,7 @@ using System.Collections.Concurrent; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; /// /// Parallelizable unit tests for IInput.EnqueueKeyDownEvent and InputProcessor.EnqueueKeyDownEvent. diff --git a/Tests/UnitTestsParallelizable/Input/EnqueueMouseEventTests.cs b/Tests/UnitTestsParallelizable/Input/EnqueueMouseEventTests.cs index f50d0fdf2..a01a3eec9 100644 --- a/Tests/UnitTestsParallelizable/Input/EnqueueMouseEventTests.cs +++ b/Tests/UnitTestsParallelizable/Input/EnqueueMouseEventTests.cs @@ -2,7 +2,7 @@ using System.Collections.Concurrent; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.DriverTests; +namespace DriverTests; /// /// Parallelizable unit tests for IInputProcessor.EnqueueMouseEvent. @@ -32,14 +32,16 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) // Act - Simulate a complete click: press → release → click processor.EnqueueMouseEvent ( - new() + null, + new () { Position = new (10, 5), Flags = MouseFlags.Button1Pressed }); processor.EnqueueMouseEvent ( - new() + null, + new () { Position = new (10, 5), Flags = MouseFlags.Button1Released @@ -89,7 +91,8 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) for (var i = 0; i < eventsPerThread; i++) { processor.EnqueueMouseEvent ( - new() + null, + new () { Position = new (threadId, i), Flags = MouseFlags.Button1Clicked @@ -160,7 +163,7 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) }; // Act - processor.EnqueueMouseEvent (mouseEvent); + processor.EnqueueMouseEvent (null, mouseEvent); SimulateInputThread (fakeInput, queue); processor.ProcessQueue (); @@ -196,7 +199,7 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) // Act foreach (MouseEventArgs mouseEvent in events) { - processor.EnqueueMouseEvent (mouseEvent); + processor.EnqueueMouseEvent (null, mouseEvent); } SimulateInputThread (fakeInput, queue); @@ -216,9 +219,9 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) Assert.Contains (receivedEvents, e => e.Flags == MouseFlags.Button1Pressed && e.Position == new Point (10, 5)); Assert.Contains (receivedEvents, e => e.Flags == MouseFlags.Button1Released && e.Position == new Point (10, 5)); Assert.Contains (receivedEvents, e => e.Flags == MouseFlags.ReportMousePosition && e.Position == new Point (15, 8)); - + // There should be two clicked events: one generated, one original - var clickedEvents = receivedEvents.Where (e => e.Flags == MouseFlags.Button1Clicked).ToList (); + List clickedEvents = receivedEvents.Where (e => e.Flags == MouseFlags.Button1Clicked).ToList (); Assert.Equal (2, clickedEvents.Count); Assert.Contains (clickedEvents, e => e.Position == new Point (10, 5)); // Generated from press+release Assert.Contains (clickedEvents, e => e.Position == new Point (20, 10)); // Original @@ -251,7 +254,7 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) processor.MouseEvent += (_, e) => receivedEvent = e; // Act - processor.EnqueueMouseEvent (mouseEvent); + processor.EnqueueMouseEvent (null, mouseEvent); SimulateInputThread (fakeInput, queue); processor.ProcessQueue (); @@ -285,7 +288,7 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) processor.MouseEvent += (_, e) => receivedEvent = e; // Act - processor.EnqueueMouseEvent (mouseEvent); + processor.EnqueueMouseEvent (null, mouseEvent); SimulateInputThread (fakeInput, queue); processor.ProcessQueue (); @@ -323,7 +326,7 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) processor.MouseEvent += (_, e) => receivedEvent = e; // Act - processor.EnqueueMouseEvent (mouseEvent); + processor.EnqueueMouseEvent (null, mouseEvent); SimulateInputThread (fakeInput, queue); processor.ProcessQueue (); @@ -372,7 +375,7 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) processor.MouseEvent += (_, e) => receivedEvent = e; // Act - processor.EnqueueMouseEvent (mouseEvent); + processor.EnqueueMouseEvent (null, mouseEvent); SimulateInputThread (fakeInput, queue); processor.ProcessQueue (); @@ -405,7 +408,7 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) // Act foreach (MouseEventArgs mouseEvent in events) { - processor.EnqueueMouseEvent (mouseEvent); + processor.EnqueueMouseEvent (null, mouseEvent); } SimulateInputThread (fakeInput, queue); @@ -435,7 +438,8 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) Exception? exception = Record.Exception (() => { processor.EnqueueMouseEvent ( - new() + null, + new () { Position = new (10, 5), Flags = MouseFlags.Button1Clicked @@ -462,9 +466,9 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) processor.MouseEvent += (_, e) => receivedEvents.Add (e); // Act - Enqueue multiple events before processing - processor.EnqueueMouseEvent (new() { Position = new (1, 1), Flags = MouseFlags.Button1Pressed }); - processor.EnqueueMouseEvent (new() { Position = new (2, 2), Flags = MouseFlags.ReportMousePosition }); - processor.EnqueueMouseEvent (new() { Position = new (3, 3), Flags = MouseFlags.Button1Released }); + processor.EnqueueMouseEvent (null, new () { Position = new (1, 1), Flags = MouseFlags.Button1Pressed }); + processor.EnqueueMouseEvent (null, new () { Position = new (2, 2), Flags = MouseFlags.ReportMousePosition }); + processor.EnqueueMouseEvent (null, new () { Position = new (3, 3), Flags = MouseFlags.Button1Released }); SimulateInputThread (fakeInput, queue); processor.ProcessQueue (); @@ -492,7 +496,7 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) // Act & Assert - Empty/default mouse event should not throw Exception? exception = Record.Exception (() => { - processor.EnqueueMouseEvent (new ()); + processor.EnqueueMouseEvent (null, new ()); SimulateInputThread (fakeInput, queue); processor.ProcessQueue (); }); @@ -515,7 +519,8 @@ public class EnqueueMouseEventTests (ITestOutputHelper output) Exception? exception = Record.Exception (() => { processor.EnqueueMouseEvent ( - new() + null, + new () { Position = new (-10, -5), Flags = MouseFlags.Button1Clicked diff --git a/Tests/UnitTestsParallelizable/Input/InputBindingsThreadSafetyTests.cs b/Tests/UnitTestsParallelizable/Input/InputBindingsThreadSafetyTests.cs new file mode 100644 index 000000000..1e20f4a60 --- /dev/null +++ b/Tests/UnitTestsParallelizable/Input/InputBindingsThreadSafetyTests.cs @@ -0,0 +1,533 @@ +namespace InputTests; + +/// +/// Tests to verify that InputBindings (KeyBindings and MouseBindings) are thread-safe +/// for concurrent access scenarios. +/// +public class InputBindingsThreadSafetyTests +{ + [Fact] + public void Add_ConcurrentAccess_NoExceptions () + { + // Arrange + var bindings = new TestInputBindings (); + const int NUM_THREADS = 10; + const int ITEMS_PER_THREAD = 100; + + // Act + Parallel.For ( + 0, + NUM_THREADS, + i => + { + for (var j = 0; j < ITEMS_PER_THREAD; j++) + { + var key = $"key_{i}_{j}"; + + try + { + bindings.Add (key, Command.Accept); + } + catch (InvalidOperationException) + { + // Expected if duplicate key - this is OK + } + } + }); + + // Assert + IEnumerable> allBindings = bindings.GetBindings (); + Assert.NotEmpty (allBindings); + Assert.True (allBindings.Count () <= NUM_THREADS * ITEMS_PER_THREAD); + } + + [Fact] + public void Clear_ConcurrentAccess_NoExceptions () + { + // Arrange + var bindings = new TestInputBindings (); + const int NUM_THREADS = 10; + + // Populate initial data + for (var i = 0; i < 100; i++) + { + bindings.Add ($"key_{i}", Command.Accept); + } + + // Act - Multiple threads clearing simultaneously + Parallel.For ( + 0, + NUM_THREADS, + i => + { + try + { + bindings.Clear (); + } + catch (Exception ex) + { + Assert.Fail ($"Clear should not throw: {ex.Message}"); + } + }); + + // Assert + Assert.Empty (bindings.GetBindings ()); + } + + [Fact] + public void GetAllFromCommands_DuringModification_NoExceptions () + { + // Arrange + var bindings = new TestInputBindings (); + var continueRunning = true; + List exceptions = new (); + const int MAX_ADDITIONS = 200; // Limit total additions to prevent infinite loop + + // Populate initial data + for (var i = 0; i < 50; i++) + { + bindings.Add ($"key_{i}", Command.Accept); + } + + // Act - Modifier thread + Task modifierTask = Task.Run (() => + { + var counter = 50; + + while (continueRunning && counter < MAX_ADDITIONS) + { + try + { + bindings.Add ($"key_{counter++}", Command.Accept); + Thread.Sleep (1); // Small delay to prevent CPU spinning + } + catch (InvalidOperationException) + { + // Expected + } + } + }); + + // Act - Reader threads + List readerTasks = new (); + + for (var i = 0; i < 5; i++) + { + readerTasks.Add ( + Task.Run (() => + { + for (var j = 0; j < 50; j++) + { + try + { + IEnumerable results = bindings.GetAllFromCommands (Command.Accept); + int count = results.Count (); + Assert.True (count >= 0); + } + catch (Exception ex) + { + exceptions.Add (ex); + } + + Thread.Sleep (1); // Small delay between iterations + } + })); + } + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (readerTasks.ToArray ()); + continueRunning = false; + modifierTask.Wait (TimeSpan.FromSeconds (5)); // Add timeout to prevent indefinite hang +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + } + + [Fact] + public void GetBindings_DuringConcurrentModification_NoExceptions () + { + // Arrange + var bindings = new TestInputBindings (); + var continueRunning = true; + List exceptions = new (); + const int MAX_MODIFICATIONS = 200; // Limit total modifications + + // Populate some initial data + for (var i = 0; i < 50; i++) + { + bindings.Add ($"initial_{i}", Command.Accept); + } + + // Act - Start modifier thread + Task modifierTask = Task.Run (() => + { + var counter = 0; + + while (continueRunning && counter < MAX_MODIFICATIONS) + { + try + { + bindings.Add ($"key_{counter++}", Command.Cancel); + } + catch (InvalidOperationException) + { + // Expected - duplicate key + } + catch (Exception ex) + { + exceptions.Add (ex); + } + + if (counter % 10 == 0) + { + bindings.Clear (Command.Accept); + } + + Thread.Sleep (1); // Small delay to prevent CPU spinning + } + }); + + // Act - Start reader threads + List readerTasks = new (); + + for (var i = 0; i < 5; i++) + { + readerTasks.Add ( + Task.Run (() => + { + for (var j = 0; j < 100; j++) + { + try + { + // This should never throw "Collection was modified" exception + IEnumerable> snapshot = bindings.GetBindings (); + int count = snapshot.Count (); + Assert.True (count >= 0); + } + catch (InvalidOperationException ex) when (ex.Message.Contains ("Collection was modified")) + { + exceptions.Add (ex); + } + catch (Exception ex) + { + exceptions.Add (ex); + } + + Thread.Sleep (1); // Small delay between iterations + } + })); + } + + // Wait for readers to complete +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (readerTasks.ToArray ()); + continueRunning = false; + modifierTask.Wait (TimeSpan.FromSeconds (5)); // Add timeout to prevent indefinite hang +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + } + + [Fact] + public void KeyBindings_ConcurrentAccess_NoExceptions () + { + // Arrange + var view = new View (); + KeyBindings keyBindings = view.KeyBindings; + List exceptions = new (); + const int NUM_THREADS = 10; + const int OPERATIONS_PER_THREAD = 50; + + // Act + List tasks = new (); + + for (var i = 0; i < NUM_THREADS; i++) + { + int threadId = i; + + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + Key key = Key.A.WithShift.WithCtrl + threadId + j; + keyBindings.Add (key, Command.Accept); + } + catch (InvalidOperationException) + { + // Expected - duplicate or invalid key + } + catch (ArgumentException) + { + // Expected - invalid key + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + IEnumerable> bindings = keyBindings.GetBindings (); + Assert.NotEmpty (bindings); + + view.Dispose (); + } + + [Fact] + public void MixedOperations_ConcurrentAccess_NoExceptions () + { + // Arrange + var bindings = new TestInputBindings (); + List exceptions = new (); + const int OPERATIONS_PER_THREAD = 100; + + // Act - Multiple threads doing various operations + List tasks = new (); + + // Adder threads + for (var i = 0; i < 3; i++) + { + int threadId = i; + + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + bindings.Add ($"add_{threadId}_{j}", Command.Accept); + } + catch (InvalidOperationException) + { + // Expected - duplicate + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + + // Reader threads + for (var i = 0; i < 3; i++) + { + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + IEnumerable> snapshot = bindings.GetBindings (); + int count = snapshot.Count (); + Assert.True (count >= 0); + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + + // Remover threads + for (var i = 0; i < 2; i++) + { + int threadId = i; + + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + bindings.Remove ($"add_{threadId}_{j}"); + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + } + + [Fact] + public void MouseBindings_ConcurrentAccess_NoExceptions () + { + // Arrange + var view = new View (); + MouseBindings mouseBindings = view.MouseBindings; + List exceptions = new (); + const int NUM_THREADS = 10; + const int OPERATIONS_PER_THREAD = 50; + + // Act + List tasks = new (); + + for (var i = 0; i < NUM_THREADS; i++) + { + int threadId = i; + + tasks.Add ( + Task.Run (() => + { + for (var j = 0; j < OPERATIONS_PER_THREAD; j++) + { + try + { + MouseFlags flags = MouseFlags.Button1Clicked | (MouseFlags)(threadId * 1000 + j); + mouseBindings.Add (flags, Command.Accept); + } + catch (InvalidOperationException) + { + // Expected - duplicate or invalid flags + } + catch (ArgumentException) + { + // Expected - invalid mouse flags + } + catch (Exception ex) + { + exceptions.Add (ex); + } + } + })); + } + +#pragma warning disable xUnit1031 // Test methods should not use blocking task operations - intentional for stress testing + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Assert + Assert.Empty (exceptions); + + view.Dispose (); + } + + [Fact] + public void Remove_ConcurrentAccess_NoExceptions () + { + // Arrange + var bindings = new TestInputBindings (); + const int NUM_ITEMS = 100; + + // Populate data + for (var i = 0; i < NUM_ITEMS; i++) + { + bindings.Add ($"key_{i}", Command.Accept); + } + + // Act - Multiple threads removing items + Parallel.For ( + 0, + NUM_ITEMS, + i => + { + try + { + bindings.Remove ($"key_{i}"); + } + catch (Exception ex) + { + Assert.Fail ($"Remove should not throw: {ex.Message}"); + } + }); + + // Assert + Assert.Empty (bindings.GetBindings ()); + } + + [Fact] + public void Replace_ConcurrentAccess_NoExceptions () + { + // Arrange + var bindings = new TestInputBindings (); + const string OLD_KEY = "old_key"; + const string NEW_KEY = "new_key"; + + bindings.Add (OLD_KEY, Command.Accept); + + // Act - Multiple threads trying to replace + List exceptions = new (); + + Parallel.For ( + 0, + 10, + i => + { + try + { + bindings.Replace (OLD_KEY, $"{NEW_KEY}_{i}"); + } + catch (InvalidOperationException) + { + // Expected - key might already be replaced + } + catch (Exception ex) + { + exceptions.Add (ex); + } + }); + + // Assert + Assert.Empty (exceptions); + } + + [Fact] + public void TryGet_ConcurrentAccess_ReturnsConsistentResults () + { + // Arrange + var bindings = new TestInputBindings (); + const string TEST_KEY = "test_key"; + + bindings.Add (TEST_KEY, Command.Accept); + + // Act + var results = new bool [100]; + + Parallel.For ( + 0, + 100, + i => { results [i] = bindings.TryGet (TEST_KEY, out _); }); + + // Assert - All threads should consistently find the binding + Assert.All (results, result => Assert.True (result)); + } + + /// + /// Test implementation of InputBindings for testing purposes. + /// + private class TestInputBindings () : InputBindings ( + (commands, evt) => new () + { + Commands = commands, + Key = Key.Empty + }, + StringComparer.OrdinalIgnoreCase) + { + public override bool IsValid (string eventArgs) { return !string.IsNullOrEmpty (eventArgs); } + } +} diff --git a/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingTests.cs b/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingTests.cs index 413c3a413..081c19fc6 100644 --- a/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingTests.cs +++ b/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingTests.cs @@ -1,6 +1,6 @@ using Xunit.Abstractions; -namespace UnitTests_Parallelizable.InputTests; +namespace InputTests; public class KeyBindingTests () { diff --git a/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingsTests.cs b/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingsTests.cs index 43c888bfa..4beaa53b1 100644 --- a/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingsTests.cs +++ b/Tests/UnitTestsParallelizable/Input/Keyboard/KeyBindingsTests.cs @@ -1,8 +1,6 @@ -using Xunit.Abstractions; +namespace InputTests; -namespace UnitTests_Parallelizable.InputTests; - -public class KeyBindingsTests () +public class KeyBindingsTests { [Fact] public void Add_Adds () @@ -28,7 +26,7 @@ public class KeyBindingsTests () [Fact] public void Add_Invalid_Key_Throws () { - var keyBindings = new KeyBindings (new View ()); + var keyBindings = new KeyBindings (new ()); List commands = new (); Assert.Throws (() => keyBindings.Add (Key.Empty, Command.Accept)); } @@ -71,40 +69,39 @@ public class KeyBindingsTests () Assert.Contains (Command.HotKey, resultCommands); } - // Add should not allow duplicates [Fact] public void Add_Throws_If_Exists () { - var keyBindings = new KeyBindings (new View ()); + var keyBindings = new KeyBindings (new ()); keyBindings.Add (Key.A, Command.HotKey); Assert.Throws (() => keyBindings.Add (Key.A, Command.Accept)); Command [] resultCommands = keyBindings.GetCommands (Key.A); Assert.Contains (Command.HotKey, resultCommands); - keyBindings = new (new View ()); + keyBindings = new (new ()); keyBindings.Add (Key.A, Command.HotKey); Assert.Throws (() => keyBindings.Add (Key.A, Command.Accept)); resultCommands = keyBindings.GetCommands (Key.A); Assert.Contains (Command.HotKey, resultCommands); - keyBindings = new (new View ()); + keyBindings = new (new ()); keyBindings.Add (Key.A, Command.HotKey); Assert.Throws (() => keyBindings.Add (Key.A, Command.Accept)); resultCommands = keyBindings.GetCommands (Key.A); Assert.Contains (Command.HotKey, resultCommands); - keyBindings = new (new View ()); + keyBindings = new (new ()); keyBindings.Add (Key.A, Command.Accept); Assert.Throws (() => keyBindings.Add (Key.A, Command.ScrollDown)); resultCommands = keyBindings.GetCommands (Key.A); Assert.Contains (Command.Accept, resultCommands); - keyBindings = new (new View ()); + keyBindings = new (new ()); keyBindings.Add (Key.A, new KeyBinding ([Command.HotKey])); Assert.Throws (() => keyBindings.Add (Key.A, new KeyBinding (new [] { Command.Accept }))); @@ -142,6 +139,23 @@ public class KeyBindingsTests () Assert.Throws (() => keyBindings.Get (Key.B)); } + [Fact] + public void Get_Gets () + { + var keyBindings = new KeyBindings (new ()); + Command [] commands = [Command.Right, Command.Left]; + + var key = new Key (Key.A); + keyBindings.Add (key, commands); + KeyBinding binding = keyBindings.Get (key); + Assert.Contains (Command.Right, binding.Commands); + Assert.Contains (Command.Left, binding.Commands); + + binding = keyBindings.Get (key); + Assert.Contains (Command.Right, binding.Commands); + Assert.Contains (Command.Left, binding.Commands); + } + // GetCommands [Fact] public void GetCommands_Unknown_ReturnsEmpty () @@ -196,7 +210,7 @@ public class KeyBindingsTests () Command [] commands2 = { Command.Up, Command.Down }; keyBindings.Add (Key.B, commands2); - Key key = keyBindings.GetFirstFromCommands (commands1); + Key? key = keyBindings.GetFirstFromCommands (commands1); Assert.Equal (Key.A, key); key = keyBindings.GetFirstFromCommands (commands2); @@ -209,7 +223,7 @@ public class KeyBindingsTests () var keyBindings = new KeyBindings (new ()); keyBindings.Add (Key.A, Command.Right); - Key key = keyBindings.GetFirstFromCommands (Command.Right); + Key? key = keyBindings.GetFirstFromCommands (Command.Right); Assert.Equal (Key.A, key); } @@ -226,10 +240,31 @@ public class KeyBindingsTests () { var keyBindings = new KeyBindings (new ()); keyBindings.Add (Key.A, Command.HotKey); - Key resultKey = keyBindings.GetFirstFromCommands (Command.HotKey); + Key? resultKey = keyBindings.GetFirstFromCommands (Command.HotKey); Assert.Equal (Key.A, resultKey); } + [Fact] + public void ReplaceCommands_Replaces () + { + var keyBindings = new KeyBindings (new ()); + keyBindings.Add (Key.A, Command.Accept); + + keyBindings.ReplaceCommands (Key.A, Command.Refresh); + + bool result = keyBindings.TryGet (Key.A, out KeyBinding bindings); + Assert.True (result); + Assert.Contains (Command.Refresh, bindings.Commands); + } + + [Fact] + public void ReplaceKey_Adds_If_DoesNotContain_Old () + { + var keyBindings = new KeyBindings (new ()); + keyBindings.Replace (Key.A, Key.B); + Assert.True (keyBindings.TryGet (Key.B, out _)); + } + [Fact] public void ReplaceKey_Replaces () { @@ -263,19 +298,11 @@ public class KeyBindingsTests () keyBindings.Add (Key.A, Command.Accept); keyBindings.Add (Key.B, Command.HotKey); - keyBindings.Replace (keyBindings.GetFirstFromCommands (Command.Accept), Key.C); + keyBindings.Replace (keyBindings.GetFirstFromCommands (Command.Accept)!, Key.C); Assert.Empty (keyBindings.GetCommands (Key.A)); Assert.Contains (Command.Accept, keyBindings.GetCommands (Key.C)); } - [Fact] - public void ReplaceKey_Adds_If_DoesNotContain_Old () - { - var keyBindings = new KeyBindings (new ()); - keyBindings.Replace (Key.A, Key.B); - Assert.True (keyBindings.TryGet (Key.B, out _)); - } - [Fact] public void ReplaceKey_Throws_If_New_Is_Empty () { @@ -284,23 +311,6 @@ public class KeyBindingsTests () Assert.Throws (() => keyBindings.Replace (Key.A, Key.Empty)); } - [Fact] - public void Get_Gets () - { - var keyBindings = new KeyBindings (new ()); - Command [] commands = [Command.Right, Command.Left]; - - var key = new Key (Key.A); - keyBindings.Add (key, commands); - KeyBinding binding = keyBindings.Get (key); - Assert.Contains (Command.Right, binding.Commands); - Assert.Contains (Command.Left, binding.Commands); - - binding = keyBindings.Get (key); - Assert.Contains (Command.Right, binding.Commands); - Assert.Contains (Command.Left, binding.Commands); - } - // TryGet [Fact] public void TryGet_Succeeds () @@ -309,7 +319,8 @@ public class KeyBindingsTests () keyBindings.Add (Key.Q.WithCtrl, Command.HotKey); var key = new Key (Key.Q.WithCtrl); bool result = keyBindings.TryGet (key, out KeyBinding _); - Assert.True (result); ; + Assert.True (result); + ; } [Fact] @@ -329,18 +340,4 @@ public class KeyBindingsTests () Assert.True (result); Assert.Contains (Command.HotKey, bindings.Commands); } - - [Fact] - public void ReplaceCommands_Replaces () - { - var keyBindings = new KeyBindings (new ()); - keyBindings.Add (Key.A, Command.Accept); - - keyBindings.ReplaceCommands (Key.A, Command.Refresh); - - bool result = keyBindings.TryGet (Key.A, out KeyBinding bindings); - Assert.True (result); - Assert.Contains (Command.Refresh, bindings.Commands); - - } } diff --git a/Tests/UnitTestsParallelizable/Input/Keyboard/KeyTests.cs b/Tests/UnitTestsParallelizable/Input/Keyboard/KeyTests.cs index c62aea0f3..a532814e2 100644 --- a/Tests/UnitTestsParallelizable/Input/Keyboard/KeyTests.cs +++ b/Tests/UnitTestsParallelizable/Input/Keyboard/KeyTests.cs @@ -1,7 +1,7 @@ using System.Text; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.InputTests; +namespace InputTests; public class KeyTests { diff --git a/Tests/UnitTestsParallelizable/Input/Mouse/MouseBindingTests.cs b/Tests/UnitTestsParallelizable/Input/Mouse/MouseBindingTests.cs index 65ad17d07..b92d16c78 100644 --- a/Tests/UnitTestsParallelizable/Input/Mouse/MouseBindingTests.cs +++ b/Tests/UnitTestsParallelizable/Input/Mouse/MouseBindingTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.InputTests; +namespace InputTests; public class MouseBindingTests { diff --git a/Tests/UnitTestsParallelizable/Input/Mouse/MouseBindingsTests.cs b/Tests/UnitTestsParallelizable/Input/Mouse/MouseBindingsTests.cs index 94e5c14f5..501d97f9a 100644 --- a/Tests/UnitTestsParallelizable/Input/Mouse/MouseBindingsTests.cs +++ b/Tests/UnitTestsParallelizable/Input/Mouse/MouseBindingsTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.InputTests; +namespace InputTests; public class MouseBindingsTests { diff --git a/Tests/UnitTestsParallelizable/Input/Mouse/MouseEventArgsTest.cs b/Tests/UnitTestsParallelizable/Input/Mouse/MouseEventArgsTest.cs index 483a89d7b..331a7e198 100644 --- a/Tests/UnitTestsParallelizable/Input/Mouse/MouseEventArgsTest.cs +++ b/Tests/UnitTestsParallelizable/Input/Mouse/MouseEventArgsTest.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.InputTests; +namespace InputTests; public class MouseEventArgsTests { diff --git a/Tests/UnitTestsParallelizable/LocalPackagesTests.cs b/Tests/UnitTestsParallelizable/LocalPackagesTests.cs index 8076f726f..84608b798 100644 --- a/Tests/UnitTestsParallelizable/LocalPackagesTests.cs +++ b/Tests/UnitTestsParallelizable/LocalPackagesTests.cs @@ -1,5 +1,5 @@  -namespace UnitTests_Parallelizable.BuildAndDeployTests; +namespace BuildAndDeployTests; public class LocalPackagesTests { diff --git a/Tests/UnitTestsParallelizable/README.md b/Tests/UnitTestsParallelizable/README.md index b4a85152a..e3e2818b9 100644 --- a/Tests/UnitTestsParallelizable/README.md +++ b/Tests/UnitTestsParallelizable/README.md @@ -2,45 +2,12 @@ This project contains unit tests that can run in parallel without interference. Tests here must not depend on global state or static Application infrastructure. -## Migration Rules - -### Tests CAN be parallelized if they: -- ✅ Test properties, constructors, and basic operations -- ✅ Use `[SetupFakeDriver]` without Application statics -- ✅ Call `View.Draw()`, `LayoutAndDraw()` without Application statics -- ✅ Verify visual output with `DriverAssert` (when using `[SetupFakeDriver]`) -- ✅ Create View hierarchies without `Application.Top` -- ✅ Test events and behavior without global state -- ✅ Use `View.BeginInit()` / `View.EndInit()` for initialization - -### Tests CANNOT be parallelized if they: -- ❌ Use `[AutoInitShutdown]` - requires `Application.Init/Shutdown` which creates global state -- ❌ Set `Application.Driver` (global singleton) -- ❌ Call `Application.Init()`, `Application.Run/Run()`, or `Application.Begin()` -- ❌ Modify `ConfigurationManager` global state (Enable/Load/Apply/Disable) -- ❌ Access `ConfigurationManager` including `ThemeManager` and `SchemeManager` - these rely on global state -- ❌ Access `SchemeManager.GetSchemes()` or dictionary lookups like `schemes["Base"]` - requires module initialization -- ❌ Access `View.Schemes` - there can be weird interactions with xunit and dotnet module initialization such that tests run before module initialization sets up the Schemes array -- ❌ Modify static properties like `Key.Separator`, `CultureInfo.CurrentCulture`, etc. -- ❌ Set static members on View subclasses (e.g., configuration properties like `Dialog.DefaultButtonAlignment`) or any static fields/properties - these are shared across all parallel tests -- ❌ Use `Application.Top`, `Application.Driver`, `Application.MainLoop`, or `Application.Navigation` -- ❌ Are true integration tests that test multiple components working together - ### Important Notes -- Many tests in `UnitTests` blindly use the above patterns when they don't actually need them +- Many tests in `UnitTests` blindly use the the legacy model they don't actually need to - These tests CAN be rewritten to remove unnecessary dependencies and migrated here - Many tests APPEAR to be integration tests but are just poorly written and cover multiple surface areas - these can be split into focused unit tests - When in doubt, analyze if the test truly needs global state or can be refactored -## How to Migrate Tests - -1. **Identify** tests in `UnitTests` that don't actually need Application statics -2. **Rewrite** tests to remove `[AutoInitShutdown]`, `Application.Begin()`, etc. if not needed -3. **Move** the test to the equivalent file in `UnitTests.Parallelizable` -4. **Delete** the old test from `UnitTests` to avoid duplicates -5. **Verify** no duplicate test names exist (CI will check this) -6. **Test** to ensure the migrated test passes - ## Example Migrations ### Simple Property Test (no changes needed) @@ -62,11 +29,11 @@ public void Constructor_Sets_Defaults () } ``` -### Remove Unnecessary [SetupFakeDriver] +### Remove Unnecessary [SetupFakeApplication] ```csharp // Before (in UnitTests) [Fact] -[SetupFakeDriver] +[SetupFakeApplication] public void Event_Fires_When_Property_Changes () { var view = new Button (); @@ -96,7 +63,7 @@ public void Event_Fires_When_Property_Changes () public void Focus_Test () { var view = new Button (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (view); Application.Begin (top); view.SetFocus (); @@ -127,5 +94,5 @@ dotnet test Tests/UnitTestsParallelizable/UnitTests.Parallelizable.csproj ``` ## See Also -- [Category A Migration Summary](../CATEGORY_A_MIGRATION_SUMMARY.md) - Detailed analysis and migration guidelines + - [.NET Unit Testing Best Practices](https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-best-practices) diff --git a/Tests/UnitTestsParallelizable/Resources/ResourceManagerTests.cs b/Tests/UnitTestsParallelizable/Resources/ResourceManagerTests.cs index be18dbdb7..8cff633c7 100644 --- a/Tests/UnitTestsParallelizable/Resources/ResourceManagerTests.cs +++ b/Tests/UnitTestsParallelizable/Resources/ResourceManagerTests.cs @@ -6,7 +6,7 @@ using System.Resources; using System.Runtime.CompilerServices; using UnitTests; -namespace UnitTests_Parallelizable.ResourcesTests; +namespace ResourcesTests; public class ResourceManagerTests : FakeDriverBase { diff --git a/Tests/UnitTests/TestDateAttribute.cs b/Tests/UnitTestsParallelizable/TestDateAttribute.cs similarity index 95% rename from Tests/UnitTests/TestDateAttribute.cs rename to Tests/UnitTestsParallelizable/TestDateAttribute.cs index 5ad857a2f..a1333389d 100644 --- a/Tests/UnitTests/TestDateAttribute.cs +++ b/Tests/UnitTestsParallelizable/TestDateAttribute.cs @@ -2,7 +2,7 @@ using System.Reflection; using Xunit.Sdk; -namespace UnitTests; +namespace UnitTests_Parallelizable; [AttributeUsage (AttributeTargets.Class | AttributeTargets.Method)] public class TestDateAttribute : BeforeAfterTestAttribute diff --git a/Tests/UnitTestsParallelizable/TestSetup.cs b/Tests/UnitTestsParallelizable/TestSetup.cs index 2a6402c11..a1f79c587 100644 --- a/Tests/UnitTestsParallelizable/TestSetup.cs +++ b/Tests/UnitTestsParallelizable/TestSetup.cs @@ -24,8 +24,8 @@ public class GlobalTestSetup : IDisposable // Reset application state just in case a test changed something. // TODO: Add an Assert to ensure none of the state of Application changed. // TODO: Add an Assert to ensure none of the state of ConfigurationManager changed. + //Application.ResetState (true); CheckDefaultState (); - Application.ResetState (true); } // IMPORTANT: Ensure this matches the code in Init_ResetState_Resets_Properties @@ -39,15 +39,15 @@ public class GlobalTestSetup : IDisposable // Check that all Application fields and properties are set to their default values // Public Properties - Assert.Null (Application.Top); - Assert.Null (Application.Mouse.MouseGrabView); + //Assert.Null (Application.TopRunnable); + //Assert.Null (Application.Mouse.MouseGrabView); - // Don't check Application.ForceDriver - // Assert.Empty (Application.ForceDriver); - // Don't check Application.Force16Colors - //Assert.False (Application.Force16Colors); - Assert.Null (Application.Driver); - Assert.False (Application.StopAfterFirstIteration); + //// Don't check Application.ForceDriver + //Assert.Empty (Application.ForceDriver); + //// Don't check Application.Force16Colors + ////Assert.False (Application.Force16Colors); + //Assert.Null (Application.Driver); + //Assert.False (Application.StopAfterFirstIteration); Assert.Equal (Key.Tab.WithShift, Application.PrevTabKey); Assert.Equal (Key.Tab, Application.NextTabKey); Assert.Equal (Key.F6.WithShift, Application.PrevTabGroupKey); @@ -55,22 +55,22 @@ public class GlobalTestSetup : IDisposable Assert.Equal (Key.Esc, Application.QuitKey); // Internal properties - Assert.False (Application.Initialized); - Assert.Equal (Application.GetSupportedCultures (), Application.SupportedCultures); - Assert.Equal (Application.GetAvailableCulturesFromEmbeddedResources (), Application.SupportedCultures); - Assert.Null (Application.MainThreadId); - Assert.Empty (Application.TopLevels); - Assert.Empty (Application.CachedViewsUnderMouse); + //Assert.False (Application.Initialized); + //Assert.Equal (Application.GetSupportedCultures (), Application.SupportedCultures); + //Assert.Equal (Application.GetAvailableCulturesFromEmbeddedResources (), Application.SupportedCultures); + //Assert.Null (Application.MainThreadId); + //Assert.Empty (Application.SessionStack); + //Assert.Empty (Application.CachedViewsUnderMouse); // Mouse // Do not reset _lastMousePosition //Assert.Null (Application._lastMousePosition); // Navigation - Assert.Null (Application.Navigation); + // Assert.Null (Application.Navigation); // Popover - Assert.Null (Application.Popover); + //Assert.Null (Application.Popover); // Events - Can't check //Assert.Null (Application.SessionBegun); diff --git a/Tests/UnitTestsParallelizable/Text/AutocompleteTests.cs b/Tests/UnitTestsParallelizable/Text/AutocompleteTests.cs index 58eb364d8..d27709977 100644 --- a/Tests/UnitTestsParallelizable/Text/AutocompleteTests.cs +++ b/Tests/UnitTestsParallelizable/Text/AutocompleteTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.TextTests; +namespace TextTests; /// /// Pure unit tests for Autocomplete functionality that don't require Application or Driver. diff --git a/Tests/UnitTestsParallelizable/Text/CollectionNavigatorTests.cs b/Tests/UnitTestsParallelizable/Text/CollectionNavigatorTests.cs index c3fce7af4..f998f9ba8 100644 --- a/Tests/UnitTestsParallelizable/Text/CollectionNavigatorTests.cs +++ b/Tests/UnitTestsParallelizable/Text/CollectionNavigatorTests.cs @@ -1,7 +1,9 @@ -using Moq; +using System.Collections; +using System.Collections.Concurrent; +using Moq; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.TextTests; +namespace TextTests; public class CollectionNavigatorTests { @@ -41,8 +43,8 @@ public class CollectionNavigatorTests Assert.Equal (2, n.GetNextMatchingItem (4, 'b')); // cycling with 'a' - n = new CollectionNavigator (simpleStrings); - Assert.Equal (0, n.GetNextMatchingItem (-1, 'a')); + n = new (simpleStrings); + Assert.Equal (0, n.GetNextMatchingItem (null, 'a')); Assert.Equal (1, n.GetNextMatchingItem (0, 'a')); // if 4 (candle) is selected it should loop back to apricot @@ -53,7 +55,7 @@ public class CollectionNavigatorTests public void Delay () { var strings = new [] { "$$", "$100.00", "$101.00", "$101.10", "$200.00", "apricot" }; - var current = 0; + int? current = 0; var n = new CollectionNavigator (strings); // No delay @@ -96,7 +98,7 @@ public class CollectionNavigatorTests var strings = new [] { "apricot", "arm", "ta", "target", "text", "egg", "candle" }; var n = new CollectionNavigator (strings); - var current = 0; + int? current = 0; Assert.Equal (strings.IndexOf ("ta"), current = n.GetNextMatchingItem (current, 't')); // should match "te" in "text" @@ -137,7 +139,7 @@ public class CollectionNavigatorTests public void MinimizeMovement_False_ShouldMoveIfMultipleMatches () { var strings = new [] { "$$", "$100.00", "$101.00", "$101.10", "$200.00", "apricot", "c", "car", "cart" }; - var current = 0; + int? current = 0; var n = new CollectionNavigator (strings); Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, "$$")); Assert.Equal (strings.IndexOf ("$100.00"), current = n.GetNextMatchingItem (current, "$")); @@ -166,14 +168,14 @@ public class CollectionNavigatorTests Assert.Equal (strings.IndexOf ("car"), current = n.GetNextMatchingItem (current, "car")); Assert.Equal (strings.IndexOf ("cart"), current = n.GetNextMatchingItem (current, "car")); - Assert.Equal (-1, current = n.GetNextMatchingItem (current, "x")); + Assert.Null (n.GetNextMatchingItem (current, "x")); } [Fact] public void MinimizeMovement_True_ShouldStayOnCurrentIfMultipleMatches () { var strings = new [] { "$$", "$100.00", "$101.00", "$101.10", "$200.00", "apricot", "c", "car", "cart" }; - var current = 0; + int? current = 0; var n = new CollectionNavigator (strings); Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, "$$", true)); Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, "$", true)); @@ -185,14 +187,14 @@ public class CollectionNavigatorTests Assert.Equal (strings.IndexOf ("car"), current = n.GetNextMatchingItem (current, "car", true)); Assert.Equal (strings.IndexOf ("car"), current = n.GetNextMatchingItem (current, "car", true)); - Assert.Equal (-1, current = n.GetNextMatchingItem (current, "x", true)); + Assert.Null (n.GetNextMatchingItem (current, "x", true)); } [Fact] public void MutliKeySearchPlusWrongKeyStays () { var strings = new [] { "a", "c", "can", "candle", "candy", "yellow", "zebra" }; - var current = 0; + int? current = 0; var n = new CollectionNavigator (strings); // https://github.com/gui-cs/Terminal.Gui/pull/2132#issuecomment-1298425573 @@ -240,20 +242,20 @@ public class CollectionNavigatorTests } [Fact] - public void ShouldAcceptNegativeOne () + public void ShouldAcceptNull () { var n = new CollectionNavigator (simpleStrings); - // Expect that index of -1 (i.e. no selection) should work correctly + // Expect that index of null (i.e. no selection) should work correctly // and select the first entry of the letter 'b' - Assert.Equal (2, n.GetNextMatchingItem (-1, 'b')); + Assert.Equal (2, n.GetNextMatchingItem (null, 'b')); } [Fact] public void Symbols () { var strings = new [] { "$$", "$100.00", "$101.00", "$101.10", "$200.00", "apricot" }; - var current = 0; + int? current = 0; var n = new CollectionNavigator (strings); Assert.Equal (strings.IndexOf ("apricot"), current = n.GetNextMatchingItem (current, 'a')); Assert.Equal ("a", n.SearchString); @@ -293,7 +295,7 @@ public class CollectionNavigatorTests var strings = new [] { "apricot", "arm", "ta", "丗丙业丞", "丗丙丛", "text", "egg", "candle" }; var n = new CollectionNavigator (strings); - var current = 0; + int? current = 0; Assert.Equal (strings.IndexOf ("丗丙业丞"), current = n.GetNextMatchingItem (current, '丗')); // 丗丙业丞 is as good a match as 丗丙丛 @@ -319,7 +321,7 @@ public class CollectionNavigatorTests public void Word () { var strings = new [] { "apricot", "arm", "bat", "batman", "bates hotel", "candle" }; - var current = 0; + int? current = 0; var n = new CollectionNavigator (strings); Assert.Equal (strings.IndexOf ("bat"), current = n.GetNextMatchingItem (current, 'b')); // match bat Assert.Equal (strings.IndexOf ("bat"), current = n.GetNextMatchingItem (current, 'a')); // match bat @@ -340,14 +342,15 @@ public class CollectionNavigatorTests current = n.GetNextMatchingItem (current, ' ') ); // match bates hotel } + [Fact] public void CustomMatcher_NeverMatches () { var strings = new [] { "apricot", "arm", "bat", "batman", "bates hotel", "candle" }; - var current = 0; + int? current = 0; var n = new CollectionNavigator (strings); - var matchNone = new Mock (); + Mock matchNone = new (); matchNone.Setup (m => m.IsMatch (It.IsAny (), It.IsAny ())) .Returns (false); @@ -358,4 +361,246 @@ public class CollectionNavigatorTests Assert.Equal (0, current = n.GetNextMatchingItem (current, 'a')); // no matches Assert.Equal (0, current = n.GetNextMatchingItem (current, 't')); // no matches } + + #region Thread Safety Tests + + [Fact] + public void ThreadSafety_ConcurrentSearchStringAccess () + { + var strings = new [] { "apricot", "arm", "bat", "batman", "candle" }; + var navigator = new CollectionNavigator (strings); + var numTasks = 20; + ConcurrentBag exceptions = new (); + + Parallel.For ( + 0, + numTasks, + i => + { + try + { + // Read SearchString concurrently + string searchString = navigator.SearchString; + + // Perform navigation operations concurrently + int? result = navigator.GetNextMatchingItem (0, 'a'); + + // Read SearchString again + searchString = navigator.SearchString; + } + catch (Exception ex) + { + exceptions.Add (ex); + } + }); + + Assert.Empty (exceptions); + } + + [Fact] + public void ThreadSafety_ConcurrentCollectionAccess () + { + var strings = new [] { "apricot", "arm", "bat", "batman", "candle" }; + var navigator = new CollectionNavigator (strings); + var numTasks = 20; + ConcurrentBag exceptions = new (); + + Parallel.For ( + 0, + numTasks, + i => + { + try + { + // Access Collection property concurrently + IList collection = navigator.Collection; + + // Perform navigation + int? result = navigator.GetNextMatchingItem (0, (char)('a' + i % 3)); + } + catch (Exception ex) + { + exceptions.Add (ex); + } + }); + + Assert.Empty (exceptions); + } + + [Fact] + public void ThreadSafety_ConcurrentNavigationOperations () + { + var strings = new [] { "apricot", "arm", "bat", "batman", "candle", "cat", "dog", "elephant" }; + var navigator = new CollectionNavigator (strings); + var numTasks = 50; + ConcurrentBag results = new (); + ConcurrentBag exceptions = new (); + + Parallel.For ( + 0, + numTasks, + i => + { + try + { + var searchChar = (char)('a' + i % 5); + int? result = navigator.GetNextMatchingItem (i % strings.Length, searchChar); + results.Add (result); + } + catch (Exception ex) + { + exceptions.Add (ex); + } + }); + + Assert.Empty (exceptions); + Assert.Equal (numTasks, results.Count); + } + + [Fact] + public void ThreadSafety_ConcurrentCollectionModification () + { + var strings = new [] { "apricot", "arm", "bat", "batman", "candle" }; + var navigator = new CollectionNavigator (strings); + var numReaders = 10; + var numWriters = 5; + ConcurrentBag exceptions = new (); + List tasks = new (); + + // Reader tasks + for (var i = 0; i < numReaders; i++) + { + tasks.Add ( + Task.Run (() => + { + try + { + for (var j = 0; j < 100; j++) + { + int? result = navigator.GetNextMatchingItem (0, 'a'); + string searchString = navigator.SearchString; + } + } + catch (Exception ex) + { + exceptions.Add (ex); + } + })); + } + + // Writer tasks (change Collection reference) + for (var i = 0; i < numWriters; i++) + { + int writerIndex = i; + + tasks.Add ( + Task.Run (() => + { + try + { + for (var j = 0; j < 50; j++) + { + var newStrings = new [] { $"item{writerIndex}_{j}_1", $"item{writerIndex}_{j}_2" }; + navigator.Collection = newStrings; + Thread.Sleep (1); // Small delay to increase contention + } + } + catch (Exception ex) + { + exceptions.Add (ex); + } + })); + } + +#pragma warning disable xUnit1031 + Task.WaitAll (tasks.ToArray ()); +#pragma warning restore xUnit1031 + + // Allow some exceptions due to collection being swapped during access + // but verify no deadlocks occurred (all tasks completed) + Assert.True (tasks.All (t => t.IsCompleted)); + } + + [Fact] + public void ThreadSafety_ConcurrentSearchStringChanges () + { + var strings = new [] { "apricot", "arm", "bat", "batman", "candle", "cat", "dog", "elephant", "fox", "goat" }; + var navigator = new CollectionNavigator (strings); + var numTasks = 30; + ConcurrentBag exceptions = new (); + ConcurrentBag searchStrings = new (); + + Parallel.For ( + 0, + numTasks, + i => + { + try + { + // Each task performs multiple searches rapidly + char [] chars = { 'a', 'b', 'c', 'd', 'e', 'f' }; + + foreach (char c in chars) + { + navigator.GetNextMatchingItem (0, c); + searchStrings.Add (navigator.SearchString); + } + } + catch (Exception ex) + { + exceptions.Add (ex); + } + }); + + Assert.Empty (exceptions); + Assert.NotEmpty (searchStrings); + } + + [Fact] + public void ThreadSafety_StressTest_RapidOperations () + { + var strings = new string [100]; + + for (var i = 0; i < 100; i++) + { + strings [i] = $"item_{i:D3}"; + } + + var navigator = new CollectionNavigator (strings); + var numTasks = 100; + var operationsPerTask = 1000; + ConcurrentBag exceptions = new (); + + Parallel.For ( + 0, + numTasks, + i => + { + try + { + var random = new Random (i); + + for (var j = 0; j < operationsPerTask; j++) + { + int? currentIndex = random.Next (0, strings.Length); + var searchChar = (char)('a' + random.Next (0, 26)); + + navigator.GetNextMatchingItem (currentIndex, searchChar); + + if (j % 100 == 0) + { + string searchString = navigator.SearchString; + } + } + } + catch (Exception ex) + { + exceptions.Add (ex); + } + }); + + Assert.Empty (exceptions); + } + + #endregion Thread Safety Tests } diff --git a/Tests/UnitTestsParallelizable/Text/RuneTests.cs b/Tests/UnitTestsParallelizable/Text/RuneTests.cs index 34214d6ef..a2ec053f9 100644 --- a/Tests/UnitTestsParallelizable/Text/RuneTests.cs +++ b/Tests/UnitTestsParallelizable/Text/RuneTests.cs @@ -2,7 +2,7 @@ using System.Globalization; using System.Text; -namespace UnitTests_Parallelizable.TextTests; +namespace TextTests; public class RuneTests { @@ -88,7 +88,7 @@ public class RuneTests 1 )] // the letters 법 join to form the Korean word for "rice:" U+BC95 법 (read from top left to bottom right) [InlineData ("\U0001F468\u200D\U0001F469\u200D\U0001F467", "👨‍👩‍👧", 8, 2, 8)] // Man, Woman and Girl emoji. - [InlineData ("\u0915\u093f", "कि", 2, 1, 2)] // Hindi कि with DEVANAGARI LETTER KA and DEVANAGARI VOWEL SIGN I + //[InlineData ("\u0915\u093f", "कि", 2, 2, 2)] // Hindi कि with DEVANAGARI LETTER KA and DEVANAGARI VOWEL SIGN I [InlineData ( "\u0e4d\u0e32", "ํา", @@ -213,7 +213,7 @@ public class RuneTests [InlineData ( '\u1161', "ᅡ", - 1, + 0, 1, 3 )] // ᅡ Hangul Jungseong A - Unicode Hangul Jamo for join with column width equal to 0 alone. @@ -231,7 +231,7 @@ public class RuneTests )] // ䷀Hexagram For The Creative Heaven - U+4dc0 - https://github.com/microsoft/terminal/blob/main/src/types/unicode_width_overrides.xml // See https://github.com/microsoft/terminal/issues/19389 - [InlineData ('\ud7b0', "ힰ", 1, 1, 3)] // ힰ ┤Hangul Jungseong O-Yeo - ힰ U+d7b0')] + [InlineData ('\ud7b0', "ힰ", 0, 1, 3)] // ힰ ┤Hangul Jungseong O-Yeo - ힰ U+d7b0')] [InlineData ('\uf61e', "", 1, 1, 3)] // Private Use Area [InlineData ('\u23f0', "⏰", 2, 1, 3)] // Alarm Clock - ⏰ U+23f0 [InlineData ('\u1100', "ᄀ", 2, 1, 3)] // ᄀ Hangul Choseong Kiyeok @@ -365,6 +365,42 @@ public class RuneTests [InlineData ('\ud801')] public void Rune_Exceptions_Integers (int code) { Assert.Throws (() => new Rune (code)); } + [Theory] + // Control characters (should be mapped to Control Pictures) + [InlineData ('\u0000', 0x2400)] // NULL → ␀ + [InlineData ('\u0009', 0x2409)] // TAB → ␉ + [InlineData ('\u000A', 0x240A)] // LF → ␊ + [InlineData ('\u000D', 0x240D)] // CR → ␍ + + // Printable characters (should remain unchanged) + [InlineData ('A', 'A')] + [InlineData (' ', ' ')] + [InlineData ('~', '~')] + public void MakePrintable_ReturnsExpected (char inputChar, int expectedCodePoint) + { + // Arrange + Rune input = new Rune (inputChar); + + // Act + Rune result = input.MakePrintable (); + + // Assert + Assert.Equal (expectedCodePoint, result.Value); + } + + [Fact] + public void MakePrintable_SupplementaryRune_RemainsUnchanged () + { + // Arrange: supplementary character outside BMP (not a control) + Rune input = new Rune (0x1F600); // 😀 grinning face emoji + + // Act + Rune result = input.MakePrintable (); + + // Assert + Assert.Equal (input.Value, result.Value); + } + [Theory] [InlineData (new [] { '\ud799', '\udc21' })] public void Rune_Exceptions_Utf16_Encode (char [] code) @@ -697,16 +733,16 @@ public class RuneTests [Theory] [InlineData ('\uea85', null, "", false)] // Private Use Area [InlineData (0x1F356, new [] { '\ud83c', '\udf56' }, "🍖", true)] // 🍖 Meat On Bone - public void Test_DecodeSurrogatePair (int code, char [] charsValue, string runeString, bool isSurrogatePair) + public void Test_DecodeSurrogatePair (int code, char []? charsValue, string runeString, bool isSurrogatePair) { var rune = new Rune (code); - char [] chars; + char []? chars; if (isSurrogatePair) { Assert.True (rune.DecodeSurrogatePair (out chars)); - Assert.Equal (2, chars.Length); - Assert.Equal (charsValue [0], chars [0]); + Assert.Equal (2, chars!.Length); + Assert.Equal (charsValue! [0], chars [0]); Assert.Equal (charsValue [1], chars [1]); Assert.Equal (runeString, new Rune (chars [0], chars [1]).ToString ()); } @@ -954,11 +990,9 @@ public class RuneTests Assert.Equal (runeCount, us.GetRuneCount ()); Assert.Equal (stringCount, s.Length); - TextElementEnumerator enumerator = StringInfo.GetTextElementEnumerator (s); - var textElementCount = 0; - while (enumerator.MoveNext ()) + foreach (string _ in GraphemeHelper.GetGraphemes (s)) { textElementCount++; // For versions prior to Net5.0 the StringInfo class might handle some grapheme clusters incorrectly. } @@ -1064,4 +1098,95 @@ public class RuneTests return true; } + + [Theory] + [InlineData (0x0041, new byte [] { 0x41 })] // 'A', ASCII + [InlineData (0x00E9, new byte [] { 0xC3, 0xA9 })] // 'é', 2-byte UTF-8 + [InlineData (0x20AC, new byte [] { 0xE2, 0x82, 0xAC })] // '€', 3-byte UTF-8 + [InlineData (0x1F600, new byte [] { 0xF0, 0x9F, 0x98, 0x80 })] // 😀 emoji, 4-byte UTF-8 + public void Encode_WritesExpectedBytes (int codePoint, byte [] expectedBytes) + { + // Arrange + Rune rune = new Rune (codePoint); + byte [] buffer = new byte [10]; // extra space + for (int i = 0; i < buffer.Length; i++) + { + buffer [i] = 0xFF; + } + + // Act + int written = rune.Encode (buffer); + + // Assert + Assert.Equal (expectedBytes.Length, written); + for (int i = 0; i < written; i++) + { + Assert.Equal (expectedBytes [i], buffer [i]); + } + } + + [Fact] + public void Encode_WithStartAndCount_WritesPartialBytes () + { + // Arrange: U+1F600 😀 (4 bytes) + Rune rune = new Rune (0x1F600); + byte [] buffer = new byte [10]; + for (int i = 0; i < buffer.Length; i++) + { + buffer [i] = 0xFF; + } + + // Act: write starting at index 2, limit count to 2 bytes + int written = rune.Encode (buffer, start: 2, count: 2); + + // Assert + Assert.Equal (2, written); + // Original UTF-8 bytes: F0 9F 98 80 + Assert.Equal (0xF0, buffer [2]); + Assert.Equal (0x9F, buffer [3]); + // Remaining buffer untouched + Assert.Equal (0xFF, buffer [0]); + Assert.Equal (0xFF, buffer [1]); + Assert.Equal (0xFF, buffer [4]); + } + + [Fact] + public void Encode_WithCountGreaterThanRuneBytes_WritesAllBytes () + { + // Arrange: é → C3 A9 + Rune rune = new Rune ('é'); + byte [] buffer = new byte [10]; + for (int i = 0; i < buffer.Length; i++) + { + buffer [i] = 0xFF; + } + + // Act: count larger than needed + int written = rune.Encode (buffer, start: 1, count: 10); + + // Assert + Assert.Equal (2, written); + Assert.Equal (0xC3, buffer [1]); + Assert.Equal (0xA9, buffer [2]); + Assert.Equal (0xFF, buffer [3]); // next byte untouched + } + + [Fact] + public void Encode_ZeroCount_WritesNothing () + { + Rune rune = new Rune ('A'); + byte [] buffer = new byte [5]; + for (int i = 0; i < buffer.Length; i++) + { + buffer [i] = 0xFF; + } + + int written = rune.Encode (buffer, start: 0, count: 0); + + Assert.Equal (0, written); + foreach (var b in buffer) + { + Assert.Equal (0xFF, b); // buffer untouched + } + } } diff --git a/Tests/UnitTestsParallelizable/Text/StringTests.cs b/Tests/UnitTestsParallelizable/Text/StringTests.cs index 80c52b96e..1c6e848cd 100644 --- a/Tests/UnitTestsParallelizable/Text/StringTests.cs +++ b/Tests/UnitTestsParallelizable/Text/StringTests.cs @@ -1,9 +1,16 @@ -namespace UnitTests_Parallelizable.TextTests; +namespace TextTests; #nullable enable public class StringTests { + [Fact] + public void TestGetColumns_Null () + { + string? str = null; + Assert.Equal (0, str!.GetColumns ()); + } + [Fact] public void TestGetColumns_Empty () { @@ -11,6 +18,20 @@ public class StringTests Assert.Equal (0, str.GetColumns ()); } + [Fact] + public void TestGetColumns_SingleRune () + { + var str = "a"; + Assert.Equal (1, str.GetColumns ()); + } + + [Fact] + public void TestGetColumns_Zero_Width () + { + var str = "\u200D"; + Assert.Equal (0, str.GetColumns ()); + } + [Theory] [InlineData ("a", 1)] [InlineData ("á", 1)] @@ -30,39 +51,37 @@ public class StringTests // Test known wide codepoints [Theory] - [InlineData ("🙂", 2)] - [InlineData ("a🙂", 3)] - [InlineData ("🙂a", 3)] - [InlineData ("👨‍👩‍👦‍👦", 2)] - [InlineData ("👨‍👩‍👦‍👦🙂", 4)] - [InlineData ("👨‍👩‍👦‍👦🙂a", 5)] - [InlineData ("👨‍👩‍👦‍👦a🙂", 5)] - [InlineData ("👨‍👩‍👦‍👦👨‍👩‍👦‍👦", 4)] - [InlineData ("山", 2)] // The character for "mountain" in Chinese/Japanese/Korean (山), Unicode U+5C71 - [InlineData ("山🙂", 4)] // The character for "mountain" in Chinese/Japanese/Korean (山), Unicode U+5C71 - //[InlineData ("\ufe20\ufe21", 2)] // Combining Ligature Left Half ︠ - U+fe20 -https://github.com/microsoft/terminal/blob/main/src/types/unicode_width_overrides.xml - // // Combining Ligature Right Half - U+fe21 -https://github.com/microsoft/terminal/blob/main/src/types/unicode_width_overrides.xml - public void TestGetColumns_MultiRune_WideBMP (string str, int expected) { Assert.Equal (expected, str.GetColumns ()); } - - [Fact] - public void TestGetColumns_Null () + [InlineData ("🙂", 2, 1, 2)] + [InlineData ("a🙂", 3, 2, 3)] + [InlineData ("🙂a", 3, 2, 3)] + [InlineData ("👨‍👩‍👦‍👦", 8, 1, 2)] + [InlineData ("👨‍👩‍👦‍👦🙂", 10, 2, 4)] + [InlineData ("👨‍👩‍👦‍👦🙂a", 11, 3, 5)] + [InlineData ("👨‍👩‍👦‍👦a🙂", 11, 3, 5)] + [InlineData ("👨‍👩‍👦‍👦👨‍👩‍👦‍👦", 16, 2, 4)] + [InlineData ("าำ", 2, 1, 2)] // า U+0E32 - THAI CHARACTER SARA AA with ำ U+0E33 - THAI CHARACTER SARA AM + [InlineData ("山", 2, 1, 2)] // The character for "mountain" in Chinese/Japanese/Korean (山), Unicode U+5C71 + [InlineData ("山🙂", 4, 2, 4)] // The character for "mountain" in Chinese/Japanese/Korean (山), Unicode U+5C71 + [InlineData ("a\ufe20e\ufe21", 2, 2, 2)] // Combining Ligature Left Half ︠ - U+fe20 -https://github.com/microsoft/terminal/blob/main/src/types/unicode_width_overrides.xml + // Combining Ligature Right Half - U+fe21 -https://github.com/microsoft/terminal/blob/main/src/types/unicode_width_overrides.xml + //[InlineData ("क", 1, 1, 1)] // क U+0915 Devanagari Letter Ka + //[InlineData ("ि", 1, 1, 1)] // U+093F Devanagari Vowel Sign I ि (i-kar). + //[InlineData ("कि", 2, 1, 2)] // "कि" is U+0915 for the base consonant "क" with U+093F for the vowel sign "ि" (i-kar). + [InlineData ("ᄀ", 2, 1, 2)] // ᄀ U+1100 HANGUL CHOSEONG KIYEOK (consonant) + [InlineData ("ᅡ", 0, 1, 0)] // ᅡ U+1161 HANGUL JUNGSEONG A (vowel) + [InlineData ("가", 2, 1, 2)] // ᄀ U+1100 HANGUL CHOSEONG KIYEOK (consonant) with ᅡ U+1161 HANGUL JUNGSEONG A (vowel) + [InlineData ("ᄒ", 2, 1, 2)] // ᄒ U+1112 Hangul Choseong Hieuh + [InlineData ("ᅵ", 0, 1, 0)] // ᅵ U+1175 Hangul Jungseong I + [InlineData ("ᇂ", 0, 1, 0)] // ᇂ U+11C2 Hangul Jongseong Hieuh + [InlineData ("힣", 2, 1, 2)] // ᄒ (choseong h) + ᅵ (jungseong i) + ᇂ (jongseong h) + [InlineData ("ힰ", 0, 1, 0)] // U+D7B0 ힰ Hangul Jungseong O-Yeo + [InlineData ("ᄀힰ", 2, 1, 2)] // ᄀ U+1100 HANGUL CHOSEONG KIYEOK (consonant) with U+D7B0 ힰ Hangul Jungseong O-Yeo + //[InlineData ("षि", 2, 1, 2)] // U+0937 ष DEVANAGARI LETTER SSA with U+093F ि COMBINING DEVANAGARI VOWEL SIGN I + public void TestGetColumns_MultiRune_WideBMP_Graphemes (string str, int expectedRunesWidth, int expectedGraphemesCount, int expectedWidth) { - string? str = null; - Assert.Equal (0, str!.GetColumns ()); - } - - [Fact] - public void TestGetColumns_SingleRune () - { - var str = "a"; - Assert.Equal (1, str.GetColumns ()); - } - - [Fact] - public void TestGetColumns_Zero_Width () - { - var str = "\u200D"; - Assert.Equal (0, str.GetColumns ()); + Assert.Equal (expectedRunesWidth, str.EnumerateRunes ().Sum (r => r.GetColumns ())); + Assert.Equal (expectedGraphemesCount, GraphemeHelper.GetGraphemes (str).ToArray ().Length); + Assert.Equal (expectedWidth, str.GetColumns ()); } [Theory] @@ -70,13 +89,124 @@ public class StringTests [InlineData ("")] public void TestGetColumns_Does_Not_Throws_With_Null_And_Empty_String (string? text) { - if (text is null) + // ReSharper disable once InvokeAsExtensionMethod + Assert.Equal (0, StringExtensions.GetColumns (text!)); + } + + public class ReadOnlySpanExtensionsTests + { + [Theory] + [InlineData ("12345", true)] // all ASCII digits + [InlineData ("0", true)] // single ASCII digit + [InlineData ("", false)] // empty span + [InlineData ("12a45", false)] // contains a letter + [InlineData ("１２３", false)] // full-width Unicode digits (not ASCII) + [InlineData ("12 34", false)] // contains space + [InlineData ("١٢٣", false)] // Arabic-Indic digits + public void IsAllAsciiDigits_WorksAsExpected (string input, bool expected) { - Assert.Equal (0, StringExtensions.GetColumns (text!)); - } - else - { - Assert.Equal (0, text.GetColumns ()); + // Arrange + ReadOnlySpan span = input.AsSpan (); + + // Act + bool result = span.IsAllAsciiDigits (); + + // Assert + Assert.Equal (expected, result); } } + + [Theory] + [InlineData ("0", true)] + [InlineData ("9", true)] + [InlineData ("A", true)] + [InlineData ("F", true)] + [InlineData ("a", true)] + [InlineData ("f", true)] + [InlineData ("123ABC", true)] + [InlineData ("abcdef", true)] + [InlineData ("G", false)] // 'G' not hex + [InlineData ("Z9", false)] // 'Z' not hex + [InlineData ("12 34", false)] // space not hex + [InlineData ("", false)] // empty string + [InlineData ("１２３", false)] // full-width digits, not ASCII + [InlineData ("0xFF", false)] // includes 'x' + public void IsAllAsciiHexDigits_ReturnsExpected (string input, bool expected) + { + // Arrange + ReadOnlySpan span = input.AsSpan (); + + // Act + bool result = span.IsAllAsciiHexDigits (); + + // Assert + Assert.Equal (expected, result); + } + + [Theory] + [MemberData (nameof (GetStringConcatCases))] + public void ToString_ReturnsExpected (IEnumerable input, string expected) + { + // Act + string result = StringExtensions.ToString (input); + + // Assert + Assert.Equal (expected, result); + } + + public static IEnumerable GetStringConcatCases () + { + yield return [new string [] { }, string.Empty]; // Empty sequence + yield return [new [] { "" }, string.Empty]; // Single empty string + yield return [new [] { "A" }, "A"]; // Single element + yield return [new [] { "A", "B" }, "AB"]; // Simple concatenation + yield return [new [] { "Hello", " ", "World" }, "Hello World"]; // Multiple parts + yield return [new [] { "123", "456", "789" }, "123456789"]; // Numeric strings + yield return [new [] { "👩‍", "🧒" }, "👩‍🧒"]; // Grapheme sequence + yield return [new [] { "α", "β", "γ" }, "αβγ"]; // Unicode letters + yield return [new [] { "A", null, "B" }, "AB"]; // Null ignored by string.Concat + } + + [Theory] + [InlineData ("", false)] // Empty string + [InlineData ("A", false)] // Single BMP character + [InlineData ("AB", false)] // Two BMP chars, not a surrogate pair + [InlineData ("👩", true)] // Single emoji surrogate pair (U+1F469) + [InlineData ("🧒", true)] // Another emoji surrogate pair (U+1F9D2) + [InlineData ("𐍈", true)] // Gothic letter hwair (U+10348) + [InlineData ("A👩", false)] // One BMP + one surrogate half + [InlineData ("👩‍", false)] // Surrogate pair + ZWJ (length != 2) + public void IsSurrogatePair_ReturnsExpected (string input, bool expected) + { + // Act + bool result = input.IsSurrogatePair (); + + // Assert + Assert.Equal (expected, result); + } + + [Theory] + // Control characters (should be replaced with the "Control Pictures" block) + [InlineData ("\u0000", "\u2400")] // NULL → ␀ + [InlineData ("\u0009", "\u2409")] // TAB → ␉ + [InlineData ("\u000A", "\u240A")] // LF → ␊ + [InlineData ("\u000D", "\u240D")] // CR → ␍ + + // Printable characters (should remain unchanged) + [InlineData ("A", "A")] + [InlineData (" ", " ")] + [InlineData ("~", "~")] + + // Multi-character string (should return unchanged) + [InlineData ("AB", "AB")] + [InlineData ("Hello", "Hello")] + [InlineData ("\u0009A", "\u0009A")] // includes a control char, but length > 1 + public void MakePrintable_ReturnsExpected (string input, string expected) + { + // Act + string result = input.MakePrintable (); + + // Assert + Assert.Equal (expected, result); + } } diff --git a/Tests/UnitTestsParallelizable/Text/TextFormatterDrawTests.cs b/Tests/UnitTestsParallelizable/Text/TextFormatterDrawTests.cs index 0c142f08b..222d58c7f 100644 --- a/Tests/UnitTestsParallelizable/Text/TextFormatterDrawTests.cs +++ b/Tests/UnitTestsParallelizable/Text/TextFormatterDrawTests.cs @@ -1,11 +1,12 @@ #nullable enable using System.Text; using UICatalog; +using UnitTests; using Xunit.Abstractions; // Alias Console to MockConsole so we don't accidentally use Console -namespace UnitTests.TextTests; +namespace TextTests; public class TextFormatterDrawTests (ITestOutputHelper output) : FakeDriverBase { @@ -36,7 +37,7 @@ public class TextFormatterDrawTests (ITestOutputHelper output) : FakeDriverBase tf.ConstrainToWidth = width; tf.ConstrainToHeight = height; - tf.Draw (new (0, 0, width, height), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (0, 0, width, height), normalColor: Attribute.Default, hotColor: Attribute.Default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } @@ -65,7 +66,7 @@ public class TextFormatterDrawTests (ITestOutputHelper output) : FakeDriverBase tf.ConstrainToWidth = width; tf.ConstrainToHeight = height; - tf.Draw (new (0, 0, width, height), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (0, 0, width, height), normalColor: Attribute.Default, hotColor: Attribute.Default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } @@ -105,7 +106,7 @@ public class TextFormatterDrawTests (ITestOutputHelper output) : FakeDriverBase tf.ConstrainToWidth = width; tf.ConstrainToHeight = height; - tf.Draw (new (Point.Empty, new (width, height)), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (Point.Empty, new (width, height)), normalColor: Attribute.Default, hotColor: Attribute.Default); Rectangle rect = DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); Assert.Equal (expectedY, rect.Y); } @@ -134,7 +135,7 @@ public class TextFormatterDrawTests (ITestOutputHelper output) : FakeDriverBase tf.ConstrainToWidth = width; tf.ConstrainToHeight = height; - tf.Draw (new (0, 0, width, height), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (0, 0, width, height), normalColor: Attribute.Default, hotColor: Attribute.Default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } @@ -163,7 +164,7 @@ public class TextFormatterDrawTests (ITestOutputHelper output) : FakeDriverBase tf.ConstrainToWidth = width; tf.ConstrainToHeight = height; - tf.Draw (new (0, 0, width, height), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (0, 0, width, height), normalColor: Attribute.Default, hotColor: Attribute.Default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } @@ -217,7 +218,7 @@ s")] tf.ConstrainToWidth = width; tf.ConstrainToHeight = height; - tf.Draw (new (0, 0, 20, 20), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (0, 0, 20, 20), normalColor: Attribute.Default, hotColor: Attribute.Default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } @@ -267,7 +268,7 @@ s")] tf.ConstrainToWidth = width; tf.ConstrainToHeight = height; - tf.Draw (new (0, 0, 5, height), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (0, 0, 5, height), normalColor: Attribute.Default, hotColor: Attribute.Default); Rectangle rect = DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); Assert.Equal (expectedY, rect.Y); @@ -328,7 +329,7 @@ B ")] tf.ConstrainToWidth = 5; tf.ConstrainToHeight = height; - tf.Draw (new (0, 0, 5, height), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (0, 0, 5, height), normalColor: Attribute.Default, hotColor: Attribute.Default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } @@ -346,11 +347,7 @@ B ")] }; var tf = new TextFormatter { ConstrainToSize = new (14, 3), Text = "Test\nTest long\nTest long long\n", MultiLine = true }; - tf.Draw ( - new (1, 1, 19, 3), - attrs [1], - attrs [2], - driver: driver); + tf.Draw (driver: driver, screen: new (1, 1, 19, 3), normalColor: attrs [1], hotColor: attrs [2]); Assert.False (tf.FillRemaining); @@ -375,11 +372,7 @@ B ")] tf.FillRemaining = true; - tf.Draw ( - new (1, 1, 19, 3), - attrs [1], - attrs [2], - driver: driver); + tf.Draw (driver: driver, screen: new (1, 1, 19, 3), normalColor: attrs [1], hotColor: attrs [2]); DriverAssert.AssertDriverAttributesAre ( @" @@ -422,7 +415,7 @@ Nice Work")] MultiLine = true }; - tf.Draw (new (0, 0, width, height), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (0, 0, width, height), normalColor: Attribute.Default, hotColor: Attribute.Default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } @@ -434,7 +427,7 @@ Nice Work")] TextFormatter tf = new () { - Text = UICatalogTop.GetAboutBoxMessage (), + Text = UICatalogRunnable.GetAboutBoxMessage (), Alignment = Alignment.Center, VerticalAlignment = Alignment.Start, WordWrap = false, @@ -448,7 +441,7 @@ Nice Work")] driver!.SetScreenSize (tfSize.Width, tfSize.Height); driver.FillRect (driver.Screen, (Rune)'*'); - tf.Draw (driver.Screen, Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: driver.Screen, normalColor: Attribute.Default, hotColor: Attribute.Default); var expectedText = """ UI Catalog: A comprehensive sample library and test app for @@ -575,7 +568,7 @@ Nice Work")] Size size = tf.FormatAndGetSize (); Assert.Equal (new (expectedWidth, expectedHeight), size); - tf.Draw (new (0, 0, width, height), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (0, 0, width, height), normalColor: Attribute.Default, hotColor: Attribute.Default); DriverAssert.AssertDriverContentsWithFrameAre (expectedDraw, output, driver); } @@ -660,7 +653,34 @@ Nice Work")] Size size = tf.FormatAndGetSize (); Assert.Equal (new (expectedWidth, expectedHeight), size); - tf.Draw (new (0, 0, width, height), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (0, 0, width, height), normalColor: Attribute.Default, hotColor: Attribute.Default); + + DriverAssert.AssertDriverContentsWithFrameAre (expectedDraw, output, driver); + } + + [Theory] + [InlineData ("\U0001F468\u200D\U0001F469\u200D\U0001F467\u200D\U0001F466", 2, 1, TextDirection.LeftRight_TopBottom, "👨‍👩‍👧‍👦")] + [InlineData ("\U0001F468\u200D\U0001F469\u200D\U0001F467\u200D\U0001F466", 2, 1, TextDirection.TopBottom_LeftRight, "👨‍👩‍👧‍👦")] + public void Draw_Emojis_With_Zero_Width_Joiner ( + string text, + int width, + int height, + TextDirection direction, + string expectedDraw + ) + { + IDriver driver = CreateFakeDriver (); + + TextFormatter tf = new () + { + Direction = direction, + ConstrainToSize = new (width, height), + Text = text, + WordWrap = false + }; + Assert.Equal (width, text.GetColumns ()); + + tf.Draw (driver, new (0, 0, width, height), Attribute.Default, Attribute.Default); DriverAssert.AssertDriverContentsWithFrameAre (expectedDraw, output, driver); } diff --git a/Tests/UnitTestsParallelizable/Text/TextFormatterJustificationTests.cs b/Tests/UnitTestsParallelizable/Text/TextFormatterJustificationTests.cs index 4bae12df3..2d95e48b1 100644 --- a/Tests/UnitTestsParallelizable/Text/TextFormatterJustificationTests.cs +++ b/Tests/UnitTestsParallelizable/Text/TextFormatterJustificationTests.cs @@ -4,7 +4,7 @@ using Xunit.Abstractions; // Alias Console to MockConsole so we don't accidentally use Console -namespace UnitTests.TextTests; +namespace TextTests; public class TextFormatterJustificationTests (ITestOutputHelper output) : FakeDriverBase { @@ -3423,7 +3423,7 @@ public class TextFormatterJustificationTests (ITestOutputHelper output) : FakeDr }; driver.FillRect (new (0, 0, 7, 7), (Rune)'*'); - tf.Draw (new (0, 0, 7, 7), Attribute.Default, Attribute.Default, driver: driver); + tf.Draw (driver: driver, screen: new (0, 0, 7, 7), normalColor: Attribute.Default, hotColor: Attribute.Default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } } diff --git a/Tests/UnitTestsParallelizable/Text/TextFormatterTests.cs b/Tests/UnitTestsParallelizable/Text/TextFormatterTests.cs index 88e95fd7f..b7f580cf9 100644 --- a/Tests/UnitTestsParallelizable/Text/TextFormatterTests.cs +++ b/Tests/UnitTestsParallelizable/Text/TextFormatterTests.cs @@ -1,8 +1,9 @@ -using System.Text; +#nullable disable +using System.Text; using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.TextTests; +namespace TextTests; public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase { @@ -792,19 +793,16 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase [MemberData (nameof (CMGlyphs))] public void GetLengthThatFits_List_Simple_And_Wide_Runes (string text, int columns, int expectedLength) { - List runes = text.ToRuneList (); - Assert.Equal (expectedLength, TextFormatter.GetLengthThatFits (runes, columns)); + Assert.Equal (expectedLength, TextFormatter.GetLengthThatFits (text, columns)); } [Theory] [InlineData ("test", 3, 3)] [InlineData ("test", 4, 4)] [InlineData ("test", 10, 4)] - public void GetLengthThatFits_Runelist (string text, int columns, int expectedLength) + public void GetLengthThatFits_For_String (string text, int columns, int expectedLength) { - List runes = text.ToRuneList (); - - Assert.Equal (expectedLength, TextFormatter.GetLengthThatFits (runes, columns)); + Assert.Equal (expectedLength, TextFormatter.GetLengthThatFits (text, columns)); } [Theory] @@ -833,7 +831,8 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase public void GetLengthThatFits_With_Combining_Runes () { var text = "Les Mise\u0328\u0301rables"; - Assert.Equal (16, TextFormatter.GetLengthThatFits (text, 14)); + Assert.Equal (14, TextFormatter.GetLengthThatFits (text, 14)); + Assert.Equal ("Les Misę́rables", text); } [Fact] @@ -841,14 +840,18 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase { List text = new () { "Les Mis", "e\u0328\u0301", "rables" }; Assert.Equal (1, TextFormatter.GetMaxColsForWidth (text, 1)); + Assert.Equal ("Les Mis", text [0]); + Assert.Equal ("ę́", text [1]); + Assert.Equal ("rables", text [^1]); } - //[Fact] - //public void GetWidestLineLength_With_Combining_Runes () - //{ - // var text = "Les Mise\u0328\u0301rables"; - // Assert.Equal (1, TextFormatter.GetWidestLineLength (text, 1, 1)); - //} + [Fact] + public void GetWidestLineLength_With_Combining_Runes () + { + var text = "Les Mise\u0328\u0301rables"; + Assert.Equal (14, TextFormatter.GetWidestLineLength (text, 1)); + Assert.Equal ("Les Misę́rables", text); + } [Fact] public void Internal_Tests () @@ -1142,6 +1145,7 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase [Fact] public void NeedsFormat_Sets () { + IDriver driver = CreateFakeDriver (); var testText = "test"; var testBounds = new Rectangle (0, 0, 100, 1); var tf = new TextFormatter (); @@ -1151,7 +1155,7 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase Assert.NotEmpty (tf.GetLines ()); Assert.False (tf.NeedsFormat); // get_Lines causes a Format Assert.Equal (testText, tf.Text); - tf.Draw (testBounds, new (), new ()); + tf.Draw (driver: driver, screen: testBounds, normalColor: new (), hotColor: new ()); Assert.False (tf.NeedsFormat); tf.ConstrainToSize = new (1, 1); @@ -2450,6 +2454,7 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase Assert.Equal (expected, breakLines); // Double space Complex example - this is how VS 2022 does it + // which I think is not correct. //text = "A sentence has words. "; //breakLines = ""; //wrappedLines = TextFormatter.WordWrapText (text, width, preserveTrailingSpaces: true); @@ -2761,8 +2766,7 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase "ฮ", "ฯ", "ะั", - "า", - "ำ" + "าำ" } )] public void WordWrap_Unicode_SingleWordLine ( @@ -2797,7 +2801,17 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase Assert.True ( expectedClippedWidth >= (wrappedLines.Count > 0 ? wrappedLines.Max (l => l.GetColumns ()) : 0) ); - Assert.Equal (resultLines, wrappedLines); + + if (maxWidth == 1) + { + List newResultLines = resultLines.ToList (); + newResultLines [^1] = ""; + Assert.Equal (newResultLines, wrappedLines); + } + else + { + Assert.Equal (resultLines, wrappedLines); + } } /// WordWrap strips CRLF @@ -2987,7 +3001,7 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase ConstrainToHeight = 1 }; - tf.Draw (new Rectangle (0, 0, width, 1), Attribute.Default, Attribute.Default, default, driver); + tf.Draw (driver, new Rectangle (0, 0, width, 1), Attribute.Default, Attribute.Default, default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } @@ -3016,7 +3030,7 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase ConstrainToHeight = 1 }; - tf.Draw (new Rectangle (0, 0, width, 1), Attribute.Default, Attribute.Default, default, driver); + tf.Draw (driver, new Rectangle (0, 0, width, 1), Attribute.Default, Attribute.Default, default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } @@ -3042,7 +3056,7 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase ConstrainToHeight = 1 }; - tf.Draw (new Rectangle (0, 0, width, 1), Attribute.Default, Attribute.Default, default, driver); + tf.Draw (driver, new Rectangle (0, 0, width, 1), Attribute.Default, Attribute.Default, default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } @@ -3068,14 +3082,14 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase ConstrainToHeight = 1 }; - tf.Draw (new Rectangle (0, 0, width, 1), Attribute.Default, Attribute.Default, default, driver); + tf.Draw (driver, new Rectangle (0, 0, width, 1), Attribute.Default, Attribute.Default, default); DriverAssert.AssertDriverContentsWithFrameAre (expectedText, output, driver); } [Theory] - [InlineData (14, 1, TextDirection.LeftRight_TopBottom, "Les Misęrables")] - [InlineData (1, 14, TextDirection.TopBottom_LeftRight, "L\ne\ns\n \nM\ni\ns\nę\nr\na\nb\nl\ne\ns")] + [InlineData (14, 1, TextDirection.LeftRight_TopBottom, "Les Misę́rables")] + [InlineData (1, 14, TextDirection.TopBottom_LeftRight, "L\ne\ns\n \nM\ni\ns\nę́\nr\na\nb\nl\ne\ns")] [InlineData ( 4, 4, @@ -3084,7 +3098,7 @@ public class TextFormatterTests (ITestOutputHelper output) : FakeDriverBase LMre eias ssb - ęl " + ę́l " )] public void Draw_With_Combining_Runes (int width, int height, TextDirection textDirection, string expected) { @@ -3100,18 +3114,16 @@ ssb tf.ConstrainToSize = new (width, height); tf.Draw ( + driver, new (0, 0, width, height), new (ColorName16.White, ColorName16.Black), new (ColorName16.Blue, ColorName16.Black), - default (Rectangle), - driver - ); + default (Rectangle)); DriverAssert.AssertDriverContentsWithFrameAre (expected, output, driver); driver.End (); } - [Theory] [InlineData (17, 1, TextDirection.LeftRight_TopBottom, 4, "This is a Tab")] [InlineData (1, 17, TextDirection.TopBottom_LeftRight, 4, "T\nh\ni\ns\n \ni\ns\n \na\n \n \n \n \n \nT\na\nb")] @@ -3139,12 +3151,11 @@ ssb Assert.True (tf.WordWrap); tf.Draw ( + driver, new (0, 0, width, height), new (ColorName16.White, ColorName16.Black), new (ColorName16.Blue, ColorName16.Black), - default (Rectangle), - driver - ); + default (Rectangle)); DriverAssert.AssertDriverContentsWithFrameAre (expected, output, driver); driver.End (); @@ -3178,18 +3189,16 @@ ssb Assert.False (tf.PreserveTrailingSpaces); tf.Draw ( + driver, new (0, 0, width, height), new (ColorName16.White, ColorName16.Black), new (ColorName16.Blue, ColorName16.Black), - default (Rectangle), - driver - ); + default (Rectangle)); DriverAssert.AssertDriverContentsWithFrameAre (expected, output, driver); driver.End (); } - [Theory] [InlineData (17, 1, TextDirection.LeftRight_TopBottom, 4, "This is a Tab")] [InlineData (1, 17, TextDirection.TopBottom_LeftRight, 4, "T\nh\ni\ns\n \ni\ns\n \na\n \n \n \n \n \nT\na\nb")] @@ -3217,15 +3226,13 @@ ssb Assert.False (tf.PreserveTrailingSpaces); tf.Draw ( + driver, new (0, 0, width, height), new (ColorName16.White, ColorName16.Black), new (ColorName16.Blue, ColorName16.Black), - default (Rectangle), - driver - ); + default (Rectangle)); DriverAssert.AssertDriverContentsWithFrameAre (expected, output, driver); driver.End (); } - } diff --git a/Tests/UnitTestsParallelizable/UnitTests.Parallelizable.csproj b/Tests/UnitTestsParallelizable/UnitTests.Parallelizable.csproj index cf0f77f7c..5bd16391b 100644 --- a/Tests/UnitTestsParallelizable/UnitTests.Parallelizable.csproj +++ b/Tests/UnitTestsParallelizable/UnitTests.Parallelizable.csproj @@ -1,72 +1,73 @@  - - - - - 2.0 - 2.0 - 2.0 - 2.0 - - - false - - true - true - portable - $(DefineConstants);JETBRAINS_ANNOTATIONS;CONTRACTS_FULL - enable - true - true - + + + + + 2.0 + 2.0 + 2.0 + 2.0 + + + enable + false + + true + true + portable + $(DefineConstants);JETBRAINS_ANNOTATIONS;CONTRACTS_FULL + enable + true + true + - - true - $(DefineConstants);DEBUG_IDISPOSABLE - - - true - + + true + $(DefineConstants);DEBUG_IDISPOSABLE + + + true + - - - - + + + + - - - - - - - - - - all - runtime; build; native; contentfiles; analyzers; buildtransitive - - - all - runtime; build; native; contentfiles; analyzers; buildtransitive - - + + + + + + + + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + - - - - - - - + + + + + + + - - - PreserveNewest - - - - - - - + + + PreserveNewest + + + + + + + \ No newline at end of file diff --git a/Tests/UnitTestsParallelizable/View/Adornment/AdornmentSubViewTests.cs b/Tests/UnitTestsParallelizable/View/Adornment/AdornmentSubViewTests.cs deleted file mode 100644 index 3876b618c..000000000 --- a/Tests/UnitTestsParallelizable/View/Adornment/AdornmentSubViewTests.cs +++ /dev/null @@ -1,29 +0,0 @@ -using Xunit.Abstractions; - -namespace UnitTests_Parallelizable.ViewTests; - -[Collection ("Global Test Setup")] -public class AdornmentSubViewTests () -{ - [Fact] - public void Setting_Thickness_Causes_Adornment_SubView_Layout () - { - var view = new View (); - var subView = new View (); - view.Margin.Add (subView); - view.BeginInit (); - view.EndInit (); - var raised = false; - - subView.SubViewLayout += LayoutStarted; - view.Margin.Thickness = new Thickness (1, 2, 3, 4); - view.Layout (); - Assert.True (raised); - - return; - void LayoutStarted (object sender, LayoutEventArgs e) - { - raised = true; - } - } -} diff --git a/Tests/UnitTestsParallelizable/View/Adornment/MarginTests.cs b/Tests/UnitTestsParallelizable/View/Adornment/MarginTests.cs deleted file mode 100644 index d7cc2ed0d..000000000 --- a/Tests/UnitTestsParallelizable/View/Adornment/MarginTests.cs +++ /dev/null @@ -1,66 +0,0 @@ -using UnitTests; -using Xunit.Abstractions; - -namespace UnitTests_Parallelizable.ViewTests; - -public class MarginTests -{ - [Fact] - public void Is_Visually_Transparent () - { - var view = new View { Height = 3, Width = 3 }; - Assert.True(view.Margin!.ViewportSettings.HasFlag(ViewportSettingsFlags.Transparent), "Margin should be transparent by default."); - } - - [Fact] - public void Is_Transparent_To_Mouse () - { - var view = new View { Height = 3, Width = 3 }; - Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.TransparentMouse), "Margin should be transparent to mouse by default."); - } - - [Fact] - public void When_Not_Visually_Transparent () - { - var view = new View { Height = 3, Width = 3 }; - - // Give the Margin some size - view.Margin!.Thickness = new Thickness (1, 1, 1, 1); - - // Give it Text - view.Margin!.Text = "Test"; - - // Strip off ViewportSettings.Transparent - view.Margin!.ViewportSettings &= ~ViewportSettingsFlags.Transparent; - - // - - } - - [Fact] - public void Thickness_Is_Empty_By_Default () - { - var view = new View { Height = 3, Width = 3 }; - Assert.Equal (Thickness.Empty, view.Margin!.Thickness); - } - - // ShadowStyle - [Fact] - public void Margin_Uses_ShadowStyle_Transparent () - { - var view = new View { Height = 3, Width = 3, ShadowStyle = ShadowStyle.Transparent }; - Assert.Equal (ShadowStyle.Transparent, view.Margin!.ShadowStyle); - Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.TransparentMouse), "Margin should be transparent to mouse when ShadowStyle is Transparent."); - Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.Transparent), "Margin should be transparent when ShadowStyle is Transparent.."); - } - - [Fact] - public void Margin_Uses_ShadowStyle_Opaque () - { - var view = new View { Height = 3, Width = 3, ShadowStyle = ShadowStyle.Opaque }; - Assert.Equal (ShadowStyle.Opaque, view.Margin!.ShadowStyle); - Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.TransparentMouse), "Margin should be transparent to mouse when ShadowStyle is Opaque."); - Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.Transparent), "Margin should be transparent when ShadowStyle is Opaque.."); - } - -} diff --git a/Tests/UnitTestsParallelizable/View/Layout/GetViewsAtLocationTests.cs b/Tests/UnitTestsParallelizable/View/Layout/GetViewsAtLocationTests.cs deleted file mode 100644 index d2b2e8484..000000000 --- a/Tests/UnitTestsParallelizable/View/Layout/GetViewsAtLocationTests.cs +++ /dev/null @@ -1,407 +0,0 @@ -#nullable enable - -namespace UnitTests_Parallelizable.ViewMouseTests; - -[Trait ("Category", "Layout")] -public class GetViewsAtLocationTests -{ - private class TestView : View - { - public TestView (int x, int y, int w, int h, bool visible = true) - { - X = x; - Y = y; - Width = w; - Height = h; - base.Visible = visible; - } - } - - [Fact] - public void ReturnsEmpty_WhenRootIsNull () - { - var result = View.GetViewsAtLocation (null, new Point (0, 0)); - Assert.Empty (result); - } - - [Fact] - public void ReturnsEmpty_WhenRootIsNotVisible () - { - TestView root = new (0, 0, 10, 10, visible: false); - var result = View.GetViewsAtLocation (root, new Point (5, 5)); - Assert.Empty (result); - } - - [Fact] - public void ReturnsEmpty_WhenPointOutsideRoot () - { - TestView root = new (0, 0, 10, 10); - var result = View.GetViewsAtLocation (root, new Point (20, 20)); - Assert.Empty (result); - } - - - [Fact] - public void ReturnsEmpty_WhenPointOutsideRoot_AndSubview () - { - TestView root = new (0, 0, 10, 10); - TestView sub = new (5, 5, 2, 2); - root.Add (sub); - var result = View.GetViewsAtLocation (root, new Point (20, 20)); - Assert.Empty (result); - } - - [Fact] - public void ReturnsRoot_WhenPointInsideRoot_NoSubviews () - { - TestView root = new (0, 0, 10, 10); - var result = View.GetViewsAtLocation (root, new Point (5, 5)); - Assert.Single (result); - Assert.Equal (root, result [0]); - } - - - [Fact] - public void ReturnsRoot_And_Subview_WhenPointInsideRootMargin () - { - TestView root = new (0, 0, 10, 10); - root.Margin!.Thickness = new (1); - TestView sub = new (2, 2, 5, 5); - root.Add (sub); - var result = View.GetViewsAtLocation (root, new Point (3, 3)); - Assert.Equal (2, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub, result [1]); - } - - [Fact] - public void ReturnsRoot_And_Subview_Border_WhenPointInsideRootMargin () - { - TestView root = new (0, 0, 10, 10); - root.Margin!.Thickness = new (1); - TestView sub = new (2, 2, 5, 5); - sub.BorderStyle = LineStyle.Dotted; - root.Add (sub); - var result = View.GetViewsAtLocation (root, new Point (3, 3)); - Assert.Equal (3, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub, result [1]); - Assert.Equal (sub.Border, result [2]); - } - - - [Fact] - public void ReturnsRoot_And_Margin_WhenPointInside_With_Margin () - { - TestView root = new (0, 0, 10, 10); - root.Margin!.Thickness = new (1); - var result = View.GetViewsAtLocation (root, new Point (0, 0)); - Assert.Equal (2, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (root.Margin, result [1]); - } - - [Fact] - public void ReturnsRoot_WhenPointOutsideSubview_With_Margin () - { - TestView root = new (0, 0, 10, 10); - root.Margin!.Thickness = new (1); - TestView sub = new (2, 2, 5, 5); - root.Add (sub); - List result = View.GetViewsAtLocation (root, new Point (2, 2)); - Assert.Single (result); - Assert.Equal (root, result [0]); - - result = View.GetViewsAtLocation (root, new Point (0, 0)); - Assert.Equal (2, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (root.Margin, result [1]); - - result = View.GetViewsAtLocation (root, new Point (1, 1)); - Assert.Single (result); - Assert.Equal (root, result [0]); - - result = View.GetViewsAtLocation (root, new Point (8, 8)); - Assert.Single (result); - Assert.Equal (root, result [0]); - } - - - [Fact] - public void ReturnsRoot_And_Border_WhenPointInside_With_Border () - { - TestView root = new (0, 0, 10, 10); - root.Border!.Thickness = new (1); - var result = View.GetViewsAtLocation (root, new Point (0, 0)); - Assert.Equal (2, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (root.Border, result [1]); - } - - [Fact] - public void ReturnsRoot_WhenPointOutsideSubview_With_Border () - { - TestView root = new (0, 0, 10, 10); - root.Border!.Thickness = new (1); - TestView sub = new (2, 2, 5, 5); - root.Add (sub); - var result = View.GetViewsAtLocation (root, new Point (2, 2)); - Assert.Single (result); - Assert.Equal (root, result [0]); - - result = View.GetViewsAtLocation (root, new Point (0, 0)); - Assert.Equal (2, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (root.Border, result [1]); - - result = View.GetViewsAtLocation (root, new Point (1, 1)); - Assert.Single (result); - Assert.Equal (root, result [0]); - - result = View.GetViewsAtLocation (root, new Point (8, 8)); - Assert.Single (result); - Assert.Equal (root, result [0]); - } - - [Fact] - public void ReturnsRoot_And_Border_WhenPointInsideRootBorder () - { - TestView root = new (0, 0, 10, 10); - root.Border!.Thickness = new (1); - var result = View.GetViewsAtLocation (root, new Point (0, 0)); - Assert.Equal (2, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (root.Border, result [1]); - } - - [Fact] - public void ReturnsRoot_And_Padding_WhenPointInsideRootPadding () - { - TestView root = new (0, 0, 10, 10); - root.Padding!.Thickness = new (1); - var result = View.GetViewsAtLocation (root, new Point (0, 0)); - Assert.Equal (2, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (root.Padding, result [1]); - } - - [Fact] - public void ReturnsRootAndSubview_WhenPointInsideSubview () - { - TestView root = new (0, 0, 10, 10); - TestView sub = new (2, 2, 5, 5); - root.Add (sub); - - var result = View.GetViewsAtLocation (root, new Point (3, 3)); - Assert.Equal (2, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub, result [1]); - } - - [Fact] - public void ReturnsRootAndSubviewAndMargin_WhenPointInsideSubviewMargin () - { - TestView root = new (0, 0, 10, 10); - TestView sub = new (2, 2, 5, 5); - sub.Margin!.Thickness = new (1); - root.Add (sub); - - var result = View.GetViewsAtLocation (root, new Point (6, 6)); - Assert.Equal (3, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub, result [1]); - Assert.Equal (sub.Margin, result [2]); - } - - [Fact] - public void ReturnsRootAndSubviewAndBorder_WhenPointInsideSubviewBorder () - { - TestView root = new (0, 0, 10, 10); - TestView sub = new (2, 2, 5, 5); - sub.Border!.Thickness = new (1); - root.Add (sub); - - var result = View.GetViewsAtLocation (root, new Point (2, 2)); - Assert.Equal (3, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub, result [1]); - Assert.Equal (sub.Border, result [2]); - } - - [Fact] - public void ReturnsRootAndSubviewAndSubviewAndBorder_WhenPointInsideSubviewBorder () - { - TestView root = new (2, 2, 10, 10); - TestView sub = new (2, 2, 5, 5); - sub.Border!.Thickness = new (1); - root.Add (sub); - - var result = View.GetViewsAtLocation (root, new Point (4, 4)); - Assert.Equal (3, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub, result [1]); - Assert.Equal (sub.Border, result [2]); - } - - [Fact] - public void ReturnsRootAndSubviewAndBorder_WhenPointInsideSubviewPadding () - { - TestView root = new (0, 0, 10, 10); - TestView sub = new (2, 2, 5, 5); - sub.Padding!.Thickness = new (1); - root.Add (sub); - - var result = View.GetViewsAtLocation (root, new Point (2, 2)); - Assert.Equal (3, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub, result [1]); - Assert.Equal (sub.Padding, result [2]); - } - - [Fact] - public void ReturnsRootAndSubviewAndMarginAndShadowView_WhenPointInsideSubviewMargin () - { - TestView root = new (0, 0, 10, 10); - TestView sub = new (2, 2, 5, 5); - sub.ShadowStyle = ShadowStyle.Opaque; - root.Add (sub); - - root.Layout (); - - var result = View.GetViewsAtLocation (root, new Point (6, 6)); - Assert.Equal (5, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub, result [1]); - Assert.Equal (sub.Margin, result [2]); - Assert.Equal (sub.Margin!.SubViews.ElementAt (0), result [3]); - Assert.Equal (sub.Margin!.SubViews.ElementAt (1), result [4]); - } - - [Fact] - public void ReturnsRootAndSubviewAndBorderAndButton_WhenPointInsideSubviewBorder () - { - TestView root = new (0, 0, 10, 10); - TestView sub = new (2, 2, 5, 5); - sub.Border!.Thickness = new (1); - - Button closeButton = new Button () - { - NoDecorations = true, - NoPadding = true, - Title = "X", - Width = 1, - Height = 1, - X = Pos.AnchorEnd (), - Y= 0, - ShadowStyle = ShadowStyle.None - }; - sub.Border!.Add (closeButton); - root.Add (sub); - - root.Layout (); - - var result = View.GetViewsAtLocation (root, new Point (6, 2)); - Assert.Equal (4, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub, result [1]); - Assert.Equal (sub.Border, result [2]); - Assert.Equal (closeButton, result [3]); - } - - [Fact] - public void ReturnsDeepestSubview_WhenNested () - { - TestView root = new (0, 0, 20, 20); - var sub1 = new TestView (2, 2, 16, 16); - var sub2 = new TestView (3, 3, 10, 10); - var sub3 = new TestView (1, 1, 5, 5); - root.Add (sub1); - sub1.Add (sub2); - sub2.Add (sub3); - - // Point inside all - var result = View.GetViewsAtLocation (root, new Point (7, 7)); - Assert.Equal (4, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub1, result [1]); - Assert.Equal (sub2, result [2]); - Assert.Equal (sub3, result [3]); - } - - [Fact] - public void ReturnsTopmostSubview_WhenOverlapping () - { - TestView root = new (0, 0, 10, 10); - var sub1 = new TestView (2, 2, 6, 6); - var sub2 = new TestView (4, 4, 6, 6); - root.Add (sub1); - root.Add (sub2); // sub2 is on top - - var result = View.GetViewsAtLocation (root, new Point (5, 5)); - Assert.Equal (3, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub1, result [1]); - Assert.Equal (sub2, result [2]); - } - - [Fact] - public void ReturnsTopmostSubview_WhenNotOverlapping () - { - TestView root = new (0, 0, 10, 10);// under 5,5, - var sub1 = new TestView (10, 10, 6, 6); // not under location 5,5 - var sub2 = new TestView (4, 4, 6, 6); // under 5,5, - root.Add (sub1); - root.Add (sub2); // sub2 is on top - - var result = View.GetViewsAtLocation (root, new Point (5, 5)); - Assert.Equal (2, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub2, result [1]); - } - - [Fact] - public void SkipsInvisibleSubviews () - { - TestView root = new (0, 0, 10, 10); - var sub1 = new TestView (2, 2, 6, 6, visible: false); - var sub2 = new TestView (4, 4, 6, 6); - root.Add (sub1); - root.Add (sub2); - - var result = View.GetViewsAtLocation (root, new Point (5, 5)); - Assert.Equal (2, result.Count); - Assert.Equal (root, result [0]); - Assert.Equal (sub2, result [1]); - } - - [Fact] - public void ReturnsRoot_WhenPointOnEdge () - { - TestView root = new (0, 0, 10, 10); - var result = View.GetViewsAtLocation (root, new Point (0, 0)); - Assert.Single (result); - Assert.Equal (root, result [0]); - } - - [Fact] - public void ReturnsRoot_WhenPointOnBottomRightCorner () - { - TestView root = new (0, 0, 10, 10); - var result = View.GetViewsAtLocation (root, new Point (9, 9)); - Assert.Single (result); - Assert.Equal (root, result [0]); - } - - [Fact] - public void ReturnsEmpty_WhenAllSubviewsInvisible () - { - TestView root = new (0, 0, 10, 10); - var sub1 = new TestView (2, 2, 6, 6, visible: false); - root.Add (sub1); - - var result = View.GetViewsAtLocation (root, new Point (3, 3)); - Assert.Single (result); - Assert.Equal (root, result [0]); - } -} - diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.CenterTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Pos.CenterTests.cs deleted file mode 100644 index d9367c927..000000000 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.CenterTests.cs +++ /dev/null @@ -1,67 +0,0 @@ -using Xunit.Abstractions; -using static Terminal.Gui.ViewBase.Pos; - -namespace UnitTests_Parallelizable.LayoutTests; - -public class PosCenterTests (ITestOutputHelper output) -{ - private readonly ITestOutputHelper _output = output; - - [Fact] - public void PosCenter_Constructor () - { - var posCenter = new PosCenter (); - Assert.NotNull (posCenter); - } - - [Fact] - public void PosCenter_ToString () - { - var posCenter = new PosCenter (); - var expectedString = "Center"; - - Assert.Equal (expectedString, posCenter.ToString ()); - } - - [Fact] - public void PosCenter_GetAnchor () - { - var posCenter = new PosCenter (); - var width = 50; - int expectedAnchor = width / 2; - - Assert.Equal (expectedAnchor, posCenter.GetAnchor (width)); - } - - [Fact] - public void PosCenter_CreatesCorrectInstance () - { - Pos pos = Center (); - Assert.IsType (pos); - } - - [Theory] - [InlineData (10, 2, 4)] - [InlineData (10, 10, 0)] - [InlineData (10, 11, 0)] - [InlineData (10, 12, -1)] - [InlineData (19, 20, 0)] - public void PosCenter_Calculate_ReturnsExpectedValue (int superviewDimension, int width, int expectedX) - { - var posCenter = new PosCenter (); - int result = posCenter.Calculate (superviewDimension, new DimAbsolute (width), null!, Dimension.Width); - Assert.Equal (expectedX, result); - } - - [Fact] - public void PosCenter_Bigger_Than_SuperView () - { - var superView = new View { Width = 10, Height = 10 }; - var view = new View { X = Center (), Y = Center (), Width = 20, Height = 20 }; - superView.Add (view); - superView.LayoutSubViews (); - - Assert.Equal (-5, view.Frame.Left); - Assert.Equal (-5, view.Frame.Top); - } -} diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.CombineTests.cs b/Tests/UnitTestsParallelizable/View/Layout/Pos.CombineTests.cs deleted file mode 100644 index 1e2d4968c..000000000 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.CombineTests.cs +++ /dev/null @@ -1,36 +0,0 @@ -using Microsoft.VisualStudio.TestPlatform.Utilities; -using UnitTests; -using Xunit.Abstractions; -using static Terminal.Gui.ViewBase.Dim; -using static Terminal.Gui.ViewBase.Pos; - -namespace UnitTests_Parallelizable.LayoutTests; - -public class PosCombineTests (ITestOutputHelper output) -{ - private readonly ITestOutputHelper _output = output; - - // TODO: This actually a SetRelativeLayout/LayoutSubViews test and should be moved - // TODO: A new test that calls SetRelativeLayout directly is needed. - [Fact] - public void PosCombine_Referencing_Same_View () - { - var super = new View { Width = 10, Height = 10, Text = "super" }; - var view1 = new View { Width = 2, Height = 2, Text = "view1" }; - var view2 = new View { Width = 2, Height = 2, Text = "view2" }; - view2.X = Pos.AnchorEnd (0) - (Pos.Right (view2) - Pos.Left (view2)); - - super.Add (view1, view2); - super.BeginInit (); - super.EndInit (); - - Exception exception = Record.Exception (super.LayoutSubViews); - Assert.Null (exception); - Assert.Equal (new (0, 0, 10, 10), super.Frame); - Assert.Equal (new (0, 0, 2, 2), view1.Frame); - Assert.Equal (new (8, 0, 2, 2), view2.Frame); - - super.Dispose (); - } - -} diff --git a/Tests/UnitTestsParallelizable/View/Navigation/NavigationTests.cs b/Tests/UnitTestsParallelizable/View/Navigation/NavigationTests.cs deleted file mode 100644 index bed43ef50..000000000 --- a/Tests/UnitTestsParallelizable/View/Navigation/NavigationTests.cs +++ /dev/null @@ -1,66 +0,0 @@ -using UnitTests; -using Xunit.Abstractions; - -namespace UnitTests_Parallelizable.ViewTests; - -public class NavigationTests -{ - - // View.Focused & View.MostFocused tests - - // View.Focused - No subviews - [Fact] - public void Focused_NoSubViews () - { - var view = new View (); - Assert.Null (view.Focused); - - view.CanFocus = true; - view.SetFocus (); - } - - [Fact] - public void GetMostFocused_NoSubViews_Returns_Null () - { - var view = new View (); - Assert.Null (view.Focused); - - view.CanFocus = true; - Assert.False (view.HasFocus); - view.SetFocus (); - Assert.True (view.HasFocus); - Assert.Null (view.MostFocused); - } - - [Fact] - public void GetMostFocused_Returns_Most () - { - var view = new View - { - Id = "view", - CanFocus = true - }; - - var subview = new View - { - Id = "subview", - CanFocus = true - }; - - view.Add (subview); - - view.SetFocus (); - Assert.True (view.HasFocus); - Assert.True (subview.HasFocus); - Assert.Equal (subview, view.MostFocused); - - var subview2 = new View - { - Id = "subview2", - CanFocus = true - }; - - view.Add (subview2); - Assert.Equal (subview2, view.MostFocused); - } -} diff --git a/Tests/UnitTestsParallelizable/ViewBase/Adornment/AdornmentSubViewTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Adornment/AdornmentSubViewTests.cs new file mode 100644 index 000000000..eb95f093a --- /dev/null +++ b/Tests/UnitTestsParallelizable/ViewBase/Adornment/AdornmentSubViewTests.cs @@ -0,0 +1,95 @@ +using Xunit.Abstractions; + +namespace ViewBaseTests.Adornments; + +public class AdornmentSubViewTests () +{ + [Fact] + public void Setting_Thickness_Causes_Adornment_SubView_Layout () + { + var view = new View (); + var subView = new View (); + view.Margin!.Add (subView); + view.BeginInit (); + view.EndInit (); + var raised = false; + + subView.SubViewLayout += LayoutStarted; + view.Margin.Thickness = new Thickness (1, 2, 3, 4); + view.Layout (); + Assert.True (raised); + + return; + void LayoutStarted (object? sender, LayoutEventArgs e) + { + raised = true; + } + } + + [Theory] + [InlineData (0, 0, false)] // Margin has no thickness, so false + [InlineData (0, 1, false)] // Margin has no thickness, so false + [InlineData (1, 0, true)] + [InlineData (1, 1, true)] + [InlineData (2, 1, true)] + public void Adornment_WithSubView_Finds (int viewMargin, int subViewMargin, bool expectedFound) + { + IApplication? app = Application.Create (); + Runnable runnable = new () + { + Width = 10, + Height = 10 + }; + app.Begin (runnable); + + runnable.Margin!.Thickness = new Thickness (viewMargin); + // Turn of TransparentMouse for the test + runnable.Margin!.ViewportSettings = ViewportSettingsFlags.None; + + var subView = new View () + { + X = 0, + Y = 0, + Width = 5, + Height = 5 + }; + subView.Margin!.Thickness = new Thickness (subViewMargin); + // Turn of TransparentMouse for the test + subView.Margin!.ViewportSettings = ViewportSettingsFlags.None; + + runnable.Margin!.Add (subView); + runnable.Layout (); + + var foundView = runnable.GetViewsUnderLocation (new Point (0, 0), ViewportSettingsFlags.None).LastOrDefault (); + + bool found = foundView == subView || foundView == subView.Margin; + Assert.Equal (expectedFound, found); + } + + [Fact] + public void Adornment_WithNonVisibleSubView_Finds_Adornment () + { + IApplication? app = Application.Create (); + Runnable runnable = new () + { + Width = 10, + Height = 10 + }; + app.Begin (runnable); + runnable.Padding!.Thickness = new Thickness (1); + + var subView = new View () + { + X = 0, + Y = 0, + Width = 1, + Height = 1, + Visible = false + }; + runnable.Padding.Add (subView); + runnable.Layout (); + + Assert.Equal (runnable.Padding, runnable.GetViewsUnderLocation (new Point (0, 0), ViewportSettingsFlags.None).LastOrDefault ()); + + } +} diff --git a/Tests/UnitTestsParallelizable/View/Adornment/AdornmentTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Adornment/AdornmentTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Adornment/AdornmentTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Adornment/AdornmentTests.cs index bbaad3a2b..ea04decd7 100644 --- a/Tests/UnitTestsParallelizable/View/Adornment/AdornmentTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Adornment/AdornmentTests.cs @@ -1,5 +1,5 @@ #nullable enable -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Adornments; [Collection ("Global Test Setup")] public class AdornmentTests diff --git a/Tests/UnitTestsParallelizable/View/Adornment/BorderArrangementTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Adornment/BorderArrangementTests.cs similarity index 100% rename from Tests/UnitTestsParallelizable/View/Adornment/BorderArrangementTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Adornment/BorderArrangementTests.cs diff --git a/Tests/UnitTestsParallelizable/ViewBase/Adornment/MarginTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Adornment/MarginTests.cs new file mode 100644 index 000000000..482b2519e --- /dev/null +++ b/Tests/UnitTestsParallelizable/ViewBase/Adornment/MarginTests.cs @@ -0,0 +1,136 @@ +#nullable enable +using UnitTests; +using Xunit.Abstractions; + +namespace ViewBaseTests.Adornments; + +public class MarginTests (ITestOutputHelper output) +{ + [Fact] + public void Margin_Is_Transparent () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + app.Driver!.SetScreenSize (5, 5); + + var view = new View { Height = 3, Width = 3 }; + view.Margin!.Diagnostics = ViewDiagnosticFlags.Thickness; + view.Margin.Thickness = new (1); + + Runnable runnable = new (); + app.Begin (runnable); + + runnable.SetScheme (new () + { + Normal = new (Color.Red, Color.Green), Focus = new (Color.Green, Color.Red) + }); + + runnable.Add (view); + Assert.Equal (ColorName16.Red, view.Margin.GetAttributeForRole (VisualRole.Normal).Foreground.GetClosestNamedColor16 ()); + Assert.Equal (ColorName16.Red, runnable.GetAttributeForRole (VisualRole.Normal).Foreground.GetClosestNamedColor16 ()); + + app.LayoutAndDraw (); + + DriverAssert.AssertDriverContentsAre ( + @"", + output, + app.Driver + ); + DriverAssert.AssertDriverAttributesAre ("0", output, app.Driver, runnable.GetAttributeForRole (VisualRole.Normal)); + } + + [Fact] + public void Margin_ViewPortSettings_Not_Transparent_Is_NotTransparent () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + app.Driver!.SetScreenSize (5, 5); + + var view = new View { Height = 3, Width = 3 }; + view.Margin!.Diagnostics = ViewDiagnosticFlags.Thickness; + view.Margin.Thickness = new (1); + view.Margin.ViewportSettings = ViewportSettingsFlags.None; + + Runnable runnable = new (); + app.Begin (runnable); + + runnable.SetScheme (new () + { + Normal = new (Color.Red, Color.Green), Focus = new (Color.Green, Color.Red) + }); + + runnable.Add (view); + Assert.Equal (ColorName16.Red, view.Margin.GetAttributeForRole (VisualRole.Normal).Foreground.GetClosestNamedColor16 ()); + Assert.Equal (ColorName16.Red, runnable.GetAttributeForRole (VisualRole.Normal).Foreground.GetClosestNamedColor16 ()); + + app.LayoutAndDraw (); + + DriverAssert.AssertDriverContentsAre ( + @" +MMM +M M +MMM", + output, + app.Driver + ); + DriverAssert.AssertDriverAttributesAre ("0", output, app.Driver, runnable.GetAttributeForRole (VisualRole.Normal)); + } + [Fact] + public void Is_Visually_Transparent () + { + var view = new View { Height = 3, Width = 3 }; + Assert.True(view.Margin!.ViewportSettings.HasFlag(ViewportSettingsFlags.Transparent), "Margin should be transparent by default."); + } + + [Fact] + public void Is_Transparent_To_Mouse () + { + var view = new View { Height = 3, Width = 3 }; + Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.TransparentMouse), "Margin should be transparent to mouse by default."); + } + + [Fact] + public void When_Not_Visually_Transparent () + { + var view = new View { Height = 3, Width = 3 }; + + // Give the Margin some size + view.Margin!.Thickness = new Thickness (1, 1, 1, 1); + + // Give it Text + view.Margin!.Text = "Test"; + + // Strip off ViewportSettings.Transparent + view.Margin!.ViewportSettings &= ~ViewportSettingsFlags.Transparent; + + // + + } + + [Fact] + public void Thickness_Is_Empty_By_Default () + { + var view = new View { Height = 3, Width = 3 }; + Assert.Equal (Thickness.Empty, view.Margin!.Thickness); + } + + // ShadowStyle + [Fact] + public void Margin_Uses_ShadowStyle_Transparent () + { + var view = new View { Height = 3, Width = 3, ShadowStyle = ShadowStyle.Transparent }; + Assert.Equal (ShadowStyle.Transparent, view.Margin!.ShadowStyle); + Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.TransparentMouse), "Margin should be transparent to mouse when ShadowStyle is Transparent."); + Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.Transparent), "Margin should be transparent when ShadowStyle is Transparent.."); + } + + [Fact] + public void Margin_Uses_ShadowStyle_Opaque () + { + var view = new View { Height = 3, Width = 3, ShadowStyle = ShadowStyle.Opaque }; + Assert.Equal (ShadowStyle.Opaque, view.Margin!.ShadowStyle); + Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.TransparentMouse), "Margin should be transparent to mouse when ShadowStyle is Opaque."); + Assert.True (view.Margin!.ViewportSettings.HasFlag (ViewportSettingsFlags.Transparent), "Margin should be transparent when ShadowStyle is Opaque.."); + } + +} diff --git a/Tests/UnitTestsParallelizable/View/Adornment/ShadowStyletests.cs b/Tests/UnitTestsParallelizable/ViewBase/Adornment/ShadowStyletests.cs similarity index 95% rename from Tests/UnitTestsParallelizable/View/Adornment/ShadowStyletests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Adornment/ShadowStyletests.cs index a3add070b..49bb7f0e7 100644 --- a/Tests/UnitTestsParallelizable/View/Adornment/ShadowStyletests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Adornment/ShadowStyletests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Adornments; [Collection ("Global Test Setup")] @@ -53,7 +53,7 @@ public class ShadowStyleTests superView.BeginInit (); superView.EndInit (); - Assert.Equal (new (expectedLeft, expectedTop, expectedRight, expectedBottom), view.Margin.Thickness); + Assert.Equal (new (expectedLeft, expectedTop, expectedRight, expectedBottom), view.Margin!.Thickness); } diff --git a/Tests/UnitTestsParallelizable/View/Adornment/ToScreenTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Adornment/ToScreenTests.cs similarity index 89% rename from Tests/UnitTestsParallelizable/View/Adornment/ToScreenTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Adornment/ToScreenTests.cs index cbea7cca8..e3601920f 100644 --- a/Tests/UnitTestsParallelizable/View/Adornment/ToScreenTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Adornment/ToScreenTests.cs @@ -1,6 +1,6 @@ using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests; /// /// Test the and methods. diff --git a/Tests/UnitTestsParallelizable/View/ArrangementTests.cs b/Tests/UnitTestsParallelizable/ViewBase/ArrangementTests.cs similarity index 79% rename from Tests/UnitTestsParallelizable/View/ArrangementTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/ArrangementTests.cs index 842a7070b..19aac38a8 100644 --- a/Tests/UnitTestsParallelizable/View/ArrangementTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/ArrangementTests.cs @@ -1,6 +1,7 @@ using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Arrangement; + public class ArrangementTests (ITestOutputHelper output) { @@ -28,11 +29,11 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void ViewArrangement_Resizable_IsCombinationOfAllResizableFlags () { - ViewArrangement expected = ViewArrangement.LeftResizable - | ViewArrangement.RightResizable - | ViewArrangement.TopResizable + ViewArrangement expected = ViewArrangement.LeftResizable + | ViewArrangement.RightResizable + | ViewArrangement.TopResizable | ViewArrangement.BottomResizable; - + Assert.Equal (ViewArrangement.Resizable, expected); } @@ -40,7 +41,7 @@ public class ArrangementTests (ITestOutputHelper output) public void ViewArrangement_CanCombineFlags () { ViewArrangement arrangement = ViewArrangement.Movable | ViewArrangement.LeftResizable; - + Assert.True (arrangement.HasFlag (ViewArrangement.Movable)); Assert.True (arrangement.HasFlag (ViewArrangement.LeftResizable)); Assert.False (arrangement.HasFlag (ViewArrangement.RightResizable)); @@ -67,11 +68,11 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void View_Arrangement_CanSetMultipleFlags () { - var view = new View - { - Arrangement = ViewArrangement.Movable | ViewArrangement.Resizable + var view = new View + { + Arrangement = ViewArrangement.Movable | ViewArrangement.Resizable }; - + Assert.True (view.Arrangement.HasFlag (ViewArrangement.Movable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.LeftResizable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.RightResizable)); @@ -83,7 +84,7 @@ public class ArrangementTests (ITestOutputHelper output) public void View_Arrangement_Overlapped_CanBeSetIndependently () { var view = new View { Arrangement = ViewArrangement.Overlapped }; - + Assert.True (view.Arrangement.HasFlag (ViewArrangement.Overlapped)); Assert.False (view.Arrangement.HasFlag (ViewArrangement.Movable)); Assert.False (view.Arrangement.HasFlag (ViewArrangement.Resizable)); @@ -92,11 +93,11 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void View_Arrangement_CanCombineOverlappedWithOtherFlags () { - var view = new View - { - Arrangement = ViewArrangement.Overlapped | ViewArrangement.Movable + var view = new View + { + Arrangement = ViewArrangement.Overlapped | ViewArrangement.Movable }; - + Assert.True (view.Arrangement.HasFlag (ViewArrangement.Overlapped)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.Movable)); } @@ -108,12 +109,12 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void TopResizable_WithoutMovable_IsAllowed () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.TopResizable, BorderStyle = LineStyle.Single }; - + Assert.True (view.Arrangement.HasFlag (ViewArrangement.TopResizable)); Assert.False (view.Arrangement.HasFlag (ViewArrangement.Movable)); } @@ -123,16 +124,16 @@ public class ArrangementTests (ITestOutputHelper output) { // According to docs and Border.Arrangment.cs line 569: // TopResizable is only checked if NOT Movable - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.Movable | ViewArrangement.TopResizable, BorderStyle = LineStyle.Single }; - + // Both flags can be set on the property Assert.True (view.Arrangement.HasFlag (ViewArrangement.Movable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.TopResizable)); - + // But the behavior in Border.DetermineArrangeModeFromClick // will prioritize Movable over TopResizable } @@ -140,12 +141,12 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void Resizable_WithMovable_IncludesTopResizable () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.Resizable | ViewArrangement.Movable, BorderStyle = LineStyle.Single }; - + Assert.True (view.Arrangement.HasFlag (ViewArrangement.Movable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.TopResizable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.LeftResizable)); @@ -160,12 +161,12 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void Border_WithNoArrangement_HasNoArrangementOptions () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.Fixed, BorderStyle = LineStyle.Single }; - + Assert.NotNull (view.Border); Assert.Equal (ViewArrangement.Fixed, view.Arrangement); } @@ -174,8 +175,8 @@ public class ArrangementTests (ITestOutputHelper output) public void Border_WithMovableArrangement_CanEnterArrangeMode () { var superView = new View (); - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.Movable, BorderStyle = LineStyle.Single, X = 0, @@ -184,7 +185,7 @@ public class ArrangementTests (ITestOutputHelper output) Height = 10 }; superView.Add (view); - + Assert.NotNull (view.Border); Assert.True (view.Arrangement.HasFlag (ViewArrangement.Movable)); } @@ -192,12 +193,12 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void Border_WithResizableArrangement_HasResizableOptions () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.Resizable, BorderStyle = LineStyle.Single }; - + Assert.NotNull (view.Border); Assert.True (view.Arrangement.HasFlag (ViewArrangement.LeftResizable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.RightResizable)); @@ -212,24 +213,35 @@ public class ArrangementTests (ITestOutputHelper output) [InlineData (ViewArrangement.BottomResizable)] public void Border_WithSingleResizableDirection_OnlyHasThatOption (ViewArrangement arrangement) { - var view = new View - { + var view = new View + { Arrangement = arrangement, BorderStyle = LineStyle.Single }; - + Assert.NotNull (view.Border); Assert.True (view.Arrangement.HasFlag (arrangement)); - + // Verify other directions are not set if (arrangement != ViewArrangement.LeftResizable) + { Assert.False (view.Arrangement.HasFlag (ViewArrangement.LeftResizable)); + } + if (arrangement != ViewArrangement.RightResizable) + { Assert.False (view.Arrangement.HasFlag (ViewArrangement.RightResizable)); + } + if (arrangement != ViewArrangement.TopResizable) + { Assert.False (view.Arrangement.HasFlag (ViewArrangement.TopResizable)); + } + if (arrangement != ViewArrangement.BottomResizable) + { Assert.False (view.Arrangement.HasFlag (ViewArrangement.BottomResizable)); + } } #endregion @@ -239,12 +251,12 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void Border_BottomRightResizable_CombinesBothFlags () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.BottomResizable | ViewArrangement.RightResizable, BorderStyle = LineStyle.Single }; - + Assert.True (view.Arrangement.HasFlag (ViewArrangement.BottomResizable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.RightResizable)); Assert.False (view.Arrangement.HasFlag (ViewArrangement.TopResizable)); @@ -254,12 +266,12 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void Border_BottomLeftResizable_CombinesBothFlags () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.BottomResizable | ViewArrangement.LeftResizable, BorderStyle = LineStyle.Single }; - + Assert.True (view.Arrangement.HasFlag (ViewArrangement.BottomResizable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.LeftResizable)); Assert.False (view.Arrangement.HasFlag (ViewArrangement.TopResizable)); @@ -269,12 +281,12 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void Border_TopRightResizable_CombinesBothFlags () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.TopResizable | ViewArrangement.RightResizable, BorderStyle = LineStyle.Single }; - + Assert.True (view.Arrangement.HasFlag (ViewArrangement.TopResizable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.RightResizable)); Assert.False (view.Arrangement.HasFlag (ViewArrangement.BottomResizable)); @@ -284,12 +296,12 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void Border_TopLeftResizable_CombinesBothFlags () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.TopResizable | ViewArrangement.LeftResizable, BorderStyle = LineStyle.Single }; - + Assert.True (view.Arrangement.HasFlag (ViewArrangement.TopResizable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.LeftResizable)); Assert.False (view.Arrangement.HasFlag (ViewArrangement.BottomResizable)); @@ -326,8 +338,8 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void Overlapped_AllowsSubViewsToOverlap () { - var superView = new View - { + var superView = new View + { Arrangement = ViewArrangement.Overlapped, Width = 20, Height = 20 @@ -351,7 +363,7 @@ public class ArrangementTests (ITestOutputHelper output) public void LeftResizable_CanBeUsedForHorizontalSplitter () { var container = new View { Width = 80, Height = 25 }; - + var leftPane = new View { X = 0, @@ -359,7 +371,7 @@ public class ArrangementTests (ITestOutputHelper output) Width = 40, Height = Dim.Fill () }; - + var rightPane = new View { X = 40, @@ -369,9 +381,9 @@ public class ArrangementTests (ITestOutputHelper output) Arrangement = ViewArrangement.LeftResizable, BorderStyle = LineStyle.Single }; - + container.Add (leftPane, rightPane); - + Assert.True (rightPane.Arrangement.HasFlag (ViewArrangement.LeftResizable)); Assert.NotNull (rightPane.Border); } @@ -380,7 +392,7 @@ public class ArrangementTests (ITestOutputHelper output) public void TopResizable_CanBeUsedForVerticalSplitter () { var container = new View { Width = 80, Height = 25 }; - + var topPane = new View { X = 0, @@ -388,7 +400,7 @@ public class ArrangementTests (ITestOutputHelper output) Width = Dim.Fill (), Height = 10 }; - + var bottomPane = new View { X = 0, @@ -398,9 +410,9 @@ public class ArrangementTests (ITestOutputHelper output) Arrangement = ViewArrangement.TopResizable, BorderStyle = LineStyle.Single }; - + container.Add (topPane, bottomPane); - + Assert.True (bottomPane.Arrangement.HasFlag (ViewArrangement.TopResizable)); Assert.NotNull (bottomPane.Border); } @@ -412,11 +424,11 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void View_WithoutBorderStyle_CanHaveArrangement () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.Movable }; - + // Arrangement can be set even without a border style // Border object still exists but has no visible style Assert.Equal (ViewArrangement.Movable, view.Arrangement); @@ -427,11 +439,11 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void View_WithNoBorderStyle_ResizableCanBeSet () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.Resizable }; - + // Arrangement is set but has limited effect without a visible border style Assert.Equal (ViewArrangement.Resizable, view.Arrangement); Assert.NotNull (view.Border); @@ -448,8 +460,8 @@ public class ArrangementTests (ITestOutputHelper output) // This test verifies the documented behavior that TopResizable is ignored // when Movable is also set (line 569 in Border.Arrangment.cs) var superView = new View { Width = 80, Height = 25 }; - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.TopResizable | ViewArrangement.Movable, BorderStyle = LineStyle.Single, X = 10, @@ -458,11 +470,11 @@ public class ArrangementTests (ITestOutputHelper output) Height = 10 }; superView.Add (view); - + // The view has both flags set Assert.True (view.Arrangement.HasFlag (ViewArrangement.TopResizable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.Movable)); - + // But Movable takes precedence in Border.DetermineArrangeModeFromClick // This is verified by the code at line 569 checking !Parent!.Arrangement.HasFlag(ViewArrangement.Movable) } @@ -471,8 +483,8 @@ public class ArrangementTests (ITestOutputHelper output) public void DetermineArrangeModeFromClick_TopResizableWorksWithoutMovable () { var superView = new View { Width = 80, Height = 25 }; - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.TopResizable, BorderStyle = LineStyle.Single, X = 10, @@ -481,7 +493,7 @@ public class ArrangementTests (ITestOutputHelper output) Height = 10 }; superView.Add (view); - + // Only TopResizable is set Assert.True (view.Arrangement.HasFlag (ViewArrangement.TopResizable)); Assert.False (view.Arrangement.HasFlag (ViewArrangement.Movable)); @@ -491,20 +503,20 @@ public class ArrangementTests (ITestOutputHelper output) public void DetermineArrangeModeFromClick_AllCornerCombinationsSupported () { var superView = new View { Width = 80, Height = 25 }; - + // Test that all 4 corner combinations are recognized - var cornerCombinations = new[] + var cornerCombinations = new [] { ViewArrangement.BottomResizable | ViewArrangement.RightResizable, ViewArrangement.BottomResizable | ViewArrangement.LeftResizable, ViewArrangement.TopResizable | ViewArrangement.RightResizable, ViewArrangement.TopResizable | ViewArrangement.LeftResizable }; - + foreach (var arrangement in cornerCombinations) { - var view = new View - { + var view = new View + { Arrangement = arrangement, BorderStyle = LineStyle.Single, X = 10, @@ -513,10 +525,10 @@ public class ArrangementTests (ITestOutputHelper output) Height = 10 }; superView.Add (view); - + // Verify the flags are set correctly Assert.True (view.Arrangement == arrangement); - + superView.Remove (view); } } @@ -530,10 +542,10 @@ public class ArrangementTests (ITestOutputHelper output) { var view = new View { Arrangement = ViewArrangement.Fixed }; Assert.Equal (ViewArrangement.Fixed, view.Arrangement); - + view.Arrangement = ViewArrangement.Movable; Assert.Equal (ViewArrangement.Movable, view.Arrangement); - + view.Arrangement = ViewArrangement.Resizable; Assert.Equal (ViewArrangement.Resizable, view.Arrangement); } @@ -542,7 +554,7 @@ public class ArrangementTests (ITestOutputHelper output) public void View_Arrangement_CanAddFlags () { var view = new View { Arrangement = ViewArrangement.Movable }; - + view.Arrangement |= ViewArrangement.LeftResizable; Assert.True (view.Arrangement.HasFlag (ViewArrangement.Movable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.LeftResizable)); @@ -551,11 +563,11 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void View_Arrangement_CanRemoveFlags () { - var view = new View - { - Arrangement = ViewArrangement.Movable | ViewArrangement.Resizable + var view = new View + { + Arrangement = ViewArrangement.Movable | ViewArrangement.Resizable }; - + view.Arrangement &= ~ViewArrangement.Movable; Assert.False (view.Arrangement.HasFlag (ViewArrangement.Movable)); Assert.True (view.Arrangement.HasFlag (ViewArrangement.Resizable)); @@ -568,15 +580,15 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void SuperView_CanHaveMultipleArrangeableSubViews () { - var superView = new View - { + var superView = new View + { Arrangement = ViewArrangement.Overlapped, Width = 80, Height = 25 }; - - var movableView = new View - { + + var movableView = new View + { Arrangement = ViewArrangement.Movable, BorderStyle = LineStyle.Single, X = 0, @@ -584,9 +596,9 @@ public class ArrangementTests (ITestOutputHelper output) Width = 20, Height = 10 }; - - var resizableView = new View - { + + var resizableView = new View + { Arrangement = ViewArrangement.Resizable, BorderStyle = LineStyle.Single, X = 25, @@ -594,9 +606,9 @@ public class ArrangementTests (ITestOutputHelper output) Width = 20, Height = 10 }; - - var fixedView = new View - { + + var fixedView = new View + { Arrangement = ViewArrangement.Fixed, BorderStyle = LineStyle.Single, X = 50, @@ -604,9 +616,9 @@ public class ArrangementTests (ITestOutputHelper output) Width = 20, Height = 10 }; - + superView.Add (movableView, resizableView, fixedView); - + Assert.Equal (3, superView.SubViews.Count); Assert.Equal (ViewArrangement.Movable, movableView.Arrangement); Assert.Equal (ViewArrangement.Resizable, resizableView.Arrangement); @@ -618,9 +630,9 @@ public class ArrangementTests (ITestOutputHelper output) { var superView = new View { Arrangement = ViewArrangement.Fixed }; var subView = new View { Arrangement = ViewArrangement.Movable }; - + superView.Add (subView); - + // SubView arrangement is independent of SuperView arrangement Assert.Equal (ViewArrangement.Fixed, superView.Arrangement); Assert.Equal (ViewArrangement.Movable, subView.Arrangement); @@ -633,30 +645,30 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void Border_WithDefaultThickness_SupportsArrangement () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.Movable, BorderStyle = LineStyle.Single }; - + Assert.NotNull (view.Border); // Default thickness should be (1,1,1,1) for Single line style - Assert.True (view.Border.Thickness.Left > 0 || view.Border.Thickness.Right > 0 + Assert.True (view.Border.Thickness.Left > 0 || view.Border.Thickness.Right > 0 || view.Border.Thickness.Top > 0 || view.Border.Thickness.Bottom > 0); } [Fact] public void Border_WithCustomThickness_SupportsArrangement () { - var view = new View - { + var view = new View + { Arrangement = ViewArrangement.LeftResizable, BorderStyle = LineStyle.Single }; - + // Set custom thickness - only left border view.Border!.Thickness = new Thickness (2, 0, 0, 0); - + Assert.Equal (2, view.Border.Thickness.Left); Assert.Equal (0, view.Border.Thickness.Top); Assert.Equal (0, view.Border.Thickness.Right); @@ -669,10 +681,10 @@ public class ArrangementTests (ITestOutputHelper output) #region View-Specific Arrangement Tests [Fact] - public void Toplevel_DefaultsToOverlapped () + public void Runnable_DefaultsToOverlapped () { - var toplevel = new Toplevel (); - Assert.True (toplevel.Arrangement.HasFlag (ViewArrangement.Overlapped)); + var runnable = new Runnable (); + Assert.True (runnable.Arrangement.HasFlag (ViewArrangement.Overlapped)); } [Fact] @@ -696,7 +708,7 @@ public class ArrangementTests (ITestOutputHelper output) // View.Navigation.cs checks Arrangement.HasFlag(ViewArrangement.Overlapped) var overlappedView = new View { Arrangement = ViewArrangement.Overlapped }; var tiledView = new View { Arrangement = ViewArrangement.Fixed }; - + Assert.True (overlappedView.Arrangement.HasFlag (ViewArrangement.Overlapped)); Assert.False (tiledView.Arrangement.HasFlag (ViewArrangement.Overlapped)); } @@ -708,9 +720,9 @@ public class ArrangementTests (ITestOutputHelper output) var parent = new View { Arrangement = ViewArrangement.Overlapped }; var child1 = new View { X = 0, Y = 0, Width = 10, Height = 10 }; var child2 = new View { X = 5, Y = 5, Width = 10, Height = 10 }; - + parent.Add (child1, child2); - + Assert.True (parent.Arrangement.HasFlag (ViewArrangement.Overlapped)); Assert.Equal (2, parent.SubViews.Count); } @@ -719,209 +731,7 @@ public class ArrangementTests (ITestOutputHelper output) #region Mouse Interaction Tests - [Fact] - public void MouseGrabHandler_WorksWithMovableView_UsingNewMouseEvent () - { - // This test proves that MouseGrabHandler works correctly with concurrent unit tests - // using NewMouseEvent directly on views, without requiring Application.Init - - var superView = new View - { - Width = 80, - Height = 25 - }; - - var movableView = new View - { - Arrangement = ViewArrangement.Movable, - BorderStyle = LineStyle.Single, - X = 10, - Y = 10, - Width = 20, - Height = 10 - }; - - superView.Add (movableView); - - // Verify initial state - Assert.NotNull (movableView.Border); - Assert.Null (Application.Mouse.MouseGrabView); - - // Simulate mouse press on the border to start dragging - var pressEvent = new MouseEventArgs - { - Position = new (1, 0), // Top border area - Flags = MouseFlags.Button1Pressed - }; - - bool? result = movableView.Border.NewMouseEvent (pressEvent); - - // The border should have grabbed the mouse - Assert.True (result); - Assert.Equal (movableView.Border, Application.Mouse.MouseGrabView); - - // Simulate mouse drag - var dragEvent = new MouseEventArgs - { - Position = new (5, 2), - Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition - }; - - result = movableView.Border.NewMouseEvent (dragEvent); - Assert.True (result); - - // Mouse should still be grabbed - Assert.Equal (movableView.Border, Application.Mouse.MouseGrabView); - - // Simulate mouse release to end dragging - var releaseEvent = new MouseEventArgs - { - Position = new (5, 2), - Flags = MouseFlags.Button1Released - }; - - result = movableView.Border.NewMouseEvent (releaseEvent); - Assert.True (result); - - // Mouse should be released - Assert.Null (Application.Mouse.MouseGrabView); - } - - [Fact] - public void MouseGrabHandler_WorksWithResizableView_UsingNewMouseEvent () - { - // This test proves MouseGrabHandler works for resizing operations - - var superView = new View - { - Width = 80, - Height = 25 - }; - - var resizableView = new View - { - Arrangement = ViewArrangement.RightResizable, - BorderStyle = LineStyle.Single, - X = 10, - Y = 10, - Width = 20, - Height = 10 - }; - - superView.Add (resizableView); - - // Verify initial state - Assert.NotNull (resizableView.Border); - Assert.Null (Application.Mouse.MouseGrabView); - - // Calculate position on right border (border is at right edge) - // Border.Frame.X is relative to parent, so we use coordinates relative to the border - var pressEvent = new MouseEventArgs - { - Position = new (resizableView.Border.Frame.Width - 1, 5), // Right border area - Flags = MouseFlags.Button1Pressed - }; - - bool? result = resizableView.Border.NewMouseEvent (pressEvent); - - // The border should have grabbed the mouse for resizing - Assert.True (result); - Assert.Equal (resizableView.Border, Application.Mouse.MouseGrabView); - - // Simulate dragging to resize - var dragEvent = new MouseEventArgs - { - Position = new (resizableView.Border.Frame.Width + 3, 5), - Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition - }; - - result = resizableView.Border.NewMouseEvent (dragEvent); - Assert.True (result); - Assert.Equal (resizableView.Border, Application.Mouse.MouseGrabView); - - // Simulate mouse release - var releaseEvent = new MouseEventArgs - { - Position = new (resizableView.Border.Frame.Width + 3, 5), - Flags = MouseFlags.Button1Released - }; - - result = resizableView.Border.NewMouseEvent (releaseEvent); - Assert.True (result); - - // Mouse should be released - Assert.Null (Application.Mouse.MouseGrabView); - } - - [Fact] - public void MouseGrabHandler_ReleasesOnMultipleViews () - { - // This test verifies MouseGrabHandler properly releases when switching between views - - var superView = new View { Width = 80, Height = 25 }; - - var view1 = new View - { - Arrangement = ViewArrangement.Movable, - BorderStyle = LineStyle.Single, - X = 10, - Y = 10, - Width = 15, - Height = 8 - }; - - var view2 = new View - { - Arrangement = ViewArrangement.Movable, - BorderStyle = LineStyle.Single, - X = 30, - Y = 10, - Width = 15, - Height = 8 - }; - - superView.Add (view1, view2); - - // Grab mouse on first view - var pressEvent1 = new MouseEventArgs - { - Position = new (1, 0), - Flags = MouseFlags.Button1Pressed - }; - - view1.Border!.NewMouseEvent (pressEvent1); - Assert.Equal (view1.Border, Application.Mouse.MouseGrabView); - - // Release on first view - var releaseEvent1 = new MouseEventArgs - { - Position = new (1, 0), - Flags = MouseFlags.Button1Released - }; - - view1.Border.NewMouseEvent (releaseEvent1); - Assert.Null (Application.Mouse.MouseGrabView); - - // Grab mouse on second view - var pressEvent2 = new MouseEventArgs - { - Position = new (1, 0), - Flags = MouseFlags.Button1Pressed - }; - - view2.Border!.NewMouseEvent (pressEvent2); - Assert.Equal (view2.Border, Application.Mouse.MouseGrabView); - - // Release on second view - var releaseEvent2 = new MouseEventArgs - { - Position = new (1, 0), - Flags = MouseFlags.Button1Released - }; - - view2.Border.NewMouseEvent (releaseEvent2); - Assert.Null (Application.Mouse.MouseGrabView); - } + // Not parallelizable due to Application.Mouse dependency in MouseGrabHandler #endregion @@ -954,13 +764,13 @@ public class ArrangementTests (ITestOutputHelper output) // This test verifies that all the arrangement tests in this file // can run without Application.Init, making them parallelizable. // If this test passes, it confirms no Application dependencies leaked in. - - var view = new View - { + + var view = new View + { Arrangement = ViewArrangement.Movable | ViewArrangement.Resizable, BorderStyle = LineStyle.Single }; - + Assert.NotNull (view); Assert.NotNull (view.Border); Assert.True (view.Arrangement.HasFlag (ViewArrangement.Movable)); @@ -974,9 +784,9 @@ public class ArrangementTests (ITestOutputHelper output) [Fact] public void ViewArrangement_CanCombineAllResizableDirections () { - ViewArrangement arrangement = ViewArrangement.TopResizable - | ViewArrangement.BottomResizable - | ViewArrangement.LeftResizable + ViewArrangement arrangement = ViewArrangement.TopResizable + | ViewArrangement.BottomResizable + | ViewArrangement.LeftResizable | ViewArrangement.RightResizable; Assert.True (arrangement.HasFlag (ViewArrangement.TopResizable)); @@ -1090,7 +900,7 @@ public class ArrangementTests (ITestOutputHelper output) public void View_MultipleSubviewsWithDifferentArrangements_EachIndependent () { var container = new View (); - + var fixedView = new View { Id = "fixed", Arrangement = ViewArrangement.Fixed }; var movableView = new View { Id = "movable", Arrangement = ViewArrangement.Movable }; var resizableView = new View { Id = "resizable", Arrangement = ViewArrangement.Resizable }; @@ -1112,7 +922,7 @@ public class ArrangementTests (ITestOutputHelper output) public void Overlapped_ViewCanBeMovedToFront () { var container = new View { Arrangement = ViewArrangement.Overlapped }; - + var view1 = new View { Id = "view1" }; var view2 = new View { Id = "view2" }; var view3 = new View { Id = "view3" }; @@ -1133,7 +943,7 @@ public class ArrangementTests (ITestOutputHelper output) public void Overlapped_ViewCanBeMovedToBack () { var container = new View { Arrangement = ViewArrangement.Overlapped }; - + var view1 = new View { Id = "view1" }; var view2 = new View { Id = "view2" }; var view3 = new View { Id = "view3" }; @@ -1142,12 +952,12 @@ public class ArrangementTests (ITestOutputHelper output) // Initial order: [view1, view2, view3] Assert.Equal ([view1, view2, view3], container.SubViews.ToArray ()); - + // Move view3 to end (top of Z-order) container.MoveSubViewToEnd (view3); Assert.Equal (view3, container.SubViews.ToArray () [^1]); Assert.Equal ([view1, view2, view3], container.SubViews.ToArray ()); - + // Now move view1 to end (making it on top, pushing view3 down) container.MoveSubViewToEnd (view1); Assert.Equal ([view2, view3, view1], container.SubViews.ToArray ()); @@ -1157,7 +967,7 @@ public class ArrangementTests (ITestOutputHelper output) public void Fixed_ViewAddOrderMattersForLayout () { var container = new View { Arrangement = ViewArrangement.Fixed }; - + var view1 = new View { Id = "view1", X = 0, Y = 0, Width = 10, Height = 5 }; var view2 = new View { Id = "view2", X = 5, Y = 2, Width = 10, Height = 5 }; diff --git a/Tests/UnitTestsParallelizable/View/Draw/NeedsDrawTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Draw/NeedsDrawTests.cs similarity index 91% rename from Tests/UnitTestsParallelizable/View/Draw/NeedsDrawTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Draw/NeedsDrawTests.cs index cf3b7a0c8..07f76890d 100644 --- a/Tests/UnitTestsParallelizable/View/Draw/NeedsDrawTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Draw/NeedsDrawTests.cs @@ -1,8 +1,10 @@ #nullable enable -namespace UnitTests_Parallelizable.ViewTests; +using UnitTests; + +namespace ViewBaseTests.Drawing; [Trait ("Category", "Output")] -public class NeedsDrawTests +public class NeedsDrawTests : FakeDriverBase { [Fact] public void NeedsDraw_False_If_Width_Height_Zero () @@ -18,7 +20,7 @@ public class NeedsDrawTests [Fact] public void NeedsDraw_True_Initially_If_Width_Height_Not_Zero () { - View superView = new () { Width = 1, Height = 1 }; + View superView = new () { Driver = CreateFakeDriver (), Width = 1, Height = 1 }; View view1 = new () { Width = 1, Height = 1 }; View view2 = new () { Width = 1, Height = 1 }; @@ -54,7 +56,7 @@ public class NeedsDrawTests var view = new View { Width = 2, Height = 2 }; Assert.True (view.NeedsDraw); - view = new() { Width = 2, Height = 2, BorderStyle = LineStyle.Single }; + view = new () { Width = 2, Height = 2, BorderStyle = LineStyle.Single }; Assert.True (view.NeedsDraw); } @@ -90,7 +92,7 @@ public class NeedsDrawTests view.EndInit (); Assert.True (view.NeedsDraw); - view = new() { Width = 2, Height = 2, BorderStyle = LineStyle.Single }; + view = new () { Width = 2, Height = 2, BorderStyle = LineStyle.Single }; view.BeginInit (); view.NeedsDraw = false; view.EndInit (); @@ -100,7 +102,7 @@ public class NeedsDrawTests [Fact] public void NeedsDraw_After_SetLayoutNeeded_And_Layout () { - var view = new View { Width = 2, Height = 2 }; + var view = new View { Driver = CreateFakeDriver (), Width = 2, Height = 2 }; Assert.True (view.NeedsDraw); Assert.False (view.NeedsLayout); @@ -120,7 +122,7 @@ public class NeedsDrawTests [Fact] public void NeedsDraw_False_After_SetRelativeLayout_Absolute_Dims () { - var view = new View { Width = 2, Height = 2 }; + var view = new View { Driver = CreateFakeDriver (), Width = 2, Height = 2 }; Assert.True (view.NeedsDraw); view.Draw (); @@ -128,14 +130,14 @@ public class NeedsDrawTests Assert.False (view.NeedsLayout); // SRL won't change anything since the view frame wasn't changed - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); Assert.False (view.NeedsDraw); view.SetNeedsLayout (); // SRL won't change anything since the view frame wasn't changed // SRL doesn't depend on NeedsLayout, but LayoutSubViews does - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); Assert.False (view.NeedsDraw); Assert.True (view.NeedsLayout); @@ -178,7 +180,7 @@ public class NeedsDrawTests Assert.True (view.NeedsDraw); Assert.True (superView.NeedsDraw); - superView.SetRelativeLayout (Application.Screen.Size); + superView.SetRelativeLayout (new (100, 100)); Assert.True (view.NeedsDraw); Assert.True (superView.NeedsDraw); } @@ -214,7 +216,7 @@ public class NeedsDrawTests view.EndInit (); Assert.True (view.NeedsDraw); - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); Assert.True (view.NeedsDraw); view.LayoutSubViews (); @@ -224,7 +226,7 @@ public class NeedsDrawTests [Fact] public void NeedsDraw_False_After_Draw () { - var view = new View { Width = 2, Height = 2, BorderStyle = LineStyle.Single }; + var view = new View { Driver = CreateFakeDriver (), Width = 2, Height = 2, BorderStyle = LineStyle.Single }; Assert.True (view.NeedsDraw); view.BeginInit (); @@ -233,7 +235,7 @@ public class NeedsDrawTests view.EndInit (); Assert.True (view.NeedsDraw); - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); Assert.True (view.NeedsDraw); view.LayoutSubViews (); diff --git a/Tests/UnitTestsParallelizable/View/SchemeTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Draw/SchemeTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/SchemeTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Draw/SchemeTests.cs index 57234c171..3642bed52 100644 --- a/Tests/UnitTestsParallelizable/View/SchemeTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Draw/SchemeTests.cs @@ -2,7 +2,7 @@ using UnitTests; using Xunit; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Drawing; [Trait ("Category", "View.Scheme")] public class SchemeTests : FakeDriverBase @@ -198,7 +198,7 @@ public class SchemeTests : FakeDriverBase Assert.Contains ("Dialog", schemes.Keys); Assert.Contains ("Error", schemes.Keys); Assert.Contains ("Menu", schemes.Keys); - Assert.Contains ("Toplevel", schemes.Keys); + Assert.Contains ("Runnable", schemes.Keys); } diff --git a/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewClearViewportTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewClearViewportTests.cs new file mode 100644 index 000000000..0115ef52b --- /dev/null +++ b/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewClearViewportTests.cs @@ -0,0 +1,371 @@ +#nullable disable +using System.Text; +using UnitTests; + +namespace ViewBaseTests.Viewport; + +public class ViewClearViewportTests () : FakeDriverBase +{ + [Fact] + public void ClearViewport_FillsViewportArea () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 1, + Y = 1, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // Clear the driver contents first + driver.FillRect (driver.Screen, new Rune ('X')); + + view.ClearViewport (); + + // The viewport area should be filled with spaces + Rectangle viewportScreen = view.ViewportToScreen (view.Viewport with { Location = new (0, 0) }); + + for (int y = viewportScreen.Y; y < viewportScreen.Y + viewportScreen.Height; y++) + { + for (int x = viewportScreen.X; x < viewportScreen.X + viewportScreen.Width; x++) + { + Assert.Equal (" ", driver.Contents [y, x].Grapheme); + } + } + } + + [Fact] + public void ClearViewport_WithClearContentOnly_LimitsToVisibleContent () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 1, + Y = 1, + Width = 20, + Height = 20, + Driver = driver + }; + view.SetContentSize (new Size (100, 100)); // Content larger than viewport + view.ViewportSettings = ViewportSettingsFlags.ClearContentOnly; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // Clear the driver contents first + driver.FillRect (driver.Screen, new Rune ('X')); + + view.ClearViewport (); + + // The visible content area should be cleared + Rectangle visibleContent = view.ViewportToScreen (new Rectangle (new (-view.Viewport.X, -view.Viewport.Y), view.GetContentSize ())); + Rectangle viewportScreen = view.ViewportToScreen (view.Viewport with { Location = new (0, 0) }); + Rectangle toClear = Rectangle.Intersect (viewportScreen, visibleContent); + + for (int y = toClear.Y; y < toClear.Y + toClear.Height; y++) + { + for (int x = toClear.X; x < toClear.X + toClear.Width; x++) + { + Assert.Equal (" ", driver.Contents [y, x].Grapheme); + } + } + } + + [Fact] + public void ClearViewport_NullDriver_DoesNotThrow () + { + var view = new View + { + X = 1, + Y = 1, + Width = 20, + Height = 20 + }; + view.BeginInit (); + view.EndInit (); + var exception = Record.Exception (() => view.ClearViewport ()); + Assert.Null (exception); + } + + [Fact] + public void ClearViewport_SetsNeedsDraw () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // Clear NeedsDraw first + view.Draw (); + Assert.False (view.NeedsDraw); + + view.ClearViewport (); + + Assert.True (view.NeedsDraw); + } + + [Fact] + public void ClearViewport_WithTransparentFlag_DoesNotClear () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 1, + Y = 1, + Width = 20, + Height = 20, + Driver = driver, + ViewportSettings = ViewportSettingsFlags.Transparent + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // Fill driver with a character + driver.FillRect (driver.Screen, new Rune ('X')); + + view.Draw (); + + // The viewport area should still have 'X' (not cleared) + Rectangle viewportScreen = view.ViewportToScreen (view.Viewport with { Location = new (0, 0) }); + + for (int y = viewportScreen.Y; y < viewportScreen.Y + viewportScreen.Height; y++) + { + for (int x = viewportScreen.X; x < viewportScreen.X + viewportScreen.Width; x++) + { + Assert.Equal ("X", driver.Contents [y, x].Grapheme); + } + } + } + + [Fact] + public void ClearingViewport_Event_Raised () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + bool eventRaised = false; + Rectangle? receivedRect = null; + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.ClearingViewport += (s, e) => + { + eventRaised = true; + receivedRect = e.NewViewport; + }; + + view.Draw (); + + Assert.True (eventRaised); + Assert.NotNull (receivedRect); + Assert.Equal (view.Viewport, receivedRect); + } + + [Fact] + public void ClearedViewport_Event_Raised () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + bool eventRaised = false; + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.ClearedViewport += (s, e) => eventRaised = true; + + view.Draw (); + + Assert.True (eventRaised); + } + + [Fact] + public void OnClearingViewport_CanPreventClear () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + bool clearedCalled = false; + + var view = new TestView + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver, + PreventClear = true + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.ClearedViewport += (s, e) => clearedCalled = true; + + view.Draw (); + + Assert.False (clearedCalled); + } + + [Fact] + public void ClearViewport_EmptyViewport_DoesNotThrow () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 1, + Height = 1, + Driver = driver + }; + view.Border!.Thickness = new Thickness (1); + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // With border of 1, viewport should be empty + Assert.True (view.Viewport.Width == 0 || view.Viewport.Height == 0); + + var exception = Record.Exception (() => view.ClearViewport ()); + + Assert.Null (exception); + } + + [Fact] + public void ClearViewport_WithScrolledViewport_ClearsCorrectArea () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 1, + Y = 1, + Width = 20, + Height = 20, + Driver = driver + }; + view.SetContentSize (new Size (100, 100)); + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // Scroll the viewport + view.Viewport = view.Viewport with { X = 10, Y = 10 }; + + // Fill driver with a character + driver.FillRect (driver.Screen, new Rune ('X')); + + view.ClearViewport (); + + // The viewport area should be cleared (not the scrolled content area) + Rectangle viewportScreen = view.ViewportToScreen (view.Viewport with { Location = new (0, 0) }); + + for (int y = viewportScreen.Y; y < viewportScreen.Y + viewportScreen.Height; y++) + { + for (int x = viewportScreen.X; x < viewportScreen.X + viewportScreen.Width; x++) + { + Assert.Equal (" ", driver.Contents [y, x].Grapheme); + } + } + } + + [Fact] + public void ClearViewport_WithClearContentOnly_AndScrolledViewport_ClearsOnlyVisibleContent () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver + }; + view.SetContentSize (new Size (15, 15)); // Content smaller than viewport + view.ViewportSettings = ViewportSettingsFlags.ClearContentOnly; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // Scroll past the content + view.Viewport = view.Viewport with { X = 5, Y = 5 }; + + // Fill driver with a character + driver.FillRect (driver.Screen, new Rune ('X')); + + view.ClearViewport (); + + // Only the visible part of the content should be cleared + Rectangle visibleContent = view.ViewportToScreen (new Rectangle (new (-view.Viewport.X, -view.Viewport.Y), view.GetContentSize ())); + Rectangle viewportScreen = view.ViewportToScreen (view.Viewport with { Location = new (0, 0) }); + Rectangle toClear = Rectangle.Intersect (viewportScreen, visibleContent); + + if (toClear != Rectangle.Empty) + { + for (int y = toClear.Y; y < toClear.Y + toClear.Height; y++) + { + for (int x = toClear.X; x < toClear.X + toClear.Width; x++) + { + Assert.Equal (" ", driver.Contents[y, x].Grapheme); + } + } + } + } + + private class TestView : View + { + public bool PreventClear { get; set; } + + protected override bool OnClearingViewport () + { + return PreventClear || base.OnClearingViewport (); + } + } +} diff --git a/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewDrawTextAndLineCanvasTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewDrawTextAndLineCanvasTests.cs new file mode 100644 index 000000000..49dff4476 --- /dev/null +++ b/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewDrawTextAndLineCanvasTests.cs @@ -0,0 +1,495 @@ +using System.Text; +using UnitTests; +using Xunit.Abstractions; + +namespace ViewBaseTests.Drawing; + +public class ViewDrawTextAndLineCanvasTests () : FakeDriverBase +{ + #region DrawText Tests + + [Fact] + public void DrawText_EmptyText_DoesNotThrow () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver, + Text = "" + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + var exception = Record.Exception (() => view.Draw ()); + + Assert.Null (exception); + } + + [Fact] + public void DrawText_NullText_DoesNotThrow () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver, + Text = null! + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + var exception = Record.Exception (() => view.Draw ()); + + Assert.Null (exception); + } + + [Fact] + public void DrawText_DrawsTextToDriver () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 1, + Y = 1, + Width = 20, + Height = 20, + Driver = driver, + Text = "Test" + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.Draw (); + + // Text should appear at the content location + Point screenPos = view.ContentToScreen (Point.Empty); + + Assert.Equal ("T", driver.Contents! [screenPos.Y, screenPos.X].Grapheme); + Assert.Equal ("e", driver.Contents [screenPos.Y, screenPos.X + 1].Grapheme); + Assert.Equal ("s", driver.Contents [screenPos.Y, screenPos.X + 2].Grapheme); + Assert.Equal ("t", driver.Contents [screenPos.Y, screenPos.X + 3].Grapheme); + } + + [Fact] + public void DrawText_WithFocus_UsesFocusAttribute () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver, + Text = "Test", + CanFocus = true + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + view.SetFocus (); + + view.Draw (); + + // Text should use focus attribute + Point screenPos = view.ContentToScreen (Point.Empty); + Attribute expectedAttr = view.GetAttributeForRole (VisualRole.Focus); + + Assert.Equal (expectedAttr, driver.Contents! [screenPos.Y, screenPos.X].Attribute); + } + + [Fact] + public void DrawText_WithoutFocus_UsesNormalAttribute () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver, + Text = "Test", + CanFocus = true + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.Draw (); + + // Text should use normal attribute + Point screenPos = view.ContentToScreen (Point.Empty); + Attribute expectedAttr = view.GetAttributeForRole (VisualRole.Normal); + + Assert.Equal (expectedAttr, driver.Contents! [screenPos.Y, screenPos.X].Attribute); + } + + [Fact] + public void DrawText_SetsSubViewNeedsDraw () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver, + Text = "Test" + }; + var child = new View { X = 0, Y = 0, Width = 10, Height = 10 }; + view.Add (child); + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // Clear SubViewNeedsDraw + view.Draw (); + Assert.False (view.SubViewNeedsDraw); + + // Call DrawText directly which should set SubViewNeedsDraw + view.DrawText (); + + // SubViews need to be redrawn since text was drawn over them + Assert.True (view.SubViewNeedsDraw); + } + + [Fact] + public void DrawingText_Event_Raised () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + bool eventRaised = false; + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver, + Text = "Test" + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.DrawingText += (s, e) => eventRaised = true; + + view.Draw (); + + Assert.True (eventRaised); + } + + [Fact] + public void DrewText_Event_Raised () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + bool eventRaised = false; + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver, + Text = "Test" + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.DrewText += (s, e) => eventRaised = true; + + view.Draw (); + + Assert.True (eventRaised); + } + + #endregion + + #region LineCanvas Tests + + [Fact] + public void LineCanvas_InitiallyEmpty () + { + var view = new View (); + + Assert.NotNull (view.LineCanvas); + Assert.Equal (Rectangle.Empty, view.LineCanvas.Bounds); + } + + [Fact] + public void RenderLineCanvas_DrawsLines () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // Add a line to the canvas + Point screenPos = new Point (15, 15); + view.LineCanvas.AddLine (screenPos, 5, Orientation.Horizontal, LineStyle.Single); + + view.RenderLineCanvas (); + + // Verify the line was drawn (check for horizontal line character) + for (int i = 0; i < 5; i++) + { + Assert.NotEqual (" ", driver.Contents! [screenPos.Y, screenPos.X + i].Grapheme); + } + } + + [Fact] + public void RenderLineCanvas_ClearsAfterRendering () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // Add a line to the canvas + view.LineCanvas.AddLine (new Point (15, 15), 5, Orientation.Horizontal, LineStyle.Single); + + Assert.NotEqual (Rectangle.Empty, view.LineCanvas.Bounds); + + view.RenderLineCanvas (); + + // LineCanvas should be cleared after rendering + Assert.Equal (Rectangle.Empty, view.LineCanvas.Bounds); + } + + [Fact] + public void RenderLineCanvas_WithSuperViewRendersLineCanvas_DoesNotClear () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver, + SuperViewRendersLineCanvas = true + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // Add a line to the canvas + view.LineCanvas.AddLine (new Point (15, 15), 5, Orientation.Horizontal, LineStyle.Single); + + Rectangle boundsBefore = view.LineCanvas.Bounds; + + view.RenderLineCanvas (); + + // LineCanvas should NOT be cleared when SuperViewRendersLineCanvas is true + Assert.Equal (boundsBefore, view.LineCanvas.Bounds); + } + + [Fact] + public void SuperViewRendersLineCanvas_MergesWithParentCanvas () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var parent = new View + { + X = 10, + Y = 10, + Width = 50, + Height = 50, + Driver = driver + }; + var child = new View + { + X = 5, + Y = 5, + Width = 30, + Height = 30, + SuperViewRendersLineCanvas = true + }; + parent.Add (child); + parent.BeginInit (); + parent.EndInit (); + parent.LayoutSubViews (); + + // Add a line to child's canvas + child.LineCanvas.AddLine (new Point (20, 20), 5, Orientation.Horizontal, LineStyle.Single); + + Assert.NotEqual (Rectangle.Empty, child.LineCanvas.Bounds); + Assert.Equal (Rectangle.Empty, parent.LineCanvas.Bounds); + + parent.Draw (); + + // Child's canvas should have been merged into parent's + // and child's canvas should be cleared + Assert.Equal (Rectangle.Empty, child.LineCanvas.Bounds); + } + + [Fact] + public void OnRenderingLineCanvas_CanPreventRendering () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new TestView + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver, + PreventRenderLineCanvas = true + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // Add a line to the canvas + Point screenPos = new Point (15, 15); + view.LineCanvas.AddLine (screenPos, 5, Orientation.Horizontal, LineStyle.Single); + + view.Draw (); + + // When OnRenderingLineCanvas returns true, RenderLineCanvas is not called + // So the LineCanvas should still have lines (not cleared) + // BUT because SuperViewRendersLineCanvas is false (default), the LineCanvas + // gets cleared during the draw cycle anyway. We need to check that the + // line was NOT actually rendered to the driver. + bool lineRendered = true; + for (int i = 0; i < 5; i++) + { + if (driver.Contents! [screenPos.Y, screenPos.X + i].Grapheme == " ") + { + lineRendered = false; + break; + } + } + + Assert.False (lineRendered); + } + + #endregion + + #region SuperViewRendersLineCanvas Tests + + [Fact] + public void SuperViewRendersLineCanvas_DefaultFalse () + { + var view = new View (); + + Assert.False (view.SuperViewRendersLineCanvas); + } + + [Fact] + public void SuperViewRendersLineCanvas_CanBeSet () + { + var view = new View { SuperViewRendersLineCanvas = true }; + + Assert.True (view.SuperViewRendersLineCanvas); + } + + [Fact] + public void Draw_WithSuperViewRendersLineCanvas_SetsNeedsDraw () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var parent = new View + { + X = 10, + Y = 10, + Width = 50, + Height = 50, + Driver = driver + }; + var child = new View + { + X = 5, + Y = 5, + Width = 30, + Height = 30, + SuperViewRendersLineCanvas = true + }; + parent.Add (child); + parent.BeginInit (); + parent.EndInit (); + parent.LayoutSubViews (); + + // Draw once to clear NeedsDraw + parent.Draw (); + Assert.False (child.NeedsDraw); + + // Draw again - child with SuperViewRendersLineCanvas should be redrawn + parent.Draw (); + + // The child should have been set to NeedsDraw during DrawSubViews + // This is verified by the fact that it was drawn (we can't check NeedsDraw after Draw) + } + + #endregion + + #region Helper Test View + + private class TestView : View + { + public bool PreventRenderLineCanvas { get; set; } + + protected override bool OnRenderingLineCanvas () + { + return PreventRenderLineCanvas || base.OnRenderingLineCanvas (); + } + } + + #endregion +} diff --git a/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewDrawingClippingTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewDrawingClippingTests.cs new file mode 100644 index 000000000..220487dcd --- /dev/null +++ b/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewDrawingClippingTests.cs @@ -0,0 +1,736 @@ +#nullable enable +using UnitTests; +using Xunit.Abstractions; + +namespace ViewBaseTests.Drawing; + +public class ViewDrawingClippingTests () : FakeDriverBase +{ + #region GetClip / SetClip Tests + + + [Fact] + public void GetClip_ReturnsDriverClip () + { + IDriver driver = CreateFakeDriver (80, 25); + var region = new Region (new Rectangle (10, 10, 20, 20)); + driver.Clip = region; + View view = new () { Driver = driver }; + + Region? result = view.GetClip (); + + Assert.NotNull (result); + Assert.Equal (region, result); + } + + [Fact] + public void SetClip_NullRegion_DoesNothing () + { + IDriver driver = CreateFakeDriver (80, 25); + var original = new Region (new Rectangle (5, 5, 10, 10)); + driver.Clip = original; + + View view = new () { Driver = driver }; + + view.SetClip (null); + + Assert.Equal (original, driver.Clip); + } + + [Fact] + public void SetClip_ValidRegion_SetsDriverClip () + { + IDriver driver = CreateFakeDriver (80, 25); + var region = new Region (new Rectangle (10, 10, 30, 30)); + View view = new () { Driver = driver }; + + view.SetClip (region); + + Assert.Equal (region, driver.Clip); + } + + #endregion + + #region SetClipToScreen Tests + + [Fact] + public void SetClipToScreen_ReturnsPreviousClip () + { + IDriver driver = CreateFakeDriver (80, 25); + var original = new Region (new Rectangle (5, 5, 10, 10)); + driver.Clip = original; + View view = new () { Driver = driver }; + + Region? previous = view.SetClipToScreen (); + + Assert.Equal (original, previous); + Assert.NotEqual (original, driver.Clip); + } + + [Fact] + public void SetClipToScreen_SetsClipToScreen () + { + IDriver driver = CreateFakeDriver (80, 25); + View view = new () { Driver = driver }; + + view.SetClipToScreen (); + + Assert.NotNull (driver.Clip); + Assert.Equal (driver.Screen, driver.Clip.GetBounds ()); + } + + #endregion + + #region ExcludeFromClip Tests + + [Fact] + public void ExcludeFromClip_Rectangle_NullDriver_DoesNotThrow () + { + View view = new () { Driver = null }; + var exception = Record.Exception (() => view.ExcludeFromClip (new Rectangle (5, 5, 10, 10))); + Assert.Null (exception); + } + + [Fact] + public void ExcludeFromClip_Rectangle_ExcludesArea () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (new Rectangle (0, 0, 80, 25)); + View view = new () { Driver = driver }; + + var toExclude = new Rectangle (10, 10, 20, 20); + view.ExcludeFromClip (toExclude); + + // Verify the region was excluded + Assert.NotNull (driver.Clip); + Assert.False (driver.Clip.Contains (15, 15)); + } + + [Fact] + public void ExcludeFromClip_Region_NullDriver_DoesNotThrow () + { + View view = new () { Driver = null }; + + var exception = Record.Exception (() => view.ExcludeFromClip (new Region (new Rectangle (5, 5, 10, 10)))); + Assert.Null (exception); + } + + [Fact] + public void ExcludeFromClip_Region_ExcludesArea () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (new Rectangle (0, 0, 80, 25)); + View view = new () { Driver = driver }; + + + var toExclude = new Region (new Rectangle (10, 10, 20, 20)); + view.ExcludeFromClip (toExclude); + + // Verify the region was excluded + Assert.NotNull (driver.Clip); + Assert.False (driver.Clip.Contains (15, 15)); + } + + #endregion + + #region AddFrameToClip Tests + + [Fact] + public void AddFrameToClip_NullDriver_ReturnsNull () + { + var view = new View { X = 0, Y = 0, Width = 10, Height = 10 }; + view.BeginInit (); + view.EndInit (); + + Region? result = view.AddFrameToClip (); + + Assert.Null (result); + } + + [Fact] + public void AddFrameToClip_IntersectsWithFrame () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 1, + Y = 1, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + Region? previous = view.AddFrameToClip (); + + Assert.NotNull (previous); + Assert.NotNull (driver.Clip); + + // The clip should now be the intersection of the screen and the view's frame + Rectangle expectedBounds = new Rectangle (1, 1, 20, 20); + Assert.Equal (expectedBounds, driver.Clip.GetBounds ()); + } + + #endregion + + #region AddViewportToClip Tests + + [Fact] + public void AddViewportToClip_NullDriver_ReturnsNull () + { + var view = new View { X = 0, Y = 0, Width = 10, Height = 10 }; + view.BeginInit (); + view.EndInit (); + + Region? result = view.AddViewportToClip (); + + Assert.Null (result); + } + + [Fact] + public void AddViewportToClip_IntersectsWithViewport () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 1, + Y = 1, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + Region? previous = view.AddViewportToClip (); + + Assert.NotNull (previous); + Assert.NotNull (driver.Clip); + + // The clip should be the viewport area + Rectangle viewportScreen = view.ViewportToScreen (new Rectangle (Point.Empty, view.Viewport.Size)); + Assert.Equal (viewportScreen, driver.Clip.GetBounds ()); + } + + [Fact] + public void AddViewportToClip_WithClipContentOnly_LimitsToVisibleContent () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 1, + Y = 1, + Width = 20, + Height = 20, + Driver = driver + }; + view.SetContentSize (new Size (100, 100)); + view.ViewportSettings = ViewportSettingsFlags.ClipContentOnly; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + Region? previous = view.AddViewportToClip (); + + Assert.NotNull (previous); + Assert.NotNull (driver.Clip); + + // The clip should be limited to visible content + Rectangle visibleContent = view.ViewportToScreen (new Rectangle (new (-view.Viewport.X, -view.Viewport.Y), view.GetContentSize ())); + Rectangle viewport = view.ViewportToScreen (new Rectangle (Point.Empty, view.Viewport.Size)); + Rectangle expected = Rectangle.Intersect (viewport, visibleContent); + + Assert.Equal (expected, driver.Clip.GetBounds ()); + } + + #endregion + + #region Clip Interaction Tests + + [Fact] + public void ClipRegions_StackCorrectly_WithNestedViews () + { + IDriver driver = CreateFakeDriver (100, 100); + driver.Clip = new Region (driver.Screen); + + var superView = new View + { + X = 1, + Y = 1, + Width = 50, + Height = 50, + Driver = driver + }; + superView.BeginInit (); + superView.EndInit (); + + var view = new View + { + X = 5, + Y = 5, + Width = 30, + Height = 30, + }; + superView.Add (view); + superView.LayoutSubViews (); + + // Set clip to superView's frame + Region? superViewClip = superView.AddFrameToClip (); + Rectangle superViewBounds = driver.Clip.GetBounds (); + + // Now set clip to view's frame + Region? viewClip = view.AddFrameToClip (); + Rectangle viewBounds = driver.Clip.GetBounds (); + + // Child clip should be within superView clip + Assert.True (superViewBounds.Contains (viewBounds.Location)); + + // Restore superView clip + view.SetClip (superViewClip); + // Assert.Equal (superViewBounds, driver.Clip.GetBounds ()); + } + + [Fact] + public void ClipRegions_RespectPreviousClip () + { + IDriver driver = CreateFakeDriver (80, 25); + var initialClip = new Region (new Rectangle (20, 20, 40, 40)); + driver.Clip = initialClip; + + var view = new View + { + X = 1, + Y = 1, + Width = 60, + Height = 60, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + Region? previous = view.AddFrameToClip (); + + // The new clip should be the intersection of the initial clip and the view's frame + Rectangle expected = Rectangle.Intersect ( + initialClip.GetBounds (), + view.FrameToScreen () + ); + + Assert.Equal (expected, driver.Clip.GetBounds ()); + + // Restore should give us back the original + view.SetClip (previous); + Assert.Equal (initialClip.GetBounds (), driver.Clip.GetBounds ()); + } + + #endregion + + #region Edge Cases + + [Fact] + public void AddFrameToClip_EmptyFrame_WorksCorrectly () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 1, + Y = 1, + Width = 0, + Height = 0, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + Region? previous = view.AddFrameToClip (); + + Assert.NotNull (previous); + Assert.NotNull (driver.Clip); + } + + [Fact] + public void AddViewportToClip_EmptyViewport_WorksCorrectly () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 1, + Y = 1, + Width = 1, // Minimal size to have adornments + Height = 1, + Driver = driver + }; + view.Border!.Thickness = new Thickness (1); + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // With border thickness of 1, the viewport should be empty + Assert.True (view.Viewport.Size.Width == 0 || view.Viewport.Size.Height == 0); + + Region? previous = view.AddViewportToClip (); + + Assert.NotNull (previous); + } + + [Fact] + public void ClipRegions_OutOfBounds_HandledCorrectly () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 100, // Outside screen bounds + Y = 100, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + Region? previous = view.AddFrameToClip (); + + Assert.NotNull (previous); + // The clip should be empty since the view is outside the screen + Assert.True (driver.Clip.IsEmpty () || !driver.Clip.Contains (100, 100)); + } + + #endregion + + #region Drawing Tests + + [Fact] + public void Clip_Set_BeforeDraw_ClipsDrawing () + { + IDriver driver = CreateFakeDriver (80, 25); + var clip = new Region (new Rectangle (10, 10, 10, 10)); + driver.Clip = clip; + + var view = new View + { + X = 0, + Y = 0, + Width = 50, + Height = 50, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.Draw (); + + // Verify clip was used + Assert.NotNull (driver.Clip); + } + + [Fact] + public void Draw_UpdatesDriverClip () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 1, + Y = 1, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.Draw (); + + // Clip should be updated to exclude the drawn view + Assert.NotNull (driver.Clip); + // Assert.False (driver.Clip.Contains (15, 15)); // Point inside the view should be excluded + } + + [Fact] + public void Draw_WithSubViews_ClipsCorrectly () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var superView = new View + { + X = 1, + Y = 1, + Width = 50, + Height = 50, + Driver = driver + }; + var view = new View { X = 5, Y = 5, Width = 20, Height = 20 }; + superView.Add (view); + superView.BeginInit (); + superView.EndInit (); + superView.LayoutSubViews (); + + superView.Draw (); + + // Both superView and view should be excluded from clip + Assert.NotNull (driver.Clip); + // Assert.False (driver.Clip.Contains (15, 15)); // Point in superView should be excluded + } + + [Fact] + public void Draw_NonVisibleView_DoesNotUpdateClip () + { + IDriver driver = CreateFakeDriver (80, 25); + var originalClip = new Region (driver.Screen); + driver.Clip = originalClip.Clone (); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Visible = false, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + + view.Draw (); + + // Clip should not be modified for invisible views + Assert.True (driver.Clip.Equals (originalClip)); + } + + [Fact] + public void ExcludeFromClip_ExcludesRegion () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + var excludeRect = new Rectangle (15, 15, 10, 10); + view.ExcludeFromClip (excludeRect); + + Assert.NotNull (driver.Clip); + Assert.False (driver.Clip.Contains (20, 20)); // Point inside excluded rect should not be in clip + + } + + [Fact] + public void ExcludeFromClip_WithNullClip_DoesNotThrow () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = null!; + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver + }; + + var exception = Record.Exception (() => view.ExcludeFromClip (new Rectangle (15, 15, 10, 10))); + + Assert.Null (exception); + + } + + #endregion + + #region Misc Tests + + [Fact] + public void SetClip_SetsDriverClip () + { + IDriver driver = CreateFakeDriver (80, 25); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver + }; + + var newClip = new Region (new Rectangle (5, 5, 30, 30)); + view.SetClip (newClip); + + Assert.Equal (newClip, driver.Clip); + } + + [Fact (Skip = "See BUGBUG in SetClip")] + public void SetClip_WithNullClip_ClearsClip () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (new Rectangle (10, 10, 20, 20)); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver + }; + + view.SetClip (null); + + Assert.Null (driver.Clip); + } + + [Fact] + public void Draw_Excludes_View_From_Clip () + { + IDriver driver = CreateFakeDriver (80, 25); + var originalClip = new Region (driver.Screen); + driver.Clip = originalClip.Clone (); + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + Region clipWithViewExcluded = originalClip.Clone (); + clipWithViewExcluded.Exclude (view.Frame); + + view.Draw (); + + Assert.Equal (clipWithViewExcluded, driver.Clip); + Assert.NotNull (driver.Clip); + } + + [Fact] + public void Draw_EmptyViewport_DoesNotCrash () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 10, + Y = 10, + Width = 1, + Height = 1, + Driver = driver + }; + view.Border!.Thickness = new Thickness (1); + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // With border of 1, viewport should be empty (0x0 or negative) + var exception = Record.Exception (() => view.Draw ()); + + Assert.Null (exception); + } + + [Fact] + public void Draw_VeryLargeView_HandlesClippingCorrectly () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 0, + Y = 0, + Width = 1000, + Height = 1000, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + var exception = Record.Exception (() => view.Draw ()); + + Assert.Null (exception); + } + + [Fact] + public void Draw_NegativeCoordinates_HandlesClippingCorrectly () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = -10, + Y = -10, + Width = 50, + Height = 50, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + var exception = Record.Exception (() => view.Draw ()); + + Assert.Null (exception); + } + + [Fact] + public void Draw_OutOfScreenBounds_HandlesClippingCorrectly () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 100, + Y = 100, + Width = 50, + Height = 50, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + var exception = Record.Exception (() => view.Draw ()); + + Assert.Null (exception); + } + + #endregion +} diff --git a/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewDrawingFlowTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewDrawingFlowTests.cs new file mode 100644 index 000000000..7a429a042 --- /dev/null +++ b/Tests/UnitTestsParallelizable/ViewBase/Draw/ViewDrawingFlowTests.cs @@ -0,0 +1,698 @@ +#nullable enable +using UnitTests; +using Xunit.Abstractions; + +namespace ViewBaseTests.Drawing; + +public class ViewDrawingFlowTests () : FakeDriverBase +{ + #region NeedsDraw Tests + + [Fact] + public void NeedsDraw_InitiallyFalse_WhenNotVisible () + { + var view = new View { Visible = false }; + view.BeginInit (); + view.EndInit (); + + Assert.False (view.NeedsDraw); + } + + [Fact] + public void NeedsDraw_TrueAfterSetNeedsDraw () + { + var view = new View { X = 0, Y = 0, Width = 10, Height = 10 }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.SetNeedsDraw (); + + Assert.True (view.NeedsDraw); + } + + [Fact] + public void NeedsDraw_ClearedAfterDraw () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 0, + Y = 0, + Width = 10, + Height = 10, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.SetNeedsDraw (); + Assert.True (view.NeedsDraw); + + view.Draw (); + + Assert.False (view.NeedsDraw); + } + + [Fact] + public void SetNeedsDraw_WithRectangle_UpdatesNeedsDrawRect () + { + var view = new View { Driver = CreateFakeDriver (), X = 0, Y = 0, Width = 20, Height = 20 }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // After layout, view will have NeedsDrawRect set to the viewport + // We need to clear it first + view.Draw (); + Assert.False (view.NeedsDraw); + Assert.Equal (Rectangle.Empty, view.NeedsDrawRect); + + var rect = new Rectangle (5, 5, 10, 10); + view.SetNeedsDraw (rect); + + Assert.True (view.NeedsDraw); + Assert.Equal (rect, view.NeedsDrawRect); + } + + [Fact] + public void SetNeedsDraw_MultipleRectangles_Expands () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View { X = 0, Y = 0, Width = 30, Height = 30, Driver = driver }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + // After layout, clear NeedsDraw + view.Draw (); + Assert.False (view.NeedsDraw); + + view.SetNeedsDraw (new Rectangle (5, 5, 10, 10)); + view.SetNeedsDraw (new Rectangle (15, 15, 10, 10)); + + // Should expand to cover the entire viewport when we have overlapping regions + // The current implementation expands to viewport size + Rectangle expected = new Rectangle (0, 0, 30, 30); + Assert.Equal (expected, view.NeedsDrawRect); + } + + [Fact] + public void SetNeedsDraw_NotVisible_DoesNotSet () + { + var view = new View + { + X = 0, + Y = 0, + Width = 10, + Height = 10, + Visible = false + }; + view.BeginInit (); + view.EndInit (); + + view.SetNeedsDraw (); + + Assert.False (view.NeedsDraw); + } + + [Fact] + public void SetNeedsDraw_PropagatesToSuperView () + { + var parent = new View { X = 0, Y = 0, Width = 50, Height = 50 }; + var child = new View { X = 10, Y = 10, Width = 20, Height = 20 }; + parent.Add (child); + parent.BeginInit (); + parent.EndInit (); + parent.LayoutSubViews (); + + child.SetNeedsDraw (); + + Assert.True (child.NeedsDraw); + Assert.True (parent.SubViewNeedsDraw); + } + + [Fact] + public void SetNeedsDraw_SetsAdornmentsNeedsDraw () + { + var view = new View { X = 0, Y = 0, Width = 20, Height = 20 }; + view.Border!.Thickness = new Thickness (1); + view.Padding!.Thickness = new Thickness (1); + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.SetNeedsDraw (); + + Assert.True (view.Border!.NeedsDraw); + Assert.True (view.Padding!.NeedsDraw); + } + + #endregion + + #region SubViewNeedsDraw Tests + + [Fact] + public void SubViewNeedsDraw_InitiallyFalse () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View { Width = 10, Height = 10, Driver = driver }; + view.BeginInit (); + view.EndInit (); + view.Draw (); // Draw once to clear initial NeedsDraw + + Assert.False (view.SubViewNeedsDraw); + } + + [Fact] + public void SetSubViewNeedsDraw_PropagatesUp () + { + var grandparent = new View { X = 0, Y = 0, Width = 100, Height = 100 }; + var parent = new View { X = 10, Y = 10, Width = 50, Height = 50 }; + var child = new View { X = 5, Y = 5, Width = 20, Height = 20 }; + + grandparent.Add (parent); + parent.Add (child); + grandparent.BeginInit (); + grandparent.EndInit (); + grandparent.LayoutSubViews (); + + child.SetSubViewNeedsDraw (); + + Assert.True (child.SubViewNeedsDraw); + Assert.True (parent.SubViewNeedsDraw); + Assert.True (grandparent.SubViewNeedsDraw); + } + + [Fact] + public void SubViewNeedsDraw_ClearedAfterDraw () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var parent = new View + { + X = 0, + Y = 0, + Width = 50, + Height = 50, + Driver = driver + }; + var child = new View { X = 10, Y = 10, Width = 20, Height = 20 }; + parent.Add (child); + parent.BeginInit (); + parent.EndInit (); + parent.LayoutSubViews (); + + child.SetNeedsDraw (); + Assert.True (parent.SubViewNeedsDraw); + + parent.Draw (); + + Assert.False (parent.SubViewNeedsDraw); + Assert.False (child.SubViewNeedsDraw); + } + + #endregion + + #region Draw Visibility Tests + + [Fact] + public void Draw_NotVisible_DoesNotDraw () + { + IDriver driver = CreateFakeDriver (80, 25); + + var view = new View + { + X = 0, + Y = 0, + Width = 10, + Height = 10, + Visible = false, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + + view.SetNeedsDraw (); + view.Draw (); + + // NeedsDraw should still be false (view wasn't drawn) + Assert.False (view.NeedsDraw); + } + + [Fact] + public void Draw_SuperViewNotVisible_DoesNotDraw () + { + IDriver driver = CreateFakeDriver (80, 25); + + var parent = new View + { + X = 0, + Y = 0, + Width = 50, + Height = 50, + Visible = false, + Driver = driver + }; + var child = new View { X = 10, Y = 10, Width = 20, Height = 20 }; + parent.Add (child); + parent.BeginInit (); + parent.EndInit (); + + child.SetNeedsDraw (); + child.Draw (); + + // Child should not have been drawn + Assert.True (child.NeedsDraw); // Still needs draw + } + + [Fact] + public void Draw_Enabled_False_UsesDisabledAttribute () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + bool drawingTextCalled = false; + Attribute? usedAttribute = null; + + var view = new TestView + { + X = 0, + Y = 0, + Width = 10, + Height = 10, + Enabled = false, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.DrawingText += (s, e) => + { + drawingTextCalled = true; + usedAttribute = driver.CurrentAttribute; + }; + + view.Draw (); + + Assert.True (drawingTextCalled); + Assert.NotNull (usedAttribute); + // The disabled attribute should have been used + Assert.Equal (view.GetAttributeForRole (VisualRole.Disabled), usedAttribute); + } + + #endregion + + #region Draw Order Tests + + [Fact] + public void Draw_CallsMethodsInCorrectOrder () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var callOrder = new List (); + + var view = new TestView + { + X = 0, + Y = 0, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.DrawingAdornmentsCallback = () => callOrder.Add ("DrawingAdornments"); + view.ClearingViewportCallback = () => callOrder.Add ("ClearingViewport"); + view.DrawingSubViewsCallback = () => callOrder.Add ("DrawingSubViews"); + view.DrawingTextCallback = () => callOrder.Add ("DrawingText"); + view.DrawingContentCallback = () => callOrder.Add ("DrawingContent"); + view.RenderingLineCanvasCallback = () => callOrder.Add ("RenderingLineCanvas"); + view.DrawCompleteCallback = () => callOrder.Add ("DrawComplete"); + + view.Draw (); + + Assert.Equal ( + new [] { "DrawingAdornments", "ClearingViewport", "DrawingSubViews", "DrawingText", "DrawingContent", "RenderingLineCanvas", "DrawComplete" }, + callOrder + ); + } + + [Fact] + public void Draw_WithSubViews_DrawsInReverseOrder () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var drawOrder = new List (); + + var parent = new View + { + X = 0, + Y = 0, + Width = 50, + Height = 50, + Driver = driver + }; + + var child1 = new TestView { X = 0, Y = 0, Width = 10, Height = 10, Id = "Child1" }; + var child2 = new TestView { X = 0, Y = 10, Width = 10, Height = 10, Id = "Child2" }; + var child3 = new TestView { X = 0, Y = 20, Width = 10, Height = 10, Id = "Child3" }; + + parent.Add (child1); + parent.Add (child2); + parent.Add (child3); + + parent.BeginInit (); + parent.EndInit (); + parent.LayoutSubViews (); + + child1.DrawingContentCallback = () => drawOrder.Add ("Child1"); + child2.DrawingContentCallback = () => drawOrder.Add ("Child2"); + child3.DrawingContentCallback = () => drawOrder.Add ("Child3"); + + parent.Draw (); + + // SubViews are drawn in reverse order for clipping optimization + Assert.Equal (new [] { "Child3", "Child2", "Child1" }, drawOrder); + } + + #endregion + + #region DrawContext Tests + + [Fact] + public void Draw_WithContext_PassesContext () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + DrawContext? receivedContext = null; + + var view = new TestView + { + X = 0, + Y = 0, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.DrawingContentCallback = () => { }; + view.DrawingContent += (s, e) => + { + receivedContext = e.DrawContext; + }; + + var context = new DrawContext (); + view.Draw (context); + + Assert.NotNull (receivedContext); + Assert.Equal (context, receivedContext); + } + + [Fact] + public void Draw_WithoutContext_CreatesContext () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + DrawContext? receivedContext = null; + + var view = new TestView + { + X = 0, + Y = 0, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.DrawingContentCallback = () => { }; + view.DrawingContent += (s, e) => + { + receivedContext = e.DrawContext; + }; + + view.Draw (); + + Assert.NotNull (receivedContext); + } + + #endregion + + #region Event Tests + + [Fact] + public void ClearingViewport_CanCancel () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 0, + Y = 0, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + bool clearedCalled = false; + + view.ClearingViewport += (s, e) => e.Cancel = true; + view.ClearedViewport += (s, e) => clearedCalled = true; + + view.Draw (); + + Assert.False (clearedCalled); + } + + [Fact] + public void DrawingText_CanCancel () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var view = new View + { + X = 0, + Y = 0, + Width = 20, + Height = 20, + Driver = driver, + Text = "Test" + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + bool drewTextCalled = false; + + view.DrawingText += (s, e) => e.Cancel = true; + view.DrewText += (s, e) => drewTextCalled = true; + + view.Draw (); + + Assert.False (drewTextCalled); + } + + [Fact] + public void DrawingSubViews_CanCancel () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + var parent = new TestView + { + X = 0, + Y = 0, + Width = 50, + Height = 50, + Driver = driver + }; + var child = new TestView { X = 10, Y = 10, Width = 20, Height = 20 }; + parent.Add (child); + parent.BeginInit (); + parent.EndInit (); + parent.LayoutSubViews (); + + bool childDrawn = false; + child.DrawingContentCallback = () => childDrawn = true; + + parent.DrawingSubViews += (s, e) => e.Cancel = true; + + parent.Draw (); + + Assert.False (childDrawn); + } + + [Fact] + public void DrawComplete_AlwaysCalled () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + bool drawCompleteCalled = false; + + var view = new View + { + X = 0, + Y = 0, + Width = 20, + Height = 20, + Driver = driver + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.DrawComplete += (s, e) => drawCompleteCalled = true; + + view.Draw (); + + Assert.True (drawCompleteCalled); + } + + #endregion + + #region Transparent View Tests + + [Fact] + public void Draw_TransparentView_DoesNotClearViewport () + { + IDriver driver = CreateFakeDriver (80, 25); + driver.Clip = new Region (driver.Screen); + + bool clearedViewport = false; + + var view = new View + { + X = 0, + Y = 0, + Width = 20, + Height = 20, + Driver = driver, + ViewportSettings = ViewportSettingsFlags.Transparent + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.ClearedViewport += (s, e) => clearedViewport = true; + + view.Draw (); + + Assert.False (clearedViewport); + } + + [Fact] + public void Draw_TransparentView_ExcludesDrawnRegionFromClip () + { + IDriver driver = CreateFakeDriver (80, 25); + var initialClip = new Region (driver.Screen); + driver.Clip = initialClip; + + var view = new View + { + X = 10, + Y = 10, + Width = 20, + Height = 20, + Driver = driver, + ViewportSettings = ViewportSettingsFlags.Transparent + }; + view.BeginInit (); + view.EndInit (); + view.LayoutSubViews (); + + view.Draw (); + + // The drawn area should be excluded from the clip + Rectangle viewportScreen = view.ViewportToScreen (view.Viewport); + + // Points inside the view should be excluded + // Note: This test depends on the DrawContext tracking, which may not exclude if nothing was actually drawn + // We're verifying the mechanism exists, not that it necessarily excludes in this specific case + } + + #endregion + + #region Helper Test View + + private class TestView : View + { + public Action? DrawingAdornmentsCallback { get; set; } + public Action? ClearingViewportCallback { get; set; } + public Action? DrawingSubViewsCallback { get; set; } + public Action? DrawingTextCallback { get; set; } + public Action? DrawingContentCallback { get; set; } + public Action? RenderingLineCanvasCallback { get; set; } + public Action? DrawCompleteCallback { get; set; } + + protected override bool OnDrawingAdornments () + { + DrawingAdornmentsCallback?.Invoke (); + return base.OnDrawingAdornments (); + } + + protected override bool OnClearingViewport () + { + ClearingViewportCallback?.Invoke (); + return base.OnClearingViewport (); + } + + protected override bool OnDrawingSubViews (DrawContext? context) + { + DrawingSubViewsCallback?.Invoke (); + return base.OnDrawingSubViews (context); + } + + protected override bool OnDrawingText (DrawContext? context) + { + DrawingTextCallback?.Invoke (); + return base.OnDrawingText (context); + } + + protected override bool OnDrawingContent (DrawContext? context) + { + DrawingContentCallback?.Invoke (); + return base.OnDrawingContent (context); + } + + protected override bool OnRenderingLineCanvas () + { + RenderingLineCanvasCallback?.Invoke (); + return base.OnRenderingLineCanvas (); + } + + protected override void OnDrawComplete (DrawContext? context) + { + DrawCompleteCallback?.Invoke (); + base.OnDrawComplete (context); + } + } + + #endregion +} diff --git a/Tests/UnitTestsParallelizable/View/InitTests.cs b/Tests/UnitTestsParallelizable/ViewBase/InitTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/InitTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/InitTests.cs index a6883ae7e..28a73ff5e 100644 --- a/Tests/UnitTestsParallelizable/View/InitTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/InitTests.cs @@ -1,6 +1,6 @@ using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests; /// Tests View BeginInit/EndInit/Initialized functionality. public class InitTests diff --git a/Tests/UnitTestsParallelizable/View/Keyboard/HotKeyTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Keyboard/HotKeyTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Keyboard/HotKeyTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Keyboard/HotKeyTests.cs index 06a55a9bc..715733e81 100644 --- a/Tests/UnitTestsParallelizable/View/Keyboard/HotKeyTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Keyboard/HotKeyTests.cs @@ -1,7 +1,7 @@ using System.Text; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests; [Collection ("Global Test Setup")] public class HotKeyTests diff --git a/Tests/UnitTests/View/Keyboard/KeyBindingsTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Keyboard/KeyBindingsTests.cs similarity index 69% rename from Tests/UnitTests/View/Keyboard/KeyBindingsTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Keyboard/KeyBindingsTests.cs index 74bfebcbe..588654222 100644 --- a/Tests/UnitTests/View/Keyboard/KeyBindingsTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Keyboard/KeyBindingsTests.cs @@ -1,38 +1,35 @@ -using System.Text; -using UnitTests; -using Xunit.Abstractions; - -namespace UnitTests.ViewTests; +#nullable enable +namespace ViewBaseTests.Keyboard; /// /// Tests for View.KeyBindings /// -public class KeyBindingsTests () +public class KeyBindingsTests { [Fact] - [AutoInitShutdown] public void Focused_HotKey_Application_All_Work () { + IApplication app = Application.Create (); + app.Begin (new Runnable { CanFocus = true }); + var view = new ScopedKeyBindingView (); var keyWasHandled = false; view.KeyDownNotHandled += (s, e) => keyWasHandled = true; - var top = new Toplevel (); - top.Add (view); - Application.Begin (top); + app!.TopRunnableView!.Add (view); - Application.RaiseKeyDownEvent (Key.A); + app.Keyboard.RaiseKeyDownEvent (Key.A); Assert.False (keyWasHandled); Assert.True (view.ApplicationCommand); keyWasHandled = false; - Application.RaiseKeyDownEvent (Key.H); + app.Keyboard.RaiseKeyDownEvent (Key.H); Assert.True (view.HotKeyCommand); Assert.False (keyWasHandled); keyWasHandled = false; Assert.False (view.HasFocus); - Application.RaiseKeyDownEvent (Key.F); + app.Keyboard.RaiseKeyDownEvent (Key.F); Assert.False (keyWasHandled); Assert.False (view.FocusedCommand); @@ -40,28 +37,25 @@ public class KeyBindingsTests () view.CanFocus = true; view.SetFocus (); Assert.True (view.HasFocus); - Application.RaiseKeyDownEvent (Key.F); + app.Keyboard.RaiseKeyDownEvent (Key.F); Assert.True (view.FocusedCommand); Assert.False (keyWasHandled); // Command was invoked, but wasn't handled Assert.True (view.ApplicationCommand); Assert.True (view.HotKeyCommand); - top.Dispose (); } [Fact] - [AutoInitShutdown] public void KeyBinding_Negative () { + IApplication? app = Application.Create (); + app.Begin (new Runnable { CanFocus = true }); + var view = new ScopedKeyBindingView (); var keyWasHandled = false; view.KeyDownNotHandled += (s, e) => keyWasHandled = true; - var top = new Toplevel (); - top.Add (view); - Application.Begin (top); - - Application.RaiseKeyDownEvent (Key.Z); + app.Keyboard.RaiseKeyDownEvent (Key.Z); Assert.False (keyWasHandled); Assert.False (view.ApplicationCommand); Assert.False (view.HotKeyCommand); @@ -69,142 +63,137 @@ public class KeyBindingsTests () keyWasHandled = false; Assert.False (view.HasFocus); - Application.RaiseKeyDownEvent (Key.F); + app.Keyboard.RaiseKeyDownEvent (Key.F); Assert.False (keyWasHandled); Assert.False (view.ApplicationCommand); Assert.False (view.HotKeyCommand); Assert.False (view.FocusedCommand); - top.Dispose (); } [Fact] - [AutoInitShutdown] public void HotKey_KeyBinding () { + IApplication? app = Application.Create (); + app.Begin (new Runnable { CanFocus = true }); + var view = new ScopedKeyBindingView (); + app!.TopRunnableView!.Add (view); + var keyWasHandled = false; view.KeyDownNotHandled += (s, e) => keyWasHandled = true; - var top = new Toplevel (); - top.Add (view); - Application.Begin (top); - keyWasHandled = false; - Application.RaiseKeyDownEvent (Key.H); + app.Keyboard.RaiseKeyDownEvent (Key.H); Assert.True (view.HotKeyCommand); Assert.False (keyWasHandled); view.HotKey = KeyCode.Z; keyWasHandled = false; view.HotKeyCommand = false; - Application.RaiseKeyDownEvent (Key.H); // old hot key + app.Keyboard.RaiseKeyDownEvent (Key.H); // old hot key Assert.False (keyWasHandled); Assert.False (view.HotKeyCommand); - Application.RaiseKeyDownEvent (Key.Z); // new hot key + app.Keyboard.RaiseKeyDownEvent (Key.Z); // new hot key Assert.True (view.HotKeyCommand); Assert.False (keyWasHandled); - - top.Dispose (); } [Fact] - [AutoInitShutdown] public void HotKey_KeyBinding_Negative () { + IApplication? app = Application.Create (); + app.Begin (new Runnable { CanFocus = true }); + var view = new ScopedKeyBindingView (); var keyWasHandled = false; view.KeyDownNotHandled += (s, e) => keyWasHandled = true; - var top = new Toplevel (); - top.Add (view); - Application.Begin (top); - - Application.RaiseKeyDownEvent (Key.Z); + app.Keyboard.RaiseKeyDownEvent (Key.Z); Assert.False (keyWasHandled); Assert.False (view.HotKeyCommand); keyWasHandled = false; - Application.RaiseKeyDownEvent (Key.F); + app.Keyboard.RaiseKeyDownEvent (Key.F); Assert.False (view.HotKeyCommand); - top.Dispose (); } [Fact] - [AutoInitShutdown] public void HotKey_Enabled_False_Does_Not_Invoke () { + IApplication? app = Application.Create (); + app.Begin (new Runnable ()); + var view = new ScopedKeyBindingView (); var keyWasHandled = false; view.KeyDownNotHandled += (s, e) => keyWasHandled = true; - var top = new Toplevel (); - top.Add (view); - Application.Begin (top); + app!.TopRunnableView!.Add (view); - Application.RaiseKeyDownEvent (Key.Z); + app.Keyboard.RaiseKeyDownEvent (Key.Z); Assert.False (keyWasHandled); Assert.False (view.HotKeyCommand); keyWasHandled = false; view.Enabled = false; - Application.RaiseKeyDownEvent (Key.F); + app.Keyboard.RaiseKeyDownEvent (Key.F); Assert.False (view.HotKeyCommand); - top.Dispose (); } - [Fact] public void HotKey_Raises_HotKeyCommand () { + IApplication? app = Application.Create (); + app.Begin (new Runnable ()); var hotKeyRaised = false; var acceptRaised = false; var selectRaised = false; - Application.Top = new Toplevel (); + var view = new View { CanFocus = true, - HotKeySpecifier = new Rune ('_'), + HotKeySpecifier = new ('_'), Title = "_Test" }; - Application.Top.Add (view); + app!.TopRunnableView!.Add (view); + view.HandlingHotKey += (s, e) => hotKeyRaised = true; view.Accepting += (s, e) => acceptRaised = true; view.Selecting += (s, e) => selectRaised = true; Assert.Equal (KeyCode.T, view.HotKey); - Assert.True (Application.RaiseKeyDownEvent (Key.T)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.T)); Assert.True (hotKeyRaised); Assert.False (acceptRaised); Assert.False (selectRaised); hotKeyRaised = false; - Assert.True (Application.RaiseKeyDownEvent (Key.T.WithAlt)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.T.WithAlt)); Assert.True (hotKeyRaised); Assert.False (acceptRaised); Assert.False (selectRaised); hotKeyRaised = false; view.HotKey = KeyCode.E; - Assert.True (Application.RaiseKeyDownEvent (Key.E.WithAlt)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.E.WithAlt)); Assert.True (hotKeyRaised); Assert.False (acceptRaised); Assert.False (selectRaised); - - Application.Top.Dispose (); - Application.ResetState (true); } + // tests that test KeyBindingScope.Focus and KeyBindingScope.HotKey (tests for KeyBindingScope.Application are in Application/KeyboardTests.cs) public class ScopedKeyBindingView : View { - public ScopedKeyBindingView () + /// + public override void EndInit () { + base.EndInit (); AddCommand (Command.Save, () => ApplicationCommand = true); AddCommand (Command.HotKey, () => HotKeyCommand = true); AddCommand (Command.Left, () => FocusedCommand = true); - Application.KeyBindings.Add (Key.A, this, Command.Save); + App!.Keyboard.KeyBindings.Add (Key.A, this, Command.Save); HotKey = KeyCode.H; KeyBindings.Add (Key.F, Command.Left); } diff --git a/Tests/UnitTestsParallelizable/View/Keyboard/KeyboardEventTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Keyboard/KeyboardEventTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Keyboard/KeyboardEventTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Keyboard/KeyboardEventTests.cs index 9dd6e0332..c894fe94f 100644 --- a/Tests/UnitTestsParallelizable/View/Keyboard/KeyboardEventTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Keyboard/KeyboardEventTests.cs @@ -1,9 +1,10 @@ -using UnitTests; +#nullable disable +using UnitTests; using Xunit.Abstractions; // Alias Console to MockConsole so we don't accidentally use Console -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Keyboard; [Collection ("Global Test Setup")] public class KeyboardEventTests (ITestOutputHelper output) : TestsAllViews diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.DimTypes.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.DimTypes.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.DimTypes.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.DimTypes.cs index 44c0add1d..157b72b03 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.DimTypes.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.DimTypes.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests; public partial class DimAutoTests { diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.MinMax.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.MinMax.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.MinMax.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.MinMax.cs index 08532c876..ebbb99a6b 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.MinMax.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.MinMax.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests; public partial class DimAutoTests { diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.PosTypes.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.PosTypes.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.PosTypes.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.PosTypes.cs index 0078736c5..8a05f45ca 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.PosTypes.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.PosTypes.cs @@ -1,4 +1,6 @@ -namespace UnitTests_Parallelizable.LayoutTests; +using UnitTests.Parallelizable; + +namespace ViewBaseTests.Layout; public partial class DimAutoTests { @@ -597,7 +599,7 @@ public partial class DimAutoTests // Without a subview, width should be 10 // Without a subview, height should be 1 - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); Assert.Equal (10, view.Frame.Width); Assert.Equal (1, view.Frame.Height); diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.cs similarity index 98% rename from Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.cs index b42b0bc9c..cedc97e95 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.AutoTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.AutoTests.cs @@ -1,9 +1,8 @@ using System.Text; -using UnitTests; using Xunit.Abstractions; using static Terminal.Gui.ViewBase.Dim; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; [Trait ("Category", "Layout")] public partial class DimAutoTests (ITestOutputHelper output) @@ -304,10 +303,10 @@ public partial class DimAutoTests (ITestOutputHelper output) Width = Auto (), Height = 1 }; - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); lastSize = view.Frame.Size; view.HotKeySpecifier = (Rune)'*'; - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); Assert.NotEqual (lastSize, view.Frame.Size); view = new () @@ -316,10 +315,10 @@ public partial class DimAutoTests (ITestOutputHelper output) Width = Auto (), Height = 1 }; - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); lastSize = view.Frame.Size; view.Text = "*ABCD"; - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); Assert.NotEqual (lastSize, view.Frame.Size); } @@ -703,7 +702,7 @@ public partial class DimAutoTests (ITestOutputHelper output) view.Text = text; - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); Assert.Equal (new (expectedW, expectedH), view.Frame.Size); } @@ -812,7 +811,7 @@ public partial class DimAutoTests (ITestOutputHelper output) view.Text = text; - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); Assert.Equal (new (expectedW, expectedH), view.Frame.Size); } @@ -831,7 +830,7 @@ public partial class DimAutoTests (ITestOutputHelper output) view.Text = text; - view.SetRelativeLayout (Application.Screen.Size); + view.SetRelativeLayout (new (100, 100)); Assert.Equal (new (expectedW, expectedH), view.Frame.Size); } diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.CombineTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.CombineTests.cs similarity index 78% rename from Tests/UnitTestsParallelizable/View/Layout/Dim.CombineTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.CombineTests.cs index a101bd714..9671b8f40 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.CombineTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.CombineTests.cs @@ -1,7 +1,7 @@ -using Xunit.Abstractions; -using static Terminal.Gui.ViewBase.Dim; +#nullable disable +using Xunit.Abstractions; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class DimCombineTests (ITestOutputHelper output) { diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.FillTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.FillTests.cs similarity index 89% rename from Tests/UnitTestsParallelizable/View/Layout/Dim.FillTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.FillTests.cs index 356e3744b..8eccf808c 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.FillTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.FillTests.cs @@ -1,7 +1,7 @@ -using UnitTests; +#nullable disable using Xunit.Abstractions; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class DimFillTests (ITestOutputHelper output) { @@ -161,4 +161,19 @@ public class DimFillTests (ITestOutputHelper output) Assert.True (view.IsInitialized); Assert.Equal (expectedViewBounds, view.Viewport); } + + [Fact] + public void DimFill_SizedCorrectly () + { + var view = new View { Width = Dim.Fill (), Height = Dim.Fill (), BorderStyle = LineStyle.Single }; + var top = new View { Width = 80, Height = 25 }; + top.Add (view); + + top.Layout (); + + view.SetRelativeLayout (new (32, 5)); + Assert.Equal (32, view.Frame.Width); + Assert.Equal (5, view.Frame.Height); + top.Dispose (); + } } diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.FuncTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.FuncTests.cs similarity index 96% rename from Tests/UnitTestsParallelizable/View/Layout/Dim.FuncTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.FuncTests.cs index c752619ad..e8ff416d3 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.FuncTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.FuncTests.cs @@ -1,7 +1,8 @@ -using Xunit.Abstractions; +#nullable disable +using Xunit.Abstractions; using static Terminal.Gui.ViewBase.Dim; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class DimFuncTests (ITestOutputHelper output) { diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.PercentTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.PercentTests.cs similarity index 96% rename from Tests/UnitTestsParallelizable/View/Layout/Dim.PercentTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.PercentTests.cs index d2faa3af6..418a21547 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.PercentTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.PercentTests.cs @@ -1,9 +1,6 @@ -using System.Globalization; -using System.Text; -using Xunit.Abstractions; -using static Terminal.Gui.ViewBase.Dim; +#nullable disable -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class DimPercentTests { diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.Tests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.Tests.cs similarity index 98% rename from Tests/UnitTestsParallelizable/View/Layout/Dim.Tests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.Tests.cs index 81aace3fc..70587b225 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.Tests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.Tests.cs @@ -1,10 +1,8 @@ -using System.Globalization; -using System.Text; -using UnitTests; -using Xunit.Abstractions; +#nullable disable + using static Terminal.Gui.ViewBase.Dim; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; [Collection ("Global Test Setup")] public class DimTests diff --git a/Tests/UnitTestsParallelizable/View/Layout/Dim.ViewTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.ViewTests.cs similarity index 93% rename from Tests/UnitTestsParallelizable/View/Layout/Dim.ViewTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.ViewTests.cs index 2bbbfa9f8..e78b53280 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Dim.ViewTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Dim.ViewTests.cs @@ -1,6 +1,7 @@ -using static Terminal.Gui.ViewBase.Dim; +#nullable disable +using static Terminal.Gui.ViewBase.Dim; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class DimViewTests { diff --git a/Tests/UnitTestsParallelizable/View/Layout/FrameTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/FrameTests.cs similarity index 97% rename from Tests/UnitTestsParallelizable/View/Layout/FrameTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/FrameTests.cs index 364012cc3..7a416fb9b 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/FrameTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/FrameTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class FrameTests { @@ -120,7 +120,7 @@ public class FrameTests Assert.True (view.NeedsLayout); view.Layout (); Assert.False (view.NeedsLayout); - Assert.Equal (Application.Screen, view.Frame); + Assert.Equal (new Size (2048, 2048), view.Frame.Size); view.Frame = Rectangle.Empty; Assert.Equal (Rectangle.Empty, view.Frame); @@ -165,7 +165,7 @@ public class FrameTests Assert.Equal (Rectangle.Empty, v.Frame); v.Dispose (); - v = new() { Frame = frame }; + v = new () { Frame = frame }; Assert.Equal (frame, v.Frame); v.Frame = newFrame; @@ -181,7 +181,7 @@ public class FrameTests Assert.Equal (Dim.Absolute (40), v.Height); v.Dispose (); - v = new() { X = frame.X, Y = frame.Y, Text = "v" }; + v = new () { X = frame.X, Y = frame.Y, Text = "v" }; v.Frame = newFrame; Assert.Equal (newFrame, v.Frame); @@ -196,7 +196,7 @@ public class FrameTests v.Dispose (); newFrame = new (10, 20, 30, 40); - v = new() { Frame = frame }; + v = new () { Frame = frame }; v.Frame = newFrame; Assert.Equal (newFrame, v.Frame); @@ -210,7 +210,7 @@ public class FrameTests Assert.Equal (Dim.Absolute (40), v.Height); v.Dispose (); - v = new() { X = frame.X, Y = frame.Y, Text = "v" }; + v = new () { X = frame.X, Y = frame.Y, Text = "v" }; v.Frame = newFrame; Assert.Equal (newFrame, v.Frame); diff --git a/Tests/UnitTestsParallelizable/ViewBase/Layout/GetViewsAtLocationTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/GetViewsAtLocationTests.cs new file mode 100644 index 000000000..2abcd0c0d --- /dev/null +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/GetViewsAtLocationTests.cs @@ -0,0 +1,1223 @@ +#nullable enable + +namespace ViewBaseTests.Layout; + +[Trait ("Category", "Layout")] +public class GetViewsAtLocationTests +{ + private class TestView : View + { + public TestView (int x, int y, int w, int h, bool visible = true) + { + X = x; + Y = y; + Width = w; + Height = h; + base.Visible = visible; + } + } + + [Fact] + public void ReturnsEmpty_WhenRootIsNull () + { + List result = View.GetViewsAtLocation (null, new (0, 0)); + Assert.Empty (result); + } + + [Fact] + public void ReturnsEmpty_WhenRootIsNotVisible () + { + TestView root = new (0, 0, 10, 10, false); + List result = View.GetViewsAtLocation (root, new (5, 5)); + Assert.Empty (result); + } + + [Fact] + public void ReturnsEmpty_WhenPointOutsideRoot () + { + TestView root = new (0, 0, 10, 10); + List result = View.GetViewsAtLocation (root, new (20, 20)); + Assert.Empty (result); + } + + [Fact] + public void ReturnsEmpty_WhenPointOutsideRoot_AndSubview () + { + TestView root = new (0, 0, 10, 10); + TestView sub = new (5, 5, 2, 2); + root.Add (sub); + List result = View.GetViewsAtLocation (root, new (20, 20)); + Assert.Empty (result); + } + + [Fact] + public void ReturnsRoot_WhenPointInsideRoot_NoSubviews () + { + TestView root = new (0, 0, 10, 10); + List result = View.GetViewsAtLocation (root, new (5, 5)); + Assert.Single (result); + Assert.Equal (root, result [0]); + } + + [Fact] + public void ReturnsRoot_And_Subview_WhenPointInsideRootMargin () + { + TestView root = new (0, 0, 10, 10); + root.Margin!.Thickness = new (1); + TestView sub = new (2, 2, 5, 5); + root.Add (sub); + List result = View.GetViewsAtLocation (root, new (3, 3)); + Assert.Equal (2, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub, result [1]); + } + + [Fact] + public void ReturnsRoot_And_Subview_Border_WhenPointInsideRootMargin () + { + TestView root = new (0, 0, 10, 10); + root.Margin!.Thickness = new (1); + TestView sub = new (2, 2, 5, 5); + sub.BorderStyle = LineStyle.Dotted; + root.Add (sub); + List result = View.GetViewsAtLocation (root, new (3, 3)); + Assert.Equal (3, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub, result [1]); + Assert.Equal (sub.Border, result [2]); + } + + [Fact] + public void ReturnsRoot_And_Margin_WhenPointInside_With_Margin () + { + TestView root = new (0, 0, 10, 10); + root.Margin!.Thickness = new (1); + List result = View.GetViewsAtLocation (root, new (0, 0)); + Assert.Equal (2, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (root.Margin, result [1]); + } + + [Fact] + public void ReturnsRoot_WhenPointOutsideSubview_With_Margin () + { + TestView root = new (0, 0, 10, 10); + root.Margin!.Thickness = new (1); + TestView sub = new (2, 2, 5, 5); + root.Add (sub); + List result = View.GetViewsAtLocation (root, new (2, 2)); + Assert.Single (result); + Assert.Equal (root, result [0]); + + result = View.GetViewsAtLocation (root, new (0, 0)); + Assert.Equal (2, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (root.Margin, result [1]); + + result = View.GetViewsAtLocation (root, new (1, 1)); + Assert.Single (result); + Assert.Equal (root, result [0]); + + result = View.GetViewsAtLocation (root, new (8, 8)); + Assert.Single (result); + Assert.Equal (root, result [0]); + } + + [Fact] + public void ReturnsRoot_And_Border_WhenPointInside_With_Border () + { + TestView root = new (0, 0, 10, 10); + root.Border!.Thickness = new (1); + List result = View.GetViewsAtLocation (root, new (0, 0)); + Assert.Equal (2, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (root.Border, result [1]); + } + + [Fact] + public void ReturnsRoot_WhenPointOutsideSubview_With_Border () + { + TestView root = new (0, 0, 10, 10); + root.Border!.Thickness = new (1); + TestView sub = new (2, 2, 5, 5); + root.Add (sub); + List result = View.GetViewsAtLocation (root, new (2, 2)); + Assert.Single (result); + Assert.Equal (root, result [0]); + + result = View.GetViewsAtLocation (root, new (0, 0)); + Assert.Equal (2, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (root.Border, result [1]); + + result = View.GetViewsAtLocation (root, new (1, 1)); + Assert.Single (result); + Assert.Equal (root, result [0]); + + result = View.GetViewsAtLocation (root, new (8, 8)); + Assert.Single (result); + Assert.Equal (root, result [0]); + } + + [Fact] + public void ReturnsRoot_And_Border_WhenPointInsideRootBorder () + { + TestView root = new (0, 0, 10, 10); + root.Border!.Thickness = new (1); + List result = View.GetViewsAtLocation (root, new (0, 0)); + Assert.Equal (2, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (root.Border, result [1]); + } + + [Fact] + public void ReturnsRoot_And_Padding_WhenPointInsideRootPadding () + { + TestView root = new (0, 0, 10, 10); + root.Padding!.Thickness = new (1); + List result = View.GetViewsAtLocation (root, new (0, 0)); + Assert.Equal (2, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (root.Padding, result [1]); + } + + [Fact] + public void ReturnsRootAndSubview_WhenPointInsideSubview () + { + TestView root = new (0, 0, 10, 10); + TestView sub = new (2, 2, 5, 5); + root.Add (sub); + + List result = View.GetViewsAtLocation (root, new (3, 3)); + Assert.Equal (2, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub, result [1]); + } + + [Fact] + public void ReturnsRootAndSubviewAndMargin_WhenPointInsideSubviewMargin () + { + TestView root = new (0, 0, 10, 10); + TestView sub = new (2, 2, 5, 5); + sub.Margin!.Thickness = new (1); + root.Add (sub); + + List result = View.GetViewsAtLocation (root, new (6, 6)); + Assert.Equal (3, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub, result [1]); + Assert.Equal (sub.Margin, result [2]); + } + + [Fact] + public void ReturnsRootAndSubviewAndBorder_WhenPointInsideSubviewBorder () + { + TestView root = new (0, 0, 10, 10); + TestView sub = new (2, 2, 5, 5); + sub.Border!.Thickness = new (1); + root.Add (sub); + + List result = View.GetViewsAtLocation (root, new (2, 2)); + Assert.Equal (3, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub, result [1]); + Assert.Equal (sub.Border, result [2]); + } + + [Fact] + public void ReturnsRootAndSubviewAndSubviewAndBorder_WhenPointInsideSubviewBorder () + { + TestView root = new (2, 2, 10, 10); + TestView sub = new (2, 2, 5, 5); + sub.Border!.Thickness = new (1); + root.Add (sub); + + List result = View.GetViewsAtLocation (root, new (4, 4)); + Assert.Equal (3, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub, result [1]); + Assert.Equal (sub.Border, result [2]); + } + + [Fact] + public void ReturnsRootAndSubviewAndBorder_WhenPointInsideSubviewPadding () + { + TestView root = new (0, 0, 10, 10); + TestView sub = new (2, 2, 5, 5); + sub.Padding!.Thickness = new (1); + root.Add (sub); + + List result = View.GetViewsAtLocation (root, new (2, 2)); + Assert.Equal (3, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub, result [1]); + Assert.Equal (sub.Padding, result [2]); + } + + [Fact] + public void ReturnsRootAndSubviewAndMarginAndShadowView_WhenPointInsideSubviewMargin () + { + TestView root = new (0, 0, 10, 10); + TestView sub = new (2, 2, 5, 5); + sub.ShadowStyle = ShadowStyle.Opaque; + root.Add (sub); + + root.Layout (); + + List result = View.GetViewsAtLocation (root, new (6, 6)); + Assert.Equal (5, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub, result [1]); + Assert.Equal (sub.Margin, result [2]); + Assert.Equal (sub.Margin!.SubViews.ElementAt (0), result [3]); + Assert.Equal (sub.Margin!.SubViews.ElementAt (1), result [4]); + } + + [Fact] + public void ReturnsRootAndSubviewAndBorderAndButton_WhenPointInsideSubviewBorder () + { + TestView root = new (0, 0, 10, 10); + TestView sub = new (2, 2, 5, 5); + sub.Border!.Thickness = new (1); + + var closeButton = new Button + { + NoDecorations = true, + NoPadding = true, + Title = "X", + Width = 1, + Height = 1, + X = Pos.AnchorEnd (), + Y = 0, + ShadowStyle = ShadowStyle.None + }; + sub.Border!.Add (closeButton); + root.Add (sub); + + root.Layout (); + + List result = View.GetViewsAtLocation (root, new (6, 2)); + Assert.Equal (4, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub, result [1]); + Assert.Equal (sub.Border, result [2]); + Assert.Equal (closeButton, result [3]); + } + + [Fact] + public void ReturnsDeepestSubview_WhenNested () + { + TestView root = new (0, 0, 20, 20); + var sub1 = new TestView (2, 2, 16, 16); + var sub2 = new TestView (3, 3, 10, 10); + var sub3 = new TestView (1, 1, 5, 5); + root.Add (sub1); + sub1.Add (sub2); + sub2.Add (sub3); + + // Point inside all + List result = View.GetViewsAtLocation (root, new (7, 7)); + Assert.Equal (4, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub1, result [1]); + Assert.Equal (sub2, result [2]); + Assert.Equal (sub3, result [3]); + } + + [Fact] + public void ReturnsTopmostSubview_WhenOverlapping () + { + TestView root = new (0, 0, 10, 10); + var sub1 = new TestView (2, 2, 6, 6); + var sub2 = new TestView (4, 4, 6, 6); + root.Add (sub1); + root.Add (sub2); // sub2 is on top + + List result = View.GetViewsAtLocation (root, new (5, 5)); + Assert.Equal (3, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub1, result [1]); + Assert.Equal (sub2, result [2]); + } + + [Fact] + public void ReturnsTopmostSubview_WhenNotOverlapping () + { + TestView root = new (0, 0, 10, 10); // under 5,5, + var sub1 = new TestView (10, 10, 6, 6); // not under location 5,5 + var sub2 = new TestView (4, 4, 6, 6); // under 5,5, + root.Add (sub1); + root.Add (sub2); // sub2 is on top + + List result = View.GetViewsAtLocation (root, new (5, 5)); + Assert.Equal (2, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub2, result [1]); + } + + [Fact] + public void SkipsInvisibleSubviews () + { + TestView root = new (0, 0, 10, 10); + var sub1 = new TestView (2, 2, 6, 6, false); + var sub2 = new TestView (4, 4, 6, 6); + root.Add (sub1); + root.Add (sub2); + + List result = View.GetViewsAtLocation (root, new (5, 5)); + Assert.Equal (2, result.Count); + Assert.Equal (root, result [0]); + Assert.Equal (sub2, result [1]); + } + + [Fact] + public void ReturnsRoot_WhenPointOnEdge () + { + TestView root = new (0, 0, 10, 10); + List result = View.GetViewsAtLocation (root, new (0, 0)); + Assert.Single (result); + Assert.Equal (root, result [0]); + } + + [Fact] + public void ReturnsRoot_WhenPointOnBottomRightCorner () + { + TestView root = new (0, 0, 10, 10); + List result = View.GetViewsAtLocation (root, new (9, 9)); + Assert.Single (result); + Assert.Equal (root, result [0]); + } + + [Fact] + public void ReturnsEmpty_WhenAllSubviewsInvisible () + { + TestView root = new (0, 0, 10, 10); + var sub1 = new TestView (2, 2, 6, 6, false); + root.Add (sub1); + + List result = View.GetViewsAtLocation (root, new (3, 3)); + Assert.Single (result); + Assert.Equal (root, result [0]); + } + + [Theory] + [InlineData (0, 0, 0, 0, 0, -1, -1, new string [] { })] + [InlineData (0, 0, 0, 0, 0, 0, 0, new [] { "Top" })] + [InlineData (0, 0, 0, 0, 0, 1, 1, new [] { "Top" })] + [InlineData (0, 0, 0, 0, 0, 4, 4, new [] { "Top" })] + [InlineData (0, 0, 0, 0, 0, 9, 9, new [] { "Top" })] + [InlineData (0, 0, 0, 0, 0, 10, 10, new string [] { })] + [InlineData (1, 1, 0, 0, 0, -1, -1, new string [] { })] + [InlineData (1, 1, 0, 0, 0, 0, 0, new string [] { })] + [InlineData (1, 1, 0, 0, 0, 1, 1, new [] { "Top" })] + [InlineData (1, 1, 0, 0, 0, 4, 4, new [] { "Top" })] + [InlineData (1, 1, 0, 0, 0, 9, 9, new [] { "Top" })] + [InlineData (1, 1, 0, 0, 0, 10, 10, new [] { "Top" })] + [InlineData (0, 0, 1, 0, 0, -1, -1, new string [] { })] + [InlineData (0, 0, 1, 0, 0, 0, 0, new string [] { })] //margin is ViewportSettings.TransparentToMouse + [InlineData (0, 0, 1, 0, 0, 1, 1, new [] { "Top" })] + [InlineData (0, 0, 1, 0, 0, 4, 4, new [] { "Top" })] + [InlineData (0, 0, 1, 0, 0, 9, 9, new string [] { })] //margin is ViewportSettings.TransparentToMouse + [InlineData (0, 0, 1, 0, 0, 10, 10, new string [] { })] + [InlineData (0, 0, 1, 1, 0, -1, -1, new string [] { })] + [InlineData (0, 0, 1, 1, 0, 0, 0, new string [] { })] //margin is ViewportSettings.TransparentToMouse + [InlineData (0, 0, 1, 1, 0, 1, 1, new [] { "Top", "Border" })] + [InlineData (0, 0, 1, 1, 0, 4, 4, new [] { "Top" })] + [InlineData (0, 0, 1, 1, 0, 9, 9, new string [] { })] //margin is ViewportSettings.TransparentToMouse + [InlineData (0, 0, 1, 1, 0, 10, 10, new string [] { })] + [InlineData (0, 0, 1, 1, 1, -1, -1, new string [] { })] + [InlineData (0, 0, 1, 1, 1, 0, 0, new string [] { })] //margin is ViewportSettings.TransparentToMouse + [InlineData (0, 0, 1, 1, 1, 1, 1, new [] { "Top", "Border" })] + [InlineData (0, 0, 1, 1, 1, 2, 2, new [] { "Top", "Padding" })] + [InlineData (0, 0, 1, 1, 1, 4, 4, new [] { "Top" })] + [InlineData (0, 0, 1, 1, 1, 9, 9, new string [] { })] //margin is ViewportSettings.TransparentToMouse + [InlineData (0, 0, 1, 1, 1, 10, 10, new string [] { })] + [InlineData (1, 1, 1, 0, 0, -1, -1, new string [] { })] + [InlineData (1, 1, 1, 0, 0, 0, 0, new string [] { })] + [InlineData (1, 1, 1, 0, 0, 1, 1, new string [] { })] //margin is ViewportSettings.TransparentToMouse + [InlineData (1, 1, 1, 0, 0, 4, 4, new [] { "Top" })] + [InlineData (1, 1, 1, 0, 0, 9, 9, new [] { "Top" })] + [InlineData (1, 1, 1, 0, 0, 10, 10, new string [] { })] //margin is ViewportSettings.TransparentToMouse + [InlineData (1, 1, 1, 1, 0, -1, -1, new string [] { })] + [InlineData (1, 1, 1, 1, 0, 0, 0, new string [] { })] + [InlineData (1, 1, 1, 1, 0, 1, 1, new string [] { })] //margin is ViewportSettings.TransparentToMouse + [InlineData (1, 1, 1, 1, 0, 4, 4, new [] { "Top" })] + [InlineData (1, 1, 1, 1, 0, 9, 9, new [] { "Top", "Border" })] + [InlineData (1, 1, 1, 1, 0, 10, 10, new string [] { })] //margin is ViewportSettings.TransparentToMouse + [InlineData (1, 1, 1, 1, 1, -1, -1, new string [] { })] + [InlineData (1, 1, 1, 1, 1, 0, 0, new string [] { })] + [InlineData (1, 1, 1, 1, 1, 1, 1, new string [] { })] //margin is ViewportSettings.TransparentToMouse + [InlineData (1, 1, 1, 1, 1, 2, 2, new [] { "Top", "Border" })] + [InlineData (1, 1, 1, 1, 1, 3, 3, new [] { "Top", "Padding" })] + [InlineData (1, 1, 1, 1, 1, 4, 4, new [] { "Top" })] + [InlineData (1, 1, 1, 1, 1, 8, 8, new [] { "Top", "Padding" })] + [InlineData (1, 1, 1, 1, 1, 9, 9, new [] { "Top", "Border" })] + [InlineData (1, 1, 1, 1, 1, 10, 10, new string [] { })] //margin is ViewportSettings.TransparentToMouse + public void Top_Adornments_Returns_Correct_View ( + int frameX, + int frameY, + int marginThickness, + int borderThickness, + int paddingThickness, + int testX, + int testY, + string [] expectedViewsFound + ) + { + // Arrange + Runnable? runnable = new () + { + Id = "Top", + Frame = new (frameX, frameY, 10, 10) + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + runnable.Margin!.Thickness = new (marginThickness); + runnable.Margin!.Id = "Margin"; + runnable.Border!.Thickness = new (borderThickness); + runnable.Border!.Id = "Border"; + runnable.Padding!.Thickness = new (paddingThickness); + runnable.Padding.Id = "Padding"; + + var location = new Point (testX, testY); + + // Act + List viewsUnderMouse = runnable.GetViewsUnderLocation (location, ViewportSettingsFlags.TransparentMouse); + + // Assert + if (expectedViewsFound.Length == 0) + { + Assert.Empty (viewsUnderMouse); + } + else + { + string [] foundIds = viewsUnderMouse.Select (v => v!.Id).ToArray (); + Assert.Equal (expectedViewsFound, foundIds); + } + } + + [Theory] + [InlineData (0, 0)] + [InlineData (1, 1)] + [InlineData (2, 2)] + public void Returns_Top_If_No_SubViews (int testX, int testY) + { + // Arrange + Runnable? runnable = new () + { + Frame = new (0, 0, 10, 10) + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + + var location = new Point (testX, testY); + + // Act + List viewsUnderMouse = runnable.GetViewsUnderLocation (location, ViewportSettingsFlags.TransparentMouse); + + // Assert + Assert.Contains (viewsUnderMouse, v => v == runnable); + runnable.Dispose (); + } + + // Test that GetViewsUnderLocation returns the correct view if the start view has no subviews + [Theory] + [InlineData (0, 0)] + [InlineData (1, 1)] + [InlineData (2, 2)] + public void Returns_Start_If_No_SubViews (int testX, int testY) + { + Runnable? runnable = new () + { + Width = 10, Height = 10 + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + + Assert.Same (runnable, runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault ()); + runnable.Dispose (); + } + + // Test that GetViewsUnderLocation returns the correct view if the start view has subviews + [Theory] + [InlineData (0, 0, false)] + [InlineData (1, 1, false)] + [InlineData (9, 9, false)] + [InlineData (10, 10, false)] + [InlineData (6, 7, false)] + [InlineData (1, 2, true)] + [InlineData (5, 6, true)] + public void Returns_Correct_If_SubViews (int testX, int testY, bool expectedSubViewFound) + { + Runnable? runnable = new () + { + Width = 10, Height = 10 + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + + var subview = new View + { + X = 1, Y = 2, + Width = 5, Height = 5 + }; + runnable.Add (subview); + + View? found = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); + + Assert.Equal (expectedSubViewFound, found == subview); + runnable.Dispose (); + } + + [Theory] + [InlineData (0, 0, false)] + [InlineData (1, 1, false)] + [InlineData (9, 9, false)] + [InlineData (10, 10, false)] + [InlineData (6, 7, false)] + [InlineData (1, 2, false)] + [InlineData (5, 6, false)] + public void Returns_Null_If_SubView_NotVisible (int testX, int testY, bool expectedSubViewFound) + { + Runnable? runnable = new () + { + Width = 10, Height = 10 + }; + + var subview = new View + { + X = 1, Y = 2, + Width = 5, Height = 5, + Visible = false + }; + runnable.Add (subview); + + View? found = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); + + Assert.Equal (expectedSubViewFound, found == subview); + runnable.Dispose (); + } + + [Theory] + [InlineData (0, 0, false)] + [InlineData (1, 1, false)] + [InlineData (9, 9, false)] + [InlineData (10, 10, false)] + [InlineData (6, 7, false)] + [InlineData (1, 2, false)] + [InlineData (5, 6, false)] + public void Returns_Null_If_Not_Visible_And_SubView_Visible (int testX, int testY, bool expectedSubViewFound) + { + Runnable? runnable = new () + { + Width = 10, Height = 10, + Visible = false + }; + + var subview = new View + { + X = 1, Y = 2, + Width = 5, Height = 5 + }; + runnable.Add (subview); + subview.Visible = true; + Assert.True (subview.Visible); + Assert.False (runnable.Visible); + View? found = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); + + Assert.Equal (expectedSubViewFound, found == subview); + runnable.Dispose (); + } + + // Test that GetViewsUnderLocation works if the start view has positive Adornments + [Theory] + [InlineData (0, 0, false)] + [InlineData (1, 1, false)] + [InlineData (9, 9, false)] + [InlineData (10, 10, false)] + [InlineData (7, 8, false)] + [InlineData (1, 2, false)] + [InlineData (2, 3, true)] + [InlineData (5, 6, true)] + [InlineData (6, 7, true)] + public void Returns_Correct_If_Start_Has_Adornments (int testX, int testY, bool expectedSubViewFound) + { + Runnable? runnable = new () + { + Width = 10, Height = 10 + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + runnable.Margin!.Thickness = new (1); + + var subview = new View + { + X = 1, Y = 2, + Width = 5, Height = 5 + }; + runnable.Add (subview); + + View? found = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); + + Assert.Equal (expectedSubViewFound, found == subview); + runnable.Dispose (); + } + + // Test that GetViewsUnderLocation works if the start view has offset Viewport location + [Theory] + [InlineData (1, 0, 0, true)] + [InlineData (1, 1, 1, true)] + [InlineData (1, 2, 2, false)] + [InlineData (-1, 3, 3, true)] + [InlineData (-1, 2, 2, true)] + [InlineData (-1, 1, 1, false)] + [InlineData (-1, 0, 0, false)] + public void Returns_Correct_If_Start_Has_Offset_Viewport (int offset, int testX, int testY, bool expectedSubViewFound) + { + Runnable? runnable = new () + { + Width = 10, Height = 10, + ViewportSettings = ViewportSettingsFlags.AllowNegativeLocation + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + runnable.Viewport = new (offset, offset, 10, 10); + + var subview = new View + { + X = 1, Y = 1, + Width = 2, Height = 2 + }; + runnable.Add (subview); + + View? found = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); + + Assert.Equal (expectedSubViewFound, found == subview); + runnable.Dispose (); + } + + [Theory] + [InlineData (9, 9, true)] + [InlineData (0, 0, false)] + [InlineData (1, 1, false)] + [InlineData (10, 10, false)] + [InlineData (7, 8, false)] + [InlineData (1, 2, false)] + [InlineData (2, 3, false)] + [InlineData (5, 6, false)] + [InlineData (6, 7, false)] + public void Returns_Correct_If_Start_Has_Adornment_WithSubView (int testX, int testY, bool expectedSubViewFound) + { + Runnable? runnable = new () + { + Width = 10, Height = 10 + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + runnable.Padding!.Thickness = new (1); + + var subview = new View + { + X = Pos.AnchorEnd (1), Y = Pos.AnchorEnd (1), + Width = 1, Height = 1 + }; + runnable.Padding.Add (subview); + + View? found = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); + + Assert.Equal (expectedSubViewFound, found == subview); + runnable.Dispose (); + } + + [Theory] + [InlineData (0, 0, new string [] { })] + [InlineData (9, 9, new string [] { })] + [InlineData (1, 1, new [] { "Top", "Border" })] + [InlineData (8, 8, new [] { "Top", "Border" })] + [InlineData (2, 2, new [] { "Top", "Padding" })] + [InlineData (7, 7, new [] { "Top", "Padding" })] + [InlineData (5, 5, new [] { "Top" })] + public void Returns_Adornment_If_Start_Has_Adornments (int testX, int testY, string [] expectedViewsFound) + { + IApplication? app = Application.Create (); + + Runnable? runnable = new () + { + Id = "Top", + Width = 10, Height = 10 + }; + app.Begin (runnable); + + runnable.Margin!.Thickness = new (1); + runnable.Margin!.Id = "Margin"; + runnable.Border!.Thickness = new (1); + runnable.Border!.Id = "Border"; + runnable.Padding!.Thickness = new (1); + runnable.Padding.Id = "Padding"; + + var subview = new View + { + Id = "SubView", + X = 1, Y = 1, + Width = 1, Height = 1 + }; + runnable.Add (subview); + + List viewsUnderMouse = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse); + string [] foundIds = viewsUnderMouse.Select (v => v!.Id).ToArray (); + + Assert.Equal (expectedViewsFound, foundIds); + runnable.Dispose (); + } + + // Test that GetViewsUnderLocation works if the subview has positive Adornments + [Theory] + [InlineData (0, 0, new [] { "Top" })] + [InlineData (1, 1, new [] { "Top" })] + [InlineData (9, 9, new [] { "Top" })] + [InlineData (10, 10, new string [] { })] + [InlineData (7, 8, new [] { "Top" })] + [InlineData (6, 7, new [] { "Top" })] + [InlineData (1, 2, new [] { "Top", "subview", "border" })] + [InlineData (5, 6, new [] { "Top", "subview", "border" })] + [InlineData (2, 3, new [] { "Top", "subview" })] + public void Returns_Correct_If_SubView_Has_Adornments (int testX, int testY, string [] expectedViewsFound) + { + Runnable? runnable = new () + { + Id = "Top", + Width = 10, Height = 10 + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + + var subview = new View + { + Id = "subview", + X = 1, Y = 2, + Width = 5, Height = 5 + }; + subview.Border!.Thickness = new (1); + subview.Border!.Id = "border"; + runnable.Add (subview); + + List viewsUnderMouse = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse); + string [] foundIds = viewsUnderMouse.Select (v => v!.Id).ToArray (); + + Assert.Equal (expectedViewsFound, foundIds); + runnable.Dispose (); + } + + // Test that GetViewsUnderLocation works if the subview has positive Adornments + [Theory] + [InlineData (0, 0, new [] { "Top" })] + [InlineData (1, 1, new [] { "Top" })] + [InlineData (9, 9, new [] { "Top" })] + [InlineData (10, 10, new string [] { })] + [InlineData (7, 8, new [] { "Top" })] + [InlineData (6, 7, new [] { "Top" })] + [InlineData (1, 2, new [] { "Top" })] + [InlineData (5, 6, new [] { "Top" })] + [InlineData (2, 3, new [] { "Top", "subview" })] + public void Returns_Correct_If_SubView_Has_Adornments_With_TransparentMouse (int testX, int testY, string [] expectedViewsFound) + { + Runnable? runnable = new () + { + Id = "Top", + Width = 10, Height = 10 + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + + var subview = new View + { + Id = "subview", + X = 1, Y = 2, + Width = 5, Height = 5 + }; + subview.Border!.Thickness = new (1); + subview.Border!.ViewportSettings = ViewportSettingsFlags.TransparentMouse; + subview.Border!.Id = "border"; + runnable.Add (subview); + + List viewsUnderMouse = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse); + string [] foundIds = viewsUnderMouse.Select (v => v!.Id).ToArray (); + + Assert.Equal (expectedViewsFound, foundIds); + runnable.Dispose (); + } + + [Theory] + [InlineData (0, 0, false)] + [InlineData (1, 1, false)] + [InlineData (9, 9, false)] + [InlineData (10, 10, false)] + [InlineData (7, 8, false)] + [InlineData (6, 7, false)] + [InlineData (1, 2, false)] + [InlineData (5, 6, false)] + [InlineData (6, 5, false)] + [InlineData (5, 5, true)] + public void Returns_Correct_If_SubView_Has_Adornment_WithSubView (int testX, int testY, bool expectedSubViewFound) + { + Runnable? runnable = new () + { + Width = 10, Height = 10 + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + + // A subview with + Padding + var subview = new View + { + X = 1, Y = 1, + Width = 5, Height = 5 + }; + subview.Padding!.Thickness = new (1); + + // This subview will be at the bottom-right-corner of subview + // So screen-relative location will be X + Width - 1 = 5 + var paddingSubView = new View + { + X = Pos.AnchorEnd (1), + Y = Pos.AnchorEnd (1), + Width = 1, + Height = 1 + }; + subview.Padding.Add (paddingSubView); + runnable.Add (subview); + + View? found = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); + + Assert.Equal (expectedSubViewFound, found == paddingSubView); + runnable.Dispose (); + } + + [Theory] + [InlineData (0, 0, false)] + [InlineData (1, 1, false)] + [InlineData (9, 9, false)] + [InlineData (10, 10, false)] + [InlineData (7, 8, false)] + [InlineData (6, 7, false)] + [InlineData (1, 2, false)] + [InlineData (5, 6, false)] + [InlineData (6, 5, false)] + [InlineData (5, 5, true)] + public void Returns_Correct_If_SubView_Is_Scrolled_And_Has_Adornment_WithSubView (int testX, int testY, bool expectedSubViewFound) + { + Runnable? runnable = new () + { + Width = 10, Height = 10 + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + + // A subview with + Padding + var subview = new View + { + X = 1, Y = 1, + Width = 5, Height = 5 + }; + subview.Padding!.Thickness = new (1); + + // Scroll the subview + subview.SetContentSize (new (10, 10)); + subview.Viewport = subview.Viewport with { Location = new (1, 1) }; + + // This subview will be at the bottom-right-corner of subview + // So screen-relative location will be X + Width - 1 = 5 + var paddingSubView = new View + { + X = Pos.AnchorEnd (1), + Y = Pos.AnchorEnd (1), + Width = 1, + Height = 1 + }; + subview.Padding.Add (paddingSubView); + runnable.Add (subview); + + View? found = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); + + Assert.Equal (expectedSubViewFound, found == paddingSubView); + runnable.Dispose (); + } + + // Test that GetViewsUnderLocation works with nested subviews + [Theory] + [InlineData (0, 0, -1)] + [InlineData (9, 9, -1)] + [InlineData (10, 10, -1)] + [InlineData (1, 1, 0)] + [InlineData (1, 2, 0)] + [InlineData (2, 2, 1)] + [InlineData (3, 3, 2)] + [InlineData (5, 5, 2)] + public void Returns_Correct_With_NestedSubViews (int testX, int testY, int expectedSubViewFound) + { + Runnable? runnable = new () + { + Width = 10, Height = 10 + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + + var numSubViews = 3; + List subviews = new (); + + for (var i = 0; i < numSubViews; i++) + { + var subview = new View + { + X = 1, Y = 1, + Width = 5, Height = 5 + }; + subviews.Add (subview); + + if (i > 0) + { + subviews [i - 1].Add (subview); + } + } + + runnable.Add (subviews [0]); + + View? found = runnable.GetViewsUnderLocation (new (testX, testY), ViewportSettingsFlags.TransparentMouse).LastOrDefault (); + Assert.Equal (expectedSubViewFound, subviews.IndexOf (found!)); + runnable.Dispose (); + } + + [Theory] + [InlineData (0, 0, new [] { "top" })] + [InlineData (9, 9, new [] { "top" })] + [InlineData (10, 10, new string [] { })] + [InlineData (1, 1, new [] { "top", "view" })] + [InlineData (1, 2, new [] { "top", "view" })] + [InlineData (2, 1, new [] { "top", "view" })] + [InlineData (2, 2, new [] { "top", "view", "subView" })] + [InlineData (3, 3, new [] { "top" })] // clipped + [InlineData (2, 3, new [] { "top" })] // clipped + public void Tiled_SubViews (int mouseX, int mouseY, string [] viewIdStrings) + { + // Arrange + Runnable? runnable = new () + { + Frame = new (0, 0, 10, 10), + Id = "top" + }; + IApplication? app = Application.Create (); + app.Begin (runnable); + + var view = new View + { + Id = "view", + X = 1, + Y = 1, + Width = 2, + Height = 2, + Arrangement = ViewArrangement.Overlapped + }; // at 1,1 to 3,2 (screen) + + var subView = new View + { + Id = "subView", + X = 1, + Y = 1, + Width = 2, + Height = 2, + Arrangement = ViewArrangement.Overlapped + }; // at 2,2 to 4,3 (screen) + view.Add (subView); + runnable.Add (view); + + List found = runnable.GetViewsUnderLocation (new (mouseX, mouseY), ViewportSettingsFlags.TransparentMouse); + + string [] foundIds = found.Select (v => v!.Id).ToArray (); + + Assert.Equal (viewIdStrings, foundIds); + + runnable.Dispose (); + } + + [Theory] + [InlineData (0, 0, new [] { "top" })] + [InlineData (9, 9, new [] { "top" })] + [InlineData (10, 10, new string [] { })] + [InlineData (-1, -1, new string [] { })] + [InlineData (1, 1, new [] { "top", "view" })] + [InlineData (1, 2, new [] { "top", "view" })] + [InlineData (2, 1, new [] { "top", "view" })] + [InlineData (2, 2, new [] { "top", "view", "popover" })] + [InlineData (3, 3, new [] { "top" })] // clipped + [InlineData (2, 3, new [] { "top" })] // clipped + public void Popover (int mouseX, int mouseY, string [] viewIdStrings) + { + // Arrange + Runnable? runnable = new () + { + Frame = new (0, 0, 10, 10), + Id = "top" + }; + + IApplication? app = Application.Create (); + app.Begin (runnable); + + var view = new View + { + Id = "view", + X = 1, + Y = 1, + Width = 2, + Height = 2, + Arrangement = ViewArrangement.Overlapped + }; // at 1,1 to 3,2 (screen) + + var popOver = new View + { + Id = "popover", + X = 1, + Y = 1, + Width = 2, + Height = 2, + Arrangement = ViewArrangement.Overlapped + }; // at 2,2 to 4,3 (screen) + + view.Add (popOver); + runnable.Add (view); + + List found = runnable.GetViewsUnderLocation (new (mouseX, mouseY), ViewportSettingsFlags.TransparentMouse); + + string [] foundIds = found.Select (v => v!.Id).ToArray (); + + Assert.Equal (viewIdStrings, foundIds); + + runnable.Dispose (); + } + + [Fact] + public void Returns_TopRunnable_When_Point_Inside_Only_TopRunnable () + { + IApplication? app = Application.Create (); + + Runnable runnable = new () + { + Id = "topRunnable", + Frame = new (0, 0, 20, 20) + }; + + Runnable secondaryRunnable = new () + { + Id = "secondaryRunnable", + Frame = new (5, 5, 10, 10) + }; + secondaryRunnable.Margin!.Thickness = new (1); + secondaryRunnable.Layout (); + + app.Begin (runnable); + app.Begin (secondaryRunnable); + + List found = runnable.GetViewsUnderLocation (new (2, 2), ViewportSettingsFlags.TransparentMouse); + Assert.Contains (found, v => v?.Id == runnable.Id); + Assert.Contains (found, v => v == runnable); + + runnable.Dispose (); + secondaryRunnable.Dispose (); + } + + [Fact] + public void Returns_SecondaryRunnable_When_Point_Inside_Only_SecondaryRunnable () + { + IApplication? app = Application.Create (); + + Runnable runnable = new () + { + Id = "topRunnable", + Frame = new (0, 0, 20, 20) + }; + + Runnable secondaryRunnable = new () + { + Id = "secondaryRunnable", + Frame = new (5, 5, 10, 10) + }; + secondaryRunnable.Margin!.Thickness = new (1); + secondaryRunnable.Layout (); + + app.Begin (runnable); + app.Begin (secondaryRunnable); + + List found = runnable.GetViewsUnderLocation (new (7, 7), ViewportSettingsFlags.TransparentMouse); + Assert.Contains (found, v => v?.Id == secondaryRunnable.Id); + Assert.DoesNotContain (found, v => v?.Id == runnable.Id); + + runnable.Dispose (); + secondaryRunnable.Dispose (); + } + + [Fact] + public void Returns_Depends_On_Margin_ViewportSettings_When_Point_In_Margin_Of_SecondaryRunnable () + { + IApplication? app = Application.Create (); + + Runnable runnable = new () + { + Id = "topRunnable", + Frame = new (0, 0, 20, 20) + }; + + Runnable secondaryRunnable = new () + { + Id = "secondaryRunnable", + Frame = new (5, 5, 10, 10) + }; + secondaryRunnable.Margin!.Thickness = new (1); + + app.Begin (runnable); + app.Begin (secondaryRunnable); + + secondaryRunnable.Margin!.ViewportSettings = ViewportSettingsFlags.None; + + List found = runnable.GetViewsUnderLocation (new (5, 5), ViewportSettingsFlags.TransparentMouse); + Assert.Contains (found, v => v == secondaryRunnable); + Assert.Contains (found, v => v == secondaryRunnable.Margin); + Assert.DoesNotContain (found, v => v?.Id == runnable.Id); + + secondaryRunnable.Margin!.ViewportSettings = ViewportSettingsFlags.TransparentMouse; + found = runnable.GetViewsUnderLocation (new (5, 5), ViewportSettingsFlags.TransparentMouse); + Assert.DoesNotContain (found, v => v == secondaryRunnable); + Assert.DoesNotContain (found, v => v == secondaryRunnable.Margin); + Assert.Contains (found, v => v?.Id == runnable.Id); + + runnable.Dispose (); + secondaryRunnable.Dispose (); + } + + [Fact] + public void Returns_Empty_When_Point_Outside_All_Runnables () + { + IApplication? app = Application.Create (); + + Runnable runnable = new () + { + Id = "topRunnable", + Frame = new (0, 0, 20, 20) + }; + + Runnable secondaryRunnable = new () + { + Id = "secondaryRunnable", + Frame = new (5, 5, 10, 10) + }; + secondaryRunnable.Margin!.Thickness = new (1); + secondaryRunnable.Layout (); + + app.Begin (runnable); + app.Begin (secondaryRunnable); + + List found = runnable.GetViewsUnderLocation (new (20, 20), ViewportSettingsFlags.TransparentMouse); + Assert.Empty (found); + + runnable.Dispose (); + secondaryRunnable.Dispose (); + } +} diff --git a/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationForRootTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/GetViewsUnderLocationForRootTests.cs similarity index 95% rename from Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationForRootTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/GetViewsUnderLocationForRootTests.cs index 34ef4d348..f8c467083 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationForRootTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/GetViewsUnderLocationForRootTests.cs @@ -1,6 +1,6 @@ #nullable enable -namespace UnitTests_Parallelizable.ViewMouseTests; +namespace ViewBaseTests.Layout; [Trait ("Category", "Input")] public class GetViewsUnderLocationForRootTests @@ -8,7 +8,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void ReturnsRoot_WhenPointInsideRoot_NoSubviews () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10) }; @@ -19,7 +19,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void ReturnsEmpty_WhenPointOutsideRoot () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10) }; @@ -30,7 +30,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void ReturnsSubview_WhenPointInsideSubview () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10) }; @@ -49,7 +49,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void ReturnsTop_WhenPointInsideSubview_With_TransparentMouse () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10) }; @@ -73,7 +73,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void ReturnsAdornment_WhenPointInMargin () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10) }; @@ -87,7 +87,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void Returns_WhenPointIn_TransparentToMouseMargin_None () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10) }; @@ -101,7 +101,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void Returns_WhenPointIn_NotTransparentToMouseMargin_Top_And_Margin () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10) }; @@ -115,7 +115,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void ReturnsAdornment_WhenPointInBorder () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10) }; @@ -128,7 +128,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void ReturnsAdornment_WhenPointInPadding () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10) }; @@ -143,7 +143,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void HonorsIgnoreTransparentMouseParam () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10), ViewportSettings = ViewportSettingsFlags.TransparentMouse @@ -158,7 +158,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void ReturnsDeepestSubview_WhenNested () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10) }; @@ -182,7 +182,7 @@ public class GetViewsUnderLocationForRootTests [Fact] public void Returns_Subview_WhenPointIn_TransparentToMouseMargin_Top () { - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 20, 20) }; @@ -216,7 +216,7 @@ public class GetViewsUnderLocationForRootTests public void Returns_Subview_Of_Adornment (string adornmentType) { // Arrange: top -> subView -> subView.[Adornment] -> adornmentSubView - Toplevel top = new () + Runnable top = new () { Frame = new (0, 0, 10, 10) }; @@ -277,7 +277,7 @@ public class GetViewsUnderLocationForRootTests public void Returns_OnlyParentsSuperView_Of_Adornment_If_TransparentMouse (string adornmentType) { // Arrange: top -> subView -> subView.[Adornment] -> adornmentSubView - Toplevel top = new () + Runnable top = new () { Id = "top", Frame = new (0, 0, 10, 10) diff --git a/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/GetViewsUnderLocationTests.cs similarity index 96% rename from Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/GetViewsUnderLocationTests.cs index 4bb0506c1..6db388683 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/GetViewsUnderLocationTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/GetViewsUnderLocationTests.cs @@ -1,6 +1,6 @@ #nullable enable -namespace UnitTests_Parallelizable.ViewMouseTests; +namespace ViewBaseTests.Mouse; [Trait ("Category", "Input")] public class GetViewsUnderLocationTests @@ -20,7 +20,7 @@ public class GetViewsUnderLocationTests var location = new Point (testX, testY); // Act - List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettingsFlags.None); + List viewsUnderMouse = view.GetViewsUnderLocation (location, ViewportSettingsFlags.None); // Assert Assert.Empty (viewsUnderMouse); @@ -42,7 +42,7 @@ public class GetViewsUnderLocationTests var location = new Point (testX, testY); // Act - List viewsUnderMouse = View.GetViewsUnderLocation (location, ViewportSettingsFlags.None); + List viewsUnderMouse = view.GetViewsUnderLocation (location, ViewportSettingsFlags.None); // Assert Assert.Empty (viewsUnderMouse); diff --git a/Tests/UnitTestsParallelizable/View/Layout/LayoutTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/LayoutTests.cs similarity index 95% rename from Tests/UnitTestsParallelizable/View/Layout/LayoutTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/LayoutTests.cs index 1c45576f2..21ab20afc 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/LayoutTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/LayoutTests.cs @@ -1,8 +1,7 @@ -using UnitTests.Parallelizable; +#nullable enable +namespace ViewBaseTests.Layout; -namespace UnitTests_Parallelizable.LayoutTests; - -public class LayoutTests : GlobalTestSetup +public class LayoutTests { #region Constructor Tests @@ -36,6 +35,37 @@ public class LayoutTests : GlobalTestSetup #endregion Constructor Tests + + [Fact] + public void Screen_Size_Change_Causes_Layout () + { + IApplication? app = Application.Create (); + app.Init ("Fake"); + Runnable? runnable = new (); + app.Begin (runnable); + + var view = new View + { + X = 3, + Y = 2, + Width = 10, + Height = 1, + Text = "0123456789" + }; + runnable.Add (view); + + app.Driver!.SetScreenSize (80, 25); + + Assert.Equal (new (0, 0, 80, 25), new Rectangle (0, 0, app.Screen.Width, app.Screen.Height)); + Assert.Equal (new (0, 0, app.Screen.Width, app.Screen.Height), runnable.Frame); + Assert.Equal (new (0, 0, 80, 25), runnable.Frame); + + app.Driver!.SetScreenSize (20, 10); + app.LayoutAndDraw (); + Assert.Equal (new (0, 0, app.Screen.Width, app.Screen.Height), runnable.Frame); + + Assert.Equal (new (0, 0, 20, 10), runnable.Frame); + } [Fact] public void Set_All_Absolute_Sets_Correctly () { diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.AbsoluteTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.AbsoluteTests.cs similarity index 91% rename from Tests/UnitTestsParallelizable/View/Layout/Pos.AbsoluteTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.AbsoluteTests.cs index 9bdc21d1a..318a14408 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.AbsoluteTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.AbsoluteTests.cs @@ -1,6 +1,7 @@ -using Xunit.Abstractions; +#nullable disable +using Xunit.Abstractions; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class PosAbsoluteTests (ITestOutputHelper output) { diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.AlignTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.AlignTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Layout/Pos.AlignTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.AlignTests.cs index f0ef53409..ae67bbfff 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.AlignTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.AlignTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class PosAlignTests { diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.AnchorEndTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.AnchorEndTests.cs similarity index 88% rename from Tests/UnitTestsParallelizable/View/Layout/Pos.AnchorEndTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.AnchorEndTests.cs index 767466209..a940a953c 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.AnchorEndTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.AnchorEndTests.cs @@ -1,7 +1,7 @@ -using Xunit.Abstractions; +#nullable disable using static Terminal.Gui.ViewBase.Pos; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class PosAnchorEndTests () { @@ -185,4 +185,28 @@ public class PosAnchorEndTests () Assert.Equal (7, result); } + + [Fact] + public void PosAnchorEnd_Equal_Inside_Window () + { + var viewWidth = 10; + var viewHeight = 1; + + var tv = new TextView + { + X = Pos.AnchorEnd (viewWidth), Y = Pos.AnchorEnd (viewHeight), Width = viewWidth, Height = viewHeight + }; + + var win = new Window { Width = 80, Height = 25 }; + + win.Add (tv); + + win.BeginInit (); + win.EndInit (); + win.Layout (); + + Assert.Equal (new (0, 0, 80, 25), win.Frame); + Assert.Equal (new (68, 22, 10, 1), tv.Frame); + win.Dispose (); + } } diff --git a/Tests/UnitTests/View/Layout/Pos.CenterTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.CenterTests.cs similarity index 74% rename from Tests/UnitTests/View/Layout/Pos.CenterTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.CenterTests.cs index 121df4da5..a7fc4783d 100644 --- a/Tests/UnitTests/View/Layout/Pos.CenterTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.CenterTests.cs @@ -1,16 +1,72 @@ using UnitTests; using Xunit.Abstractions; -using static Terminal.Gui.ViewBase.Dim; using static Terminal.Gui.ViewBase.Pos; -namespace UnitTests.LayoutTests; +namespace ViewBaseTests.Layout; -public class PosCenterTests (ITestOutputHelper output) +public class PosCenterTests (ITestOutputHelper output) : FakeDriverBase { private readonly ITestOutputHelper _output = output; + [Fact] + public void PosCenter_Constructor () + { + var posCenter = new PosCenter (); + Assert.NotNull (posCenter); + } + + [Fact] + public void PosCenter_ToString () + { + var posCenter = new PosCenter (); + var expectedString = "Center"; + + Assert.Equal (expectedString, posCenter.ToString ()); + } + + [Fact] + public void PosCenter_GetAnchor () + { + var posCenter = new PosCenter (); + var width = 50; + int expectedAnchor = width / 2; + + Assert.Equal (expectedAnchor, posCenter.GetAnchor (width)); + } + + [Fact] + public void PosCenter_CreatesCorrectInstance () + { + Pos pos = Center (); + Assert.IsType (pos); + } + + [Theory] + [InlineData (10, 2, 4)] + [InlineData (10, 10, 0)] + [InlineData (10, 11, 0)] + [InlineData (10, 12, -1)] + [InlineData (19, 20, 0)] + public void PosCenter_Calculate_ReturnsExpectedValue (int superviewDimension, int width, int expectedX) + { + var posCenter = new PosCenter (); + int result = posCenter.Calculate (superviewDimension, new DimAbsolute (width), null!, Dimension.Width); + Assert.Equal (expectedX, result); + } + + [Fact] + public void PosCenter_Bigger_Than_SuperView () + { + var superView = new View { Width = 10, Height = 10 }; + var view = new View { X = Center (), Y = Center (), Width = 20, Height = 20 }; + superView.Add (view); + superView.LayoutSubViews (); + + Assert.Equal (-5, view.Frame.Left); + Assert.Equal (-5, view.Frame.Top); + } + [Theory] - [AutoInitShutdown] [InlineData (1)] [InlineData (2)] [InlineData (3)] @@ -23,7 +79,9 @@ public class PosCenterTests (ITestOutputHelper output) [InlineData (10)] public void PosCenter_SubView_85_Percent_Height (int height) { - var win = new Window { Width = Fill (), Height = Fill () }; + IDriver driver = CreateFakeDriver (20, height); + var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; + win.Driver = driver; var subview = new Window { @@ -31,23 +89,22 @@ public class PosCenterTests (ITestOutputHelper output) }; win.Add (subview); + win.BeginInit (); + win.EndInit (); + win.SetRelativeLayout (driver.Screen.Size); + win.LayoutSubViews (); + win.Draw (); - SessionToken rs = Application.Begin (win); - - Application.Driver!.SetScreenSize (20, height); - AutoInitShutdownAttribute.RunIteration (); var expected = string.Empty; switch (height) { case 1: - //Assert.Equal (new (0, 0, 17, 0), subview.Frame); expected = @" ────────────────────"; break; case 2: - //Assert.Equal (new (0, 0, 17, 1), subview.Frame); expected = @" ┌──────────────────┐ └──────────────────┘ @@ -55,7 +112,6 @@ public class PosCenterTests (ITestOutputHelper output) break; case 3: - //Assert.Equal (new (0, 0, 17, 2), subview.Frame); expected = @" ┌──────────────────┐ │ │ @@ -64,7 +120,6 @@ public class PosCenterTests (ITestOutputHelper output) break; case 4: - //Assert.Equal (new (0, 0, 17, 3), subview.Frame); expected = @" ┌──────────────────┐ │ ─────────────── │ @@ -73,7 +128,6 @@ public class PosCenterTests (ITestOutputHelper output) break; case 5: - //Assert.Equal (new (0, 0, 17, 3), subview.Frame); expected = @" ┌──────────────────┐ │ ┌─────────────┐ │ @@ -83,7 +137,6 @@ public class PosCenterTests (ITestOutputHelper output) break; case 6: - //Assert.Equal (new (0, 0, 17, 3), subview.Frame); expected = @" ┌──────────────────┐ │ ┌─────────────┐ │ @@ -94,7 +147,6 @@ public class PosCenterTests (ITestOutputHelper output) break; case 7: - //Assert.Equal (new (0, 0, 17, 3), subview.Frame); expected = @" ┌──────────────────┐ │ ┌─────────────┐ │ @@ -106,7 +158,6 @@ public class PosCenterTests (ITestOutputHelper output) break; case 8: - //Assert.Equal (new (0, 0, 17, 3), subview.Frame); expected = @" ┌──────────────────┐ │ ┌─────────────┐ │ @@ -119,7 +170,6 @@ public class PosCenterTests (ITestOutputHelper output) break; case 9: - //Assert.Equal (new (0, 0, 17, 3), subview.Frame); expected = @" ┌──────────────────┐ │ │ @@ -133,7 +183,6 @@ public class PosCenterTests (ITestOutputHelper output) break; case 10: - //Assert.Equal (new (0, 0, 17, 3), subview.Frame); expected = @" ┌──────────────────┐ │ │ @@ -150,13 +199,12 @@ public class PosCenterTests (ITestOutputHelper output) break; } - _ = DriverAssert.AssertDriverContentsWithFrameAre (expected, _output); - Application.End (rs); + _ = DriverAssert.AssertDriverContentsWithFrameAre (expected, _output, driver); win.Dispose (); + driver.End (); } [Theory] - [AutoInitShutdown] [InlineData (1)] [InlineData (2)] [InlineData (3)] @@ -169,7 +217,9 @@ public class PosCenterTests (ITestOutputHelper output) [InlineData (10)] public void PosCenter_SubView_85_Percent_Width (int width) { - var win = new Window { Width = Fill (), Height = Fill () }; + IDriver driver = CreateFakeDriver (width, 7); + var win = new Window { Width = Dim.Fill (), Height = Dim.Fill () }; + win.Driver = driver; var subview = new Window { @@ -177,11 +227,12 @@ public class PosCenterTests (ITestOutputHelper output) }; win.Add (subview); + win.BeginInit (); + win.EndInit (); + win.SetRelativeLayout (driver.Screen.Size); + win.LayoutSubViews (); + win.Draw (); - SessionToken rs = Application.Begin (win); - - Application.Driver!.SetScreenSize (width, 7); - AutoInitShutdownAttribute.RunIteration (); var expected = string.Empty; switch (width) @@ -319,8 +370,8 @@ public class PosCenterTests (ITestOutputHelper output) break; } - _ = DriverAssert.AssertDriverContentsWithFrameAre (expected, _output); - Application.End (rs); + _ = DriverAssert.AssertDriverContentsWithFrameAre (expected, _output, driver); win.Dispose (); + driver.End (); } } diff --git a/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.CombineTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.CombineTests.cs new file mode 100644 index 000000000..f23a665f6 --- /dev/null +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.CombineTests.cs @@ -0,0 +1,139 @@ +#nullable disable + +using Xunit.Abstractions; +using static Terminal.Gui.ViewBase.Dim; +using static Terminal.Gui.ViewBase.Pos; + +namespace ViewBaseTests.Layout; + +public class PosCombineTests (ITestOutputHelper output) +{ + private readonly ITestOutputHelper _output = output; + + // TODO: This actually a SetRelativeLayout/LayoutSubViews test and should be moved + // TODO: A new test that calls SetRelativeLayout directly is needed. + [Fact] + public void PosCombine_Referencing_Same_View () + { + var super = new View { Width = 10, Height = 10, Text = "super" }; + var view1 = new View { Width = 2, Height = 2, Text = "view1" }; + var view2 = new View { Width = 2, Height = 2, Text = "view2" }; + view2.X = AnchorEnd (0) - (Right (view2) - Left (view2)); + + super.Add (view1, view2); + super.BeginInit (); + super.EndInit (); + + Exception exception = Record.Exception (super.LayoutSubViews); + Assert.Null (exception); + Assert.Equal (new (0, 0, 10, 10), super.Frame); + Assert.Equal (new (0, 0, 2, 2), view1.Frame); + Assert.Equal (new (8, 0, 2, 2), view2.Frame); + + super.Dispose (); + } + + [Fact] + public void PosCombine_DimCombine_View_With_SubViews () + { + IApplication app = Application.Create (); + Runnable runnable = new () { Width = 80, Height = 25 }; + app.Begin (runnable); + var win1 = new Window { Id = "win1", Width = 20, Height = 10 }; + + var view1 = new View + { + Text = "view1", + Width = Auto (DimAutoStyle.Text), + Height = Auto (DimAutoStyle.Text) + }; + var win2 = new Window { Id = "win2", Y = Bottom (view1) + 1, Width = 10, Height = 3 }; + var view2 = new View { Id = "view2", Width = Fill (), Height = 1, CanFocus = true }; + + var view3 = new View { Id = "view3", Width = Fill (1), Height = 1, CanFocus = true }; + + view2.Add (view3); + win2.Add (view2); + win1.Add (view1, win2); + runnable.Add (win1); + + Assert.Equal (new (0, 0, 80, 25), runnable.Frame); + Assert.Equal (new (0, 0, 5, 1), view1.Frame); + Assert.Equal (new (0, 0, 20, 10), win1.Frame); + Assert.Equal (new (0, 2, 10, 3), win2.Frame); + Assert.Equal (new (0, 0, 8, 1), view2.Frame); + Assert.Equal (new (0, 0, 7, 1), view3.Frame); + View foundView = runnable.GetViewsUnderLocation (new (9, 4), ViewportSettingsFlags.None).LastOrDefault (); + Assert.Equal (foundView, view2); + runnable.Dispose (); + } + + [Fact] + public void PosCombine_Will_Throws () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + var t = new Runnable (); + + var w = new Window { X = Left (t) + 2, Y = Top (t) + 2 }; + var f = new FrameView (); + var v1 = new View { X = Left (w) + 2, Y = Top (w) + 2 }; + var v2 = new View { X = Left (v1) + 2, Y = Top (v1) + 2 }; + + f.Add (v1); // v2 not added + w.Add (f); + t.Add (w); + + f.X = X (v2) - X (v1); + f.Y = Y (v2) - Y (v1); + + app.StopAfterFirstIteration = true; + Assert.Throws (() => app.Run (t)); + t.Dispose (); + v2.Dispose (); + app.Dispose (); + } + + [Fact] + public void PosCombine_Refs_SuperView_Throws () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + var top = new Runnable (); + var w = new Window { X = Left (top) + 2, Y = Top (top) + 2 }; + var f = new FrameView (); + var v1 = new View { X = Left (w) + 2, Y = Top (w) + 2 }; + var v2 = new View { X = Left (v1) + 2, Y = Top (v1) + 2 }; + + f.Add (v1, v2); + w.Add (f); + top.Add (w); + SessionToken token = app.Begin (top); + + f.X = X (app.TopRunnableView) + X (v2) - X (v1); + f.Y = Y (app.TopRunnableView) + Y (v2) - Y (v1); + + app.TopRunnableView!.SubViewsLaidOut += (s, e) => + { + Assert.Equal (0, app.TopRunnableView.Frame.X); + Assert.Equal (0, app.TopRunnableView.Frame.Y); + Assert.Equal (2, w.Frame.X); + Assert.Equal (2, w.Frame.Y); + Assert.Equal (2, f.Frame.X); + Assert.Equal (2, f.Frame.Y); + Assert.Equal (4, v1.Frame.X); + Assert.Equal (4, v1.Frame.Y); + Assert.Equal (6, v2.Frame.X); + Assert.Equal (6, v2.Frame.Y); + }; + + app.StopAfterFirstIteration = true; + + Assert.Throws (() => app.Run (top)); + app.TopRunnableView?.Dispose (); + top.Dispose (); + app.Dispose (); + } +} diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.FuncTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.FuncTests.cs similarity index 96% rename from Tests/UnitTestsParallelizable/View/Layout/Pos.FuncTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.FuncTests.cs index adc67dd60..082deac75 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.FuncTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.FuncTests.cs @@ -1,6 +1,7 @@ -using Xunit.Abstractions; +#nullable disable +using Xunit.Abstractions; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class PosFuncTests (ITestOutputHelper output) { diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.PercentTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.PercentTests.cs similarity index 96% rename from Tests/UnitTestsParallelizable/View/Layout/Pos.PercentTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.PercentTests.cs index 65df904ee..c3528ed9e 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.PercentTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.PercentTests.cs @@ -1,7 +1,7 @@ using Xunit.Abstractions; using static Terminal.Gui.ViewBase.Pos; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class PosPercentTests (ITestOutputHelper output) { @@ -39,7 +39,7 @@ public class PosPercentTests (ITestOutputHelper output) }; container.Add (view); - var top = new Toplevel (); + var top = new Runnable (); top.Add (container); top.LayoutSubViews (); diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.Tests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.Tests.cs similarity index 98% rename from Tests/UnitTestsParallelizable/View/Layout/Pos.Tests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.Tests.cs index 392140f3e..dde6eaa4b 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.Tests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.Tests.cs @@ -1,4 +1,5 @@ -namespace UnitTests_Parallelizable.LayoutTests; +#nullable disable +namespace ViewBaseTests.Layout; public class PosTests { diff --git a/Tests/UnitTestsParallelizable/View/Layout/Pos.ViewTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.ViewTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Layout/Pos.ViewTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.ViewTests.cs index efac33e90..fc3e99508 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/Pos.ViewTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/Pos.ViewTests.cs @@ -1,6 +1,6 @@ using static Terminal.Gui.ViewBase.Pos; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class PosViewTests { diff --git a/Tests/UnitTestsParallelizable/View/Layout/ScreenToTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/ScreenToTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Layout/ScreenToTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/ScreenToTests.cs index 5b6c151b2..58f01b45b 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/ScreenToTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/ScreenToTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; /// Tests for view coordinate mapping (e.g. etc...). public class ScreenToTests diff --git a/Tests/UnitTestsParallelizable/View/Layout/SetRelativeLayoutTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/SetRelativeLayoutTests.cs similarity index 98% rename from Tests/UnitTestsParallelizable/View/Layout/SetRelativeLayoutTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/SetRelativeLayoutTests.cs index a10f9d6df..b7e35fbcc 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/SetRelativeLayoutTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/SetRelativeLayoutTests.cs @@ -1,9 +1,6 @@ -using JetBrains.Annotations; -using UnitTests; -using Xunit.Abstractions; -using static Terminal.Gui.ViewBase.Dim; +using static Terminal.Gui.ViewBase.Dim; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class SetRelativeLayoutTests { @@ -404,7 +401,7 @@ public class SetRelativeLayoutTests }; view.X = Pos.AnchorEnd (0) - Pos.Func (GetViewWidth); - int GetViewWidth ([CanBeNull] View _) { return view.Frame.Width; } + int GetViewWidth (View? _) { return view.Frame.Width; } // view will be 3 chars wide. It's X will be 27 (30 - 3). // BUGBUG: IsInitialized need to be true before calculate diff --git a/Tests/UnitTestsParallelizable/View/Layout/ToScreenTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/ToScreenTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Layout/ToScreenTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/ToScreenTests.cs index e005b7ca9..d426aa24e 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/ToScreenTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/ToScreenTests.cs @@ -1,6 +1,6 @@ using Xunit.Abstractions; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; /// /// Test the and methods. diff --git a/Tests/UnitTestsParallelizable/View/Layout/TopologicalSortTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/TopologicalSortTests.cs similarity index 97% rename from Tests/UnitTestsParallelizable/View/Layout/TopologicalSortTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/TopologicalSortTests.cs index e2fe774a4..edae0dde7 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/TopologicalSortTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/TopologicalSortTests.cs @@ -1,6 +1,6 @@ using Xunit.Abstractions; -namespace UnitTests_Parallelizable.LayoutTests; +namespace ViewBaseTests.Layout; public class TopologicalSortTests (ITestOutputHelper output) { diff --git a/Tests/UnitTestsParallelizable/View/Layout/ViewLayoutEventTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/ViewLayoutEventTests.cs similarity index 98% rename from Tests/UnitTestsParallelizable/View/Layout/ViewLayoutEventTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/ViewLayoutEventTests.cs index bc368764f..d6b24bb39 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/ViewLayoutEventTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/ViewLayoutEventTests.cs @@ -1,9 +1,9 @@ #nullable enable using UnitTests.Parallelizable; -namespace UnitTests_Parallelizable.ViewLayoutEventTests; +namespace ViewBaseTests.Layout; -public class ViewLayoutEventTests : GlobalTestSetup +public class ViewLayoutEventTests { [Fact] public void View_WidthChanging_Event_Fires () diff --git a/Tests/UnitTestsParallelizable/View/Layout/ViewportTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Layout/ViewportTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Layout/ViewportTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Layout/ViewportTests.cs index 123ff90c2..a60ba318b 100644 --- a/Tests/UnitTestsParallelizable/View/Layout/ViewportTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Layout/ViewportTests.cs @@ -1,6 +1,6 @@ using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Viewport; /// /// Test the . diff --git a/Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseDragTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseDragTests.cs new file mode 100644 index 000000000..8307ada94 --- /dev/null +++ b/Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseDragTests.cs @@ -0,0 +1,667 @@ +namespace ViewBaseTests.Mouse; + +/// +/// Parallelizable tests for mouse drag functionality on movable and resizable views. +/// These tests validate mouse drag behavior without Application.Init or global state. +/// +[Trait ("Category", "Input")] +public class MouseDragTests +{ + #region Movable View Drag Tests + + [Fact] + public void MovableView_MouseDrag_UpdatesPosition () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + View superView = new () + { + Width = 50, + Height = 50, + App = app + }; + + View movableView = new () + { + X = 10, + Y = 10, + Width = 10, + Height = 10, + Arrangement = ViewArrangement.Movable, + BorderStyle = LineStyle.Single, + App = app + }; + + superView.Add (movableView); + + // Add to a runnable so the views are part of the application + var runnable = new Runnable { App = app, Frame = new (0, 0, 80, 25) }; + runnable.Add (superView); + app.Begin (runnable); + + // Simulate mouse press on border to start drag + MouseEventArgs pressEvent = new () + { + ScreenPosition = new (10, 10), // Screen position + Flags = MouseFlags.Button1Pressed + }; + + // Act - Start drag + app.Mouse.RaiseMouseEvent (pressEvent); + + // Simulate mouse drag + MouseEventArgs dragEvent = new () + { + ScreenPosition = new (15, 15), // New screen position + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + app.Mouse.RaiseMouseEvent (dragEvent); + + // Assert - View should have moved + Assert.Equal (15, movableView.Frame.X); + Assert.Equal (15, movableView.Frame.Y); + Assert.Equal (10, movableView.Frame.Width); + Assert.Equal (10, movableView.Frame.Height); + + app.End (app.SessionStack!.First ()); + runnable.Dispose (); + superView.Dispose (); + } + + [Fact] + public void MovableView_MouseDrag_WithSuperview_UsesCorrectCoordinates () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + View superView = new () + { + X = 5, + Y = 5, + Width = 50, + Height = 50 + }; + + View movableView = new () + { + X = 10, + Y = 10, + Width = 10, + Height = 10, + Arrangement = ViewArrangement.Movable, + BorderStyle = LineStyle.Single + }; + + superView.Add (movableView); + + // Add to a runnable so the views are part of the application + var runnable = new Runnable { App = app, Frame = new (0, 0, 80, 25) }; + runnable.Add (superView); + app.Begin (runnable); + + // Simulate mouse press on border + MouseEventArgs pressEvent = new () + { + ScreenPosition = new (15, 15), // 5+10 offset + Flags = MouseFlags.Button1Pressed + }; + + app.Mouse.RaiseMouseEvent (pressEvent); + + // Simulate mouse drag + MouseEventArgs dragEvent = new () + { + ScreenPosition = new (18, 18), // Moved 3,3 + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + app.Mouse.RaiseMouseEvent (dragEvent); + + // Assert - View should have moved relative to superview + Assert.Equal (13, movableView.Frame.X); // 10 + 3 + Assert.Equal (13, movableView.Frame.Y); // 10 + 3 + + app.End (app.SessionStack!.First ()); + runnable.Dispose (); + superView.Dispose (); + } + + [Fact] + public void MovableView_MouseRelease_StopsDrag () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + View superView = new () + { + Width = 50, + Height = 50 + }; + + View movableView = new () + { + X = 10, + Y = 10, + Width = 10, + Height = 10, + Arrangement = ViewArrangement.Movable, + BorderStyle = LineStyle.Single + }; + + superView.Add (movableView); + + // Add to a runnable so the views are part of the application + var runnable = new Runnable { App = app, Frame = new (0, 0, 80, 25) }; + runnable.Add (superView); + app.Begin (runnable); + + // Start drag + MouseEventArgs pressEvent = new () + { + ScreenPosition = new (10, 10), + Flags = MouseFlags.Button1Pressed + }; + + app.Mouse.RaiseMouseEvent (pressEvent); + + // Drag + MouseEventArgs dragEvent = new () + { + ScreenPosition = new (15, 15), + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + app.Mouse.RaiseMouseEvent (dragEvent); + + // Release + MouseEventArgs releaseEvent = new () + { + ScreenPosition = new (15, 15), + Flags = MouseFlags.Button1Released + }; + + app.Mouse.RaiseMouseEvent (releaseEvent); + + // Assert - Position should remain at dragged location + Assert.Equal (15, movableView.Frame.X); + Assert.Equal (15, movableView.Frame.Y); + + app.End (app.SessionStack!.First ()); + runnable.Dispose (); + superView.Dispose (); + } + + #endregion + + #region Resizable View Drag Tests + + [Fact] + public void ResizableView_RightResize_Drag_IncreasesWidth () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + View superView = new () + { + Width = 50, + Height = 50 + }; + + View resizableView = new () + { + X = 10, + Y = 10, + Width = 10, + Height = 10, + Arrangement = ViewArrangement.RightResizable, + BorderStyle = LineStyle.Single + }; + + superView.Add (resizableView); + + // Add to a runnable so the views are part of the application + var runnable = new Runnable { App = app, Frame = new (0, 0, 80, 25) }; + runnable.Add (superView); + app.Begin (runnable); + + // Simulate mouse press on right border + MouseEventArgs pressEvent = new () + { + ScreenPosition = new (19, 15), + Flags = MouseFlags.Button1Pressed + }; + + app.Mouse.RaiseMouseEvent (pressEvent); + + // Simulate mouse drag to the right + MouseEventArgs dragEvent = new () + { + ScreenPosition = new (24, 15), + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + app.Mouse.RaiseMouseEvent (dragEvent); + + // Assert - Width should have increased + Assert.Equal (10, resizableView.Frame.X); // X unchanged + Assert.Equal (10, resizableView.Frame.Y); // Y unchanged + Assert.Equal (15, resizableView.Frame.Width); // Width increased by 5 + Assert.Equal (10, resizableView.Frame.Height); // Height unchanged + + app.End (app.SessionStack!.First ()); + runnable.Dispose (); + superView.Dispose (); + } + + [Fact] + public void ResizableView_BottomResize_Drag_IncreasesHeight () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + View superView = new () + { + Width = 50, + Height = 50 + }; + + View resizableView = new () + { + X = 10, + Y = 10, + Width = 10, + Height = 10, + Arrangement = ViewArrangement.BottomResizable, + BorderStyle = LineStyle.Single + }; + + superView.Add (resizableView); + + // Add to a runnable so the views are part of the application + var runnable = new Runnable { App = app, Frame = new (0, 0, 80, 25) }; + runnable.Add (superView); + app.Begin (runnable); + + // Simulate mouse press on bottom border + MouseEventArgs pressEvent = new () + { + ScreenPosition = new (15, 19), + Flags = MouseFlags.Button1Pressed + }; + + app.Mouse.RaiseMouseEvent (pressEvent); + + // Simulate mouse drag down + MouseEventArgs dragEvent = new () + { + ScreenPosition = new (15, 24), + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + app.Mouse.RaiseMouseEvent (dragEvent); + + // Assert - Height should have increased + Assert.Equal (10, resizableView.Frame.X); // X unchanged + Assert.Equal (10, resizableView.Frame.Y); // Y unchanged + Assert.Equal (10, resizableView.Frame.Width); // Width unchanged + Assert.Equal (15, resizableView.Frame.Height); // Height increased by 5 + + app.End (app.SessionStack!.First ()); + runnable.Dispose (); + superView.Dispose (); + } + + [Fact] + public void ResizableView_LeftResize_Drag_MovesAndResizes () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + View superView = new () + { + Width = 50, + Height = 50 + }; + + View resizableView = new () + { + X = 10, + Y = 10, + Width = 10, + Height = 10, + Arrangement = ViewArrangement.LeftResizable, + BorderStyle = LineStyle.Single + }; + + superView.Add (resizableView); + + // Add to a runnable so the views are part of the application + var runnable = new Runnable { App = app, Frame = new (0, 0, 80, 25) }; + runnable.Add (superView); + app.Begin (runnable); + + // Simulate mouse press on left border + MouseEventArgs pressEvent = new () + { + ScreenPosition = new (10, 15), + Flags = MouseFlags.Button1Pressed + }; + + app.Mouse.RaiseMouseEvent (pressEvent); + + // Simulate mouse drag to the left + MouseEventArgs dragEvent = new () + { + ScreenPosition = new (7, 15), + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + app.Mouse.RaiseMouseEvent (dragEvent); + + // Assert - Should move left and resize + Assert.Equal (7, resizableView.Frame.X); // X moved left by 3 + Assert.Equal (10, resizableView.Frame.Y); // Y unchanged + Assert.Equal (13, resizableView.Frame.Width); // Width increased by 3 + Assert.Equal (10, resizableView.Frame.Height); // Height unchanged + + app.End (app.SessionStack!.First ()); + runnable.Dispose (); + superView.Dispose (); + } + + [Fact] + public void ResizableView_TopResize_Drag_MovesAndResizes () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + View superView = new () + { + Width = 50, + Height = 50 + }; + + View resizableView = new () + { + X = 10, + Y = 10, + Width = 10, + Height = 10, + Arrangement = ViewArrangement.TopResizable, + BorderStyle = LineStyle.Single + }; + + superView.Add (resizableView); + + // Add to a runnable so the views are part of the application + var runnable = new Runnable { App = app, Frame = new (0, 0, 80, 25) }; + runnable.Add (superView); + app.Begin (runnable); + + // Simulate mouse press on top border + MouseEventArgs pressEvent = new () + { + ScreenPosition = new (15, 10), + Flags = MouseFlags.Button1Pressed + }; + + app.Mouse.RaiseMouseEvent (pressEvent); + + // Simulate mouse drag up + MouseEventArgs dragEvent = new () + { + ScreenPosition = new (15, 8), + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + app.Mouse.RaiseMouseEvent (dragEvent); + + // Assert - Should move up and resize + Assert.Equal (10, resizableView.Frame.X); // X unchanged + Assert.Equal (8, resizableView.Frame.Y); // Y moved up by 2 + Assert.Equal (10, resizableView.Frame.Width); // Width unchanged + Assert.Equal (12, resizableView.Frame.Height); // Height increased by 2 + + app.End (app.SessionStack!.First ()); + runnable.Dispose (); + superView.Dispose (); + } + + #endregion + + #region Corner Resize Tests + + [Fact] + public void ResizableView_BottomRightCornerResize_Drag_ResizesBothDimensions () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + View superView = new () + { + Width = 50, + Height = 50 + }; + + View resizableView = new () + { + X = 10, + Y = 10, + Width = 10, + Height = 10, + Arrangement = ViewArrangement.BottomResizable | ViewArrangement.RightResizable, + BorderStyle = LineStyle.Single + }; + + superView.Add (resizableView); + + // Add to a runnable so the views are part of the application + var runnable = new Runnable { App = app, Frame = new (0, 0, 80, 25) }; + runnable.Add (superView); + app.Begin (runnable); + + // Simulate mouse press on bottom-right corner + MouseEventArgs pressEvent = new () + { + ScreenPosition = new (19, 19), + Flags = MouseFlags.Button1Pressed + }; + + app.Mouse.RaiseMouseEvent (pressEvent); + + // Simulate mouse drag diagonally + MouseEventArgs dragEvent = new () + { + ScreenPosition = new (24, 24), + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + app.Mouse.RaiseMouseEvent (dragEvent); + + // Assert - Both dimensions should increase + Assert.Equal (10, resizableView.Frame.X); // X unchanged + Assert.Equal (10, resizableView.Frame.Y); // Y unchanged + Assert.Equal (15, resizableView.Frame.Width); // Width increased by 5 + Assert.Equal (15, resizableView.Frame.Height); // Height increased by 5 + + app.End (app.SessionStack!.First ()); + runnable.Dispose (); + superView.Dispose (); + } + + [Fact] + public void ResizableView_TopLeftCornerResize_Drag_MovesAndResizes () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + View superView = new () + { + Width = 50, + Height = 50 + }; + + View resizableView = new () + { + X = 10, + Y = 10, + Width = 10, + Height = 10, + Arrangement = ViewArrangement.TopResizable | ViewArrangement.LeftResizable, + BorderStyle = LineStyle.Single + }; + + superView.Add (resizableView); + + // Add to a runnable so the views are part of the application + var runnable = new Runnable { App = app, Frame = new (0, 0, 80, 25) }; + runnable.Add (superView); + app.Begin (runnable); + + // Simulate mouse press on top-left corner + MouseEventArgs pressEvent = new () + { + ScreenPosition = new (10, 10), + Flags = MouseFlags.Button1Pressed + }; + + app.Mouse.RaiseMouseEvent (pressEvent); + + // Simulate mouse drag diagonally up and left + MouseEventArgs dragEvent = new () + { + ScreenPosition = new (7, 8), + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + app.Mouse.RaiseMouseEvent (dragEvent); + + // Assert - Should move and resize + Assert.Equal (7, resizableView.Frame.X); // X moved left by 3 + Assert.Equal (8, resizableView.Frame.Y); // Y moved up by 2 + Assert.Equal (13, resizableView.Frame.Width); // Width increased by 3 + Assert.Equal (12, resizableView.Frame.Height); // Height increased by 2 + + app.End (app.SessionStack!.First ()); + runnable.Dispose (); + superView.Dispose (); + } + + #endregion + + #region Minimum Size Constraints + + [Fact] + public void ResizableView_Drag_RespectsMinimumWidth () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + View superView = new () + { + Width = 50, + Height = 50 + }; + + View resizableView = new () + { + X = 10, + Y = 10, + Width = 10, + Height = 10, + Arrangement = ViewArrangement.LeftResizable, + BorderStyle = LineStyle.Single + }; + + superView.Add (resizableView); + + // Add to a runnable so the views are part of the application + var runnable = new Runnable { App = app, Frame = new (0, 0, 80, 25) }; + runnable.Add (superView); + app.Begin (runnable); + + // Try to drag far to the right (making width very small) + MouseEventArgs dragEvent = new () + { + Position = new (8, 5), // Drag 8 units right, would make width 2 + ScreenPosition = new (18, 15), + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + // Act + resizableView.Border!.HandleDragOperation (dragEvent); + + // Assert - Width should be constrained to minimum + // Minimum width = border thickness + margin right + int expectedMinWidth = resizableView.Border!.Thickness.Horizontal + resizableView.Margin!.Thickness.Right; + Assert.True (resizableView.Frame.Width >= expectedMinWidth); + + app.End (app.SessionStack!.First ()); + runnable.Dispose (); + superView.Dispose (); + } + + [Fact] + public void ResizableView_Drag_RespectsMinimumHeight () + { + // Arrange + using IApplication app = Application.Create (); + app.Init ("fake"); + + View superView = new () + { + Width = 50, + Height = 50 + }; + + View resizableView = new () + { + X = 10, + Y = 10, + Width = 10, + Height = 10, + Arrangement = ViewArrangement.TopResizable, + BorderStyle = LineStyle.Single + }; + + superView.Add (resizableView); + + // Add to a runnable so the views are part of the application + var runnable = new Runnable { App = app, Frame = new (0, 0, 80, 25) }; + runnable.Add (superView); + app.Begin (runnable); + + // Try to drag far down (making height very small) + MouseEventArgs dragEvent = new () + { + Position = new (5, 8), // Drag 8 units down, would make height 2 + ScreenPosition = new (15, 18), + Flags = MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition + }; + + // Act + resizableView.Border!.HandleDragOperation (dragEvent); + + // Assert - Height should be constrained to minimum + int expectedMinHeight = resizableView.Border!.Thickness.Vertical + resizableView.Margin!.Thickness.Bottom; + Assert.True (resizableView.Frame.Height >= expectedMinHeight); + + app.End (app.SessionStack!.First ()); + runnable.Dispose (); + superView.Dispose (); + } + + #endregion +} diff --git a/Tests/UnitTestsParallelizable/View/Mouse/MouseEnterLeaveTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseEnterLeaveTests.cs similarity index 97% rename from Tests/UnitTestsParallelizable/View/Mouse/MouseEnterLeaveTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseEnterLeaveTests.cs index bd034084b..dabf62225 100644 --- a/Tests/UnitTestsParallelizable/View/Mouse/MouseEnterLeaveTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseEnterLeaveTests.cs @@ -1,6 +1,6 @@ using System.ComponentModel; -namespace UnitTests_Parallelizable.ViewMouseTests; +namespace ViewBaseTests.Mouse; [Trait ("Category", "Input")] public class MouseEnterLeaveTests @@ -40,7 +40,7 @@ public class MouseEnterLeaveTests public bool MouseEnterRaised { get; private set; } public bool MouseLeaveRaised { get; private set; } - private void OnMouseEnterHandler (object s, CancelEventArgs e) + private void OnMouseEnterHandler (object? s, CancelEventArgs e) { MouseEnterRaised = true; @@ -50,7 +50,7 @@ public class MouseEnterLeaveTests } } - private void OnMouseLeaveHandler (object s, EventArgs e) { MouseLeaveRaised = true; } + private void OnMouseLeaveHandler (object? s, EventArgs e) { MouseLeaveRaised = true; } } [Fact] diff --git a/Tests/UnitTestsParallelizable/View/Mouse/MouseEventRoutingTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseEventRoutingTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Mouse/MouseEventRoutingTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseEventRoutingTests.cs index 8f9453832..5f8450efa 100644 --- a/Tests/UnitTestsParallelizable/View/Mouse/MouseEventRoutingTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseEventRoutingTests.cs @@ -1,7 +1,7 @@ using Terminal.Gui.App; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ApplicationTests; +namespace ApplicationTests; /// /// Parallelizable tests for mouse event routing and coordinate transformation. diff --git a/Tests/UnitTestsParallelizable/View/Mouse/MouseTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseTests.cs similarity index 96% rename from Tests/UnitTestsParallelizable/View/Mouse/MouseTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseTests.cs index 9091312c4..9fa3d824f 100644 --- a/Tests/UnitTestsParallelizable/View/Mouse/MouseTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Mouse/MouseTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewMouseTests; +namespace ViewBaseTests.Mouse; [Collection ("Global Test Setup")] @@ -106,7 +106,7 @@ public class MouseTests (ITestOutputHelper output) : TestsAllViews [MemberData (nameof (AllViewTypes))] public void AllViews_NewMouseEvent_Enabled_False_Does_Not_Set_Handled (Type viewType) { - View view = CreateInstanceIfNotGeneric (viewType); + View? view = CreateInstanceIfNotGeneric (viewType); if (view == null) { @@ -126,7 +126,7 @@ public class MouseTests (ITestOutputHelper output) : TestsAllViews [MemberData (nameof (AllViewTypes))] public void AllViews_NewMouseEvent_Clicked_Enabled_False_Does_Not_Set_Handled (Type viewType) { - View view = CreateInstanceIfNotGeneric (viewType); + View? view = CreateInstanceIfNotGeneric (viewType); if (view == null) { diff --git a/Tests/UnitTestsParallelizable/View/Navigation/AddRemoveTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Navigation/AddRemoveTests.cs similarity index 98% rename from Tests/UnitTestsParallelizable/View/Navigation/AddRemoveTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Navigation/AddRemoveTests.cs index 03fe076a9..bc8e4b60d 100644 --- a/Tests/UnitTestsParallelizable/View/Navigation/AddRemoveTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Navigation/AddRemoveTests.cs @@ -1,7 +1,6 @@ using UnitTests; -using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Navigation; [Collection ("Global Test Setup")] public class AddRemoveNavigationTests () : TestsAllViews diff --git a/Tests/UnitTestsParallelizable/View/Navigation/AdvanceFocusTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Navigation/AdvanceFocusTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Navigation/AdvanceFocusTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Navigation/AdvanceFocusTests.cs index 3c52f3ad9..bdb18b0f3 100644 --- a/Tests/UnitTestsParallelizable/View/Navigation/AdvanceFocusTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Navigation/AdvanceFocusTests.cs @@ -1,7 +1,4 @@ -using System.Runtime.Intrinsics; -using Xunit.Abstractions; - -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Navigation; public class AdvanceFocusTests () { diff --git a/Tests/UnitTests/View/Navigation/NavigationTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Navigation/AllViewsNavigationTests.cs similarity index 64% rename from Tests/UnitTests/View/Navigation/NavigationTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Navigation/AllViewsNavigationTests.cs index 8198b14eb..4549f79e6 100644 --- a/Tests/UnitTests/View/Navigation/NavigationTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Navigation/AllViewsNavigationTests.cs @@ -1,16 +1,16 @@ -using UnitTests; +#nullable enable +using UnitTests; using Xunit.Abstractions; -namespace UnitTests.ViewTests; +namespace ViewBaseTests.Navigation; -public class NavigationTests (ITestOutputHelper output) : TestsAllViews +public class AllViewsNavigationTests (ITestOutputHelper output) : TestsAllViews { [Theory] [MemberData (nameof (AllViewTypes))] - [SetupFakeApplication] // SetupFakeDriver resets app state; helps to avoid test pollution public void AllViews_AtLeastOneNavKey_Advances (Type viewType) { - View view = CreateInstanceIfNotGeneric (viewType); + View? view = CreateInstanceIfNotGeneric (viewType); if (view == null) { @@ -26,9 +26,8 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews return; } - Toplevel top = new (); - Application.Top = top; - Application.Navigation = new (); + IApplication app = Application.Create (); + app.Begin (new Runnable () { CanFocus = true }); View otherView = new () { @@ -37,7 +36,7 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews TabStop = view.TabStop == TabBehavior.NoStop ? TabBehavior.TabStop : view.TabStop }; - top.Add (view, otherView); + app.TopRunnableView!.Add (view, otherView); // Start with the focus on our test view view.SetFocus (); @@ -58,17 +57,17 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews case TabBehavior.TabStop: case TabBehavior.NoStop: case TabBehavior.TabGroup: - Application.RaiseKeyDownEvent (key); + app.Keyboard.RaiseKeyDownEvent (key); if (view.HasFocus) { // Try once more (HexView) - Application.RaiseKeyDownEvent (key); + app.Keyboard.RaiseKeyDownEvent (key); } break; default: - Application.RaiseKeyDownEvent (Key.Tab); + app.Keyboard.RaiseKeyDownEvent (Key.Tab); break; } @@ -84,17 +83,14 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews output.WriteLine ($"{view.GetType ().Name} - {key} did not Leave."); } - top.Dispose (); - Assert.True (left); } [Theory] [MemberData (nameof (AllViewTypes))] - [SetupFakeApplication] // SetupFakeDriver resets app state; helps to avoid test pollution public void AllViews_HasFocus_Changed_Event (Type viewType) { - View view = CreateInstanceIfNotGeneric (viewType); + View? view = CreateInstanceIfNotGeneric (viewType); if (view == null) { @@ -110,16 +106,15 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews return; } - if (view is Toplevel && ((Toplevel)view).Modal) + if (view is IRunnable) { - output.WriteLine ($"Ignoring {viewType} - It's a Modal Toplevel"); + output.WriteLine ($"Ignoring {viewType} - It's an IRunnable"); return; } - Toplevel top = new (); - Application.Top = top; - Application.Navigation = new (); + IApplication app = Application.Create (); + app.Begin (new Runnable () { CanFocus = true }); View otherView = new () { @@ -131,34 +126,38 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews var hasFocusTrue = 0; var hasFocusFalse = 0; - view.HasFocusChanged += (s, e) => - { - if (e.NewValue) - { - hasFocusTrue++; - } - else - { - hasFocusFalse++; - } - }; - - top.Add (view, otherView); - Assert.False (view.HasFocus); - Assert.False (otherView.HasFocus); - // Ensure the view is Visible view.Visible = true; + view.HasFocus = false; - Application.Top.SetFocus (); - Assert.True (Application.Top!.HasFocus); - Assert.True (top.HasFocus); + view.HasFocusChanged += (s, e) => + { + if (e.NewValue) + { + hasFocusTrue++; + } + else + { + hasFocusFalse++; + } + }; - // Start with the focus on our test view - Assert.True (view.HasFocus); + Assert.Equal (0, hasFocusTrue); + Assert.Equal (0, hasFocusFalse); + + app.TopRunnableView!.Add (view, otherView); + Assert.False (view.HasFocus); + Assert.True (otherView.HasFocus); Assert.Equal (1, hasFocusTrue); - Assert.Equal (0, hasFocusFalse); + Assert.Equal (1, hasFocusFalse); + + // Start with the focus on our test view + view.SetFocus (); + Assert.True (view.HasFocus); + + Assert.Equal (2, hasFocusTrue); + Assert.Equal (1, hasFocusFalse); // Use keyboard to navigate to next view (otherView). var tries = 0; @@ -175,21 +174,19 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews case null: case TabBehavior.NoStop: case TabBehavior.TabStop: - if (Application.RaiseKeyDownEvent (Key.Tab)) + if (app.Keyboard.RaiseKeyDownEvent (Key.Tab)) { if (view.HasFocus) { // Try another nav key (e.g. for TextView that eats Tab) - Application.RaiseKeyDownEvent (Key.CursorDown); + app.Keyboard.RaiseKeyDownEvent (Key.CursorDown); } - } - - ; + }; break; case TabBehavior.TabGroup: - Application.RaiseKeyDownEvent (Key.F6); + app.Keyboard.RaiseKeyDownEvent (Key.F6); break; default: @@ -197,8 +194,8 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews } } - Assert.Equal (1, hasFocusTrue); - Assert.Equal (1, hasFocusFalse); + Assert.Equal (2, hasFocusTrue); + Assert.Equal (2, hasFocusFalse); Assert.False (view.HasFocus); Assert.True (otherView.HasFocus); @@ -211,26 +208,26 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews break; case TabBehavior.TabStop: - Application.RaiseKeyDownEvent (Key.Tab); + app.Keyboard.RaiseKeyDownEvent (Key.Tab); break; case TabBehavior.TabGroup: - if (!Application.RaiseKeyDownEvent (Key.F6)) + if (!app.Keyboard.RaiseKeyDownEvent (Key.F6)) { view.SetFocus (); } break; case null: - Application.RaiseKeyDownEvent (Key.Tab); + app.Keyboard.RaiseKeyDownEvent (Key.Tab); break; default: throw new ArgumentOutOfRangeException (); } - Assert.Equal (2, hasFocusTrue); - Assert.Equal (1, hasFocusFalse); + Assert.Equal (3, hasFocusTrue); + Assert.Equal (2, hasFocusFalse); Assert.True (view.HasFocus); Assert.False (otherView.HasFocus); @@ -243,21 +240,18 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews int enterCount = hasFocusTrue; int leaveCount = hasFocusFalse; - top.Dispose (); - Assert.False (otherViewHasFocus); Assert.True (viewHasFocus); - Assert.Equal (2, enterCount); - Assert.Equal (1, leaveCount); + Assert.Equal (3, enterCount); + Assert.Equal (2, leaveCount); } [Theory] [MemberData (nameof (AllViewTypes))] - [SetupFakeApplication] // SetupFakeDriver resets app state; helps to avoid test pollution public void AllViews_Visible_False_No_HasFocus_Events (Type viewType) { - View view = CreateInstanceIfNotGeneric (viewType); + View? view = CreateInstanceIfNotGeneric (viewType); if (view == null) { @@ -273,17 +267,15 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews return; } - if (view is Toplevel && ((Toplevel)view).Modal) + if (view is IRunnable) { - output.WriteLine ($"Ignoring {viewType} - It's a Modal Toplevel"); + output.WriteLine ($"Ignoring {viewType} - It's an IRunnable"); return; } - Toplevel top = new (); - - Application.Top = top; - Application.Navigation = new (); + IApplication? app = Application.Create (); + app.Begin (new Runnable () { CanFocus = true }); View otherView = new () { @@ -298,7 +290,7 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews view.HasFocusChanging += (s, e) => hasFocusChangingCount++; view.HasFocusChanged += (s, e) => hasFocusChangedCount++; - top.Add (view, otherView); + app.TopRunnableView!.Add (view, otherView); // Start with the focus on our test view view.SetFocus (); @@ -306,21 +298,18 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews Assert.Equal (0, hasFocusChangingCount); Assert.Equal (0, hasFocusChangedCount); - Application.RaiseKeyDownEvent (Key.Tab); + app.Keyboard.RaiseKeyDownEvent (Key.Tab); Assert.Equal (0, hasFocusChangingCount); Assert.Equal (0, hasFocusChangedCount); - Application.RaiseKeyDownEvent (Key.F6); + app.Keyboard.RaiseKeyDownEvent (Key.F6); Assert.Equal (0, hasFocusChangingCount); Assert.Equal (0, hasFocusChangedCount); - - top.Dispose (); } [Fact] - [AutoInitShutdown] public void Application_Begin_FocusesDeepest () { var win1 = new Window { Id = "win1", Width = 10, Height = 1 }; @@ -330,12 +319,70 @@ public class NavigationTests (ITestOutputHelper output) : TestsAllViews win2.Add (view2); win1.Add (view1, win2); - Application.Begin (win1); + IApplication app = Application.Create (); + app.Begin (win1); Assert.True (win1.HasFocus); Assert.True (view1.HasFocus); Assert.False (win2.HasFocus); Assert.False (view2.HasFocus); - win1.Dispose (); + } + + // View.Focused & View.MostFocused tests + + // View.Focused - No subviews + [Fact] + public void Focused_NoSubViews () + { + var view = new View (); + Assert.Null (view.Focused); + + view.CanFocus = true; + view.SetFocus (); + } + + [Fact] + public void GetMostFocused_NoSubViews_Returns_Null () + { + var view = new View (); + Assert.Null (view.Focused); + + view.CanFocus = true; + Assert.False (view.HasFocus); + view.SetFocus (); + Assert.True (view.HasFocus); + Assert.Null (view.MostFocused); + } + + [Fact] + public void GetMostFocused_Returns_Most () + { + var view = new View + { + Id = "view", + CanFocus = true + }; + + var subview = new View + { + Id = "subview", + CanFocus = true + }; + + view.Add (subview); + + view.SetFocus (); + Assert.True (view.HasFocus); + Assert.True (subview.HasFocus); + Assert.Equal (subview, view.MostFocused); + + var subview2 = new View + { + Id = "subview2", + CanFocus = true + }; + + view.Add (subview2); + Assert.Equal (subview2, view.MostFocused); } } diff --git a/Tests/UnitTestsParallelizable/View/Navigation/CanFocusTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Navigation/CanFocusTests.cs similarity index 78% rename from Tests/UnitTestsParallelizable/View/Navigation/CanFocusTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Navigation/CanFocusTests.cs index 01b86092e..076908c11 100644 --- a/Tests/UnitTestsParallelizable/View/Navigation/CanFocusTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Navigation/CanFocusTests.cs @@ -1,7 +1,6 @@ using UnitTests; -using Xunit.Abstractions; +namespace ViewBaseTests.Navigation; -namespace UnitTests_Parallelizable.ViewTests; [Collection ("Global Test Setup")] public class CanFocusTests () : TestsAllViews @@ -181,7 +180,7 @@ public class CanFocusTests () : TestsAllViews [Fact] public void CanFocus_Faced_With_Container () { - var t = new Toplevel (); + var t = new Runnable (); var w = new Window (); var f = new FrameView (); var v = new View { CanFocus = true }; @@ -238,4 +237,44 @@ public class CanFocusTests () : TestsAllViews Assert.False (view.HasFocus); } + [Fact] + public void CanFocus_Set_True_Get_AdvanceFocus_Works () + { + IApplication app = Application.Create (); + app.Begin (new Runnable () { CanFocus = true }); + + Label label = new () { Text = "label" }; + View view = new () { Text = "view", CanFocus = true }; + app.TopRunnableView!.Add (label, view); + + app.TopRunnableView.SetFocus (); + Assert.Equal (view, app.Navigation!.GetFocused ()); + Assert.False (label.CanFocus); + Assert.False (label.HasFocus); + Assert.True (view.CanFocus); + Assert.True (view.HasFocus); + + Assert.False (app.Navigation.AdvanceFocus (NavigationDirection.Forward, null)); + Assert.False (label.HasFocus); + Assert.True (view.HasFocus); + + // Set label CanFocus to true + label.CanFocus = true; + Assert.False (label.HasFocus); + Assert.True (view.HasFocus); + + // label can now be focused, so AdvanceFocus should move to it. + Assert.True (app.Navigation.AdvanceFocus (NavigationDirection.Forward, null)); + Assert.True (label.HasFocus); + Assert.False (view.HasFocus); + + // Move back to view + view.SetFocus (); + Assert.False (label.HasFocus); + Assert.True (view.HasFocus); + + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Tab)); + Assert.True (label.HasFocus); + Assert.False (view.HasFocus); + } } diff --git a/Tests/UnitTestsParallelizable/View/Navigation/EnabledTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Navigation/EnabledTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Navigation/EnabledTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Navigation/EnabledTests.cs index 6a31d7f90..b240a3b17 100644 --- a/Tests/UnitTestsParallelizable/View/Navigation/EnabledTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Navigation/EnabledTests.cs @@ -1,6 +1,6 @@ using UnitTests; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests; [Collection ("Global Test Setup")] public class EnabledTests : TestsAllViews diff --git a/Tests/UnitTestsParallelizable/View/Navigation/HasFocusChangeEventTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Navigation/HasFocusChangeEventTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Navigation/HasFocusChangeEventTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Navigation/HasFocusChangeEventTests.cs index ea4fa6064..633dd3ff9 100644 --- a/Tests/UnitTestsParallelizable/View/Navigation/HasFocusChangeEventTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Navigation/HasFocusChangeEventTests.cs @@ -1,7 +1,6 @@ using UnitTests; -using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Navigation; [Collection ("Global Test Setup")] public class HasFocusChangeEventTests () : TestsAllViews diff --git a/Tests/UnitTestsParallelizable/View/Navigation/HasFocusTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Navigation/HasFocusTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Navigation/HasFocusTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Navigation/HasFocusTests.cs index 787bbfe4d..da651aa00 100644 --- a/Tests/UnitTestsParallelizable/View/Navigation/HasFocusTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Navigation/HasFocusTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Navigation; [Collection ("Global Test Setup")] public class HasFocusTests () : TestsAllViews diff --git a/Tests/UnitTestsParallelizable/View/Navigation/RestoreFocusTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Navigation/RestoreFocusTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Navigation/RestoreFocusTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Navigation/RestoreFocusTests.cs index 3fbd165e2..692657890 100644 --- a/Tests/UnitTestsParallelizable/View/Navigation/RestoreFocusTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Navigation/RestoreFocusTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Navigation; [Collection ("Global Test Setup")] public class RestoreFocusTests () : TestsAllViews diff --git a/Tests/UnitTestsParallelizable/View/Navigation/SetFocusTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Navigation/SetFocusTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Navigation/SetFocusTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Navigation/SetFocusTests.cs index 1eb8c6383..f9161c37d 100644 --- a/Tests/UnitTestsParallelizable/View/Navigation/SetFocusTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Navigation/SetFocusTests.cs @@ -1,7 +1,6 @@ using UnitTests; -using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Navigation; [Collection ("Global Test Setup")] public class SetFocusTests () : TestsAllViews diff --git a/Tests/UnitTestsParallelizable/View/Navigation/VisibleTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Navigation/VisibleTests.cs similarity index 99% rename from Tests/UnitTestsParallelizable/View/Navigation/VisibleTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Navigation/VisibleTests.cs index 295cef50e..0c23de343 100644 --- a/Tests/UnitTestsParallelizable/View/Navigation/VisibleTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Navigation/VisibleTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests; [Collection ("Global Test Setup")] public class VisibleTests () : TestsAllViews diff --git a/Tests/UnitTestsParallelizable/View/Orientation/OrientationHelperTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Orientation/OrientationHelperTests.cs similarity index 98% rename from Tests/UnitTestsParallelizable/View/Orientation/OrientationHelperTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Orientation/OrientationHelperTests.cs index dcb32bc12..14a256d9f 100644 --- a/Tests/UnitTestsParallelizable/View/Orientation/OrientationHelperTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Orientation/OrientationHelperTests.cs @@ -1,6 +1,6 @@ using Moq; -namespace UnitTests_Parallelizable.ViewTests.OrientationTests; +namespace ViewBaseTests.OrientationTests; public class OrientationHelperTests { diff --git a/Tests/UnitTestsParallelizable/View/Orientation/OrientationTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Orientation/OrientationTests.cs similarity index 95% rename from Tests/UnitTestsParallelizable/View/Orientation/OrientationTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Orientation/OrientationTests.cs index ec9dbfb9a..c914c6159 100644 --- a/Tests/UnitTestsParallelizable/View/Orientation/OrientationTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Orientation/OrientationTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.ViewTests.OrientationTests; +namespace ViewBaseTests.OrientationTests; public class OrientationTests { @@ -20,8 +20,8 @@ public class OrientationTests set => _orientationHelper.Orientation = value; } - public event EventHandler> OrientationChanging; - public event EventHandler> OrientationChanged; + public event EventHandler>? OrientationChanging; + public event EventHandler>? OrientationChanged; public bool CancelOnOrientationChanging { get; set; } diff --git a/Tests/UnitTestsParallelizable/View/SubviewTests.cs b/Tests/UnitTestsParallelizable/ViewBase/SubviewTests.cs similarity index 96% rename from Tests/UnitTestsParallelizable/View/SubviewTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/SubviewTests.cs index f02650d54..3835dfa88 100644 --- a/Tests/UnitTestsParallelizable/View/SubviewTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/SubviewTests.cs @@ -1,4 +1,4 @@ -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests.Hierarchy; [Collection ("Global Test Setup")] public class SubViewTests @@ -14,11 +14,11 @@ public class SubViewTests super.SuperViewChanged += (s, e) => { - superRaisedCount++; + superRaisedCount++; }; sub.SuperViewChanged += (s, e) => { - if (e.SuperView is {}) + if (e.SuperView is { }) { subRaisedCount++; } @@ -266,14 +266,14 @@ public class SubViewTests superView.Add (subview1, subview2, subview3); superView.MoveSubViewTowardsEnd (subview2); - Assert.Equal (subview2, superView.SubViews.ToArray() [^1]); + Assert.Equal (subview2, superView.SubViews.ToArray () [^1]); superView.MoveSubViewTowardsEnd (subview1); - Assert.Equal (subview1, superView.SubViews.ToArray() [1]); + Assert.Equal (subview1, superView.SubViews.ToArray () [1]); // Already at end, what happens? superView.MoveSubViewTowardsEnd (subview2); - Assert.Equal (subview2, superView.SubViews.ToArray() [^1]); + Assert.Equal (subview2, superView.SubViews.ToArray () [^1]); } [Fact] @@ -423,7 +423,7 @@ public class SubViewTests var tf1 = new TextField (); var w1 = new Window (); w1.Add (fv1, tf1); - var top1 = new Toplevel (); + var top1 = new Runnable (); top1.Add (w1); var v2 = new View (); @@ -432,7 +432,7 @@ public class SubViewTests var tf2 = new TextField (); var w2 = new Window (); w2.Add (fv2, tf2); - var top2 = new Toplevel (); + var top2 = new Runnable (); top2.Add (w2); Assert.Equal (top1, v1.GetTopSuperView ()); @@ -454,7 +454,7 @@ public class SubViewTests [Fact] public void Initialized_Event_Comparing_With_Added_Event () { - var top = new Toplevel { Id = "0" }; // Frame: 0, 0, 80, 25; Viewport: 0, 0, 80, 25 + var top = new Runnable { Id = "0" }; // Frame: 0, 0, 80, 25; Viewport: 0, 0, 80, 25 var winAddedToTop = new Window { @@ -480,25 +480,25 @@ public class SubViewTests winAddedToTop.SubViewAdded += (s, e) => { - Assert.Equal (e.SuperView.Frame.Width, winAddedToTop.Frame.Width); + Assert.Equal (e.SuperView!.Frame.Width, winAddedToTop.Frame.Width); Assert.Equal (e.SuperView.Frame.Height, winAddedToTop.Frame.Height); }; v1AddedToWin.SubViewAdded += (s, e) => { - Assert.Equal (e.SuperView.Frame.Width, v1AddedToWin.Frame.Width); + Assert.Equal (e.SuperView!.Frame.Width, v1AddedToWin.Frame.Width); Assert.Equal (e.SuperView.Frame.Height, v1AddedToWin.Frame.Height); }; v2AddedToWin.SubViewAdded += (s, e) => { - Assert.Equal (e.SuperView.Frame.Width, v2AddedToWin.Frame.Width); + Assert.Equal (e.SuperView!.Frame.Width, v2AddedToWin.Frame.Width); Assert.Equal (e.SuperView.Frame.Height, v2AddedToWin.Frame.Height); }; svAddedTov1.SubViewAdded += (s, e) => { - Assert.Equal (e.SuperView.Frame.Width, svAddedTov1.Frame.Width); + Assert.Equal (e.SuperView!.Frame.Width, svAddedTov1.Frame.Width); Assert.Equal (e.SuperView.Frame.Height, svAddedTov1.Frame.Height); }; @@ -517,7 +517,7 @@ public class SubViewTests Assert.False (v2AddedToWin.CanFocus); Assert.False (svAddedTov1.CanFocus); - Application.LayoutAndDraw (); + top.Layout (); }; winAddedToTop.Initialized += (s, e) => diff --git a/Tests/UnitTestsParallelizable/View/TextTests.cs b/Tests/UnitTestsParallelizable/ViewBase/TextTests.cs similarity index 97% rename from Tests/UnitTestsParallelizable/View/TextTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/TextTests.cs index 110af6302..90c01d7a5 100644 --- a/Tests/UnitTestsParallelizable/View/TextTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/TextTests.cs @@ -2,7 +2,7 @@ using System.Text; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewTests; +namespace ViewBaseTests; /// /// Tests of the and properties. @@ -107,7 +107,7 @@ public class TextTests () Assert.Contains ( typeof (IsExternalInit), typeof (View).GetMethod ("set_TextFormatter") - .ReturnParameter.GetRequiredCustomModifiers ()); + ?.ReturnParameter.GetRequiredCustomModifiers ()!); } // Test that the Text property is set correctly. diff --git a/Tests/UnitTestsParallelizable/View/TitleTests.cs b/Tests/UnitTestsParallelizable/ViewBase/TitleTests.cs similarity index 95% rename from Tests/UnitTestsParallelizable/View/TitleTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/TitleTests.cs index 06dc3a631..b0d368b49 100644 --- a/Tests/UnitTestsParallelizable/View/TitleTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/TitleTests.cs @@ -1,7 +1,8 @@ -using System.Text; -using Xunit.Abstractions; +#nullable disable -namespace UnitTests_Parallelizable.ViewTests; +using System.Text; + +namespace ViewBaseTests; public class TitleTests { diff --git a/Tests/UnitTestsParallelizable/View/ViewCommandTests.cs b/Tests/UnitTestsParallelizable/ViewBase/ViewCommandTests.cs similarity index 96% rename from Tests/UnitTestsParallelizable/View/ViewCommandTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/ViewCommandTests.cs index a571699c4..f358f58ed 100644 --- a/Tests/UnitTestsParallelizable/View/ViewCommandTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/ViewCommandTests.cs @@ -1,4 +1,5 @@ -namespace UnitTests_Parallelizable.ViewTests; + +namespace ViewBaseTests.Commands; public class ViewCommandTests { #region OnAccept/Accept tests @@ -46,7 +47,7 @@ public class ViewCommandTests return; - void ViewOnAccept (object sender, CommandEventArgs e) + void ViewOnAccept (object? sender, CommandEventArgs e) { acceptInvoked = true; e.Handled = true; @@ -66,7 +67,7 @@ public class ViewCommandTests return; - void ViewOnAccept (object sender, CommandEventArgs e) { accepted = true; } + void ViewOnAccept (object? sender, CommandEventArgs e) { accepted = true; } } // Accept on subview should bubble up to parent @@ -177,7 +178,7 @@ public class ViewCommandTests return; - void ViewOnSelect (object sender, CommandEventArgs e) + void ViewOnSelect (object? sender, CommandEventArgs e) { selectingInvoked = true; e.Handled = true; @@ -197,7 +198,7 @@ public class ViewCommandTests return; - void ViewOnSelecting (object sender, CommandEventArgs e) { selecting = true; } + void ViewOnSelecting (object? sender, CommandEventArgs e) { selecting = true; } } [Fact] diff --git a/Tests/UnitTests/View/Viewport/ViewportSettings.TransparentMouseTests.cs b/Tests/UnitTestsParallelizable/ViewBase/Viewport/ViewportSettings.TransparentMouseTests.cs similarity index 79% rename from Tests/UnitTests/View/Viewport/ViewportSettings.TransparentMouseTests.cs rename to Tests/UnitTestsParallelizable/ViewBase/Viewport/ViewportSettings.TransparentMouseTests.cs index 089753bf7..895b91050 100644 --- a/Tests/UnitTests/View/Viewport/ViewportSettings.TransparentMouseTests.cs +++ b/Tests/UnitTestsParallelizable/ViewBase/Viewport/ViewportSettings.TransparentMouseTests.cs @@ -1,6 +1,6 @@ #nullable enable -namespace UnitTests.ViewTests; +namespace ViewBaseTests.Mouse; public class TransparentMouseTests { @@ -19,11 +19,12 @@ public class TransparentMouseTests public void TransparentMouse_Passes_Mouse_Events_To_Underlying_View () { // Arrange - var top = new Toplevel () + IApplication? app = Application.Create (); + var top = new Runnable () { Id = "top", }; - Application.Top = top; + app.Begin (top); var underlying = new MouseTrackingView { Id = "underlying", X = 0, Y = 0, Width = 10, Height = 10 }; var overlay = new MouseTrackingView { Id = "overlay", X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettingsFlags.TransparentMouse }; @@ -31,8 +32,6 @@ public class TransparentMouseTests top.Add (underlying); top.Add (overlay); - top.BeginInit (); - top.EndInit (); top.Layout (); var mouseEvent = new MouseEventArgs @@ -42,21 +41,19 @@ public class TransparentMouseTests }; // Act - Application.RaiseMouseEvent (mouseEvent); + app.Mouse.RaiseMouseEvent (mouseEvent); // Assert Assert.True (underlying.MouseEventReceived); - - top.Dispose (); - Application.ResetState (true); } [Fact] public void NonTransparentMouse_Consumes_Mouse_Events () { // Arrange - var top = new Toplevel (); - Application.Top = top; + IApplication? app = Application.Create (); + var top = new Runnable (); + app.Begin (top); var underlying = new MouseTrackingView { X = 0, Y = 0, Width = 10, Height = 10 }; var overlay = new MouseTrackingView { X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettingsFlags.None }; @@ -64,8 +61,6 @@ public class TransparentMouseTests top.Add (underlying); top.Add (overlay); - top.BeginInit (); - top.EndInit (); top.Layout (); var mouseEvent = new MouseEventArgs @@ -75,22 +70,23 @@ public class TransparentMouseTests }; // Act - Application.RaiseMouseEvent (mouseEvent); + app.Mouse.RaiseMouseEvent (mouseEvent); // Assert Assert.True (overlay.MouseEventReceived); Assert.False (underlying.MouseEventReceived); - - top.Dispose (); - Application.ResetState (true); - } + } [Fact] public void TransparentMouse_Stacked_TransparentMouse_Views () { // Arrange - var top = new Toplevel (); - Application.Top = top; + IApplication? app = Application.Create (); + var top = new Runnable () + { + Id = "top", + }; + app.Begin (top); var underlying = new MouseTrackingView { X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettingsFlags.TransparentMouse }; var overlay = new MouseTrackingView { X = 0, Y = 0, Width = 10, Height = 10, ViewportSettings = ViewportSettingsFlags.TransparentMouse }; @@ -98,8 +94,6 @@ public class TransparentMouseTests top.Add (underlying); top.Add (overlay); - top.BeginInit (); - top.EndInit (); top.Layout (); var mouseEvent = new MouseEventArgs @@ -116,14 +110,11 @@ public class TransparentMouseTests }; // Act - Application.RaiseMouseEvent (mouseEvent); + app.Mouse.RaiseMouseEvent (mouseEvent); // Assert Assert.False (overlay.MouseEventReceived); Assert.False (underlying.MouseEventReceived); Assert.True (topHandled); - - top.Dispose (); - Application.ResetState (true); } } diff --git a/Tests/UnitTestsParallelizable/Views/AllViewsDrawTests.cs b/Tests/UnitTestsParallelizable/Views/AllViewsDrawTests.cs index 35ebdf600..6e59b09df 100644 --- a/Tests/UnitTestsParallelizable/Views/AllViewsDrawTests.cs +++ b/Tests/UnitTestsParallelizable/Views/AllViewsDrawTests.cs @@ -2,7 +2,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; public class AllViewsDrawTests (ITestOutputHelper output) : TestsAllViews { @@ -21,6 +21,7 @@ public class AllViewsDrawTests (ITestOutputHelper output) : TestsAllViews return; } + view.Driver = driver; output.WriteLine ($"Testing {viewType}"); if (view is IDesignable designable) diff --git a/Tests/UnitTestsParallelizable/Views/AllViewsTests.cs b/Tests/UnitTestsParallelizable/Views/AllViewsTests.cs index d9b99f3a7..2aa9a09c0 100644 --- a/Tests/UnitTestsParallelizable/Views/AllViewsTests.cs +++ b/Tests/UnitTestsParallelizable/Views/AllViewsTests.cs @@ -3,7 +3,7 @@ using System.Reflection; using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; public class AllViewsTests (ITestOutputHelper output) : TestsAllViews { diff --git a/Tests/UnitTestsParallelizable/Views/BarTests.cs b/Tests/UnitTestsParallelizable/Views/BarTests.cs index 259c97abd..4c5d2748d 100644 --- a/Tests/UnitTestsParallelizable/Views/BarTests.cs +++ b/Tests/UnitTestsParallelizable/Views/BarTests.cs @@ -1,6 +1,6 @@ using JetBrains.Annotations; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; [TestSubject (typeof (Bar))] public class BarTests @@ -107,7 +107,7 @@ public class BarTests public void GetAttributeForRole_DoesNotDeferToSuperView_WhenSchemeNameIsSet () { // This test would fail before the fix that checks SchemeName in GetAttributeForRole - // StatusBar and MenuBarv2 set SchemeName = "Menu", and should use Menu scheme + // StatusBar and MenuBar set SchemeName = "Menu", and should use Menu scheme // instead of deferring to parent's customized attributes var parentView = new View { SchemeName = "Base" }; diff --git a/Tests/UnitTestsParallelizable/Views/ButtonTests.cs b/Tests/UnitTestsParallelizable/Views/ButtonTests.cs index b2b45dcbe..03b7abc80 100644 --- a/Tests/UnitTestsParallelizable/Views/ButtonTests.cs +++ b/Tests/UnitTestsParallelizable/Views/ButtonTests.cs @@ -1,6 +1,7 @@ +#nullable disable using UnitTests; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; /// /// Pure unit tests for that don't require Application static dependencies. diff --git a/Tests/UnitTestsParallelizable/Views/CheckBoxTests.cs b/Tests/UnitTestsParallelizable/Views/CheckBoxTests.cs index e6721a906..047f2d8db 100644 --- a/Tests/UnitTestsParallelizable/Views/CheckBoxTests.cs +++ b/Tests/UnitTestsParallelizable/Views/CheckBoxTests.cs @@ -1,10 +1,65 @@ -using UnitTests; -using Xunit.Abstractions; +#nullable enable -namespace UnitTests_Parallelizable.ViewsTests; +using System.Collections.ObjectModel; + +namespace ViewsTests; public class CheckBoxTests () { + [Fact] + public void Commands_Select () + { + IApplication app = Application.Create (); + Runnable runnable = new (); + View otherView = new () { CanFocus = true }; + var ckb = new CheckBox (); + runnable.Add (ckb, otherView); + app.Begin (runnable); + ckb.SetFocus (); + Assert.True (ckb.HasFocus); + + var checkedStateChangingCount = 0; + ckb.CheckedStateChanging += (s, e) => checkedStateChangingCount++; + + var selectCount = 0; + ckb.Selecting += (s, e) => selectCount++; + + var acceptCount = 0; + ckb.Accepting += (s, e) => acceptCount++; + + Assert.Equal (CheckState.UnChecked, ckb.CheckedState); + Assert.Equal (0, checkedStateChangingCount); + Assert.Equal (0, selectCount); + Assert.Equal (0, acceptCount); + Assert.Equal (Key.Empty, ckb.HotKey); + + // Test while focused + ckb.Text = "_Test"; + Assert.Equal (Key.T, ckb.HotKey); + ckb.NewKeyDownEvent (Key.T); + Assert.Equal (CheckState.Checked, ckb.CheckedState); + Assert.Equal (1, checkedStateChangingCount); + Assert.Equal (1, selectCount); + Assert.Equal (0, acceptCount); + + ckb.Text = "T_est"; + Assert.Equal (Key.E, ckb.HotKey); + ckb.NewKeyDownEvent (Key.E.WithAlt); + Assert.Equal (2, checkedStateChangingCount); + Assert.Equal (2, selectCount); + Assert.Equal (0, acceptCount); + + ckb.NewKeyDownEvent (Key.Space); + Assert.Equal (3, checkedStateChangingCount); + Assert.Equal (3, selectCount); + Assert.Equal (0, acceptCount); + + ckb.NewKeyDownEvent (Key.Enter); + Assert.Equal (3, checkedStateChangingCount); + Assert.Equal (3, selectCount); + Assert.Equal (1, acceptCount); + } + [Theory] [InlineData ("01234", 0, 0, 0, 0)] [InlineData ("01234", 1, 0, 1, 0)] @@ -153,7 +208,7 @@ public class CheckBoxTests () return; - void ViewOnAccept (object sender, CommandEventArgs e) + void ViewOnAccept (object? sender, CommandEventArgs e) { acceptInvoked = true; e.Handled = true; diff --git a/Tests/UnitTestsParallelizable/Views/ColorPickerTests.cs b/Tests/UnitTestsParallelizable/Views/ColorPickerTests.cs index ce1543202..e90361b94 100644 --- a/Tests/UnitTestsParallelizable/Views/ColorPickerTests.cs +++ b/Tests/UnitTestsParallelizable/Views/ColorPickerTests.cs @@ -1,15 +1,15 @@ -using UnitTests; +#nullable enable -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; /// -/// Pure unit tests for that don't require Application.Driver or View context. -/// These tests can run in parallel without interference. +/// Pure unit tests for that don't require Application.Driver or View context. +/// These tests can run in parallel without interference. /// -public class ColorPickerTests : FakeDriverBase +public class ColorPickerTests { [Fact] - public void ColorPicker_ChangedEvent_Fires () + public void ChangedEvent_Fires () { Color newColor = default; var count = 0; @@ -39,4 +39,840 @@ public class ColorPickerTests : FakeDriverBase // Should have no effect Assert.Equal (2, count); } + + [Fact] + public void ChangeValueOnUI_UpdatesAllUIElements () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, true); + + var otherView = new View { CanFocus = true }; + + cp.App!.TopRunnableView?.Add (otherView); // thi sets focus to otherView + Assert.True (otherView.HasFocus); + + cp.SetFocus (); + Assert.False (otherView.HasFocus); + + cp.Draw (); // Draw is needed to update TrianglePosition + + ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + TextField rTextField = GetTextField (cp, ColorPickerPart.Bar1); + TextField gTextField = GetTextField (cp, ColorPickerPart.Bar2); + TextField bTextField = GetTextField (cp, ColorPickerPart.Bar3); + + Assert.Equal ("R:", r.Text); + Assert.Equal (2, r.TrianglePosition); + Assert.Equal ("0", rTextField.Text); + Assert.Equal ("G:", g.Text); + Assert.Equal (2, g.TrianglePosition); + Assert.Equal ("0", gTextField.Text); + Assert.Equal ("B:", b.Text); + Assert.Equal (2, b.TrianglePosition); + Assert.Equal ("0", bTextField.Text); + Assert.Equal ("#000000", hex.Text); + + // Change value using text field + TextField rBarTextField = cp.SubViews.OfType ().First (tf => tf.Text == "0"); + + rBarTextField.SetFocus (); + rBarTextField.Text = "128"; + + otherView.SetFocus (); + Assert.True (otherView.HasFocus); + + cp.Draw (); // Draw is needed to update TrianglePosition + + Assert.Equal ("R:", r.Text); + Assert.Equal (9, r.TrianglePosition); + Assert.Equal ("128", rTextField.Text); + Assert.Equal ("G:", g.Text); + Assert.Equal (2, g.TrianglePosition); + Assert.Equal ("0", gTextField.Text); + Assert.Equal ("B:", b.Text); + Assert.Equal (2, b.TrianglePosition); + Assert.Equal ("0", bTextField.Text); + Assert.Equal ("#800000", hex.Text); + + cp.App?.Dispose (); + } + + [Fact] + public void ClickingAtEndOfBar_SetsMaxValue () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, false); + + cp.Draw (); // Draw is needed to update TrianglePosition + + // Click at the end of the Red bar + cp.Focused!.RaiseMouseEvent ( + new () + { + Flags = MouseFlags.Button1Pressed, + Position = new (19, 0) // Assuming 0-based indexing + }); + + cp.Draw (); // Draw is needed to update TrianglePosition + + ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + + Assert.Equal ("R:", r.Text); + Assert.Equal (19, r.TrianglePosition); + Assert.Equal ("G:", g.Text); + Assert.Equal (2, g.TrianglePosition); + Assert.Equal ("B:", b.Text); + Assert.Equal (2, b.TrianglePosition); + Assert.Equal ("#FF0000", hex.Text); + + cp.App?.Dispose (); + } + + [Fact] + public void ClickingBeyondBar_ChangesToMaxValue () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, false); + + cp.Draw (); // Draw is needed to update TrianglePosition + + // Click beyond the bar + cp.Focused!.RaiseMouseEvent ( + new () + { + Flags = MouseFlags.Button1Pressed, + Position = new (21, 0) // Beyond the bar + }); + + cp.Draw (); // Draw is needed to update TrianglePosition + + ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + + Assert.Equal ("R:", r.Text); + Assert.Equal (19, r.TrianglePosition); + Assert.Equal ("G:", g.Text); + Assert.Equal (2, g.TrianglePosition); + Assert.Equal ("B:", b.Text); + Assert.Equal (2, b.TrianglePosition); + Assert.Equal ("#FF0000", hex.Text); + + cp.App?.Dispose (); + } + + [Fact] + public void ClickingDifferentBars_ChangesFocus () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, false); + + cp.Draw (); // Draw is needed to update TrianglePosition + + // Click on Green bar + cp.App!.Mouse.RaiseMouseEvent ( + new () + { + Flags = MouseFlags.Button1Pressed, + ScreenPosition = new (0, 1) + }); + + //cp.SubViews.OfType () + // .Single () + // .OnMouseEvent ( + // new () + // { + // Flags = MouseFlags.Button1Pressed, + // Position = new (0, 1) + // }); + + cp.Draw (); // Draw is needed to update TrianglePosition + + Assert.IsAssignableFrom (cp.Focused); + + // Click on Blue bar + cp.App!.Mouse.RaiseMouseEvent ( + new () + { + Flags = MouseFlags.Button1Pressed, + ScreenPosition = new (0, 2) + }); + + //cp.SubViews.OfType () + // .Single () + // .OnMouseEvent ( + // new () + // { + // Flags = MouseFlags.Button1Pressed, + // Position = new (0, 2) + // }); + + cp.Draw (); // Draw is needed to update TrianglePosition + + Assert.IsAssignableFrom (cp.Focused); + + cp.App?.Dispose (); + } + + [Fact] + public void Construct_DefaultValue () + { + ColorPicker cp = GetColorPicker (ColorModel.HSV, false); + + // Should be only a single text field (Hex) because ShowTextFields is false + Assert.Single (cp.SubViews.OfType ()); + + cp.Draw (); // Draw is needed to update TrianglePosition + + // All bars should be at 0 with the triangle at 0 (+2 because of "H:", "S:" etc) + ColorBar h = GetColorBar (cp, ColorPickerPart.Bar1); + Assert.Equal ("H:", h.Text); + Assert.Equal (2, h.TrianglePosition); + Assert.IsType (h); + + ColorBar s = GetColorBar (cp, ColorPickerPart.Bar2); + Assert.Equal ("S:", s.Text); + Assert.Equal (2, s.TrianglePosition); + Assert.IsType (s); + + ColorBar v = GetColorBar (cp, ColorPickerPart.Bar3); + Assert.Equal ("V:", v.Text); + Assert.Equal (2, v.TrianglePosition); + Assert.IsType (v); + + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + Assert.Equal ("#000000", hex.Text); + + cp.App?.Dispose (); + } + + [Fact] + public void DisposesOldViews_OnModelChange () + { + ColorPicker cp = GetColorPicker (ColorModel.HSL, true); + + ColorBar b1 = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar b2 = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b3 = GetColorBar (cp, ColorPickerPart.Bar3); + + TextField tf1 = GetTextField (cp, ColorPickerPart.Bar1); + TextField tf2 = GetTextField (cp, ColorPickerPart.Bar2); + TextField tf3 = GetTextField (cp, ColorPickerPart.Bar3); + + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + +#if DEBUG_IDISPOSABLE + Assert.All (new View [] { b1, b2, b3, tf1, tf2, tf3, hex }, b => Assert.False (b.WasDisposed)); +#endif + cp.Style.ColorModel = ColorModel.RGB; + cp.ApplyStyleChanges (); + + ColorBar b1After = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar b2After = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b3After = GetColorBar (cp, ColorPickerPart.Bar3); + + TextField tf1After = GetTextField (cp, ColorPickerPart.Bar1); + TextField tf2After = GetTextField (cp, ColorPickerPart.Bar2); + TextField tf3After = GetTextField (cp, ColorPickerPart.Bar3); + + TextField hexAfter = GetTextField (cp, ColorPickerPart.Hex); + + // Old bars should be disposed +#if DEBUG_IDISPOSABLE + Assert.All (new View [] { b1, b2, b3, tf1, tf2, tf3, hex }, b => Assert.True (b.WasDisposed)); +#endif + Assert.NotSame (hex, hexAfter); + + Assert.NotSame (b1, b1After); + Assert.NotSame (b2, b2After); + Assert.NotSame (b3, b3After); + + Assert.NotSame (tf1, tf1After); + Assert.NotSame (tf2, tf2After); + Assert.NotSame (tf3, tf3After); + + cp.App?.Dispose (); + } + + [Fact] + public void EnterHexFor_ColorName () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, true, true); + + cp.Draw (); // Draw is needed to update TrianglePosition + + TextField name = GetTextField (cp, ColorPickerPart.ColorName); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + + hex.SetFocus (); + + Assert.True (hex.HasFocus); + Assert.Same (hex, cp.Focused); + + hex.Text = ""; + name.Text = ""; + + Assert.Empty (hex.Text); + Assert.Empty (name.Text); + + cp.App!.Keyboard.RaiseKeyDownEvent ('#'); + Assert.Empty (name.Text); + + //7FFFD4 + + Assert.Equal ("#", hex.Text); + cp.App!.Keyboard.RaiseKeyDownEvent ('7'); + cp.App!.Keyboard.RaiseKeyDownEvent ('F'); + cp.App!.Keyboard.RaiseKeyDownEvent ('F'); + cp.App!.Keyboard.RaiseKeyDownEvent ('F'); + cp.App!.Keyboard.RaiseKeyDownEvent ('D'); + Assert.Empty (name.Text); + + cp.App!.Keyboard.RaiseKeyDownEvent ('4'); + + Assert.True (hex.HasFocus); + + // Tab out of the hex field - should wrap to first focusable subview + cp.App!.Keyboard.RaiseKeyDownEvent (Key.Tab); + Assert.False (hex.HasFocus); + Assert.NotSame (hex, cp.Focused); + + // Color name should be recognised as a known string and populated + Assert.Equal ("#7FFFD4", hex.Text); + Assert.Equal ("Aquamarine", name.Text); + + cp.App?.Dispose (); + } + + /// + /// In this version we use the Enter button to accept the typed text instead + /// of tabbing to the next view. + /// + [Fact] + public void EnterHexFor_ColorName_AcceptVariation () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, true, true); + + cp.Draw (); // Draw is needed to update TrianglePosition + + TextField name = GetTextField (cp, ColorPickerPart.ColorName); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + + hex.SetFocus (); + + Assert.True (hex.HasFocus); + Assert.Same (hex, cp.Focused); + + hex.Text = ""; + name.Text = ""; + + Assert.Empty (hex.Text); + Assert.Empty (name.Text); + + cp.App!.Keyboard.RaiseKeyDownEvent ('#'); + Assert.Empty (name.Text); + + //7FFFD4 + + Assert.Equal ("#", hex.Text); + cp.App!.Keyboard.RaiseKeyDownEvent ('7'); + cp.App!.Keyboard.RaiseKeyDownEvent ('F'); + cp.App!.Keyboard.RaiseKeyDownEvent ('F'); + cp.App!.Keyboard.RaiseKeyDownEvent ('F'); + cp.App!.Keyboard.RaiseKeyDownEvent ('D'); + Assert.Empty (name.Text); + + cp.App!.Keyboard.RaiseKeyDownEvent ('4'); + + Assert.True (hex.HasFocus); + + // Should stay in the hex field (because accept not tab) + cp.App!.Keyboard.RaiseKeyDownEvent (Key.Enter); + Assert.True (hex.HasFocus); + Assert.Same (hex, cp.Focused); + + // But still, Color name should be recognised as a known string and populated + Assert.Equal ("#7FFFD4", hex.Text); + Assert.Equal ("Aquamarine", name.Text); + + cp.App?.Dispose (); + } + + [Fact] + public void InvalidHexInput_DoesNotChangeColor () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, true); + + cp.Draw (); // Draw is needed to update TrianglePosition + + // Enter invalid hex value + TextField hexField = cp.SubViews.OfType ().First (tf => tf.Text == "#000000"); + hexField.SetFocus (); + hexField.Text = "#ZZZZZZ"; + Assert.True (hexField.HasFocus); + Assert.Equal ("#ZZZZZZ", hexField.Text); + + ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + + Assert.Equal ("#ZZZZZZ", hex.Text); + + // Advance away from hexField to cause validation + cp.AdvanceFocus (NavigationDirection.Forward, null); + + cp.Draw (); // Draw is needed to update TrianglePosition + + Assert.Equal ("R:", r.Text); + Assert.Equal (2, r.TrianglePosition); + Assert.Equal ("G:", g.Text); + Assert.Equal (2, g.TrianglePosition); + Assert.Equal ("B:", b.Text); + Assert.Equal (2, b.TrianglePosition); + Assert.Equal ("#000000", hex.Text); + + cp.App?.Dispose (); + } + + [Fact] + public void RGB_KeyboardNavigation () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, false); + cp.Draw (); // Draw is needed to update TrianglePosition + + ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + + Assert.Equal ("R:", r.Text); + Assert.Equal (2, r.TrianglePosition); + Assert.IsType (r); + Assert.Equal ("G:", g.Text); + Assert.Equal (2, g.TrianglePosition); + Assert.IsType (g); + Assert.Equal ("B:", b.Text); + Assert.Equal (2, b.TrianglePosition); + Assert.IsType (b); + Assert.Equal ("#000000", hex.Text); + + Assert.IsAssignableFrom (cp.Focused); + + cp.Draw (); // Draw is needed to update TrianglePosition + + cp.App!.Keyboard.RaiseKeyDownEvent (Key.CursorRight); + + cp.Draw (); // Draw is needed to update TrianglePosition + + Assert.Equal (3, r.TrianglePosition); + Assert.Equal ("#0F0000", hex.Text); + + cp.App!.Keyboard.RaiseKeyDownEvent (Key.CursorRight); + + cp.Draw (); // Draw is needed to update TrianglePosition + + Assert.Equal (4, r.TrianglePosition); + Assert.Equal ("#1E0000", hex.Text); + + // Use cursor to move the triangle all the way to the right + for (var i = 0; i < 1000; i++) + { + cp.App!.Keyboard.RaiseKeyDownEvent (Key.CursorRight); + } + + cp.Draw (); // Draw is needed to update TrianglePosition + + // 20 width and TrianglePosition is 0 indexed + // Meaning we are asserting that triangle is at end + Assert.Equal (19, r.TrianglePosition); + Assert.Equal ("#FF0000", hex.Text); + + cp.App?.Dispose (); + } + + [Fact] + public void RGB_MouseNavigation () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, false); + + cp.Draw (); // Draw is needed to update TrianglePosition + + ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + + Assert.Equal ("R:", r.Text); + Assert.Equal (2, r.TrianglePosition); + Assert.IsType (r); + Assert.Equal ("G:", g.Text); + Assert.Equal (2, g.TrianglePosition); + Assert.IsType (g); + Assert.Equal ("B:", b.Text); + Assert.Equal (2, b.TrianglePosition); + Assert.IsType (b); + Assert.Equal ("#000000", hex.Text); + + Assert.IsAssignableFrom (cp.Focused); + + cp.Focused!.RaiseMouseEvent ( + new () + { + Flags = MouseFlags.Button1Pressed, + Position = new (3, 0) + }); + + cp.Draw (); // Draw is needed to update TrianglePosition + + Assert.Equal (3, r.TrianglePosition); + Assert.Equal ("#0F0000", hex.Text); + + cp.Focused.RaiseMouseEvent ( + new () + { + Flags = MouseFlags.Button1Pressed, + Position = new (4, 0) + }); + + cp.Draw (); // Draw is needed to update TrianglePosition + + Assert.Equal (4, r.TrianglePosition); + Assert.Equal ("#1E0000", hex.Text); + + cp.App?.Dispose (); + } + + [Theory] + [MemberData (nameof (ColorPickerTestData))] + public void RGB_NoText ( + Color c, + string expectedR, + int expectedRTriangle, + string expectedG, + int expectedGTriangle, + string expectedB, + int expectedBTriangle, + string expectedHex + ) + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, false); + cp.SelectedColor = c; + + cp.Draw (); // Draw is needed to update TrianglePosition + + ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + + Assert.Equal (expectedR, r.Text); + Assert.Equal (expectedRTriangle, r.TrianglePosition); + Assert.Equal (expectedG, g.Text); + Assert.Equal (expectedGTriangle, g.TrianglePosition); + Assert.Equal (expectedB, b.Text); + Assert.Equal (expectedBTriangle, b.TrianglePosition); + Assert.Equal (expectedHex, hex.Text); + + cp.App?.Dispose (); + } + + [Theory] + [MemberData (nameof (ColorPickerTestData_WithTextFields))] + public void RGB_NoText_WithTextFields ( + Color c, + string expectedR, + int expectedRTriangle, + int expectedRValue, + string expectedG, + int expectedGTriangle, + int expectedGValue, + string expectedB, + int expectedBTriangle, + int expectedBValue, + string expectedHex + ) + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, true); + cp.SelectedColor = c; + + cp.Draw (); // Draw is needed to update TrianglePosition + + ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + TextField rTextField = GetTextField (cp, ColorPickerPart.Bar1); + TextField gTextField = GetTextField (cp, ColorPickerPart.Bar2); + TextField bTextField = GetTextField (cp, ColorPickerPart.Bar3); + + Assert.Equal (expectedR, r.Text); + Assert.Equal (expectedRTriangle, r.TrianglePosition); + Assert.Equal (expectedRValue.ToString (), rTextField.Text); + Assert.Equal (expectedG, g.Text); + Assert.Equal (expectedGTriangle, g.TrianglePosition); + Assert.Equal (expectedGValue.ToString (), gTextField.Text); + Assert.Equal (expectedB, b.Text); + Assert.Equal (expectedBTriangle, b.TrianglePosition); + Assert.Equal (expectedBValue.ToString (), bTextField.Text); + Assert.Equal (expectedHex, hex.Text); + + cp.App?.Dispose (); + } + + [Fact] + public void SwitchingColorModels_ResetsBars () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, false); + cp.SelectedColor = new (255, 0); + + cp.Draw (); // Draw is needed to update TrianglePosition + + ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + + Assert.Equal ("R:", r.Text); + Assert.Equal (19, r.TrianglePosition); + Assert.Equal ("G:", g.Text); + Assert.Equal (2, g.TrianglePosition); + Assert.Equal ("B:", b.Text); + Assert.Equal (2, b.TrianglePosition); + Assert.Equal ("#FF0000", hex.Text); + + // Switch to HSV + cp.Style.ColorModel = ColorModel.HSV; + cp.ApplyStyleChanges (); + + cp.Draw (); // Draw is needed to update TrianglePosition + + ColorBar h = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar s = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar v = GetColorBar (cp, ColorPickerPart.Bar3); + + Assert.Equal ("H:", h.Text); + Assert.Equal (2, h.TrianglePosition); + Assert.Equal ("S:", s.Text); + Assert.Equal (19, s.TrianglePosition); + Assert.Equal ("V:", v.Text); + Assert.Equal (19, v.TrianglePosition); + Assert.Equal ("#FF0000", hex.Text); + + cp.App?.Dispose (); + } + + [Fact] + public void SyncBetweenTextFieldAndBars () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, true); + + cp.Draw (); // Draw is needed to update TrianglePosition + + // Change value using the bar + RBar rBar = cp.SubViews.OfType ().First (); + rBar.Value = 128; + + cp.Draw (); // Draw is needed to update TrianglePosition + + ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + TextField rTextField = GetTextField (cp, ColorPickerPart.Bar1); + TextField gTextField = GetTextField (cp, ColorPickerPart.Bar2); + TextField bTextField = GetTextField (cp, ColorPickerPart.Bar3); + + Assert.Equal ("R:", r.Text); + Assert.Equal (9, r.TrianglePosition); + Assert.Equal ("128", rTextField.Text); + Assert.Equal ("G:", g.Text); + Assert.Equal (2, g.TrianglePosition); + Assert.Equal ("0", gTextField.Text); + Assert.Equal ("B:", b.Text); + Assert.Equal (2, b.TrianglePosition); + Assert.Equal ("0", bTextField.Text); + Assert.Equal ("#800000", hex.Text); + + cp.App?.Dispose (); + } + + [Fact] + public void TabCompleteColorName () + { + ColorPicker cp = GetColorPicker (ColorModel.RGB, true, true); + + cp.Draw (); // Draw is needed to update TrianglePosition + + ColorBar r = GetColorBar (cp, ColorPickerPart.Bar1); + ColorBar g = GetColorBar (cp, ColorPickerPart.Bar2); + ColorBar b = GetColorBar (cp, ColorPickerPart.Bar3); + TextField name = GetTextField (cp, ColorPickerPart.ColorName); + TextField hex = GetTextField (cp, ColorPickerPart.Hex); + + name.SetFocus (); + + Assert.True (name.HasFocus); + Assert.Same (name, cp.Focused); + + name.Text = ""; + Assert.Empty (name.Text); + + cp.App!.Keyboard.RaiseKeyDownEvent (Key.A); + cp.App!.Keyboard.RaiseKeyDownEvent (Key.Q); + + Assert.Equal ("aq", name.Text); + + // Auto complete the color name + cp.App!.Keyboard.RaiseKeyDownEvent (Key.Tab); + + // Match cyan alternative name + Assert.Equal ("Aqua", name.Text); + + Assert.True (name.HasFocus); + + cp.App!.Keyboard.RaiseKeyDownEvent (Key.Tab); + + // Resolves to cyan color + Assert.Equal ("Aqua", name.Text); + + // Tab out of the text field + cp.App!.Keyboard.RaiseKeyDownEvent (Key.Tab); + + Assert.False (name.HasFocus); + Assert.NotSame (name, cp.Focused); + + Assert.Equal ("#00FFFF", hex.Text); + + cp.App?.Dispose (); + } + + public static IEnumerable ColorPickerTestData () + { + yield return + [ + new Color (255, 0), + "R:", 19, "G:", 2, "B:", 2, "#FF0000" + ]; + + yield return + [ + new Color (0, 255), + "R:", 2, "G:", 19, "B:", 2, "#00FF00" + ]; + + yield return + [ + new Color (0, 0, 255), + "R:", 2, "G:", 2, "B:", 19, "#0000FF" + ]; + + yield return + [ + new Color (125, 125, 125), + "R:", 11, "G:", 11, "B:", 11, "#7D7D7D" + ]; + } + + public static IEnumerable ColorPickerTestData_WithTextFields () + { + yield return + [ + new Color (255, 0), + "R:", 15, 255, "G:", 2, 0, "B:", 2, 0, "#FF0000" + ]; + + yield return + [ + new Color (0, 255), + "R:", 2, 0, "G:", 15, 255, "B:", 2, 0, "#00FF00" + ]; + + yield return + [ + new Color (0, 0, 255), + "R:", 2, 0, "G:", 2, 0, "B:", 15, 255, "#0000FF" + ]; + + yield return + [ + new Color (125, 125, 125), + "R:", 9, 125, "G:", 9, 125, "B:", 9, 125, "#7D7D7D" + ]; + } + + private ColorBar GetColorBar (ColorPicker cp, ColorPickerPart toGet) + { + if (toGet <= ColorPickerPart.Bar3) + { + return cp.SubViews.OfType ().ElementAt ((int)toGet); + } + + throw new NotSupportedException ("ColorPickerPart must be a bar"); + } + + private static ColorPicker GetColorPicker (ColorModel colorModel, bool showTextFields, bool showName = false) + { + IApplication? app = Application.Create (); + app.Init ("Fake"); + + var cp = new ColorPicker { Width = 20, SelectedColor = new (0, 0) }; + cp.Style.ColorModel = colorModel; + cp.Style.ShowTextFields = showTextFields; + cp.Style.ShowColorName = showName; + cp.ApplyStyleChanges (); + Runnable? runnable = new () { Width = 20, Height = 5 }; + app.Begin (runnable); + runnable.Add (cp); + + app.LayoutAndDraw (); + + return cp; + } + + private TextField GetTextField (ColorPicker cp, ColorPickerPart toGet) + { + bool hasBarValueTextFields = cp.Style.ShowTextFields; + bool hasColorNameTextField = cp.Style.ShowColorName; + + switch (toGet) + { + case ColorPickerPart.Bar1: + case ColorPickerPart.Bar2: + case ColorPickerPart.Bar3: + if (!hasBarValueTextFields) + { + throw new NotSupportedException ("Corresponding Style option is not enabled"); + } + + return cp.SubViews.OfType ().ElementAt ((int)toGet); + case ColorPickerPart.ColorName: + if (!hasColorNameTextField) + { + throw new NotSupportedException ("Corresponding Style option is not enabled"); + } + + return cp.SubViews.OfType ().ElementAt (hasBarValueTextFields ? (int)toGet : (int)toGet - 3); + case ColorPickerPart.Hex: + + int offset = hasBarValueTextFields ? 0 : 3; + offset += hasColorNameTextField ? 0 : 1; + + return cp.SubViews.OfType ().ElementAt ((int)toGet - offset); + default: + throw new ArgumentOutOfRangeException (nameof (toGet), toGet, null); + } + } + + private enum ColorPickerPart + { + Bar1 = 0, + Bar2 = 1, + Bar3 = 2, + ColorName = 3, + Hex = 4 + } } diff --git a/Tests/UnitTests/Views/DateFieldTests.cs b/Tests/UnitTestsParallelizable/Views/DateFieldTests.cs similarity index 92% rename from Tests/UnitTests/Views/DateFieldTests.cs rename to Tests/UnitTestsParallelizable/Views/DateFieldTests.cs index c4e310fbd..2c6fa4c4f 100644 --- a/Tests/UnitTests/Views/DateFieldTests.cs +++ b/Tests/UnitTestsParallelizable/Views/DateFieldTests.cs @@ -1,8 +1,9 @@ #nullable enable using System.Globalization; using System.Runtime.InteropServices; +using UnitTests_Parallelizable; -namespace UnitTests.ViewsTests; +namespace ViewsTests; public class DateFieldTests { @@ -35,25 +36,34 @@ public class DateFieldTests [Fact] [TestDate] - [SetupFakeApplication] public void Copy_Paste () { - var df1 = new DateField (DateTime.Parse ("12/12/1971")); - var df2 = new DateField (DateTime.Parse ("12/31/2023")); + IApplication app = Application.Create(); + app.Init("fake"); - // Select all text - Assert.True (df2.NewKeyDownEvent (Key.End.WithShift)); - Assert.Equal (1, df2.SelectedStart); - Assert.Equal (10, df2.SelectedLength); - Assert.Equal (11, df2.CursorPosition); + try + { + var df1 = new DateField (DateTime.Parse ("12/12/1971")) { App = app }; + var df2 = new DateField (DateTime.Parse ("12/31/2023")) { App = app }; - // Copy from df2 - Assert.True (df2.NewKeyDownEvent (Key.C.WithCtrl)); + // Select all text + Assert.True (df2.NewKeyDownEvent (Key.End.WithShift)); + Assert.Equal (1, df2.SelectedStart); + Assert.Equal (10, df2.SelectedLength); + Assert.Equal (11, df2.CursorPosition); - // Paste into df1 - Assert.True (df1.NewKeyDownEvent (Key.V.WithCtrl)); - Assert.Equal (" 12/31/2023", df1.Text); - Assert.Equal (11, df1.CursorPosition); + // Copy from df2 + Assert.True (df2.NewKeyDownEvent (Key.C.WithCtrl)); + + // Paste into df1 + Assert.True (df1.NewKeyDownEvent (Key.V.WithCtrl)); + Assert.Equal (" 12/31/2023", df1.Text); + Assert.Equal (11, df1.CursorPosition); + } + finally + { + app.Dispose (); + } } [Fact] diff --git a/Tests/UnitTestsParallelizable/Views/DatePickerTests.cs b/Tests/UnitTestsParallelizable/Views/DatePickerTests.cs index 4ffc18b56..5b33256c4 100644 --- a/Tests/UnitTestsParallelizable/Views/DatePickerTests.cs +++ b/Tests/UnitTestsParallelizable/Views/DatePickerTests.cs @@ -1,7 +1,7 @@ using System.Globalization; using UnitTests; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; /// /// Pure unit tests for that don't require Application.Driver or View context. diff --git a/Tests/UnitTestsParallelizable/Views/FlagSelectorTests.cs b/Tests/UnitTestsParallelizable/Views/FlagSelectorTests.cs index 5e9de8fcc..80e83b66a 100644 --- a/Tests/UnitTestsParallelizable/Views/FlagSelectorTests.cs +++ b/Tests/UnitTestsParallelizable/Views/FlagSelectorTests.cs @@ -1,5 +1,5 @@ #nullable enable -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; public class FlagSelectorTests { diff --git a/Tests/UnitTests/Views/HexViewTests.cs b/Tests/UnitTestsParallelizable/Views/HexViewTests.cs similarity index 67% rename from Tests/UnitTests/Views/HexViewTests.cs rename to Tests/UnitTestsParallelizable/Views/HexViewTests.cs index 83d661f6f..87c401d69 100644 --- a/Tests/UnitTests/Views/HexViewTests.cs +++ b/Tests/UnitTestsParallelizable/Views/HexViewTests.cs @@ -1,10 +1,10 @@ #nullable enable using System.Text; -using JetBrains.Annotations; +using UnitTests; -namespace UnitTests.ViewsTests; +namespace ViewsTests; -public class HexViewTests +public class HexViewTests : FakeDriverBase { [Theory] [InlineData (0, 4)] @@ -32,35 +32,36 @@ public class HexViewTests public void ReadOnly_Prevents_Edits () { var hv = new HexView (LoadStream (null, out _, true)) { Width = 20, Height = 20 }; - Application.Navigation = new ApplicationNavigation (); - Application.Top = new Toplevel (); - Application.Top.Add (hv); - Application.Top.SetFocus (); + + IApplication app = Application.Create (); + Runnable runnable = new (); + app.Begin (runnable); + runnable.Add (hv); // Needed because HexView relies on LayoutComplete to calc sizes hv.LayoutSubViews (); - Assert.True (Application.RaiseKeyDownEvent (Key.Tab)); // Move to left side + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Tab)); // Move to left side Assert.Empty (hv.Edits); hv.ReadOnly = true; - Assert.True (Application.RaiseKeyDownEvent (Key.Home)); - Assert.False (Application.RaiseKeyDownEvent (Key.A)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Home)); + Assert.False (app.Keyboard.RaiseKeyDownEvent (Key.A)); Assert.Empty (hv.Edits); Assert.Equal (126, hv.Source!.Length); hv.ReadOnly = false; - Assert.True (Application.RaiseKeyDownEvent (Key.D4)); - Assert.True (Application.RaiseKeyDownEvent (Key.D1)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.D4)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.D1)); Assert.Single (hv.Edits); Assert.Equal (65, hv.Edits.ToList () [0].Value); Assert.Equal ('A', (char)hv.Edits.ToList () [0].Value); Assert.Equal (126, hv.Source.Length); // Appends byte - Assert.True (Application.RaiseKeyDownEvent (Key.End)); - Assert.True (Application.RaiseKeyDownEvent (Key.D4)); - Assert.True (Application.RaiseKeyDownEvent (Key.D2)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.End)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.D4)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.D2)); Assert.Equal (2, hv.Edits.Count); Assert.Equal (66, hv.Edits.ToList () [1].Value); Assert.Equal ('B', (char)hv.Edits.ToList () [1].Value); @@ -69,16 +70,14 @@ public class HexViewTests hv.ApplyEdits (); Assert.Empty (hv.Edits); Assert.Equal (127, hv.Source.Length); - - Application.Top.Dispose (); - Application.ResetState (true); } [Fact] public void ApplyEdits_With_Argument () { - Application.Navigation = new ApplicationNavigation (); - Application.Top = new Toplevel (); + IApplication app = Application.Create (); + Runnable runnable = new (); + app.Begin (runnable); byte [] buffer = Encoding.Default.GetBytes ("Fest"); var original = new MemoryStream (); @@ -89,8 +88,7 @@ public class HexViewTests original.CopyTo (copy); copy.Flush (); var hv = new HexView (copy) { Width = Dim.Fill (), Height = Dim.Fill () }; - Application.Top.Add (hv); - Application.Top.SetFocus (); + runnable.Add (hv); // Needed because HexView relies on LayoutComplete to calc sizes hv.LayoutSubViews (); @@ -100,15 +98,15 @@ public class HexViewTests hv.Source.Read (readBuffer); Assert.Equal ("Fest", Encoding.Default.GetString (readBuffer)); - Assert.True (Application.RaiseKeyDownEvent (Key.Tab)); // Move to left side - Assert.True (Application.RaiseKeyDownEvent (Key.D5)); - Assert.True (Application.RaiseKeyDownEvent (Key.D4)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Tab)); // Move to left side + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.D5)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.D4)); readBuffer [hv.Edits.ToList () [0].Key] = hv.Edits.ToList () [0].Value; Assert.Equal ("Test", Encoding.Default.GetString (readBuffer)); - Assert.True (Application.RaiseKeyDownEvent (Key.Tab)); // Move to right side - Assert.True (Application.RaiseKeyDownEvent (Key.CursorLeft)); - Assert.True (Application.RaiseKeyDownEvent (Key.Z.WithShift)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Tab)); // Move to right side + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorLeft)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Z.WithShift)); readBuffer [hv.Edits.ToList () [0].Key] = hv.Edits.ToList () [0].Value; Assert.Equal ("Zest", Encoding.Default.GetString (readBuffer)); @@ -121,8 +119,6 @@ public class HexViewTests Assert.Equal ("Zest", Encoding.Default.GetString (readBuffer)); Assert.Equal (Encoding.Default.GetString (buffer), Encoding.Default.GetString (readBuffer)); - Application.Top.Dispose (); - Application.ResetState (true); } [Fact] @@ -144,76 +140,73 @@ public class HexViewTests [Fact] public void Position_Encoding_Default () { - Application.Navigation = new ApplicationNavigation (); - var hv = new HexView (LoadStream (null, out _)) { Width = 100, Height = 100 }; - Application.Top = new Toplevel (); - Application.Top.Add (hv); - Application.Top.LayoutSubViews (); + IApplication app = Application.Create (); + Runnable runnable = new (); + app.Begin (runnable); + runnable.Add (hv); Assert.Equal (63, hv.Source!.Length); Assert.Equal (20, hv.BytesPerLine); Assert.Equal (new (0, 0), hv.GetPosition (hv.Address)); - Assert.True (Application.RaiseKeyDownEvent (Key.Tab)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Tab)); Assert.Equal (new (0, 0), hv.GetPosition (hv.Address)); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorRight.WithCtrl)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorRight.WithCtrl)); Assert.Equal (hv.BytesPerLine - 1, hv.GetPosition (hv.Address).X); - Assert.True (Application.RaiseKeyDownEvent (Key.Home)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Home)); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorRight)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorRight)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorRight)); Assert.Equal (new (1, 0), hv.GetPosition (hv.Address)); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorDown)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorDown)); Assert.Equal (new (1, 1), hv.GetPosition (hv.Address)); - Assert.True (Application.RaiseKeyDownEvent (Key.End)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.End)); Assert.Equal (new (3, 3), hv.GetPosition (hv.Address)); Assert.Equal (hv.Source!.Length, hv.Address); - Application.Top.Dispose (); - Application.ResetState (true); } [Fact] public void Position_Encoding_Unicode () { - Application.Navigation = new ApplicationNavigation (); + var hv = new HexView (LoadStream (null, out _, true)) { Width = 100, Height = 100 }; + IApplication app = Application.Create (); + Runnable runnable = new (); + app.Begin (runnable); + runnable.Add (hv); - var hv = new HexView (LoadStream (null, out _, unicode: true)) { Width = 100, Height = 100 }; - Application.Top = new Toplevel (); - Application.Top.Add (hv); - - hv.LayoutSubViews (); + app.LayoutAndDraw (); Assert.Equal (126, hv.Source!.Length); Assert.Equal (20, hv.BytesPerLine); Assert.Equal (new (0, 0), hv.GetPosition (hv.Address)); - Assert.True (Application.RaiseKeyDownEvent (Key.Tab)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Tab)); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorRight.WithCtrl)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorRight.WithCtrl)); Assert.Equal (hv.BytesPerLine - 1, hv.GetPosition (hv.Address).X); - Assert.True (Application.RaiseKeyDownEvent (Key.Home)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Home)); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorRight)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorRight)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorRight)); Assert.Equal (new (1, 0), hv.GetPosition (hv.Address)); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorDown)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorDown)); Assert.Equal (new (1, 1), hv.GetPosition (hv.Address)); - Assert.True (Application.RaiseKeyDownEvent (Key.End)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.End)); Assert.Equal (new (6, 6), hv.GetPosition (hv.Address)); Assert.Equal (hv.Source!.Length, hv.Address); - Application.Top.Dispose (); - Application.ResetState (true); } [Fact] @@ -264,69 +257,67 @@ public class HexViewTests [Fact] public void KeyBindings_Test_Movement_LeftSide () { - Application.Navigation = new ApplicationNavigation (); - Application.Top = new Toplevel (); var hv = new HexView (LoadStream (null, out _)) { Width = 20, Height = 10 }; - Application.Top.Add (hv); - hv.LayoutSubViews (); + IApplication app = Application.Create (); + Runnable runnable = new (); + app.Begin (runnable); + runnable.Add (hv); + app.LayoutAndDraw (); Assert.Equal (MEM_STRING_LENGTH, hv.Source!.Length); Assert.Equal (0, hv.Address); Assert.Equal (4, hv.BytesPerLine); // Default internal focus is on right side. Move back to left. - Assert.True (Application.RaiseKeyDownEvent (Key.Tab.WithShift)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Tab.WithShift)); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorRight)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorRight)); + Assert.Equal (0, hv.Address); + + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorRight)); Assert.Equal (1, hv.Address); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorLeft)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorLeft)); Assert.Equal (0, hv.Address); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorDown)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorDown)); Assert.Equal (4, hv.Address); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorUp)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorUp)); Assert.Equal (0, hv.Address); - Assert.True (Application.RaiseKeyDownEvent (Key.PageDown)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.PageDown)); Assert.Equal (40, hv.Address); - Assert.True (Application.RaiseKeyDownEvent (Key.PageUp)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.PageUp)); Assert.Equal (0, hv.Address); - Assert.True (Application.RaiseKeyDownEvent (Key.End)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.End)); Assert.Equal (MEM_STRING_LENGTH, hv.Address); - Assert.True (Application.RaiseKeyDownEvent (Key.Home)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.Home)); Assert.Equal (0, hv.Address); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorRight.WithCtrl)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorRight.WithCtrl)); Assert.Equal (3, hv.Address); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorLeft.WithCtrl)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorLeft.WithCtrl)); Assert.Equal (0, hv.Address); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorDown.WithCtrl)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorDown.WithCtrl)); Assert.Equal (36, hv.Address); - Assert.True (Application.RaiseKeyDownEvent (Key.CursorUp.WithCtrl)); + Assert.True (app.Keyboard.RaiseKeyDownEvent (Key.CursorUp.WithCtrl)); Assert.Equal (0, hv.Address); - Application.Top.Dispose (); - Application.ResetState (true); } [Fact] public void PositionChanged_Event () { - Application.Navigation = new ApplicationNavigation (); var hv = new HexView (LoadStream (null, out _)) { Width = 20, Height = 10 }; - Application.Top = new Toplevel (); - Application.Top.Add (hv); - - Application.Top.LayoutSubViews (); + hv.Layout (); HexViewEventArgs hexViewEventArgs = null!; hv.PositionChanged += (s, e) => hexViewEventArgs = e; @@ -339,42 +330,38 @@ public class HexViewTests Assert.Equal (4, hexViewEventArgs.BytesPerLine); Assert.Equal (new (1, 1), hexViewEventArgs.Position); Assert.Equal (5, hexViewEventArgs.Address); - Application.Top.Dispose (); - Application.ResetState (true); } [Fact] public void Source_Sets_Address_To_Zero_If_Greater_Than_Source_Length () { - Application.Navigation = new ApplicationNavigation (); var hv = new HexView (LoadStream (null, out _)) { Width = 10, Height = 5 }; - Application.Top = new Toplevel (); - Application.Top.Add (hv); - Application.Top.Layout (); + IApplication app = Application.Create (); + Runnable runnable = new (); + app.Begin (runnable); + runnable.Add (hv); Assert.True (hv.NewKeyDownEvent (Key.End)); Assert.Equal (MEM_STRING_LENGTH, hv.Address); hv.Source = new MemoryStream (); - Application.Top.Layout (); + runnable.Layout (); Assert.Equal (0, hv.Address); hv.Source = LoadStream (null, out _); hv.Width = Dim.Fill (); hv.Height = Dim.Fill (); - Application.Top.Layout (); + runnable.Layout (); Assert.Equal (0, hv.Address); Assert.True (hv.NewKeyDownEvent (Key.End)); Assert.Equal (MEM_STRING_LENGTH, hv.Address); hv.Source = new MemoryStream (); - Application.Top.Layout (); + runnable.Layout (); Assert.Equal (0, hv.Address); - Application.Top.Dispose (); - Application.ResetState (true); } private const string MEM_STRING = "Hello world.\nThis is a test of the Emergency Broadcast System.\n"; @@ -400,6 +387,7 @@ public class HexViewTests { bArray = Encoding.Default.GetBytes (memString); } + numBytesInMemString = bArray.Length; stream.Write (bArray); @@ -421,8 +409,8 @@ public class HexViewTests } public override void Flush () { baseStream.Flush (); } - public override int Read (byte [] buffer, int offset, int count) { return baseStream.Read (buffer, offset, count); } - public override long Seek (long offset, SeekOrigin origin) { throw new NotImplementedException (); } + public override int Read (byte [] buffer, int offset, int count) => baseStream.Read (buffer, offset, count); + public override long Seek (long offset, SeekOrigin origin) => throw new NotImplementedException (); public override void SetLength (long value) { throw new NotSupportedException (); } public override void Write (byte [] buffer, int offset, int count) { baseStream.Write (buffer, offset, count); } } diff --git a/Tests/UnitTestsParallelizable/Views/IListDataSourceTests.cs b/Tests/UnitTestsParallelizable/Views/IListDataSourceTests.cs new file mode 100644 index 000000000..0fd14354e --- /dev/null +++ b/Tests/UnitTestsParallelizable/Views/IListDataSourceTests.cs @@ -0,0 +1,513 @@ +#nullable enable +using System.Collections; +using System.Collections.ObjectModel; +using System.Collections.Specialized; +using System.Text; +using Xunit.Abstractions; + +// ReSharper disable InconsistentNaming + +namespace ViewsTests; + +public class IListDataSourceTests (ITestOutputHelper output) +{ + private readonly ITestOutputHelper _output = output; + + #region Concurrent Modification Tests + + [Fact] + public void ListWrapper_SuspendAndModify_NoEventsUntilResume () + { + ObservableCollection source = ["Item1"]; + ListWrapper wrapper = new (source); + var eventCount = 0; + + wrapper.CollectionChanged += (s, e) => eventCount++; + + wrapper.SuspendCollectionChangedEvent = true; + + source.Add ("Item2"); + source.Add ("Item3"); + source.RemoveAt (0); + + Assert.Equal (0, eventCount); + + wrapper.SuspendCollectionChangedEvent = false; + + // Should have adjusted marks for the removals that happened while suspended + Assert.Equal (2, wrapper.Count); + } + + #endregion + + /// + /// Test implementation of IListDataSource for testing custom implementations + /// + private class TestListDataSource : IListDataSource + { + private readonly List _items = ["Custom Item 00", "Custom Item 01", "Custom Item 02"]; + private readonly BitArray _marks = new (3); + + public event NotifyCollectionChangedEventHandler? CollectionChanged; + + public int Count => _items.Count; + + public int Length => _items.Any () ? _items.Max (s => s?.Length ?? 0) : 0; + + public bool SuspendCollectionChangedEvent { get; set; } + + public bool IsMarked (int item) + { + if (item < 0 || item >= _items.Count) + { + return false; + } + + return _marks [item]; + } + + public void SetMark (int item, bool value) + { + if (item >= 0 && item < _items.Count) + { + _marks [item] = value; + } + } + + public void Render (Terminal.Gui.Views.ListView listView, bool selected, int item, int col, int line, int width, int viewportX = 0) + { + if (item < 0 || item >= _items.Count) + { + return; + } + + listView.Move (col, line); + string text = _items [item] ?? ""; + + if (viewportX < text.Length) + { + text = text.Substring (viewportX); + } + else + { + text = ""; + } + + if (text.Length > width) + { + text = text.Substring (0, width); + } + + listView.AddStr (text); + + // Fill remaining width + for (int i = text.Length; i < width; i++) + { + listView.AddRune ((Rune)' '); + } + } + + public IList ToList () { return _items; } + + public void Dispose () { IsDisposed = true; } + + public void AddItem (string item) + { + _items.Add (item); + + // Resize marks + var newMarks = new BitArray (_items.Count); + + for (var i = 0; i < Math.Min (_marks.Length, newMarks.Length); i++) + { + newMarks [i] = _marks [i]; + } + + if (!SuspendCollectionChangedEvent) + { + CollectionChanged?.Invoke (this, new (NotifyCollectionChangedAction.Add, item, _items.Count - 1)); + } + } + + public bool IsDisposed { get; private set; } + } + + #region ListWrapper Render Tests + + [Fact] + public void ListWrapper_Render_NullItem_RendersEmpty () + { + ObservableCollection source = [null, "Item2"]; + ListWrapper wrapper = new (source); + var listView = new ListView { Width = 20, Height = 2 }; + listView.BeginInit (); + listView.EndInit (); + + // Render the null item (index 0) + wrapper.Render (listView, false, 0, 0, 0, 20); + + // Should not throw and should render empty/spaces + Assert.Equal (2, wrapper.Count); + } + + [Fact] + public void ListWrapper_Render_EmptyString_RendersSpaces () + { + ObservableCollection source = [""]; + ListWrapper wrapper = new (source); + var listView = new ListView { Width = 20, Height = 1 }; + listView.BeginInit (); + listView.EndInit (); + + wrapper.Render (listView, false, 0, 0, 0, 20); + + Assert.Equal (1, wrapper.Count); + Assert.Equal (0, wrapper.Length); // Empty string has zero length + } + + [Fact] + public void ListWrapper_Render_UnicodeText_CalculatesWidthCorrectly () + { + ObservableCollection source = ["Hello 你好", "Test"]; + ListWrapper wrapper = new (source); + + // "Hello 你好" should be: "Hello " (6) + "你" (2) + "好" (2) = 10 columns + Assert.True (wrapper.Length >= 10); + } + + [Fact] + public void ListWrapper_Render_LongString_ClipsToWidth () + { + var longString = new string ('X', 100); + ObservableCollection source = [longString]; + ListWrapper wrapper = new (source); + var listView = new ListView { Width = 20, Height = 1 }; + listView.BeginInit (); + listView.EndInit (); + + wrapper.Render (listView, false, 0, 0, 0, 10); + + Assert.Equal (100, wrapper.Length); + } + + [Fact] + public void ListWrapper_Render_WithViewportX_ScrollsHorizontally () + { + ObservableCollection source = ["0123456789ABCDEF"]; + ListWrapper wrapper = new (source); + var listView = new ListView { Width = 10, Height = 1 }; + listView.BeginInit (); + listView.EndInit (); + + // Render with horizontal scroll offset of 5 + wrapper.Render (listView, false, 0, 0, 0, 10, 5); + + // Should render "56789ABCDE" (starting at position 5) + Assert.Equal (16, wrapper.Length); + } + + [Fact] + public void ListWrapper_Render_ViewportXBeyondLength_RendersEmpty () + { + ObservableCollection source = ["Short"]; + ListWrapper wrapper = new (source); + var listView = new ListView { Width = 20, Height = 1 }; + listView.BeginInit (); + listView.EndInit (); + + // Render with viewport beyond string length + wrapper.Render (listView, false, 0, 0, 0, 10, 100); + + Assert.Equal (5, wrapper.Length); + } + + [Fact] + public void ListWrapper_Render_ColAndLine_PositionsCorrectly () + { + ObservableCollection source = ["Item1", "Item2"]; + ListWrapper wrapper = new (source); + var listView = new ListView { Width = 20, Height = 5 }; + listView.BeginInit (); + listView.EndInit (); + + // Render at different positions + wrapper.Render (listView, false, 0, 2, 1, 10); // col=2, line=1 + wrapper.Render (listView, false, 1, 0, 3, 10); // col=0, line=3 + + Assert.Equal (2, wrapper.Count); + } + + [Fact] + public void ListWrapper_Render_WidthConstraint_FillsRemaining () + { + ObservableCollection source = ["Hi"]; + ListWrapper wrapper = new (source); + var listView = new ListView { Width = 20, Height = 1 }; + listView.BeginInit (); + listView.EndInit (); + + // Render "Hi" in width of 10 - should fill remaining 8 with spaces + wrapper.Render (listView, false, 0, 0, 0, 10); + + Assert.Equal (2, wrapper.Length); + } + + [Fact] + public void ListWrapper_Render_NonStringType_UsesToString () + { + ObservableCollection source = [42, 100, -5]; + ListWrapper wrapper = new (source); + var listView = new ListView { Width = 20, Height = 3 }; + listView.BeginInit (); + listView.EndInit (); + + wrapper.Render (listView, false, 0, 0, 0, 10); + wrapper.Render (listView, false, 1, 0, 1, 10); + wrapper.Render (listView, false, 2, 0, 2, 10); + + Assert.Equal (3, wrapper.Count); + Assert.True (wrapper.Length >= 2); // "42" is 2 chars, "100" is 3 chars + } + + #endregion + + #region Custom IListDataSource Implementation Tests + + [Fact] + public void CustomDataSource_AllMembers_WorkCorrectly () + { + var customSource = new TestListDataSource (); + var listView = new ListView { Source = customSource, Width = 20, Height = 5 }; + + Assert.Equal (3, customSource.Count); + Assert.Equal (14, customSource.Length); // "Custom Item 00" is 14 chars + + // Test marking + Assert.False (customSource.IsMarked (0)); + customSource.SetMark (0, true); + Assert.True (customSource.IsMarked (0)); + customSource.SetMark (0, false); + Assert.False (customSource.IsMarked (0)); + + // Test ToList + IList list = customSource.ToList (); + Assert.Equal (3, list.Count); + Assert.Equal ("Custom Item 00", list [0]); + + // Test render doesn't throw + listView.BeginInit (); + listView.EndInit (); + Exception ex = Record.Exception (() => customSource.Render (listView, false, 0, 0, 0, 20)); + Assert.Null (ex); + } + + [Fact] + public void CustomDataSource_CollectionChanged_RaisedOnModification () + { + var customSource = new TestListDataSource (); + var eventRaised = false; + NotifyCollectionChangedAction? action = null; + + customSource.CollectionChanged += (s, e) => + { + eventRaised = true; + action = e.Action; + }; + + customSource.AddItem ("New Item"); + + Assert.True (eventRaised); + Assert.Equal (NotifyCollectionChangedAction.Add, action); + Assert.Equal (4, customSource.Count); + } + + [Fact] + public void CustomDataSource_SuspendCollectionChanged_SuppressesEvents () + { + var customSource = new TestListDataSource (); + var eventCount = 0; + + customSource.CollectionChanged += (s, e) => eventCount++; + + customSource.SuspendCollectionChangedEvent = true; + customSource.AddItem ("Item 1"); + customSource.AddItem ("Item 2"); + Assert.Equal (0, eventCount); // No events raised + + customSource.SuspendCollectionChangedEvent = false; + customSource.AddItem ("Item 3"); + Assert.Equal (1, eventCount); // Event raised after resume + } + + [Fact] + public void CustomDataSource_Dispose_CleansUp () + { + var customSource = new TestListDataSource (); + + customSource.Dispose (); + + // After dispose, adding should not raise events (if implemented correctly) + customSource.AddItem ("New Item"); + + // The test source doesn't unsubscribe in dispose, but this shows the pattern + Assert.True (customSource.IsDisposed); + } + + #endregion + + #region Edge Cases + + [Fact] + public void ListWrapper_EmptyCollection_PropertiesReturnZero () + { + ObservableCollection source = []; + ListWrapper wrapper = new (source); + + Assert.Equal (0, wrapper.Count); + Assert.Equal (0, wrapper.Length); + } + + [Fact] + public void ListWrapper_NullSource_HandledGracefully () + { + ListWrapper wrapper = new (null); + + Assert.Equal (0, wrapper.Count); + Assert.Equal (0, wrapper.Length); + + // ToList should not throw + IList list = wrapper.ToList (); + Assert.Empty (list); + } + + [Fact] + public void ListWrapper_IsMarked_OutOfBounds_ReturnsFalse () + { + ObservableCollection source = ["Item1"]; + ListWrapper wrapper = new (source); + + Assert.False (wrapper.IsMarked (-1)); + Assert.False (wrapper.IsMarked (1)); + Assert.False (wrapper.IsMarked (100)); + } + + [Fact] + public void ListWrapper_SetMark_OutOfBounds_DoesNotThrow () + { + ObservableCollection source = ["Item1"]; + ListWrapper wrapper = new (source); + + Exception ex = Record.Exception (() => wrapper.SetMark (-1, true)); + Assert.Null (ex); + + ex = Record.Exception (() => wrapper.SetMark (100, true)); + Assert.Null (ex); + } + + [Fact] + public void ListWrapper_CollectionShrinks_MarksAdjusted () + { + ObservableCollection source = ["Item1", "Item2", "Item3"]; + ListWrapper wrapper = new (source); + + wrapper.SetMark (0, true); + wrapper.SetMark (2, true); + + Assert.True (wrapper.IsMarked (0)); + Assert.True (wrapper.IsMarked (2)); + + // Remove item 1 (middle item) + source.RemoveAt (1); + + Assert.Equal (2, wrapper.Count); + Assert.True (wrapper.IsMarked (0)); // Still marked + + // Item that was at index 2 is now at index 1 + } + + [Fact] + public void ListWrapper_CollectionGrows_MarksPreserved () + { + ObservableCollection source = ["Item1"]; + ListWrapper wrapper = new (source); + + wrapper.SetMark (0, true); + Assert.True (wrapper.IsMarked (0)); + + source.Add ("Item2"); + source.Add ("Item3"); + + Assert.Equal (3, wrapper.Count); + Assert.True (wrapper.IsMarked (0)); // Original mark preserved + Assert.False (wrapper.IsMarked (1)); + Assert.False (wrapper.IsMarked (2)); + } + + [Fact] + public void ListWrapper_StartsWith_EmptyString_ReturnsFirst () + { + ObservableCollection source = ["Apple", "Banana", "Cherry"]; + ListWrapper wrapper = new (source); + + // Searching for empty string might return -1 or 0 depending on implementation + int result = wrapper.StartsWith (""); + Assert.True (result == -1 || result == 0); + } + + [Fact] + public void ListWrapper_StartsWith_NoMatch_ReturnsNegative () + { + ObservableCollection source = ["Apple", "Banana", "Cherry"]; + ListWrapper wrapper = new (source); + + int result = wrapper.StartsWith ("Zebra"); + Assert.Equal (-1, result); + } + + [Fact] + public void ListWrapper_StartsWith_CaseInsensitive () + { + ObservableCollection source = ["Apple", "Banana", "Cherry"]; + ListWrapper wrapper = new (source); + + Assert.Equal (0, wrapper.StartsWith ("app")); + Assert.Equal (0, wrapper.StartsWith ("APP")); + Assert.Equal (1, wrapper.StartsWith ("ban")); + Assert.Equal (1, wrapper.StartsWith ("BAN")); + } + + [Fact] + public void ListWrapper_MaxLength_UpdatesOnCollectionChange () + { + ObservableCollection source = ["Hi"]; + ListWrapper wrapper = new (source); + + Assert.Equal (2, wrapper.Length); + + source.Add ("Very Long String Indeed"); + Assert.Equal (23, wrapper.Length); + + source.Clear (); + source.Add ("X"); + Assert.Equal (1, wrapper.Length); + } + + [Fact] + public void ListWrapper_Dispose_UnsubscribesFromCollectionChanged () + { + ObservableCollection source = ["Item1"]; + ListWrapper wrapper = new (source); + + wrapper.CollectionChanged += (s, e) => { }; + + wrapper.Dispose (); + + // After dispose, source changes should not raise wrapper events + source.Add ("Item2"); + + // The wrapper's event might still fire, but the wrapper won't propagate source events + // This depends on implementation + } + + #endregion +} diff --git a/Tests/UnitTestsParallelizable/Views/LabelTests.cs b/Tests/UnitTestsParallelizable/Views/LabelTests.cs index a3730a1a1..eb1493632 100644 --- a/Tests/UnitTestsParallelizable/Views/LabelTests.cs +++ b/Tests/UnitTestsParallelizable/Views/LabelTests.cs @@ -1,12 +1,14 @@ +#nullable enable using UnitTests; +using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; /// /// Pure unit tests for that don't require Application.Driver or Application context. /// These tests can run in parallel without interference. /// -public class LabelTests : FakeDriverBase +public class LabelTests (ITestOutputHelper output) : FakeDriverBase { [Fact] public void Text_Mirrors_Title () @@ -88,7 +90,7 @@ public class LabelTests : FakeDriverBase return; - void LabelOnAccept (object sender, CommandEventArgs e) { accepted = true; } + void LabelOnAccept (object? sender, CommandEventArgs e) { accepted = true; } } [Fact] @@ -154,4 +156,206 @@ public class LabelTests : FakeDriverBase Assert.Equal ("Test", label.Text); } + + [Fact] + public void CanFocus_False_HotKey_SetsFocus_Next () + { + View otherView = new () + { + Text = "otherView", + CanFocus = true + }; + + Label label = new () + { + Text = "_label" + }; + + View nextView = new () + { + Text = "nextView", + CanFocus = true + }; + + IApplication app = Application.Create (); + Runnable runnable = new (); + app.Begin (runnable); + runnable.Add (otherView, label, nextView); + otherView.SetFocus (); + + // runnable.SetFocus (); + Assert.True (otherView.HasFocus); + + Assert.True (app.Keyboard.RaiseKeyDownEvent (label.HotKey)); + Assert.False (otherView.HasFocus); + Assert.False (label.HasFocus); + Assert.True (nextView.HasFocus); + } + + [Fact] + public void CanFocus_False_MouseClick_SetsFocus_Next () + { + View otherView = new () { X = 0, Y = 0, Width = 1, Height = 1, Id = "otherView", CanFocus = true }; + Label label = new () { X = 0, Y = 1, Text = "_label" }; + View nextView = new () + { + X = Pos.Right (label), Y = Pos.Top (label), Width = 1, Height = 1, Id = "nextView", CanFocus = true + }; + + IApplication app = Application.Create (); + Runnable runnable = new (); + app.Begin (runnable); + runnable.Add (otherView, label, nextView); + otherView.SetFocus (); + + // click on label + app.Mouse.RaiseMouseEvent (new () { ScreenPosition = label.Frame.Location, Flags = MouseFlags.Button1Clicked }); + Assert.False (label.HasFocus); + Assert.True (nextView.HasFocus); + } + + + [Fact] + public void CanFocus_True_HotKey_SetsFocus () + { + Label label = new () + { + Text = "_label", + CanFocus = true + }; + + View view = new () + { + Text = "view", + CanFocus = true + }; + + IApplication app = Application.Create (); + Runnable runnable = new (); + app.Begin (runnable); + runnable.Add (label, view); + + view.SetFocus (); + Assert.True (label.CanFocus); + Assert.False (label.HasFocus); + Assert.True (view.CanFocus); + Assert.True (view.HasFocus); + + // No focused view accepts Tab, and there's no other view to focus, so OnKeyDown returns false + Assert.True (app.Keyboard.RaiseKeyDownEvent (label.HotKey)); + Assert.True (label.HasFocus); + Assert.False (view.HasFocus); + } + + + + [Fact] + public void CanFocus_True_MouseClick_Focuses () + { + Label label = new () + { + Text = "label", + X = 0, + Y = 0, + CanFocus = true + }; + + View otherView = new () + { + Text = "view", + X = 0, + Y = 1, + Width = 4, + Height = 1, + CanFocus = true + }; + + IApplication app = Application.Create (); + Runnable runnable = new () + { + Width = 10, + Height = 10 + }; ; + app.Begin (runnable); + runnable.Add (label, otherView); + label.SetFocus (); + + Assert.True (label.CanFocus); + Assert.True (label.HasFocus); + Assert.True (otherView.CanFocus); + Assert.False (otherView.HasFocus); + + otherView.SetFocus (); + Assert.True (otherView.HasFocus); + + // label can focus, so clicking on it set focus + app.Mouse.RaiseMouseEvent (new () { ScreenPosition = new (0, 0), Flags = MouseFlags.Button1Clicked }); + Assert.True (label.HasFocus); + Assert.False (otherView.HasFocus); + + // click on view + app.Mouse.RaiseMouseEvent (new () { ScreenPosition = new (0, 1), Flags = MouseFlags.Button1Clicked }); + Assert.False (label.HasFocus); + Assert.True (otherView.HasFocus); + } + + + [Fact] + public void With_Top_Margin_Without_Top_Border () + { + IApplication app = Application.Create (); + app.Init ("Fake"); + Runnable runnable = new () + { + Width = 10, + Height = 10 + }; ; + app.Begin (runnable); + + var label = new Label { Text = "Test", /*Width = 6, Height = 3,*/ BorderStyle = LineStyle.Single }; + label.Margin!.Thickness = new (0, 1, 0, 0); + label.Border!.Thickness = new (1, 0, 1, 1); + runnable.Add (label); + app.LayoutAndDraw (); + + Assert.Equal (new (0, 0, 6, 3), label.Frame); + Assert.Equal (new (0, 0, 4, 1), label.Viewport); + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +│Test│ +└────┘", + output, + app.Driver + ); + } + + [Fact] + public void Without_Top_Border () + { + IApplication app = Application.Create (); + app.Init ("Fake"); + Runnable runnable = new () + { + Width = 10, + Height = 10 + }; ; + app.Begin (runnable); + + var label = new Label { Text = "Test", /* Width = 6, Height = 3, */BorderStyle = LineStyle.Single }; + label.Border!.Thickness = new (1, 0, 1, 1); + runnable.Add (label); + app.LayoutAndDraw (); + + Assert.Equal (new (0, 0, 6, 2), label.Frame); + Assert.Equal (new (0, 0, 4, 1), label.Viewport); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +│Test│ +└────┘", + output, + app.Driver + ); + } + } diff --git a/Tests/UnitTestsParallelizable/Views/LineTests.cs b/Tests/UnitTestsParallelizable/Views/LineTests.cs index 8fa44f4a1..c3f58138a 100644 --- a/Tests/UnitTestsParallelizable/Views/LineTests.cs +++ b/Tests/UnitTestsParallelizable/Views/LineTests.cs @@ -1,6 +1,8 @@ -namespace UnitTests_Parallelizable.ViewsTests; +using UnitTests; -public class LineTests +namespace ViewsTests; + +public class LineTests : FakeDriverBase { [Fact] public void Line_DefaultConstructor_Horizontal () @@ -87,7 +89,7 @@ public class LineTests [Fact] public void Line_DrawsCalled_Successfully () { - var app = new Window (); + var app = new Window () { Driver = CreateFakeDriver () }; var line = new Line { Y = 1, Width = 10 }; app.Add (line); @@ -103,7 +105,7 @@ public class LineTests [Fact] public void Line_WithBorder_DrawsSuccessfully () { - var app = new Window { Width = 20, Height = 10, BorderStyle = LineStyle.Single }; + var app = new Window { Driver = CreateFakeDriver (), Width = 20, Height = 10, BorderStyle = LineStyle.Single }; // Add a line that intersects with the window border var line = new Line { X = 5, Y = 0, Height = Dim.Fill (), Orientation = Orientation.Vertical }; @@ -121,7 +123,7 @@ public class LineTests [Fact] public void Line_MultipleIntersecting_DrawsSuccessfully () { - var app = new Window { Width = 30, Height = 15 }; + var app = new Window { Driver = CreateFakeDriver (), Width = 30, Height = 15 }; // Create intersecting lines var hLine = new Line { X = 5, Y = 5, Width = 15, Style = LineStyle.Single }; @@ -258,7 +260,7 @@ public class LineTests // Test: new Line { Height = 9, Orientation = Orientation.Vertical } // Expected: Width=1, Height=9 - line = new() { Height = 9, Orientation = Orientation.Vertical }; + line = new () { Height = 9, Orientation = Orientation.Vertical }; Assert.Equal (1, line.Width.GetAnchor (0)); Assert.Equal (9, line.Height.GetAnchor (0)); diff --git a/Tests/UnitTestsParallelizable/Views/ListViewTests.cs b/Tests/UnitTestsParallelizable/Views/ListViewTests.cs index 9b942d681..90ab19d41 100644 --- a/Tests/UnitTestsParallelizable/Views/ListViewTests.cs +++ b/Tests/UnitTestsParallelizable/Views/ListViewTests.cs @@ -1,32 +1,90 @@ -using System.Collections.ObjectModel; +#nullable enable +using System.Collections; +using System.Collections.ObjectModel; +using System.Collections.Specialized; +using System.Text; using Moq; +using Terminal.Gui; +using UnitTests; +using Xunit; +using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewsTests; +// ReSharper disable AccessToModifiedClosure -public class ListViewTests +namespace ViewsTests; + +public class ListViewTests (ITestOutputHelper output) { + private readonly ITestOutputHelper _output = output; + [Fact] + public void CollectionNavigatorMatcher_KeybindingsOverrideNavigator () + { + ObservableCollection source = ["apricot", "arm", "bat", "batman", "bates hotel", "candle"]; + var lv = new ListView { Source = new ListWrapper (source) }; + + lv.SetFocus (); + + lv.KeyBindings.Add (Key.B, Command.Down); + + Assert.Null (lv.SelectedItem); + + // Keys should be consumed to move down the navigation i.e. to apricot + Assert.True (lv.NewKeyDownEvent (Key.B)); + Assert.Equal (0, lv.SelectedItem); + + Assert.True (lv.NewKeyDownEvent (Key.B)); + Assert.Equal (1, lv.SelectedItem); + + // There is no keybinding for Key.C so it hits collection navigator i.e. we jump to candle + Assert.True (lv.NewKeyDownEvent (Key.C)); + Assert.Equal (5, lv.SelectedItem); + } + + [Fact] + public void ListView_CollectionNavigatorMatcher_KeybindingsOverrideNavigator () + { + ObservableCollection source = ["apricot", "arm", "bat", "batman", "bates hotel", "candle"]; + var lv = new ListView { Source = new ListWrapper (source) }; + + lv.SetFocus (); + + lv.KeyBindings.Add (Key.B, Command.Down); + + Assert.Null (lv.SelectedItem); + + // Keys should be consumed to move down the navigation i.e. to apricot + Assert.True (lv.NewKeyDownEvent (Key.B)); + Assert.Equal (0, lv.SelectedItem); + + Assert.True (lv.NewKeyDownEvent (Key.B)); + Assert.Equal (1, lv.SelectedItem); + + // There is no keybinding for Key.C so it hits collection navigator i.e. we jump to candle + Assert.True (lv.NewKeyDownEvent (Key.C)); + Assert.Equal (5, lv.SelectedItem); + } + [Fact] public void ListViewCollectionNavigatorMatcher_DefaultBehaviour () { - ObservableCollection source = new () { "apricot", "arm", "bat", "batman", "bates hotel", "candle" }; - ListView lv = new ListView { Source = new ListWrapper (source) }; + ObservableCollection source = ["apricot", "arm", "bat", "batman", "bates hotel", "candle"]; + var lv = new ListView { Source = new ListWrapper (source) }; // Keys are consumed during navigation Assert.True (lv.NewKeyDownEvent (Key.B)); Assert.True (lv.NewKeyDownEvent (Key.A)); Assert.True (lv.NewKeyDownEvent (Key.T)); - Assert.Equal ("bat", (string)lv.Source.ToList () [lv.SelectedItem]); + Assert.Equal ("bat", (string)lv.Source.ToList () [lv.SelectedItem!.Value]!); } [Fact] public void ListViewCollectionNavigatorMatcher_IgnoreKeys () { - ObservableCollection source = new () { "apricot", "arm", "bat", "batman", "bates hotel", "candle" }; - ListView lv = new ListView { Source = new ListWrapper (source) }; + ObservableCollection source = ["apricot", "arm", "bat", "batman", "bates hotel", "candle"]; + var lv = new ListView { Source = new ListWrapper (source) }; - - var matchNone = new Mock (); + Mock matchNone = new (); matchNone.Setup (m => m.IsCompatibleKey (It.IsAny ())) .Returns (false); @@ -45,11 +103,10 @@ public class ListViewTests [Fact] public void ListViewCollectionNavigatorMatcher_OverrideMatching () { - ObservableCollection source = new () { "apricot", "arm", "bat", "batman", "bates hotel", "candle" }; - ListView lv = new ListView { Source = new ListWrapper (source) }; + ObservableCollection source = ["apricot", "arm", "bat", "batman", "bates hotel", "candle"]; + var lv = new ListView { Source = new ListWrapper (source) }; - - var matchNone = new Mock (); + Mock matchNone = new (); matchNone.Setup (m => m.IsCompatibleKey (It.IsAny ())) .Returns (true); @@ -59,6 +116,7 @@ public class ListViewTests .Returns ((string s, object key) => s.StartsWith ('B') && key?.ToString () == "candle"); lv.KeystrokeNavigator.Matcher = matchNone.Object; + // Keys are consumed during navigation Assert.True (lv.NewKeyDownEvent (Key.B)); Assert.Equal (5, lv.SelectedItem); @@ -67,54 +125,1466 @@ public class ListViewTests Assert.True (lv.NewKeyDownEvent (Key.T)); Assert.Equal (5, lv.SelectedItem); - Assert.Equal ("candle", (string)lv.Source.ToList () [lv.SelectedItem]); + Assert.Equal ("candle", (string)lv.Source.ToList () [lv.SelectedItem!.Value]!); + } + + #region ListView Tests (from ListViewTests.cs - parallelizable) + + [Fact] + public void Constructors_Defaults () + { + var lv = new ListView (); + Assert.Null (lv.Source); + Assert.True (lv.CanFocus); + Assert.Null (lv.SelectedItem); + Assert.False (lv.AllowsMultipleSelection); + + lv = new () { Source = new ListWrapper (["One", "Two", "Three"]) }; + Assert.NotNull (lv.Source); + Assert.Null (lv.SelectedItem); + + lv = new () { Source = new NewListDataSource () }; + Assert.NotNull (lv.Source); + Assert.Null (lv.SelectedItem); + + lv = new () + { + Y = 1, Width = 10, Height = 20, Source = new ListWrapper (["One", "Two", "Three"]) + }; + Assert.NotNull (lv.Source); + Assert.Null (lv.SelectedItem); + Assert.Equal (new (0, 1, 10, 20), lv.Frame); + + lv = new () { Y = 1, Width = 10, Height = 20, Source = new NewListDataSource () }; + Assert.NotNull (lv.Source); + Assert.Null (lv.SelectedItem); + Assert.Equal (new (0, 1, 10, 20), lv.Frame); + } + + private class NewListDataSource : IListDataSource + { +#pragma warning disable CS0067 + public event NotifyCollectionChangedEventHandler? CollectionChanged; +#pragma warning restore CS0067 + + public int Count => 0; + public int Length => 0; + + public bool SuspendCollectionChangedEvent + { + get => throw new NotImplementedException (); + set => throw new NotImplementedException (); + } + + public bool IsMarked (int item) { throw new NotImplementedException (); } + + public void Render ( + ListView container, + bool selected, + int item, + int col, + int line, + int width, + int viewportX = 0 + ) + { + throw new NotImplementedException (); + } + + public void SetMark (int item, bool value) { throw new NotImplementedException (); } + public IList ToList () { return new List { "One", "Two", "Three" }; } + + public void Dispose () { throw new NotImplementedException (); } } [Fact] - public void ListView_CollectionNavigatorMatcher_KeybindingsOverrideNavigator () + public void KeyBindings_Command () { - ObservableCollection source = new () { "apricot", "arm", "bat", "batman", "bates hotel", "candle" }; - ListView lv = new ListView { Source = new ListWrapper (source) }; - - lv.SetFocus (); - - lv.KeyBindings.Add (Key.B, Command.Down); - - Assert.Equal (-1, lv.SelectedItem); - - // Keys should be consumed to move down the navigation i.e. to apricot - Assert.True (lv.NewKeyDownEvent (Key.B)); + ObservableCollection source = ["One", "Two", "Three"]; + var lv = new ListView { Height = 2, AllowsMarking = true, Source = new ListWrapper (source) }; + lv.BeginInit (); + lv.EndInit (); + Assert.Null (lv.SelectedItem); + Assert.True (lv.NewKeyDownEvent (Key.CursorDown)); + Assert.Equal (0, lv.SelectedItem); + Assert.True (lv.NewKeyDownEvent (Key.CursorUp)); + Assert.Equal (0, lv.SelectedItem); + Assert.True (lv.NewKeyDownEvent (Key.PageDown)); + Assert.Equal (2, lv.SelectedItem); + Assert.Equal (2, lv.TopItem); + Assert.True (lv.NewKeyDownEvent (Key.PageUp)); + Assert.Equal (0, lv.SelectedItem); + Assert.Equal (0, lv.TopItem); + Assert.False (lv.Source.IsMarked (lv.SelectedItem!.Value)); + Assert.True (lv.NewKeyDownEvent (Key.Space)); + Assert.True (lv.Source.IsMarked (lv.SelectedItem!.Value)); + var opened = false; + lv.OpenSelectedItem += (s, _) => opened = true; + Assert.True (lv.NewKeyDownEvent (Key.Enter)); + Assert.True (opened); + Assert.True (lv.NewKeyDownEvent (Key.End)); + Assert.Equal (2, lv.SelectedItem); + Assert.True (lv.NewKeyDownEvent (Key.Home)); Assert.Equal (0, lv.SelectedItem); - - Assert.True (lv.NewKeyDownEvent (Key.B)); - Assert.Equal (1, lv.SelectedItem); - - // There is no keybinding for Key.C so it hits collection navigator i.e. we jump to candle - Assert.True (lv.NewKeyDownEvent (Key.C)); - Assert.Equal (5, lv.SelectedItem); } [Fact] - public void CollectionNavigatorMatcher_KeybindingsOverrideNavigator () + public void HotKey_Command_SetsFocus () { - ObservableCollection source = new () { "apricot", "arm", "bat", "batman", "bates hotel", "candle" }; - ListView lv = new ListView { Source = new ListWrapper (source) }; + var view = new ListView (); - lv.SetFocus (); + view.CanFocus = true; + Assert.False (view.HasFocus); + view.InvokeCommand (Command.HotKey); + Assert.True (view.HasFocus); + } - lv.KeyBindings.Add (Key.B, Command.Down); + [Fact] + public void HotKey_Command_Does_Not_Accept () + { + var listView = new ListView (); + var accepted = false; - Assert.Equal (-1, lv.SelectedItem); + listView.Accepting += OnAccepted; + listView.InvokeCommand (Command.HotKey); - // Keys should be consumed to move down the navigation i.e. to apricot - Assert.True (lv.NewKeyDownEvent (Key.B)); - Assert.Equal (0, lv.SelectedItem); + Assert.False (accepted); - Assert.True (lv.NewKeyDownEvent (Key.B)); + return; + + void OnAccepted (object? sender, CommandEventArgs e) { accepted = true; } + } + + [Fact] + public void Accept_Command_Accepts_and_Opens_Selected_Item () + { + ObservableCollection source = ["One", "Two", "Three"]; + var listView = new ListView { Source = new ListWrapper (source) }; + listView.SelectedItem = 0; + + var accepted = false; + var opened = false; + var selectedValue = string.Empty; + + listView.Accepting += Accepted; + listView.OpenSelectedItem += OpenSelectedItem; + + listView.InvokeCommand (Command.Accept); + + Assert.True (accepted); + Assert.True (opened); + Assert.Equal (source [0], selectedValue); + + return; + + void OpenSelectedItem (object? sender, ListViewItemEventArgs e) + { + opened = true; + selectedValue = e.Value!.ToString (); + } + + void Accepted (object? sender, CommandEventArgs e) { accepted = true; } + } + + [Fact] + public void Accept_Cancel_Event_Prevents_OpenSelectedItem () + { + ObservableCollection source = ["One", "Two", "Three"]; + var listView = new ListView { Source = new ListWrapper (source) }; + listView.SelectedItem = 0; + + var accepted = false; + var opened = false; + var selectedValue = string.Empty; + + listView.Accepting += Accepted; + listView.OpenSelectedItem += OpenSelectedItem; + + listView.InvokeCommand (Command.Accept); + + Assert.True (accepted); + Assert.False (opened); + Assert.Equal (string.Empty, selectedValue); + + return; + + void OpenSelectedItem (object? sender, ListViewItemEventArgs e) + { + opened = true; + selectedValue = e.Value!.ToString (); + } + + void Accepted (object? sender, CommandEventArgs e) + { + accepted = true; + e.Handled = true; + } + } + + [Fact] + public void ListViewProcessKeyReturnValue_WithMultipleCommands () + { + var lv = new ListView { Source = new ListWrapper (["One", "Two", "Three", "Four"]) }; + + Assert.NotNull (lv.Source); + + // first item should be deselected by default + Assert.Null (lv.SelectedItem); + + // bind shift down to move down twice in control + lv.KeyBindings.Add (Key.CursorDown.WithShift, Command.Down, Command.Down); + + Key ev = Key.CursorDown.WithShift; + + Assert.True (lv.NewKeyDownEvent (ev), "The first time we move down 2 it should be possible"); + + // After moving down twice from null we should be at 'Two' Assert.Equal (1, lv.SelectedItem); - // There is no keybinding for Key.C so it hits collection navigator i.e. we jump to candle - Assert.True (lv.NewKeyDownEvent (Key.C)); - Assert.Equal (5, lv.SelectedItem); + // clear the items + lv.SetSource (null); + + // Press key combo again - return should be false this time as none of the Commands are allowable + Assert.False (lv.NewKeyDownEvent (ev), "We cannot move down so will not respond to this"); + } + + [Fact] + public void AllowsMarking_True_SpaceWithShift_SelectsThenDown_SingleSelection () + { + var lv = new ListView { Source = new ListWrapper (["One", "Two", "Three"]) }; + lv.AllowsMarking = true; + lv.AllowsMultipleSelection = false; + + Assert.NotNull (lv.Source); + + // first item should be deselected by default + Assert.Null (lv.SelectedItem); + + // nothing is ticked + Assert.False (lv.Source.IsMarked (0)); + Assert.False (lv.Source.IsMarked (1)); + Assert.False (lv.Source.IsMarked (2)); + + // view should indicate that it has accepted and consumed the event + Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); + + // first item should now be selected + Assert.Equal (0, lv.SelectedItem); + + // none of the items should be ticked + Assert.False (lv.Source.IsMarked (0)); + Assert.False (lv.Source.IsMarked (1)); + Assert.False (lv.Source.IsMarked (2)); + + // Press key combo again + Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); + + // second item should now be selected + Assert.Equal (1, lv.SelectedItem); + + // first item only should be ticked + Assert.True (lv.Source.IsMarked (0)); + Assert.False (lv.Source.IsMarked (1)); + Assert.False (lv.Source.IsMarked (2)); + + // Press key combo again + Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); + Assert.Equal (2, lv.SelectedItem); + Assert.False (lv.Source.IsMarked (0)); + Assert.True (lv.Source.IsMarked (1)); + Assert.False (lv.Source.IsMarked (2)); + + // Press key combo again + Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); + Assert.Equal (2, lv.SelectedItem); // cannot move down any further + Assert.False (lv.Source.IsMarked (0)); + Assert.False (lv.Source.IsMarked (1)); + Assert.True (lv.Source.IsMarked (2)); // but can toggle marked + + // Press key combo again + Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); + Assert.Equal (2, lv.SelectedItem); // cannot move down any further + Assert.False (lv.Source.IsMarked (0)); + Assert.False (lv.Source.IsMarked (1)); + Assert.False (lv.Source.IsMarked (2)); // untoggle toggle marked + } + + [Fact] + public void AllowsMarking_True_SpaceWithShift_SelectsThenDown_MultipleSelection () + { + var lv = new ListView { Source = new ListWrapper (["One", "Two", "Three"]) }; + lv.AllowsMarking = true; + lv.AllowsMultipleSelection = true; + + Assert.NotNull (lv.Source); + + // first item should be deselected by default + Assert.Null (lv.SelectedItem); + + // nothing is ticked + Assert.False (lv.Source.IsMarked (0)); + Assert.False (lv.Source.IsMarked (1)); + Assert.False (lv.Source.IsMarked (2)); + + // view should indicate that it has accepted and consumed the event + Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); + + // first item should now be selected + Assert.Equal (0, lv.SelectedItem); + + // none of the items should be ticked + Assert.False (lv.Source.IsMarked (0)); + Assert.False (lv.Source.IsMarked (1)); + Assert.False (lv.Source.IsMarked (2)); + + // Press key combo again + Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); + + // second item should now be selected + Assert.Equal (1, lv.SelectedItem); + + // first item only should be ticked + Assert.True (lv.Source.IsMarked (0)); + Assert.False (lv.Source.IsMarked (1)); + Assert.False (lv.Source.IsMarked (2)); + + // Press key combo again + Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); + Assert.Equal (2, lv.SelectedItem); + Assert.True (lv.Source.IsMarked (0)); + Assert.True (lv.Source.IsMarked (1)); + Assert.False (lv.Source.IsMarked (2)); + + // Press key combo again + Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); + Assert.Equal (2, lv.SelectedItem); // cannot move down any further + Assert.True (lv.Source.IsMarked (0)); + Assert.True (lv.Source.IsMarked (1)); + Assert.True (lv.Source.IsMarked (2)); // but can toggle marked + + // Press key combo again + Assert.True (lv.NewKeyDownEvent (Key.Space.WithShift)); + Assert.Equal (2, lv.SelectedItem); // cannot move down any further + Assert.True (lv.Source.IsMarked (0)); + Assert.True (lv.Source.IsMarked (1)); + Assert.False (lv.Source.IsMarked (2)); // untoggle toggle marked + } + + [Fact] + public void ListWrapper_StartsWith () + { + ListWrapper lw = new (["One", "Two", "Three"]); + + Assert.Equal (1, lw.StartsWith ("t")); + Assert.Equal (1, lw.StartsWith ("tw")); + Assert.Equal (2, lw.StartsWith ("th")); + Assert.Equal (1, lw.StartsWith ("T")); + Assert.Equal (1, lw.StartsWith ("TW")); + Assert.Equal (2, lw.StartsWith ("TH")); + + lw = new (["One", "Two", "Three"]); + + Assert.Equal (1, lw.StartsWith ("t")); + Assert.Equal (1, lw.StartsWith ("tw")); + Assert.Equal (2, lw.StartsWith ("th")); + Assert.Equal (1, lw.StartsWith ("T")); + Assert.Equal (1, lw.StartsWith ("TW")); + Assert.Equal (2, lw.StartsWith ("TH")); + } + + [Fact] + public void OnEnter_Does_Not_Throw_Exception () + { + var lv = new ListView (); + var top = new View (); + top.Add (lv); + Exception exception = Record.Exception (() => lv.SetFocus ()); + Assert.Null (exception); + } + + [Fact] + public void SelectedItem_Get_Set () + { + var lv = new ListView { Source = new ListWrapper (["One", "Two", "Three"]) }; + Assert.Null (lv.SelectedItem); + Assert.Throws (() => lv.SelectedItem = 3); + Exception exception = Record.Exception (() => lv.SelectedItem = null); + Assert.Null (exception); + } + + [Fact] + public void SetSource_Preserves_ListWrapper_Instance_If_Not_Null () + { + var lv = new ListView { Source = new ListWrapper (["One", "Two"]) }; + + Assert.NotNull (lv.Source); + + lv.SetSource (null); + Assert.NotNull (lv.Source); + + lv.Source = null; + Assert.Null (lv.Source); + + lv = new () { Source = new ListWrapper (["One", "Two"]) }; + Assert.NotNull (lv.Source); + + lv.SetSourceAsync (null); + Assert.NotNull (lv.Source); + } + + [Fact] + public void SettingEmptyKeybindingThrows () + { + var lv = new ListView { Source = new ListWrapper (["One", "Two", "Three"]) }; + Assert.Throws (() => lv.KeyBindings.Add (Key.Space)); + } + + [Fact] + public void CollectionChanged_Event () + { + var added = 0; + var removed = 0; + ObservableCollection source = []; + var lv = new ListView { Source = new ListWrapper (source) }; + + lv.CollectionChanged += (sender, args) => + { + if (args.Action == NotifyCollectionChangedAction.Add) + { + added++; + } + else if (args.Action == NotifyCollectionChangedAction.Remove) + { + removed++; + } + }; + + for (var i = 0; i < 3; i++) + { + source.Add ($"Item{i}"); + } + + Assert.Equal (3, added); + Assert.Equal (0, removed); + + added = 0; + + for (var i = 0; i < 3; i++) + { + source.Remove (source [0]); + } + + Assert.Equal (0, added); + Assert.Equal (3, removed); + Assert.Empty (source); + } + + [Fact] + public void CollectionChanged_Event_Is_Only_Subscribed_Once () + { + var added = 0; + var removed = 0; + var otherActions = 0; + IList source1 = []; + var lv = new ListView { Source = new ListWrapper (new (source1)) }; + + lv.CollectionChanged += (sender, args) => + { + if (args.Action == NotifyCollectionChangedAction.Add) + { + added++; + } + else if (args.Action == NotifyCollectionChangedAction.Remove) + { + removed++; + } + else + { + otherActions++; + } + }; + + ObservableCollection source2 = []; + lv.Source = new ListWrapper (source2); + ObservableCollection source3 = []; + lv.Source = new ListWrapper (source3); + Assert.Equal (0, added); + Assert.Equal (0, removed); + Assert.Equal (0, otherActions); + + for (var i = 0; i < 3; i++) + { + source1.Add ($"Item{i}"); + source2.Add ($"Item{i}"); + source3.Add ($"Item{i}"); + } + + Assert.Equal (3, added); + Assert.Equal (0, removed); + Assert.Equal (0, otherActions); + + added = 0; + + for (var i = 0; i < 3; i++) + { + source1.Remove (source1 [0]); + source2.Remove (source2 [0]); + source3.Remove (source3 [0]); + } + + Assert.Equal (0, added); + Assert.Equal (3, removed); + Assert.Equal (0, otherActions); + Assert.Empty (source1); + Assert.Empty (source2); + Assert.Empty (source3); + } + + [Fact] + public void CollectionChanged_Event_UnSubscribe_Previous_If_New_Is_Null () + { + var added = 0; + var removed = 0; + var otherActions = 0; + ObservableCollection source1 = []; + var lv = new ListView { Source = new ListWrapper (source1) }; + + lv.CollectionChanged += (sender, args) => + { + if (args.Action == NotifyCollectionChangedAction.Add) + { + added++; + } + else if (args.Action == NotifyCollectionChangedAction.Remove) + { + removed++; + } + else + { + otherActions++; + } + }; + + lv.Source = new ListWrapper (null); + Assert.Equal (0, added); + Assert.Equal (0, removed); + Assert.Equal (0, otherActions); + + for (var i = 0; i < 3; i++) + { + source1.Add ($"Item{i}"); + } + + Assert.Equal (0, added); + Assert.Equal (0, removed); + Assert.Equal (0, otherActions); + + for (var i = 0; i < 3; i++) + { + source1.Remove (source1 [0]); + } + + Assert.Equal (0, added); + Assert.Equal (0, removed); + Assert.Equal (0, otherActions); + Assert.Empty (source1); + } + + [Fact] + public void ListWrapper_CollectionChanged_Event_Is_Only_Subscribed_Once () + { + var added = 0; + var removed = 0; + var otherActions = 0; + ObservableCollection source1 = []; + ListWrapper lw = new (source1); + + lw.CollectionChanged += (sender, args) => + { + if (args.Action == NotifyCollectionChangedAction.Add) + { + added++; + } + else if (args.Action == NotifyCollectionChangedAction.Remove) + { + removed++; + } + else + { + otherActions++; + } + }; + + ObservableCollection source2 = []; + lw = new (source2); + ObservableCollection source3 = []; + lw = new (source3); + Assert.Equal (0, added); + Assert.Equal (0, removed); + Assert.Equal (0, otherActions); + + for (var i = 0; i < 3; i++) + { + source1.Add ($"Item{i}"); + source2.Add ($"Item{i}"); + source3.Add ($"Item{i}"); + } + + Assert.Equal (3, added); + Assert.Equal (0, removed); + Assert.Equal (0, otherActions); + + added = 0; + + for (var i = 0; i < 3; i++) + { + source1.Remove (source1 [0]); + source2.Remove (source2 [0]); + source3.Remove (source3 [0]); + } + + Assert.Equal (0, added); + Assert.Equal (3, removed); + Assert.Equal (0, otherActions); + Assert.Empty (source1); + Assert.Empty (source2); + Assert.Empty (source3); + } + + [Fact] + public void ListWrapper_CollectionChanged_Event_UnSubscribe_Previous_Is_Disposed () + { + var added = 0; + var removed = 0; + var otherActions = 0; + ObservableCollection source1 = []; + ListWrapper lw = new (source1); + + lw.CollectionChanged += Lw_CollectionChanged; + + lw.Dispose (); + lw = new (null); + Assert.Equal (0, lw.Count); + Assert.Equal (0, added); + Assert.Equal (0, removed); + Assert.Equal (0, otherActions); + + for (var i = 0; i < 3; i++) + { + source1.Add ($"Item{i}"); + } + + Assert.Equal (0, added); + Assert.Equal (0, removed); + Assert.Equal (0, otherActions); + + for (var i = 0; i < 3; i++) + { + source1.Remove (source1 [0]); + } + + Assert.Equal (0, added); + Assert.Equal (0, removed); + Assert.Equal (0, otherActions); + Assert.Empty (source1); + + void Lw_CollectionChanged (object? sender, NotifyCollectionChangedEventArgs e) + { + if (e.Action == NotifyCollectionChangedAction.Add) + { + added++; + } + } + } + + [Fact] + public void ListWrapper_SuspendCollectionChangedEvent_ResumeSuspendCollectionChangedEvent_Tests () + { + var added = 0; + ObservableCollection source = []; + ListWrapper lw = new (source); + + lw.CollectionChanged += Lw_CollectionChanged; + + lw.SuspendCollectionChangedEvent = true; + + for (var i = 0; i < 3; i++) + { + source.Add ($"Item{i}"); + } + + Assert.Equal (0, added); + Assert.Equal (3, lw.Count); + Assert.Equal (3, source.Count); + + lw.SuspendCollectionChangedEvent = false; + + for (var i = 3; i < 6; i++) + { + source.Add ($"Item{i}"); + } + + Assert.Equal (3, added); + Assert.Equal (6, lw.Count); + Assert.Equal (6, source.Count); + + void Lw_CollectionChanged (object? sender, NotifyCollectionChangedEventArgs e) + { + if (e.Action == NotifyCollectionChangedAction.Add) + { + added++; + } + } + } + + [Fact] + public void ListView_SuspendCollectionChangedEvent_ResumeSuspendCollectionChangedEvent_Tests () + { + var added = 0; + ObservableCollection source = []; + var lv = new ListView { Source = new ListWrapper (source) }; + + lv.CollectionChanged += Lw_CollectionChanged; + + lv.SuspendCollectionChangedEvent (); + + for (var i = 0; i < 3; i++) + { + source.Add ($"Item{i}"); + } + + Assert.Equal (0, added); + Assert.Equal (3, lv.Source.Count); + Assert.Equal (3, source.Count); + + lv.ResumeSuspendCollectionChangedEvent (); + + for (var i = 3; i < 6; i++) + { + source.Add ($"Item{i}"); + } + + Assert.Equal (3, added); + Assert.Equal (6, lv.Source.Count); + Assert.Equal (6, source.Count); + + void Lw_CollectionChanged (object? sender, NotifyCollectionChangedEventArgs e) + { + if (e.Action == NotifyCollectionChangedAction.Add) + { + added++; + } + } + } + + #endregion + + [Fact] + public void Clicking_On_Border_Is_Ignored () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + + var selected = ""; + + var lv = new ListView + { + Height = 5, + Width = 7, + BorderStyle = LineStyle.Single + }; + lv.SetSource (["One", "Two", "Three", "Four"]); + lv.SelectedItemChanged += (s, e) => selected = e.Value!.ToString (); + var top = new Runnable (); + top.Add (lv); + app.Begin (top); + + //AutoInitDisposeAttribute.RunIteration (); + + Assert.Equal (new (1), lv.Border!.Thickness); + Assert.Null (lv.SelectedItem); + Assert.Equal ("", lv.Text); + app.LayoutAndDraw (); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌─────┐ +│One │ +│Two │ +│Three│ +└─────┘", + _output, app?.Driver); + + app?.Mouse.RaiseMouseEvent (new () { ScreenPosition = new (0, 0), Flags = MouseFlags.Button1Clicked }); + Assert.Equal ("", selected); + Assert.Null (lv.SelectedItem); + + app?.Mouse.RaiseMouseEvent ( + new () + { + ScreenPosition = new (1, 1), Flags = MouseFlags.Button1Clicked + }); + Assert.Equal ("One", selected); + Assert.Equal (0, lv.SelectedItem); + + app?.Mouse.RaiseMouseEvent ( + new () + { + ScreenPosition = new (1, 2), Flags = MouseFlags.Button1Clicked + }); + Assert.Equal ("Two", selected); + Assert.Equal (1, lv.SelectedItem); + + app?.Mouse.RaiseMouseEvent ( + new () + { + ScreenPosition = new (1, 3), Flags = MouseFlags.Button1Clicked + }); + Assert.Equal ("Three", selected); + Assert.Equal (2, lv.SelectedItem); + + app?.Mouse.RaiseMouseEvent ( + new () + { + ScreenPosition = new (1, 4), Flags = MouseFlags.Button1Clicked + }); + Assert.Equal ("Three", selected); + Assert.Equal (2, lv.SelectedItem); + top.Dispose (); + + app?.Dispose (); + } + + [Fact] + public void Ensures_Visibility_SelectedItem_On_MoveDown_And_MoveUp () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + app.Driver?.SetScreenSize (12, 12); + + ObservableCollection source = []; + + for (var i = 0; i < 20; i++) + { + source.Add ($"Line{i}"); + } + + var lv = new ListView { Width = Dim.Fill (), Height = Dim.Fill (), Source = new ListWrapper (source) }; + var win = new Window (); + win.Add (lv); + var top = new Runnable (); + top.Add (win); + app.Begin (top); + + Assert.Null (lv.SelectedItem); + app.LayoutAndDraw (); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌──────────┐ +│Line0 │ +│Line1 │ +│Line2 │ +│Line3 │ +│Line4 │ +│Line5 │ +│Line6 │ +│Line7 │ +│Line8 │ +│Line9 │ +└──────────┘", + _output, app.Driver + ); + + Assert.True (lv.ScrollVertical (10)); + app.LayoutAndDraw (); + Assert.Null (lv.SelectedItem); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌──────────┐ +│Line10 │ +│Line11 │ +│Line12 │ +│Line13 │ +│Line14 │ +│Line15 │ +│Line16 │ +│Line17 │ +│Line18 │ +│Line19 │ +└──────────┘", + _output, app.Driver + ); + + Assert.True (lv.MoveDown ()); + app.LayoutAndDraw (); + Assert.Equal (0, lv.SelectedItem); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌──────────┐ +│Line0 │ +│Line1 │ +│Line2 │ +│Line3 │ +│Line4 │ +│Line5 │ +│Line6 │ +│Line7 │ +│Line8 │ +│Line9 │ +└──────────┘", + _output, app.Driver + ); + + Assert.True (lv.MoveEnd ()); + app.LayoutAndDraw (); + Assert.Equal (19, lv.SelectedItem); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌──────────┐ +│Line10 │ +│Line11 │ +│Line12 │ +│Line13 │ +│Line14 │ +│Line15 │ +│Line16 │ +│Line17 │ +│Line18 │ +│Line19 │ +└──────────┘", + _output, app.Driver + ); + + Assert.True (lv.ScrollVertical (-20)); + app.LayoutAndDraw (); + Assert.Equal (19, lv.SelectedItem); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌──────────┐ +│Line0 │ +│Line1 │ +│Line2 │ +│Line3 │ +│Line4 │ +│Line5 │ +│Line6 │ +│Line7 │ +│Line8 │ +│Line9 │ +└──────────┘", + _output, app.Driver + ); + + Assert.True (lv.MoveDown ()); + app.LayoutAndDraw (); + Assert.Equal (19, lv.SelectedItem); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌──────────┐ +│Line10 │ +│Line11 │ +│Line12 │ +│Line13 │ +│Line14 │ +│Line15 │ +│Line16 │ +│Line17 │ +│Line18 │ +│Line19 │ +└──────────┘", + _output, app.Driver + ); + + Assert.True (lv.ScrollVertical (-20)); + app.LayoutAndDraw (); + Assert.Equal (19, lv.SelectedItem); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌──────────┐ +│Line0 │ +│Line1 │ +│Line2 │ +│Line3 │ +│Line4 │ +│Line5 │ +│Line6 │ +│Line7 │ +│Line8 │ +│Line9 │ +└──────────┘", + _output, app.Driver + ); + + Assert.True (lv.MoveDown ()); + app.LayoutAndDraw (); + Assert.Equal (19, lv.SelectedItem); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌──────────┐ +│Line10 │ +│Line11 │ +│Line12 │ +│Line13 │ +│Line14 │ +│Line15 │ +│Line16 │ +│Line17 │ +│Line18 │ +│Line19 │ +└──────────┘", + _output, app.Driver + ); + + Assert.True (lv.MoveHome ()); + app.LayoutAndDraw (); + Assert.Equal (0, lv.SelectedItem); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌──────────┐ +│Line0 │ +│Line1 │ +│Line2 │ +│Line3 │ +│Line4 │ +│Line5 │ +│Line6 │ +│Line7 │ +│Line8 │ +│Line9 │ +└──────────┘", + _output, app.Driver + ); + + Assert.True (lv.ScrollVertical (20)); + app.LayoutAndDraw (); + Assert.Equal (0, lv.SelectedItem); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌──────────┐ +│Line19 │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +└──────────┘", + _output, app.Driver + ); + + Assert.True (lv.MoveUp ()); + app.LayoutAndDraw (); + Assert.Equal (0, lv.SelectedItem); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +┌──────────┐ +│Line0 │ +│Line1 │ +│Line2 │ +│Line3 │ +│Line4 │ +│Line5 │ +│Line6 │ +│Line7 │ +│Line8 │ +│Line9 │ +└──────────┘", + _output, app.Driver + ); + top.Dispose (); + app.Dispose (); + } + + [Fact] + public void EnsureSelectedItemVisible_SelectedItem () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + app.Driver?.SetScreenSize (12, 12); + + ObservableCollection source = []; + + for (var i = 0; i < 10; i++) + { + source.Add ($"Item {i}"); + } + + var lv = new ListView { Width = 10, Height = 5, Source = new ListWrapper (source) }; + var top = new Runnable (); + top.Add (lv); + app.Begin (top); + app.LayoutAndDraw (); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +Item 0 +Item 1 +Item 2 +Item 3 +Item 4", + _output, app.Driver + ); + + // EnsureSelectedItemVisible is auto enabled on the OnSelectedChanged + lv.SelectedItem = 6; + app.LayoutAndDraw (); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +Item 2 +Item 3 +Item 4 +Item 5 +Item 6", + _output, app.Driver + ); + top.Dispose (); + app.Dispose (); + } + + [Fact] + public void EnsureSelectedItemVisible_Top () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + IDriver? driver = app.Driver; + driver?.SetScreenSize (8, 2); + + ObservableCollection source = ["First", "Second"]; + var lv = new ListView { Width = Dim.Fill (), Height = 1, Source = new ListWrapper (source) }; + lv.SelectedItem = 1; + var top = new Runnable (); + top.Add (lv); + app.Begin (top); + app.LayoutAndDraw (); + + Assert.Equal ("Second ", GetContents (0)); + Assert.Equal (new (' ', 7), GetContents (1)); + + lv.MoveUp (); + lv.Draw (); + + Assert.Equal ("First ", GetContents (0)); + Assert.Equal (new (' ', 7), GetContents (1)); + + string GetContents (int line) + { + var sb = new StringBuilder (); + + for (var i = 0; i < 7; i++) + { + sb.Append ((app?.Driver?.Contents!) [line, i].Grapheme); + } + + return sb.ToString (); + } + + top.Dispose (); + app.Dispose (); + } + + [Fact] + public void LeftItem_TopItem_Tests () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + app.Driver?.SetScreenSize (12, 12); + + ObservableCollection source = []; + + for (var i = 0; i < 5; i++) + { + source.Add ($"Item {i}"); + } + + var lv = new ListView + { + X = 1, + Source = new ListWrapper (source) + }; + lv.Height = lv.Source.Count; + lv.Width = lv.MaxLength; + var top = new Runnable (); + top.Add (lv); + app.Begin (top); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" + Item 0 + Item 1 + Item 2 + Item 3 + Item 4", + _output, app.Driver); + + lv.LeftItem = 1; + lv.TopItem = 1; + app.LayoutAndDraw (); + + DriverAssert.AssertDriverContentsWithFrameAre ( + @" + tem 1 + tem 2 + tem 3 + tem 4", + _output, app.Driver); + top.Dispose (); + app.Dispose (); + } + + [Fact] + public void RowRender_Event () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + + var rendered = false; + ObservableCollection source = ["one", "two", "three"]; + var lv = new ListView { Width = Dim.Fill (), Height = Dim.Fill () }; + lv.RowRender += (s, _) => rendered = true; + var top = new Runnable (); + top.Add (lv); + app.Begin (top); + Assert.False (rendered); + + lv.SetSource (source); + lv.Draw (); + Assert.True (rendered); + top.Dispose (); + app.Dispose (); + } + + [Fact] + public void Vertical_ScrollBar_Hides_And_Shows_As_Needed () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + + var lv = new ListView + { + Width = 10, + Height = 3 + }; + lv.VerticalScrollBar.AutoShow = true; + lv.SetSource (["One", "Two", "Three", "Four", "Five"]); + var top = new Runnable (); + top.Add (lv); + app.Begin (top); + + Assert.True (lv.VerticalScrollBar.Visible); + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +One ▲ +Two █ +Three ▼", + _output, app?.Driver); + + lv.Height = 5; + app?.LayoutAndDraw (); + + Assert.False (lv.VerticalScrollBar.Visible); + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +One +Two +Three +Four +Five ", + _output, app?.Driver); + top.Dispose (); + app?.Dispose (); + } + + [Fact] + public void Mouse_Wheel_Scrolls () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + + var lv = new ListView + { + Width = 10, + Height = 3, + }; + lv.SetSource (["One", "Two", "Three", "Four", "Five"]); + var top = new Runnable (); + top.Add (lv); + app.Begin (top); + + // Initially, we are at the top. + Assert.Equal (0, lv.TopItem); + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +One +Two +Three", + _output, app?.Driver); + + // Scroll down + app?.Mouse.RaiseMouseEvent (new () { ScreenPosition = new (0, 0), Flags = MouseFlags.WheeledDown }); + app?.LayoutAndDraw (); + Assert.Equal (1, lv.TopItem); + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +Two +Three +Four ", + _output, app?.Driver); + + // Scroll up + app?.Mouse.RaiseMouseEvent (new () { ScreenPosition = new (0, 0), Flags = MouseFlags.WheeledUp }); + app?.LayoutAndDraw (); + Assert.Equal (0, lv.TopItem); + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +One +Two +Three", + _output, app?.Driver); + + top.Dispose (); + app?.Dispose (); + } + + [Fact] + public void SelectedItem_With_Source_Null_Does_Nothing () + { + var lv = new ListView (); + Assert.Null (lv.Source); + + // should not throw + lv.SelectedItem = 0; + + Assert.Null (lv.SelectedItem); + } + + [Fact] + public void Horizontal_Scroll () + { + IApplication? app = Application.Create (); + app.Init ("fake"); + + var lv = new ListView + { + Width = 10, + Height = 3, + }; + lv.SetSource (["One", "Two", "Three - long", "Four", "Five"]); + var top = new Runnable (); + top.Add (lv); + app.Begin (top); + app.LayoutAndDraw (); + + Assert.Equal (0, lv.LeftItem); + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +One +Two +Three - lo", + _output, app?.Driver); + + lv.ScrollHorizontal (1); + app?.LayoutAndDraw (); + Assert.Equal (1, lv.LeftItem); + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +ne +wo +hree - lon", + _output, app?.Driver); + + // Scroll right with mouse + app?.Mouse.RaiseMouseEvent (new () { ScreenPosition = new (0, 0), Flags = MouseFlags.WheeledRight }); + app?.LayoutAndDraw (); + Assert.Equal (2, lv.LeftItem); + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +e +o +ree - long", + _output, app?.Driver); + + // Scroll left with mouse + app?.Mouse.RaiseMouseEvent (new () { ScreenPosition = new (0, 0), Flags = MouseFlags.WheeledLeft }); + app?.LayoutAndDraw (); + Assert.Equal (1, lv.LeftItem); + DriverAssert.AssertDriverContentsWithFrameAre ( + @" +ne +wo +hree - lon", + _output, app?.Driver); + + top.Dispose (); + app?.Dispose (); + } + + [Fact] + public async Task SetSourceAsync_SetsSource () + { + var lv = new ListView (); + var source = new ObservableCollection { "One", "Two", "Three" }; + + await lv.SetSourceAsync (source); + + Assert.NotNull (lv.Source); + Assert.Equal (3, lv.Source.Count); + } + + [Fact] + public void AllowsMultipleSelection_Set_To_False_Unmarks_All_But_Selected () + { + var lv = new ListView { AllowsMarking = true, AllowsMultipleSelection = true }; + var source = new ListWrapper (["One", "Two", "Three"]); + lv.Source = source; + + lv.SelectedItem = 0; + source.SetMark (0, true); + source.SetMark (1, true); + source.SetMark (2, true); + + Assert.True (source.IsMarked (0)); + Assert.True (source.IsMarked (1)); + Assert.True (source.IsMarked (2)); + + lv.AllowsMultipleSelection = false; + + Assert.True (source.IsMarked (0)); + Assert.False (source.IsMarked (1)); + Assert.False (source.IsMarked (2)); + } + + [Fact] + public void Source_CollectionChanged_Remove () + { + var source = new ObservableCollection { "One", "Two", "Three" }; + var lv = new ListView { Source = new ListWrapper (source) }; + + lv.SelectedItem = 2; + Assert.Equal (2, lv.SelectedItem); + Assert.Equal (3, lv.Source.Count); + + source.RemoveAt (0); + + Assert.Equal (2, lv.Source.Count); + Assert.Equal (1, lv.SelectedItem); + + source.RemoveAt (1); + Assert.Equal (1, lv.Source.Count); + Assert.Equal (0, lv.SelectedItem); } } diff --git a/Tests/UnitTestsParallelizable/Views/MenuBarItemTests.cs b/Tests/UnitTestsParallelizable/Views/MenuBarItemTests.cs index 75ac7a9a5..90320c399 100644 --- a/Tests/UnitTestsParallelizable/Views/MenuBarItemTests.cs +++ b/Tests/UnitTestsParallelizable/Views/MenuBarItemTests.cs @@ -1,19 +1,19 @@ using Xunit.Abstractions; -//using static Terminal.Gui.ViewTests.MenuTests; +//using static Terminal.Gui.ViewBaseTests.MenuTests; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; public class MenuBarItemTests () { [Fact] public void Constructors_Defaults () { - var menuBarItem = new MenuBarItemv2 (); + var menuBarItem = new MenuBarItem (); Assert.Null (menuBarItem.PopoverMenu); Assert.Null (menuBarItem.TargetView); - menuBarItem = new MenuBarItemv2 (targetView: null, command: Command.NotBound, commandText: null, popoverMenu: null); + menuBarItem = new MenuBarItem (targetView: null, command: Command.NotBound, commandText: null, popoverMenu: null); Assert.Null (menuBarItem.PopoverMenu); Assert.Null (menuBarItem.TargetView); diff --git a/Tests/UnitTestsParallelizable/Views/MenuItemTests.cs b/Tests/UnitTestsParallelizable/Views/MenuItemTests.cs deleted file mode 100644 index b48502cd9..000000000 --- a/Tests/UnitTestsParallelizable/Views/MenuItemTests.cs +++ /dev/null @@ -1,14 +0,0 @@ -using Xunit.Abstractions; - -//using static Terminal.Gui.ViewTests.MenuTests; - -namespace UnitTests_Parallelizable.ViewsTests; - -public class MenuItemTests () -{ - [Fact] - public void Constructors_Defaults () - { - - } -} diff --git a/Tests/UnitTestsParallelizable/Views/MenuTests.cs b/Tests/UnitTestsParallelizable/Views/MenuTests.cs index f83dd490e..0bb2c5e46 100644 --- a/Tests/UnitTestsParallelizable/Views/MenuTests.cs +++ b/Tests/UnitTestsParallelizable/Views/MenuTests.cs @@ -1,15 +1,15 @@ using Xunit.Abstractions; -//using static Terminal.Gui.ViewTests.MenuTests; +//using static Terminal.Gui.ViewBaseTests.MenuTests; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; public class MenuTests () { [Fact] public void Constructors_Defaults () { - var menu = new Menuv2 { }; + var menu = new Menu { }; Assert.Empty (menu.Title); Assert.Empty (menu.Text); } diff --git a/Tests/UnitTestsParallelizable/Views/MessageBoxTests.cs b/Tests/UnitTestsParallelizable/Views/MessageBoxTests.cs new file mode 100644 index 000000000..47bdcf8be --- /dev/null +++ b/Tests/UnitTestsParallelizable/Views/MessageBoxTests.cs @@ -0,0 +1,625 @@ +#nullable enable +using System.Text; +using UICatalog; +using UnitTests; +using Xunit.Abstractions; + +namespace ViewsTests; + +public class MessageBoxTests (ITestOutputHelper output) +{ + [Fact] + public void KeyBindings_Enter_Causes_Focused_Button_Click_No_Accept () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + try + { + int? result = null; + var iteration = 0; + var btnAcceptCount = 0; + + app.Iteration += OnApplicationOnIteration; + app.Run> (); + app.Iteration -= OnApplicationOnIteration; + + Assert.Equal (1, result); + Assert.Equal (1, btnAcceptCount); + + void OnApplicationOnIteration (object? s, EventArgs a) + { + iteration++; + + switch (iteration) + { + case 1: + result = MessageBox.Query (app, string.Empty, string.Empty, 0, false, "btn0", "btn1"); + app.RequestStop (); + + break; + + case 2: + // Tab to btn2 + app.Keyboard.RaiseKeyDownEvent (Key.Tab); + + var btn = app.Navigation!.GetFocused () as Button; + btn!.Accepting += (sender, e) => { btnAcceptCount++; }; + + // Click + app.Keyboard.RaiseKeyDownEvent (Key.Enter); + + break; + + default: + Assert.Fail (); + + break; + } + } + } + finally + { + app.Dispose (); + } + } + + [Fact] + public void KeyBindings_Esc_Closes () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + try + { + int? result = 999; + var iteration = 0; + + app.Iteration += OnApplicationOnIteration; + app.Run> (); + app.Iteration -= OnApplicationOnIteration; + + Assert.Null (result); + + void OnApplicationOnIteration (object? s, EventArgs a) + { + iteration++; + + switch (iteration) + { + case 1: + result = MessageBox.Query (app, string.Empty, string.Empty, 0, false, "btn0", "btn1"); + app.RequestStop (); + + break; + + case 2: + app.Keyboard.RaiseKeyDownEvent (Key.Esc); + + break; + + default: + Assert.Fail (); + + break; + } + } + } + finally + { + app.Dispose (); + } + } + + [Fact] + public void KeyBindings_Space_Causes_Focused_Button_Click_No_Accept () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + try + { + int? result = null; + var iteration = 0; + var btnAcceptCount = 0; + + app.Iteration += OnApplicationOnIteration; + app.Run> (); + app.Iteration -= OnApplicationOnIteration; + + Assert.Equal (1, result); + Assert.Equal (1, btnAcceptCount); + + void OnApplicationOnIteration (object? s, EventArgs a) + { + iteration++; + + switch (iteration) + { + case 1: + result = MessageBox.Query (app, string.Empty, string.Empty, 0, false, "btn0", "btn1"); + app.RequestStop (); + + break; + + case 2: + // Tab to btn2 + app.Keyboard.RaiseKeyDownEvent (Key.Tab); + + var btn = app.Navigation!.GetFocused () as Button; + btn!.Accepting += (sender, e) => { btnAcceptCount++; }; + + app.Keyboard.RaiseKeyDownEvent (Key.Space); + + break; + + default: + Assert.Fail (); + + break; + } + } + } + finally + { + app.Dispose (); + } + } + + [Theory] + [InlineData (@"", false, false, 6, 6, 2, 2)] + [InlineData (@"", false, true, 3, 6, 9, 3)] + [InlineData (@"01234\n-----\n01234", false, false, 1, 6, 13, 3)] + [InlineData (@"01234\n-----\n01234", true, false, 1, 5, 13, 4)] + [InlineData (@"0123456789", false, false, 1, 6, 12, 3)] + [InlineData (@"0123456789", false, true, 1, 5, 12, 4)] + [InlineData (@"01234567890123456789", false, true, 1, 5, 13, 4)] + [InlineData (@"01234567890123456789", true, true, 1, 5, 13, 5)] + [InlineData (@"01234567890123456789\n01234567890123456789", false, true, 1, 5, 13, 4)] + [InlineData (@"01234567890123456789\n01234567890123456789", true, true, 1, 4, 13, 7)] + public void Location_And_Size_Correct (string message, bool wrapMessage, bool hasButton, int expectedX, int expectedY, int expectedW, int expectedH) + { + IApplication app = Application.Create (); + app.Init ("fake"); + + try + { + int iterations = -1; + + app.Driver!.SetScreenSize (15, 15); // 15 x 15 gives us enough room for a button with one char (9x1) + Dialog.DefaultShadow = ShadowStyle.None; + Button.DefaultShadow = ShadowStyle.None; + + var mbFrame = Rectangle.Empty; + + app.Iteration += OnApplicationOnIteration; + app.Run> (); + app.Iteration -= OnApplicationOnIteration; + + Assert.Equal (new (expectedX, expectedY, expectedW, expectedH), mbFrame); + + void OnApplicationOnIteration (object? s, EventArgs a) + { + iterations++; + + if (iterations == 0) + { + MessageBox.Query (app, string.Empty, message, 0, wrapMessage, hasButton ? ["0"] : []); + app.RequestStop (); + } + else if (iterations == 1) + { + mbFrame = app.TopRunnableView!.Frame; + app.RequestStop (); + } + } + } + finally + { + app.Dispose (); + } + } + + [Fact] + public void Message_With_Spaces_WrapMessage_False () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + try + { + int iterations = -1; + var top = new Runnable (); + top.BorderStyle = LineStyle.None; + app.Driver!.SetScreenSize (20, 10); + + var btn = + $"{Glyphs.LeftBracket}{Glyphs.LeftDefaultIndicator} btn {Glyphs.RightDefaultIndicator}{Glyphs.RightBracket}"; + + // Override CM + MessageBox.DefaultButtonAlignment = Alignment.End; + MessageBox.DefaultBorderStyle = LineStyle.Double; + Dialog.DefaultShadow = ShadowStyle.None; + Button.DefaultShadow = ShadowStyle.None; + + app.Iteration += OnApplicationOnIteration; + try + { + app.Run (top); + } + finally + { + app.Iteration -= OnApplicationOnIteration; + top.Dispose (); + } + + void OnApplicationOnIteration (object? s, EventArgs a) + { + iterations++; + + if (iterations == 0) + { + var sb = new StringBuilder (); + + for (var i = 0; i < 17; i++) + { + sb.Append ("ff "); + } + + MessageBox.Query (app, string.Empty, sb.ToString (), 0, false, "btn"); + app.RequestStop (); + } + else if (iterations == 2) + { + DriverAssert.AssertDriverContentsWithFrameAre ( + @" + ╔════════════════╗ + ║ ff ff ff ff ff ║ + ║ ⟦► btn ◄⟧║ + ╚════════════════╝", + output, + app.Driver); + app.RequestStop (); + + // Really long text + MessageBox.Query (app, string.Empty, new ('f', 500), 0, false, "btn"); + } + else if (iterations == 4) + { + DriverAssert.AssertDriverContentsWithFrameAre ( + @" + ╔════════════════╗ + ║ffffffffffffffff║ + ║ ⟦► btn ◄⟧║ + ╚════════════════╝", + output, + app.Driver); + app.RequestStop (); + } + } + } + finally + { + app.Dispose (); + } + } + + [Fact] + public void Message_With_Spaces_WrapMessage_True () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + try + { + int iterations = -1; + var top = new Runnable (); + top.BorderStyle = LineStyle.None; + app.Driver!.SetScreenSize (20, 10); + + var btn = + $"{Glyphs.LeftBracket}{Glyphs.LeftDefaultIndicator} btn {Glyphs.RightDefaultIndicator}{Glyphs.RightBracket}"; + + // Override CM + MessageBox.DefaultButtonAlignment = Alignment.End; + MessageBox.DefaultBorderStyle = LineStyle.Double; + Dialog.DefaultShadow = ShadowStyle.None; + Button.DefaultShadow = ShadowStyle.None; + + app.Iteration += OnApplicationOnIteration; + try + { + app.Run (top); + } + finally + { + app.Iteration -= OnApplicationOnIteration; + top.Dispose (); + } + + void OnApplicationOnIteration (object? s, EventArgs a) + { + iterations++; + + if (iterations == 0) + { + var sb = new StringBuilder (); + + for (var i = 0; i < 17; i++) + { + sb.Append ("ff "); + } + + MessageBox.Query (app, string.Empty, sb.ToString (), 0, true, "btn"); + app.RequestStop (); + } + else if (iterations == 2) + { + DriverAssert.AssertDriverContentsWithFrameAre ( + @" + ╔══════════════╗ + ║ff ff ff ff ff║ + ║ff ff ff ff ff║ + ║ff ff ff ff ff║ + ║ ff ff ║ + ║ ⟦► btn ◄⟧║ + ╚══════════════╝", + output, + app.Driver); + app.RequestStop (); + + // Really long text + MessageBox.Query (app, string.Empty, new ('f', 500), 0, true, "btn"); + } + else if (iterations == 4) + { + DriverAssert.AssertDriverContentsWithFrameAre ( + @" + ╔════════════════╗ + ║ffffffffffffffff║ + ║ffffffffffffffff║ + ║ffffffffffffffff║ + ║ffffffffffffffff║ + ║ffffffffffffffff║ + ║ffffffffffffffff║ + ║fffffff⟦► btn ◄⟧║ + ╚════════════════╝", + output, + app.Driver); + app.RequestStop (); + } + } + } + finally + { + app.Dispose (); + } + } + + [Theory (Skip = "Bogus test: Never does anything")] + [InlineData (0, 0, "1")] + [InlineData (1, 1, "1")] + [InlineData (7, 5, "1")] + [InlineData (50, 50, "1")] + [InlineData (0, 0, "message")] + [InlineData (1, 1, "message")] + [InlineData (7, 5, "message")] + [InlineData (50, 50, "message")] + public void Size_Not_Default_Message (int height, int width, string message) + { + IApplication app = Application.Create (); + app.Init ("fake"); + + try + { + int iterations = -1; + app.Driver!.SetScreenSize (100, 100); + + app.Iteration += (s, a) => + { + iterations++; + + if (iterations == 0) + { + MessageBox.Query (app, height, width, string.Empty, message); + app.RequestStop (); + } + else if (iterations == 1) + { + Assert.IsType (app.TopRunnableView); + Assert.Equal (new (height, width), app.TopRunnableView.Frame.Size); + app.RequestStop (); + } + }; + } + finally + { + app.Dispose (); + } + } + + [Theory (Skip = "Bogus test: Never does anything")] + [InlineData (0, 0, "1")] + [InlineData (1, 1, "1")] + [InlineData (7, 5, "1")] + [InlineData (50, 50, "1")] + [InlineData (0, 0, "message")] + [InlineData (1, 1, "message")] + [InlineData (7, 5, "message")] + [InlineData (50, 50, "message")] + public void Size_Not_Default_Message_Button (int height, int width, string message) + { + IApplication app = Application.Create (); + app.Init ("fake"); + + try + { + int iterations = -1; + + app.Iteration += (s, a) => + { + iterations++; + + if (iterations == 0) + { + MessageBox.Query (app, height, width, string.Empty, message, "_Ok"); + app.RequestStop (); + } + else if (iterations == 1) + { + Assert.IsType (app.TopRunnableView); + Assert.Equal (new (height, width), app.TopRunnableView.Frame.Size); + app.RequestStop (); + } + }; + } + finally + { + app.Dispose (); + } + } + + [Theory (Skip = "Bogus test: Never does anything")] + [InlineData (0, 0)] + [InlineData (1, 1)] + [InlineData (7, 5)] + [InlineData (50, 50)] + public void Size_Not_Default_No_Message (int height, int width) + { + IApplication app = Application.Create (); + app.Init ("fake"); + + try + { + int iterations = -1; + + app.Iteration += (s, a) => + { + iterations++; + + if (iterations == 0) + { + MessageBox.Query (app, height, width, string.Empty, string.Empty); + app.RequestStop (); + } + else if (iterations == 1) + { + Assert.IsType (app.TopRunnableView); + Assert.Equal (new (height, width), app.TopRunnableView.Frame.Size); + app.RequestStop (); + } + }; + } + finally + { + app.Dispose (); + } + } + + [Fact] + public void UICatalog_AboutBox () + { + IApplication app = Application.Create (); + app.Init ("fake"); + + try + { + int iterations = -1; + app.Driver!.SetScreenSize (70, 15); + + // Override CM + MessageBox.DefaultButtonAlignment = Alignment.End; + MessageBox.DefaultBorderStyle = LineStyle.Double; + Dialog.DefaultShadow = ShadowStyle.None; + Button.DefaultShadow = ShadowStyle.None; + + app.Iteration += OnApplicationOnIteration; + + var top = new Runnable (); + top.BorderStyle = LineStyle.Single; + try + { + app.Run (top); + } + finally + { + app.Iteration -= OnApplicationOnIteration; + top.Dispose (); + } + + void OnApplicationOnIteration (object? s, EventArgs a) + { + iterations++; + + if (iterations == 0) + { + MessageBox.Query ( + app, + "", + UICatalogRunnable.GetAboutBoxMessage (), + wrapMessage: false, + buttons: "_Ok"); + + app.RequestStop (); + } + else if (iterations == 2) + { + var expectedText = """ + ┌────────────────────────────────────────────────────────────────────┐ + │ ╔═══════════════════════════════════════════════════════════╗ │ + │ ║UI Catalog: A comprehensive sample library and test app for║ │ + │ ║ ║ │ + │ ║ _______ _ _ _____ _ ║ │ + │ ║|__ __| (_) | | / ____| (_) ║ │ + │ ║ | | ___ _ __ _ __ ___ _ _ __ __ _| || | __ _ _ _ ║ │ + │ ║ | |/ _ \ '__| '_ ` _ \| | '_ \ / _` | || | |_ | | | | | ║ │ + │ ║ | | __/ | | | | | | | | | | | (_| | || |__| | |_| | | ║ │ + │ ║ |_|\___|_| |_| |_| |_|_|_| |_|\__,_|_(_)_____|\__,_|_| ║ │ + │ ║ ║ │ + │ ║ v2 - Pre-Alpha ║ │ + │ ║ ⟦► Ok ◄⟧║ │ + │ ╚═══════════════════════════════════════════════════════════╝ │ + └────────────────────────────────────────────────────────────────────┘ + """; + + DriverAssert.AssertDriverContentsAre (expectedText, output, app.Driver); + + app.RequestStop (); + } + } + } + finally + { + app.Dispose (); + } + } + + [Theory] + [MemberData (nameof (AcceptingKeys))] + public void Button_IsDefault_True_Return_His_Index_On_Accepting (Key key) + { + IApplication app = Application.Create (); + app.Init ("fake"); + + try + { + app.Iteration += OnApplicationOnIteration; + int? res = MessageBox.Query (app, "hey", "IsDefault", "Yes", "No"); + app.Iteration -= OnApplicationOnIteration; + + Assert.Equal (0, res); + + void OnApplicationOnIteration (object? o, EventArgs iterationEventArgs) { Assert.True (app.Keyboard.RaiseKeyDownEvent (key)); } + } + finally + { + app.Dispose (); + } + } + + public static IEnumerable AcceptingKeys () + { + yield return [Key.Enter]; + yield return [Key.Space]; + } +} diff --git a/Tests/UnitTestsParallelizable/Views/NumericUpDownTests.cs b/Tests/UnitTestsParallelizable/Views/NumericUpDownTests.cs index 4a9975244..309b28a06 100644 --- a/Tests/UnitTestsParallelizable/Views/NumericUpDownTests.cs +++ b/Tests/UnitTestsParallelizable/Views/NumericUpDownTests.cs @@ -1,6 +1,6 @@ using System.Globalization; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; public class NumericUpDownTests { @@ -112,7 +112,7 @@ public class NumericUpDownTests public void WhenCreated_ShouldHaveDefaultWidthAndHeight_int () { NumericUpDown numericUpDown = new (); - numericUpDown.SetRelativeLayout (Application.Screen.Size); + numericUpDown.SetRelativeLayout (new (100, 100)); Assert.Equal (3, numericUpDown.Frame.Width); Assert.Equal (1, numericUpDown.Frame.Height); @@ -122,7 +122,7 @@ public class NumericUpDownTests public void WhenCreated_ShouldHaveDefaultWidthAndHeight_float () { NumericUpDown numericUpDown = new (); - numericUpDown.SetRelativeLayout (Application.Screen.Size); + numericUpDown.SetRelativeLayout (new (100, 100)); Assert.Equal (3, numericUpDown.Frame.Width); Assert.Equal (1, numericUpDown.Frame.Height); @@ -132,7 +132,7 @@ public class NumericUpDownTests public void WhenCreated_ShouldHaveDefaultWidthAndHeight_double () { NumericUpDown numericUpDown = new (); - numericUpDown.SetRelativeLayout (Application.Screen.Size); + numericUpDown.SetRelativeLayout (new (100, 100)); Assert.Equal (3, numericUpDown.Frame.Width); Assert.Equal (1, numericUpDown.Frame.Height); @@ -142,7 +142,7 @@ public class NumericUpDownTests public void WhenCreated_ShouldHaveDefaultWidthAndHeight_long () { NumericUpDown numericUpDown = new (); - numericUpDown.SetRelativeLayout (Application.Screen.Size); + numericUpDown.SetRelativeLayout (new (100, 100)); Assert.Equal (3, numericUpDown.Frame.Width); Assert.Equal (1, numericUpDown.Frame.Height); @@ -152,7 +152,7 @@ public class NumericUpDownTests public void WhenCreated_ShouldHaveDefaultWidthAndHeight_decimal () { NumericUpDown numericUpDown = new (); - numericUpDown.SetRelativeLayout (Application.Screen.Size); + numericUpDown.SetRelativeLayout (new (100, 100)); Assert.Equal (3, numericUpDown.Frame.Width); Assert.Equal (1, numericUpDown.Frame.Height); diff --git a/Tests/UnitTestsParallelizable/Views/OptionSelectorTests.cs b/Tests/UnitTestsParallelizable/Views/OptionSelectorTests.cs index 79e8f8420..15532bc8f 100644 --- a/Tests/UnitTestsParallelizable/Views/OptionSelectorTests.cs +++ b/Tests/UnitTestsParallelizable/Views/OptionSelectorTests.cs @@ -1,4 +1,5 @@ -namespace UnitTests_Parallelizable.ViewsTests; +#nullable disable +namespace ViewsTests; public class OptionSelectorTests { diff --git a/Tests/UnitTestsParallelizable/Views/ScrollBarTests.cs b/Tests/UnitTestsParallelizable/Views/ScrollBarTests.cs index fb1011ca0..4f7e428a7 100644 --- a/Tests/UnitTestsParallelizable/Views/ScrollBarTests.cs +++ b/Tests/UnitTestsParallelizable/Views/ScrollBarTests.cs @@ -1,7 +1,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; public class ScrollBarTests { @@ -22,7 +22,7 @@ public class ScrollBarTests [Fact] public void AutoHide_False_Is_Default_CorrectlyHidesAndShows () { - var super = new Toplevel () + var super = new Runnable () { Id = "super", Width = 1, @@ -55,7 +55,7 @@ public class ScrollBarTests [Fact] public void AutoHide_False_CorrectlyHidesAndShows () { - var super = new Toplevel () + var super = new Runnable () { Id = "super", Width = 1, @@ -81,7 +81,7 @@ public class ScrollBarTests [Fact] public void AutoHide_True_Changing_ScrollableContentSize_CorrectlyHidesAndShows () { - var super = new Toplevel () + var super = new Runnable () { Id = "super", Width = 1, @@ -125,7 +125,7 @@ public class ScrollBarTests [Fact] public void AutoHide_Change_VisibleContentSize_CorrectlyHidesAndShows () { - var super = new Toplevel () + var super = new Runnable () { Id = "super", Width = 1, diff --git a/Tests/UnitTestsParallelizable/Views/ScrollSliderTests.cs b/Tests/UnitTestsParallelizable/Views/ScrollSliderTests.cs index 89d9649c1..0cb1785f2 100644 --- a/Tests/UnitTestsParallelizable/Views/ScrollSliderTests.cs +++ b/Tests/UnitTestsParallelizable/Views/ScrollSliderTests.cs @@ -1,8 +1,9 @@ -using Xunit.Abstractions; +using UnitTests; +using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; -public class ScrollSliderTests +public class ScrollSliderTests (ITestOutputHelper output) : FakeDriverBase { [Fact] public void Constructor_Initializes_Correctly () @@ -675,4 +676,339 @@ public class ScrollSliderTests Assert.True (scrollSlider.Position <= 5); } + + + [Theory] + [InlineData ( + 3, + 10, + 1, + 0, + Orientation.Vertical, + @" +┌───┐ +│███│ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +└───┘")] + [InlineData ( + 10, + 1, + 3, + 0, + Orientation.Horizontal, + @" +┌──────────┐ +│███ │ +└──────────┘")] + [InlineData ( + 3, + 10, + 3, + 0, + Orientation.Vertical, + @" +┌───┐ +│███│ +│███│ +│███│ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +│ │ +└───┘")] + + + + [InlineData ( + 3, + 10, + 5, + 0, + Orientation.Vertical, + @" +┌───┐ +│███│ +│███│ +│███│ +│███│ +│███│ +│ │ +│ │ +│ │ +│ │ +│ │ +└───┘")] + + [InlineData ( + 3, + 10, + 5, + 1, + Orientation.Vertical, + @" +┌───┐ +│ │ +│███│ +│███│ +│███│ +│███│ +│███│ +│ │ +│ │ +│ │ +│ │ +└───┘")] + [InlineData ( + 3, + 10, + 5, + 4, + Orientation.Vertical, + @" +┌───┐ +│ │ +│ │ +│ │ +│ │ +│███│ +│███│ +│███│ +│███│ +│███│ +│ │ +└───┘")] + [InlineData ( + 3, + 10, + 5, + 5, + Orientation.Vertical, + @" +┌───┐ +│ │ +│ │ +│ │ +│ │ +│ │ +│███│ +│███│ +│███│ +│███│ +│███│ +└───┘")] + [InlineData ( + 3, + 10, + 5, + 6, + Orientation.Vertical, + @" +┌───┐ +│ │ +│ │ +│ │ +│ │ +│ │ +│███│ +│███│ +│███│ +│███│ +│███│ +└───┘")] + + [InlineData ( + 3, + 10, + 10, + 0, + Orientation.Vertical, + @" +┌───┐ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +└───┘")] + + [InlineData ( + 3, + 10, + 10, + 5, + Orientation.Vertical, + @" +┌───┐ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +└───┘")] + [InlineData ( + 3, + 10, + 11, + 0, + Orientation.Vertical, + @" +┌───┐ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +│███│ +└───┘")] + + [InlineData ( + 10, + 3, + 5, + 0, + Orientation.Horizontal, + @" +┌──────────┐ +│█████ │ +│█████ │ +│█████ │ +└──────────┘")] + + [InlineData ( + 10, + 3, + 5, + 1, + Orientation.Horizontal, + @" +┌──────────┐ +│ █████ │ +│ █████ │ +│ █████ │ +└──────────┘")] + [InlineData ( + 10, + 3, + 5, + 4, + Orientation.Horizontal, + @" +┌──────────┐ +│ █████ │ +│ █████ │ +│ █████ │ +└──────────┘")] + [InlineData ( + 10, + 3, + 5, + 5, + Orientation.Horizontal, + @" +┌──────────┐ +│ █████│ +│ █████│ +│ █████│ +└──────────┘")] + [InlineData ( + 10, + 3, + 5, + 6, + Orientation.Horizontal, + @" +┌──────────┐ +│ █████│ +│ █████│ +│ █████│ +└──────────┘")] + + [InlineData ( + 10, + 3, + 10, + 0, + Orientation.Horizontal, + @" +┌──────────┐ +│██████████│ +│██████████│ +│██████████│ +└──────────┘")] + + [InlineData ( + 10, + 3, + 10, + 5, + Orientation.Horizontal, + @" +┌──────────┐ +│██████████│ +│██████████│ +│██████████│ +└──────────┘")] + [InlineData ( + 10, + 3, + 11, + 0, + Orientation.Horizontal, + @" +┌──────────┐ +│██████████│ +│██████████│ +│██████████│ +└──────────┘")] + public void Draws_Correctly (int superViewportWidth, int superViewportHeight, int sliderSize, int position, Orientation orientation, string expected) + { + IDriver driver = CreateFakeDriver (); + var super = new Window + { + Driver = driver, + Id = "super", + Width = superViewportWidth + 2, + Height = superViewportHeight + 2 + }; + + var scrollSlider = new ScrollSlider + { + Orientation = orientation, + Size = sliderSize, + //Position = position, + }; + Assert.Equal (sliderSize, scrollSlider.Size); + super.Add (scrollSlider); + scrollSlider.Position = position; + + super.Layout (); + super.Draw (); + + _ = DriverAssert.AssertDriverContentsWithFrameAre (expected, output, driver); + } } diff --git a/Tests/UnitTestsParallelizable/Views/SelectorBaseTests.cs b/Tests/UnitTestsParallelizable/Views/SelectorBaseTests.cs index 8077aa277..0f105b356 100644 --- a/Tests/UnitTestsParallelizable/Views/SelectorBaseTests.cs +++ b/Tests/UnitTestsParallelizable/Views/SelectorBaseTests.cs @@ -1,5 +1,5 @@ #nullable enable -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; /// /// Tests for functionality that applies to all selector implementations. diff --git a/Tests/UnitTestsParallelizable/Views/ShortcutTests.cs b/Tests/UnitTestsParallelizable/Views/ShortcutTests.cs index 7866055ca..2e6bfe7fa 100644 --- a/Tests/UnitTestsParallelizable/Views/ShortcutTests.cs +++ b/Tests/UnitTestsParallelizable/Views/ShortcutTests.cs @@ -1,8 +1,7 @@ -using JetBrains.Annotations; +#nullable enable +using JetBrains.Annotations; -namespace UnitTests_Parallelizable.ViewsTests; - -[Collection ("Global Test Setup")] +namespace ViewsTests; [TestSubject (typeof (Shortcut))] public class ShortcutTests @@ -108,7 +107,7 @@ public class ShortcutTests // | C H K | Assert.Equal (expectedWidth, shortcut.Frame.Width); - shortcut = new() + shortcut = new () { HelpText = help, Title = command, @@ -118,7 +117,7 @@ public class ShortcutTests shortcut.Layout (); Assert.Equal (expectedWidth, shortcut.Frame.Width); - shortcut = new() + shortcut = new () { HelpText = help, Key = key, @@ -128,7 +127,7 @@ public class ShortcutTests shortcut.Layout (); Assert.Equal (expectedWidth, shortcut.Frame.Width); - shortcut = new() + shortcut = new () { Key = key, HelpText = help, @@ -299,7 +298,8 @@ public class ShortcutTests [Fact] public void BindKeyToApplication_Can_Be_Set () { - var shortcut = new Shortcut (); + IApplication? app = Application.Create (); + var shortcut = new Shortcut () { App = app }; shortcut.BindKeyToApplication = true; @@ -314,13 +314,16 @@ public class ShortcutTests shortcut.Key = Key.A; Assert.True (shortcut.HotKeyBindings.TryGet (Key.A, out _)); + shortcut.App = Application.Create (); shortcut.BindKeyToApplication = true; + shortcut.BeginInit (); + shortcut.EndInit (); Assert.False (shortcut.HotKeyBindings.TryGet (Key.A, out _)); - Assert.True (Application.KeyBindings.TryGet (Key.A, out _)); + Assert.True (shortcut.App?.Keyboard.KeyBindings.TryGet (Key.A, out _)); shortcut.BindKeyToApplication = false; Assert.True (shortcut.HotKeyBindings.TryGet (Key.A, out _)); - Assert.False (Application.KeyBindings.TryGet (Key.A, out _)); + Assert.False (shortcut.App?.Keyboard.KeyBindings.TryGet (Key.A, out _)); } [Theory] @@ -439,4 +442,54 @@ public class ShortcutTests Assert.False (shortcut.CanFocus); Assert.True (shortcut.CommandView.CanFocus); } + + [Theory (Skip = "Broke somehow!")] + [InlineData (true, KeyCode.A, 1, 1)] + [InlineData (true, KeyCode.C, 1, 1)] + [InlineData (true, KeyCode.C | KeyCode.AltMask, 1, 1)] + [InlineData (true, KeyCode.Enter, 1, 1)] + [InlineData (true, KeyCode.Space, 1, 1)] + [InlineData (true, KeyCode.F1, 0, 0)] + [InlineData (false, KeyCode.A, 1, 1)] + [InlineData (false, KeyCode.C, 1, 1)] + [InlineData (false, KeyCode.C | KeyCode.AltMask, 1, 1)] + [InlineData (false, KeyCode.Enter, 0, 0)] + [InlineData (false, KeyCode.Space, 0, 0)] + [InlineData (false, KeyCode.F1, 0, 0)] + public void KeyDown_CheckBox_Raises_Accepted_Selected (bool canFocus, KeyCode key, int expectedAccept, int expectedSelect) + { + IApplication? app = Application.Create (); + Runnable runnable = new (); + app.Begin (runnable); + + var shortcut = new Shortcut + { + Key = Key.A, + Text = "0", + CommandView = new CheckBox () + { + Title = "_C" + }, + CanFocus = canFocus + }; + runnable.Add (shortcut); + + Assert.Equal (canFocus, shortcut.HasFocus); + + var accepted = 0; + shortcut.Accepting += (s, e) => + { + accepted++; + e.Handled = true; + }; + + var selected = 0; + shortcut.Selecting += (s, e) => selected++; + + app.Keyboard.RaiseKeyDownEvent (key); + + Assert.Equal (expectedAccept, accepted); + Assert.Equal (expectedSelect, selected); + } + } diff --git a/Tests/UnitTestsParallelizable/Views/SliderTests.cs b/Tests/UnitTestsParallelizable/Views/SliderTests.cs index 9e3b8f2f4..9aa71097d 100644 --- a/Tests/UnitTestsParallelizable/Views/SliderTests.cs +++ b/Tests/UnitTestsParallelizable/Views/SliderTests.cs @@ -1,7 +1,7 @@ using System.Text; using UnitTests; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; public class SliderOptionTests : FakeDriverBase { diff --git a/Tests/UnitTestsParallelizable/Views/SpinnerStyleTests.cs b/Tests/UnitTestsParallelizable/Views/SpinnerStyleTests.cs index d230ff962..def4b6399 100644 --- a/Tests/UnitTestsParallelizable/Views/SpinnerStyleTests.cs +++ b/Tests/UnitTestsParallelizable/Views/SpinnerStyleTests.cs @@ -1,5 +1,5 @@ #nullable enable -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; /// /// Parallelizable tests for and its concrete implementations. diff --git a/Tests/UnitTestsParallelizable/Views/TableViewTests.cs b/Tests/UnitTestsParallelizable/Views/TableViewTests.cs index 8fefa1230..a4edfc86f 100644 --- a/Tests/UnitTestsParallelizable/Views/TableViewTests.cs +++ b/Tests/UnitTestsParallelizable/Views/TableViewTests.cs @@ -1,16 +1,200 @@ -using System; -using System.Collections.Generic; -using System.Data; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +using System.Data; +#nullable enable using JetBrains.Annotations; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; [TestSubject (typeof (TableView))] public class TableViewTests { + [Fact] + public void CanTabOutOfTableViewUsingCursor_Left () + { + GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2); + + // Make the selected cell one in + tableView.SelectedColumn = 1; + + // Pressing left should move us to the first column without changing focus + tableView.App!.Keyboard.RaiseKeyDownEvent (Key.CursorLeft); + Assert.Same (tableView, tableView.App!.TopRunnableView!.MostFocused); + Assert.True (tableView.HasFocus); + + // Because we are now on the leftmost cell a further left press should move focus + tableView.App!.Keyboard.RaiseKeyDownEvent (Key.CursorLeft); + + Assert.NotSame (tableView, tableView.App!.TopRunnableView!.MostFocused); + Assert.False (tableView.HasFocus); + + Assert.Same (tf1, tableView.App!.TopRunnableView.MostFocused); + Assert.True (tf1.HasFocus); + } + + [Fact] + public void CanTabOutOfTableViewUsingCursor_Up () + { + GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2); + + // Make the selected cell one in + tableView.SelectedRow = 1; + + // First press should move us up + tableView.App!.Keyboard.RaiseKeyDownEvent (Key.CursorUp); + Assert.Same (tableView, tableView.App!.TopRunnableView!.MostFocused); + Assert.True (tableView.HasFocus); + + // Because we are now on the top row a further press should move focus + tableView.App!.Keyboard.RaiseKeyDownEvent (Key.CursorUp); + + Assert.NotSame (tableView, tableView.App!.TopRunnableView!.MostFocused); + Assert.False (tableView.HasFocus); + + Assert.Same (tf1, tableView.App!.TopRunnableView!.MostFocused); + Assert.True (tf1.HasFocus); + } + + [Fact] + public void CanTabOutOfTableViewUsingCursor_Right () + { + GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2); + + // Make the selected cell one in from the rightmost column + tableView.SelectedColumn = tableView.Table.Columns - 2; + + // First press should move us to the rightmost column without changing focus + tableView.App!.Keyboard.RaiseKeyDownEvent (Key.CursorRight); + Assert.Same (tableView, tableView.App!.TopRunnableView!.MostFocused); + Assert.True (tableView.HasFocus); + + // Because we are now on the rightmost cell, a further right press should move focus + tableView.App!.Keyboard.RaiseKeyDownEvent (Key.CursorRight); + + Assert.NotSame (tableView, tableView.App!.TopRunnableView!.MostFocused); + Assert.False (tableView.HasFocus); + + Assert.Same (tf2, tableView.App!.TopRunnableView!.MostFocused); + Assert.True (tf2.HasFocus); + + } + + [Fact] + public void CanTabOutOfTableViewUsingCursor_Down () + { + GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2); + + // Make the selected cell one in from the bottommost row + tableView.SelectedRow = tableView.Table.Rows - 2; + + // First press should move us to the bottommost row without changing focus + tableView.App!.Keyboard.RaiseKeyDownEvent (Key.CursorDown); + Assert.Same (tableView, tableView.App!.TopRunnableView!.MostFocused); + Assert.True (tableView.HasFocus); + + // Because we are now on the bottommost cell, a further down press should move focus + tableView.App!.Keyboard.RaiseKeyDownEvent (Key.CursorDown); + + Assert.NotSame (tableView, tableView.App!.TopRunnableView!.MostFocused); + Assert.False (tableView.HasFocus); + + Assert.Same (tf2, tableView.App!.TopRunnableView!.MostFocused); + Assert.True (tf2.HasFocus); + } + + [Fact] + public void CanTabOutOfTableViewUsingCursor_Left_ClearsSelectionFirst () + { + GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2); + + // Make the selected cell one in + tableView.SelectedColumn = 1; + + // Pressing shift-left should give us a multi selection + tableView.App!.Keyboard.RaiseKeyDownEvent (Key.CursorLeft.WithShift); + Assert.Same (tableView, tableView.App!.TopRunnableView!.MostFocused); + Assert.True (tableView.HasFocus); + Assert.Equal (2, tableView.GetAllSelectedCells ().Count ()); + + // Because we are now on the leftmost cell a further left press would normally move focus + // However there is an ongoing selection so instead the operation clears the selection and + // gets swallowed (not resulting in a focus change) + tableView.App!.Keyboard.RaiseKeyDownEvent (Key.CursorLeft); + + // Selection 'clears' just to the single cell and we remain focused + Assert.Single (tableView.GetAllSelectedCells ()); + Assert.Same (tableView, tableView.App!.TopRunnableView!.MostFocused); + Assert.True (tableView.HasFocus); + + // A further left will switch focus + tableView.App!.Keyboard.RaiseKeyDownEvent (Key.CursorLeft); + + Assert.NotSame (tableView, tableView.App!.TopRunnableView!.MostFocused); + Assert.False (tableView.HasFocus); + + Assert.Same (tf1, tableView.App!.TopRunnableView!.MostFocused); + Assert.True (tf1.HasFocus); + } + + /// + /// Creates 3 views on with the focus in the + /// . This is a helper method to setup tests that want to + /// explore moving input focus out of a tableview. + /// + /// + /// + /// + private void GetTableViewWithSiblings (out TextField tf1, out TableView tableView, out TextField tf2) + { + IApplication? app = Application.Create (); + Runnable? runnable = new (); + app.Begin (runnable); + + tableView = new (); + + tf1 = new (); + tf2 = new (); + runnable.Add (tf1); + runnable.Add (tableView); + runnable.Add (tf2); + + tableView.SetFocus (); + + Assert.Same (tableView, runnable.MostFocused); + Assert.True (tableView.HasFocus); + + // Set big table + tableView.Table = BuildTable (25, 50); + } + + public static DataTableSource BuildTable (int cols, int rows) => BuildTable (cols, rows, out _); + + /// Builds a simple table of string columns with the requested number of columns and rows + /// + /// + /// + public static DataTableSource BuildTable (int cols, int rows, out DataTable dt) + { + dt = new (); + + for (var c = 0; c < cols; c++) + { + dt.Columns.Add ("Col" + c); + } + + for (var r = 0; r < rows; r++) + { + DataRow newRow = dt.NewRow (); + + for (var c = 0; c < cols; c++) + { + newRow [c] = $"R{r}C{c}"; + } + + dt.Rows.Add (newRow); + } + + return new (dt); + } + [Fact] public void TableView_CollectionNavigatorMatcher_KeybindingsOverrideNavigator () { diff --git a/Tests/UnitTestsParallelizable/Views/TextFieldTests.cs b/Tests/UnitTestsParallelizable/Views/TextFieldTests.cs index a5362f46f..70d3121ab 100644 --- a/Tests/UnitTestsParallelizable/Views/TextFieldTests.cs +++ b/Tests/UnitTestsParallelizable/Views/TextFieldTests.cs @@ -2,7 +2,7 @@ using UnitTests; using Xunit.Abstractions; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; public class TextFieldTests (ITestOutputHelper output) : FakeDriverBase { @@ -51,7 +51,7 @@ public class TextFieldTests (ITestOutputHelper output) : FakeDriverBase tf.Selecting += (sender, args) => Assert.Fail ("Selected should not be raied."); - Toplevel top = new (); + Runnable top = new (); top.Add (tf); tf.SetFocus (); top.NewKeyDownEvent (Key.Space); @@ -67,7 +67,7 @@ public class TextFieldTests (ITestOutputHelper output) : FakeDriverBase var selectingCount = 0; tf.Selecting += (sender, args) => selectingCount++; - Toplevel top = new (); + Runnable top = new (); top.Add (tf); tf.SetFocus (); top.NewKeyDownEvent (Key.Enter); @@ -85,7 +85,7 @@ public class TextFieldTests (ITestOutputHelper output) : FakeDriverBase var acceptedCount = 0; tf.Accepting += (sender, args) => acceptedCount++; - Toplevel top = new (); + Runnable top = new (); top.Add (tf); tf.SetFocus (); top.NewKeyDownEvent (Key.Enter); @@ -118,7 +118,7 @@ public class TextFieldTests (ITestOutputHelper output) : FakeDriverBase return; - void OnAccept (object sender, CommandEventArgs e) { accepted = true; } + void OnAccept (object? sender, CommandEventArgs e) { accepted = true; } } [Fact] @@ -133,7 +133,7 @@ public class TextFieldTests (ITestOutputHelper output) : FakeDriverBase return; - void Accept (object sender, CommandEventArgs e) { accepted = true; } + void Accept (object? sender, CommandEventArgs e) { accepted = true; } } [Fact] @@ -172,7 +172,7 @@ public class TextFieldTests (ITestOutputHelper output) : FakeDriverBase return; - void ButtonAccept (object sender, CommandEventArgs e) { buttonAccept++; } + void ButtonAccept (object? sender, CommandEventArgs e) { buttonAccept++; } } [Fact] @@ -199,7 +199,7 @@ public class TextFieldTests (ITestOutputHelper output) : FakeDriverBase return; - void TextViewAccept (object sender, CommandEventArgs e) + void TextViewAccept (object? sender, CommandEventArgs e) { tfAcceptedInvoked = true; e.Handled = handle; @@ -209,7 +209,7 @@ public class TextFieldTests (ITestOutputHelper output) : FakeDriverBase [Fact] public void OnEnter_Does_Not_Throw_If_Not_IsInitialized_SetCursorVisibility () { - var top = new Toplevel (); + var top = new Runnable (); var tf = new TextField { Width = 10 }; top.Add (tf); @@ -291,7 +291,7 @@ public class TextFieldTests (ITestOutputHelper output) : FakeDriverBase return; - void HandleJKey (object s, Key arg) + void HandleJKey (object? s, Key arg) { if (arg.AsRune == new Rune ('j')) { @@ -622,14 +622,14 @@ public class TextFieldTests (ITestOutputHelper output) : FakeDriverBase string GetContents () { - var item = ""; + var sb = new StringBuilder (); for (var i = 0; i < 16; i++) { - item += driver.Contents [0, i]!.Rune; + sb.Append (driver.Contents! [0, i]!.Grapheme); } - return item; + return sb.ToString (); } } } diff --git a/Tests/UnitTestsParallelizable/Views/TextValidateFieldTests.cs b/Tests/UnitTestsParallelizable/Views/TextValidateFieldTests.cs index d79b6a0c1..d8904f668 100644 --- a/Tests/UnitTestsParallelizable/Views/TextValidateFieldTests.cs +++ b/Tests/UnitTestsParallelizable/Views/TextValidateFieldTests.cs @@ -1,7 +1,7 @@ using System.Text.RegularExpressions; using UnitTests; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; public class TextValidateField_NET_Provider_Tests : FakeDriverBase { @@ -57,7 +57,7 @@ public class TextValidateField_NET_Provider_Tests : FakeDriverBase Assert.True (field.IsValid); var provider = field.Provider as NetMaskedTextProvider; - provider.Mask = "--------(00000000)--------"; + provider!.Mask = "--------(00000000)--------"; Assert.Equal ("--------(1234____)--------", field.Provider.DisplayText); Assert.False (field.IsValid); } diff --git a/Tests/UnitTestsParallelizable/Views/TextViewTests.cs b/Tests/UnitTestsParallelizable/Views/TextViewTests.cs index 8ea0df071..4618865cd 100644 --- a/Tests/UnitTestsParallelizable/Views/TextViewTests.cs +++ b/Tests/UnitTestsParallelizable/Views/TextViewTests.cs @@ -1,6 +1,7 @@ -using System.Text; +#nullable disable +using System.Text; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; public class TextViewTests { @@ -1444,23 +1445,23 @@ public class TextViewTests public void Internal_Tests () { var txt = "This is a text."; - List txtRunes = Cell.StringToCells (txt); - Assert.Equal (txt.Length, txtRunes.Count); - Assert.Equal ('T', txtRunes [0].Rune.Value); - Assert.Equal ('h', txtRunes [1].Rune.Value); - Assert.Equal ('i', txtRunes [2].Rune.Value); - Assert.Equal ('s', txtRunes [3].Rune.Value); - Assert.Equal (' ', txtRunes [4].Rune.Value); - Assert.Equal ('i', txtRunes [5].Rune.Value); - Assert.Equal ('s', txtRunes [6].Rune.Value); - Assert.Equal (' ', txtRunes [7].Rune.Value); - Assert.Equal ('a', txtRunes [8].Rune.Value); - Assert.Equal (' ', txtRunes [9].Rune.Value); - Assert.Equal ('t', txtRunes [10].Rune.Value); - Assert.Equal ('e', txtRunes [11].Rune.Value); - Assert.Equal ('x', txtRunes [12].Rune.Value); - Assert.Equal ('t', txtRunes [13].Rune.Value); - Assert.Equal ('.', txtRunes [^1].Rune.Value); + List txtStrings = Cell.StringToCells (txt); + Assert.Equal (txt.Length, txtStrings.Count); + Assert.Equal ("T", txtStrings [0].Grapheme); + Assert.Equal ("h", txtStrings [1].Grapheme); + Assert.Equal ("i", txtStrings [2].Grapheme); + Assert.Equal ("s", txtStrings [3].Grapheme); + Assert.Equal (" ", txtStrings [4].Grapheme); + Assert.Equal ("i", txtStrings [5].Grapheme); + Assert.Equal ("s", txtStrings [6].Grapheme); + Assert.Equal (" ", txtStrings [7].Grapheme); + Assert.Equal ("a", txtStrings [8].Grapheme); + Assert.Equal (" ", txtStrings [9].Grapheme); + Assert.Equal ("t", txtStrings [10].Grapheme); + Assert.Equal ("e", txtStrings [11].Grapheme); + Assert.Equal ("x", txtStrings [12].Grapheme); + Assert.Equal ("t", txtStrings [13].Grapheme); + Assert.Equal (".", txtStrings [^1].Grapheme); var col = 0; Assert.True (TextModel.SetCol (ref col, 80, 79)); @@ -1469,19 +1470,19 @@ public class TextViewTests var start = 0; var x = 8; - Assert.Equal (8, TextModel.GetColFromX (txtRunes, start, x)); - Assert.Equal ('a', txtRunes [start + x].Rune.Value); + Assert.Equal (8, TextModel.GetColFromX (txtStrings, start, x)); + Assert.Equal ("a", txtStrings [start + x].Grapheme); start = 1; x = 7; - Assert.Equal (7, TextModel.GetColFromX (txtRunes, start, x)); - Assert.Equal ('a', txtRunes [start + x].Rune.Value); + Assert.Equal (7, TextModel.GetColFromX (txtStrings, start, x)); + Assert.Equal ("a", txtStrings [start + x].Grapheme); - Assert.Equal ((15, 15), TextModel.DisplaySize (txtRunes)); - Assert.Equal ((6, 6), TextModel.DisplaySize (txtRunes, 1, 7)); + Assert.Equal ((15, 15), TextModel.DisplaySize (txtStrings)); + Assert.Equal ((6, 6), TextModel.DisplaySize (txtStrings, 1, 7)); - Assert.Equal (0, TextModel.CalculateLeftColumn (txtRunes, 0, 7, 8)); - Assert.Equal (1, TextModel.CalculateLeftColumn (txtRunes, 0, 8, 8)); - Assert.Equal (2, TextModel.CalculateLeftColumn (txtRunes, 0, 9, 8)); + Assert.Equal (0, TextModel.CalculateLeftColumn (txtStrings, 0, 7, 8)); + Assert.Equal (1, TextModel.CalculateLeftColumn (txtStrings, 0, 8, 8)); + Assert.Equal (2, TextModel.CalculateLeftColumn (txtStrings, 0, 9, 8)); var tm = new TextModel (); tm.AddLine (0, Cell.StringToCells ("This is first line.")); @@ -2050,9 +2051,9 @@ public class TextViewTests Assert.True (c1.Equals (c2)); Assert.True (c2.Equals (c1)); - c1.Rune = new ('a'); + c1.Grapheme = new ("a"); c1.Attribute = new (); - c2.Rune = new ('a'); + c2.Grapheme = new ("a"); c2.Attribute = new (); Assert.True (c1.Equals (c2)); Assert.True (c2.Equals (c1)); @@ -2063,13 +2064,13 @@ public class TextViewTests { List cells = new () { - new () { Rune = new ('T') }, - new () { Rune = new ('e') }, - new () { Rune = new ('s') }, - new () { Rune = new ('t') } + new () { Grapheme = new ("T") }, + new () { Grapheme = new ("e") }, + new () { Grapheme = new ("s") }, + new () { Grapheme = new ("t") } }; TextView tv = CreateTextView (); - var top = new Toplevel (); + var top = new Runnable (); top.Add (tv); tv.Load (cells); diff --git a/Tests/UnitTests/Views/TimeFieldTests.cs b/Tests/UnitTestsParallelizable/Views/TimeFieldTests.cs similarity index 87% rename from Tests/UnitTests/Views/TimeFieldTests.cs rename to Tests/UnitTestsParallelizable/Views/TimeFieldTests.cs index a22f82201..2596e307d 100644 --- a/Tests/UnitTests/Views/TimeFieldTests.cs +++ b/Tests/UnitTestsParallelizable/Views/TimeFieldTests.cs @@ -1,6 +1,4 @@ -using UnitTests; - -namespace UnitTests.ViewsTests; +namespace ViewsTests; public class TimeFieldTests { @@ -43,25 +41,34 @@ public class TimeFieldTests } [Fact] - [SetupFakeApplication] public void Copy_Paste () { - var tf1 = new TimeField { Time = TimeSpan.Parse ("12:12:19") }; - var tf2 = new TimeField { Time = TimeSpan.Parse ("12:59:01") }; + IApplication app = Application.Create(); + app.Init("fake"); - // Select all text - Assert.True (tf2.NewKeyDownEvent (Key.End.WithShift)); - Assert.Equal (1, tf2.SelectedStart); - Assert.Equal (8, tf2.SelectedLength); - Assert.Equal (9, tf2.CursorPosition); + try + { + var tf1 = new TimeField { Time = TimeSpan.Parse ("12:12:19"), App = app }; + var tf2 = new TimeField { Time = TimeSpan.Parse ("12:59:01"), App = app }; - // Copy from tf2 - Assert.True (tf2.NewKeyDownEvent (Key.C.WithCtrl)); + // Select all text + Assert.True (tf2.NewKeyDownEvent (Key.End.WithShift)); + Assert.Equal (1, tf2.SelectedStart); + Assert.Equal (8, tf2.SelectedLength); + Assert.Equal (9, tf2.CursorPosition); - // Paste into tf1 - Assert.True (tf1.NewKeyDownEvent (Key.V.WithCtrl)); - Assert.Equal (" 12:59:01", tf1.Text); - Assert.Equal (9, tf1.CursorPosition); + // Copy from tf2 + Assert.True (tf2.NewKeyDownEvent (Key.C.WithCtrl)); + + // Paste into tf1 + Assert.True (tf1.NewKeyDownEvent (Key.V.WithCtrl)); + Assert.Equal (" 12:59:01", tf1.Text); + Assert.Equal (9, tf1.CursorPosition); + } + finally + { + app.Dispose (); + } } [Fact] diff --git a/Tests/UnitTestsParallelizable/Views/TreeViewTests.cs b/Tests/UnitTestsParallelizable/Views/TreeViewTests.cs index 11e16bdf6..e269fc967 100644 --- a/Tests/UnitTestsParallelizable/Views/TreeViewTests.cs +++ b/Tests/UnitTestsParallelizable/Views/TreeViewTests.cs @@ -1,6 +1,6 @@ using JetBrains.Annotations; -namespace UnitTests_Parallelizable.ViewsTests; +namespace ViewsTests; [TestSubject (typeof (TreeView))] public class TreeViewTests diff --git a/Tests/UnitTestsParallelizable/xunit.runner.json b/Tests/UnitTestsParallelizable/xunit.runner.json index 66c35c65f..ba11279f6 100644 --- a/Tests/UnitTestsParallelizable/xunit.runner.json +++ b/Tests/UnitTestsParallelizable/xunit.runner.json @@ -2,5 +2,6 @@ "$schema": "https://xunit.net/schema/current/xunit.runner.schema.json", "parallelizeTestCollections": true, "parallelizeAssembly": true, - "stopOnFail": false + "stopOnFail": false, + "maxParallelThreads": "default" } \ No newline at end of file diff --git a/codecov.yml b/codecov.yml index ea178f7c1..b71daa005 100644 --- a/codecov.yml +++ b/codecov.yml @@ -11,7 +11,7 @@ coverage: # Overall project coverage project: default: - target: 70% # Minimum target coverage + target: 75% # Minimum target coverage threshold: 1% # Allow 1% decrease without failing base: auto # Compare against base branch (v2_develop) if_ci_failed: error # Fail if CI fails diff --git a/docfx/docs/Popovers.md b/docfx/docs/Popovers.md index bfbe549dd..54cc24d10 100644 --- a/docfx/docs/Popovers.md +++ b/docfx/docs/Popovers.md @@ -15,4 +15,4 @@ A `Popover` is any View that meets these characteristics: - Is Transparent (`ViewportSettings = ViewportSettings.Transparent | ViewportSettings.TransparentMouse` - Sets `Visible = false` when it receives `Application.QuitKey` -@Terminal.Gui.Views.PopoverMenu provides a sophisticated implementation that can be used as a context menu and is the basis for @Terminal.Gui.MenuBarv2. \ No newline at end of file +@Terminal.Gui.Views.PopoverMenu provides a sophisticated implementation that can be used as a context menu and is the basis for @Terminal.Gui.MenuBar. \ No newline at end of file diff --git a/docfx/docs/View.md b/docfx/docs/View.md index f65ab2de5..c22585d1e 100644 --- a/docfx/docs/View.md +++ b/docfx/docs/View.md @@ -32,6 +32,8 @@ See the [Views Overview](views.md) for a catalog of all built-in View subclasses - [View.SuperView](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_SuperView) - The View's container (null if the View has no container) - [View.Id](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Id) - Unique identifier for the View (should be unique among siblings) - [View.Data](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Data) - Arbitrary data attached to the View +- [View.App](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_App) - The application context this View belongs to +- [View.Driver](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Driver) - The driver used for rendering (derived from App). This is a shortcut to `App.Driver` for convenience. --- @@ -103,6 +105,8 @@ Views implement [ISupportInitializeNotification](https://docs.microsoft.com/en-u 3. **[EndInit](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_EndInit)** - Signals initialization is complete; raises [View.Initialized](~/api/Terminal.Gui.ViewBase.View.yml) event 4. **[IsInitialized](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_IsInitialized)** - Property indicating if initialization is complete +During initialization, [View.App](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_App) is set to reference the application context, enabling views to access application services like the driver and current session. + ### Disposal Views are [IDisposable](https://docs.microsoft.com/en-us/dotnet/api/system.idisposable): @@ -267,7 +271,7 @@ View view = new () ### 2. Initialization -When a View is added to a SuperView or when [Application.Run](~/api/Terminal.Gui.App.Application.yml#Terminal_Gui_App_Application_Run_Terminal_Gui_Views_Toplevel_System_Func_System_Exception_System_Boolean__) is called: +When a View is added to a SuperView or when [Application.Run](~/api/Terminal.Gui.App.Application.yml#Terminal_Gui_App_Application_Run_Terminal_Gui_Views_Runnable_System_Func_System_Exception_System_Boolean__) is called: 1. [BeginInit](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_BeginInit) is called 2. [EndInit](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_EndInit) is called @@ -554,11 +558,133 @@ view.AddCommand(Command.ScrollDown, () => { view.ScrollVertical(1); return true; --- -## Modal Views +## Runnable Views (IRunnable) -Views can run modally (exclusively capturing all input until closed). See [Toplevel](~/api/Terminal.Gui.Views.Toplevel.yml) for details. +Views can implement [IRunnable](~/api/Terminal.Gui.App.IRunnable.yml) to run as independent, blocking sessions with typed results. This decouples runnability from inheritance, allowing any View to participate in session management. -### Running a View Modally +### IRunnable Architecture + +The **IRunnable** pattern provides: + +- **Interface-Based**: Implement `IRunnable` instead of inheriting from `Runnable` +- **Type-Safe Results**: Generic `TResult` parameter for compile-time type safety +- **Fluent API**: Chain `Init()`, `Run()`, and `Shutdown()` for concise code +- **Automatic Disposal**: Framework manages lifecycle of created runnables +- **CWP Lifecycle Events**: `IsRunningChanging/Changed`, `IsModalChanging/Changed` + +### Creating a Runnable View + +Derive from [Runnable](~/api/Terminal.Gui.ViewBase.Runnable-1.yml) or implement [IRunnable](~/api/Terminal.Gui.App.IRunnable-1.yml): + +```csharp +public class ColorPickerDialog : Runnable +{ + private ColorPicker16 _colorPicker; + + public ColorPickerDialog() + { + Title = "Select a Color"; + + _colorPicker = new ColorPicker16 { X = Pos.Center(), Y = 2 }; + + var okButton = new Button { Text = "OK", IsDefault = true }; + okButton.Accepting += (s, e) => { + Result = _colorPicker.SelectedColor; + Application.RequestStop(); + }; + + Add(_colorPicker, okButton); + } +} +``` + +### Running with Fluent API + +The fluent API enables elegant, concise code with automatic disposal: + +```csharp +// Framework creates, runs, and disposes the runnable automatically +Color? result = Application.Create() + .Init() + .Run() + .Shutdown() as Color?; + +if (result is { }) +{ + Console.WriteLine($"Selected: {result}"); +} +``` + +### Running with Explicit Control + +For more control over the lifecycle: + +```csharp +var app = Application.Create(); +app.Init(); + +var dialog = new ColorPickerDialog(); +app.Run(dialog); + +// Extract result after Run returns +Color? result = dialog.Result; + +// Caller is responsible for disposal +dialog.Dispose(); + +app.Shutdown(); +``` + +### Disposal Semantics + +**"Whoever creates it, owns it":** + +- `Run()`: Framework creates → Framework disposes (in `Shutdown()`) +- `Run(IRunnable)`: Caller creates → Caller disposes + +### Result Extraction + +Extract the result in `OnIsRunningChanging` when stopping: + +```csharp +protected override bool OnIsRunningChanging(bool oldIsRunning, bool newIsRunning) +{ + if (!newIsRunning) // Stopping - extract result before disposal + { + Result = _colorPicker.SelectedColor; + + // Optionally cancel stop (e.g., prompt to save) + if (HasUnsavedChanges()) + { + return true; // Cancel stop + } + } + + return base.OnIsRunningChanging(oldIsRunning, newIsRunning); +} +``` + +### Lifecycle Properties + +- **`IsRunning`** - True when on the `RunnableSessionStack` +- **`IsModal`** - True when at the top of the stack (receiving all input) +- **`Result`** - The typed result value (set before stopping) + +### Lifecycle Events (CWP-Compliant) + +- **`IsRunningChanging`** - Cancellable event before added/removed from stack +- **`IsRunningChanged`** - Non-cancellable event after stack change +- **`IsModalChanged`** - Non-cancellable event after modal state change + +--- + +## Modal Views (Legacy) + +Views can run modally (exclusively capturing all input until closed). See [Runnable](~/api/Terminal.Gui.Views.Runnable.yml) for the legacy pattern. + +**Note:** New code should use `IRunnable` pattern (see above) for better type safety and lifecycle management. + +### Running a View Modally (Legacy) ```csharp var dialog = new Dialog @@ -576,16 +702,17 @@ dialog.Add(label); Application.Run(dialog); // Dialog has been closed +dialog.Dispose(); ``` -### Modal View Types +### Modal View Types (Legacy) -- **[Toplevel](~/api/Terminal.Gui.Views.Toplevel.yml)** - Base class for modal views, can fill entire screen +- **[Runnable](~/api/Terminal.Gui.Views.Runnable.yml)** - Base class for modal views, can fill entire screen - **[Window](~/api/Terminal.Gui.Views.Window.yml)** - Overlapped container with border and title - **[Dialog](~/api/Terminal.Gui.Views.Dialog.yml)** - Modal Window, centered with button support - **[Wizard](~/api/Terminal.Gui.Views.Wizard.yml)** - Multi-step modal dialog -### Dialog Example +### Dialog Example (Legacy) [Dialogs](~/api/Terminal.Gui.Views.Dialog.yml) are Modal [Windows](~/api/Terminal.Gui.Views.Window.yml) centered on screen: @@ -678,6 +805,7 @@ view.ShadowStyle = ShadowStyle.Transparent; ## See Also +- **[Application Deep Dive](application.md)** - Instance-based application architecture - **[Views Overview](views.md)** - Complete list of all built-in Views - **[Layout Deep Dive](layout.md)** - Detailed layout system documentation - **[Drawing Deep Dive](drawing.md)** - Drawing system and color management diff --git a/docfx/docs/application.md b/docfx/docs/application.md new file mode 100644 index 000000000..369488621 --- /dev/null +++ b/docfx/docs/application.md @@ -0,0 +1,879 @@ +# Application Architecture + +Terminal.Gui v2 uses an instance-based application architecture with the **IRunnable** interface pattern that decouples views from the global application state, improving testability, enabling multiple application contexts, and providing type-safe result handling. + +## Key Features + +- **Instance-Based**: Use `Application.Create()` to get an `IApplication` instance instead of static methods +- **IRunnable Interface**: Views implement `IRunnable` to participate in session management without inheriting from `Runnable` +- **Fluent API**: Chain `Init()` and `Run()` for elegant, concise code +- **IDisposable Pattern**: Proper resource cleanup with `Dispose()` or `using` statements +- **Automatic Disposal**: Framework-created runnables are automatically disposed +- **Type-Safe Results**: Generic `TResult` parameter provides compile-time type safety +- **CWP Compliance**: All lifecycle events follow the Cancellable Work Pattern + +## View Hierarchy and Run Stack + +```mermaid +graph TB + subgraph ViewTree["View Hierarchy (SuperView/SubView)"] + direction TB + Top[app.Current
Window] + Menu[MenuBar] + Status[StatusBar] + Content[Content View] + Button1[Button] + Button2[Button] + + Top --> Menu + Top --> Status + Top --> Content + Content --> Button1 + Content --> Button2 + end + + subgraph Stack["app.SessionStack"] + direction TB + S1[Window
Currently Active] + S2[Previous Runnable
Waiting] + S3[Base Runnable
Waiting] + + S1 -.-> S2 -.-> S3 + end + + Top -.->|"same instance"| S1 + + style Top fill:#ccffcc,stroke:#339933,stroke-width:3px + style S1 fill:#ccffcc,stroke:#339933,stroke-width:3px +``` + +## Usage Example Flow + +```mermaid +sequenceDiagram + participant App as IApplication + participant Main as Main Window + participant Dialog as Dialog + + Note over App: Initially empty SessionStack + + App->>Main: Run(mainWindow) + activate Main + Note over App: SessionStack: [Main]
Current: Main + + Main->>Dialog: Run(dialog) + activate Dialog + Note over App: SessionStack: [Dialog, Main]
Current: Dialog + + Dialog->>App: RequestStop() + deactivate Dialog + Note over App: SessionStack: [Main]
Current: Main + + Main->>App: RequestStop() + deactivate Main + Note over App: SessionStack: []
Current: null +``` + +## Key Concepts + +### Instance-Based vs Static + +**Terminal.Gui v2** supports both static and instance-based patterns. The static `Application` class is marked obsolete but still functional for backward compatibility. The recommended pattern is to use `Application.Create()` to get an `IApplication` instance: + +```csharp +// OLD (v1 / early v2 - still works but obsolete): +Application.Init(); +var top = new Window(); +top.Add(myView); +Application.Run(top); +top.Dispose(); +Application.Shutdown(); // Obsolete - use Dispose() instead + +// RECOMMENDED (v2 - instance-based with using statement): +using (var app = Application.Create().Init()) +{ + var top = new Window(); + top.Add(myView); + app.Run(top); + top.Dispose(); +} // app.Dispose() called automatically + +// WITH IRunnable (fluent API with automatic disposal): +using (var app = Application.Create().Init()) +{ + app.Run(); + Color? result = app.GetResult(); +} + +// SIMPLEST (manual disposal): +var app = Application.Create().Init(); +app.Run(); +Color? result = app.GetResult(); +app.Dispose(); +``` + +**Note:** The static `Application` class delegates to `ApplicationImpl.Instance` (a singleton). `Application.Create()` creates a **new** `ApplicationImpl` instance, enabling multiple application contexts and better testability. + +### View.App Property + +Every view now has an `App` property that references its application context: + +```csharp +public class View +{ + /// + /// Gets the application context for this view. + /// + public IApplication? App { get; internal set; } + + /// + /// Gets the application context, checking parent hierarchy if needed. + /// Override to customize application resolution. + /// + public virtual IApplication? GetApp() => App ?? SuperView?.GetApp(); +} +``` + +**Benefits:** +- Views can be tested without `Application.Init()` +- Multiple applications can coexist +- Clear ownership: views know their context +- Reduced global state dependencies + +### Accessing Application from Views + +**Recommended pattern:** + +```csharp +public class MyView : View +{ + public override void OnEnter(View view) + { + // Use View.App instead of static Application + App?.Current?.SetNeedsDraw(); + + // Access SessionStack + if (App?.SessionStack.Count > 0) + { + // Work with sessions + } + } +} +``` + +**Alternative - dependency injection:** + +```csharp +public class MyView : View +{ + private readonly IApplication _app; + + public MyView(IApplication app) + { + _app = app; + // Now completely decoupled from static Application + } + + public void DoWork() + { + _app.Current?.SetNeedsDraw(); + } +} +``` + +## IRunnable Architecture + +Terminal.Gui v2 introduces the **IRunnable** interface pattern that decouples runnable behavior from the `Runnable` class hierarchy. Views can implement `IRunnable` to participate in session management without inheritance constraints. + +### Key Benefits + +- **Interface-Based**: No forced inheritance from `Runnable` +- **Type-Safe Results**: Generic `TResult` parameter provides compile-time type safety +- **Fluent API**: Method chaining for elegant, concise code +- **Automatic Disposal**: Framework manages lifecycle of created runnables +- **CWP Compliance**: All lifecycle events follow the Cancellable Work Pattern + +### Fluent API Pattern + +The fluent API enables elegant method chaining with automatic resource management: + +```csharp +// Recommended: using statement with GetResult +using (var app = Application.Create().Init()) +{ + app.Run(); + Color? result = app.GetResult(); + + if (result is { }) + { + ApplyColor(result); + } +} + +// Alternative: Manual disposal +var app = Application.Create().Init(); +app.Run(); +Color? result = app.GetResult(); +app.Dispose(); + +if (result is { }) +{ + ApplyColor(result); +} +``` + +**Key Methods:** + +- `Init()` - Returns `IApplication` for chaining +- `Run()` - Creates and runs runnable, returns `IApplication` +- `GetResult()` / `GetResult()` - Extract typed result after run +- `Dispose()` - Release all resources (called automatically with `using`) + +### Disposal Semantics + +**"Whoever creates it, owns it":** + +| Method | Creator | Owner | Disposal | +|--------|---------|-------|----------| +| `Run()` | Framework | Framework | Automatic when `Run()` returns | +| `Run(IRunnable)` | Caller | Caller | Manual by caller | + +```csharp +// Framework ownership - automatic disposal +using (var app = Application.Create().Init()) +{ + app.Run(); // Dialog disposed automatically when Run returns + var result = app.GetResult(); +} + +// Caller ownership - manual disposal +using (var app = Application.Create().Init()) +{ + var dialog = new MyDialog(); + app.Run(dialog); + var result = dialog.Result; + dialog.Dispose(); // Caller must dispose +} +``` + +### Creating Runnable Views + +Derive from `Runnable` or implement `IRunnable`: + +```csharp +public class FileDialog : Runnable +{ + private TextField _pathField; + + public FileDialog() + { + Title = "Select File"; + + _pathField = new TextField { X = 1, Y = 1, Width = Dim.Fill(1) }; + + var okButton = new Button { Text = "OK", IsDefault = true }; + okButton.Accepting += (s, e) => { + Result = _pathField.Text; + Application.RequestStop(); + }; + + Add(_pathField, okButton); + } + + protected override bool OnIsRunningChanging(bool oldValue, bool newValue) + { + if (!newValue) // Stopping - extract result before disposal + { + Result = _pathField?.Text; + } + return base.OnIsRunningChanging(oldValue, newValue); + } +} +``` + +### Lifecycle Properties + +- **`IsRunning`** - True when runnable is on `RunnableSessionStack` +- **`IsModal`** - True when runnable is at top of stack (capturing all input) +- **`Result`** - Typed result value set before stopping + +### Lifecycle Events (CWP-Compliant) + +All events follow Terminal.Gui's Cancellable Work Pattern: + +| Event | Cancellable | When | Use Case | +|-------|-------------|------|----------| +| `IsRunningChanging` | ✓ | Before add/remove from stack | Extract result, prevent close | +| `IsRunningChanged` | ✗ | After stack change | Post-start/stop cleanup | +| `IsModalChanged` | ✗ | After modal state change | Update UI after focus change | + +**Example - Result Extraction:** + +```csharp +protected override bool OnIsRunningChanging(bool oldValue, bool newValue) +{ + if (!newValue) // Stopping + { + // Extract result before views are disposed + Result = _colorPicker.SelectedColor; + + // Optionally cancel stop (e.g., unsaved changes) + if (HasUnsavedChanges()) + { + int response = MessageBox.Query("Save?", "Save changes?", "Yes", "No", "Cancel"); + if (response == 2) return true; // Cancel stop + if (response == 0) Save(); + } + } + + return base.OnIsRunningChanging(oldValue, newValue); +} +``` + +### RunnableSessionStack + +The `RunnableSessionStack` manages all running `IRunnable` sessions: + +```csharp +public interface IApplication +{ + /// + /// Stack of running IRunnable sessions. + /// Each entry is a RunnableSessionToken wrapping an IRunnable. + /// + ConcurrentStack? RunnableSessionStack { get; } + + /// + /// The IRunnable at the top of RunnableSessionStack (currently modal). + /// + IRunnable? TopRunnable { get; } +} +``` + +**Stack Behavior:** + +- Push: `Begin(IRunnable)` adds to top of stack +- Pop: `End(RunnableSessionToken)` removes from stack +- Peek: `TopRunnable` returns current modal runnable +- All: `RunnableSessionStack` enumerates all running sessions + +## IApplication Interface + +The `IApplication` interface defines the application contract with support for both legacy `Runnable` and modern `IRunnable` patterns: + +```csharp +public interface IApplication +{ + // IRunnable support (primary) + IRunnable? TopRunnable { get; } + View? TopRunnableView { get; } + ConcurrentStack? SessionStack { get; } + + // Driver and lifecycle + IDriver? Driver { get; } + IMainLoopCoordinator? Coordinator { get; } + + // Fluent API methods + IApplication Init(string? driverName = null); + void Dispose(); // IDisposable + + // Runnable methods + SessionToken? Begin(IRunnable runnable); + object? Run(IRunnable runnable, Func? errorHandler = null); + IApplication Run(Func? errorHandler = null) where TRunnable : IRunnable, new(); + void RequestStop(IRunnable? runnable); + void End(SessionToken sessionToken); + + // Result extraction + object? GetResult(); + T? GetResult() where T : class; + + // ... other members +} +``` + +## Terminology Changes + +Terminal.Gui v2 modernized its terminology for clarity: + +### Application.TopRunnable (formerly "Current", and before that "Top") + +The `TopRunnable` property represents the `IRunnable` on the top of the session stack (the active runnable session): + +```csharp +// Access the top runnable session +IRunnable? topRunnable = app.TopRunnable; + +// From within a view +IRunnable? topRunnable = App?.TopRunnable; + +// Cast to View if needed +View? topView = app.TopRunnableView; +``` + +**Why "TopRunnable"?** +- Clearly indicates it's the top of the runnable session stack +- Aligns with the IRunnable architecture +- Distinguishes from other concepts like "Current" which could be ambiguous +- Works with any view that implements `IRunnable`, not just `Runnable` + +### Application.SessionStack (formerly "Runnables") + +The `SessionStack` property is the stack of running sessions: + +```csharp +// Access all running sessions +foreach (var runnable in app.SessionStack) +{ + // Process each session +} + +// From within a view +int sessionCount = App?.SessionStack.Count ?? 0; +``` + +**Why "SessionStack" instead of "Runnables"?** +- Describes both content (sessions) and structure (stack) +- Aligns with `SessionToken` terminology +- Follows .NET naming patterns (descriptive + collection type) + +## Migration from Static Application + +The static `Application` class delegates to `ApplicationImpl.Instance` (a singleton) and is marked obsolete. All static methods and properties are marked with `[Obsolete]` but remain functional for backward compatibility: + +```csharp +public static partial class Application +{ + [Obsolete("The legacy static Application object is going away.")] + public static View? TopRunnableView => ApplicationImpl.Instance.TopRunnableView; + + [Obsolete("The legacy static Application object is going away.")] + public static IRunnable? TopRunnable => ApplicationImpl.Instance.TopRunnable; + + [Obsolete("The legacy static Application object is going away.")] + public static ConcurrentStack? SessionStack => ApplicationImpl.Instance.SessionStack; + + // ... other obsolete static members +} +``` + +**Important:** The static `Application` class uses a singleton (`ApplicationImpl.Instance`), while `Application.Create()` creates new instances. For new code, prefer the instance-based pattern using `Application.Create()`. + +### Migration Strategies + +**Strategy 1: Use View.App** + +```csharp +// OLD: +void MyMethod() +{ + Application.TopRunnable?.SetNeedsDraw(); +} + +// NEW: +void MyMethod(View view) +{ + view.App?.TopRunnableView?.SetNeedsDraw(); +} +``` + +**Strategy 2: Pass IApplication** + +```csharp +// OLD: +void ProcessSessions() +{ + foreach (var runnable in Application.SessionStack) + { + // Process + } +} + +// NEW: +void ProcessSessions(IApplication app) +{ + foreach (var runnable in app.SessionStack) + { + // Process + } +} +``` + +**Strategy 3: Store IApplication Reference** + +```csharp +public class MyService +{ + private readonly IApplication _app; + + public MyService(IApplication app) + { + _app = app; + } + + public void DoWork() + { + _app.Current?.Title = "Processing..."; + } +} +``` + +## Resource Management and Disposal + +Terminal.Gui v2 implements the `IDisposable` pattern for proper resource cleanup. Applications must be disposed after use to: +- Stop the input thread cleanly +- Release driver resources +- Prevent thread leaks in tests +- Free unmanaged resources + +### Using the `using` Statement (Recommended) + +```csharp +// Automatic disposal with using statement +using (var app = Application.Create().Init()) +{ + app.Run(); + // app.Dispose() automatically called when scope exits +} +``` + +### Manual Disposal + +```csharp +// Manual disposal +var app = Application.Create(); +try +{ + app.Init(); + app.Run(); +} +finally +{ + app.Dispose(); // Ensure cleanup even if exception occurs +} +``` + +### Dispose() and Result Retrieval + +- **`Dispose()`** - Standard IDisposable pattern for resource cleanup (required) +- **`GetResult()`** / **`GetResult()`** - Retrieve results after run completes +- **`Shutdown()`** - Obsolete (use `Dispose()` instead) + +```csharp +// RECOMMENDED (using statement): +using (var app = Application.Create().Init()) +{ + app.Run(); + var result = app.GetResult(); + // app.Dispose() called automatically here +} + +// ALTERNATIVE (manual disposal): +var app = Application.Create().Init(); +app.Run(); +var result = app.GetResult(); +app.Dispose(); // Must call explicitly + +// OLD (obsolete - do not use): +var result = app.Run().Shutdown() as MyResult; +``` + +### Input Thread Lifecycle + +When you call `Init()`, Terminal.Gui starts a dedicated input thread that continuously polls for console input. This thread must be stopped properly: + +```csharp +var app = Application.Create(); +app.Init("fake"); // Input thread starts here + +// Input thread runs in background at ~50 polls/second (20ms throttle) + +app.Dispose(); // Cancels input thread and waits for it to exit +``` + +**Important for Tests**: Always dispose applications in tests to prevent thread leaks: + +```csharp +[Fact] +public void My_Test() +{ + using var app = Application.Create(); + app.Init("fake"); + + // Test code here + + // app.Dispose() called automatically +} +``` + +### Singleton Re-initialization + +The legacy static `Application` singleton can be re-initialized after disposal (for backward compatibility with old tests): + +```csharp +// Test 1 +Application.Init(); +Application.Shutdown(); // Obsolete but still works for legacy singleton + +// Test 2 - singleton resets and can be re-initialized +Application.Init(); // ✅ Works! +Application.Shutdown(); // Obsolete but still works for legacy singleton +``` + +However, instance-based applications follow standard `IDisposable` semantics and cannot be reused after disposal: + +```csharp +var app = Application.Create(); +app.Init(); +app.Dispose(); + +app.Init(); // ❌ Throws ObjectDisposedException +``` + +## Session Management + +### Begin and End + +Applications manage sessions through `Begin()` and `End()`: + +```csharp +using var app = Application.Create (); +app.Init(); + +var window = new Window(); + +// Begin a new session - pushes to SessionStack +SessionToken? token = app.Begin(window); + +// TopRunnable now points to this window +Debug.Assert(app.TopRunnable == window); + +// End the session - pops from SessionStack +if (token != null) +{ + app.End(token); +} + +// TopRunnable restored to previous runnable (if any) +``` + +### Nested Sessions + +Multiple sessions can run nested: + +```csharp +using var app = Application.Create (); +app.Init(); + +// Session 1 +var main = new Window { Title = "Main" }; +var token1 = app.Begin(main); +// app.TopRunnable == main, SessionStack.Count == 1 + +// Session 2 (nested) +var dialog = new Dialog { Title = "Dialog" }; +var token2 = app.Begin(dialog); +// app.TopRunnable == dialog, SessionStack.Count == 2 + +// End dialog +app.End(token2); +// app.TopRunnable == main, SessionStack.Count == 1 + +// End main +app.End(token1); +// app.TopRunnable == null, SessionStack.Count == 0 +``` + +## View.Driver Property + +Similar to `View.App`, views now have a `Driver` property: + +```csharp +public class View +{ + /// + /// Gets the driver for this view. + /// + public IDriver? Driver => GetDriver(); + + /// + /// Gets the driver, checking application context if needed. + /// Override to customize driver resolution. + /// + public virtual IDriver? GetDriver() => App?.Driver; +} +``` + +**Usage:** + +```csharp +public override void OnDrawContent(Rectangle viewport) +{ + // Use view's driver instead of Application.Driver + Driver?.Move(0, 0); + Driver?.AddStr("Hello"); +} +``` + +## Testing with the New Architecture + +The instance-based architecture dramatically improves testability: + +### Testing Views in Isolation + +```csharp +[Fact] +public void MyView_DisplaysCorrectly() +{ + // Create mock application + var mockApp = new Mock(); + mockApp.Setup(a => a.Current).Returns(new Runnable()); + + // Create view with mock app + var view = new MyView { App = mockApp.Object }; + + // Test without Application.Init()! + view.SetNeedsDraw(); + Assert.True(view.NeedsDraw); + + // No Application.Shutdown() needed! +} +``` + +### Testing with Real ApplicationImpl + +```csharp +[Fact] +public void MyView_WorksWithRealApplication() +{ + using var app = Application.Create (); + app.Init("fake"); + + var view = new MyView(); + var top = new Window(); + top.Add(view); + + app.Begin(top); + + // View.App automatically set + Assert.NotNull(view.App); + Assert.Same(app, view.App); + + // Test view behavior + view.DoSomething(); +} +``` + +## Best Practices + +### DO: Use View.App + +```csharp +✅ GOOD: +public void Refresh() +{ + App?.TopRunnableView?.SetNeedsDraw(); +} +``` + +### DON'T: Use Static Application + +```csharp +❌ AVOID: +public void Refresh() +{ + Application.TopRunnableView?.SetNeedsDraw(); // Obsolete! +} +``` + +### DO: Pass IApplication as Dependency + +```csharp +✅ GOOD: +public class Service +{ + public Service(IApplication app) { } +} +``` + +### DON'T: Use Static Application in New Code + +```csharp +❌ AVOID (obsolete pattern): +public void Refresh() +{ + Application.TopRunnableView?.SetNeedsDraw(); // Obsolete static access +} + +✅ PREFERRED: +public void Refresh() +{ + App?.TopRunnableView?.SetNeedsDraw(); // Use View.App property +} +``` + +### DO: Override GetApp() for Custom Resolution + +```csharp +✅ GOOD: +public class SpecialView : View +{ + private IApplication? _customApp; + + public override IApplication? GetApp() + { + return _customApp ?? base.GetApp(); + } +} +``` + +## Advanced Scenarios + +### Multiple Applications + +The instance-based architecture enables multiple applications: + +```csharp +// Application 1 +using var app1 = Application.Create (); +app1.Init("windows"); +var top1 = new Window { Title = "App 1" }; +// ... configure top1 + +// Application 2 (different driver!) +using var app2 = Application.Create (); +app2.Init("unix"); +var top2 = new Window { Title = "App 2" }; +// ... configure top2 + +// Views in top1 use app1 +// Views in top2 use app2 +``` + +### Application-Agnostic Views + +Create views that work with any application: + +```csharp +public class UniversalView : View +{ + public void ShowMessage(string message) + { + // Works regardless of which application context + var app = GetApp(); + if (app != null) + { + var msg = new MessageBox(message); + app.Begin(msg); + } + } +} +``` + +## See Also + +- [Navigation](navigation.md) - Navigation with the instance-based architecture +- [Keyboard](keyboard.md) - Keyboard handling through View.App +- [Mouse](mouse.md) - Mouse handling through View.App +- [Drivers](drivers.md) - Driver access through View.Driver +- [Multitasking](multitasking.md) - Session management with SessionStack diff --git a/docfx/docs/arrangement.md b/docfx/docs/arrangement.md index 06c4dc7d8..c1775e194 100644 --- a/docfx/docs/arrangement.md +++ b/docfx/docs/arrangement.md @@ -376,14 +376,14 @@ See the [Multitasking Deep Dive](multitasking.md) for complete details on modal ### What Makes a View Modal A view is modal when: -- Run via [Application.Run](~/api/Terminal.Gui.App.Application.yml#Terminal_Gui_App_Application_Run_Terminal_Gui_Views_Toplevel_System_Func_System_Exception_System_Boolean__) -- [Toplevel.Modal](~/api/Terminal.Gui.Views.Toplevel.yml#Terminal_Gui_Views_Toplevel_Modal) = `true` +- Run via [Application.Run](~/api/Terminal.Gui.App.Application.yml#Terminal_Gui_App_Application_Run_Terminal_Gui_Views_Runnable_System_Func_System_Exception_System_Boolean__) +- [Runnable.Modal](~/api/Terminal.Gui.Views.Runnable.yml#Terminal_Gui_Views_Runnable_Modal) = `true` ### Modal Characteristics - **Exclusive Input** - All keyboard and mouse input goes to the modal view - **Constrained Z-Order** - Modal view has Z-order of 1, everything else at 0 -- **Blocks Execution** - `Application.Run` blocks until [Application.RequestStop](~/api/Terminal.Gui.App.Application.yml#Terminal_Gui_App_Application_RequestStop_Terminal_Gui_Views_Toplevel_) is called +- **Blocks Execution** - `Application.Run` blocks until [Application.RequestStop](~/api/Terminal.Gui.App.Application.yml#Terminal_Gui_App_Application_RequestStop_Terminal_Gui_Views_Runnable_) is called - **Own RunState** - Each modal view has its own [RunState](~/api/Terminal.Gui.App.RunState.yml) ### Modal View Types @@ -431,13 +431,13 @@ See the [Multitasking Deep Dive](multitasking.md) for complete details. ### Non-Modal Runnable Views ```csharp -var toplevel = new Toplevel +var runnable = new Runnable { Modal = false // Non-modal }; // Runs as independent application -Application.Run(toplevel); +Application.Run(runnable); ``` **Characteristics:** @@ -572,7 +572,7 @@ Application.Shutdown(); ```csharp Application.Init(); -var top = new Toplevel(); +var top = new Runnable(); var leftPane = new FrameView { @@ -606,7 +606,7 @@ Application.Shutdown(); ```csharp Application.Init(); -var desktop = new Toplevel +var desktop = new Runnable { Arrangement = ViewArrangement.Overlapped }; @@ -724,7 +724,7 @@ view.LayoutComplete += (s, e) => - [ViewArrangement](~/api/Terminal.Gui.ViewBase.ViewArrangement.yml) - [Border](~/api/Terminal.Gui.ViewBase.Border.yml) - [Application.ArrangeKey](~/api/Terminal.Gui.App.Application.yml#Terminal_Gui_App_Application_ArrangeKey) -- [Toplevel.Modal](~/api/Terminal.Gui.Views.Toplevel.yml#Terminal_Gui_Views_Toplevel_Modal) +- [Runnable.Modal](~/api/Terminal.Gui.Views.Runnable.yml#Terminal_Gui_Views_Runnable_Modal) ### UICatalog Examples diff --git a/docfx/docs/cancellable-work-pattern.md b/docfx/docs/cancellable-work-pattern.md index b39262d69..aa5f7263a 100644 --- a/docfx/docs/cancellable-work-pattern.md +++ b/docfx/docs/cancellable-work-pattern.md @@ -181,7 +181,7 @@ protected bool? RaiseAccepting(ICommandContext? ctx) #### Propagation Challenge -- `Command.Activate` is local, limiting hierarchical coordination (e.g., `MenuBarv2` popovers). A proposed `PropagatedCommands` property addresses this, as detailed in the appendix. +- `Command.Activate` is local, limiting hierarchical coordination (e.g., `MenuBar` popovers). A proposed `PropagatedCommands` property addresses this, as detailed in the appendix. ### 4. Application.Keyboard: Application-Level Keyboard Input diff --git a/docfx/docs/command.md b/docfx/docs/command.md index 9e6779ca6..41d6ca1cd 100644 --- a/docfx/docs/command.md +++ b/docfx/docs/command.md @@ -10,7 +10,7 @@ The `Command` system in Terminal.Gui provides a standardized framework for defining and executing actions that views can perform, such as selecting items, accepting input, or navigating content. Implemented primarily through the `View.Command` APIs, this system integrates tightly with input handling (e.g., keyboard and mouse events) and leverages the *Cancellable Work Pattern* to ensure extensibility, cancellation, and decoupling. Central to this system are the `Selecting` and `Accepting` events, which encapsulate common user interactions: `Selecting` for changing a view’s state or preparing it for interaction (e.g., toggling a checkbox, focusing a menu item), and `Accepting` for confirming an action or state (e.g., executing a menu command, submitting a dialog). -This deep dive explores the `Command` and `View.Command` APIs, focusing on the `Selecting` and `Accepting` concepts, their implementation, and their propagation behavior. It critically evaluates the need for additional events (`Selected`/`Accepted`) and the propagation of `Selecting` events, drawing on insights from `Menuv2`, `MenuItemv2`, `MenuBarv2`, `CheckBox`, and `FlagSelector`. These implementations highlight the system’s application in hierarchical (menus) and stateful (checkboxes, flag selectors) contexts. The document reflects the current implementation, including the `Cancel` property in `CommandEventArgs` and local handling of `Command.Select`. An appendix briefly summarizes proposed changes from a filed issue to rename `Command.Select` to `Command.Activate`, replace `Cancel` with `Handled`, and introduce a propagation mechanism, addressing limitations in the current system. +This deep dive explores the `Command` and `View.Command` APIs, focusing on the `Selecting` and `Accepting` concepts, their implementation, and their propagation behavior. It critically evaluates the need for additional events (`Selected`/`Accepted`) and the propagation of `Selecting` events, drawing on insights from `Menu`, `MenuItemv2`, `MenuBar`, `CheckBox`, and `FlagSelector`. These implementations highlight the system’s application in hierarchical (menus) and stateful (checkboxes, flag selectors) contexts. The document reflects the current implementation, including the `Cancel` property in `CommandEventArgs` and local handling of `Command.Select`. An appendix briefly summarizes proposed changes from a filed issue to rename `Command.Select` to `Command.Activate`, replace `Cancel` with `Handled`, and introduce a propagation mechanism, addressing limitations in the current system. ## Overview of the Command System @@ -89,7 +89,7 @@ public bool? InvokeCommand(Command command, ICommandContext? ctx) ### Command Routing Most commands route directly to the target view. `Command.Select` and `Command.Accept` have special routing: -- `Command.Select`: Handled locally, with no propagation to superviews, relying on view-specific events (e.g., `SelectedMenuItemChanged` in `Menuv2`) for hierarchical coordination. +- `Command.Select`: Handled locally, with no propagation to superviews, relying on view-specific events (e.g., `SelectedMenuItemChanged` in `Menu`) for hierarchical coordination. - `Command.Accept`: Propagates to a default button (if `IsDefault = true`), superview, or `SuperMenuItem` (in menus). **Example**: `Command.Accept` in `RaiseAccepting`: @@ -170,7 +170,7 @@ These concepts are opinionated, reflecting Terminal.Gui’s view that most UI in } ``` - **OptionSelector**: Selecting an OpitonSelector option raises `Selecting` to update the selected option. - - **Menuv2** and **MenuBarv2**: Selecting a `MenuItemv2` (e.g., via mouse enter or arrow keys) sets focus, tracked by `SelectedMenuItem` and raising `SelectedMenuItemChanged`: + - **Menu** and **MenuBar**: Selecting a `MenuItemv2` (e.g., via mouse enter or arrow keys) sets focus, tracked by `SelectedMenuItem` and raising `SelectedMenuItemChanged`: ```csharp protected override void OnFocusedChanged(View? previousFocused, View? focused) { @@ -196,7 +196,7 @@ These concepts are opinionated, reflecting Terminal.Gui’s view that most UI in ``` - **Views without State**: For views like `Button`, `Selecting` typically sets focus but does not change state, making it less relevant. -- **Propagation**: `Command.Select` is handled locally by the target view. If the command is unhandled (`null` or `false`), processing stops without propagating to the superview or other views. This is evident in `Menuv2`, where `SelectedMenuItemChanged` is used for hierarchical coordination, and in `CheckBox` and `FlagSelector`, where state changes are internal. +- **Propagation**: `Command.Select` is handled locally by the target view. If the command is unhandled (`null` or `false`), processing stops without propagating to the superview or other views. This is evident in `Menu`, where `SelectedMenuItemChanged` is used for hierarchical coordination, and in `CheckBox` and `FlagSelector`, where state changes are internal. ### Accepting - **Definition**: `Accepting` represents a user action that confirms or finalizes a view’s state or triggers an action, such as submitting a dialog, activating a button, or confirming a selection in a list. It is associated with `Command.Accept`, typically triggered by the Enter key or double-click. @@ -211,7 +211,7 @@ These concepts are opinionated, reflecting Terminal.Gui’s view that most UI in - **Button**: Pressing Enter raises `Accepting` to activate the button (e.g., submit a dialog). - **ListView**: Double-clicking or pressing Enter raises `Accepting` to confirm the selected item(s). - **TextField**: Pressing Enter raises `Accepting` to submit the input. - - **Menuv2** and **MenuBarv2**: Pressing Enter on a `MenuItemv2` raises `Accepting` to execute a command or open a submenu, followed by the `Accepted` event to hide the menu or deactivate the menu bar: + - **Menu** and **MenuBar**: Pressing Enter on a `MenuItemv2` raises `Accepting` to execute a command or open a submenu, followed by the `Accepted` event to hide the menu or deactivate the menu bar: ```csharp protected void RaiseAccepted(ICommandContext? ctx) { @@ -230,7 +230,7 @@ These concepts are opinionated, reflecting Terminal.Gui’s view that most UI in - **Propagation**: `Command.Accept` propagates to: - A default button (if present in the superview with `IsDefault = true`). - The superview, enabling hierarchical handling (e.g., a dialog processes `Accept` if no button handles it). - - In `Menuv2`, propagation extends to the `SuperMenuItem` for submenus in popovers, as seen in `OnAccepting`: + - In `Menu`, propagation extends to the `SuperMenuItem` for submenus in popovers, as seen in `OnAccepting`: ```csharp protected override bool OnAccepting(CommandEventArgs args) { @@ -245,7 +245,7 @@ These concepts are opinionated, reflecting Terminal.Gui’s view that most UI in return false; } ``` - - Similarly, `MenuBarv2` customizes propagation to show popovers: + - Similarly, `MenuBar` customizes propagation to show popovers: ```csharp protected override bool OnAccepting(CommandEventArgs args) { @@ -278,7 +278,7 @@ These concepts are opinionated, reflecting Terminal.Gui’s view that most UI in | **Event** | `Selecting` | `Accepting` | | **Virtual Method** | `OnSelecting` | `OnAccepting` | | **Propagation** | Local to the view | Propagates to default button, superview, or SuperMenuItem (in menus) | -| **Use Cases** | `Menuv2`, `MenuBarv2`, `CheckBox`, `FlagSelector`, `ListView`, `Button` | `Menuv2`, `MenuBarv2`, `CheckBox`, `FlagSelector`, `Button`, `ListView`, `Dialog` | +| **Use Cases** | `Menu`, `MenuBar`, `CheckBox`, `FlagSelector`, `ListView`, `Button` | `Menu`, `MenuBar`, `CheckBox`, `FlagSelector`, `Button`, `ListView`, `Dialog` | | **State Dependency** | Often stateful, but includes focus for stateless views | May be stateless (triggers action) | ### Critical Evaluation: Selecting vs. Accepting @@ -287,9 +287,9 @@ The distinction between `Selecting` and `Accepting` is clear in theory: - `Accepting` is about finalizing an action, such as submitting a selection or activating a button. However, practical challenges arise: -- **Overlapping Triggers**: In `ListView`, pressing Enter might both select an item (`Selecting`) and confirm it (`Accepting`), depending on the interaction model, potentially confusing developers. Similarly, in `Menuv2`, navigation (e.g., arrow keys) triggers `Selecting`, while Enter triggers `Accepting`, but the overlap in user intent can blur the lines. +- **Overlapping Triggers**: In `ListView`, pressing Enter might both select an item (`Selecting`) and confirm it (`Accepting`), depending on the interaction model, potentially confusing developers. Similarly, in `Menu`, navigation (e.g., arrow keys) triggers `Selecting`, while Enter triggers `Accepting`, but the overlap in user intent can blur the lines. - **Stateless Views**: For views like `Button` or `MenuItemv2`, `Selecting` is limited to setting focus, which dilutes its purpose as a state-changing action and may confuse developers expecting a more substantial state change. -- **Propagation Limitations**: The local handling of `Command.Select` restricts hierarchical coordination. For example, `MenuBarv2` relies on `SelectedMenuItemChanged` to manage `PopoverMenu` visibility, which is view-specific and not generalizable. This highlights a need for a propagation mechanism that maintains subview-superview decoupling. +- **Propagation Limitations**: The local handling of `Command.Select` restricts hierarchical coordination. For example, `MenuBar` relies on `SelectedMenuItemChanged` to manage `PopoverMenu` visibility, which is view-specific and not generalizable. This highlights a need for a propagation mechanism that maintains subview-superview decoupling. - **FlagSelector Design Flaw**: In `FlagSelector`, the `CheckBox.Selecting` handler incorrectly triggers both `Selecting` and `Accepting`, conflating state changes (toggling flags) with action confirmation (submitting the flag set). This violates the intended separation and requires a design fix to ensure `Selecting` is limited to subview state changes and `Accepting` is reserved for parent-level confirmation. **Recommendation**: Enhance documentation to clarify the `Selecting`/`Accepting` model: @@ -299,13 +299,13 @@ However, practical challenges arise: ## Evaluating Selected/Accepted Events -The need for `Selected` and `Accepted` events is under consideration, with `Accepted` showing utility in specific views (`Menuv2`, `MenuBarv2`) but not universally required across all views. These events would serve as post-events, notifying that a `Selecting` or `Accepting` action has completed, similar to other *Cancellable Work Pattern* post-events like `ClearedViewport` in `View.Draw` or `OrientationChanged` in `OrientationHelper`. +The need for `Selected` and `Accepted` events is under consideration, with `Accepted` showing utility in specific views (`Menu`, `MenuBar`) but not universally required across all views. These events would serve as post-events, notifying that a `Selecting` or `Accepting` action has completed, similar to other *Cancellable Work Pattern* post-events like `ClearedViewport` in `View.Draw` or `OrientationChanged` in `OrientationHelper`. ### Need for Selected/Accepted Events - **Selected Event**: - **Purpose**: A `Selected` event would notify that a `Selecting` action has completed, indicating that a state change or preparatory action (e.g., a new item highlighted, a checkbox toggled) has taken effect. - **Use Cases**: - - **Menuv2** and **MenuBarv2**: Notify when a new `MenuItemv2` is focused, currently handled by the `SelectedMenuItemChanged` event, which tracks focus changes: + - **Menu** and **MenuBar**: Notify when a new `MenuItemv2` is focused, currently handled by the `SelectedMenuItemChanged` event, which tracks focus changes: ```csharp protected override void OnFocusedChanged(View? previousFocused, View? focused) { @@ -366,7 +366,7 @@ The need for `Selected` and `Accepted` events is under consideration, with `Acce ``` - **ListView**: Notify when a new item is selected, typically handled by `SelectedItemChanged` or similar custom events. - **Button**: Less relevant, as `Selecting` typically only sets focus, and no state change occurs to warrant a `Selected` notification. - - **Current Approach**: Views like `Menuv2`, `CheckBox`, and `FlagSelector` use custom events (`SelectedMenuItemChanged`, `CheckedStateChanged`, `ValueChanged`) to signal state changes, bypassing a generic `Selected` event. These view-specific events provide context (e.g., the selected `MenuItemv2`, the new `CheckedState`, or the updated `Value`) that a generic `Selected` event would struggle to convey without additional complexity. + - **Current Approach**: Views like `Menu`, `CheckBox`, and `FlagSelector` use custom events (`SelectedMenuItemChanged`, `CheckedStateChanged`, `ValueChanged`) to signal state changes, bypassing a generic `Selected` event. These view-specific events provide context (e.g., the selected `MenuItemv2`, the new `CheckedState`, or the updated `Value`) that a generic `Selected` event would struggle to convey without additional complexity. - **Pros**: - A standardized `Selected` event could unify state change notifications across views, reducing the need for custom events in some cases. - Aligns with the *Cancellable Work Pattern*’s post-event phase, providing a consistent way to react to completed `Selecting` actions. @@ -376,13 +376,13 @@ The need for `Selected` and `Accepted` events is under consideration, with `Acce - Less relevant for stateless views like `Button`, where `Selecting` only sets focus, leading to inconsistent usage across view types. - Adds complexity to the base `View` class, potentially bloating the API for a feature not universally needed. - Requires developers to handle generic `Selected` events with less specific information, which could lead to more complex event handling logic compared to targeted view-specific events. - - **Context Insight**: The use of `SelectedMenuItemChanged` in `Menuv2` and `MenuBarv2`, `CheckedStateChanged` in `CheckBox`, and `ValueChanged` in `FlagSelector` suggests that view-specific events are preferred for their specificity and context. These events are tailored to the view’s state (e.g., `MenuItemv2` instance, `CheckState`, or `Value`), making them more intuitive for developers than a generic `Selected` event. The absence of a `Selected` event in the current implementation indicates that it hasn’t been necessary for most use cases, as view-specific events adequately cover state change notifications. - - **Verdict**: A generic `Selected` event could provide a standardized way to notify state changes, but its benefits are outweighed by the effectiveness of view-specific events like `SelectedMenuItemChanged`, `CheckedStateChanged`, and `ValueChanged`. These events offer richer context and are sufficient for current use cases across `Menuv2`, `CheckBox`, `FlagSelector`, and other views. Adding `Selected` to the base `View` class is not justified at this time, as it would add complexity without significant advantages over existing mechanisms. + - **Context Insight**: The use of `SelectedMenuItemChanged` in `Menu` and `MenuBar`, `CheckedStateChanged` in `CheckBox`, and `ValueChanged` in `FlagSelector` suggests that view-specific events are preferred for their specificity and context. These events are tailored to the view’s state (e.g., `MenuItemv2` instance, `CheckState`, or `Value`), making them more intuitive for developers than a generic `Selected` event. The absence of a `Selected` event in the current implementation indicates that it hasn’t been necessary for most use cases, as view-specific events adequately cover state change notifications. + - **Verdict**: A generic `Selected` event could provide a standardized way to notify state changes, but its benefits are outweighed by the effectiveness of view-specific events like `SelectedMenuItemChanged`, `CheckedStateChanged`, and `ValueChanged`. These events offer richer context and are sufficient for current use cases across `Menu`, `CheckBox`, `FlagSelector`, and other views. Adding `Selected` to the base `View` class is not justified at this time, as it would add complexity without significant advantages over existing mechanisms. - **Accepted Event**: - **Purpose**: An `Accepted` event would notify that an `Accepting` action has completed (i.e., was not canceled via `args.Cancel`), indicating that the action has taken effect, aligning with the *Cancellable Work Pattern*’s post-event phase. - **Use Cases**: - - **Menuv2** and **MenuBarv2**: The `Accepted` event is critical for signaling that a menu command has been executed or a submenu action has completed, triggering actions like hiding the menu or deactivating the menu bar. In `Menuv2`, it’s raised by `RaiseAccepted` and used hierarchically: + - **Menu** and **MenuBar**: The `Accepted` event is critical for signaling that a menu command has been executed or a submenu action has completed, triggering actions like hiding the menu or deactivating the menu bar. In `Menu`, it’s raised by `RaiseAccepted` and used hierarchically: ```csharp protected void RaiseAccepted(ICommandContext? ctx) { @@ -391,7 +391,7 @@ The need for `Selected` and `Accepted` events is under consideration, with `Acce Accepted?.Invoke(this, args); } ``` - In `MenuBarv2`, it deactivates the menu bar: + In `MenuBar`, it deactivates the menu bar: ```csharp protected override void OnAccepted(CommandEventArgs args) { @@ -408,16 +408,16 @@ The need for `Selected` and `Accepted` events is under consideration, with `Acce - **Button**: Could notify that the button was activated, typically handled by a custom event like `Clicked`. - **ListView**: Could notify that a selection was confirmed (e.g., Enter pressed), often handled by custom events. - **Dialog**: Could notify that an action was completed (e.g., OK button clicked), useful for hierarchical scenarios. - - **Current Approach**: `Menuv2` and `MenuItemv2` implement `Accepted` to signal action completion, with hierarchical handling via subscriptions (e.g., `MenuItemv2.Accepted` triggers `Menuv2.RaiseAccepted`, which triggers `MenuBarv2.OnAccepted`). Other views like `CheckBox` and `FlagSelector` rely on the completion of the `Accepting` event (i.e., not canceled) or custom events (e.g., `Button.Clicked`) to indicate action completion, without a generic `Accepted` event. + - **Current Approach**: `Menu` and `MenuItemv2` implement `Accepted` to signal action completion, with hierarchical handling via subscriptions (e.g., `MenuItemv2.Accepted` triggers `Menu.RaiseAccepted`, which triggers `MenuBar.OnAccepted`). Other views like `CheckBox` and `FlagSelector` rely on the completion of the `Accepting` event (i.e., not canceled) or custom events (e.g., `Button.Clicked`) to indicate action completion, without a generic `Accepted` event. - **Pros**: - - Provides a standardized way to react to confirmed actions, particularly valuable in composite or hierarchical views like `Menuv2`, `MenuBarv2`, and `Dialog`, where superviews need to respond to action completion (e.g., closing a menu or dialog). + - Provides a standardized way to react to confirmed actions, particularly valuable in composite or hierarchical views like `Menu`, `MenuBar`, and `Dialog`, where superviews need to respond to action completion (e.g., closing a menu or dialog). - Aligns with the *Cancellable Work Pattern*’s post-event phase, offering a consistent mechanism for post-action notifications. - Simplifies hierarchical scenarios by providing a unified event for action completion, reducing reliance on view-specific events in some cases. - **Cons**: - - May duplicate existing view-specific events (e.g., `Button.Clicked`, `Menuv2.Accepted`), leading to redundancy in views where custom events are already established. + - May duplicate existing view-specific events (e.g., `Button.Clicked`, `Menu.Accepted`), leading to redundancy in views where custom events are already established. - Adds complexity to the base `View` class, especially for views like `CheckBox` or `FlagSelector` where `Accepting`’s completion is often sufficient without a post-event. - Requires clear documentation to distinguish `Accepted` from `Accepting` and to clarify when it should be used over view-specific events. - - **Context Insight**: The implementation of `Accepted` in `Menuv2` and `MenuBarv2` demonstrates its utility in hierarchical contexts, where it facilitates actions like menu closure or menu bar deactivation. For example, `MenuItemv2` raises `Accepted` to trigger `Menuv2`’s `RaiseAccepted`, which propagates to `MenuBarv2`: + - **Context Insight**: The implementation of `Accepted` in `Menu` and `MenuBar` demonstrates its utility in hierarchical contexts, where it facilitates actions like menu closure or menu bar deactivation. For example, `MenuItemv2` raises `Accepted` to trigger `Menu`’s `RaiseAccepted`, which propagates to `MenuBar`: ```csharp protected void RaiseAccepted(ICommandContext? ctx) { @@ -427,16 +427,16 @@ The need for `Selected` and `Accepted` events is under consideration, with `Acce } ``` In contrast, `CheckBox` and `FlagSelector` do not use `Accepted`, relying on `Accepting`’s completion or view-specific events like `CheckedStateChanged` or `ValueChanged`. This suggests that `Accepted` is particularly valuable in composite views with hierarchical interactions but not universally needed across all views. The absence of `Accepted` in `CheckBox` and `FlagSelector` indicates that `Accepting` is often sufficient for simple confirmation scenarios, but the hierarchical use in menus and potential dialog applications highlight its potential for broader adoption in specific contexts. - - **Verdict**: The `Accepted` event is highly valuable in composite and hierarchical views like `Menuv2`, `MenuBarv2`, and potentially `Dialog`, where it supports coordinated action completion (e.g., closing menus or dialogs). However, adding it to the base `View` class is premature without broader validation across more view types, as many views (e.g., `CheckBox`, `FlagSelector`) function effectively without it, using `Accepting` or custom events. Implementing `Accepted` in specific views or base classes like `Bar` or `Toplevel` (e.g., for menus and dialogs) and reassessing its necessity for the base `View` class later is a prudent approach. This balances the demonstrated utility in hierarchical scenarios with the need to avoid unnecessary complexity in simpler views. + - **Verdict**: The `Accepted` event is highly valuable in composite and hierarchical views like `Menu`, `MenuBar`, and potentially `Dialog`, where it supports coordinated action completion (e.g., closing menus or dialogs). However, adding it to the base `View` class is premature without broader validation across more view types, as many views (e.g., `CheckBox`, `FlagSelector`) function effectively without it, using `Accepting` or custom events. Implementing `Accepted` in specific views or base classes like `Bar` or `Runnable` (e.g., for menus and dialogs) and reassessing its necessity for the base `View` class later is a prudent approach. This balances the demonstrated utility in hierarchical scenarios with the need to avoid unnecessary complexity in simpler views. **Recommendation**: Avoid adding `Selected` or `Accepted` events to the base `View` class for now. Instead: -- Continue using view-specific events (e.g., `Menuv2.SelectedMenuItemChanged`, `CheckBox.CheckedStateChanged`, `FlagSelector.ValueChanged`, `ListView.SelectedItemChanged`, `Button.Clicked`) for their contextual specificity and clarity. -- Maintain and potentially formalize the use of `Accepted` in views like `Menuv2`, `MenuBarv2`, and `Dialog`, tracking its utility to determine if broader adoption in a base class like `Bar` or `Toplevel` is warranted. +- Continue using view-specific events (e.g., `Menu.SelectedMenuItemChanged`, `CheckBox.CheckedStateChanged`, `FlagSelector.ValueChanged`, `ListView.SelectedItemChanged`, `Button.Clicked`) for their contextual specificity and clarity. +- Maintain and potentially formalize the use of `Accepted` in views like `Menu`, `MenuBar`, and `Dialog`, tracking its utility to determine if broader adoption in a base class like `Bar` or `Runnable` is warranted. - If `Selected` or `Accepted` events are added in the future, ensure they fire only when their respective events (`Selecting`, `Accepting`) are not canceled (i.e., `args.Cancel` is `false`), maintaining consistency with the *Cancellable Work Pattern*’s post-event phase. ## Propagation of Selecting -The current implementation of `Command.Select` is local, but `MenuBarv2` requires propagation to manage `PopoverMenu` visibility, highlighting a limitation in the system’s ability to support hierarchical coordination without view-specific mechanisms. +The current implementation of `Command.Select` is local, but `MenuBar` requires propagation to manage `PopoverMenu` visibility, highlighting a limitation in the system’s ability to support hierarchical coordination without view-specific mechanisms. ### Current Behavior - **Selecting**: `Command.Select` is handled locally by the target view, with no propagation to the superview or other views. If the command is unhandled (returns `null` or `false`), processing stops without further routing. @@ -457,7 +457,7 @@ The current implementation of `Command.Select` is local, but `MenuBarv2` require } ``` - **Context Across Views**: - - In `Menuv2`, `Selecting` sets focus and raises `SelectedMenuItemChanged` to track changes, but this is a view-specific mechanism: + - In `Menu`, `Selecting` sets focus and raises `SelectedMenuItemChanged` to track changes, but this is a view-specific mechanism: ```csharp protected override void OnFocusedChanged(View? previousFocused, View? focused) { @@ -466,7 +466,7 @@ The current implementation of `Command.Select` is local, but `MenuBarv2` require RaiseSelectedMenuItemChanged(SelectedMenuItem); } ``` - - In `MenuBarv2`, `SelectedMenuItemChanged` is used to manage `PopoverMenu` visibility, but this relies on custom event handling rather than a generic propagation model: + - In `MenuBar`, `SelectedMenuItemChanged` is used to manage `PopoverMenu` visibility, but this relies on custom event handling rather than a generic propagation model: ```csharp protected override void OnSelectedMenuItemChanged(MenuItemv2? selected) { @@ -481,7 +481,7 @@ The current implementation of `Command.Select` is local, but `MenuBarv2` require - In `Button`, `Selecting` sets focus, which is inherently local. - **Accepting**: `Command.Accept` propagates to a default button (if present), the superview, or a `SuperMenuItem` (in menus), enabling hierarchical handling. - - **Rationale**: `Accepting` often involves actions that affect the broader UI context (e.g., closing a dialog, executing a menu command), requiring coordination with parent views. This is evident in `Menuv2`’s propagation to `SuperMenuItem` and `MenuBarv2`’s handling of `Accepted`: + - **Rationale**: `Accepting` often involves actions that affect the broader UI context (e.g., closing a dialog, executing a menu command), requiring coordination with parent views. This is evident in `Menu`’s propagation to `SuperMenuItem` and `MenuBar`’s handling of `Accepted`: ```csharp protected override void OnAccepting(CommandEventArgs args) { @@ -498,10 +498,10 @@ The current implementation of `Command.Select` is local, but `MenuBarv2` require ``` ### Should Selecting Propagate? -The local handling of `Command.Select` is sufficient for many views, but `MenuBarv2`’s need to manage `PopoverMenu` visibility highlights a gap in the current design, where hierarchical coordination relies on view-specific events like `SelectedMenuItemChanged`. +The local handling of `Command.Select` is sufficient for many views, but `MenuBar`’s need to manage `PopoverMenu` visibility highlights a gap in the current design, where hierarchical coordination relies on view-specific events like `SelectedMenuItemChanged`. - **Arguments For Propagation**: - - **Hierarchical Coordination**: In `MenuBarv2`, propagation would allow the menu bar to react to `MenuItemv2` selections (e.g., focusing a menu item via arrow keys or mouse enter) to show or hide popovers, streamlining the interaction model. Without propagation, `MenuBarv2` depends on `SelectedMenuItemChanged`, which is specific to `Menuv2` and not reusable for other hierarchical components. + - **Hierarchical Coordination**: In `MenuBar`, propagation would allow the menu bar to react to `MenuItemv2` selections (e.g., focusing a menu item via arrow keys or mouse enter) to show or hide popovers, streamlining the interaction model. Without propagation, `MenuBar` depends on `SelectedMenuItemChanged`, which is specific to `Menu` and not reusable for other hierarchical components. - **Consistency with Accepting**: `Command.Accept`’s propagation model supports hierarchical actions (e.g., dialog submission, menu command execution), suggesting that `Command.Select` could benefit from a similar approach to enable broader UI coordination, particularly in complex views like menus or dialogs. - **Future-Proofing**: Propagation could support other hierarchical components, such as `TabView` (coordinating tab selection) or nested dialogs (tracking subview state changes), enhancing the `Command` system’s flexibility for future use cases. @@ -530,7 +530,7 @@ The local handling of `Command.Select` is sufficient for many views, but `MenuBa }; ``` - **Performance and Complexity**: Propagation increases event handling overhead and complicates the API, as superviews must process or ignore `Selecting` events. This could lead to performance issues in deeply nested view hierarchies or views with frequent state changes. - - **Existing Alternatives**: View-specific events like `SelectedMenuItemChanged`, `CheckedStateChanged`, and `ValueChanged` already provide mechanisms for superview coordination, negating the need for generic propagation in many cases. For instance, `MenuBarv2` uses `SelectedMenuItemChanged` to manage popovers, albeit in a view-specific way: + - **Existing Alternatives**: View-specific events like `SelectedMenuItemChanged`, `CheckedStateChanged`, and `ValueChanged` already provide mechanisms for superview coordination, negating the need for generic propagation in many cases. For instance, `MenuBar` uses `SelectedMenuItemChanged` to manage popovers, albeit in a view-specific way: ```csharp protected override void OnSelectedMenuItemChanged(MenuItemv2? selected) { @@ -543,21 +543,21 @@ The local handling of `Command.Select` is sufficient for many views, but `MenuBa Similarly, `CheckBox` and `FlagSelector` use `CheckedStateChanged` and `ValueChanged` to notify superviews or external code of state changes, which is sufficient for most scenarios. - **Semantics of `Cancel`**: Propagation would occur only if `args.Cancel` is `false`, implying an unhandled selection, which is counterintuitive since `Selecting` typically completes its action (e.g., setting focus or toggling a state) within the view. This could confuse developers expecting propagation to occur for all `Selecting` events. -- **Context Insight**: The `MenuBarv2` implementation demonstrates a clear need for propagation to manage `PopoverMenu` visibility, as it must react to `MenuItemv2` selections (e.g., focus changes) across its submenu hierarchy. The reliance on `SelectedMenuItemChanged` works but is specific to `Menuv2`, limiting its applicability to other hierarchical components. In contrast, `CheckBox` and `FlagSelector` show that local handling is adequate for most stateful views, where state changes are self-contained or communicated via view-specific events. `ListView` similarly operates locally, with `SelectedItemChanged` or similar events handling external notifications. `Button`’s focus-based `Selecting` is inherently local, requiring no propagation. This dichotomy suggests that while propagation is critical for certain hierarchical scenarios (e.g., menus), it’s unnecessary for many views, and any propagation mechanism must avoid coupling subviews to superviews to maintain encapsulation. +- **Context Insight**: The `MenuBar` implementation demonstrates a clear need for propagation to manage `PopoverMenu` visibility, as it must react to `MenuItemv2` selections (e.g., focus changes) across its submenu hierarchy. The reliance on `SelectedMenuItemChanged` works but is specific to `Menu`, limiting its applicability to other hierarchical components. In contrast, `CheckBox` and `FlagSelector` show that local handling is adequate for most stateful views, where state changes are self-contained or communicated via view-specific events. `ListView` similarly operates locally, with `SelectedItemChanged` or similar events handling external notifications. `Button`’s focus-based `Selecting` is inherently local, requiring no propagation. This dichotomy suggests that while propagation is critical for certain hierarchical scenarios (e.g., menus), it’s unnecessary for many views, and any propagation mechanism must avoid coupling subviews to superviews to maintain encapsulation. -- **Verdict**: The local handling of `Command.Select` is sufficient for most views, including `CheckBox`, `FlagSelector`, `ListView`, and `Button`, where state changes or preparatory actions are internal or communicated via view-specific events. However, `MenuBarv2`’s requirement for hierarchical coordination to manage `PopoverMenu` visibility highlights a gap in the current design, where view-specific events like `SelectedMenuItemChanged` are used as a workaround. A generic propagation model would enhance flexibility for hierarchical components, but it must ensure that subviews (e.g., `MenuItemv2`) remain decoupled from superviews (e.g., `MenuBarv2`) to avoid implementation-specific dependencies. The current lack of propagation is a limitation, particularly for menus, but adding it requires careful design to avoid overcomplicating the API or impacting performance for views that don’t need it. +- **Verdict**: The local handling of `Command.Select` is sufficient for most views, including `CheckBox`, `FlagSelector`, `ListView`, and `Button`, where state changes or preparatory actions are internal or communicated via view-specific events. However, `MenuBar`’s requirement for hierarchical coordination to manage `PopoverMenu` visibility highlights a gap in the current design, where view-specific events like `SelectedMenuItemChanged` are used as a workaround. A generic propagation model would enhance flexibility for hierarchical components, but it must ensure that subviews (e.g., `MenuItemv2`) remain decoupled from superviews (e.g., `MenuBar`) to avoid implementation-specific dependencies. The current lack of propagation is a limitation, particularly for menus, but adding it requires careful design to avoid overcomplicating the API or impacting performance for views that don’t need it. -**Recommendation**: Maintain the local handling of `Command.Select` for now, as it meets the needs of most views like `CheckBox`, `FlagSelector`, and `ListView`. For `MenuBarv2`, continue using `SelectedMenuItemChanged` as a temporary solution, but prioritize developing a generic propagation mechanism that supports hierarchical coordination without coupling subviews to superviews. This mechanism should allow superviews to opt-in to receiving `Selecting` events from subviews, ensuring encapsulation (see appendix for a proposed solution). +**Recommendation**: Maintain the local handling of `Command.Select` for now, as it meets the needs of most views like `CheckBox`, `FlagSelector`, and `ListView`. For `MenuBar`, continue using `SelectedMenuItemChanged` as a temporary solution, but prioritize developing a generic propagation mechanism that supports hierarchical coordination without coupling subviews to superviews. This mechanism should allow superviews to opt-in to receiving `Selecting` events from subviews, ensuring encapsulation (see appendix for a proposed solution). ## Recommendations for Refining the Design -Based on the analysis of the current `Command` and `View.Command` system, as implemented in `Menuv2`, `MenuBarv2`, `CheckBox`, and `FlagSelector`, the following recommendations aim to refine the system’s clarity, consistency, and flexibility while addressing identified limitations: +Based on the analysis of the current `Command` and `View.Command` system, as implemented in `Menu`, `MenuBar`, `CheckBox`, and `FlagSelector`, the following recommendations aim to refine the system’s clarity, consistency, and flexibility while addressing identified limitations: 1. **Clarify Selecting/Accepting in Documentation**: - Explicitly define `Selecting` as state changes or interaction preparation (e.g., toggling a `CheckBox`, focusing a `MenuItemv2`, selecting a `ListView` item) and `Accepting` as action confirmations (e.g., executing a menu command, submitting a dialog). - Emphasize that `Command.Select` may set focus in stateless views (e.g., `Button`, `MenuItemv2`) but is primarily intended for state changes, to reduce confusion for developers. - - Provide examples for each view type (e.g., `Menuv2`, `CheckBox`, `FlagSelector`, `ListView`, `Button`) to illustrate their distinct roles. For instance: - - `Menuv2`: “`Selecting` focuses a `MenuItemv2` via arrow keys, while `Accepting` executes the selected command.” + - Provide examples for each view type (e.g., `Menu`, `CheckBox`, `FlagSelector`, `ListView`, `Button`) to illustrate their distinct roles. For instance: + - `Menu`: “`Selecting` focuses a `MenuItemv2` via arrow keys, while `Accepting` executes the selected command.” - `CheckBox`: “`Selecting` toggles the `CheckedState`, while `Accepting` confirms the current state.” - `FlagSelector`: “`Selecting` toggles a subview flag, while `Accepting` confirms the entire flag set.” - Document the `Cancel` property’s role in `CommandEventArgs`, noting its current limitation (implying negation rather than completion) and the planned replacement with `Handled` to align with input events like `Key.Handled`. @@ -577,7 +577,7 @@ Based on the analysis of the current `Command` and `View.Command` system, as imp - This ensures `Selecting` only propagates state changes to the parent `FlagSelector` via `RaiseSelecting`, and `Accepting` is triggered separately (e.g., via Enter on the `FlagSelector` itself) to confirm the `Value`. 3. **Enhance ICommandContext with View-Specific State**: - - Enrich `ICommandContext` with a `State` property to include view-specific data (e.g., the selected `MenuItemv2` in `Menuv2`, the new `CheckedState` in `CheckBox`, the updated `Value` in `FlagSelector`). This enables more informed event handlers without requiring view-specific subscriptions. + - Enrich `ICommandContext` with a `State` property to include view-specific data (e.g., the selected `MenuItemv2` in `Menu`, the new `CheckedState` in `CheckBox`, the updated `Value` in `FlagSelector`). This enables more informed event handlers without requiring view-specific subscriptions. - Proposed interface update: ```csharp public interface ICommandContext @@ -588,7 +588,7 @@ Based on the analysis of the current `Command` and `View.Command` system, as imp object? State { get; } // View-specific state (e.g., selected item, CheckState) } ``` - - Example: In `Menuv2`, include the `SelectedMenuItem` in `ICommandContext.State` for `Selecting` handlers: + - Example: In `Menu`, include the `SelectedMenuItem` in `ICommandContext.State` for `Selecting` handlers: ```csharp protected bool? RaiseSelecting(ICommandContext? ctx) { @@ -605,19 +605,19 @@ Based on the analysis of the current `Command` and `View.Command` system, as imp - This enhances the flexibility of event handlers, allowing external code to react to state changes without subscribing to view-specific events like `SelectedMenuItemChanged` or `CheckedStateChanged`. 4. **Monitor Use Cases for Propagation Needs**: - - Track the usage of `Selecting` and `Accepting` in real-world applications, particularly in `Menuv2`, `MenuBarv2`, `CheckBox`, and `FlagSelector`, to identify scenarios where propagation of `Selecting` events could simplify hierarchical coordination. - - Collect feedback on whether the reliance on view-specific events (e.g., `SelectedMenuItemChanged` in `Menuv2`) is sufficient or if a generic propagation model would reduce complexity for hierarchical components like `MenuBarv2`. This will inform the design of a propagation mechanism that maintains subview-superview decoupling (see appendix). + - Track the usage of `Selecting` and `Accepting` in real-world applications, particularly in `Menu`, `MenuBar`, `CheckBox`, and `FlagSelector`, to identify scenarios where propagation of `Selecting` events could simplify hierarchical coordination. + - Collect feedback on whether the reliance on view-specific events (e.g., `SelectedMenuItemChanged` in `Menu`) is sufficient or if a generic propagation model would reduce complexity for hierarchical components like `MenuBar`. This will inform the design of a propagation mechanism that maintains subview-superview decoupling (see appendix). - Example focus areas: - - `MenuBarv2`: Assess whether `SelectedMenuItemChanged` adequately handles `PopoverMenu` visibility or if propagation would streamline the interaction model. + - `MenuBar`: Assess whether `SelectedMenuItemChanged` adequately handles `PopoverMenu` visibility or if propagation would streamline the interaction model. - `Dialog`: Evaluate whether `Selecting` propagation could enhance subview coordination (e.g., tracking checkbox toggles within a dialog). - `TabView`: Consider potential needs for tab selection coordination if implemented in the future. 5. **Improve Propagation for Hierarchical Views**: - - Recognize the limitation in `Command.Select`’s local handling for hierarchical components like `MenuBarv2`, where superviews need to react to subview selections (e.g., focusing a `MenuItemv2` to manage popovers). The current reliance on `SelectedMenuItemChanged` is effective but view-specific, limiting reusability. + - Recognize the limitation in `Command.Select`’s local handling for hierarchical components like `MenuBar`, where superviews need to react to subview selections (e.g., focusing a `MenuItemv2` to manage popovers). The current reliance on `SelectedMenuItemChanged` is effective but view-specific, limiting reusability. - Develop a propagation mechanism that allows superviews to opt-in to receiving `Selecting` events from subviews without requiring subviews to know superview details, ensuring encapsulation. This could involve a new event or property in `View` to enable propagation while maintaining decoupling (see appendix for a proposed solution). - - Example: For `MenuBarv2`, a propagation mechanism could allow it to handle `Selecting` events from `MenuItemv2` subviews to show or hide popovers, replacing the need for `SelectedMenuItemChanged`: + - Example: For `MenuBar`, a propagation mechanism could allow it to handle `Selecting` events from `MenuItemv2` subviews to show or hide popovers, replacing the need for `SelectedMenuItemChanged`: ```csharp - // Current workaround in MenuBarv2 + // Current workaround in MenuBar protected override void OnSelectedMenuItemChanged(MenuItemv2? selected) { if (IsOpen() && selected is MenuBarItemv2 { PopoverMenuOpen: false } selectedMenuBarItem) @@ -628,7 +628,7 @@ Based on the analysis of the current `Command` and `View.Command` system, as imp ``` 6. **Standardize Hierarchical Handling for Accepting**: - - Refine the propagation model for `Command.Accept` to reduce reliance on view-specific logic, such as `Menuv2`’s use of `SuperMenuItem` for submenu propagation. The current approach, while functional, introduces coupling: + - Refine the propagation model for `Command.Accept` to reduce reliance on view-specific logic, such as `Menu`’s use of `SuperMenuItem` for submenu propagation. The current approach, while functional, introduces coupling: ```csharp if (SuperView is null && SuperMenuItem is {}) { @@ -636,9 +636,9 @@ Based on the analysis of the current `Command` and `View.Command` system, as imp } ``` - Explore a more generic mechanism, such as allowing superviews to subscribe to `Accepting` events from subviews, to streamline propagation and improve encapsulation. This could be addressed in conjunction with `Selecting` propagation (see appendix). - - Example: In `Menuv2`, a subscription-based model could replace `SuperMenuItem` logic: + - Example: In `Menu`, a subscription-based model could replace `SuperMenuItem` logic: ```csharp - // Hypothetical subscription in Menuv2 + // Hypothetical subscription in Menu SubViewAdded += (sender, args) => { if (args.View is MenuItemv2 menuItem) @@ -650,15 +650,15 @@ Based on the analysis of the current `Command` and `View.Command` system, as imp ## Conclusion -The `Command` and `View.Command` system in Terminal.Gui provides a robust framework for handling view actions, with `Selecting` and `Accepting` serving as opinionated mechanisms for state changes/preparation and action confirmations. The system is effectively implemented across `Menuv2`, `MenuBarv2`, `CheckBox`, and `FlagSelector`, supporting a range of stateful and stateless interactions. However, limitations in terminology (`Select`’s ambiguity), cancellation semantics (`Cancel`’s misleading implication), and propagation (local `Selecting` handling) highlight areas for improvement. +The `Command` and `View.Command` system in Terminal.Gui provides a robust framework for handling view actions, with `Selecting` and `Accepting` serving as opinionated mechanisms for state changes/preparation and action confirmations. The system is effectively implemented across `Menu`, `MenuBar`, `CheckBox`, and `FlagSelector`, supporting a range of stateful and stateless interactions. However, limitations in terminology (`Select`’s ambiguity), cancellation semantics (`Cancel`’s misleading implication), and propagation (local `Selecting` handling) highlight areas for improvement. -The `Selecting`/`Accepting` distinction is clear in principle but requires careful documentation to avoid confusion, particularly for stateless views where `Selecting` is focus-driven and for views like `FlagSelector` where implementation flaws conflate the two concepts. View-specific events like `SelectedMenuItemChanged`, `CheckedStateChanged`, and `ValueChanged` are sufficient for post-selection notifications, negating the need for a generic `Selected` event. The `Accepted` event is valuable in hierarchical views like `Menuv2` and `MenuBarv2` but not universally required, suggesting inclusion in `Bar` or `Toplevel` rather than `View`. +The `Selecting`/`Accepting` distinction is clear in principle but requires careful documentation to avoid confusion, particularly for stateless views where `Selecting` is focus-driven and for views like `FlagSelector` where implementation flaws conflate the two concepts. View-specific events like `SelectedMenuItemChanged`, `CheckedStateChanged`, and `ValueChanged` are sufficient for post-selection notifications, negating the need for a generic `Selected` event. The `Accepted` event is valuable in hierarchical views like `Menu` and `MenuBar` but not universally required, suggesting inclusion in `Bar` or `Runnable` rather than `View`. -By clarifying terminology, fixing implementation flaws (e.g., `FlagSelector`), enhancing `ICommandContext`, and developing a decoupled propagation model, Terminal.Gui can enhance the `Command` system’s clarity and flexibility, particularly for hierarchical components like `MenuBarv2`. The appendix summarizes proposed changes to address these limitations, aligning with a filed issue to guide future improvements. +By clarifying terminology, fixing implementation flaws (e.g., `FlagSelector`), enhancing `ICommandContext`, and developing a decoupled propagation model, Terminal.Gui can enhance the `Command` system’s clarity and flexibility, particularly for hierarchical components like `MenuBar`. The appendix summarizes proposed changes to address these limitations, aligning with a filed issue to guide future improvements. ## Appendix: Summary of Proposed Changes to Command System -A filed issue proposes enhancements to the `Command` system to address limitations in terminology, cancellation semantics, and propagation, informed by `Menuv2`, `MenuBarv2`, `CheckBox`, and `FlagSelector`. These changes are not yet implemented but aim to improve clarity, consistency, and flexibility. +A filed issue proposes enhancements to the `Command` system to address limitations in terminology, cancellation semantics, and propagation, informed by `Menu`, `MenuBar`, `CheckBox`, and `FlagSelector`. These changes are not yet implemented but aim to improve clarity, consistency, and flexibility. ### Proposed Changes 1. **Rename `Command.Select` to `Command.Activate`**: @@ -672,9 +672,9 @@ A filed issue proposes enhancements to the `Command` system to address limitatio - Impact: Clarifies semantics, requires updating event handlers. 3. **Introduce `PropagateActivating` Event**: - - Add `event EventHandler? PropagateActivating` to `View`, allowing superviews (e.g., `MenuBarv2`) to subscribe to subview propagation requests. - - Rationale: Enables hierarchical coordination (e.g., `MenuBarv2` managing `PopoverMenu` visibility) without coupling subviews to superviews, addressing the current reliance on view-specific events like `SelectedMenuItemChanged`. - - Impact: Enhances flexibility for hierarchical views, requires subscription management in superviews like `MenuBarv2`. + - Add `event EventHandler? PropagateActivating` to `View`, allowing superviews (e.g., `MenuBar`) to subscribe to subview propagation requests. + - Rationale: Enables hierarchical coordination (e.g., `MenuBar` managing `PopoverMenu` visibility) without coupling subviews to superviews, addressing the current reliance on view-specific events like `SelectedMenuItemChanged`. + - Impact: Enhances flexibility for hierarchical views, requires subscription management in superviews like `MenuBar`. ### Benefits - **Clarity**: `Activate` improves terminology for all views. @@ -685,7 +685,7 @@ A filed issue proposes enhancements to the `Command` system to address limitatio ### Implementation Notes - Update `Command` enum, `View`, and derived classes for the rename. - Modify `CommandEventArgs` for `Handled`. -- Implement `PropagateActivating` and test in `MenuBarv2`. +- Implement `PropagateActivating` and test in `MenuBar`. - Revise documentation to reflect changes. For details, refer to the filed issue in the Terminal.Gui repository. \ No newline at end of file diff --git a/docfx/docs/config.md b/docfx/docs/config.md index 48a993033..a6c7a4cc7 100644 --- a/docfx/docs/config.md +++ b/docfx/docs/config.md @@ -231,7 +231,7 @@ ThemeManager.ThemeChanged += (sender, e) => ### Scheme System -A **Scheme** defines the colors and text styles for a specific UI context (e.g., Dialog, Menu, TopLevel). +A **Scheme** defines the colors and text styles for a specific UI context (e.g., Dialog, Menu, Runnable). See the [Scheme Deep Dive](scheme.md) for complete details on the scheme system. @@ -239,7 +239,7 @@ See the [Scheme Deep Dive](scheme.md) for complete details on the scheme system. [Schemes](~/api/Terminal.Gui.Drawing.Schemes.yml) enum defines the standard schemes: -- **TopLevel** - Top-level application windows +- **Runnable** - Top-level application windows - **Base** - Default for most views - **Dialog** - Dialogs and message boxes - **Menu** - Menus and status bars @@ -277,7 +277,7 @@ Each [Scheme](~/api/Terminal.Gui.Drawing.Scheme.yml) maps [VisualRole](~/api/Ter ```json { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "BrightGreen", "Background": "Black", @@ -459,7 +459,8 @@ ThemeManager.ThemeChanged += (sender, e) => { // Theme has changed // Refresh all views to use new theme - Application.Top?.SetNeedsDraw(); + // From within a View, use: App?.Current?.SetNeedsDraw(); + // Or access via IApplication instance: app.Current?.SetNeedsDraw(); }; ``` @@ -575,7 +576,7 @@ A theme is a named collection bundling visual settings and schemes: "Button.DefaultShadow": "Opaque", "Schemes": [ { - "TopLevel": { + "Runnable": { "Normal": { "Foreground": "BrightGreen", "Background": "Black" }, "Focus": { "Foreground": "White", "Background": "Cyan" } }, diff --git a/docfx/docs/cursor.md b/docfx/docs/cursor.md index 3c60b55a1..5b7439910 100644 --- a/docfx/docs/cursor.md +++ b/docfx/docs/cursor.md @@ -51,7 +51,7 @@ It doesn't make sense the every View instance has it's own notion of `MostFocuse * Find all instances of `view._hasFocus = ` and change them to use `SetHasFocus` (today, anyplace that sets `_hasFocus` is a BUG!!). * Change `SetFocus`/`SetHasFocus` etc... such that if the focus is changed to a different view heirarchy, `Application.MostFocusedView` gets set appropriately. -**MORE THOUGHT REQUIRED HERE** - There be dragons given how `Toplevel` has `OnEnter/OnLeave` overrrides. The above needs more study, but is directioally correct. +**MORE THOUGHT REQUIRED HERE** - There be dragons given how `Runnable` has `OnEnter/OnLeave` overrrides. The above needs more study, but is directioally correct. ### `View` Cursor Changes * Add `public Point? CursorPosition` diff --git a/docfx/docs/drawing.md b/docfx/docs/drawing.md index 598ec7a38..a74edf432 100644 --- a/docfx/docs/drawing.md +++ b/docfx/docs/drawing.md @@ -8,7 +8,7 @@ Terminal.Gui provides a set of APIs for formatting text, line drawing, and chara # View Drawing API -Terminal.Gui apps draw using the @Terminal.Gui.ViewBase.View.Move(System.Int32,System.Int32) and @Terminal.Gui.ViewBase.View.AddRune(System.Text.Rune) APIs. Move selects the column and row of the cell and AddRune places the specified glyph in that cell using the @Terminal.Gui.Drawing.Attribute that was most recently set via @Terminal.Gui.ViewBase.View.SetAttribute(Terminal.Gui.Drawing.Attribute). The @Terminal.Gui.Drivers.ConsoleDriver caches all changed Cells and efficiently outputs them to the terminal each iteration of the Application. In other words, Terminal.Gui uses deferred rendering. +Terminal.Gui apps draw using the @Terminal.Gui.ViewBase.View.Move(System.Int32,System.Int32) and @Terminal.Gui.ViewBase.View.AddRune(System.Text.Rune) APIs. Move selects the column and row of the cell and AddRune places the specified glyph in that cell using the @Terminal.Gui.Drawing.Attribute that was most recently set via @Terminal.Gui.ViewBase.View.SetAttribute(Terminal.Gui.Drawing.Attribute). The driver caches all changed Cells and efficiently outputs them to the terminal each iteration of the Application. In other words, Terminal.Gui uses deferred rendering. ## Coordinate System for Drawing @@ -26,7 +26,7 @@ See [Layout](layout.md) for more details of the Terminal.Gui coordinate system. 1) Adding the text to a @Terminal.Gui.Text.TextFormatter object. 2) Setting formatting options, such as @Terminal.Gui.Text.TextFormatter.Alignment. -3) Calling @Terminal.Gui.Text.TextFormatter.Draw(System.Drawing.Rectangle,Terminal.Gui.Drawing.Attribute,Terminal.Gui.Drawing.Attribute,System.Drawing.Rectangle,Terminal.Gui.Drivers.IConsoleDriver). +3) Calling @Terminal.Gui.Text.TextFormatter.Draw(Terminal.Gui.Drivers.IDriver, System.Drawing.Rectangle,Terminal.Gui.Drawing.Attribute,Terminal.Gui.Drawing.Attribute,System.Drawing.Rectangle). ## Line drawing @@ -62,19 +62,17 @@ If a View need to redraw because something changed within it's Content Area it c ## Clipping -Clipping enables better performance and features like transparent margins by ensuring regions of the terminal that need to be drawn actually get drawn by the @Terminal.Gui.Drivers.ConsoleDriver. Terminal.Gui supports non-rectangular clip regions with @Terminal.Gui.Drawing.Region. @Terminal.Gui.Drivers.ConsoleDriver.Clip is the application managed clip region and is managed by @Terminal.Gui.App.Application. Developers cannot change this directly, but can use @Terminal.Gui.ViewBase.View.SetClipToScreen, @Terminal.Gui.ViewBase.View.SetClip(Terminal.Gui.Drawing.Region), @Terminal.Gui.ViewBase.View.SetClipToFrame, etc... +Clipping enables better performance and features like transparent margins by ensuring regions of the terminal that need to be drawn actually get drawn by the driver. Terminal.Gui supports non-rectangular clip regions with @Terminal.Gui.Drawing.Region. The driver.Clip is the application managed clip region and is managed by @Terminal.Gui.App.Application. Developers cannot change this directly, but can use @Terminal.Gui.ViewBase.View.SetClipToScreen, @Terminal.Gui.ViewBase.View.SetClip(Terminal.Gui.Drawing.Region), @Terminal.Gui.ViewBase.View.SetClipToFrame, etc... ## Cell The @Terminal.Gui.Drawing.Cell class represents a single cell on the screen. It contains a character and an attribute. The character is of type `Rune` and the attribute is of type @Terminal.Gui.Drawing.Attribute. -`Cell` is not exposed directly to the developer. Instead, the @Terminal.Gui.Drivers.ConsoleDriver classes manage the `Cell` array that represents the screen. +`Cell` is not exposed directly to the developer. Instead, the driver classes manage the `Cell` array that represents the screen. To draw a `Cell` to the screen, use @Terminal.Gui.ViewBase.View.Move(System.Int32,System.Int32) to specify the row and column coordinates and then use the @Terminal.Gui.ViewBase.View.AddRune(System.Int32,System.Int32,System.Text.Rune) method to draw a single glyph. -// ... existing code ... - ## Attribute The @Terminal.Gui.Drawing.Attribute class represents the formatting attributes of a `Cell`. It exposes properties for the foreground and background colors as well as the text style. The foreground and background colors are of type @Terminal.Gui.Drawing.Color. Bold, underline, and other formatting attributes are supported via the @Terminal.Gui.Drawing.Attribute.Style property. @@ -100,8 +98,6 @@ SetAttributeForRole (VisualRole.Focus); AddStr ("Red on Black Underlined."); ``` -// ... existing code ... - ## VisualRole Represents the semantic visual role of a visual element rendered by a View (e.g., Normal text, Focused item, Active selection). @@ -141,4 +137,30 @@ See [View Deep Dive](View.md) for details. ## Diagnostics -The @Terminal.Gui.ViewBase.ViewDiagnosticFlags.DrawIndicator flag can be set on @Terminal.Gui.ViewBase.View.Diagnostics to cause an animated glyph to appear in the `Border` of each View. The glyph will animate each time that View's `Draw` method is called where either @Terminal.Gui.ViewBase.View.NeedsDraw or @Terminal.Gui.ViewBase.View.SubViewNeedsDraw is set. \ No newline at end of file +The @Terminal.Gui.ViewBase.ViewDiagnosticFlags.DrawIndicator flag can be set on @Terminal.Gui.ViewBase.View.Diagnostics to cause an animated glyph to appear in the `Border` of each View. The glyph will animate each time that View's `Draw` method is called where either @Terminal.Gui.ViewBase.View.NeedsDraw or @Terminal.Gui.ViewBase.View.SubViewNeedsDraw is set. + +## Accessing Application Drawing Context + +Views can access application-level drawing functionality through `View.App`: + +```csharp +public class CustomView : View +{ + protected override bool OnDrawingContent() + { + // Access driver capabilities through View.App + if (App?.Driver?.SupportsTrueColor == true) + { + // Use true color features + SetAttribute(new Attribute(Color.FromRgb(255, 0, 0), Color.FromRgb(0, 0, 255))); + } + else + { + // Fallback to 16-color mode + SetAttributeForRole(VisualRole.Normal); + } + + AddStr("Custom drawing with application context"); + return true; + } +} \ No newline at end of file diff --git a/docfx/docs/drivers.md b/docfx/docs/drivers.md index e8322ebf2..a7f523347 100644 --- a/docfx/docs/drivers.md +++ b/docfx/docs/drivers.md @@ -34,7 +34,7 @@ Application.Init(); // Method 2: Pass driver name to Init Application.Init(driverName: "unix"); -// Method 3: Pass a custom IConsoleDriver instance +// Method 3: Pass a custom IDriver instance var customDriver = new MyCustomDriver(); Application.Init(driver: customDriver); ``` @@ -56,7 +56,7 @@ The v2 driver architecture uses the **Component Factory** pattern to create plat Each driver is composed of specialized components, each with a single responsibility: -#### IConsoleInput<T> +#### IInput<T> Reads raw console input events from the terminal. The generic type `T` represents the platform-specific input type: - `ConsoleKeyInfo` for DotNetDriver and FakeDriver - `WindowsConsole.InputRecord` for WindowsDriver @@ -64,7 +64,7 @@ Reads raw console input events from the terminal. The generic type `T` represent Runs on a dedicated input thread to avoid blocking the UI. -#### IConsoleOutput +#### IOutput Renders the output buffer to the terminal. Handles: - Writing text and ANSI escape sequences - Setting cursor position @@ -88,8 +88,8 @@ Manages the screen buffer and drawing operations: #### IWindowSizeMonitor Detects terminal size changes and raises `SizeChanged` events when the terminal is resized. -#### ConsoleDriverFacade<T> -A unified facade that implements `IConsoleDriver` and coordinates all the components. This is what gets assigned to `Application.Driver`. +#### DriverFacade<T> +A unified facade that implements `IDriver` and coordinates all the components. This is what gets assigned to `Application.Driver`. ### Threading Model @@ -105,22 +105,22 @@ The driver architecture employs a **multi-threaded design** for optimal responsi ├──────────────────┬───────────────────┐ │ │ │ ┌────────▼────────┐ ┌──────▼─────────┐ ┌──────▼──────────┐ - │ Input Thread │ │ Main UI Thread│ │ ConsoleDriver │ + │ Input Thread │ │ Main UI Thread│ │ Driver │ │ │ │ │ │ Facade │ - │ IConsoleInput │ │ ApplicationMain│ │ │ + │ IInput │ │ ApplicationMain│ │ │ │ reads console │ │ Loop processes │ │ Coordinates all │ │ input async │ │ events, layout,│ │ components │ │ into queue │ │ and rendering │ │ │ └─────────────────┘ └────────────────┘ └─────────────────┘ ``` -- **Input Thread**: Started by `MainLoopCoordinator`, runs `IConsoleInput.Run()` which continuously reads console input and queues it into a thread-safe `ConcurrentQueue`. +- **Input Thread**: Started by `MainLoopCoordinator`, runs `IInput.Run()` which continuously reads console input and queues it into a thread-safe `ConcurrentQueue`. - **Main UI Thread**: Runs `ApplicationMainLoop.Iteration()` which: 1. Processes input from the queue via `IInputProcessor` 2. Executes timeout callbacks 3. Checks for UI changes (layout/drawing) - 4. Renders updates via `IConsoleOutput` + 4. Renders updates via `IOutput` This separation ensures that input is never lost and the UI remains responsive during intensive operations. @@ -131,25 +131,25 @@ When you call `Application.Init()`: 1. **ApplicationImpl.Init()** is invoked 2. Creates a `MainLoopCoordinator` with the appropriate `ComponentFactory` 3. **MainLoopCoordinator.StartAsync()** begins: - - Starts the input thread which creates `IConsoleInput` - - Initializes the main UI loop which creates `IConsoleOutput` - - Creates `ConsoleDriverFacade` and assigns to `Application.Driver` + - Starts the input thread which creates `IInput` + - Initializes the main UI loop which creates `IOutput` + - Creates `DriverFacade` and assigns to `IApplication.Driver` - Waits for both threads to be ready 4. Returns control to the application ### Shutdown Flow -When `Application.Shutdown()` is called: +When `IApplication.Shutdown()` is called: 1. Cancellation token is triggered 2. Input thread exits its read loop -3. `IConsoleOutput` is disposed +3. `IOutput` is disposed 4. Main thread waits for input thread to complete 5. All resources are cleaned up ## Component Interfaces -### IConsoleDriver +### IDriver The main driver interface that the framework uses internally. Provides: @@ -167,16 +167,6 @@ The main driver interface that the framework uses internally. Provides: - Use @Terminal.Gui.ViewBase.View.AddRune and @Terminal.Gui.ViewBase.View.AddStr for drawing - ViewBase infrastructure classes (in `Terminal.Gui/ViewBase/`) can access Driver when needed for framework implementation -### IConsoleDriverFacade - -Extended interface for v2 drivers that exposes the internal components: - -- `IInputProcessor InputProcessor` -- `IOutputBuffer OutputBuffer` -- `IWindowSizeMonitor WindowSizeMonitor` - -This interface allows advanced scenarios and testing. - ## Platform-Specific Details ### DotNetDriver (NetComponentFactory) @@ -219,79 +209,13 @@ This ensures Terminal.Gui applications can be debugged directly in Visual Studio - Uses `FakeConsole` for all operations - Allows injection of predefined input - Captures output for verification -- Always used when `Application._forceFakeConsole` is true - -## Example: Checking Driver Capabilities - -```csharp -Application.Init(); - -// The driver is internal - access through Application properties -// Check screen dimensions -var screenWidth = Application.Screen.Width; -var screenHeight = Application.Screen.Height; - -// Check if 24-bit color is supported -bool supportsTrueColor = Application.Driver?.SupportsTrueColor ?? false; - -// Access advanced components (for framework/infrastructure code only) -if (Application.Driver is IConsoleDriverFacade facade) -{ - // Access individual components for advanced scenarios - IInputProcessor inputProcessor = facade.InputProcessor; - IOutputBuffer outputBuffer = facade.OutputBuffer; - IWindowSizeMonitor sizeMonitor = facade.WindowSizeMonitor; - - // Use components for advanced scenarios - sizeMonitor.SizeChanging += (s, e) => - { - Console.WriteLine($"Terminal resized to {e.Size}"); - }; -} -``` +- Always used when `IApplication.ForceDriver` is `fake` **Important:** View subclasses should not access `Application.Driver`. Use the View APIs instead: - `View.Move(col, row)` for positioning - `View.AddRune()` and `View.AddStr()` for drawing -- `Application.Screen` for screen dimensions +- `View.App.Screen` for screen dimensions -## Custom Drivers - -To create a custom driver, implement `IComponentFactory`: - -```csharp -public class MyComponentFactory : ComponentFactory -{ - public override IConsoleInput CreateInput() - { - return new MyConsoleInput(); - } - - public override IConsoleOutput CreateOutput() - { - return new MyConsoleOutput(); - } - - public override IInputProcessor CreateInputProcessor( - ConcurrentQueue inputBuffer) - { - return new MyInputProcessor(inputBuffer); - } -} -``` - -Then use it: - -```csharp -ApplicationImpl.ChangeComponentFactory(new MyComponentFactory()); -Application.Init(); -``` - -## Legacy Drivers - -Terminal.Gui v1 drivers that implement `IConsoleDriver` but not `IConsoleDriverFacade` are still supported through a legacy compatibility layer. However, they do not benefit from the v2 architecture improvements (multi-threading, component separation, etc.). - -**Note**: The legacy `MainLoop` infrastructure (including the `MainLoop` class, `IMainLoopDriver` interface, and `FakeMainLoop`) has been removed in favor of the modern architecture. All drivers now use the `MainLoopCoordinator` and `ApplicationMainLoop` system exclusively. ## See Also diff --git a/docfx/docs/events.md b/docfx/docs/events.md index 52f6363d7..88e7a457c 100644 --- a/docfx/docs/events.md +++ b/docfx/docs/events.md @@ -350,7 +350,7 @@ TG follows the *naming* advice provided in [.NET Naming Guidelines - Names of Ev ### Proposed Enhancement: Command Propagation -The *Cancellable Work Pattern* in `View.Command` currently supports local `Command.Activate` and propagating `Command.Accept`. To address hierarchical coordination needs (e.g., `MenuBarv2` popovers, `Dialog` closing), a `PropagatedCommands` property is proposed (Issue #4050): +The *Cancellable Work Pattern* in `View.Command` currently supports local `Command.Activate` and propagating `Command.Accept`. To address hierarchical coordination needs (e.g., `MenuBar` popovers, `Dialog` closing), a `PropagatedCommands` property is proposed (Issue #4050): - **Change**: Add `IReadOnlyList PropagatedCommands` to `View`, defaulting to `[Command.Accept]`. `Raise*` methods propagate if the command is in `SuperView?.PropagatedCommands` and `args.Handled` is `false`. - **Example**: @@ -373,7 +373,7 @@ The *Cancellable Work Pattern* in `View.Command` currently supports local `Comma } ``` -- **Impact**: Enables `Command.Activate` propagation for `MenuBarv2` while preserving `Command.Accept` propagation, maintaining decoupling and avoiding noise from irrelevant commands. +- **Impact**: Enables `Command.Activate` propagation for `MenuBar` while preserving `Command.Accept` propagation, maintaining decoupling and avoiding noise from irrelevant commands. ### **Conflation in FlagSelector**: - **Issue**: `CheckBox.Activating` triggers `Accepting`, conflating state change and confirmation. @@ -389,7 +389,7 @@ The *Cancellable Work Pattern* in `View.Command` currently supports local `Comma ``` ### **Propagation Limitations**: - - **Issue**: Local `Command.Activate` restricts `MenuBarv2` coordination; `Command.Accept` uses hacks (#3925). + - **Issue**: Local `Command.Activate` restricts `MenuBar` coordination; `Command.Accept` uses hacks (#3925). - **Recommendation**: Adopt `PropagatedCommands` to enable targeted propagation, as proposed. ### **Complexity in Multi-Phase Workflows**: diff --git a/docfx/docs/getting-started.md b/docfx/docs/getting-started.md index caaa45c9e..e764ff129 100644 --- a/docfx/docs/getting-started.md +++ b/docfx/docs/getting-started.md @@ -25,10 +25,19 @@ Use the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.template ## Sample Usage in C# -The following example shows a basic Terminal.Gui application in C# (this is `./Example/Example.cs`): +The following example shows a basic Terminal.Gui application using the modern instance-based model (this is `./Example/Example.cs`): [!code-csharp[Program.cs](../../Examples/Example/Example.cs)] +### Key aspects of the modern model: + +- Use `Application.Create()` to create an `IApplication` instance +- The application initializes automatically when you call `Run()` +- Use `app.Run()` to run a window that implements `IRunnable` +- Call `app.Dispose()` to clean up resources and restore the terminal +- Event handling uses `Accepting` event instead of legacy `Accept` event +- Set `e.Handled = true` in event handlers to prevent further processing + When run the application looks as follows: ![Simple Usage app](../images/Example.png) diff --git a/docfx/docs/index.md b/docfx/docs/index.md index 830ec3c19..437d34ffc 100644 --- a/docfx/docs/index.md +++ b/docfx/docs/index.md @@ -13,10 +13,13 @@ Welcome to the Terminal.Gui documentation! This comprehensive guide covers every - [Getting Started](~/docs/getting-started.md) - Quick start guide to create your first Terminal.Gui application - [Migrating from v1 to v2](~/docs/migratingfromv1.md) - Complete guide for upgrading existing applications - [What's New in v2](~/docs/newinv2.md) - Overview of new features and improvements +- [Showcase](~/docs/showcase.md) - Showcase of TUI apps built with Terminal.Gui ## Deep Dives - [ANSI Response Parser](~/docs/ansiparser.md) - Terminal sequence parsing and state management +- [Application](~/docs/application.md) - Application lifecycle, initialization, and main loop +- [Arrangement](~/docs/arrangement.md) - View arrangement and positioning strategies - [Cancellable Work Pattern](~/docs/cancellable-work-pattern.md) - Core design pattern for extensible workflows - [Character Map Scenario](~/docs/CharacterMap.md) - Complex drawing, scrolling, and Unicode rendering example - [Command System](~/docs/command.md) - Command execution, key bindings, and the Selecting/Accepting concepts @@ -24,6 +27,7 @@ Welcome to the Terminal.Gui documentation! This comprehensive guide covers every - [Cross-Platform Driver Model](~/docs/drivers.md) - Platform abstraction and console driver architecture - [Cursor System](~/docs/cursor.md) - Modern cursor management and positioning (proposed design) - [Dim.Auto](~/docs/dimauto.md) - Automatic view sizing based on content +- [Drawing](~/docs/drawing.md) - Drawing primitives, rendering, and graphics operations - [Events](~/docs/events.md) - Event patterns and handling throughout the framework - [Keyboard Input](~/docs/keyboard.md) - Key handling, bindings, commands, and shortcuts - [Layout System](~/docs/layout.md) - View positioning, sizing, and arrangement @@ -33,7 +37,11 @@ Welcome to the Terminal.Gui documentation! This comprehensive guide covers every - [Mouse Input](~/docs/mouse.md) - Mouse event handling and interaction patterns - [Navigation](~/docs/navigation.md) - Focus management, keyboard navigation, and accessibility - [Popovers](~/docs/Popovers.md) - Drawing outside viewport boundaries for menus and popups +- [Scheme](~/docs/scheme.md) - Color schemes, styling, and visual theming - [Scrolling](~/docs/scrolling.md) - Built-in scrolling, virtual content areas, and scroll bars +- [TableView](~/docs/tableview.md) - Table view component, data binding, and column management +- [TreeView](~/docs/treeview.md) - Tree view component, hierarchical data, and node management +- [View](~/docs/View.md) - Base view class, view hierarchy, and core view functionality ## API Reference diff --git a/docfx/docs/keyboard.md b/docfx/docs/keyboard.md index 14071f69c..74f36ff8c 100644 --- a/docfx/docs/keyboard.md +++ b/docfx/docs/keyboard.md @@ -61,7 +61,7 @@ Key Bindings can be added at the `Application` or `View` level. For **Application-scoped Key Bindings** there are two categories of Application-scoped Key Bindings: -1) **Application Command Key Bindings** - Bindings for `Command`s supported by @Terminal.Gui.App.Application. For example, @Terminal.Gui.App.Application.QuitKey, which is bound to `Command.Quit` and results in @Terminal.Gui.App.Application.RequestStop(Terminal.Gui.Views.Toplevel) being called. +1) **Application Command Key Bindings** - Bindings for `Command`s supported by @Terminal.Gui.App.Application. For example, @Terminal.Gui.App.Application.QuitKey, which is bound to `Command.Quit` and results in @Terminal.Gui.App.Application.RequestStop(Terminal.Gui.Views.Runnable) being called. 2) **Application Key Bindings** - Bindings for `Command`s supported on arbitrary `Views` that are meant to be invoked regardless of which part of the application is visible/active. Use @Terminal.Gui.App.Application.Keyboard.KeyBindings to add or modify Application-scoped Key Bindings. For backward compatibility, @Terminal.Gui.App.Application.KeyBindings also provides access to the same key bindings. @@ -91,13 +91,13 @@ The Command can be invoked even if the `View` that defines them is not focused o ### **Key Events** -Keyboard events are retrieved from [Console Drivers](drivers.md) each iteration of the [Application](~/api/Terminal.Gui.App.Application.yml) [Main Loop](multitasking.md). The console driver raises the @Terminal.Gui.Drivers.ConsoleDriver.KeyDown and @Terminal.Gui.Drivers.ConsoleDriver.KeyUp events which invoke @Terminal.Gui.App.Application.RaiseKeyDownEvent* and @Terminal.Gui.App.Application.RaiseKeyUpEvent(Terminal.Gui.Input.Key) respectively. +Keyboard events are retrieved from [Drivers](drivers.md) each iteration of the [Application](~/api/Terminal.Gui.App.Application.yml) [Main Loop](multitasking.md). The driver raises the @Terminal.Gui.Drivers.IDriver.KeyDown and @Terminal.Gui.Drivers.IDriver.KeyUp events which invoke @Terminal.Gui.App.Application.RaiseKeyDownEvent* and @Terminal.Gui.App.Application.RaiseKeyUpEvent(Terminal.Gui.Input.Key) respectively. > [!NOTE] > Not all drivers/platforms support sensing distinct KeyUp events. These drivers will simulate KeyUp events by raising KeyUp after KeyDown. -@Terminal.Gui.App.Application.RaiseKeyDownEvent* raises @Terminal.Gui.App.Application.KeyDown and then calls @Terminal.Gui.ViewBase.View.NewKeyDownEvent* on all toplevel Views. If no View handles the key event, any Application-scoped key bindings will be invoked. Application-scoped key bindings are managed through @Terminal.Gui.App.Application.Keyboard.KeyBindings. +@Terminal.Gui.App.Application.RaiseKeyDownEvent* raises @Terminal.Gui.App.Application.KeyDown and then calls @Terminal.Gui.ViewBase.View.NewKeyDownEvent* on all runnable Views. If no View handles the key event, any Application-scoped key bindings will be invoked. Application-scoped key bindings are managed through @Terminal.Gui.App.Application.Keyboard.KeyBindings. If a view is enabled, the @Terminal.Gui.ViewBase.View.NewKeyDownEvent* method will do the following: @@ -113,12 +113,12 @@ To define application key handling logic for an entire application in cases wher ## **Key Down/Up Events** -*Terminal.Gui* supports key up/down events with @Terminal.Gui.ViewBase.View.OnKeyDown* and @Terminal.Gui.ViewBase.View.OnKeyUp*, but not all [Console Drivers](drivers.md) do. To receive these key down and key up events, you must use a driver that supports them (e.g. `WindowsDriver`). +*Terminal.Gui* supports key up/down events with @Terminal.Gui.ViewBase.View.OnKeyDown* and @Terminal.Gui.ViewBase.View.OnKeyUp*, but not all [Drivers](drivers.md) do. To receive these key down and key up events, you must use a driver that supports them (e.g. `WindowsDriver`). # General input model -- Key Down and Up events are generated by `ConsoleDriver`. -- `Application` subscribes to `ConsoleDriver.Down/Up` events and forwards them to the most-focused `TopLevel` view using `View.NewKeyDownEvent` and `View.NewKeyUpEvent`. +- Key Down and Up events are generated by the driver. +- `IApplication` implementations subscribe to driver KeyDown/Up events and forwards them to the most-focused `Runnable` view using `View.NewKeyDownEvent` and `View.NewKeyUpEvent`. - The base (`View`) implementation of `NewKeyDownEvent` follows a pattern of "Before", "During", and "After" processing: - **Before** - If `Enabled == false` that view should *never* see keyboard (or mouse input). @@ -134,25 +134,19 @@ To define application key handling logic for an entire application in cases wher - Subclasses of `View` can (rarely) override `OnKeyDown` (or subscribe to `KeyDown`) to see keys before they are processed - Subclasses of `View` can (often) override `OnKeyDownNotHandled` to do key processing for keys that were not previously handled. `TextField` and `TextView` are examples. -## ConsoleDriver - -* No concept of `Command` or `KeyBindings` -* Use the low-level `KeyCode` enum. -* Exposes non-cancelable `KeyDown/Up` events. The `OnKey/Down/Up` methods are public and can be used to simulate keyboard input (in addition to SendKeys). - ## Application * Implements support for `KeyBindingScope.Application`. * Keyboard functionality is now encapsulated in the @Terminal.Gui.App.IKeyboard interface, accessed via @Terminal.Gui.App.Application.Keyboard. * @Terminal.Gui.App.Application.Keyboard provides access to @Terminal.Gui.Input.KeyBindings, key binding configuration (QuitKey, ArrangeKey, navigation keys), and keyboard event handling. -* For backward compatibility, @Terminal.Gui.App.Application still exposes static properties/methods that delegate to @Terminal.Gui.App.Application.Keyboard (e.g., `Application.KeyBindings`, `Application.RaiseKeyDownEvent`, `Application.QuitKey`). +* For backward compatibility, @Terminal.Gui.App.Application still exposes static properties/methods that delegate to @Terminal.Gui.App.Application.Keyboard (e.g., `IApplication.KeyBindings`, `IApplication.RaiseKeyDownEvent`, `IApplication.QuitKey`). * Exposes cancelable `KeyDown/Up` events (via `Handled = true`). The `RaiseKeyDownEvent` and `RaiseKeyUpEvent` methods are public and can be used to simulate keyboard input. * The @Terminal.Gui.App.IKeyboard interface enables testability with isolated keyboard instances that don't depend on static Application state. ## View * Implements support for `KeyBindings` and `HotKeyBindings`. -* Exposes cancelable non-virtual methods for a new key event: `NewKeyDownEvent` and `NewKeyUpEvent`. These methods are called by `Application` can be called to simulate keyboard input. +* Exposes cancelable non-virtual methods for a new key event: `NewKeyDownEvent` and `NewKeyUpEvent`. These methods are called by `IApplication` can be called to simulate keyboard input. * Exposes cancelable virtual methods for a new key event: `OnKeyDown` and `OnKeyUp`. These methods are called by `NewKeyDownEvent` and `NewKeyUpEvent` and can be overridden to handle keyboard input. ## IKeyboard Architecture @@ -175,9 +169,9 @@ The @Terminal.Gui.App.IKeyboard interface provides a decoupled, testable archite ```csharp // Modern approach - using IKeyboard -Application.Keyboard.KeyBindings.Add(Key.F1, Command.HotKey); -Application.Keyboard.RaiseKeyDownEvent(Key.Enter); -Application.Keyboard.QuitKey = Key.Q.WithCtrl; +App.Keyboard.KeyBindings.Add(Key.F1, Command.HotKey); +App.Keyboard.RaiseKeyDownEvent(Key.Enter); +App.Keyboard.QuitKey = Key.Q.WithCtrl; // Legacy approach - still works (delegates to Application.Keyboard) Application.KeyBindings.Add(Key.F1, Command.HotKey); @@ -202,6 +196,24 @@ Assert.Equal(Key.Q.WithCtrl, keyboard1.QuitKey); Assert.Equal(Key.X.WithCtrl, keyboard2.QuitKey); ``` +**Accessing application context from views:** + +```csharp +public class MyView : View +{ + protected override bool OnKeyDown(Key key) + { + // Use View.App instead of static Application + if (key == Key.F1) + { + App?.Keyboard?.KeyBindings.Add(Key.F2, Command.Accept); + return true; + } + return base.OnKeyDown(key); + } +} +``` + ### Architecture Benefits - **Parallel Testing**: Multiple test methods can create and use separate @Terminal.Gui.App.IKeyboard instances simultaneously without state interference. @@ -218,4 +230,10 @@ The @Terminal.Gui.App.Keyboard class implements @Terminal.Gui.App.IKeyboard and - **Events**: KeyDown, KeyUp events for application-level keyboard monitoring - **Command Implementations**: Handlers for Application-scoped commands (Quit, Suspend, Navigation, Refresh, Arrange) -The @Terminal.Gui.App.ApplicationImpl class creates and manages the @Terminal.Gui.App.IKeyboard instance, setting its `Application` property to `this` to provide the necessary @Terminal.Gui.App.IApplication reference. \ No newline at end of file +The @Terminal.Gui.App.ApplicationImpl class creates and manages the @Terminal.Gui.App.IKeyboard instance, setting its `IApplication` property to `this` to provide the necessary @Terminal.Gui.App.IApplication reference. + +## Driver + +* No concept of `Command` or `KeyBindings` +* Use the low-level `KeyCode` enum. +* Exposes non-cancelable `KeyDown/Up` events. The `OnKey/Down/Up` methods are public and can be used to simulate keyboard input (in addition to SendKeys) \ No newline at end of file diff --git a/docfx/docs/migratingfromv1.md b/docfx/docs/migratingfromv1.md index fbf121c2f..7e81994e6 100644 --- a/docfx/docs/migratingfromv1.md +++ b/docfx/docs/migratingfromv1.md @@ -1,528 +1,1114 @@ # Migrating From v1 To v2 -This document provides an overview of the changes between Terminal.Gui v1 and v2. It is intended to help developers migrate their applications from v1 to v2. +This document provides a comprehensive guide for migrating applications from Terminal.Gui v1 to v2. -For detailed breaking change documentation check out this Discussion: https://github.com/gui-cs/Terminal.Gui/discussions/2448 +For detailed breaking change documentation, check out this Discussion: https://github.com/gui-cs/Terminal.Gui/discussions/2448 -## View Constructors -> Initializers +## Table of Contents -In v1, @Terminal.Gui.View and most sub-classes had multiple constructors that took a variety of parameters. In v2, the constructors have been replaced with initializers. This change was made to simplify the API and make it easier to use. In addition, the v1 constructors drove a false (and needlessly complex) distinction between "Absolute" and "Computed" layout. In v2, the layout system is much simpler and more intuitive. +- [Overview of Major Changes](#overview-of-major-changes) +- [Application Architecture](#application-architecture) +- [View Construction and Initialization](#view-construction-and-initialization) +- [Layout System Changes](#layout-system-changes) +- [Color and Attribute Changes](#color-and-attribute-changes) +- [Type Changes](#type-changes) +- [Unicode and Text](#unicode-and-text) +- [Keyboard API](#keyboard-api) +- [Mouse API](#mouse-api) +- [Navigation Changes](#navigation-changes) +- [Scrolling Changes](#scrolling-changes) +- [Adornments](#adornments) +- [Event Pattern Changes](#event-pattern-changes) +- [View-Specific Changes](#view-specific-changes) +- [Disposal and Resource Management](#disposal-and-resource-management) +- [API Terminology Changes](#api-terminology-changes) -### How to Fix +--- -Replace the constructor calls with initializer calls. +## Overview of Major Changes -```diff -- var myView = new View (new Rect (10, 10, 40, 10)); -+ var myView = new View { X = 10, Y = 10, Width = 40, Height = 10 }; +Terminal.Gui v2 represents a major architectural evolution with these key improvements: + +1. **Instance-Based Application Model** - Move from static `Application` to `IApplication` instances +2. **IRunnable Architecture** - Interface-based runnable pattern with type-safe results +3. **Simplified Layout** - Removed Absolute/Computed distinction, improved adornments +4. **24-bit TrueColor** - Full color support by default +5. **Enhanced Input** - Better keyboard and mouse APIs +6. **Built-in Scrolling** - All views support scrolling inherently +7. **Fluent API** - Method chaining for elegant code +8. **Proper Disposal** - IDisposable pattern throughout + +--- + +## Application Architecture + +### Instance-Based Application Model + +**v1 Pattern (Static):** +```csharp +// v1 - static Application +Application.Init(); +var top = Application.Top; +top.Add(myView); +Application.Run(); +Application.Shutdown(); ``` -## TrueColor Support - 24-bit Color is the default - -Terminal.Gui v2 now supports 24-bit color by default. This means that the colors you use in your application will be more accurate and vibrant. If you are using custom colors in your application, you may need to update them to use the new 24-bit color format. - -The @Terminal.Gui.Attribute class has been simplified. Color names now match the ANSI standard ('Brown' is now called 'Yellow') - -### How to Fix - -Static class `Attribute.Make` has been removed. Use constructor instead - -```diff -- var c = Attribute.Make(Color.BrightMagenta, Color.Blue); -+ var c = new Attribute(Color.BrightMagenta, Color.Blue); +**v2 Recommended Pattern (Instance-Based):** +```csharp +// v2 - instance-based with using statement +using (var app = Application.Create().Init()) +{ + var top = new Window(); + top.Add(myView); + app.Run(top); + top.Dispose(); +} // app.Dispose() called automatically ``` -```diff -- var c = Color.Brown; -+ var c = Color.Yellow; +**v2 Legacy Pattern (Still Works):** +```csharp +// v2 - legacy static (marked obsolete but functional) +Application.Init(); +var top = new Window(); +top.Add(myView); +Application.Run(top); +top.Dispose(); +Application.Shutdown(); // Obsolete - use Dispose() instead ``` -## Low-Level Type Changes +### IRunnable Architecture -* `Rect` -> `Rectangle` -* `Point` -> `Point` -* `Size` -> `Size` - -### How to Fix - -* Replace `Rect` with `Rectangle` - - -## `NStack.string` has been removed. Use `System.Rune` instead. - -See [Unicode](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/overview.html#unicode) for details. - -### How to Fix - -Replace `using` statements with the `System.Text` namespace - -```diff -- using NStack; -+ using System.Text; -``` - -Anywhere you have an implicit cast from `char` to `Rune`, replace with a constructor call - -```diff -- myView.AddRune(col, row, '▄'); -+ myView.AddRune(col, row, new Rune('▄')); -``` - -When measuring the screen space taken up by a `Rune` use `GetColumns()` - -```diff -- Rune.ColumnWidth(rune); -+ rune.GetColumns(); -``` -When measuring the screen space taken up by a `string` you can use the extension method `GetColumns()` - -```diff -- myString.Sum(c=>Rune.ColumnWidth(c)); -+ myString.GetColumns(); -``` - -## View Life Cycle Management - -In v1, @Terminal.Gui.View was derived from `Responder` which supported `IDisposable`. In v2, `Responder` has been removed and @Terminal.Gui.View is the base-class supporting `IDisposable`. - -In v1, @Terminal.Gui./Terminal.Gui.Application.Init) automatically created a toplevel view and set [Application.Top](~/api/Terminal.Gui.Application.Top. In v2, @Terminal.Gui.App.Application.Init no longer automatically creates a toplevel or sets @Terminal.Gui.App.Application.Top; app developers must explicitly create the toplevel view and pass it to @Terminal.Gui.App.Application.Run (or use `Application.Run`). Developers are responsible for calling `Dispose` on any toplevel they create before exiting. - -### How to Fix - -* Replace `Responder` with @Terminal.Gui.View -* Update any code that assumes `Application.Init` automatically created a toplevel view and set `Application.Top`. -* Update any code that assumes `Application.Init` automatically disposed of the toplevel view when the application exited. - -## @Terminal.Gui.Pos and @Terminal.Gui.Dim types now adhere to standard C# idioms - -* In v1, the @Terminal.Gui.Pos and @Terminal.Gui.Dim types (e.g. @Terminal.Gui.Pos.PosView) were nested classes and marked @Terminal.Gui.internal. In v2, they are no longer nested, and have appropriate public APIs. -* Nullabilty is enabled. -* Methods & properties follow standards. -* The static method that creates a @Terminal.Gui.PosAbsolute, `Pos.At`, was renamed to @Terminal.Gui.Pos.Absolute for consistency. -* The static method that crates as @Terminal.Gui.DimAbsoulte, `Dim.Sized`, was renamed to @Terminal.Gui.Dim.Absolute for consistency. - -### How to Fix - -* Search and replace `Pos.Pos` -> `Pos`. -* Search and replace `Dim.Dim` -> `Dim`. -* Search and replace `Pos.At` -> `Pos.Absolute` -* Search and replace `Dim.Sized` -> `Dim.Absolute` -* Search and replace `Dim.Anchor` -> `Dim.GetAnchor` -* Search and replace `Pos.Anchor` -> `Pos.GetAnchor` - -## Layout Improvements - -In v2, the layout system has been improved to make it easier to create complex user interfaces. If you are using custom layouts in your application, you may need to update them to use the new layout system. - -* The distinction between `Absolute Layout` and `Computed Layout` has been removed, as has the `LayoutStyle` enum. v1 drew a false distinction between these styles. -* @Terminal.Gui.ViewBase.View.Frame now represents the position and size of the view in the superview's coordinate system. The `Frame` property is of type `Rectangle`. -* @Terminal.Gui.ViewBase.View.Bounds has been replaced by @Terminal.Gui.ViewBase.View.Viewport. The `Viewport` property represents the visible area of the view in its own coordinate system. The `Viewport` property is of type `Rectangle`. -* @Terminal.Gui.ViewBase.View.GetContentSize represents the size of the view's content. This replaces `ScrollView` and `ScrollBarView` in v1. See more below. - -### How to Fix - -### `Bounds` -> `Viewport` - -* Remove all references ot `LayoutStyle`. -* Rename `Bounds` to `Viewport`. The `Location` property of `Bounds` can now have non-zero values. -* Update any code that assumed `Bounds.Location` was always `Point.Empty`. -* Update any code that used `Bounds` to refer to the size of the view's content. Use `GetContentSize()` instead. -* Update any code that assumed `Bounds.Size` was the same as `Frame.Size`. `Frame.Size` defines the size of the view in the superview's coordinate system, while `Viewport.Size` defines the visible area of the view in its own coordinate system. -* Use @Terminal.Gui.ViewBase.View.GetAdornmentsThickness to get the total thickness of the view's border, margin, and padding. -* Not assume a View can draw outside of 'Viewport'. Use the 'Margin', 'Border', and 'Padding' Adornments to do things outside of `Viewport`. View subclasses should not implement their own concept of padding or margins but leverage these `Adornments` instead. -* Mouse and draw events now provide coordinates relative to the `Viewport` not the `Frame`. - -## `View.AutoSize` has been removed. Use @Terminal.Gui.Dim.Auto for width or height instead. - -In v1, `View.AutoSize` was used to size a view to its `Text`. In v2, `View.AutoSize` has been removed. Use @Terminal.Gui.Dim.Auto for width or height instead. - -### How to Fix - -* Replace `View.AutoSize = true` with `View.Width = Dim.Auto` or `View.Height = Dim.Auto` as needed. See the [DimAuto Deep Dive](dimauto.md) for more information. - -## Adornments - -In v2, the `Border`, `Margin`, and `Padding` properties have been added to all views. This simplifies view development and enables a sophisticated look and feel. If you are using custom borders, margins, or padding in your application, you may need to update them to use the new properties. - -* `View.Border` is now of type @Terminal.Gui.Adornment. @Terminal.Gui.ViewBase.View.BorderStyle is provided as a convenience property to set the border style (`myView.BorderStyle = LineStyle.Double`). - -### How to Fix - -## Built-in Scrolling - -In v1, scrolling was enabled by using `ScrollView` or `ScrollBarView`. In v2, the base @Terminal.Gui.View class supports scrolling inherently. The area of a view visible to the user at a given moment was previously a rectangle called `Bounds`. `Bounds.Location` was always `Point.Empty`. In v2 the visible area is a rectangle called `Viewport` which is a protal into the Views content, which can be bigger (or smaller) than the area visible to the user. Causing a view to scroll is as simple as changing `View.Viewport.Location`. The View's content is described by @Terminal.Gui.ViewBase.View.GetContentSize. See [Layout](layout.md) for details. - -@Terminal.Gui.ScrollBar replaces `ScrollBarView` with a much cleaner implementation of a scrollbar. In addition, @Terminal.Gui.ViewBase.View.VerticalScrollBar and @Terminal.Gui.ViewBase.View.HorizontalScrollBar provide a simple way to enable scroll bars in any View with almost no code. See See [Scrolling Deep Dive](scrolling.md) for more. - -### How to Fix - -* Replace `ScrollView` with @Terminal.Gui.View and use `Viewport` and @Terminal.Gui.ViewBase.View.GetContentSize to control scrolling. -* Update any code that assumed `Bounds.Location` was always `Point.Empty`. -* Update any code that used `Bounds` to refer to the size of the view's content. Use @Terminal.Gui.ViewBase.View.GetContentSize instead. -* Update any code that assumed `Bounds.Size` was the same as `Frame.Size`. `Frame.Size` defines the size of the view in the superview's coordinate system, while `Viewport.Size` defines the visible area of the view in its own coordinate system. -* Replace `ScrollBarView` with @Terminal.Gui.ScrollBar. See [Scrolling Deep Dive](scrolling.md) for more. - -## Updated Keyboard API - -The API for handling keyboard input is significantly improved. See [Keyboard API](keyboard.md). - -* The @Terminal.Gui.Key class replaces the `KeyEvent` struct and provides a platform-independent abstraction for common keyboard operations. It is used for processing keyboard input and raising keyboard events. This class provides a high-level abstraction with helper methods and properties for common keyboard operations. Use this class instead of the low-level @Terminal.Gui.KeyCode enum when possible. See @Terminal.Gui.Key for more details. -* The preferred way to enable Application-wide or View-heirarchy-dependent keystrokes is to use the @Terminal.Gui.Shortcut View or the built-in View's that utilize it, such as the @Terminal.Gui.Bar-based views. -* The preferred way to handle single keystrokes is to use **Key Bindings**. Key Bindings map a key press to a @Terminal.Gui.Input.Command. A view can declare which commands it supports, and provide a lambda that implements the functionality of the command, using `View.AddCommand()`. Use the @Terminal.Gui.ViewBase.View.Keybindings to configure the key bindings. -* For better consistency and user experience, the default key for closing an app or `Toplevel` is now `Esc` (it was previously `Ctrl+Q`). -* The `Application.RootKeyEvent` method has been replaced with `Application.KeyDown` - -### How to Fix - -* Replace `KeyEvent` with `Key` -* Use @Terminal.Gui.ViewBase.View.AddCommand to define commands your view supports. -* Use @Terminal.Gui.ViewBase.View.Keybindings to configure key bindings to `Command`s. -* It should be very uncommon for v2 code to override `OnKeyPressed` etc... -* Anywhere `Ctrl+Q` was hard-coded as the "quit key", replace with `Application.QuitKey`. -* See *Navigation* below for more information on v2's navigation keys. -* Replace `Application.RootKeyEvent` with `Application.KeyDown`. If the reason for subscribing to RootKeyEvent was to enable an application-wide action based on a key-press, consider using Application.KeyBindings instead. - -```diff -- Application.RootKeyEvent(KeyEvent arg) -+ Application.KeyDown(object? sender, Key e) -``` - -## @Terminal.Gui.Input.Command has been expanded and simplified - -In v1, the `Command` enum had duplicate entries and inconsistent naming. In v2 it has been both expanded and simplified. - -### How To Fix - -* Update any references to old `Command` values with the updated versions. - -## Updated Mouse API - -The API for mouse input is now internally consistent and easier to use. - -* The @Terminal.Gui.MouseEventArgs class replaces `MouseEventEventArgs`. -* More granular APIs are provided to ease handling specific mouse actions. See [Mouse API](mouse.md). -* Views can use the @Terminal.Gui.ViewBase.View.Highlight event to have the view be visibly highlighted on various mouse events. -* Views can set `View.WantContinousButtonPresses = true` to have their @Terminal.Gui.Input.Command.Accept command be invoked repeatedly as the user holds a mouse button down on the view. -* Mouse and draw events now provide coordinates relative to the `Viewport` not the `Screen`. -* The `Application.RootMouseEvent` method has been replaced with `Application.MouseEvent` - -### How to Fix - -* Replace `MouseEventEventArgs` with `MouseEvent` -* Use the @Terminal.Gui.ViewBase.View.Highlight event to have the view be visibly highlighted on various mouse events. -* Set `View.WantContinousButtonPresses = true` to have the @Terminal.Gui.Input.Command.Accept command be invoked repeatedly as the user holds a mouse button down on the view. -* Update any code that assumed mouse events provided coordinates relative to the `Screen`. -* Replace `Application.RootMouseEvent` with `Application.MouseEvent`. - -```diff -- Application.RootMouseEvent(KeyEvent arg) -+ Application.MouseEvent(object? sender, MouseEventArgs mouseEvent) -``` - -## Navigation - `Cursor`, `Focus`, `TabStop` etc... - -The cursor and focus system has been redesigned in v2 to be more consistent and easier to use. If you are using custom cursor or focus logic in your application, you may need to update it to use the new system. - -### Cursor - -In v1, whether the cursor (the flashing caret) was visible or not was controlled by `View.CursorVisibility` which was an enum extracted from Ncruses/Terminfo. It only works in some cases on Linux, and only partially with `WindowsDriver`. The position of the cursor was determined by the last call to the driver's Move method. `View.PositionCursor()` could be overridden by views to cause `Application` to call the driver's positioning method on behalf of the app and to manage setting `CursorVisibility`. This API was confusing and bug-prone. - -In v2, the API is (NOT YET IMPLEMENTED) simplified. A view simply reports the style of cursor it wants and the Viewport-relative location: - -* `public Point? CursorPosition` - - If `null` the cursor is not visible - - If `{}` the cursor is visible at the `Point`. -* `public event EventHandler? CursorPositionChanged` -* `public int? CursorStyle` - - If `null` the default cursor style is used. - - If `{}` specifies the style of cursor. See [cursor.md](cursor.md) for more. -* `Application` now has APIs for querying available cursor styles. -* The driver details are no longer directly accessible to View subclasses. - -#### How to Fix (Cursor API) - -* Use @Terminal.Gui.ViewBase.View.CursorPosition to set the cursor position in a view. Set @Terminal.Gui.ViewBase.View.CursorPosition to `null` to hide the cursor. -* Set @Terminal.Gui.ViewBase.View.CursorVisibility to the cursor style you want to use. -* Remove any overrides of `OnEnter` and `OnLeave` that explicitly change the cursor. - -### Driver Access - -In v1, Views could access `Driver` directly (e.g., `Driver.Move()`, `Driver.Rows`, `Driver.Cols`). In v2, `Driver` is internal and View subclasses should not access it directly. ViewBase provides all necessary abstractions for Views to function without needing direct driver access. - -#### How to Fix (Driver Access) - -* Replace `Driver.Rows` and `Driver.Cols` with @Terminal.Gui.App.Application.Screen.Height and @Terminal.Gui.App.Application.Screen.Width -* Replace direct `Driver.Move(screenX, screenY)` calls with @Terminal.Gui.ViewBase.View.Move using viewport-relative coordinates -* Use @Terminal.Gui.ViewBase.View.AddRune and @Terminal.Gui.ViewBase.View.AddStr for drawing -* ViewBase infrastructure classes (in `Terminal.Gui/ViewBase/`) can still access Driver for framework implementation needs - -```diff -- if (x >= Driver.Cols) return; -+ if (x >= Application.Screen.Width) return; - -- Point screenPos = ViewportToScreen(new Point(col, row)); -- Driver.Move(screenPos.X, screenPos.Y); -+ Move(col, row); // Move handles viewport-to-screen conversion -``` - -### Focus - -See [navigation.md](navigation.md) for more details. -See also [Keyboard](keyboard.md) where HotKey is covered more deeply... - -* In v1, `View.CanFocus` was `true` by default. In v2, it is `false`. Any `View` subclass that wants to be focusable must set `CanFocus = true`. -* In v1 it was not possible to remove focus from a view. `HasFocus` as a get-only property. In v2, `view.HasFocus` can be set as well. Setting to `true` is equivalent to calling `view.SetFocus`. Setting to `false` is equivalent to calling `view.SuperView.AdvanceFocus` (which might not actually cause `view` to stop having focus). -* In v1, calling `super.Add (view)` where `view.CanFocus == true` caused all views up the hierarchy (all SuperViews) to get `CanFocus` set to `true` as well. In v2, developers need to explicitly set `CanFocus` for any view in the view-hierarchy where focus is desired. This simplifies the implementation and removes confusing automatic behavior. -* In v1, if `view.CanFocus == true`, `Add` would automatically set `TabStop`. In v2, the automatic setting of `TabStop` in `Add` is retained because it is not overly complex to do so and is a nice convenience for developers to not have to set both `Tabstop` and `CanFocus`. Note v2 does NOT automatically change `CanFocus` if `TabStop` is changed. -* `view.TabStop` now describes the behavior of a view in the focus chain. the `TabBehavior` enum includes `NoStop` (the view may be focusable, but not via next/prev keyboard nav), `TabStop` (the view may be focusable, and `NextTabStop`/`PrevTabStop` keyboard nav will stop), `TabGroup` (the view may be focusable, and `NextTabGroup`/`PrevTabGroup` keyboard nav will stop). -* In v1, the `View.Focused` property was a cache of which view in `SubViews/TabIndexes` had `HasFocus == true`. There was a lot of logic for keeping this property in sync. In v2, `View.Focused` is a get-only, computed property. -* In v1, the `View.MostFocused` property recursed down the subview-hierarchy on each get. In addition, because only one View in an application can be the "most focused", it doesn't make sense for this property to be on every View. In v2, this API is removed. Use `Application.Navigation.GetFocused()` instead. -* The v1 APIs `View.EnsureFocus`/`FocusNext`/`FocusPrev`/`FocusFirst`/`FocusLast` are replaced in v2 with these APIs that accomplish the same thing, more simply. - - `public bool AdvanceFocus (NavigationDirection direction, TabBehavior? behavior)` - - `public bool FocusDeepest (NavigationDirection direction, TabBehavior? behavior)` -* In v1, the `View.OnEnter/Enter` and `View.OnLeave/Leave` virtual methods/events could be used to notify that a view had gained or lost focus, but had confusing semantics around what it mean to override (requiring calling `base`) and bug-ridden behavior on what the return values signified. The "Enter" and "Leave" terminology was confusing. In v2, `View.OnHasFocusChanging/HasFocusChanging` and `View.OnHasFocusChanged/HasFocusChanged` replace `View.OnEnter/Enter` and `View.OnLeave/Leave`. These virtual methods/events follow standard Terminal.Gui event patterns. The `View.OnHasFocusChanging/HasFocusChanging` event supports being cancelled. -* In v1, the concept of `Mdi` views included a large amount of complex code (in `Toplevel` and `Application`) for dealing with navigation across overlapped Views. This has all been radically simplified in v2. Any View can work in an "overlapped" or "tiled" way. See [navigation.md](navigation.md) for more details. -* The `View.TabIndex` and `View.TabIndexes` have been removed. Change the order of the views in `View.SubViews` to change the navigation order (using, for example `View.MoveSubViewTowardsStart()`). - -### How to Fix (Focus API) - -* Set @Terminal.Gui.ViewBase.View.CanFocus to `true` for any View sub-class that wants to be focusable. -* Use @Terminal.Gui.App.Application.Navigation.GetFocused to get the most focused view in the application. -* Use @Terminal.Gui.App.Application.Navigation.AdvanceFocus to cause focus to change. - -### Keyboard Navigation - -In v2, `HotKey`s can be used to navigate across the entire application view-hierarchy. They work independently of `Focus`. This enables a user to navigate across a complex UI of nested subviews if needed (even in overlapped scenarios). An example use-case is the `AllViewsTester` scenario. - -In v2, unlike v1, multiple Views in an application (even within the same SuperView) can have the same `HotKey`. Each press of the `HotKey` will invoke the next `HotKey` across the View hierarchy (NOT IMPLEMENTED YET)* - -In v1, the keys used for navigation were both hard-coded and configurable, but in an inconsistent way. `Tab` and `Shift+Tab` worked consistently for navigating between SubViews, but were not configurable. `Ctrl+Tab` and `Ctrl+Shift+Tab` navigated across `Overlapped` views and had configurable "alternate" versions (`Ctrl+PageDown` and `Ctrl+PageUp`). - -In v2, this is made consistent and configurable: - -- `Application.NextTabStopKey` (`Key.Tab`) - Navigates to the next subview that is a `TabStop` (see below). If there is no next, the first subview that is a `TabStop` will gain focus. -- `Application.PrevTabStopKey` (`Key.Tab.WithShift`) - Opposite of `Application.NextTabStopKey`. -- `Key.CursorRight` - Operates identically to `Application.NextTabStopKey`. -- `Key.CursorDown` - Operates identically to `Application.NextTabStopKey`. -- `Key.CursorLeft` - Operates identically to `Application.PrevTabStopKey`. -- `Key.CursorUp` - Operates identically to `Application.PrevTabStopKey`. -- `Application.NextTabGroupKey` (`Key.F6`) - Navigates to the next view in the view-hierarchy that is a `TabGroup` (see below). If there is no next, the first view which is a `TabGroup` will gain focus. -- `Application.PrevTabGroupKey` (`Key.F6.WithShift`) - Opposite of `Application.NextTabGroupKey`. - -`F6` was chosen to match [Windows](https://learn.microsoft.com/en-us/windows/apps/design/input/keyboard-accelerators#common-keyboard-accelerators) - -These keys are all registered as `KeyBindingScope.Application` key bindings by `Application`. Because application-scoped key bindings have the lowest priority, Views can override the behaviors of these keys (e.g. `TextView` overrides `Key.Tab` by default, enabling the user to enter `\t` into text). The `AllViews_AtLeastOneNavKey_Leaves` unit test ensures all built-in Views have at least one of the above keys that can advance. - -### How to Fix (Keyboard Navigation) - -... - -## Button.Clicked Event Renamed - -The `Button.Clicked` event has been renamed `Button.Accepting` - -## How to Fix - -Rename all instances of `Button.Clicked` to `Button.Accepting`. Note the signature change to mouse events below. - -```diff -- btnLogin.Clicked -+ btnLogin.Accepting -``` - -Alternatively, if you want to have key events as well as mouse events to fire an event, use `Button.Accepting`. - -## Events now use `object sender, EventArgs args` signature - -Previously events in Terminal.Gui used a mixture of `Action` (no arguments), `Action` (or other raw datatype) and `Action`. Now all events use the `EventHandler` [standard .net design pattern](https://learn.microsoft.com/en-us/dotnet/csharp/event-pattern#event-delegate-signatures). - -For example, `event Action TimeoutAdded` has become `event EventHandler TimeoutAdded` - -This change was made for the following reasons: - -- Event parameters are now individually named and documented (with xmldoc) -- Future additions to event parameters can be made without being breaking changes (i.e. adding new properties to the EventArgs class) - -For example: +v2 introduces `IRunnable` for type-safe, runnable views: ```csharp +// Create a dialog that returns a typed result +public class FileDialog : Runnable +{ + private TextField _pathField; + + public FileDialog() + { + Title = "Select File"; + _pathField = new TextField { Width = Dim.Fill() }; + Add(_pathField); + + var okButton = new Button { Text = "OK", IsDefault = true }; + okButton.Accepting += (s, e) => { + Result = _pathField.Text; + Application.RequestStop(); + }; + AddButton(okButton); + } + + protected override bool OnIsRunningChanging(bool oldValue, bool newValue) + { + if (!newValue) // Stopping - extract result before disposal + { + Result = _pathField?.Text; + } + return base.OnIsRunningChanging(oldValue, newValue); + } +} -public class TimeoutEventArgs : EventArgs { - - /// - /// Gets the in UTC time when the - /// will next execute after. - /// - public long Ticks { get; } - -[...] +// Use with fluent API +using (var app = Application.Create().Init()) +{ + app.Run(); + string? result = app.GetResult(); + + if (result is { }) + { + OpenFile(result); + } } ``` -## How To Fix -If you previously had a lambda expression, you can simply add the extra arguments: +**Key Benefits:** +- Type-safe results (no casting) +- Automatic disposal of framework-created runnables +- CWP-compliant lifecycle events +- Works with any View (not just Toplevel) -```diff -- btnLogin.Clicked += () => { /*do something*/ }; -+ btnLogin.Accepting += (s,e) => { /*do something*/ }; -``` -Note that the event name has also changed as noted above. +### Disposal and Resource Management -If you have used a named method instead of a lamda you will need to update the signature e.g. +v2 requires explicit disposal: -```diff -- private void MyButton_Clicked () -+ private void MyButton_Clicked (object sender, EventArgs e) +```csharp +// ❌ v1 - Application.Shutdown() disposed everything +Application.Init(); +var top = new Window(); +Application.Run(top); +Application.Shutdown(); // Disposed top automatically + +// ✅ v2 - Dispose views explicitly +using (var app = Application.Create().Init()) +{ + var top = new Window(); + app.Run(top); + top.Dispose(); // Must dispose +} + +// ✅ v2 - Framework-created runnables disposed automatically +using (var app = Application.Create().Init()) +{ + app.Run(); // Dialog disposed automatically + var result = app.GetResult(); +} ``` -## `ReDraw` is now `Draw` +**Disposal Rules:** +- "Whoever creates it, owns it" +- `Run()`: Framework creates → Framework disposes +- `Run(IRunnable)`: Caller creates → Caller disposes +- Always dispose `IApplication` (use `using` statement) -### How to Fix +### View.App Property -* Replace `ReDraw` with `Draw` -* Mouse and draw events now provide coordinates relative to the `Viewport` not the `Frame`. +Views now have an `App` property for accessing the application context: -## No more nested classes +```csharp +// ❌ v1 - Direct static reference +Application.Driver.Move(x, y); -All public classes that were previously [nested classes](https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/nested-types) are now in the root namespace as their own classes. +// ✅ v2 - Use View.App +App?.Driver.Move(x, y); -### How To Fix -Replace references to nested types with the new standalone version - -```diff -- var myTab = new TabView.Tab(); -+ var myTab = new Tab(); +// ✅ v2 - Dependency injection +public class MyView : View +{ + private readonly IApplication _app; + + public MyView(IApplication app) + { + _app = app; + } +} ``` -## View and Text Alignment Changes +--- -In v1, both `TextAlignment` and `VerticalTextAlignment` enums were used to align text in views. In v2, these enums have been replaced with the @Terminal.Gui.Alignment enum. The @Terminal.Gui.ViewBase.View.TextAlignment property controls horizontal text alignment and the @Terminal.Gui.ViewBase.View.VerticalTextAlignment property controls vertical text alignment. +## View Construction and Initialization -v2 now supports @Terminal.Gui.Pos.Align which enables views to be easily aligned within their Superview. +### Constructors → Initializers -The @Terminal.Gui.Aligner class makes it easy to align elements (text, Views, etc...) within a container. - -### How to Fix - -* Replace `VerticalAlignment.Middle` is now @Terminal.Gui.Alignment.Center. - -## `StatusBar`- `StatusItem` is replaced by `Shortcut` - -@Terminal.Gui.StatusBar has been upgraded to utilize @Terminal.Gui.Shortcut. - -### How to Fix - -```diff -- var statusBar = new StatusBar ( -- new StatusItem [] -- { -- new ( -- Application.QuitKey, -- $"{Application.QuitKey} to Quit", -- () => Quit () -- ) -- } -- ); -+ var statusBar = new StatusBar (new Shortcut [] { new (Application.QuitKey, "Quit", Quit) }); +**v1:** +```csharp +var myView = new View(new Rect(10, 10, 40, 10)); ``` -## `CheckBox` - API renamed and simplified - -In v1 `CheckBox` used `bool?` to represent the 3 states. To support consistent behavior for the `Accept` event, `CheckBox` was refactored to use the new `CheckState` enum instead of `bool?`. - -Additionally, the `Toggle` event was renamed `CheckStateChanging` and made cancelable. The `Toggle` method was renamed to `AdvanceCheckState`. - -### How to Fix - -```diff --var cb = new CheckBox ("_Checkbox", true); { -- X = Pos.Right (label) + 1, -- Y = Pos.Top (label) + 2 -- }; -- cb.Toggled += (e) => { -- }; -- cb.Toggle (); -+ -+var cb = new CheckBox () -+{ -+ Title = "_Checkbox", -+ CheckState = CheckState.Checked -+} -+cb.CheckStateChanging += (s, e) => -+{ -+ e.Cancel = preventChange; -+} -+preventChange = false; -+cb.AdvanceCheckState (); +**v2:** +```csharp +var myView = new View +{ + X = 10, + Y = 10, + Width = 40, + Height = 10 +}; ``` -## `MainLoop` has been removed from `Application` +### Initialization Pattern -In v1, you could add timeouts via `Application.MainLoop.AddTimeout` and access the `MainLoop` object directly. In v2, the legacy `MainLoop` class has been completely removed as part of the architectural modernization. Timeout functionality and other features previously accessed via `MainLoop` are now available directly through `Application` or `ApplicationImpl`. +v2 uses `ISupportInitializeNotification`: -### How to Fix +```csharp +// v1 - No explicit initialization +var view = new View(); +Application.Run(view); -Replace any `Application.MainLoop` references: - -```diff -- Application.MainLoop.AddTimeout (TimeSpan time, Func callback) -+ Application.AddTimeout (TimeSpan time, Func callback) +// v2 - Automatic initialization via BeginInit/EndInit +var view = new View(); +// BeginInit() called automatically when added to SuperView +// EndInit() called automatically +// Initialized event raised after EndInit() ``` -```diff -- Application.MainLoop.Wakeup () -+ // No replacement needed - wakeup is handled automatically by the modern architecture +--- + +## Layout System Changes + +### Removed LayoutStyle Distinction + +v1 had `Absolute` and `Computed` layout styles. v2 removed this distinction. + +**v1:** +```csharp +view.LayoutStyle = LayoutStyle.Computed; ``` -**Note**: The legacy `MainLoop` infrastructure (including `IMainLoopDriver` and `FakeMainLoop`) has been removed. The modern v2 architecture uses `ApplicationImpl`, `MainLoopCoordinator`, and `ApplicationMainLoop` instead. +**v2:** +```csharp +// No LayoutStyle - all layout is declarative via Pos/Dim +view.X = Pos.Center(); +view.Y = Pos.Center(); +view.Width = Dim.Percent(50); +view.Height = Dim.Fill(); +``` -## `SendSubViewXXX` renamed and corrected +### Frame vs Bounds -In v1, the `View` methods to move SubViews within the SubViews list were poorly named and actually operated in reverse of what their names suggested. +**v1:** +- `Frame` - Position/size in SuperView coordinates +- `Bounds` - Always `{0, 0, Width, Height}` (location always empty) -In v2, these methods have been named correctly. +**v2:** +- `Frame` - Position/size in SuperView coordinates (same as v1) +- `Viewport` - Visible area in content coordinates (replaces Bounds) + - **Important**: `Viewport.Location` can now be non-zero for scrolling -- `SendSubViewToBack` -> `MoveSubViewToStart` - Moves the specified subview to the start of the list. -- `SendSubViewBackward` -> `MoveSubViewTowardsStart` - Moves the specified subview one position towards the start of the list. -- `SendSubViewToFront` -> `MoveSubViewToEnd` - Moves the specified subview to the end of the list. -- `SendSubViewForward` -> `MoveSubViewTowardsEnd` - Moves the specified subview one position towards the end of the list. +```csharp +// ❌ v1 +var size = view.Bounds.Size; +Debug.Assert(view.Bounds.Location == Point.Empty); // Always true -## `Mdi` Replaced by `ViewArrangement.Overlapped` +// ✅ v2 +var visibleArea = view.Viewport; +var contentSize = view.GetContentSize(); -In v1, it apps with multiple overlapping views could be created using a set of APIs spread across `Application` (e.g. `Application.MdiTop`) and `Toplevel` (e.g. `IsMdiContainer`). This functionality has been replaced in v2 with @Terminal.Gui.ViewBase.View.Arrangement. Specifically, overlapped views with @Terminal.Gui.ViewBase.View.Arrangement having the @Terminal.Gui.ViewBase.ViewArrangement.Overlapped flag set will be arranged in an overlapped fashion using the order in their SuperView's subview list as the Z-order. +// Viewport.Location can be non-zero when scrolled +view.ScrollVertical(10); +Debug.Assert(view.Viewport.Location.Y == 10); +``` -Setting the @Terminal.Gui.ViewBase.ViewArrangement.Movable flag will enable the overlapped views to be movable with the mouse or keyboard (`Ctrl+F5` to activate). +### Pos and Dim API Changes -Setting the @Terminal.Gui.ViewBase.ViewArrangement.Sizable flag will enable the overlapped views to be resized with the mouse or keyboard (`Ctrl+F5` to activate). +| v1 | v2 | +|----|-----| +| `Pos.At(x)` | `Pos.Absolute(x)` | +| `Dim.Sized(width)` | `Dim.Absolute(width)` | +| `Pos.Anchor()` | `Pos.GetAnchor()` | +| `Dim.Anchor()` | `Dim.GetAnchor()` | -In v1, only Views derived from `Toplevel` could be overlapped. In v2, any view can be. +```csharp +// ❌ v1 +view.X = Pos.At(10); +view.Width = Dim.Sized(20); -v1 conflated the concepts of +// ✅ v2 +view.X = Pos.Absolute(10); +view.Width = Dim.Absolute(20); +``` -## `PopoverMenu` replaced by `PopoverMenu` +### View.AutoSize Removed -`PopoverMenu` replaces `ContrextMenu`. +**v1:** +```csharp +view.AutoSize = true; +``` -## `MenuItem` is now based on `Shortcut` +**v2:** +```csharp +view.Width = Dim.Auto(); +view.Height = Dim.Auto(); +``` +See [Dim.Auto Deep Dive](dimauto.md) for details. -```diff -new ( - Strings.charMapCopyGlyph, - "", - CopyGlyph, -- null, -- null, - (KeyCode)Key.G.WithCtrl - ), -``` +--- -## Others... +## Adornments -* `View` and all subclasses support `IDisposable` and must be disposed (by calling `view.Dispose ()`) by whatever code owns the instance when the instance is longer needed. +v2 adds `Border`, `Margin`, and `Padding` as built-in adornments. -* To simplify programming, any `View` added as a SubView another `View` will have it's lifecycle owned by the Superview; when a `View` is disposed, it will call `Dispose` on all the items in the `SubViews` property. Note this behavior is the same as it was in v1, just clarified. +**v1:** +```csharp +// Custom border drawing +view.Border = new Border { /* ... */ }; +``` -* In v1, `Application.End` called `Dispose ()` on @Terminal.Gui.App.Application.Top (via `Runstate.Toplevel`). This was incorrect as it meant that after `Application.Run` returned, `Application.Top` had been disposed, and any code that wanted to interrogate the results of `Run` by accessing `Application.Top` only worked by accident. This is because GC had not actually happened; if it had the application would have crashed. In v2 `Application.End` does NOT call `Dispose`, and it is the caller to `Application.Run` who is responsible for disposing the `Toplevel` that was either passed to `Application.Run (View)` or created by `Application.Run ()`. +**v2:** +```csharp +// Built-in Border adornment +view.BorderStyle = LineStyle.Single; +view.Border.Thickness = new Thickness(1); +view.Title = "My View"; -* Any code that creates a `Toplevel`, either by using `top = new()` or by calling either `top = Application.Run ()` or `top = ApplicationRun()` must call `top.Dispose` when complete. The exception to this is if `top` is passed to `myView.Add(top)` making it a subview of `myView`. This is because the semantics of `Add` are that the `myView` takes over responsibility for the subviews lifetimes. Of course, if someone calls `myView.Remove(top)` to remove said subview, they then re-take responsbility for `top`'s lifetime and they must call `top.Dispose`. +// Built-in Margin and Padding +view.Margin.Thickness = new Thickness(2); +view.Padding.Thickness = new Thickness(1); +``` + +See [Layout Deep Dive](layout.md) for complete details. + +--- + +## Color and Attribute Changes + +### 24-bit TrueColor Default + +v2 uses 24-bit color by default. + +```csharp +// v1 - Limited color palette +var color = Color.Brown; + +// v2 - ANSI-compliant names + TrueColor +var color = Color.Yellow; // Brown renamed +var customColor = new Color(0xFF, 0x99, 0x00); // 24-bit RGB +``` + +### Attribute.Make Removed + +**v1:** +```csharp +var attr = Attribute.Make(Color.BrightMagenta, Color.Blue); +``` + +**v2:** +```csharp +var attr = new Attribute(Color.BrightMagenta, Color.Blue); +``` + +### Color Name Changes + +| v1 | v2 | +|----|-----| +| `Color.Brown` | `Color.Yellow` | + +--- + +## Type Changes + +### Low-Level Types + +| v1 | v2 | +|----|-----| +| `Rect` | `Rectangle` | +| `Point` | `Point` | +| `Size` | `Size` | + +```csharp +// ❌ v1 +Rect rect = new Rect(0, 0, 10, 10); + +// ✅ v2 +Rectangle rect = new Rectangle(0, 0, 10, 10); +``` + +--- + +## Unicode and Text + +### NStack.ustring Removed + +**v1:** +```csharp +using NStack; +ustring text = "Hello"; +var width = text.Sum(c => Rune.ColumnWidth(c)); +``` + +**v2:** +```csharp +using System.Text; +string text = "Hello"; +var width = text.GetColumns(); // Extension method +``` + +### Rune Changes + +**v1:** +```csharp +// Implicit cast +myView.AddRune(col, row, '▄'); + +// Width +var width = Rune.ColumnWidth(rune); +``` + +**v2:** +```csharp +// Explicit constructor +myView.AddRune(col, row, new Rune('▄')); + +// Width +var width = rune.GetColumns(); +``` + +See [Unicode](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/overview.html#unicode) for details. + +--- + +## Keyboard API + +v2 has a completely redesigned keyboard API. + +### Key Class + +**v1:** +```csharp +KeyEvent keyEvent; +if (keyEvent.KeyCode == KeyCode.Enter) { } +``` + +**v2:** +```csharp +Key key; +if (key == Key.Enter) { } + +// Modifiers +if (key.Shift) { } +if (key.Ctrl) { } + +// With modifiers +Key ctrlC = Key.C.WithCtrl; +Key shiftF1 = Key.F1.WithShift; +``` + +### Key Bindings + +**v1:** +```csharp +// Override OnKeyPress +protected override bool OnKeyPress(KeyEvent keyEvent) +{ + if (keyEvent.KeyCode == KeyCode.Enter) + { + // Handle + return true; + } + return base.OnKeyPress(keyEvent); +} +``` + +**v2:** +```csharp +// Use KeyBindings + Commands +AddCommand(Command.Accept, HandleAccept); +KeyBindings.Add(Key.Enter, Command.Accept); + +private bool HandleAccept() +{ + // Handle + return true; +} +``` + +### Application-Wide Keys + +**v1:** +```csharp +// Hard-coded Ctrl+Q +if (keyEvent.Key == Key.CtrlMask | Key.Q) +{ + Application.RequestStop(); +} +``` + +**v2:** +```csharp +// Configurable quit key +if (key == Application.QuitKey) +{ + Application.RequestStop(); +} + +// Change the quit key +Application.QuitKey = Key.Esc; +``` + +### Navigation Keys + +v2 has consistent, configurable navigation keys: + +| Key | Purpose | +|-----|---------| +| `Tab` | Next TabStop | +| `Shift+Tab` | Previous TabStop | +| `F6` | Next TabGroup | +| `Shift+F6` | Previous TabGroup | + +```csharp +// Configurable +Application.NextTabStopKey = Key.Tab; +Application.PrevTabStopKey = Key.Tab.WithShift; +Application.NextTabGroupKey = Key.F6; +Application.PrevTabGroupKey = Key.F6.WithShift; +``` + +See [Keyboard Deep Dive](keyboard.md) for complete details. + +--- + +## Mouse API + +### MouseEventEventArgs → MouseEventArgs + +**v1:** +```csharp +void HandleMouse(MouseEventEventArgs args) { } +``` + +**v2:** +```csharp +void HandleMouse(object? sender, MouseEventArgs args) { } +``` + +### Mouse Coordinates + +**v1:** +- Mouse coordinates were screen-relative + +**v2:** +- Mouse coordinates are now **Viewport-relative** + +```csharp +// v2 - Viewport-relative coordinates +view.MouseClick += (s, e) => +{ + // e.Position is relative to view's Viewport + var x = e.Position.X; // 0 = left edge of viewport + var y = e.Position.Y; // 0 = top edge of viewport +}; +``` + +### Highlight Event + +v2 adds a `Highlight` event for visual feedback: + +```csharp +view.Highlight += (s, e) => +{ + // Provide visual feedback on mouse hover +}; +view.HighlightStyle = HighlightStyle.Hover; +``` + +See [Mouse Deep Dive](mouse.md) for complete details. + +--- + +## Navigation Changes + +### Focus Properties + +**v1:** +```csharp +view.CanFocus = true; // Default was true +``` + +**v2:** +```csharp +view.CanFocus = true; // Default is FALSE - must opt-in +``` + +**Important:** In v2, `CanFocus` defaults to `false`. Views that want focus must explicitly set it. + +### Focus Changes + +**v1:** +```csharp +// HasFocus was read-only +bool hasFocus = view.HasFocus; +``` + +**v2:** +```csharp +// HasFocus can be set +view.HasFocus = true; // Equivalent to SetFocus() +view.HasFocus = false; // Equivalent to SuperView.AdvanceFocus() +``` + +### TabStop Behavior + +**v1:** +```csharp +view.TabStop = true; // Boolean +``` + +**v2:** +```csharp +view.TabStop = TabBehavior.TabStop; // Enum with more options + +// Options: +// - NoStop: Focusable but not via Tab +// - TabStop: Normal tab navigation +// - TabGroup: Advance via F6 +``` + +### Navigation Events + +**v1:** +```csharp +view.Enter += (s, e) => { }; // Gained focus +view.Leave += (s, e) => { }; // Lost focus +``` + +**v2:** +```csharp +view.HasFocusChanging += (s, e) => +{ + // Before focus changes (cancellable) + if (preventFocusChange) + e.Cancel = true; +}; + +view.HasFocusChanged += (s, e) => +{ + // After focus changed + if (e.Value) + Console.WriteLine("Gained focus"); + else + Console.WriteLine("Lost focus"); +}; +``` + +See [Navigation Deep Dive](navigation.md) for complete details. + +--- + +## Scrolling Changes + +### ScrollView Removed + +**v1:** +```csharp +var scrollView = new ScrollView +{ + ContentSize = new Size(100, 100), + ShowHorizontalScrollIndicator = true, + ShowVerticalScrollIndicator = true +}; +``` + +**v2:** +```csharp +// Built-in scrolling on every View +var view = new View(); +view.SetContentSize(new Size(100, 100)); + +// Built-in scrollbars +view.VerticalScrollBar.Visible = true; +view.HorizontalScrollBar.Visible = true; +view.VerticalScrollBar.AutoShow = true; +``` + +### Scrolling API + +**v2:** +```csharp +// Set content larger than viewport +view.SetContentSize(new Size(100, 100)); + +// Scroll by changing Viewport location +view.Viewport = view.Viewport with { Location = new Point(10, 10) }; + +// Or use helper methods +view.ScrollVertical(5); +view.ScrollHorizontal(3); +``` + +See [Scrolling Deep Dive](scrolling.md) for complete details. + +--- + +## Event Pattern Changes + +v2 standardizes all events to use `object sender, EventArgs args` pattern. + +### Button.Clicked → Button.Accepting + +**v1:** +```csharp +button.Clicked += () => { /* do something */ }; +``` + +**v2:** +```csharp +button.Accepting += (s, e) => { /* do something */ }; +``` + +### Event Signatures + +**v1:** +```csharp +// Various patterns +event Action SomeEvent; +event Action OtherEvent; +event Action ThirdEvent; +``` + +**v2:** +```csharp +// Consistent pattern +event EventHandler? SomeEvent; +event EventHandler>? OtherEvent; +event EventHandler>? ThirdEvent; +``` + +**Benefits:** +- Named parameters +- Cancellable events via `CancelEventArgs` +- Future-proof (new properties can be added) + +--- + +## View-Specific Changes + +### CheckBox + +**v1:** +```csharp +var cb = new CheckBox("_Checkbox", true); +cb.Toggled += (e) => { }; +cb.Toggle(); +``` + +**v2:** +```csharp +var cb = new CheckBox +{ + Title = "_Checkbox", + CheckState = CheckState.Checked +}; +cb.CheckStateChanging += (s, e) => +{ + e.Cancel = preventChange; +}; +cb.AdvanceCheckState(); +``` + +### StatusBar + +**v1:** +```csharp +var statusBar = new StatusBar( + new StatusItem[] + { + new StatusItem(Application.QuitKey, "Quit", () => Quit()) + } +); +``` + +**v2:** +```csharp +var statusBar = new StatusBar( + new Shortcut[] + { + new Shortcut(Application.QuitKey, "Quit", Quit) + } +); +``` + +### PopoverMenu + +v2 replaces `ContextMenu` with `PopoverMenu`: + +**v1:** +```csharp +var contextMenu = new ContextMenu(); +``` + +**v2:** +```csharp +var popoverMenu = new PopoverMenu(); +``` + +### MenuItem + +**v1:** +```csharp +new MenuItem( + "Copy", + "", + CopyGlyph, + null, + null, + (KeyCode)Key.G.WithCtrl +) +``` + +**v2:** +```csharp +new MenuItem( + "Copy", + "", + CopyGlyph, + Key.G.WithCtrl +) +``` + +--- + +## Disposal and Resource Management + +v2 implements proper `IDisposable` throughout. + +### View Disposal + +```csharp +// v1 - No explicit disposal needed +var view = new View(); +Application.Run(view); +Application.Shutdown(); + +// v2 - Explicit disposal required +var view = new View(); +app.Run(view); +view.Dispose(); +app.Dispose(); +``` + +### Disposal Patterns + +```csharp +// ✅ Best practice - using statement +using (var app = Application.Create().Init()) +{ + using (var view = new View()) + { + app.Run(view); + } +} + +// ✅ Alternative - explicit try/finally +var app = Application.Create(); +try +{ + app.Init(); + var view = new View(); + try + { + app.Run(view); + } + finally + { + view.Dispose(); + } +} +finally +{ + app.Dispose(); +} +``` + +### SubView Disposal + +When a View is disposed, it automatically disposes all SubViews: + +```csharp +var container = new View(); +var child1 = new View(); +var child2 = new View(); + +container.Add(child1, child2); + +// Disposes container, child1, and child2 +container.Dispose(); +``` + +See [Resource Management](#disposal-and-resource-management) for complete details. + +--- + +## API Terminology Changes + +v2 modernizes terminology for clarity: + +### Application.Top → Application.TopRunnable + +**v1:** +```csharp +Application.Top.SetNeedsDraw(); +``` + +**v2:** +```csharp +// Use TopRunnable (or TopRunnableView for View reference) +app.TopRunnable?.SetNeedsDraw(); +app.TopRunnableView?.SetNeedsDraw(); + +// From within a view +App?.TopRunnableView?.SetNeedsDraw(); +``` + +**Why "TopRunnable"?** +- Clearly indicates it's the top of the runnable session stack +- Aligns with `IRunnable` architecture +- Works with any `IRunnable`, not just `Toplevel` + +### Application.TopLevels → Application.SessionStack + +**v1:** +```csharp +foreach (var tl in Application.TopLevels) +{ + // Process +} +``` + +**v2:** +```csharp +foreach (var token in app.SessionStack) +{ + var runnable = token.Runnable; + // Process +} + +// Count of sessions +int sessionCount = app.SessionStack.Count; +``` + +**Why "SessionStack"?** +- Describes both content (sessions) and structure (stack) +- Aligns with `SessionToken` terminology +- Follows .NET naming patterns + +### View Arrangement + +**v1:** +```csharp +view.SendSubViewToBack(); +view.SendSubViewBackward(); +view.SendSubViewToFront(); +view.SendSubViewForward(); +``` + +**v2:** +```csharp +// Fixed naming (methods worked opposite to their names in v1) +view.MoveSubViewToStart(); +view.MoveSubViewTowardsStart(); +view.MoveSubViewToEnd(); +view.MoveSubViewTowardsEnd(); +``` + +### Mdi → ViewArrangement.Overlapped + +**v1:** +```csharp +Application.MdiTop = true; +toplevel.IsMdiContainer = true; +``` + +**v2:** +```csharp +view.Arrangement = ViewArrangement.Overlapped; + +// Additional flags +view.Arrangement = ViewArrangement.Movable | ViewArrangement.Resizable; +``` + +See [Arrangement Deep Dive](arrangement.md) for complete details. + +--- + +## Complete Migration Example + +Here's a complete v1 to v2 migration: + +**v1:** +```csharp +using NStack; +using Terminal.Gui; + +Application.Init(); + +var win = new Window(new Rect(0, 0, 50, 20), "Hello"); + +var label = new Label(1, 1, "Name:"); + +var textField = new TextField(10, 1, 30, ""); + +var button = new Button(10, 3, "OK"); +button.Clicked += () => +{ + MessageBox.Query(50, 7, "Info", $"Hello, {textField.Text}", "Ok"); +}; + +win.Add(label, textField, button); + +Application.Top.Add(win); +Application.Run(); +Application.Shutdown(); +``` + +**v2:** +```csharp +using System; +using Terminal.Gui; + +using (var app = Application.Create().Init()) +{ + var win = new Window + { + Title = "Hello", + Width = 50, + Height = 20 + }; + + var label = new Label + { + Text = "Name:", + X = 1, + Y = 1 + }; + + var textField = new TextField + { + X = 10, + Y = 1, + Width = 30 + }; + + var button = new Button + { + Text = "OK", + X = 10, + Y = 3 + }; + button.Accepting += (s, e) => + { + MessageBox.Query(app, "Info", $"Hello, {textField.Text}", "Ok"); + }; + + win.Add(label, textField, button); + + app.Run(win); + win.Dispose(); +} +``` + +--- + +## Summary of Major Breaking Changes + +| Category | v1 | v2 | +|----------|----|----| +| **Application** | Static `Application` | `IApplication` instances via `Application.Create()` | +| **Disposal** | Automatic | Explicit (`IDisposable` pattern) | +| **View Construction** | Constructors with Rect | Initializers with X, Y, Width, Height | +| **Layout** | Absolute/Computed distinction | Unified Pos/Dim system | +| **Colors** | Limited palette | 24-bit TrueColor default | +| **Types** | `Rect`, `NStack.ustring` | `Rectangle`, `System.String` | +| **Keyboard** | `KeyEvent`, hard-coded keys | `Key`, configurable bindings | +| **Mouse** | Screen-relative | Viewport-relative | +| **Scrolling** | `ScrollView` | Built-in on all Views | +| **Focus** | `CanFocus` default true | `CanFocus` default false | +| **Navigation** | `Enter`/`Leave` events | `HasFocusChanging`/`HasFocusChanged` | +| **Events** | Mixed patterns | Standard `EventHandler` | +| **Terminology** | `Application.Top`, `TopLevels` | `TopRunnable`, `SessionStack` | + +--- + +## Additional Resources + +- [Application Deep Dive](application.md) - Complete application architecture +- [View Deep Dive](View.md) - View system details +- [Layout Deep Dive](layout.md) - Comprehensive layout guide +- [Keyboard Deep Dive](keyboard.md) - Keyboard input handling +- [Mouse Deep Dive](mouse.md) - Mouse input handling +- [Navigation Deep Dive](navigation.md) - Focus and navigation +- [Scrolling Deep Dive](scrolling.md) - Built-in scrolling system +- [Arrangement Deep Dive](arrangement.md) - Movable/resizable views +- [Configuration Deep Dive](config.md) - Configuration system +- [What's New in v2](newinv2.md) - New features overview + +--- + +## Getting Help + +- [GitHub Discussions](https://github.com/gui-cs/Terminal.Gui/discussions) +- [GitHub Issues](https://github.com/gui-cs/Terminal.Gui/issues) +- [API Documentation](~/api/index.md) \ No newline at end of file diff --git a/docfx/docs/mouse.md b/docfx/docs/mouse.md index 552a6c585..56e8dff85 100644 --- a/docfx/docs/mouse.md +++ b/docfx/docs/mouse.md @@ -66,14 +66,14 @@ Here are some common mouse binding patterns used throughout Terminal.Gui: At the core of *Terminal.Gui*'s mouse API is the @Terminal.Gui.Input.MouseEventArgs class. The @Terminal.Gui.Input.MouseEventArgs class provides a platform-independent abstraction for common mouse events. Every mouse event can be fully described in a @Terminal.Gui.Input.MouseEventArgs instance, and most of the mouse-related APIs are simply helper functions for decoding a @Terminal.Gui.Input.MouseEventArgs. -When the user does something with the mouse, the `ConsoleDriver` maps the platform-specific mouse event into a `MouseEventArgs` and calls `Application.RaiseMouseEvent`. Then, `Application.RaiseMouseEvent` determines which `View` the event should go to. The `View.OnMouseEvent` method can be overridden or the `View.MouseEvent` event can be subscribed to, to handle the low-level mouse event. If the low-level event is not handled by a view, `Application` will then call the appropriate high-level helper APIs. For example, if the user double-clicks the mouse, `View.OnMouseClick` will be called/`View.MouseClick` will be raised with the event arguments indicating which mouse button was double-clicked. +When the user does something with the mouse, the driver maps the platform-specific mouse event into a `MouseEventArgs` and calls `IApplication.Mouse.RaiseMouseEvent`. Then, `IApplication.Mouse.RaiseMouseEvent` determines which `View` the event should go to. The `View.OnMouseEvent` method can be overridden or the `View.MouseEvent` event can be subscribed to, to handle the low-level mouse event. If the low-level event is not handled by a view, `IApplication` will then call the appropriate high-level helper APIs. For example, if the user double-clicks the mouse, `View.OnMouseClick` will be called/`View.MouseClick` will be raised with the event arguments indicating which mouse button was double-clicked. ### Mouse Event Processing Flow Mouse events are processed through the following workflow using the [Cancellable Work Pattern](cancellable-work-pattern.md): -1. **Driver Level**: The ConsoleDriver captures platform-specific mouse events and converts them to `MouseEventArgs` -2. **Application Level**: `Application.RaiseMouseEvent` determines the target view and routes the event +1. **Driver Level**: The driver captures platform-specific mouse events and converts them to `MouseEventArgs` +2. **Application Level**: `IApplication.Mouse.RaiseMouseEvent` determines the target view and routes the event 3. **View Level**: The target view processes the event through: - `OnMouseEvent` (virtual method that can be overridden) - `MouseEvent` event (for event subscribers) @@ -157,8 +157,8 @@ view.MouseStateChanged += (sender, e) => The @Terminal.Gui.App.Application.MouseEvent event can be used if an application wishes to receive all mouse events before they are processed by individual views: -```cs -Application.MouseEvent += (sender, e) => +```csharp +App.Mouse.MouseEvent += (sender, e) => { // Handle application-wide mouse events if (e.Flags.HasFlag(MouseFlags.Button3Clicked)) @@ -169,6 +169,24 @@ Application.MouseEvent += (sender, e) => }; ``` +For view-specific mouse handling that needs access to application context, use `View.App`: + +```csharp +public class MyView : View +{ + protected override bool OnMouseEvent(MouseEventArgs mouseEvent) + { + if (mouseEvent.Flags.HasFlag(MouseFlags.Button3Clicked)) + { + // Access application mouse functionality through View.App + App?.MouseEvent?.Invoke(this, mouseEvent); + return true; + } + return base.OnMouseEvent(mouseEvent); + } +} +``` + ## Mouse Enter/Leave Events The @Terminal.Gui.ViewBase.View.MouseEnter and @Terminal.Gui.ViewBase.View.MouseLeave events enable a View to take action when the mouse enters or exits the view boundary. Internally, this is used to enable @Terminal.Gui.ViewBase.View.Highlight functionality: @@ -218,3 +236,4 @@ The `MouseEventArgs` provides both coordinate systems: + diff --git a/docfx/docs/multitasking.md b/docfx/docs/multitasking.md index a4e98b8c5..a632c697c 100644 --- a/docfx/docs/multitasking.md +++ b/docfx/docs/multitasking.md @@ -9,7 +9,7 @@ Terminal.Gui applications run on a single main thread with an event loop that pr Terminal.Gui follows the standard UI toolkit pattern where **all UI operations must happen on the main thread**. Attempting to modify views or their properties from background threads will result in undefined behavior and potential crashes. ### The Golden Rule -> Always use `Application.Invoke()` to update the UI from background threads. +> Always use `App?.Invoke()` (from within a View) or `app.Invoke()` (with an IApplication instance) to update the UI from background threads. ## Background Operations @@ -47,6 +47,7 @@ private async void LoadDataButton_Clicked() When working with traditional threading APIs or when async/await isn't suitable: +**From within a View (recommended):** ```csharp private void StartBackgroundWork() { @@ -58,14 +59,41 @@ private void StartBackgroundWork() Thread.Sleep(50); // Simulate work // Marshal back to main thread for UI updates - Application.Invoke(() => + App?.Invoke(() => { progressBar.Fraction = i / 100f; statusLabel.Text = $"Progress: {i}%"; }); } - Application.Invoke(() => + App?.Invoke(() => + { + statusLabel.Text = "Complete!"; + }); + }); +} +``` + +**Using IApplication instance:** +```csharp +private void StartBackgroundWork(IApplication app) +{ + Task.Run(() => + { + // This code runs on a background thread + for (int i = 0; i <= 100; i++) + { + Thread.Sleep(50); // Simulate work + + // Marshal back to main thread for UI updates + app.Invoke(() => + { + progressBar.Fraction = i / 100f; + statusLabel.Text = $"Progress: {i}%"; + }); + } + + app.Invoke(() => { statusLabel.Text = "Complete!"; }); @@ -88,8 +116,8 @@ public class ClockView : View timeLabel = new Label { Text = DateTime.Now.ToString("HH:mm:ss") }; Add(timeLabel); - // Update every second - timerToken = Application.AddTimeout( + // Update every second using the View's App property + timerToken = App?.AddTimeout( TimeSpan.FromSeconds(1), UpdateTime ); @@ -105,7 +133,7 @@ public class ClockView : View { if (disposing && timerToken != null) { - Application.RemoveTimeout(timerToken); + App?.RemoveTimeout(timerToken); } base.Dispose(disposing); } @@ -206,21 +234,29 @@ Task.Run(() => }); ``` -### ✅ Do: Use Application.Invoke() +### ✅ Do: Use App.Invoke() or app.Invoke() ```csharp Task.Run(() => { - Application.Invoke(() => + // From within a View: + App?.Invoke(() => { label.Text = "This is safe!"; // Correct! }); + + // Or with IApplication instance: + // app.Invoke(() => { label.Text = "This is safe!"; }); }); ``` ### ❌ Don't: Forget to clean up timers ```csharp // Memory leak - timer keeps running after view is disposed -Application.AddTimeout(TimeSpan.FromSeconds(1), UpdateStatus); +// From within a View: +App?.AddTimeout(TimeSpan.FromSeconds(1), UpdateStatus); + +// Or with IApplication instance: +app.AddTimeout(TimeSpan.FromSeconds(1), UpdateStatus); ``` ### ✅ Do: Remove timers in Dispose @@ -229,7 +265,11 @@ protected override void Dispose(bool disposing) { if (disposing && timerToken != null) { - Application.RemoveTimeout(timerToken); + // From within a View, use App property + App?.RemoveTimeout(timerToken); + + // Or with IApplication instance: + // app.RemoveTimeout(timerToken); } base.Dispose(disposing); } diff --git a/docfx/docs/navigation.md b/docfx/docs/navigation.md index c83f72d50..6ebb64911 100644 --- a/docfx/docs/navigation.md +++ b/docfx/docs/navigation.md @@ -176,25 +176,30 @@ The @Terminal.Gui.App.ApplicationNavigation.AdvanceFocus method causes the focus The implementation is simple: ```cs -return Application.Current?.AdvanceFocus (direction, behavior); +return app.Current?.AdvanceFocus (direction, behavior); ``` -This method is called from the `Command` handlers bound to the application-scoped keybindings created during `Application.Init`. It is `public` as a convenience. +This method is called from the `Command` handlers bound to the application-scoped keybindings created during `app.Init()`. It is `public` as a convenience. -This method replaces about a dozen functions in v1 (scattered across `Application` and `Toplevel`). +**Note:** When accessing from within a View, use `App?.Current` instead of `Application.TopRunnable` (which is obsolete). + +This method replaces about a dozen functions in v1 (scattered across `Application` and `Runnable`). ### Application Navigation Examples ```csharp +var app = Application.Create(); +app.Init(); + // Listen for global focus changes -Application.Navigation.FocusedChanged += (sender, e) => +app.Navigation.FocusedChanged += (sender, e) => { - var focused = Application.Navigation.GetFocused(); + var focused = app.Navigation.GetFocused(); StatusBar.Text = $"Focused: {focused?.GetType().Name ?? "None"}"; }; // Prevent certain views from getting focus -Application.Navigation.FocusedChanging += (sender, e) => +app.Navigation.FocusedChanging += (sender, e) => { if (e.NewView is SomeRestrictedView) { @@ -374,7 +379,7 @@ In v1 `View` had `MostFocused` property that traversed up the view-hierarchy ret var focused = Application.Navigation.GetFocused(); // This replaces the v1 pattern: -// var focused = Application.Top.MostFocused; +// var focused = Application.TopRunnable.MostFocused; ``` ## How Does `View.Add/Remove` Work? diff --git a/docfx/docs/newinv2.md b/docfx/docs/newinv2.md index e416dd754..f19dd6687 100644 --- a/docfx/docs/newinv2.md +++ b/docfx/docs/newinv2.md @@ -1,235 +1,785 @@ -# Terminal.Gui v2 +# Terminal.Gui v2 - What's New This document provides an in-depth overview of the new features, improvements, and architectural changes in Terminal.Gui v2 compared to v1. -For information on how to port code from v1 to v2, see the [v1 To v2 Migration Guide](migratingfromv1.md). +**For migration guidance**, see the [v1 To v2 Migration Guide](migratingfromv1.md). -## Architectural Overhaul and Design Philosophy +## Table of Contents -Terminal.Gui v2 represents a fundamental rethinking of the library's architecture, driven by the need for better maintainability, performance, and developer experience. The primary design goals in v2 include: +- [Overview](#overview) +- [Architectural Overhaul](#architectural-overhaul) +- [Instance-Based Application Model](#instance-based-application-model) +- [IRunnable Architecture](#irunnable-architecture) +- [Modern Look & Feel](#modern-look--feel) +- [Simplified API](#simplified-api) +- [View Improvements](#view-improvements) +- [New and Improved Views](#new-and-improved-views) +- [Enhanced Input Handling](#enhanced-input-handling) +- [Configuration and Persistence](#configuration-and-persistence) +- [Debugging and Performance](#debugging-and-performance) +- [Additional Features](#additional-features) -- **Decoupling of Concepts**: In v1, many concepts like focus management, layout, and input handling were tightly coupled, leading to fragile and hard-to-predict behavior. v2 explicitly separates these concerns, resulting in a more modular and testable codebase. -- **Performance Optimization**: v2 reduces overhead in rendering, event handling, and view management by streamlining internal data structures and algorithms. -- **Modern .NET Practices**: The API has been updated to align with contemporary .NET conventions, such as using events with `EventHandler` and leveraging modern C# features like target-typed `new` and file-scoped namespaces. -- **Accessibility and Usability**: v2 places a stronger emphasis on ensuring that terminal applications are accessible, with improved keyboard navigation and visual feedback. +--- -This architectural shift has resulted in the removal of thousands of lines of redundant or overly complex code from v1, replaced with cleaner, more focused implementations. +## Overview -## Modern Look & Feel - Technical Details +Terminal.Gui v2 represents a fundamental redesign of the library's architecture, API, and capabilities. Key improvements include: -### TrueColor Support +- **Instance-Based Application Model** - Move from static singletons to `IApplication` instances +- **IRunnable Architecture** - Interface-based pattern for type-safe, runnable views +- **Proper Resource Management** - Full IDisposable pattern with automatic cleanup +- **Built-in Scrolling** - Every view supports scrolling inherently +- **24-bit TrueColor** - Full color spectrum by default +- **Enhanced Input** - Modern keyboard and mouse APIs +- **Improved Layout** - Simplified with adornments (Margin, Border, Padding) +- **Better Navigation** - Decoupled focus and tab navigation +- **Configuration System** - Persistent themes and settings +- **Logging and Metrics** - Built-in debugging and performance tracking -See the [Drawing Deep Dive](drawing.md) for complete details on the color system. +--- -- **Implementation**: v2 introduces 24-bit color support by extending the [Attribute](~/api/Terminal.Gui.Drawing.Attribute.yml) class to handle RGB values, with fallback to 16-color mode for older terminals. This is evident in the [IConsoleDriver](~/api/Terminal.Gui.Drivers.IConsoleDriver.yml) implementations, which now map colors to the appropriate terminal escape sequences. -- **Impact**: Developers can now use a full spectrum of colors without manual palette management, as seen in v1. The [Color](~/api/Terminal.Gui.Drawing.Color.yml) struct in v2 supports direct RGB input, and drivers handle the translation to terminal capabilities via [IConsoleDriver.SupportsTrueColor](~/api/Terminal.Gui.Drivers.IConsoleDriver.yml#Terminal_Gui_Drivers_IConsoleDriver_SupportsTrueColor). -- **Usage**: See the [ColorPicker](~/api/Terminal.Gui.Views.ColorPicker.yml) view for an example of how TrueColor is leveraged to provide a rich color selection UI. +## Architectural Overhaul -### Enhanced Borders and Padding (Adornments) +### Design Philosophy -See the [Layout Deep Dive](layout.md) for complete details on the adornments system. +Terminal.Gui v2 was designed with these core principles: -- **Implementation**: v2 introduces a new [Adornment](~/api/Terminal.Gui.ViewBase.Adornment.yml) class hierarchy, with [Margin](~/api/Terminal.Gui.ViewBase.Margin.yml), [Border](~/api/Terminal.Gui.ViewBase.Border.yml), and [Padding](~/api/Terminal.Gui.ViewBase.Padding.yml) as distinct view-like entities that wrap content. This is a significant departure from v1, where borders were often hardcoded or required custom drawing. -- **Code Change**: In v1, [View](~/api/Terminal.Gui.ViewBase.View.yml) had rudimentary border support via properties like `BorderStyle`. In v2, [View](~/api/Terminal.Gui.ViewBase.View.yml) has a [View.Border](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Border) property of type [Border](~/api/Terminal.Gui.ViewBase.Border.yml), which is itself a configurable entity with properties like [Thickness](~/api/Terminal.Gui.Drawing.Thickness.yml), [Border.LineStyle](~/api/Terminal.Gui.ViewBase.Border.yml#Terminal_Gui_ViewBase_Border_LineStyle), and [Border.Settings](~/api/Terminal.Gui.ViewBase.Border.yml#Terminal_Gui_ViewBase_Border_Settings). -- **Impact**: This allows for consistent border rendering across all views and simplifies custom view development by providing a reusable adornment framework. +1. **Separation of Concerns** - Layout, focus, input, and drawing are cleanly decoupled +2. **Performance** - Reduced overhead in rendering and event handling +3. **Modern .NET Practices** - Standard patterns like `EventHandler` and `IDisposable` +4. **Testability** - Views can be tested in isolation without global state +5. **Accessibility** - Improved keyboard navigation and visual feedback -### User Configurable Color Themes and Text Styles +### Result -See the [Configuration Deep Dive](config.md) and [Scheme Deep Dive](scheme.md) for complete details. +- Thousands of lines of redundant or complex code removed +- More modular and maintainable codebase +- Better performance and predictability +- Easier to extend and customize -- **Implementation**: v2 adds a [ConfigurationManager](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml) that supports loading and saving color schemes from configuration files. Themes are applied via [Scheme](~/api/Terminal.Gui.Drawing.Scheme.yml) objects, which can be customized per view or globally. Each [Attribute](~/api/Terminal.Gui.Drawing.Attribute.yml) in a [Scheme](~/api/Terminal.Gui.Drawing.Scheme.yml) now includes a [TextStyle](~/api/Terminal.Gui.Drawing.TextStyle.yml) property supporting Bold, Italic, Underline, Strikethrough, Blink, Reverse, and Faint text styles. -- **Impact**: Unlike v1, where color schemes were static or required manual override, v2 enables end-users to personalize not just colors but also text styling (bold, italic, underline, etc.) without code changes, significantly enhancing accessibility and user preference support. +--- -### Enhanced Unicode/Wide Character Support -- **Implementation**: v2 improves Unicode handling by correctly managing wide characters in text rendering and input processing. The [TextFormatter](~/api/Terminal.Gui.Text.TextFormatter.yml) class now accounts for Unicode width in layout calculations. -- **Impact**: This fixes v1 issues where wide characters (e.g., CJK scripts) could break layout or input handling, making Terminal.Gui v2 suitable for international applications. +## Instance-Based Application Model + +See the [Application Deep Dive](application.md) for complete details. + +v2 introduces an instance-based architecture that eliminates global state and enables multiple application contexts. + +### Key Features + +**IApplication Interface:** +- `Application.Create()` returns an `IApplication` instance +- Multiple applications can coexist (useful for testing) +- Each instance manages its own driver, session stack, and resources + +**View.App Property:** +- Every view has an `App` property referencing its `IApplication` context +- Views access application services through `App` (driver, session management, etc.) +- Eliminates static dependencies, improving testability + +**Session Management:** +- `SessionStack` tracks all running sessions as a stack +- `TopRunnable` property references the currently active session +- `Begin()` and `End()` methods manage session lifecycle + +### Example + +```csharp +// Instance-based pattern (recommended) +IApplication app = Application.Create ().Init (); +Window window = new () { Title = "My App" }; +app.Run (window); +window.Dispose (); +app.Dispose (); + +// With using statement for automatic disposal +using (IApplication app = Application.Create ().Init ()) +{ + Window window = new () { Title = "My App" }; + app.Run (window); + window.Dispose (); +} // app.Dispose() called automatically + +// Access from within a view +public class MyView : View +{ + public void DoWork () + { + App?.Driver.Move (0, 0); + App?.TopRunnableView?.SetNeedsDraw (); + } +} +``` + +### Benefits + +- **Testability** - Mock `IApplication` for unit tests +- **No Global State** - Multiple contexts can coexist +- **Clear Ownership** - Views explicitly know their context +- **Proper Cleanup** - IDisposable ensures resources are released + +### Resource Management + +v2 implements full `IDisposable` pattern: + +```csharp +// Recommended: using statement +using (IApplication app = Application.Create ().Init ()) +{ + app.Run (); + MyResult? result = app.GetResult (); +} + +// Ensures: +// - Input thread stopped cleanly +// - Driver resources released +// - No thread leaks in tests +``` + +**Important Changes:** +- `Shutdown()` method is obsolete - use `Dispose()` instead +- Always dispose applications (especially in tests) +- Input thread runs at ~50 polls/second (20ms throttle) until disposed + +--- + +## IRunnable Architecture + +See the [Application Deep Dive](application.md) for complete details. + +v2 introduces `IRunnable` - an interface-based pattern for runnable views with type-safe results. + +### Key Features + +**Interface-Based:** +- Implement `IRunnable` without inheriting from `Runnable` +- Any view can be runnable +- Decouples runnability from view hierarchy + +**Type-Safe Results:** +- Generic `TResult` parameter provides compile-time type safety +- `null` indicates cancellation/non-acceptance +- Results extracted before disposal in lifecycle events + +**Lifecycle Events (CWP-Compliant):** +- `IsRunningChanging` - Cancellable, before stack change +- `IsRunningChanged` - Non-cancellable, after stack change +- `IsModalChanging` - Cancellable, before modal state change +- `IsModalChanged` - Non-cancellable, after modal state change + +### Example + +```csharp +public class FileDialog : Runnable +{ + private TextField _pathField; + + public FileDialog () + { + Title = "Select File"; + _pathField = new () { Width = Dim.Fill () }; + Add (_pathField); + + Button okButton = new () { Text = "OK", IsDefault = true }; + okButton.Accepting += (s, e) => + { + Result = _pathField.Text; + Application.RequestStop (); + }; + AddButton (okButton); + } + + protected override bool OnIsRunningChanging (bool oldValue, bool newValue) + { + if (!newValue) // Stopping - extract result before disposal + { + Result = _pathField?.Text; + + // Optionally cancel stop + if (HasUnsavedChanges ()) + { + return true; // Cancel + } + } + return base.OnIsRunningChanging (oldValue, newValue); + } +} + +// Use with fluent API +using (IApplication app = Application.Create ().Init ()) +{ + app.Run (); + string? path = app.GetResult (); + + if (path is { }) + { + OpenFile (path); + } +} +``` + +### Fluent API + +v2 enables elegant method chaining: + +```csharp +// Concise and readable +using (IApplication app = Application.Create ().Init ()) +{ + app.Run (); + Color? result = app.GetResult (); +} +``` + +**Key Methods:** +- `Init()` - Returns `IApplication` for chaining +- `Run()` - Creates and runs runnable, returns `IApplication` +- `GetResult()` - Extract typed result after run +- `Dispose()` - Release all resources + +### Disposal Semantics + +**"Whoever creates it, owns it":** + +| Method | Creator | Owner | Disposal | +|--------|---------|-------|----------| +| `Run()` | Framework | Framework | Automatic when returns | +| `Run(IRunnable)` | Caller | Caller | Manual by caller | + +```csharp +// Framework ownership - automatic disposal +app.Run (); // Dialog disposed automatically + +// Caller ownership - manual disposal +MyDialog dialog = new (); +app.Run (dialog); +dialog.Dispose (); // Caller must dispose +``` + +### Benefits + +- **Type Safety** - No casting, compile-time checking +- **Clean Lifecycle** - CWP-compliant events +- **Automatic Disposal** - Framework manages created runnables +- **Flexible** - Works with any View, not just Toplevel + +--- + +## Modern Look & Feel + +### 24-bit TrueColor Support + +See the [Drawing Deep Dive](drawing.md) for complete details. + +v2 provides full 24-bit color support by default: + +- **Implementation**: [Attribute](~/api/Terminal.Gui.Drawing.Attribute.yml) class handles RGB values +- **Fallback**: Automatic 16-color mode for older terminals +- **Driver Support**: [IConsoleDriver.SupportsTrueColor](~/api/Terminal.Gui.Drivers.IConsoleDriver.yml#Terminal_Gui_Drivers_IConsoleDriver_SupportsTrueColor) detection +- **Usage**: Direct RGB input via [Color](~/api/Terminal.Gui.Drawing.Color.yml) struct + +```csharp +// 24-bit RGB color +Color customColor = new (0xFF, 0x99, 0x00); + +// Or use named colors (ANSI-compliant) +Color color = Color.Yellow; // Was "Brown" in v1 +``` + +### Enhanced Borders and Adornments + +See the [Layout Deep Dive](layout.md) for complete details. + +v2 introduces a comprehensive [Adornment](~/api/Terminal.Gui.ViewBase.Adornment.yml) system: + +- **[Margin](~/api/Terminal.Gui.ViewBase.Margin.yml)** - Transparent spacing outside the border +- **[Border](~/api/Terminal.Gui.ViewBase.Border.yml)** - Visual frame with title, multiple styles +- **[Padding](~/api/Terminal.Gui.ViewBase.Padding.yml)** - Spacing inside the border + +**Border Features:** +- Multiple [LineStyle](~/api/Terminal.Gui.Drawing.LineStyle.yml) options: Single, Double, Heavy, Rounded, Dashed, Dotted +- Automatic line intersection handling via [LineCanvas](~/api/Terminal.Gui.Drawing.LineCanvas.yml) +- Configurable thickness per side via [Thickness](~/api/Terminal.Gui.Drawing.Thickness.yml) +- Title display with alignment options + +```csharp +view.BorderStyle = LineStyle.Double; +view.Border.Thickness = new (1); +view.Title = "My View"; + +view.Margin.Thickness = new (2); +view.Padding.Thickness = new (1); +``` + +### User Configurable Themes + +See the [Configuration Deep Dive](config.md) and [Scheme Deep Dive](scheme.md) for details. + +v2 adds comprehensive theme support: + +- **ConfigurationManager**: Loads/saves color schemes from files +- **Schemes**: Applied per-view or globally via [Scheme](~/api/Terminal.Gui.Drawing.Scheme.yml) +- **Text Styles**: [TextStyle](~/api/Terminal.Gui.Drawing.TextStyle.yml) supports Bold, Italic, Underline, Strikethrough, Blink, Reverse, Faint +- **User Customization**: End-users can personalize without code changes + +```csharp +// Apply a theme +ConfigurationManager.Themes.Theme = "Dark"; + +// Customize text style +view.Scheme.Normal = new ( + Color.White, + Color.Black, + TextStyle.Bold | TextStyle.Underline +); +``` ### LineCanvas -See the [Drawing Deep Dive](drawing.md) for complete details on LineCanvas and the drawing system. +See the [Drawing Deep Dive](drawing.md) for complete details. -- **Implementation**: A new [LineCanvas](~/api/Terminal.Gui.Drawing.LineCanvas.yml) class provides a drawing API for creating lines and shapes using box-drawing characters. It includes logic for auto-joining lines at intersections, selecting appropriate glyphs dynamically. -- **Code Example**: In v2, [LineCanvas](~/api/Terminal.Gui.Drawing.LineCanvas.yml) is used internally by views like [Border](~/api/Terminal.Gui.ViewBase.Border.yml) and [Line](~/api/Terminal.Gui.Views.Line.yml) to draw clean, connected lines, a feature absent in v1. -- **Impact**: Developers can create complex diagrams or UI elements with minimal effort, improving the visual fidelity of terminal applications. +[LineCanvas](~/api/Terminal.Gui.Drawing.LineCanvas.yml) provides sophisticated line drawing: -## Simplified API - Under the Hood +- Auto-joining lines at intersections +- Multiple line styles (Single, Double, Heavy, etc.) +- Automatic glyph selection for corners and T-junctions +- Used by [Border](~/api/Terminal.Gui.ViewBase.Border.yml), [Line](~/api/Terminal.Gui.Views.Line.yml), and custom views -### API Consistency and Reduction -- **Change**: v2 revisits every public API, consolidating redundant methods and properties. For example, v1 had multiple focus-related methods scattered across [View](~/api/Terminal.Gui.ViewBase.View.yml) and [Application](~/api/Terminal.Gui.App.Application.yml); v2 centralizes these in [ApplicationNavigation](~/api/Terminal.Gui.App.ApplicationNavigation.yml). -- **Impact**: This reduces the learning curve for new developers and minimizes the risk of using deprecated or inconsistent APIs. -- **Example**: The v1 `View.MostFocused` property is replaced by `Application.Navigation.GetFocused()`, reducing traversal overhead and clarifying intent. +```csharp +// Line view uses LineCanvas +Line line = new () { Orientation = Orientation.Horizontal }; +line.LineStyle = LineStyle.Double; +``` + +### Gradients + +See the [Drawing Deep Dive](drawing.md) for details. + +v2 adds gradient support: + +- [Gradient](~/api/Terminal.Gui.Drawing.Gradient.yml) - Color transitions +- [GradientFill](~/api/Terminal.Gui.Drawing.GradientFill.yml) - Fill patterns +- Uses TrueColor for smooth effects +- Apply to borders, backgrounds, or custom elements + +```csharp +Gradient gradient = new (Color.Blue, Color.Cyan); +view.BackgroundGradient = new (gradient, Orientation.Vertical); +``` + +--- + +## Simplified API + +### Consistency and Reduction + +v2 consolidates redundant APIs: + +- **Centralized Navigation**: [ApplicationNavigation](~/api/Terminal.Gui.App.ApplicationNavigation.yml) replaces scattered focus methods +- **Standard Events**: All events use `EventHandler` pattern +- **Consistent Naming**: Methods follow .NET conventions (e.g., `OnHasFocusChanged`) +- **Reduced Surface**: Fewer but more powerful APIs + +**Example:** +```csharp +// v1 - Multiple scattered methods +View.MostFocused +View.EnsureFocus () +View.FocusNext () + +// v2 - Centralized +Application.Navigation.GetFocused () +view.SetFocus () +view.AdvanceFocus () +``` ### Modern .NET Standards -- **Change**: Events in v2 use `EventHandler` instead of v1's custom delegate types. Methods follow consistent naming (e.g., `OnHasFocusChanged` vs. v1's varied naming). -- **Impact**: Developers familiar with .NET conventions will find v2 more intuitive, and tools like IntelliSense provide better support due to standardized signatures. -### Performance Gains -- **Change**: v2 optimizes rendering by minimizing unnecessary redraws through a smarter `NeedsDisplay` system and reducing object allocations in hot paths like event handling. -- **Impact**: Applications built with v2 will feel snappier, especially in complex UIs with many views or frequent updates, addressing v1 performance bottlenecks. +- Events: `EventHandler` instead of custom delegates +- Properties: Consistent get/set patterns +- Disposal: IDisposable throughout +- Nullability: Enabled in core library files -## View Improvements - Deep Dive +### Performance Optimizations -### Deterministic View Lifetime Management -- **v1 Issue**: Lifetime rules for `View` objects were unclear, leading to memory leaks or premature disposal, especially with `Application.Run`. -- **v2 Solution**: v2 defines explicit rules for view disposal and ownership, enforced by unit tests. `Application.Run` now clearly manages the lifecycle of `Toplevel` views, ensuring deterministic cleanup. -- **Impact**: Developers can predict when resources are released, reducing bugs related to dangling references or uninitialized states. +v2 reduces overhead through: -### Adornments Framework +- Smarter `NeedsDraw` system (only draw what changed) +- Reduced allocations in hot paths (event handling, rendering) +- Optimized layout calculations +- Efficient input processing -See the [Layout Deep Dive](layout.md) and [View Deep Dive](View.md) for complete details. +**Result**: Snappier UIs, especially with many views or frequent updates -- **Technical Detail**: Adornments are implemented as nested views that surround the content area, each with its own drawing and layout logic. [Border](~/api/Terminal.Gui.ViewBase.Border.yml) supports multiple [LineStyle](~/api/Terminal.Gui.Drawing.LineStyle.yml) options (Single, Double, Heavy, Rounded, Dashed, Dotted) with automatic line intersection handling via [LineCanvas](~/api/Terminal.Gui.Drawing.LineCanvas.yml). -- **Code Change**: In v2, [View](~/api/Terminal.Gui.ViewBase.View.yml) has properties [View.Margin](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Margin), [View.Border](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Border), and [View.Padding](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Padding), each configurable independently, unlike v1's limited border support. -- **Impact**: This modular approach allows for reusable UI elements and simplifies creating visually consistent applications. +--- -### Built-in Scrolling/Virtual Content Area +## View Improvements -See the [Scrolling Deep Dive](scrolling.md) and [Layout Deep Dive](layout.md) for complete details. +### Deterministic Lifetime Management -- **v1 Issue**: Scrolling required using `ScrollView` or manual offset management, which was error-prone. -- **v2 Solution**: Every [View](~/api/Terminal.Gui.ViewBase.View.yml) in v2 has a [View.Viewport](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Viewport) rectangle representing the visible portion of a potentially larger content area defined by [View.GetContentSize](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_GetContentSize). Changing `Viewport.Location` scrolls the content. -- **Code Example**: In v2, [TextView](~/api/Terminal.Gui.Views.TextView.yml) uses this to handle large text buffers without additional wrapper views. -- **Impact**: Simplifies implementing scrollable content and reduces the need for specialized container views. +v2 clarifies view ownership: -### Improved ScrollBar -- **Change**: v2 replaces `ScrollBarView` with [ScrollBar](~/api/Terminal.Gui.Views.ScrollBar.yml), a cleaner implementation integrated with the built-in scrolling system. [View.VerticalScrollBar](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_VerticalScrollBar) and [View.HorizontalScrollBar](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_HorizontalScrollBar) properties enable scroll bars with minimal code. -- **Impact**: Developers can add scroll bars to any view without managing separate view hierarchies, a significant usability improvement over v1. +- Explicit disposal rules enforced by unit tests +- `Application.Run` manages `Runnable` lifecycle +- SubViews disposed automatically with SuperView +- Clear documentation of ownership semantics -### DimAuto, PosAnchorEnd, and PosAlign +### Built-in Scrolling -See the [Layout Deep Dive](layout.md) and [DimAuto Deep Dive](dimauto.md) for complete details. +See the [Scrolling Deep Dive](scrolling.md) for complete details. -- **[Dim.Auto](~/api/Terminal.Gui.Dim.yml#Terminal_Gui_Dim_Auto_Terminal_Gui_DimAutoStyle_Terminal_Gui_Dim_Terminal_Gui_Dim_)**: Automatically sizes views based on content or subviews, reducing manual layout calculations. -- **[Pos.AnchorEnd](~/api/Terminal.Gui.Pos.yml#Terminal_Gui_Pos_AnchorEnd_System_Int32_)**: Allows anchoring to the right or bottom of a superview, enabling flexible layouts not easily achievable in v1. -- **[Pos.Align](~/api/Terminal.Gui.Pos.yml)**: Provides alignment options (left, center, right) for multiple views, streamlining UI design. -- **Impact**: These features reduce boilerplate layout code and support responsive designs in terminal constraints. +Every [View](~/api/Terminal.Gui.ViewBase.View.yml) supports scrolling inherently: + +- **[Viewport](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Viewport)** - Visible rectangle (can have non-zero location) +- **[GetContentSize](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_GetContentSize)** - Returns total content size +- **[SetContentSize](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_SetContentSize_System_Nullable_System_Drawing_Size__)** - Sets scrollable content size +- **ScrollVertical/ScrollHorizontal** - Helper methods + +**No need for ScrollView wrapper!** + +```csharp +// Enable scrolling +view.SetContentSize (new (100, 100)); + +// Scroll by changing Viewport location +view.ScrollVertical (5); +view.ScrollHorizontal (3); + +// Built-in scrollbars +view.VerticalScrollBar.Visible = true; +view.HorizontalScrollBar.Visible = true; +view.VerticalScrollBar.AutoShow = true; +``` + +### Enhanced ScrollBar + +v2 replaces `ScrollBarView` with [ScrollBar](~/api/Terminal.Gui.Views.ScrollBar.yml): + +- Cleaner implementation +- Automatic show/hide +- Proportional sizing with `ScrollSlider` +- Integrated with View's scrolling system +- Simple to add via [View.VerticalScrollBar](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_VerticalScrollBar) / [View.HorizontalScrollBar](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_HorizontalScrollBar) + +### Advanced Layout Features + +See the [Layout Deep Dive](layout.md) and [DimAuto Deep Dive](dimauto.md) for details. + +**[Dim.Auto](~/api/Terminal.Gui.Dim.yml#Terminal_Gui_Dim_Auto_Terminal_Gui_DimAutoStyle_Terminal_Gui_Dim_Terminal_Gui_Dim_):** +- Automatically sizes views based on content or subviews +- Reduces manual layout calculations +- Supports multiple styles (Text, Content, Position) + +**[Pos.AnchorEnd](~/api/Terminal.Gui.Pos.yml#Terminal_Gui_Pos_AnchorEnd_System_Int32_):** +- Anchor to right or bottom of SuperView +- Enables flexible, responsive layouts + +**[Pos.Align](~/api/Terminal.Gui.Pos.yml):** +- Align multiple views (Left, Center, Right) +- Simplifies creating aligned layouts + +```csharp +// Auto-size based on text +label.Width = Dim.Auto (); +label.Height = Dim.Auto (); + +// Anchor to bottom-right +button.X = Pos.AnchorEnd (10); +button.Y = Pos.AnchorEnd (2); + +// Center align +label1.X = Pos.Center (); +label2.X = Pos.Center (); +``` ### View Arrangement See the [Arrangement Deep Dive](arrangement.md) for complete details. -- **Technical Detail**: The [View.Arrangement](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Arrangement) property supports flags like [ViewArrangement.Movable](~/api/Terminal.Gui.ViewBase.ViewArrangement.yml), [ViewArrangement.Resizable](~/api/Terminal.Gui.ViewBase.ViewArrangement.yml), and [ViewArrangement.Overlapped](~/api/Terminal.Gui.ViewBase.ViewArrangement.yml), enabling dynamic UI interactions via keyboard and mouse. -- **Code Example**: [Window](~/api/Terminal.Gui.Views.Window.yml) in v2 uses [View.Arrangement](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Arrangement) to allow dragging and resizing, a feature requiring custom logic in v1. -- **Impact**: Developers can create desktop-like experiences in the terminal with minimal effort. +[View.Arrangement](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Arrangement) enables interactive UI: -### Keyboard Navigation Overhaul +- **[ViewArrangement.Movable](~/api/Terminal.Gui.ViewBase.ViewArrangement.yml)** - Drag with mouse or move with keyboard +- **[ViewArrangement.Resizable](~/api/Terminal.Gui.ViewBase.ViewArrangement.yml)** - Resize edges with mouse or keyboard +- **[ViewArrangement.Overlapped](~/api/Terminal.Gui.ViewBase.ViewArrangement.yml)** - Z-order management for overlapping views -See the [Navigation Deep Dive](navigation.md) for complete details on the navigation system. +**Arrangement Key**: Press `Ctrl+F5` (configurable via [Application.ArrangeKey](~/api/Terminal.Gui.App.Application.yml#Terminal_Gui_App_Application_ArrangeKey)) to enter arrange mode -- **v1 Issue**: Navigation was inconsistent, with coupled concepts like [View.CanFocus](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_CanFocus) and `TabStop` leading to unpredictable focus behavior. -- **v2 Solution**: v2 decouples these concepts, introduces [TabBehavior](~/api/Terminal.Gui.Input.TabBehavior.yml) enum for clearer intent (`TabStop`, `TabGroup`, `NoStop`), and centralizes navigation logic in [ApplicationNavigation](~/api/Terminal.Gui.App.ApplicationNavigation.yml). -- **Impact**: Ensures accessibility by guaranteeing keyboard access to all focusable elements, with unit tests enforcing navigation keys on built-in views. +```csharp +// Movable and resizable window +window.Arrangement = ViewArrangement.Movable | ViewArrangement.Resizable; -### Sizable/Movable Views -- **Implementation**: Any view can be made resizable or movable by setting [View.Arrangement](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_Arrangement) flags, with built-in mouse and keyboard handlers for interaction. -- **Impact**: Enhances user experience by allowing runtime UI customization, a feature limited to specific views like [Window](~/api/Terminal.Gui.Views.Window.yml) in v1. +// Overlapped windows +container.Arrangement = ViewArrangement.Overlapped; +``` -## New and Improved Built-in Views - Detailed Analysis +### Enhanced Navigation -See the [Views Overview](views.md) for a complete catalog of all built-in views. +See the [Navigation Deep Dive](navigation.md) for complete details. -### New Views +v2 decouples navigation concepts: -v2 introduces many new View subclasses that were not present in v1: +- **[CanFocus](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_CanFocus)** - Whether view can receive focus (defaults to `false` in v2) +- **[TabStop](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_TabStop)** - [TabBehavior](~/api/Terminal.Gui.Input.TabBehavior.yml) enum (TabStop, TabGroup, NoStop) +- **[ApplicationNavigation](~/api/Terminal.Gui.App.ApplicationNavigation.yml)** - Centralized navigation logic -- **Bar**: A foundational view for horizontal or vertical layouts of `Shortcut` or other items, used in `StatusBar`, `MenuBarv2`, and `PopoverMenu`. -- **CharMap**: A scrollable, searchable Unicode character map with support for the Unicode Character Database (UCD) API, enabling users to browse and select from all Unicode codepoints with detailed character information. See [Character Map Deep Dive](CharacterMap.md). -- **ColorPicker**: Leverages TrueColor for a comprehensive color selection experience, supporting multiple color models (HSV, RGB, HSL, Grayscale) with interactive color bars. -- **DatePicker**: Provides a calendar-based date selection UI with month/year navigation, leveraging v2's improved drawing and navigation systems. -- **FlagSelector**: Enables selection of non-mutually-exclusive flags with checkbox-based UI, supporting both dictionary-based and enum-based flag definitions. -- **GraphView**: Displays graphs (bar charts, scatter plots, line graphs) with flexible axes, labels, scaling, scrolling, and annotations - bringing data visualization to the terminal. -- **Line**: Draws single horizontal or vertical lines using the `LineCanvas` system with automatic intersection handling and multiple line styles (Single, Double, Heavy, Rounded, Dashed, Dotted). -- **Menuv2 System** (MenuBarv2, PopoverMenu): A completely redesigned menu system built on the `Bar` infrastructure, providing a more flexible and visually appealing menu experience. -- **NumericUpDown**: Type-safe numeric input with increment/decrement buttons, supporting `int`, `long`, `float`, `double`, and `decimal` types. -- **OptionSelector**: Displays a list of mutually-exclusive options with checkbox-style UI (radio button equivalent), supporting both horizontal and vertical orientations. -- **Shortcut**: An opinionated view for displaying commands with key bindings, simplifying status bar and toolbar creation with consistent visual presentation. -- **Slider**: A sophisticated control for range selection with multiple styles (horizontal/vertical bars, indicators), multiple options per slider, configurable legends, and event-driven value changes. -- **SpinnerView**: Displays animated spinner glyphs to indicate progress or activity, with multiple built-in styles (Line, Dots, Bounce, etc.) and support for auto-spin or manual animation control. +**Navigation Keys (Configurable):** +- `Tab` / `Shift+Tab` - Next/previous TabStop +- `F6` / `Shift+F6` - Next/previous TabGroup +- Arrow keys - Same as Tab navigation -### Improved Views +```csharp +// Configure navigation keys +Application.NextTabStopKey = Key.Tab; +Application.PrevTabStopKey = Key.Tab.WithShift; +Application.NextTabGroupKey = Key.F6; +Application.PrevTabGroupKey = Key.F6.WithShift; -Many existing views from v1 have been significantly enhanced in v2: +// Set tab behavior +view.CanFocus = true; +view.TabStop = TabBehavior.TabStop; // Normal tab navigation +``` -- **FileDialog** (OpenDialog, SaveDialog): Completely modernized with `TreeView` for hierarchical file navigation, Unicode glyphs for icons, search functionality, and history tracking - far surpassing v1's basic file dialogs. -- **ScrollBar**: Replaces v1's `ScrollBarView` with a cleaner implementation featuring automatic show/hide, proportional sizing with `ScrollSlider`, and seamless integration with View's built-in scrolling system. -- **StatusBar**: Rebuilt on the `Bar` infrastructure, providing more flexible item management, automatic sizing, and better visual presentation. -- **TableView**: Massively enhanced with support for generic collections (via `IEnumerableTableSource`), checkboxes with `CheckBoxTableSourceWrapper`, tree structures via `TreeTableSource`, custom cell rendering, and significantly improved performance. See [TableView Deep Dive](tableview.md). -- **ScrollView**: Deprecated in favor of View's built-in scrolling capabilities, eliminating the need for wrapper views and simplifying scrollable content implementation. +--- -## Beauty - Visual Enhancements +## New and Improved Views -### Borders +See the [Views Overview](views.md) for a complete catalog. -See the [Drawing Deep Dive](drawing.md) for complete details on borders and LineCanvas. +### New Views in v2 -- **Implementation**: Uses the [Border](~/api/Terminal.Gui.ViewBase.Border.yml) adornment with [LineStyle](~/api/Terminal.Gui.Drawing.LineStyle.yml) options and [LineCanvas](~/api/Terminal.Gui.Drawing.LineCanvas.yml) for automatic line intersection handling. -- **Impact**: Adds visual polish to UI elements, making applications feel more refined compared to v1's basic borders. +- **[Bar](~/api/Terminal.Gui.Views.Bar.yml)** - Foundation for StatusBar, MenuBar, PopoverMenu +- **[CharMap](~/api/Terminal.Gui.Views.CharMap.yml)** - Scrollable Unicode character map with UCD support +- **[ColorPicker](~/api/Terminal.Gui.Views.ColorPicker.yml)** - TrueColor selection with multiple color models +- **[DatePicker](~/api/Terminal.Gui.Views.DatePicker.yml)** - Calendar-based date selection +- **[FlagSelector](~/api/Terminal.Gui.Views.FlagSelector.yml)** - Non-mutually-exclusive flag selection +- **[GraphView](~/api/Terminal.Gui.Views.GraphView.yml)** - Data visualization (bar, scatter, line graphs) +- **[Line](~/api/Terminal.Gui.Views.Line.yml)** - Single lines with LineCanvas integration +- **[NumericUpDown](~/api/Terminal.Gui.Views.NumericUpDown-1.yml)** - Type-safe numeric input +- **[OptionSelector](~/api/Terminal.Gui.Views.OptionSelector.yml)** - Mutually-exclusive option selection +- **[Shortcut](~/api/Terminal.Gui.Views.Shortcut.yml)** - Command display with key bindings +- **[Slider](~/api/Terminal.Gui.Views.Slider.yml)** - Sophisticated range selection control +- **[SpinnerView](~/api/Terminal.Gui.Views.SpinnerView.yml)** - Animated progress indicators -### Gradient +### Significantly Improved Views -See the [Drawing Deep Dive](drawing.md) for complete details on gradients and fills. +- **[FileDialog](~/api/Terminal.Gui.Views.FileDialog.yml)** - TreeView navigation, Unicode icons, search, history +- **[ScrollBar](~/api/Terminal.Gui.Views.ScrollBar.yml)** - Clean implementation with auto-show +- **[StatusBar](~/api/Terminal.Gui.Views.StatusBar.yml)** - Rebuilt on Bar infrastructure +- **[TableView](~/api/Terminal.Gui.Views.TableView.yml)** - Generic collections, checkboxes, tree structures, custom rendering +- **[MenuBar](~/api/Terminal.Gui.Views.MenuBar.yml)** / **[PopoverMenu](~/api/Terminal.Gui.Views.PopoverMenu.yml)** - Redesigned menu system -- **Implementation**: [Gradient](~/api/Terminal.Gui.Drawing.Gradient.yml) and [GradientFill](~/api/Terminal.Gui.Drawing.GradientFill.yml) APIs allow rendering color transitions across view elements, using TrueColor for smooth effects. -- **Impact**: Enables modern-looking UI elements like gradient borders or backgrounds, not possible in v1 without custom drawing. +--- -## Configuration Manager - Persistence and Customization +## Enhanced Input Handling -See the [Configuration Deep Dive](config.md) for complete details on the configuration system. +### Keyboard API -- **Technical Detail**: [ConfigurationManager](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml) in v2 uses JSON to persist settings like themes, key bindings, and view properties to disk via [SettingsScope](~/api/Terminal.Gui.Configuration.SettingsScope.yml) and [ConfigLocations](~/api/Terminal.Gui.Configuration.ConfigLocations.yml). -- **Code Change**: Unlike v1, where settings were ephemeral or hardcoded, v2 provides a centralized system for loading/saving configurations using the [ConfigurationManagerAttribute](~/api/Terminal.Gui.Configuration.ConfigurationManagerAttribute.yml). -- **Impact**: Allows for user-specific customizations and library-wide settings without recompilation, enhancing flexibility. +See the [Keyboard Deep Dive](keyboard.md) and [Command Deep Dive](command.md) for details. -## Logging & Metrics - Debugging and Performance +**[Key](~/api/Terminal.Gui.Input.Key.yml) Class:** +- Replaces v1's `KeyEvent` struct +- High-level abstraction over raw key codes +- Properties for modifiers and key type +- Platform-independent -See the [Logging Deep Dive](logging.md) for complete details on the logging and metrics system. +```csharp +// Check keys +if (key == Key.Enter) { } +if (key == Key.C.WithCtrl) { } -- **Implementation**: v2 introduces a multi-level logging system via [Logging](~/api/Terminal.Gui.App.Logging.yml) for internal operations (e.g., rendering, input handling) using Microsoft.Extensions.Logging.ILogger, and metrics for performance tracking via [Logging.Meter](~/api/Terminal.Gui.App.Logging.yml#Terminal_Gui_App_Logging_Meter) (e.g., frame rate, redraw times, iteration timing). -- **Impact**: Developers can diagnose issues like slow redraws or terminal compatibility problems using standard .NET logging frameworks (Serilog, NLog, etc.) and metrics tools (dotnet-counters), a capability absent in v1, reducing guesswork in debugging. +// Modifiers +if (key.Shift) { } +if (key.Ctrl) { } +``` -## Sixel Image Support - Graphics in Terminal -- **Technical Detail**: v2 supports the Sixel protocol for rendering images and animations directly in compatible terminals (e.g., Windows Terminal, xterm) via [SixelEncoder](~/api/Terminal.Gui.Drawing.SixelEncoder.yml). -- **Code Change**: New rendering logic in console drivers detects terminal support via [SixelSupportDetector](~/api/Terminal.Gui.Drawing.SixelSupportDetector.yml) and handles Sixel data transmission through [SixelToRender](~/api/Terminal.Gui.Drawing.SixelToRender.yml). -- **Impact**: Brings graphical capabilities to terminal applications, far beyond v1's text-only rendering, opening up new use cases like image previews. +**Key Bindings:** +- Map keys to [Command](~/api/Terminal.Gui.Input.Command.yml) enums +- Scopes: Application, Focused, HotKey +- Views declare supported commands via [View.AddCommand](~/api/Terminal.Gui.ViewBase.View.yml) -## Updated Keyboard API - Comprehensive Input Handling +```csharp +// Add command handler +view.AddCommand (Command.Accept, HandleAccept); -See the [Keyboard Deep Dive](keyboard.md) and [Command Deep Dive](command.md) for complete details. +// Bind key to command +view.KeyBindings.Add (Key.Enter, Command.Accept); -### Key Class -- **Change**: Replaces v1's `KeyEvent` struct with a [Key](~/api/Terminal.Gui.Input.Key.yml) class, providing a high-level abstraction over raw key codes with properties for modifiers and key type. -- **Impact**: Simplifies keyboard handling by abstracting platform differences, making code more portable and readable. +private bool HandleAccept () +{ + // Handle command + return true; // Handled +} +``` -### Key Bindings -- **Implementation**: v2 introduces a binding system mapping keys to [Command](~/api/Terminal.Gui.Input.Command.yml) enums via [View.KeyBindings](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_KeyBindings), with scopes (`Application`, `Focused`, `HotKey`) for priority. -- **Impact**: Replaces v1's ad-hoc key handling with a structured approach, allowing views to declare supported commands via [View.AddCommand](~/api/Terminal.Gui.ViewBase.View.yml) and customize responses easily. -- **Example**: [TextField](~/api/Terminal.Gui.Views.TextField.yml) in v2 binds `Key.Tab` to text insertion rather than focus change, customizable by developers. +**Configurable Keys:** +- [Application.QuitKey](~/api/Terminal.Gui.App.Application.yml#Terminal_Gui_App_Application_QuitKey) - Close app (default: Esc) +- [Application.ArrangeKey](~/api/Terminal.Gui.App.Application.yml#Terminal_Gui_App_Application_ArrangeKey) - Arrange mode (default: Ctrl+F5) +- Navigation keys (Tab, F6, arrows) -### Default Close Key -- **Change**: Changed from `Ctrl+Q` in v1 to `Esc` in v2 for closing apps or [Toplevel](~/api/Terminal.Gui.Views.Toplevel.yml) views, accessible via [Application.QuitKey](~/api/Terminal.Gui.App.Application.yml#Terminal_Gui_App_Application_QuitKey). -- **Impact**: Aligns with common user expectations, improving UX consistency across terminal applications. +### Mouse API -## Updated Mouse API - Enhanced Interaction +See the [Mouse Deep Dive](mouse.md) for complete details. -See the [Mouse Deep Dive](mouse.md) for complete details on mouse handling. +**[MouseEventArgs](~/api/Terminal.Gui.Input.MouseEventArgs.yml):** +- Replaces v1's `MouseEventEventArgs` +- Cleaner structure for mouse data +- [MouseFlags](~/api/Terminal.Gui.Input.MouseFlags.yml) for button states -### MouseEventArgs Class -- **Change**: Replaces v1's `MouseEventEventArgs` with [MouseEventArgs](~/api/Terminal.Gui.Input.MouseEventArgs.yml), providing a cleaner structure for mouse data (position, flags via [MouseFlags](~/api/Terminal.Gui.Input.MouseFlags.yml)). -- **Impact**: Simplifies event handling with a more intuitive API, reducing errors in mouse interaction logic. +**Granular Events:** +- [View.MouseClick](~/api/Terminal.Gui.ViewBase.View.yml) - High-level click events +- Double-click support +- Mouse movement tracking +- Viewport-relative coordinates (not screen-relative) -### Granular Mouse Handling -- **Implementation**: v2 offers specific events for clicks ([View.MouseClick](~/api/Terminal.Gui.ViewBase.View.yml)), double-clicks, and movement, with [MouseFlags](~/api/Terminal.Gui.Input.MouseFlags.yml) for button states. -- **Impact**: Developers can handle complex mouse interactions (e.g., drag-and-drop) more easily than in v1. +**Highlight and Continuous Presses:** +- [View.Highlight](~/api/Terminal.Gui.ViewBase.View.yml) - Visual feedback on hover/click +- [View.HighlightStyle](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_HighlightStyle) - Configure highlight appearance +- [View.WantContinuousButtonPresses](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_WantContinuousButtonPresses) - Repeat [Command.Accept](~/api/Terminal.Gui.Input.Command.yml) during button hold -### Highlight Event and Continuous Button Presses -- **Highlight**: Views can visually respond to mouse hover or click via the [View.Highlight](~/api/Terminal.Gui.ViewBase.View.yml) event and [View.HighlightStyle](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_HighlightStyle) property. -- **Continuous Presses**: Setting [View.WantContinuousButtonPresses](~/api/Terminal.Gui.ViewBase.View.yml#Terminal_Gui_ViewBase_View_WantContinuousButtonPresses) = true repeats [Command.Accept](~/api/Terminal.Gui.Input.Command.yml) during button hold, useful for sliders or buttons. -- **Impact**: Enhances interactive feedback, making terminal UIs feel more responsive. +```csharp +// Highlight on hover +view.Highlight += (s, e) => { /* Visual feedback */ }; +view.HighlightStyle = HighlightStyle.Hover; -## AOT Support - Deployment and Performance -- **Implementation**: v2 ensures compatibility with Ahead-of-Time compilation and single-file applications by avoiding reflection patterns problematic for AOT, using source generators and [SourceGenerationContext](~/api/Terminal.Gui.Configuration.SourceGenerationContext.yml) for JSON serialization. -- **Impact**: Simplifies deployment for environments requiring Native AOT (see `Examples/NativeAot`), a feature not explicitly supported in v1, reducing runtime overhead and enabling faster startup times. +// Continuous button presses +view.WantContinuousButtonPresses = true; +``` + +--- + +## Configuration and Persistence + +See the [Configuration Deep Dive](config.md) for complete details. + +### ConfigurationManager + +[ConfigurationManager](~/api/Terminal.Gui.Configuration.ConfigurationManager.yml) provides: + +- JSON-based persistence +- Theme management +- Key binding customization +- View property persistence +- [SettingsScope](~/api/Terminal.Gui.Configuration.SettingsScope.yml) - User, Application, Machine levels +- [ConfigLocations](~/api/Terminal.Gui.Configuration.ConfigLocations.yml) - Where to search for configs + +```csharp +// Enable configuration +ConfigurationManager.Enable (ConfigLocations.All); + +// Load a theme +ConfigurationManager.Themes.Theme = "Dark"; + +// Save current configuration +ConfigurationManager.Save (); +``` + +**User Customization:** +- End-users can personalize themes, colors, text styles +- Key bindings can be remapped +- No code changes required +- JSON files easily editable + +--- + +## Debugging and Performance + +See the [Logging Deep Dive](logging.md) for complete details. + +### Logging System + +[Logging](~/api/Terminal.Gui.App.Logging.yml) integrates with Microsoft.Extensions.Logging: + +- Multi-level logging (Trace, Debug, Info, Warning, Error) +- Internal operation tracking (rendering, input, layout) +- Works with standard .NET logging frameworks (Serilog, NLog, etc.) + +```csharp +// Configure logging +Logging.ConfigureLogging ("myapp.log", LogLevel.Debug); + +// Use in code +Logging.Debug ("Rendering view {ViewId}", view.Id); +``` + +### Metrics + +[Logging.Meter](~/api/Terminal.Gui.App.Logging.yml#Terminal_Gui_App_Logging_Meter) provides performance metrics: + +- Frame rate tracking +- Redraw times +- Iteration timing +- Input processing overhead + +**Tools**: Use `dotnet-counters` or other metrics tools to monitor + +```bash +dotnet counters monitor --name MyApp Terminal.Gui +``` + +--- + +## Additional Features + +### Sixel Image Support + +v2 supports the Sixel protocol for rendering images: + +- [SixelEncoder](~/api/Terminal.Gui.Drawing.SixelEncoder.yml) - Encode images as Sixel data +- [SixelSupportDetector](~/api/Terminal.Gui.Drawing.SixelSupportDetector.yml) - Detect terminal support +- [SixelToRender](~/api/Terminal.Gui.Drawing.SixelToRender.yml) - Render Sixel images +- Compatible terminals: Windows Terminal, xterm, others + +**Use Cases**: Image previews, graphics in terminal apps + +### AOT Support + +v2 ensures compatibility with Ahead-of-Time compilation: + +- Avoid reflection patterns problematic for AOT +- Source generators for JSON serialization via [SourceGenerationContext](~/api/Terminal.Gui.Configuration.SourceGenerationContext.yml) +- Single-file deployment support +- Faster startup, reduced runtime overhead + +**Example**: See `Examples/NativeAot` for AOT deployment + +### Enhanced Unicode Support + +- Correctly manages wide characters (CJK scripts) +- [TextFormatter](~/api/Terminal.Gui.Text.TextFormatter.yml) accounts for Unicode width +- Fixes v1 layout issues with wide characters +- International application support + +--- ## Conclusion -Terminal.Gui v2 is a transformative update, addressing core limitations of v1 through architectural redesign, performance optimizations, and feature enhancements. From TrueColor and adornments for visual richness to decoupled navigation and modern input APIs for usability, v2 provides a robust foundation for building sophisticated terminal applications. The detailed changes in view management, configuration, and debugging tools empower developers to create more maintainable and user-friendly applications. \ No newline at end of file +Terminal.Gui v2 represents a comprehensive modernization: + +**Architecture:** +- Instance-based application model +- IRunnable architecture with type-safe results +- Proper resource management (IDisposable) +- Decoupled concerns (layout, focus, input) + +**Features:** +- 24-bit TrueColor +- Built-in scrolling +- Enhanced adornments (Margin, Border, Padding) +- Modern keyboard and mouse APIs +- Configuration and themes +- Logging and metrics + +**API:** +- Simplified and consistent +- Modern .NET patterns +- Better performance +- Improved testability + +**Views:** +- Many new views (CharMap, ColorPicker, GraphView, etc.) +- Significantly improved existing views +- Easier to create custom views + +v2 provides a robust foundation for building sophisticated, maintainable, and user-friendly terminal applications. The architectural improvements, combined with new features and enhanced APIs, enable developers to create modern terminal UIs that feel responsive and polished. + +For detailed migration guidance, see the [v1 To v2 Migration Guide](migratingfromv1.md). \ No newline at end of file diff --git a/docfx/docs/runnable-architecture-proposal.md b/docfx/docs/runnable-architecture-proposal.md new file mode 100644 index 000000000..8903ede79 --- /dev/null +++ b/docfx/docs/runnable-architecture-proposal.md @@ -0,0 +1,1726 @@ +# IRunnable Architecture Proposal + +**Status**: Phase 1 Complete ✅ - Phase 2 In Progress + +**Version**: 1.8 - Phase 1 Implemented + +**Date**: 2025-01-21 + +**Phase 1 Completion**: Issue #4400 closed with full implementation including fluent API and automatic disposal + +## Summary + +This proposal recommends decoupling Terminal.Gui's "Runnable" concept from `Toplevel` and `ViewArrangement.Overlapped`, elevating it to a first-class interface-based abstraction. + +**Key Insight**: Analysis of the codebase reveals that **all runnable sessions are effectively modal** - they block in `Application.Run()` until stopped and capture input. The distinction between "modal" and "non-modal" in the current design is artificial: + +- The `Modal` property only affects input propagation and Z-order, not the fundamental run loop behavior +- All `Toplevel`s block in `Run()` - there's no "background" runnable concept +- Non-modal `Toplevel`s (like `WizardAsView`) are just embedded views with `Modal = false`, not true sessions +- Overlapped windows are managed by `ViewArrangement.Overlapped`, not runnability + +By introducing `IRunnable`, we create a clean separation where: + +- **Runnable** = Can be run as a **UI**-blocking session with `Application.Run()` and returns a result +- **Overlapped** = `ViewArrangement.Overlapped` for window management (orthogonal to runnability) +- **Embedded** = Just views, not runnable at all + +## Terminology + +This proposal introduces new terminology to clarify the architecture: + +| Term | Definition | +|------|------------| +| **`IRunnable`** | Base interface for Views capable of running as an independent session with `Application.Run()` without returning a result. Replaces `Toplevel` as the contract for runnable views. When an `IRunnable` is passed to `IApplication.Run`, `Run` blocks until the `IRunnable` `Stops`. | +| **`IRunnable`** | Generic interface derived from `IRunnable` that can return a typed result. | +| **`Runnable`** | Optional base class that implements `IRunnable` and derives from `View`, providing default lifecycle behavior. Views can derive from this or implement `IRunnable` directly. | +| **`TResult`** | Type parameter specifying the type of result data returned when the runnable completes (e.g., `int` for button index, `string` for file path, enum, or other complex type). `Result` is `null` if the runnable stopped without the user explicitly accepting it (ESC pressed, window closed, etc.). | +| **`Result`** | Property on `IRunnable` that holds the typed result data. Should be set in `IsRunningChanging` handler (when `newValue = false`) **before** the runnable is popped from `RunnableSessionStack`. This allows subscribers to inspect results and optionally cancel the stop. Available after `IApplication.Run` returns. `null` indicates cancellation/non-acceptance. | +| **RunnableSession** | A running instance of an `IRunnable`. Managed by `IApplication` via `Begin()`, `Run()`, `RequestStop()`, and `End()` methods. Represented by a `RunnableSessionToken` on the `RunnableSessionStack`. | +| **`RunnableSessionToken`** | Object returned by `Begin()` that represents a running session. Wraps an `IRunnable` instance (via a `Runnable` property) and is stored in `RunnableSessionStack`. Disposed when session ends. | +| **`RunnableSessionStack`** | A stack of `RunnableSessionToken` instances, each wrapping an `IRunnable`. Tracks all running runnables in the application. Literally a `ConcurrentStack`. Replaces `SessionStack` (formerly `Toplevels`). +| **`IsRunning`** | Boolean property on `IRunnable` indicating whether the runnable is currently on the `RunnableSessionStack` (i.e., `RunnableSessionStack.Any(token => token.Runnable == this)`). Read-only, derived from stack state. Runnables are added during `IApplication.Begin` and removed in `IApplication.End`. Replaces `Toplevel.Running`. | +| **`IsRunningChanging`** | Cancellable event raised **before** an `IRunnable` is added to or removed from `RunnableSessionStack`. When transitioning to `IsRunning = true`, can be canceled to prevent starting. When transitioning to `IsRunning = false`, allows code to prevent closure (e.g., prompt to save changes) AND is the ideal place to extract `Result` before the runnable is removed from the stack. Event args (`CancelEventArgs`) provide the new state in `NewValue`. Replaces `Toplevel.Closing` and partially `Toplevel.Activate`. | +| **`IsRunningChanged`** | Non-cancellable event raised **after** a runnable has been added to or removed from `RunnableSessionStack`. Fired after `IsRunning` has changed to the new value (true = started, false = stopped). For post-state-change logic (e.g., setting focus after start, cleanup after stop). Replaces `Toplevel.Activated` and `Toplevel.Closed`. | +| **`IsInitialized`** (`View` property) | Boolean property (on `View`) indicating whether a view has completed two-phase initialization (`View.BeginInit/View.EndInit`). From .NET's `ISupportInitialize` pattern. If the `IRunnable.IsInitialized == false`, `BeginInit` is called from `IApplication.Begin` after `IsRunning` has changed to `true`. `EndInit` is called immediately after `BeginInit`. | +| **`Initialized`** (`View` event) | Non-cancellable event raised as `View.EndInit()` completes. | +| **`TopRunnable`** (`IApplication` property) | Used to be `Top`, but was recently renamed to `Current` because it was confusing relative to `Toplevel`. It's precise definition in this proposal is "The `IRunnable` that is on the top of the `RunnableSessionStack` stack. And by definition, and per-implementation, this `IRunnable` is capturing all mouse and keyboard input and is thus "Modal". Note, any other `IRunnable` instances on `RunnableSessionStack` continue to be laid out, drawn, and receive iteration events; they just don't get any user input. Another interesting note: No code in the solution other than ./App, ./ViewBase, and tests reference `IApplication.Current` (an indication the previous de-coupling was successful). It also means the name of this property is not that important because it's just an implementation detail, primarily used to enable tests to not have to actually call `Run`. View has `public bool IsCurrentTop => App?.Current == this;`; thus we rename `IApplication.Current` to `IApplication.TopRunnable` and it's synonymous with `IRunnable.IsModal`. | +| **`IsModal`** | Boolean property on `IRunnable` indicating whether the `IRunnable` is at the top of the `RunnableSessionStack` (i.e., `this == app.TopRunnable` or `app.RunnableSessionStack.Peek().Runnable == this`). The `IRunnable` at the top of the stack gets all mouse/keyboard input and thus is running "modally". Read-only, derived from stack state. `IsModal` represents the concept from the end-user's perspective. | +| **`IsModalChanging`** | Cancellable event raised **before** an `IRunnable` transitions to/from the top of the `RunnableSessionStack`. When becoming modal (`newValue = true`), can be canceled to prevent activation. Event args (`CancelEventArgs`) provide the new state. Replaces `Toplevel.Activate` and `Toplevel.Deactivate`. | +| **`IsModalChanged`** | Non-cancellable event raised **after** an `IRunnable` has transitioned to/from the top of the `RunnableSessionStack`. Fired after `IsModal` has changed to the new value (true = became modal, false = no longer modal). For post-activation logic (e.g., setting focus, updating UI state). Replaces `Toplevel.Activated` and `Toplevel.Deactivated`. | +| **`End`** (`IApplication` method) | Ends a running `IRunnable` instance by removing its `RunnableSessionToken` from the `RunnableSessionStack`. `IsRunningChanging` with `newValue = false` is raised **before** the token is popped from the stack (allowing result extraction and cancellation). `IsRunningChanged` is raised **after** the `Pop` operation. Then, `RunnableSessionStack.Peek()` is called to see if another `IRunnable` instance can transition to `IApplication.TopRunnable`/`IRunnable.IsModal = true`. | +| **`ViewArrangement.Overlapped`** | Layout mode for windows that can overlap with Z-order management. Orthogonal to runnability - overlapped windows can be embedded views (not runnable) or runnable sessions. | + +**Key Architectural Changes:** +- **Simplified**: One interface `IRunnable` replaces both `Toplevel` and the artificial `Modal` property distinction +- **All sessions block**: No concept of "non-modal runnable" - if it's runnable, `Run()` blocks until `RequestStop()` +- **Type-safe results**: Generic `TResult` parameter provides compile-time type safety +- **Decoupled from layout**: Being runnable is independent of `ViewArrangement.Overlapped` +- **Consistent patterns**: All lifecycle events follow Terminal.Gui's Cancellable Work Pattern +- **Result extraction in `Stopping`**: `OnStopping()` is the correct place to extract `Result` before disposal + +## Table of Contents + +- [Background](#background) +- [Problems with Current Design](#problems-with-current-design) +- [Proposed Architecture](#proposed-architecture) +- [Detailed API Design](#detailed-api-design) +- [Migration Path](#migration-path) +- [Implementation Strategy](#implementation-strategy) +- [Benefits](#benefits) +- [Open Questions](#open-questions) + +## Background + +### Current State + +In Terminal.Gui v2, the concept of a "runnable" view is embedded in the `Toplevel` class: + +```csharp +public partial class Toplevel : View +{ + public bool Running { get; set; } + public bool Modal { get; set; } + public bool IsLoaded { get; private set; } + + // Lifecycle events + public event EventHandler? Activate; + public event EventHandler? Deactivate; + public event EventHandler? Loaded; + public event EventHandler? Ready; + public event EventHandler? Closing; + public event EventHandler? Closed; + public event EventHandler? Unloaded; +} +``` + +To run a view, it must derive from `Toplevel`: + +```csharp +// Current pattern +var dialog = new Dialog(); // Dialog -> Window -> Toplevel +Application.Run(dialog); +``` + +`Toplevel` serves multiple purposes: + +1. **Session Management**: Manages the running session lifecycle +2. **Full-Screen Container**: By default sizes to fill the screen +3. **Overlapped Support**: Sets `Arrangement = ViewArrangement.Overlapped` +4. **Modal Support**: Has a `Modal` property + +This creates unnecessary coupling: + +- Only `Toplevel` derivatives can be run +- `Toplevel` always implies overlapped arrangement +- Modal behavior is a property, not a characteristic of the session +- The `SessionStack` contains `Toplevel` objects, coupling session management to the view hierarchy + + +## Problems with Current Design + +### 1. Tight Coupling + +**Problem**: Runnable behavior is hardcoded into `Toplevel`, creating artificial constraints. + +**Consequence**: +- Cannot run arbitrary `View` subclasses (e.g., a `FrameView` or custom `View`) +- Forces inheritance hierarchy: must derive from `Toplevel` even when full-screen/overlapped behavior isn't needed +- Code that manages sessions is scattered between `Application`, `ApplicationImpl`, `Toplevel`, and session management code + +**Example Limitation**: +```csharp +// Want to run a specialized view as a session +var customView = new MyCustomView(); +// Cannot do: Application.Run(customView); +// Must do: wrap in Toplevel or derive from Toplevel +``` + +### 2. Overlapped Coupling + +**Problem**: `Toplevel` constructor sets `Arrangement = ViewArrangement.Overlapped`, conflating "runnable" with "overlapped". + +**Consequence**: +- Cannot have a runnable tiled view without explicitly unsetting `Overlapped` +- Unclear separation between layout mode (overlapped vs. tiled) and execution mode (runnable) +- Architecture implies overlapped views must be runnable, which isn't necessarily true + +```csharp +// Toplevel constructor +public Toplevel () +{ + Arrangement = ViewArrangement.Overlapped; // Why is this hardcoded? + Width = Dim.Fill (); + Height = Dim.Fill (); +} +``` + +### 3. Modal as Property - Actually Not a Distinction + +**Problem**: `Modal` is a boolean property on `Toplevel` that creates an **artificial distinction**. + +**Reality Check**: All `Toplevel`s are effectively "modal" in that they: +1. Block in `Application.Run()` until `RequestStop()` is called +2. Have exclusive access to the run loop while running +3. Must complete before control returns to the caller + +**What `Modal = false` Actually Does:** +- Allows keyboard events to propagate to the SuperView +- Doesn't enforce Z-order "topmost" behavior +- That's it - it's just input routing, not a fundamental session characteristic + +**Evidence from codebase:** + +```csharp +// WizardAsView.cs - "Non-modal" is actually just an embedded View +var wizard = new Wizard { /* ... */ }; +wizard.Modal = false; // Just affects input propagation and border + +// NOTE: The wizard is NOT run separately! +topLevel.Add (wizard); // Added as a subview (embedded) +Application.Run (topLevel); // Only the topLevel is run + +// The distinction is artificial: +// - "Modal" Wizard = Application.Run(wizard) - BLOCKS until stopped +// - "Non-Modal" Wizard = topLevel.Add(wizard) - NOT runnable, just a View +// Both named "Wizard" but completely different usage patterns! +``` + +The confusion arises because **`Modal` is a property that affects behavior whether the Toplevel is runnable OR embedded**: +- If run with `Application.Run()`: controls input capture and Z-order +- If embedded with `superView.Add()`: still affects input propagation, but it's not a session + +**The real distinction**: +- **Runnable** (call `Application.Run(x)`) - Always blocks, has session lifecycle +- **Embedded** (call `superView.Add(x)`) - Just a view in the hierarchy, no session + +**Consequence**: +- Confusing semantics: "non-modal runnable" is an oxymoron +- Modal behavior is scattered across the codebase in conditional checks +- Session management has complex logic for Modal state transitions + +```csharp +// ApplicationImpl.Run.cs:98-101 - Complex conditional +if ((Current?.Modal == false && toplevel.Modal) + || (Current?.Modal == false && !toplevel.Modal) + || (Current?.Modal == true && toplevel.Modal)) +{ + // All this complexity for input routing! +} +``` + +**Better Model**: Remove the `Modal` property. If you want embedded Wizard-like behavior, just add it as a View (don't make it runnable). + +### 4. Session Management Complexity + +**Problem**: The `RunnableSessionStack` manages `Toplevel` instances, coupling session lifecycle to view hierarchy. + +**Consequence**: +- `SessionToken` stores a `Toplevel`, not a more abstract "runnable session" +- Complex logic for managing the relationship between `RunnableSessionStack`, `Current`, and `CachedSessionTokenToplevel` +- Unclear ownership: who owns the `Toplevel` lifecycle? + +```csharp +public class SessionToken : IDisposable +{ + public Toplevel? Toplevel { get; internal set; } // Tight coupling +} +``` + +### 5. Lifecycle Events Are Misnamed and Hacky + +**Problem**: Events like `Activate`, `Deactivate`, `Loaded`, `Ready`, `Closing`, `Closed`, `Unloaded` are on `Toplevel` but conceptually belong to the runnable session, not the view. + +**Consequence**: +- Events fire on the view object, mixing view lifecycle with session lifecycle +- Cannot easily monitor session changes independently of view state +- Event args reference `Toplevel` specifically +- **Hacky `ToplevelTransitionManager`**: The `Ready` event requires a separate manager class to track which toplevels have been "readied" across session transitions + +**Why is this hacky?** The `Ready` event is fired during the first `RunIteration()` (in the main loop), not during `Begin()` like other lifecycle events. This requires tracking state externally and checking every iteration. With proper CWP-aligned lifecycle, this complexity disappears - `Started` fires after `Begin()` completes, no tracking needed. + +### 6. Unclear Responsibilities + +**Problem**: It's unclear what `Toplevel` is responsible for. + +Is `Toplevel`: +- A full-screen container view? +- The base class for runnable views? +- The representation of a running session? +- A view with special overlapped arrangement? + +**Consequence**: Confused codebase where responsibilities blur. + +### 7. Violates Cancellable Work Pattern + +**Problem**: `Toplevel`'s lifecycle methods don't follow Terminal.Gui's **Cancellable Work Pattern** (CWP), which is used throughout the framework for `View.Draw`, `View.Keyboard`, `View.Command`, and property changes. + +**Consequence**: + +Current `Toplevel.OnClosing` implementation: +```csharp +internal virtual bool OnClosing(ToplevelClosingEventArgs ev) +{ + Closing?.Invoke(this, ev); // ? Event fired INSIDE virtual method + return ev.Cancel; +} +``` + +**What's wrong:** +1. **Wrong Order**: Event is raised inside the virtual method, not after +2. **No Pre-Check**: Virtual method doesn't return bool to cancel before event +3. **Inconsistent Naming**: Should be `OnStopping`/`Stopping` (cancellable) and `OnStopped`/`Stopped` (non-cancellable) +4. **Manual Checking**: `Application.RequestStop` manually checks `ev.Cancel` instead of relying on method return value + +**Impact**: +- Developers familiar with CWP from other Terminal.Gui components are confused by inconsistent patterns +- Cannot properly override lifecycle methods following the standard pattern +- Event subscription doesn't work as expected compared to other Terminal.Gui events +- Testing is harder because flow is non-standard + +### 8. View Initialization Doesn't Follow CWP + +**Problem**: `View.BeginInit/EndInit/Initialized` doesn't follow the Cancellable Work Pattern, creating inconsistency with the rest of Terminal.Gui. + +**What's Wrong:** +1. **No Pre-Notification Virtual**: No `OnInitializing()` virtual method before initialization +2. **No Cancellation**: Cannot cancel initialization +3. **Event After Work**: `Initialized` event fires after all work is done, no chance to participate +4. **Inconsistent with CWP**: Doesn't match the pattern used elsewhere in Terminal.Gui + +**Impact**: +- Inconsistent with rest of Terminal.Gui's event model +- Cannot hook into initialization at the right point in the lifecycle +- Subclasses cannot easily customize initialization behavior +- Makes the IRunnable lifecycle confusing since `Initialized` event doesn't follow CWP + +**Proposed Fix**: Add `Initializing` (cancellable) event and `OnInitializing`/`OnInitialized` virtual methods to match CWP pattern used throughout Terminal.Gui. + +## Proposed Architecture + +### Core Concept: Simplify and Clarify + +**Key Insight**: After analyzing the codebase, there's no valid use case for "non-modal runnables". Every `Toplevel` that calls `Application.Run()` blocks until `RequestStop()`. The `Modal` property only controls input routing, not the fundamental session behavior. + +**Simplified Model:** + +1. **`IRunnable`** - Interface for views that can run as **blocking** sessions with typed results +2. **`ViewArrangement.Overlapped`** - Layout mode for window management (orthogonal to runnability) +3. **Embedded Views** - Views that aren't runnable at all (e.g., `Wizard` with `Modal = false` is just a view) + +### Architecture Tenets + +1. **Interface-Based**: Use `IRunnable` interface to define runnable behavior, not inheritance +2. **Composition Over Inheritance**: Views can implement `IRunnable` without inheriting from `Toplevel` +3. **All Sessions Block**: `Application.Run()` blocks until `RequestStop()` is called (no background/non-blocking sessions) +4. **Type-Safe Results**: Generic `TResult` parameter provides compile-time type safety for return values +5. **Clean Separation**: View hierarchy (SuperView/SubViews) is independent of session hierarchy (RunnableSessionStack) +6. **Cancellable Work Pattern**: All lifecycle phases follow Terminal.Gui's Cancellable Work Pattern for consistency +7. **Result Extraction in `Stopping`**: `OnStopping()` is called before disposal, perfect for extracting `Result` + +### Result Extraction Pattern + +The `Result` property is a nullable generic (`public TResult? Result`) to represent the outcome of the runnable operation, allowing for rich result data and context. + +**Critical Timing**: `Result` must be extracted in `RaiseIsRunningChanging()` when the new value is `false`, which is called by `RequestStop()` before the run loop exits and before disposal. This ensures the data is captured while views are still accessible. + +```csharp +protected override bool RaiseIsRunningChanging () +{ + // Extract Result BEFORE disposal + // At this point views are still alive and accessible + Result = ExtractResultFromViews(); + + return base.OnStopping(); // Allow cancellation +} +``` + +--- + +## Detailed API Design + +### 1. `IRunnable` Non-Generic Base Interface + +The non-generic base interface provides common members for all runnables, enabling type-safe heterogeneous collections: + +```csharp +namespace Terminal.Gui.App; + +/// +/// Non-generic base interface for runnable views. Provides common members without type parameter. +/// +/// +/// +/// This interface enables storing heterogeneous runnables in collections (e.g., ) +/// while preserving type safety at usage sites via . +/// +/// +/// Most code should use directly. This base interface is primarily +/// for framework infrastructure (session management, stacking, etc.). +/// +/// +public interface IRunnable +{ + #region Running or not (added to/removed from RunnableSessionStack) + + // TODO: Determine if this should support set for testing purposes. + // TODO: If IApplication.RunnableSessionStack should be public/internal or wrapped. + /// + /// Gets whether this runnable session is currently running. + /// + bool IsRunning { get => App?.RunnableSessionStack.Contains(this); } + + /// Called when IsRunning is changing; raises IsRunningChanging. + /// True if the change was canceled; otherwise false. + bool RaiseIsRunningChanging(bool oldIsRunning, bool newIsRunning); + + /// + /// Raised when IsRunning is changing (e.g when or is called). + /// Can be canceled by setting to true. + /// + event EventHandler>? IsRunningChanging; + + /// Called after IsRunning has changed. + /// The new value of IsRunning (true = started, false = stopped). + void RaiseIsRunningChangedEvent(bool newIsRunning); + + /// + /// Raised after the session has started or stopped (IsRunning has changed). + /// + /// + /// Subscribe to perform post-state-change logic. When newValue is false (stopped), + /// this is the ideal place to extract before views are disposed. + /// + event EventHandler>? IsRunningChanged; + + + #endregion Running or not (added to/removed from RunnableSessionStack) + + #region Modal or not (top of RunnableSessionStack or not) + + // TODO: Determine if this should support set for testing purposes. + /// + /// Gets whether this runnable session is a the top of the Runnable Stack and thus + /// exclusively receiving mouse and keyboard input. + /// + bool IsModal { get => App?.TopRunnable == this; } + + /// Called when IsModal is changing; raises IsModalChanging. + /// True if the change was canceled; otherwise false. + bool RaiseIsModalChanging(bool oldIsModal, bool newIsModal); + + /// + /// Called when the user does something to cause this runnable to be put at the top + /// of the Runnable Stack or not. This is typically because `Run` was called or `RequestStop` + /// was called. + /// Can be canceled by setting to true. + /// + event EventHandler>? IsModalChanging; + + /// Called after IsModal has changed. + /// The new value of IsModal (true = became modal/top, false = no longer modal). + void RaiseIsModalChangedEvent(bool newIsModal); + + /// + /// Raised after the session has become modal (top of stack) or ceased being modal. + /// + /// + /// Subscribe to perform post-activation logic (e.g., setting focus, updating UI state). + /// + event EventHandler>? IsModalChanged; + + #endregion Modal or not (top of RunnableSessionStack or not) + +} +``` + +### 2. `IRunnable` Generic Interface + +The generic interface extends the base with typed result support: + +```csharp +namespace Terminal.Gui.App; + +/// +/// Defines a view that can be run as an independent blocking session with , +/// returning a typed result. +/// +/// +/// The type of result data returned when the session completes. +/// Common types: for button indices, for file paths, +/// custom types for complex form data. +/// +/// +/// +/// A runnable view executes as a self-contained blocking session with its own lifecycle, +/// event loop iteration, and focus management. blocks until +/// is called. +/// +/// +/// When is null, the session was stopped without being accepted +/// (e.g., ESC key pressed, window closed). When non-null, it contains the result data +/// extracted in before views are disposed. +/// +/// +/// Implementing does not require deriving from any specific +/// base class or using . These are orthogonal concerns. +/// +/// +/// This interface follows the Terminal.Gui Cancellable Work Pattern for all lifecycle events. +/// +/// +public interface IRunnable : IRunnable +{ + /// + /// Gets the result data extracted when the session was accepted, or null if not accepted. + /// + /// + /// + /// Implementations should set this in by extracting data from + /// views before they are disposed. + /// + /// + /// null indicates the session was stopped without accepting (ESC key, close without action). + /// Non-null contains the type-safe result data. + /// + /// + TResult? Result { get; set; } +} +``` + +**Design Rationale:** +- **Non-generic base**: Enables `RunnableSessionStack` to store `ConcurrentStack` without type erasure +- **Generic extension**: Preserves type safety at usage sites: `var dialog = new Dialog(); int? result = dialog.Result;` +- **Common lifecycle**: Both interfaces share the same lifecycle events via the base + +**Note**: The `Initialized` event is already defined on `View` via `ISupportInitializeNotification` and does not need to be redefined here. + +### Why This Model Works + +1. **Natural nesting**: Each `Run()` call creates a nested blocking context +2. **Automatic cleanup**: When a session ends, previous session automatically becomes modal again +3. **Z-order enforcement**: Topmost session (IsModal=true) is always visually on top +4. **Input capture**: Only `TopRunnable` (IsModal=true) receives keyboard/mouse input +5. **All sessions active**: All sessions on stack (IsRunning=true) continue to be laid out and drawn +6. **No race conditions**: Serial call stack eliminates concurrency issues + +### Code Example + +```csharp +public class MainWindow : Runnable +{ + private void OpenFile() + { + var fileDialog = new FileDialog(); + + // This blocks until fileDialog closes + Application.Run(fileDialog); + + // FileDialog has stopped, we're back here + if (fileDialog.Result is string path) + { + LoadFile(path); + } + + fileDialog.Dispose(); + + // MainWindow's Run() loop continues + } +} + +public class FileDialog : Runnable +{ + protected override bool OnIsRunningChanging(bool oldIsRunning, bool newIsRunning) + { + if (!newIsRunning) // Stopping + { + if (SelectedPath == null) + { + // Confirm cancellation with nested modal + int result = MessageBox.Query( + "Confirm", + "Cancel file selection?", + "Yes", "No"); + + if (result == 1) // No + { + return true; // Cancel stopping + } + } + + Result = SelectedPath; + } + + return base.OnIsRunningChanging(oldIsRunning, newIsRunning); + } +} +``` + +### RunnableSessionStack Implementation + +```csharp +public interface IApplication +{ + /// + /// Gets the stack of active runnable session tokens. + /// Sessions execute serially - the top of stack is the currently modal session. + /// + /// + /// + /// Session tokens are pushed onto the stack when is called and popped when + /// completes. The stack grows during nested modal calls and + /// shrinks as they complete. + /// + /// + /// Only the top session () has exclusive keyboard/mouse input (IsModal=true). + /// All other sessions on the stack continue to be laid out, drawn, and receive iteration events (IsRunning=true), + /// but they don't receive user input. + /// + /// + /// Stack during nested modals: + /// + /// RunnableSessionStack (top to bottom): + /// - MessageBox (TopRunnable, IsModal=true, IsRunning=true, has input) + /// - FileDialog (IsModal=false, IsRunning=true, continues to update/draw) + /// - MainWindow (IsModal=false, IsRunning=true, continues to update/draw) + /// + /// + /// + ConcurrentStack RunnableSessionStack { get; } + + /// + /// Gets or sets the topmost runnable session (the one capturing input). + /// + /// + /// + /// Always equals RunnableSessionStack.Peek().Runnable when stack is non-empty. + /// + /// + /// This is the runnable with = true. + /// + /// + IRunnable? TopRunnable { get; set; } +} +``` + +### Why Not Parallel Sessions? + +**Question**: Why not allow multiple non-modal sessions running in parallel (like tiled window managers)? + +**Answer**: This adds enormous complexity with little benefit: + +1. **Input routing**: Which session gets keyboard/mouse events? +2. **Focus management**: How does focus move between parallel sessions? +3. **Z-order**: How are overlapping sessions drawn? +4. **Coordination**: How do sessions communicate? +5. **Thread safety**: Concurrent access to Application state + +**Alternative**: Use embedded views with `ViewArrangement.Overlapped`: + +```csharp +// Instead of parallel runnables, use embedded overlapped windows +var mainView = new Runnable(); + +var window1 = new Window +{ + X = 0, + Y = 0, + Width = 40, + Height = 20, + Arrangement = ViewArrangement.Overlapped +}; + +var window2 = new Window +{ + X = 10, + Y = 5, + Width = 40, + Height = 20, + Arrangement = ViewArrangement.Overlapped +}; + +mainView.Add(window1); +mainView.Add(window2); + +// Only mainView is runnable, windows are embedded +Application.Run(mainView); +mainView.Dispose(); +``` + +**Benefits of serial-only model:** +- **Simplicity**: Clear execution flow +- **Predictability**: One active session at a time +- **Composability**: Overlapped windows via `ViewArrangement`, runnability via `IRunnable` +- **Testability**: Easier to test serial workflows + +### 2. `Runnable` Base Class (Complete Implementation) + +Provides a default implementation for convenience: + +```csharp +namespace Terminal.Gui.ViewBase; + +/// +/// Base implementation of for views that can be run as blocking sessions. +/// +/// The type of result data returned when the session completes. +/// +/// Views can derive from this class or implement directly. +/// +public class Runnable : View, IRunnable +{ + /// + public TResult? Result { get; set; } + + #region IRunnable Implementation - IsRunning (from base interface) + + /// + public bool RaiseIsRunningChanging(bool oldIsRunning, bool newIsRunning) + { + // Clear previous result when starting + if (newIsRunning) + { + Result = default; + } + + // CWP Phase 1: Virtual method (pre-notification) + if (OnIsRunningChanging(oldIsRunning, newIsRunning)) + { + return true; // Canceled + } + + // CWP Phase 2: Event notification + var args = new CancelEventArgs { CurrentValue = oldIsRunning, NewValue = newIsRunning }; + IsRunningChanging?.Invoke(this, args); + + return args.Cancel; + } + + /// + public event EventHandler>? IsRunningChanging; + + /// + public void RaiseIsRunningChangedEvent(bool newIsRunning) + { + // CWP Phase 3: Post-notification (work already done by Application.Begin/End) + OnIsRunningChanged(newIsRunning); + + var args = new EventArgs { CurrentValue = newIsRunning }; + IsRunningChanged?.Invoke(this, args); + } + + /// + public event EventHandler>? IsRunningChanged; + + /// + /// Called before event. Override to cancel state change or extract . + /// + /// The current value of IsRunning. + /// The new value of IsRunning (true = starting, false = stopping). + /// True to cancel; false to proceed. + /// + /// + /// Default implementation returns false (allow change). + /// + /// + /// IMPORTANT: When is false (stopping), this is the ideal place + /// to extract from views before the runnable is removed from the stack. + /// At this point, all views are still alive and accessible, and subscribers can inspect the result + /// and optionally cancel the stop. + /// + /// + /// + /// protected override bool OnIsRunningChanging(bool oldIsRunning, bool newIsRunning) + /// { + /// if (!newIsRunning) // Stopping + /// { + /// // Extract result before removal from stack + /// Result = _textField.Text; + /// + /// // Or check if user wants to save first + /// if (HasUnsavedChanges()) + /// { + /// var result = MessageBox.Query("Save?", "Save changes?", "Yes", "No", "Cancel"); + /// if (result == 2) return true; // Cancel stopping + /// if (result == 0) Save(); + /// } + /// } + /// + /// return base.OnIsRunningChanging(oldIsRunning, newIsRunning); + /// } + /// + /// + /// + protected virtual bool OnIsRunningChanging(bool oldIsRunning, bool newIsRunning) => false; + + /// + /// Called after has changed. Override for post-state-change logic. + /// + /// The new value of IsRunning (true = started, false = stopped). + /// + /// Default implementation does nothing. Overrides should call base to ensure extensibility. + /// + protected virtual void OnIsRunningChanged(bool newIsRunning) + { + // Default: no-op + } + + #endregion + + #region IRunnable Implementation - IsModal (from base interface) + + /// + public bool RaiseIsModalChanging(bool oldIsModal, bool newIsModal) + { + // CWP Phase 1: Virtual method (pre-notification) + if (OnIsModalChanging(oldIsModal, newIsModal)) + { + return true; // Canceled + } + + // CWP Phase 2: Event notification + var args = new CancelEventArgs { CurrentValue = oldIsModal, NewValue = newIsModal }; + IsModalChanging?.Invoke(this, args); + + return args.Cancel; + } + + /// + public event EventHandler>? IsModalChanging; + + /// + public void RaiseIsModalChangedEvent(bool newIsModal) + { + // CWP Phase 3: Post-notification (work already done by Application) + OnIsModalChanged(newIsModal); + + var args = new EventArgs { CurrentValue = newIsModal }; + IsModalChanged?.Invoke(this, args); + } + + /// + public event EventHandler>? IsModalChanged; + + /// + /// Called before event. Override to cancel activation/deactivation. + /// + /// The current value of IsModal. + /// The new value of IsModal (true = becoming modal/top, false = no longer modal). + /// True to cancel; false to proceed. + /// + /// Default implementation returns false (allow change). + /// + protected virtual bool OnIsModalChanging(bool oldIsModal, bool newIsModal) => false; + + /// + /// Called after has changed. Override for post-activation logic. + /// + /// The new value of IsModal (true = became modal, false = no longer modal). + /// + /// + /// Default implementation does nothing. Overrides should call base to ensure extensibility. + /// + /// + /// Common uses: setting focus when becoming modal, updating UI state. + /// + /// + protected virtual void OnIsModalChanged(bool newIsModal) + { + // Default: no-op + } + + #endregion + + /// + /// Requests that this runnable session stop. + /// + public virtual void RequestStop() + { + Application.RequestStop(this); + } +} +``` + +**Key Design Point**: `OnStopping()` is called **before** the run loop exits and **before** disposal, making it the perfect place to extract `Result` while views are still accessible. + +### 3. Event Args + +Terminal.Gui's existing event args types are used: + +- **`EventArgs`** - For non-cancellable events that need to pass data +- **`CancelEventArgs`** - For cancellable events that need to pass data +- **`CancelEventArgs`** - For cancellable events without additional data +- **`ResultEventArgs`** - For events that produce a result + +### 4. Updated `IApplication` Interface + +Modified methods to work with `IRunnable`: + +```csharp +namespace Terminal.Gui.App; + +public interface IApplication +{ + /// + /// Gets or sets the topmost runnable session (the one capturing keyboard/mouse input). + /// + /// + /// + /// null when no session is running. + /// + /// + /// This is the runnable with = true. + /// Always equals RunnableSessionStack.Peek().Runnable when stack is non-empty. + /// + /// + IRunnable? TopRunnable { get; set; } + + /// + /// Gets the stack of all runnable session tokens. + /// + /// + /// The top of the stack (Peek().Runnable) is the session (IsModal=true). + /// All sessions on the stack have IsRunning=true and continue to receive layout, draw, and iteration events. + /// + ConcurrentStack RunnableSessionStack { get; } + + /// + /// Prepares the provided runnable for execution and creates a session token. + /// + /// The runnable to begin executing. + /// A RunnableSessionToken that must be passed to when the session completes. + RunnableSessionToken Begin(IRunnable runnable); + + // Three forms of Run(): + + /// + /// Runs a new session with the provided runnable view. + /// + /// The runnable to execute. + /// Optional handler for unhandled exceptions. + void Run(IRunnable runnable, Func? errorHandler = null); + + /// + /// Creates and runs a new session with a runnable of the specified type. + /// + /// The type of runnable to create and run. Must have a parameterless constructor. + /// Optional handler for unhandled exceptions. + /// The runnable instance that was created and run. + /// + /// This is a convenience method that creates an instance of and runs it. + /// Equivalent to: var r = new TRunnable(); Run(r); return r; + /// + TRunnable Run(Func? errorHandler = null) where TRunnable : IRunnable, new(); + + /// + /// Creates and runs a default container runnable (e.g., or ). + /// + /// Optional handler for unhandled exceptions. + /// The default runnable that was created and run. + /// + /// + /// This is a convenience method for the common use case where the developer just wants a default + /// container view without specifying a type. It creates a instance + /// and runs it, allowing the developer to populate it via the event. + /// + /// + /// + /// var app = Application.Create(); + /// app.Init(); + /// + /// IRunnable? mainRunnable = null; + /// + /// // Listen for when the default runnable starts + /// app.IsRunningChanged += (s, e) => + /// { + /// if (e.CurrentValue && app.TopRunnable != null) + /// { + /// // Populate app.TopRunnable with views + /// app.TopRunnable.Add(new MenuBar { /* ... */ }); + /// app.TopRunnable.Add(new StatusBar { /* ... */ }); + /// // ... + /// } + /// }; + /// + /// mainRunnable = app.Run(); // Creates default Runnable{object} and runs it + /// app.Shutdown(); + /// + /// + /// + IRunnable Run(Func? errorHandler = null); + + /// + /// Requests that the specified runnable session stop. + /// + /// The runnable to stop. If null, stops . + void RequestStop(IRunnable? runnable = null); + + /// + /// Ends the session associated with the token. + /// + /// The token returned by . + void End(RunnableSessionToken sessionToken); +} +``` + +### 5. Updated `RunnableSessionToken` + +Wraps an `IRunnable` instance: + +```csharp +namespace Terminal.Gui.App; + +/// +/// Represents a running session created by . +/// Wraps an instance and is stored in . +/// +public class RunnableSessionToken : IDisposable +{ + internal RunnableSessionToken(IRunnable runnable) + { + Runnable = runnable; + } + + /// + /// Gets or sets the runnable associated with this session. + /// Set to null by when the session completes. + /// + public IRunnable? Runnable { get; internal set; } + + public void Dispose() + { + if (Runnable != null) + { + throw new InvalidOperationException( + "RunnableSessionToken.Dispose called but Runnable is not null. " + + "Call IApplication.End(sessionToken) before disposing."); + } + } +} +``` + +### 6. `ApplicationImpl.Run` Implementation + +Here's how the three forms of `Run()` work with `IRunnable`: + +```csharp +namespace Terminal.Gui.App; + +public partial class ApplicationImpl +{ + // Form 1: Run with provided runnable + public void Run(IRunnable runnable, Func? errorHandler = null) + { + if (runnable is null) + { + throw new ArgumentNullException(nameof(runnable)); + } + + if (!Initialized) + { + throw new NotInitializedException(nameof(Run)); + } + + // Begin the session (adds to stack, raises IsRunningChanging/IsRunningChanged) + RunnableSessionToken token = Begin(runnable); + + try + { + // All runnables block until RequestStop() is called + RunLoop(runnable, errorHandler); + } + finally + { + // End the session (raises IsRunningChanging/IsRunningChanged, pops from stack) + End(token); + } + } + + // Form 2: Run with type parameter (convenience) + public TRunnable Run(Func? errorHandler = null) + where TRunnable : IRunnable, new() + { + if (!Initialized) + { + throw new NotInitializedException(nameof(Run)); + } + + TRunnable runnable = new(); + Run(runnable, errorHandler); + return runnable; + } + + // Form 3: Run with default container (convenience) + public IRunnable Run(Func? errorHandler = null) + { + if (!Initialized) + { + throw new NotInitializedException(nameof(Run)); + } + + // Create a default container runnable + // Using Runnable as a generic container (result not meaningful) + var runnable = new Runnable + { + Width = Dim.Fill(), + Height = Dim.Fill() + }; + + Run(runnable, errorHandler); + return runnable; + } + + private void RunLoop(IRunnable runnable, Func? errorHandler) + { + // Main loop - blocks until RequestStop() is called + // Note: IsRunning is a derived property (stack.Contains), so we check it each iteration + while (runnable.IsRunning && !_isDisposed) + { + try + { + // Process one iteration of the event loop + Coordinator.RunIteration(); + } + catch (Exception ex) + { + if (errorHandler is null || !errorHandler(ex)) + { + throw; + } + } + } + } + + private RunnableSessionToken Begin(IRunnable runnable) + { + // Create token wrapping the runnable + var token = new RunnableSessionToken(runnable); + + // Raise IsRunningChanging (false -> true) - can be canceled + if (runnable.RaiseIsRunningChanging(false, true)) + { + // Starting was canceled + return token; // Don't add to stack + } + + // Push token onto Runnable Stack (IsRunning becomes true) + RunnableSessionStack.Push(token); + + // Update TopRunnable to the new top of stack + IRunnable? previousTop = TopRunnable; + TopRunnable = runnable; + + // Raise IsRunningChanged (now true) + runnable.RaiseIsRunningChangedEvent(true); + + // If there was a previous top, it's no longer modal + if (previousTop != null) + { + // Raise IsModalChanging (true -> false) + previousTop.RaiseIsModalChanging(true, false); + // IsModal is now false (derived property) + previousTop.RaiseIsModalChangedEvent(false); + } + + // New runnable becomes modal + // Raise IsModalChanging (false -> true) + runnable.RaiseIsModalChanging(false, true); + // IsModal is now true (derived property) + runnable.RaiseIsModalChangedEvent(true); + + // Initialize if needed + if (runnable is View view && !view.IsInitialized) + { + view.BeginInit(); + view.EndInit(); + // Initialized event is raised by View.EndInit() + } + + // Initial Layout and draw + LayoutAndDraw(true); + + // Set focus + if (runnable is View viewToFocus && !viewToFocus.HasFocus) + { + viewToFocus.SetFocus(); + } + + if (PositionCursor()) + { + Driver?.UpdateCursor(); + } + + return token; + } + + private void End(RunnableSessionToken token) + { + if (token.Runnable is null) + { + return; // Already ended + } + + IRunnable runnable = token.Runnable; + + // Raise IsRunningChanging (true -> false) - can be canceled + // This is where Result should be extracted! + if (runnable.RaiseIsRunningChanging(true, false)) + { + // Stopping was canceled + return; + } + + // Current runnable is no longer modal + // Raise IsModalChanging (true -> false) + runnable.RaiseIsModalChanging(true, false); + // IsModal is now false (will be false after pop) + runnable.RaiseIsModalChangedEvent(false); + + // Pop token from Runnable Stack (IsRunning becomes false) + if (RunnableSessionStack.TryPop(out RunnableSessionToken? popped) && popped == token) + { + // Restore previous top runnable + if (RunnableSessionStack.TryPeek(out RunnableSessionToken? previousToken)) + { + TopRunnable = previousToken.Runnable; + + // Previous runnable becomes modal again + if (TopRunnable != null) + { + // Raise IsModalChanging (false -> true) + TopRunnable.RaiseIsModalChanging(false, true); + // IsModal is now true (derived property) + TopRunnable.RaiseIsModalChangedEvent(true); + } + } + else + { + TopRunnable = null; + } + } + + // Raise IsRunningChanged (now false) + runnable.RaiseIsRunningChangedEvent(false); + + // Set focus to new TopRunnable if exists + if (TopRunnable is View viewToFocus && !viewToFocus.HasFocus) + { + viewToFocus.SetFocus(); + } + + // Clear the token + token.Runnable = null; + } + + public void RequestStop(IRunnable? runnable = null) + { + runnable ??= TopRunnable; + + if (runnable is null) + { + return; + } + + // Trigger the run loop to exit + // The End() method will be called from the finally block in Run() + // and that's where IsRunningChanging/IsRunningChanged will be raised + _stopRequested = runnable; + } +} + +``` + +### 8. Updated View Hierarchy + +```csharp +// Old hierarchy +View + ├─ Toplevel (runnable, overlapped, modal property) + │ ├─ Window (overlapped) + │ │ ├─ Dialog (modal, centered) + │ │ │ └─ MessageBox + │ │ └─ Wizard (modal, multi-step) + │ └─ (other Toplevel derivatives) + └─ (all other views) + +// New hierarchy +View + ├─ Runnable (implements IRunnable) + │ ├─ Window (can be run, overlapped by default) + │ ├─ Dialog (implements IModalRunnable, centered) + │ │ └─ MessageBox + │ └─ Wizard (implements IModalRunnable, multi-step) + └─ (all other views, can optionally implement IRunnable) +``` + +### 9. Usage Examples + +#### Three Forms of Run() + +**Form 1: Run with provided runnable** + +```csharp +Application app = Application.Create (); +app.Init (); + +Runnable myView = new () +{ + Width = Dim.Fill (), + Height = Dim.Fill () +}; +myView.Add (new MenuBar { /* ... */ }); +myView.Add (new StatusBar { /* ... */ }); + +app.Run (myView); // Run the specific runnable +myView.Dispose (); +app.Shutdown (); +``` + +**Form 2: Run with type parameter (generic convenience)** + +```csharp +Application app = Application.Create (); +app.Init (); + +Dialog dialog = app.Run (); // Creates and runs Dialog +// dialog.Result contains the result after it closes + +dialog.Dispose (); +app.Shutdown (); +``` + +**Form 3: Run with default container (parameterless convenience)** + +```csharp +Application app = Application.Create (); +app.Init (); + +// Subscribe to application-level event to populate the default runnable +app.IsRunningChanged += (s, e) => +{ + if (e.CurrentValue && app.TopRunnable != null) + { + // Populate app.TopRunnable with views when it starts + app.TopRunnable.Add (new MenuBar { /* ... */ }); + app.TopRunnable.Add (new Label + { + Text = "Hello World!", + X = Pos.Center (), + Y = Pos.Center () + }); + app.TopRunnable.Add (new StatusBar { /* ... */ }); + } +}; + +IRunnable mainRunnable = app.Run (); // Creates default Runnable and runs it +mainRunnable.Dispose (); + +app.Shutdown (); +``` + +**Why three forms?** +- **Form 1**: Most control, you create and configure the runnable +- **Form 2**: Convenience for creating typed runnables with default constructors +- **Form 3**: Simplest for quick apps, populate via `Starting` event + +#### Using IsRunningChanged Event + +```csharp +Runnable runnable = new (); + +// Listen for when it starts running +runnable.IsRunningChanged += (s, e) => +{ + if (e.CurrentValue) // Started running + { + // View is on the stack, initialized, and laid out + // Safe to perform post-start logic + SetupDataBindings (); + LoadInitialData (); + } + else // Stopped running + { + // Clean up resources + SaveState (); + } +}; + +app.Run (runnable); +runnable.Dispose (); +``` + +#### Override Pattern (Canceling Stop with Cleanup and Result Extraction) + +```csharp +public class MyRunnable : Runnable +{ + private TextField? _textField; + + protected override bool OnIsRunningChanging(bool oldIsRunning, bool newIsRunning) + { + if (!newIsRunning) // Stopping + { + // Extract Result BEFORE being removed from stack + if (HasUnsavedChanges ()) + { + var result = MessageBox.Query ("Unsaved Changes", + "Save before closing?", "Yes", "No", "Cancel"); + + if (result == 2) // Cancel + { + return true; // Cancel stopping + } + else if (result == 0) // Yes + { + SaveChanges (); + Result = _textField?.Text; // Extract result + } + else // No + { + Result = null; // Explicitly null (canceled) + } + } + else + { + Result = _textField?.Text; // Extract result + } + } + else // Starting + { + // Clear previous result + Result = default; + + // Can prevent starting if needed + if (!CanStart ()) + { + return true; // Cancel starting + } + } + + return base.OnIsRunningChanging (oldIsRunning, newIsRunning); + } + + protected override void OnIsRunningChanged (bool newIsRunning) + { + if (newIsRunning) // Started + { + // Post-start initialization + SetFocus (); + StartBackgroundWork (); + } + else // Stopped + { + // Cleanup after successful stop + DisconnectFromServer (); + SaveState (); + } + + base.OnIsRunningChanged (newIsRunning); + } + + protected override void OnIsModalChanged (bool newIsModal) + { + if (newIsModal) // Became modal (top of stack) + { + // Set focus, update UI for being active + UpdateTitle ("Active"); + } + else // No longer modal (another runnable on top) + { + // Dim UI, show as inactive + UpdateTitle ("Inactive"); + } + + base.OnIsModalChanged (newIsModal); + } +} +``` + +#### Modal Dialog with Automatic Result Capture + +`Dialog` implements `IRunnable` and overrides `OnIsRunningChanging` to extract result before disposal: + +```csharp +public class Dialog : Runnable +{ + private Button[]? _buttons; + + protected override bool OnIsRunningChanging(bool oldIsRunning, bool newIsRunning) + { + if (!newIsRunning) // Stopping + { + // Extract Result BEFORE views are disposed + // Find which button was clicked + Result = _buttons?.Select((b, i) => (button: b, index: i)) + .FirstOrDefault(x => x.button.HasFocus) + .index ?? -1; + } + + return base.OnIsRunningChanging(oldIsRunning, newIsRunning); + } +} + +// Usage +Dialog dialog = new (); +Application.Run (dialog); + +// Type-safe result - no casting needed +var result = dialog.Result ?? -1; + +// Pattern matching +if (dialog.Result is int buttonIndex) +{ + switch (buttonIndex) + { + case 0: + // First button clicked + break; + case 1: + // Second button clicked + break; + case -1: + // Canceled (ESC, closed) + break; + } +} +dialog.Dispose (); +``` + +This works seamlessly with buttons calling `Application.RequestStop()` in their handlers. + +#### MessageBox Example - Type-Safe and Simple + +With `Dialog` implementing `IRunnable`, MessageBox is beautifully simple: + +```csharp +// MessageBox.Query implementation (simplified) +private static int QueryFull (string title, string message, params string [] buttons) +{ + using Dialog d = new () { Title = title, Text = message }; + + // Create buttons with handlers that call RequestStop + for (var i = 0; i < buttons.Length; i++) + { + var buttonIndex = i; // Capture for closure + d.AddButton (new Button + { + Text = buttons [i], + IsDefault = (i == 0), // First button is default + Accept = (s, e) => + { + // Store which button was clicked + d.Result = buttonIndex; + Application.RequestStop (); + } + }); + } + + // Run modal - blocks until RequestStop() + Application.Run (d); + + // Type-safe result - no casting needed! + return d.Result ?? -1; // null = canceled (ESC pressed, etc.) +} +``` + +**Pattern**: Buttons set `Result` in their handlers, then call `RequestStop()`. The `OnIsRunningChanging` override can extract additional data if needed. + +#### OptionSelector Example - Type-Safe Pattern + +Custom dialog that returns a typed enum: + +```csharp +// Custom dialog that returns an Alignment enum +public class AlignmentDialog : Runnable +{ + private RadioGroup? _selector; + + public AlignmentDialog () + { + Title = "Choose Alignment"; + + _selector = new () + { + RadioLabels = new [] { "Start", "Center", "End" } + }; + + Add (_selector); + + Button okButton = new () { Text = "OK", IsDefault = true }; + okButton.Accept += (s, e) => + { + Application.RequestStop (); + }; + AddButton (okButton); + } + + protected override bool OnIsRunningChanging (bool oldIsRunning, bool newIsRunning) + { + if (!newIsRunning) // Stopping + { + // Extract the selected value BEFORE disposal + Result = _selector?.SelectedItem switch + { + 0 => Alignment.Start, + 1 => Alignment.Center, + 2 => Alignment.End, + _ => (Alignment?)null + }; + } + + return base.OnIsRunningChanging (oldIsRunning, newIsRunning); + } +} + +// Usage - type-safe! +AlignmentDialog dialog = new (); +Application.Run (dialog); + +if (dialog.Result is Alignment alignment) +{ + ApplyAlignment (alignment); // No casting needed! +} +dialog.Dispose (); +``` + +#### FileDialog Example + +```csharp +public class FileDialog : Runnable +{ + private TextField? _pathField; + + public FileDialog () + { + Title = "Open File"; + + _pathField = new () { Width = Dim.Fill () }; + Add (_pathField); + + Button okButton = new () { Text = "OK", IsDefault = true }; + okButton.Accept += (s, e) => + { + Application.RequestStop (); + }; + + AddButton (okButton); + } + + protected override bool OnIsRunningChanging (bool oldIsRunning, bool newIsRunning) + { + if (!newIsRunning) // Stopping + { + // Extract result BEFORE disposal + Result = _pathField?.Text; + } + + return base.OnIsRunningChanging (oldIsRunning, newIsRunning); + } +} + +// Usage - type-safe! +FileDialog fileDialog = new (); +Application.Run (fileDialog); + +if (fileDialog.Result is { } path) +{ + OpenFile (path); // string, no cast needed! +} +fileDialog.Dispose (); +``` + +#### Key Benefits + +1. **Zero boilerplate** - No manual Accepting handlers in MessageBox +2. **Fully type-safe** - No casting, compile-time type checking +3. **Natural C# idioms** - `null` = not accepted, pattern matching for accepted +4. **Safe disposal** - Data extracted before views are disposed +5. **Extensible** - Works with any type: `int`, `string`, enums, custom objects +6. **Clean separation** - Dialog captures data, controls handle their own Accept logic +7. **Consistent** - All lifecycle events follow Terminal.Gui's Cancellable Work Pattern + +--- + +## Migration Path + +### Phase 0: Rename `Current` to `TopRunnable` **DONE** + +- Issue #4148 +- This is a minor rename for clarity. Can be done after Phase 1 is complete. +- Rename `IApplication.Current` → `IApplication.TopRunnable` +- Update `View.IsCurrentTop` → `View.IsTopRunnable` + +### Phase 1: Add IRunnable Support ✅ COMPLETE + +- Issue #4400 - **COMPLETED** + +**Implemented:** + +1. ✅ Add `IRunnable` (non-generic) interface alongside existing `Toplevel` +2. ✅ Add `IRunnable` (generic) interface +3. ✅ Add `Runnable` base class +4. ✅ Add `RunnableSessionToken` class +5. ✅ Update `IApplication.RunnableSessionStack` to hold `RunnableSessionToken` +6. ✅ Update `IApplication` to support both `Toplevel` and `IRunnable` +7. ✅ Implement CWP-based `IsRunningChanging`/`IsRunningChanged` events +8. ✅ Implement CWP-based `IsModalChanging`/`IsModalChanged` events +9. ✅ Update `Begin()`, `End()`, `RequestStop()` to raise these events +10. ✅ Add `Run()` overloads: `Run(IRunnable)`, `Run()` + +**Bonus Features Added:** + +11. ✅ Fluent API - `Init()`, `Run()` return `IApplication` for method chaining +12. ✅ Automatic Disposal - `Shutdown()` returns result and disposes framework-owned runnables +13. ✅ Clear Ownership Semantics - "Whoever creates it, owns it" +14. ✅ 62 Parallelizable Unit Tests - Comprehensive test coverage +15. ✅ Example Application - `Examples/FluentExample` demonstrating the pattern +16. ✅ Complete API Documentation - XML docs for all new types + +**Key Design Decisions:** + +- Fluent API with `Init()` → `Run()` → `Shutdown()` chaining +- `Run()` returns `IApplication` (breaking change from returning `TRunnable`) +- `Shutdown()` returns `object?` (result from last run runnable) +- Framework automatically disposes runnables created by `Run()` +- Caller disposes runnables passed to `Run(IRunnable)` + +**Migration Example:** + +```csharp +// Before (manual disposal): +var dialog = new MyDialog(); +app.Run(dialog); +var result = dialog.Result; +dialog.Dispose(); + +// After (fluent with automatic disposal): +var result = Application.Create() + .Init() + .Run() + .Shutdown() as MyResultType; +``` + +### Phase 2: Migrate Existing Views + +- Issue (TBD) + +1. Make `Toplevel` implement `IRunnable` (adapter pattern for compatibility) +2. Update `Dialog` to inherit from `Runnable` instead of `Window` +3. Update `MessageBox` to use `Dialog.Result` +4. Update `Wizard` to inherit from `Runnable` +5. Update all examples to use new `IRunnable` pattern + +### Phase 3: Deprecate and Remove Toplevel + +- Issue (TBD) + +1. Mark `Toplevel` as `[Obsolete]` +2. Update all internal code to use `IRunnable`/`Runnable` +3. Remove `Toplevel` class entirely (breaking change for v3) + +### Phase 4: Upgrade View Initialization (Optional Enhancement) + +- Issue (TBD) + +1. Refactor `View.BeginInit()`/`View.EndInit()`/`Initialized` to be CWP compliant +2. This is independent of the runnable architecture but would improve consistency diff --git a/docfx/docs/toc.yml b/docfx/docs/toc.yml index 66c9b5cbb..c25192060 100644 --- a/docfx/docs/toc.yml +++ b/docfx/docs/toc.yml @@ -2,10 +2,16 @@ href: index.md - name: Getting Started href: getting-started.md +- name: Showcase + href: showcase.md - name: What's new in v2 href: newinv2.md - name: v1 To v2 Migration href: migratingfromv1.md +- name: Lexicon & Taxonomy + href: lexicon.md +- name: Application Deep Dive + href: application.md - name: Arrangement href: arrangement.md - name: Cancellable Work Pattern @@ -24,8 +30,6 @@ href: drivers.md - name: Events Deep Dive href: events.md -- name: Lexicon & Taxonomy - href: lexicon.md - name: Keyboard href: keyboard.md - name: Layout Engine @@ -38,14 +42,16 @@ href: navigation.md - name: Popovers href: Popovers.md -- name: View Deep Dive - href: View.md -- name: View List - href: views.md +- name: Scheme Deep Dive + href: scheme.md - name: Scrolling href: scrolling.md - name: TableView Deep Dive href: tableview.md - name: TreeView Deep Dive href: treeview.md +- name: View Deep Dive + href: View.md +- name: View List + href: views.md diff --git a/docfx/docs/views.md b/docfx/docs/views.md index 77490fae4..80c96aba8 100644 --- a/docfx/docs/views.md +++ b/docfx/docs/views.md @@ -119,7 +119,7 @@ Lets the user pick a date from a visual calendar. ## [Dialog](~/api/Terminal.Gui.Views.Dialog.yml) -A [Toplevel.Modal](~/api/Terminal.Gui.Views.Toplevel.Modal.yml) [Window](~/api/Terminal.Gui.Views.Window.yml). Supports a simple API for adding [Button](~/api/Terminal.Gui.Views.Button.yml)s across the bottom. By default, the [Dialog](~/api/Terminal.Gui.Views.Dialog.yml) is centered and used the [Schemes.Dialog](~/api/Terminal.Gui.Drawing.Schemes.Dialog.yml) scheme. +A [Runnable.Modal](~/api/Terminal.Gui.Views.Runnable.Modal.yml) [Window](~/api/Terminal.Gui.Views.Window.yml). Supports a simple API for adding [Button](~/api/Terminal.Gui.Views.Button.yml)s across the bottom. By default, the [Dialog](~/api/Terminal.Gui.Views.Dialog.yml) is centered and used the [Schemes.Dialog](~/api/Terminal.Gui.Drawing.Schemes.Dialog.yml) scheme. ```text ┏┥Demo Title┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ @@ -327,7 +327,7 @@ Last List Item ## [MenuBar](~/api/Terminal.Gui.Views.MenuBar.yml) -Provides a menu bar that spans the top of a [Toplevel](~/api/Terminal.Gui.Views.Toplevel.yml) View with drop-down and cascading menus. By default, any sub-sub-menus (sub-menus of the [MenuItem](~/api/Terminal.Gui.Views.MenuItem.yml)s added to [MenuBarItem](~/api/Terminal.Gui.Views.MenuBarItem.yml)s) are displayed in a cascading manner, where each sub-sub-menu pops out of the sub-menu frame (either to the right or left, depending on where the sub-menu is relative to the edge of the screen). By setting [MenuBar.UseSubMenusSingleFrame](~/api/Terminal.Gui.Views.MenuBar.UseSubMenusSingleFrame.yml) to true, this behavior can be changed such that all sub-sub-menus are drawn within a single frame below the MenuBar. +Provides a menu bar that spans the top of a [Runnable](~/api/Terminal.Gui.Views.Runnable.yml) View with drop-down and cascading menus. By default, any sub-sub-menus (sub-menus of the [MenuItem](~/api/Terminal.Gui.Views.MenuItem.yml)s added to [MenuBarItem](~/api/Terminal.Gui.Views.MenuBarItem.yml)s) are displayed in a cascading manner, where each sub-sub-menu pops out of the sub-menu frame (either to the right or left, depending on where the sub-menu is relative to the edge of the screen). By setting [MenuBar.UseSubMenusSingleFrame](~/api/Terminal.Gui.Views.MenuBar.UseSubMenusSingleFrame.yml) to true, this behavior can be changed such that all sub-sub-menus are drawn within a single frame below the MenuBar. ```text File Edit About (Top-Level) @@ -518,7 +518,7 @@ Demo Text ## [Slider\](~/api/Terminal.Gui.Views.Slider-1.yml) -Provides a tpe-safe slider control letting the user navigate from a set of typed options in a linear manner using the keyboard or mouse. +Provides a type-safe slider control letting the user navigate from a set of typed options in a linear manner using the keyboard or mouse. @@ -532,7 +532,7 @@ Displays a spinning glyph or combinations of glyphs to indicate progress or acti ## [StatusBar](~/api/Terminal.Gui.Views.StatusBar.yml) -A status bar is a [View](~/api/Terminal.Gui.ViewBase.View.yml) that snaps to the bottom of a [Toplevel](~/api/Terminal.Gui.Views.Toplevel.yml) displaying set of [Shortcut](~/api/Terminal.Gui.Views.Shortcut.yml)s. The [StatusBar](~/api/Terminal.Gui.Views.StatusBar.yml) should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a status bar. +A status bar is a [View](~/api/Terminal.Gui.ViewBase.View.yml) that snaps to the bottom of a [Runnable](~/api/Terminal.Gui.Views.Runnable.yml) displaying set of [Shortcut](~/api/Terminal.Gui.Views.Shortcut.yml)s. The [StatusBar](~/api/Terminal.Gui.Views.StatusBar.yml) should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a status bar. ```text Ctrl+Z Quit Quit │ F1 Help Text Help │ F10 ☐ @@ -645,9 +645,9 @@ Provides time editing functionality with mouse support 02:48:05 ``` -## [Toplevel](~/api/Terminal.Gui.Views.Toplevel.yml) +## [Runnable](~/api/Terminal.Gui.Views.Runnable.yml) -Toplevel views are used for both an application's main view (filling the entire screen and for modal (pop-up) views such as [Dialog](~/api/Terminal.Gui.Views.Dialog.yml), [MessageBox](~/api/Terminal.Gui.Views.MessageBox.yml), and [Wizard](~/api/Terminal.Gui.Views.Wizard.yml)). +Runnable views are used for both an application's main view (filling the entire screen and for modal (pop-up) views such as [Dialog](~/api/Terminal.Gui.Views.Dialog.yml), [MessageBox](~/api/Terminal.Gui.Views.MessageBox.yml), and [Wizard](~/api/Terminal.Gui.Views.Wizard.yml)). ```text Demo Text diff --git a/docfx/schemas/tui-config-schema.json b/docfx/schemas/tui-config-schema.json index 87fec828d..a86bc7559 100644 --- a/docfx/schemas/tui-config-schema.json +++ b/docfx/schemas/tui-config-schema.json @@ -220,7 +220,7 @@ "additionalProperties": true, "definitions": { "Color": { - "description": "One be either one of the W3C standard color names (parsed case-insensitively), a ColorName16 (e.g. 'BrightBlue', parsed case-insensitively), an rgb(r,g,b) tuple, or a hex color string in the format #RRGGBB.", + "description": "One of the standard color names (parsed case-insensitively; (e.g. 'BrightBlue'), an rgb(r,g,b) tuple, or a hex color string in the format #RRGGBB.", "$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "oneOf": [ @@ -572,7 +572,7 @@ ], "description": "Default shadow style for Button controls, often used for 3D effect." }, - "Menuv2.DefaultBorderStyle": { + "Menu.DefaultBorderStyle": { "type": "string", "enum": [ "None", @@ -581,9 +581,9 @@ "Heavy", "Rounded" ], - "description": "Default border style for the newer Menuv2 control and its sub-menus." + "description": "Default border style for the newer Menu control and its sub-menus." }, - "MenuBarv2.DefaultBorderStyle": { + "MenuBar.DefaultBorderStyle": { "type": "string", "enum": [ "None", @@ -592,7 +592,7 @@ "Heavy", "Rounded" ], - "description": "Default border style for the MenuBarv2 control." + "description": "Default border style for the MenuBar control." }, "StatusBar.DefaultSeparatorLineStyle": { "type": "string", @@ -606,7 +606,7 @@ }, "Schemes": { "type": "array", - "description": "A list of scheme definitions for this theme. Each item in the array is an object containing one or more named schemes (e.g., 'TopLevel', 'Base', 'Menu').", + "description": "A list of scheme definitions for this theme. Each item in the array is an object containing one or more named schemes (e.g., 'Runnable', 'Base', 'Menu').", "items": { "type": "object", "description": "An object where each key is a scheme name (e.g., 'Base', 'Error') and its value is the scheme definition.",