mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
Updates IListDataSource.Render to rename the start parameter to viewportXOffset (#4392)
* Add comprehensive unit tests for WindowsKeyConverter - Implement 118 parallelizable unit tests for WindowsKeyConverter - Cover ToKey and ToKeyInfo methods with full bidirectional testing - Test basic characters, modifiers, special keys, function keys - Test VK_PACKET Unicode/IME input - Test OEM keys, NumPad keys, and lock states - Include round-trip conversion tests - All tests passing successfully Fixes #4389 * Rename `start` parameter to `viewportXOffset` for clarity The `start` parameter in several methods and interfaces has been renamed to `viewportXOffset` to better reflect its purpose as the horizontal offset of the viewport during string rendering. - Updated method signatures in `ListViewWithSelection` to use `viewportXOffset` instead of `start`, including default values. - Modified the `RenderUstr` method in `ListViewWithSelection` to use `viewportXOffset` for calculating the starting index. - Renamed the `start` parameter to `viewportXOffset` in the `IListDataSource` interface and updated its documentation. - Replaced all occurrences of `start` with `viewportXOffset` in the `ListWrapper<T>` class, including method calls and logic. - Updated the `RenderUstr` method in `ListWrapper<T>` to use `viewportXOffset` for substring calculations. - Adjusted the test method in `ListViewTests.cs` to reflect the parameter name change. These changes improve code readability and make the parameter's role in rendering logic more explicit. * Remove WindowsKeyConverterTests class that was added by mistake * Modernized ListView and IListDataSource - Tons of new unit tests Refactored `ListView` and `IListDataSource` to improve readability, maintainability, and functionality. Introduced `ListWrapper<T>` as a default implementation of `IListDataSource` for easier integration with standard collections. Enhanced `ListView` with better handling of marking, selection, and scrolling. Replaced `viewportXOffset` with `viewportX` for horizontal scrolling. Added `EnsureSelectedItemVisible` to maintain visibility of the selected item. Updated `IListDataSource` with detailed XML documentation and added `SuspendCollectionChangedEvent` for bulk updates. Improved null safety with nullable reference types. Added comprehensive unit tests for `ListWrapper<T>` and `IListDataSource` to ensure robustness. Modernized the codebase with C# features like expression-bodied members and pattern matching. Fixed bugs related to `SelectedItem` validation and rendering artifacts. * Improve index validation in ComboBox and ListView Enhance robustness by adding stricter checks for valid indices in ComboBox and ListView. Updated conditions in the `_listview.SelectedItemChanged` event handler to ensure `e.Item` is non-negative before accessing `_searchSet`. Modified the `SetValue` method to use `e.Item` instead of `_listview.SelectedItem`. In ListView, updated the `OnSelectedChanged` method to validate that `SelectedItem` is non-negative (`>= 0`) before accessing the `Source` list. These changes prevent potential out-of-range errors and improve code safety. * Refactor and enhance test coverage across modules Refactored and added new tests to improve coverage, readability, and consistency across multiple test files. Key changes include: - **ShortcutTests.cs**: Added tests for `BindKeyToApplication` and removed redundant tests. - **SourcesManagerTests.cs**: Renamed `Update_*` tests to `Load_*` for clarity. - **ArrangementTests.cs**: Reintroduced `MouseGrabHandler` tests, added `ViewArrangement` flag tests, and improved structure. - **NeedsDrawTests.cs**: Replaced `Application.Screen.Size` with fixed dimensions for better isolation. - **DimAutoTests.cs**: Updated layout tests to use fixed dimensions. - **FrameTests.cs**: Standardized object initialization and validated frame behavior. - **SubViewTests.cs**: Improved formatting and modernized event handling. - **NumericUpDownTests.cs**: Decoupled layout tests from screen size. General improvements: - Enhanced formatting and removed redundant tests. - Added comments for clarity. - Introduced `ITestOutputHelper` for better debugging in `ArrangementTests`. * Refactor to use nullable types for better null safety Enabled nullable reference types across the codebase to improve null safety and prevent potential null reference issues. Refactored `SelectedItem` and related properties from `int` to `int?` to represent no selection with `null` instead of `-1`. Updated logic, event arguments, and method signatures to handle nullable values consistently. Simplified object initialization using modern C# syntax and improved code readability with interpolated strings. Added null checks and early returns to prevent runtime errors. Enhanced error handling by throwing `ArgumentOutOfRangeException` for invalid values. Updated tests to reflect the changes, replacing assertions for `-1` with `null` and ensuring proper handling of nullable values. Cleaned up redundant code and improved formatting for better maintainability. * on` functionality has been deprecated, refactored, or removed from the `Shortcut` class. * Refactor: Transition to instance-based architecture Updated `Run-LocalCoverage.ps1` to increase `--blame-hang-timeout` from 10s to 60s. Improved null safety in `GuiTestContext` by adding null-conditional operators. Commented out problematic code in `SetupFakeApplicationAttribute.cs` to prevent test hangs. Excluded `ViewBase` files from `UnitTests.Parallelizable.csproj` and removed redundant folder declarations. Simplified event handling in `IListDataSourceTests.cs` and updated `ListViewTests.cs` to use nullable reference types. Enhanced documentation to emphasize the transition to an instance-based application architecture. Updated examples in `application.md`, `multitasking.md`, and `navigation.md` to reflect the use of `Application.Create()` and `View.App`. Clarified the obsolescence of the static `Application` class. Revised table of contents in `toc.yml` to include new sections like "Application Deep Dive" and "Scheme Deep Dive." Added `dotnet-tools.json` for tool configuration. These changes improve maintainability, testability, and alignment with modern C# practices. * Refactor ListViewTests to use Terminal.Gui framework The `ListViewTests` class has been refactored to replace the `AutoInitShutdown` attribute with explicit application lifecycle management using `IApplication` and `app.Init()` from the `Terminal.Gui` framework. Key changes include: - Rewriting tests to use `Terminal.Gui`'s application lifecycle. - Adding a private `_output` field for logging test output via `ITestOutputHelper`. - Updating `DriverAssert.AssertDriverContentsWithFrameAre` to include `app.Driver` for UI verification. - Rewriting tests like `Clicking_On_Border_Is_Ignored`, `EnsureSelectedItemVisible_SelectedItem`, and others to align with the new framework. - Adding explicit calls to `app.Shutdown()` for proper cleanup. - Enabling nullable reference types with `#nullable enable`. - Updating `using` directives and `namespace` to reflect the new structure. These changes improve test maintainability, compatibility, and diagnostics. * Update Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Views/CollectionNavigation/CollectionNavigatorBase.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Examples/UICatalog/UICatalogTop.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Views/ListWrapper.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update Terminal.Gui/Views/ListWrapper.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Updated the `SetMark` method to return `Source.IsMarked(SelectedItem.Value)` for consistency and removed an outdated comment questioning its correctness. Enhanced the exception message in the `SelectedItem` property setter to provide clearer guidance when the value is out of range. * Add comprehensive ListView behavior test coverage Added multiple test methods to validate `ListView` behavior: - `Vertical_ScrollBar_Hides_And_Shows_As_Needed`: Ensures the vertical scrollbar auto-hides/shows based on content height. - `Mouse_Wheel_Scrolls`: Verifies vertical scrolling with the mouse wheel updates `TopItem`. - `SelectedItem_With_Source_Null_Does_Nothing`: Confirms no exceptions occur when setting `SelectedItem` with a `null` source. - `Horizontal_Scroll`: Tests horizontal scrolling, including programmatic and mouse wheel interactions, ensuring `LeftItem` updates correctly. - `SetSourceAsync_SetsSource`: Validates the asynchronous `SetSourceAsync` method updates the source and item count. - `AllowsMultipleSelection_Set_To_False_Unmarks_All_But_Selected`: Ensures disabling multiple selection unmarks all but the selected item. - `Source_CollectionChanged_Remove`: Confirms `SelectedItem` and source count update correctly when items are removed from the source collection. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Tig
GitHub
@@ -130,14 +130,14 @@ public class NeedsDrawTests : FakeDriverBase
|
||||
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);
|
||||
|
||||
@@ -180,7 +180,7 @@ public class NeedsDrawTests : FakeDriverBase
|
||||
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);
|
||||
}
|
||||
@@ -216,7 +216,7 @@ public class NeedsDrawTests : FakeDriverBase
|
||||
view.EndInit ();
|
||||
Assert.True (view.NeedsDraw);
|
||||
|
||||
view.SetRelativeLayout (Application.Screen.Size);
|
||||
view.SetRelativeLayout (new (100, 100));
|
||||
Assert.True (view.NeedsDraw);
|
||||
|
||||
view.LayoutSubViews ();
|
||||
@@ -235,7 +235,7 @@ public class NeedsDrawTests : FakeDriverBase
|
||||
view.EndInit ();
|
||||
Assert.True (view.NeedsDraw);
|
||||
|
||||
view.SetRelativeLayout (Application.Screen.Size);
|
||||
view.SetRelativeLayout (new (100, 100));
|
||||
Assert.True (view.NeedsDraw);
|
||||
|
||||
view.LayoutSubViews ();
|
||||
|
||||
@@ -597,7 +597,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);
|
||||
|
||||
|
||||
@@ -304,10 +304,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 +316,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 +703,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 +812,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 +831,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);
|
||||
}
|
||||
|
||||
@@ -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);
|
||||
|
||||
|
||||
@@ -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]
|
||||
@@ -517,7 +517,7 @@ public class SubViewTests
|
||||
Assert.False (v2AddedToWin.CanFocus);
|
||||
Assert.False (svAddedTov1.CanFocus);
|
||||
|
||||
Application.LayoutAndDraw ();
|
||||
top.Layout ();
|
||||
};
|
||||
|
||||
winAddedToTop.Initialized += (s, e) =>
|
||||
|
||||
Reference in New Issue
Block a user