Files
Terminal.Gui/Tests/UnitTestsParallelizable/Views/ListViewTests.cs
Tig a84b2c4896 Fixes #4419, #4148, #4408 - Toplevel is GONE - Replaced by Runnable (#4422)
* WIP: Broken

* Got working. Mostly.

* Parllel tests pass

* More progres

* Fixed app tests.

* Mouse

* more progress.

* working on shortcut

* Shortcut accept on ENTER is broken.

* One left...

* More test progress.

* All unit tests pass. Still some issues though.

* tweak

* Fixed Integration Tests

* Fixed UI Catalog

* Tweaking CP to try to find race condition

* Refactor StandardColors and improve ColorPicker logic

Refactored `StandardColors` to use lazy initialization for static fields, improving performance and avoiding static constructor convoy effects. Introduced `NamesValueFactory` and `MapValueFactory` methods for encapsulated initialization logic.

Simplified `GetColorNames` to directly return `_names.Value`. Improved `TryParseColor` by clarifying default value usage and adopting object initializer syntax. Updated `TryNameColor` to use `_argbNameMap.Value`.

Refactored `GetArgb` for better readability. Replaced `MultiStandardColorNameResolver` with `StandardColorsNameResolver` in `ColorPicker`. Commented out `app.Init("Fake")` in `ColorPickerTests` for testing purposes.

Made minor formatting improvements, including updated comments and XML documentation for consistency.

* revert

* Throttle input loop to prevent CPU spinning

Introduce a 20ms delay in the input loop of `InputImpl<TInputRecord>`
to prevent excessive CPU usage when no input is available. Removed
the `DateTime dt = Now();` line and the `while (Peek())` block, which
previously enqueued input records.

This change improves resource management, especially in scenarios
where multiple `ApplicationImpl` instances are created in parallel
tests without calling `Shutdown()`. It prevents thread pool
exhaustion and ensures better performance in such cases.

* Refactor ApplicationImpl to use IDisposable pattern

Implemented the IDisposable pattern in ApplicationImpl to improve resource management. Added `Dispose` and `DisposeCore` methods, and marked the `Shutdown` method as obsolete, encouraging the use of `Dispose` or `using` statements instead. Updated the `IApplication` interface to inherit from IDisposable and added `GetResult` methods for retrieving run session results.

Refactored unit tests to adopt the new lifecycle management approach, replacing legacy `Shutdown` calls with `Dispose` or `using`. Removed fragile and obsolete tests, and re-enabled previously skipped tests after addressing underlying issues.

Updated `FakeApplicationLifecycle` and `SetupFakeApplicationAttribute` to align with the new disposal pattern. Improved documentation and examples to guide users toward modern usage patterns. Maintained backward compatibility for legacy singleton usage.

* Add IDisposable pattern with input loop throttling

- Add IDisposable to IApplication for proper resource cleanup
- Add 20ms throttle to input loop (prevents CPU spinning)
- Add Lazy<T> to StandardColors (eliminates convoy effect)
- Add MainLoopCoordinatorTests suite (5 new tests)
- Add Dispose() calls to all 16 ColorPickerTests
- Mark Application.Shutdown() as [Obsolete]

IApplication now requires Dispose() for cleanup

Performance: 100x CPU reduction, 15x faster disposal, tests complete in <5s

Fixes: Thread leaks, CPU saturation, test hangs in parallel execution
Docs: Updated application.md and newinv2.md with disposal patterns

* Refactor test for input loop throttling clarity

Updated `InputLoop_Throttle_Limits_Poll_Rate` test to improve clarity, reliability, and efficiency:
- Rewrote summary comment to clarify purpose and emphasize the 20ms throttle's role in preventing CPU spinning.
- Replaced `var` with explicit types for better readability.
- Reduced test duration from 1s to 500ms to improve test speed.
- Revised assertions:
  - Replaced range-based assertion with upper-bound check to ensure poll count is below 500, avoiding timing sensitivity issues.
  - Added assertion to verify the thread ran and was not immediately canceled.
- Added a 2-second timeout to `inputTask.Wait` and verified task completion.
- Improved comments to explain test behavior and reasoning behind changes.

* tweaks

* Fix nullabiltiy stuff.

* runnable fixes

* more nullabe

* More nullability

* warnings gone

* Fixed fluent test failure.

* Refactor ApplicationImpl and update Runnable layout logic

Refactored `ApplicationImpl.Run.cs` for improved readability and
atomicity:
- Combined `if (wasModal)` with `SessionStack?.TryPop` to streamline
  logic.
- Simplified restoration of `previousRunnable` by reducing nesting.
- Updated comments for clarity and retained `SetIsModal` call.

Simplified focus-setting logic in `ApplicationImpl.Run.cs` using
pattern matching for `TopRunnableView`.

In `Runnable<TResult>`, added `SetNeedsLayout` after `IsModalChanged`
to ensure layout updates. Removed an unused empty line for cleanup.

Corrected namespace in `GetViewsUnderLocationForRootTests.cs` to
align with test structure.

* Update layout on modal state change

A call to `SetNeedsLayout()` was added to the `OnIsModalChanged`
method in the `Runnable` class. This ensures that the layout
is updated whenever the modal state changes.

* Increase test timeout for inputTask.Wait to 10 seconds

Extended the timeout duration for the `inputTask.Wait` method
from 4 seconds to 10 seconds in `MainLoopCoordinatorTests`.
This change ensures the test has a longer window to complete
under conditions of increased load or slower execution
environments, reducing the likelihood of false test failures.

* Refactor project files and simplify test logic

Removed `<LangVersion>` and `<ImplicitUsings>` properties from
`UnitTests.csproj` and `UnitTests.Parallelizable.csproj` to rely
on default SDK settings and disable implicit global usings.

Simplified the `SizeChanged_Event_Still_Fires_For_Compatibility`
test in `FakeDriverTests` by removing the `screenChangedFired`
variable, its associated event handler, and related assertions.
Also removed obsolete warning suppression directives as they
are no longer needed.

* Reduce UnitTestsParallelizable iterations from 10 to 3

Reduced the number of iterations for the UnitTestsParallelizable
test suite from 10 to 3 to save time and resources while still
exposing concurrency issues. Updated the loop and log messages
to reflect the new iteration count.

* disabled InputLoop_Throttle_Limits_Poll_Rate

* Refactor app lifecycle and improve Runnable API

Refactored `Program.cs` to simplify application lifecycle:
- Modularized app creation, initialization, and disposal.
- Improved result handling and ensured proper resource cleanup.

Re-implemented `Runnable<TResult>` with a cleaner design:
- Retained functionality while improving readability and structure.
- Added XML documentation and followed the Cancellable Work Pattern.

Re-implemented `RunnableWrapper<TView, TResult>`:
- Enabled wrapping any `View` to make it runnable with typed results.
- Added examples and remarks for better developer guidance.

Re-implemented `ViewRunnableExtensions`:
- Provided fluent API for making views runnable with or without results.
- Enhanced documentation with examples for common use cases.

General improvements:
- Enhanced code readability, maintainability, and error handling.
- Replaced redundant code with cleaner, more maintainable versions.

* Modernize codebase for Terminal.Gui and MVVM updates

Refactored `LoginView` to remove redundant `Application.LayoutAndDraw()`
call. Enhanced `LoginViewModel` with new observable properties for
automatic property change notifications. Updated `Message` class to use
nullable generics for improved type safety.

Replaced legacy `Application.Init()` and `Application.Run()` calls with
the modern `IApplication` API across `Program.cs`, `Example.cs`, and
`ReactiveExample`. Ensured proper disposal of `IApplication` instances
to prevent resource leaks.

Updated `TerminalScheduler` to integrate with `IApplication` for
invoking actions and managing timeouts. Added null checks and improved
timeout disposal logic for robustness.

Refactored `ExampleWindow` for better readability and alignment with
modern `Terminal.Gui` conventions. Cleaned up unused imports and
improved code clarity across the codebase.

Updated README.md to reflect the latest `Terminal.Gui` practices,
including examples of the `IApplication` API and automatic UI refresh
handling. Renamed `LoginAction` to `LoginActions` for consistency.

* Refactor: Transition to IRunnable-based architecture

Replaced `Toplevel` with `Window` as the primary top-level UI element. Introduced the `IRunnable` interface to modernize the architecture, enabling greater flexibility and testability. Deprecated the static `Application` class in favor of the instance-based `IApplication` model, which supports multiple application contexts.

Updated methods like `Application.Run()` and `Application.RequestStop()` to use `IRunnable`. Removed or replaced legacy `Modal` properties with `IsModal`. Enhanced the `IApplication` interface with a fluent API, including methods like `Run<TRunnable>()` and `GetResult<T>()`.

Refactored tests and examples to align with the new architecture. Updated documentation to reflect the instance-based model. Deprecated obsolete members and methods, including `Application.Current` and `Application.TopRunnable`.

Improved event handling by replacing the `Accept` event with `Accepting` and using `e.Handled` for event processing. Updated threading examples to use `App?.Invoke()` or `app.Invoke()` for UI updates. Cleaned up redundant code and redefined modal behavior for better consistency.

These changes modernize the `Terminal.Gui` library, improving clarity, usability, and maintainability while ensuring backward compatibility where possible.

* Refactor: Replace Toplevel with Runnable class

This commit introduces a major architectural update to the `Terminal.Gui` library, replacing the legacy `Toplevel` class with the new `Runnable` class. The changes span the entire codebase, including core functionality, tests, documentation, and configuration files.

- **Core Class Replacement**:
  - Replaced `Toplevel` with `Runnable` as the base class for modal views and session management.
  - Updated all references to `Toplevel` in the codebase, including constructors, methods, and properties.

- **Configuration Updates**:
  - Updated `tui-config-schema.json` to reflect the new `Runnable` scheme.

- **New Classes**:
  - Added `UICatalogRunnable` for managing the UI Catalog application.
  - Introduced `Runnable<TResult>` as a generic base class for blocking sessions with result handling.

- **Documentation and Tests**:
  - Updated documentation to emphasize `Runnable` and mark `Toplevel` as obsolete.
  - Refactored test cases to use `Runnable` and ensure compatibility.

- **Behavioral Improvements**:
  - Enhanced lifecycle management and alignment with the `IRunnable` interface.
  - Improved clarity and consistency in naming conventions.

These changes modernize the library, improve flexibility, and provide a clearer architecture for developers.

* Refactor: Consolidate Runnable classes and decouple View from ApplicationImpl

- Made Runnable<TResult> inherit from Runnable (eliminating ~180 LOC duplication)
- Moved View init/layout/cursor logic from ApplicationImpl to Runnable lifecycle events
- ApplicationImpl.Begin now operates purely on IRunnable interface

Related to #4419

* Simplified the disposal logic in `ApplicationImpl.Run.cs` by replacing
the type-specific check for `View` with a more general check for
`IDisposable`. This ensures proper disposal of any `IDisposable`
object, improving robustness.

Removed the `FrameworkOwnedRunnable` property from the `ApplicationImpl`
class in `ApplicationImpl.cs` and the `IApplication` interface in
`IApplication.cs`. This eliminates the need to manage this property,
reducing complexity and improving maintainability.

Updated `application.md` to reflect the removal of the
`FrameworkOwnedRunnable` property, ensuring the documentation aligns
with the updated codebase.

* Replaces the legacy `Shutdown()` method with `Dispose()` to align
with the `IDisposable` pattern, ensuring proper resource cleanup
and simplifying the API. The `Dispose()` method is now the
recommended way to release resources, with `using` statements
encouraged for automatic disposal.

Key changes:
- Marked `Shutdown()` as obsolete; it now internally calls `Dispose()`.
- Updated the fluent API to remove `Shutdown()` from chaining.
- Enhanced session lifecycle management for thread safety.
- Updated tests to validate proper disposal and state reset.
- Improved `IRunnable` integration with automatic disposal for
  framework-created runnables.
- Maintained backward compatibility for the legacy static
  `Application` singleton.
- Refactored documentation and examples to reflect modern practices
  and emphasize `Dispose()` usage.

These changes modernize the `Terminal.Gui` lifecycle, improve
testability, and encourage alignment with .NET conventions.

* Refactor runnable app context handling in ApplicationImpl

Refactor how the application context is set for `runnable` objects
by introducing a new `SetApp` method in the `IRunnable` interface.
This replaces the previous logic of directly setting the `App`
property for `View` objects, making the process more generic and
encapsulated within `IRunnable` implementations.

Simplify `Mouse.UngrabMouse()` by removing the conditional check
and calling it unconditionally.

Make a minor formatting adjustment in the generic constraint of
`Run<TRunnable>` in `ApplicationImpl`.

Add `SetApp(IApplication app)` to the `IRunnable` interface and
implement it in the `Runnable` class to set the `App` property
to the provided application instance.

* Improve docs, tests, and modularity across the codebase

Reorganized and updated `CONTRIBUTING.md`:
- Added **Key Architecture Concepts** section and reordered the table of contents.
- Updated testing requirements to discourage legacy patterns.
- Added instructions for replicating CI workflows locally.
- Clarified PR guidelines and coding style expectations.

Enhanced `README.md` with detailed CI/CD workflow documentation.

Refactored `ColorPicker.Prompt` to use `IApplication` for improved modularity and testability.

Introduced `IApplicationScreenChangedTests` for comprehensive testing of `ScreenChanged` events and `Screen` property.

Refactored `ApplicationScreenTests` and `TextView.PromptForColors` to align with modern patterns.

Updated `Terminal.sln` to include `.github/workflows/README.md`.

Performed general cleanup:
- Removed outdated documentation links.
- Improved XML documentation and coding consistency.

* readme tweaks

* Improve thread safety, layout, and test coverage

Refactored `OutputBufferImpl.cs` to enhance thread safety by locking shared resources and adding bounds checks for columns and rows. Improved handling of wide characters and removed outdated TODO comments.

Updated `Runnable.cs` to call `SetNeedsDraw()` on modal state changes, ensuring proper layout and drawing updates. Simplified layout handling in `ApplicationImpl.Run.cs` by replacing redundant comments with a `LayoutAndDraw()` call.

Added a check in `AllViewsTester.cs` to skip creating instances of `RunnableWrapper` types with unsatisfiable generic constraints, logging a warning when encountered.

Enhanced `ListViewTests.cs` by adding explicit `app.LayoutAndDraw()` calls to validate visual output and ensure tests reflect the updated application state.

These changes improve robustness, prevent race conditions, and ensure consistent behavior across the application.

* Refactor: Rename Toplevel to Runnable and update logic

Updated the `Border` class to use `Command.Quit` instead of
`Command.QuitToplevel` in the `CloseButton.Accept` handler.

Renamed test methods in `GetViewsAtLocationTests.cs` to replace
"Toplevel" with "Runnable" for consistency. Updated `Runnable<bool>`
instances to use "topRunnable" as the `Id` property.

These changes align the codebase with updated naming conventions
and improve clarity.

* Removed `ToplevelTests` and migrated relevant test cases to
`MouseDragTests` with improved structure and coverage. Updated
tests to use `Application.Create`, `app.Begin`, and `app.End`
for better resource management and lifecycle handling.

Replaced direct event handling with `app.Mouse.RaiseMouseEvent`
to align with the application's event-handling mechanism. Added
`Runnable` objects to ensure views are properly initialized and
disposed of within the application context.

Enhanced tests to include assertions for minimum width and
height constraints during resize operations. Removed redundant
tests and streamlined logic to reduce duplication and improve
maintainability.

* Reorged Unit Test namespaces.

* more

* Refactor tests and update namespaces for consistency

Updated namespaces in `ArrangementTests.cs` and `MouseDragTests.cs` for better organization. Enhanced `ArrangementTests.cs` with additional checks for arrangement flags. Reformatted and re-added `MouseDragTests.cs` and `SchemeTests.cs` with modern C# features like nullable annotations and object initializers. Ensured no functional changes while improving code clarity and consistency.

* Fix nullability warnings in MouseDragTests.cs

Updated `app.End` calls to use the null-forgiving operator (`!`)
on `app.SessionStack` to ensure it is treated as non-null.
This change addresses potential nullability warnings and
improves code safety and clarity. Applied consistently across
all relevant test cases in the `MouseDragTests` class.
2025-12-01 12:54:21 -07:00

1591 lines
48 KiB
C#

#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;
// ReSharper disable AccessToModifiedClosure
namespace ViewsTests;
public class ListViewTests (ITestOutputHelper output)
{
private readonly ITestOutputHelper _output = output;
[Fact]
public void CollectionNavigatorMatcher_KeybindingsOverrideNavigator ()
{
ObservableCollection<string> source = ["apricot", "arm", "bat", "batman", "bates hotel", "candle"];
var lv = new ListView { Source = new ListWrapper<string> (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<string> source = ["apricot", "arm", "bat", "batman", "bates hotel", "candle"];
var lv = new ListView { Source = new ListWrapper<string> (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<string> source = ["apricot", "arm", "bat", "batman", "bates hotel", "candle"];
var lv = new ListView { Source = new ListWrapper<string> (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!.Value]!);
}
[Fact]
public void ListViewCollectionNavigatorMatcher_IgnoreKeys ()
{
ObservableCollection<string> source = ["apricot", "arm", "bat", "batman", "bates hotel", "candle"];
var lv = new ListView { Source = new ListWrapper<string> (source) };
Mock<ICollectionNavigatorMatcher> matchNone = new ();
matchNone.Setup (m => m.IsCompatibleKey (It.IsAny<Key> ()))
.Returns (false);
lv.KeystrokeNavigator.Matcher = matchNone.Object;
// Keys are ignored because IsCompatibleKey returned false i.e. don't use these keys for navigation
Assert.False (lv.NewKeyDownEvent (Key.B));
Assert.False (lv.NewKeyDownEvent (Key.A));
Assert.False (lv.NewKeyDownEvent (Key.T));
// assert IsMatch never called
matchNone.Verify (m => m.IsMatch (It.IsAny<string> (), It.IsAny<object> ()), Times.Never ());
}
[Fact]
public void ListViewCollectionNavigatorMatcher_OverrideMatching ()
{
ObservableCollection<string> source = ["apricot", "arm", "bat", "batman", "bates hotel", "candle"];
var lv = new ListView { Source = new ListWrapper<string> (source) };
Mock<ICollectionNavigatorMatcher> matchNone = new ();
matchNone.Setup (m => m.IsCompatibleKey (It.IsAny<Key> ()))
.Returns (true);
// Match any string starting with b to "candle" (psych!)
matchNone.Setup (m => m.IsMatch (It.IsAny<string> (), It.IsAny<object> ()))
.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);
Assert.True (lv.NewKeyDownEvent (Key.A));
Assert.Equal (5, lv.SelectedItem);
Assert.True (lv.NewKeyDownEvent (Key.T));
Assert.Equal (5, 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<string> (["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<string> (["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<string> { "One", "Two", "Three" }; }
public void Dispose () { throw new NotImplementedException (); }
}
[Fact]
public void KeyBindings_Command ()
{
ObservableCollection<string> source = ["One", "Two", "Three"];
var lv = new ListView { Height = 2, AllowsMarking = true, Source = new ListWrapper<string> (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);
}
[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<string> source = ["One", "Two", "Three"];
var listView = new ListView { Source = new ListWrapper<string> (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<string> source = ["One", "Two", "Three"];
var listView = new ListView { Source = new ListWrapper<string> (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<string> (["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);
// clear the items
lv.SetSource<string> (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<string> (["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<string> (["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<string> 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<string> (["One", "Two", "Three"]) };
Assert.Null (lv.SelectedItem);
Assert.Throws<ArgumentException> (() => 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<string> (["One", "Two"]) };
Assert.NotNull (lv.Source);
lv.SetSource<string> (null);
Assert.NotNull (lv.Source);
lv.Source = null;
Assert.Null (lv.Source);
lv = new () { Source = new ListWrapper<string> (["One", "Two"]) };
Assert.NotNull (lv.Source);
lv.SetSourceAsync<string> (null);
Assert.NotNull (lv.Source);
}
[Fact]
public void SettingEmptyKeybindingThrows ()
{
var lv = new ListView { Source = new ListWrapper<string> (["One", "Two", "Three"]) };
Assert.Throws<ArgumentException> (() => lv.KeyBindings.Add (Key.Space));
}
[Fact]
public void CollectionChanged_Event ()
{
var added = 0;
var removed = 0;
ObservableCollection<string> source = [];
var lv = new ListView { Source = new ListWrapper<string> (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<string> source1 = [];
var lv = new ListView { Source = new ListWrapper<string> (new (source1)) };
lv.CollectionChanged += (sender, args) =>
{
if (args.Action == NotifyCollectionChangedAction.Add)
{
added++;
}
else if (args.Action == NotifyCollectionChangedAction.Remove)
{
removed++;
}
else
{
otherActions++;
}
};
ObservableCollection<string> source2 = [];
lv.Source = new ListWrapper<string> (source2);
ObservableCollection<string> source3 = [];
lv.Source = new ListWrapper<string> (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<string> source1 = [];
var lv = new ListView { Source = new ListWrapper<string> (source1) };
lv.CollectionChanged += (sender, args) =>
{
if (args.Action == NotifyCollectionChangedAction.Add)
{
added++;
}
else if (args.Action == NotifyCollectionChangedAction.Remove)
{
removed++;
}
else
{
otherActions++;
}
};
lv.Source = new ListWrapper<string> (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<string> source1 = [];
ListWrapper<string> lw = new (source1);
lw.CollectionChanged += (sender, args) =>
{
if (args.Action == NotifyCollectionChangedAction.Add)
{
added++;
}
else if (args.Action == NotifyCollectionChangedAction.Remove)
{
removed++;
}
else
{
otherActions++;
}
};
ObservableCollection<string> source2 = [];
lw = new (source2);
ObservableCollection<string> 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<string> source1 = [];
ListWrapper<string> 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<string> source = [];
ListWrapper<string> 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<string> source = [];
var lv = new ListView { Source = new ListWrapper<string> (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<string> 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<string> (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<string> source = [];
for (var i = 0; i < 10; i++)
{
source.Add ($"Item {i}");
}
var lv = new ListView { Width = 10, Height = 5, Source = new ListWrapper<string> (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<string> source = ["First", "Second"];
var lv = new ListView { Width = Dim.Fill (), Height = 1, Source = new ListWrapper<string> (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<string> source = [];
for (var i = 0; i < 5; i++)
{
source.Add ($"Item {i}");
}
var lv = new ListView
{
X = 1,
Source = new ListWrapper<string> (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<string> 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<string> { "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<string> (["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<string> { "One", "Two", "Three" };
var lv = new ListView { Source = new ListWrapper<string> (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);
}
}