mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
* 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>
223 lines
7.5 KiB
C#
223 lines
7.5 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Collections.ObjectModel;
|
|
using System.Linq;
|
|
|
|
namespace UICatalog.Scenarios;
|
|
|
|
[ScenarioMetadata ("SpinnerView Styles", "Shows the SpinnerView Styles.")]
|
|
[ScenarioCategory ("Controls")]
|
|
[ScenarioCategory ("Progress")]
|
|
public class SpinnerViewStyles : Scenario
|
|
{
|
|
public override void Main ()
|
|
{
|
|
Application.Init ();
|
|
|
|
Window app = new ()
|
|
{
|
|
Title = GetQuitKeyAndName ()
|
|
};
|
|
|
|
const int DEFAULT_DELAY = 130;
|
|
const string DEFAULT_CUSTOM = @"-\|/";
|
|
Dictionary<int, KeyValuePair<string, Type>> styleDict = new ();
|
|
var i = 0;
|
|
|
|
foreach (Type style in typeof (SpinnerStyle).GetNestedTypes ())
|
|
{
|
|
styleDict.Add (i, new (style.Name, style));
|
|
i++;
|
|
}
|
|
|
|
var preview = new View
|
|
{
|
|
X = Pos.Center (),
|
|
Y = 0,
|
|
Width = 22,
|
|
Height = 3,
|
|
|
|
//Title = "Preview",
|
|
BorderStyle = LineStyle.Single
|
|
};
|
|
app.Add (preview);
|
|
|
|
var spinner = new SpinnerView { X = Pos.Center (), Y = 0 };
|
|
preview.Add (spinner);
|
|
spinner.AutoSpin = true;
|
|
|
|
var ckbAscii = new CheckBox
|
|
{
|
|
X = Pos.Center () - 7,
|
|
Y = Pos.Bottom (preview),
|
|
Enabled = false,
|
|
CheckedState = CheckState.Checked,
|
|
Text = "Ascii Only"
|
|
};
|
|
app.Add (ckbAscii);
|
|
|
|
var ckbNoSpecial = new CheckBox
|
|
{
|
|
X = Pos.Center () + 7,
|
|
Y = Pos.Bottom (preview),
|
|
Enabled = false,
|
|
CheckedState = CheckState.Checked,
|
|
Text = "No Special"
|
|
};
|
|
app.Add (ckbNoSpecial);
|
|
|
|
var ckbReverse = new CheckBox
|
|
{
|
|
X = Pos.Center () - 22, Y = Pos.Bottom (preview) + 1, CheckedState = CheckState.UnChecked, Text = "Reverse"
|
|
};
|
|
app.Add (ckbReverse);
|
|
|
|
var ckbBounce = new CheckBox
|
|
{
|
|
X = Pos.Right (ckbReverse) + 2, Y = Pos.Bottom (preview) + 1, CheckedState = CheckState.UnChecked, Text = "Bounce"
|
|
};
|
|
app.Add (ckbBounce);
|
|
|
|
var delayLabel = new Label { X = Pos.Right (ckbBounce) + 2, Y = Pos.Bottom (preview) + 1, Text = "Delay:" };
|
|
app.Add (delayLabel);
|
|
|
|
var delayField = new TextField
|
|
{
|
|
X = Pos.Right (delayLabel), Y = Pos.Bottom (preview) + 1, Width = 5, Text = DEFAULT_DELAY.ToString ()
|
|
};
|
|
app.Add (delayField);
|
|
|
|
delayField.TextChanged += (s, e) =>
|
|
{
|
|
if (ushort.TryParse (delayField.Text, out ushort i))
|
|
{
|
|
spinner.SpinDelay = i;
|
|
}
|
|
};
|
|
|
|
var customLabel = new Label { X = Pos.Right (delayField) + 2, Y = Pos.Bottom (preview) + 1, Text = "Custom:" };
|
|
app.Add (customLabel);
|
|
|
|
var customField = new TextField
|
|
{
|
|
X = Pos.Right (customLabel), Y = Pos.Bottom (preview) + 1, Width = 12, Text = DEFAULT_CUSTOM
|
|
};
|
|
app.Add (customField);
|
|
|
|
string [] styleArray = styleDict.Select (e => e.Value.Key).ToArray ();
|
|
|
|
if (styleArray.Length < 1)
|
|
{
|
|
return;
|
|
}
|
|
|
|
var styles = new ListView
|
|
{
|
|
X = Pos.Center (), Y = Pos.Bottom (preview) + 2, Height = Dim.Fill (), Width = Dim.Fill (1)
|
|
};
|
|
styles.SetSource (new ObservableCollection<string> (styleArray));
|
|
styles.SelectedItem = 0; // SpinnerStyle.Custom;
|
|
app.Add (styles);
|
|
SetCustom ();
|
|
|
|
customField.TextChanged += (s, e) =>
|
|
{
|
|
if (customField.Text.Length > 0)
|
|
{
|
|
if (styles.SelectedItem != 0)
|
|
{
|
|
styles.SelectedItem = 0; // SpinnerStyle.Custom
|
|
}
|
|
|
|
SetCustom ();
|
|
}
|
|
};
|
|
|
|
styles.SelectedItemChanged += (s, e) =>
|
|
{
|
|
if (e.Item == 0)
|
|
{
|
|
// SpinnerStyle.Custom
|
|
if (customField.Text.Length < 1)
|
|
{
|
|
customField.Text = DEFAULT_CUSTOM;
|
|
}
|
|
|
|
if (delayField.Text.Length < 1)
|
|
{
|
|
delayField.Text = DEFAULT_DELAY.ToString ();
|
|
}
|
|
|
|
SetCustom ();
|
|
}
|
|
else
|
|
{
|
|
spinner.Visible = true;
|
|
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;
|
|
ckbAscii.CheckedState = spinner.IsAsciiOnly ? CheckState.Checked : CheckState.UnChecked;
|
|
ckbReverse.CheckedState = CheckState.UnChecked;
|
|
}
|
|
};
|
|
|
|
ckbReverse.CheckedStateChanging += (s, e) => { spinner.SpinReverse = e.Result == CheckState.Checked; };
|
|
|
|
ckbBounce.CheckedStateChanging += (s, e) => { spinner.SpinBounce = e.Result == CheckState.Checked; };
|
|
|
|
app.Unloaded += App_Unloaded;
|
|
|
|
void SetCustom ()
|
|
{
|
|
if (customField.Text.Length > 0)
|
|
{
|
|
spinner.Visible = true;
|
|
|
|
if (ushort.TryParse (delayField.Text, out ushort d))
|
|
{
|
|
spinner.SpinDelay = d;
|
|
}
|
|
else
|
|
{
|
|
delayField.Text = DEFAULT_DELAY.ToString ();
|
|
spinner.SpinDelay = DEFAULT_DELAY;
|
|
}
|
|
|
|
List<string> str = new ();
|
|
|
|
foreach (char c in customField.Text)
|
|
{
|
|
str.Add (c.ToString ());
|
|
}
|
|
|
|
spinner.Sequence = str.ToArray ();
|
|
}
|
|
else
|
|
{
|
|
spinner.Visible = false;
|
|
}
|
|
}
|
|
|
|
void App_Unloaded (object sender, EventArgs args)
|
|
{
|
|
if (spinner is {})
|
|
{
|
|
spinner.Dispose ();
|
|
spinner = null;
|
|
}
|
|
}
|
|
|
|
Application.Run (app);
|
|
app.Unloaded -= App_Unloaded;
|
|
if (spinner is { })
|
|
{
|
|
spinner.Dispose ();
|
|
spinner = null;
|
|
}
|
|
app.Dispose ();
|
|
|
|
Application.Shutdown ();
|
|
}
|
|
}
|