Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 15:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Cleans up/Refactors View.Subviews (#3962)

Browse Source 
* Subview clean up

* New Add/Remove event pattern

* Using Logging

* cleanup

* Subview -> SubView

* Test code cleanup. Killed many warnings.

* Fix tznind feedback

* Refactored AllViewTest helpers

* Moved keyboard tests to parallel

* Moved mouse tests to parallel

* Moved view tests to parallel

* Test code cleanup. Killed many warnings.

* dupe test

* Some mouse tests can't run in parallel because MouseGrabView

* Made SpinnerView more testable

* Moved more tests

* SubViews to IReadOnlyCollection<View>

* SubViews to IReadOnlyCollection<View> 2

* scrollbar tests

* shortcut tests

* Use InternalSubViews vs. _subviews

* Nuked View.IsAdded.
Added View.SuperViewChanged.

* API doc updats

* Unit Test tweak

* Unit Test tweak
This commit is contained in:
Tig
2025-03-08 15:42:17 -07:00
committed by GitHub
parent 85cf6619ed
commit acb5979e6c
226 changed files with 7235 additions and 7188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

455
Tests/UnitTests/Views/ShortcutTests.cs
View File

@@ -6,442 +6,6 @@ namespace Terminal.Gui.ViewsTests;
[TestSubject (typeof (Shortcut))]
public class ShortcutTests
{
[Fact]
public void Constructor_Defaults ()
{
var shortcut = new Shortcut ();
Assert.NotNull (shortcut);
Assert.True (shortcut.CanFocus);
Assert.IsType<DimAuto> (shortcut.Width);
Assert.IsType<DimAuto> (shortcut.Height);
}
[Fact]
public void Size_Defaults ()
{
var shortcut = new Shortcut ();
shortcut.Layout ();
Assert.Equal (2, shortcut.Frame.Width);
Assert.Equal (1, shortcut.Frame.Height);
Assert.Equal (2, shortcut.Viewport.Width);
Assert.Equal (1, shortcut.Viewport.Height);
Assert.Equal (0, shortcut.CommandView.Viewport.Width);
Assert.Equal (1, shortcut.CommandView.Viewport.Height);
Assert.Equal (0, shortcut.HelpView.Viewport.Width);
Assert.Equal (0, shortcut.HelpView.Viewport.Height);
Assert.Equal (0, shortcut.KeyView.Viewport.Width);
Assert.Equal (0, shortcut.KeyView.Viewport.Height);
// 0123456789
// " 0 A "
shortcut = new ()
{
Key = Key.A,
HelpText = "0"
};
shortcut.Layout ();
Assert.Equal (8, shortcut.Frame.Width);
Assert.Equal (1, shortcut.Frame.Height);
Assert.Equal (8, shortcut.Viewport.Width);
Assert.Equal (1, shortcut.Viewport.Height);
Assert.Equal (0, shortcut.CommandView.Viewport.Width);
Assert.Equal (1, shortcut.CommandView.Viewport.Height);
Assert.Equal (1, shortcut.HelpView.Viewport.Width);
Assert.Equal (1, shortcut.HelpView.Viewport.Height);
Assert.Equal (1, shortcut.KeyView.Viewport.Width);
Assert.Equal (1, shortcut.KeyView.Viewport.Height);
// 0123456789
// " C 0 A "
shortcut = new ()
{
Title = "C",
Key = Key.A,
HelpText = "0"
};
shortcut.Layout ();
Assert.Equal (9, shortcut.Frame.Width);
Assert.Equal (1, shortcut.Frame.Height);
Assert.Equal (9, shortcut.Viewport.Width);
Assert.Equal (1, shortcut.Viewport.Height);
Assert.Equal (1, shortcut.CommandView.Viewport.Width);
Assert.Equal (1, shortcut.CommandView.Viewport.Height);
Assert.Equal (1, shortcut.HelpView.Viewport.Width);
Assert.Equal (1, shortcut.HelpView.Viewport.Height);
Assert.Equal (1, shortcut.KeyView.Viewport.Width);
Assert.Equal (1, shortcut.KeyView.Viewport.Height);
}
[Theory]
[InlineData ("", "", KeyCode.Null, 2)]
[InlineData ("C", "", KeyCode.Null, 3)]
[InlineData ("", "H", KeyCode.Null, 5)]
[InlineData ("", "", KeyCode.K, 5)]
[InlineData ("C", "", KeyCode.K, 6)]
[InlineData ("C", "H", KeyCode.Null, 6)]
[InlineData ("", "H", KeyCode.K, 8)]
[InlineData ("C", "H", KeyCode.K, 9)]
public void NaturalSize (string command, string help, KeyCode key, int expectedWidth)
{
var shortcut = new Shortcut
{
HelpText = help,
Key = key,
Title = command,
};
shortcut.Layout ();
// |0123456789
// | C H K |
Assert.Equal (expectedWidth, shortcut.Frame.Width);
shortcut = new Shortcut
{
HelpText = help,
Title = command,
Key = key
};
shortcut.Layout ();
Assert.Equal (expectedWidth, shortcut.Frame.Width);
shortcut = new Shortcut
{
HelpText = help,
Key = key,
Title = command,
};
shortcut.Layout ();
Assert.Equal (expectedWidth, shortcut.Frame.Width);
shortcut = new Shortcut
{
Key = key,
HelpText = help,
Title = command,
};
shortcut.Layout ();
Assert.Equal (expectedWidth, shortcut.Frame.Width);
}
[Theory]
[InlineData (0, 0, 3, 3)]
[InlineData (1, 0, 3, 3)]
[InlineData (2, 0, 3, 3)]
[InlineData (3, 0, 3, 3)]
[InlineData (4, 0, 3, 3)]
[InlineData (5, 0, 3, 3)]
[InlineData (6, 0, 3, 3)]
[InlineData (7, 0, 3, 4)]
[InlineData (8, 0, 3, 5)]
[InlineData (9, 0, 3, 6)]
[InlineData (10, 0, 4, 7)]
[InlineData (11, 0, 5, 8)]
public void Set_Width_Layouts_Correctly (int width, int expectedCmdX, int expectedHelpX, int expectedKeyX)
{
var shortcut = new Shortcut
{
Width = width,
Title = "C",
Text = "H",
Key = Key.K
};
shortcut.Layout ();
// 01234
// -C--K
// 012345
// -C--K-
// 0123456
// -C-H-K-
// 01234567
// -C--H-K-
// 012345678
// -C--H--K-
// 0123456789
// -C--H--K-
Assert.Equal (expectedCmdX, shortcut.CommandView.Frame.X);
Assert.Equal (expectedHelpX, shortcut.HelpView.Frame.X);
Assert.Equal (expectedKeyX, shortcut.KeyView.Frame.X);
}
[Fact]
public void CommandView_Text_And_Title_Track ()
{
var shortcut = new Shortcut
{
Title = "T"
};
Assert.Equal (shortcut.Title, shortcut.CommandView.Text);
shortcut = new ();
shortcut.CommandView = new ()
{
Text = "T"
};
Assert.Equal (shortcut.Title, shortcut.CommandView.Text);
}
[Fact]
public void HelpText_And_Text_Are_The_Same ()
{
var shortcut = new Shortcut
{
Text = "H"
};
Assert.Equal (shortcut.Text, shortcut.HelpText);
shortcut = new ()
{
HelpText = "H"
};
Assert.Equal (shortcut.Text, shortcut.HelpText);
}
[Theory]
[InlineData (KeyCode.Null, "")]
[InlineData (KeyCode.F1, "F1")]
public void KeyView_Text_Tracks_Key (KeyCode key, string expected)
{
var shortcut = new Shortcut
{
Key = key
};
Assert.Equal (expected, shortcut.KeyView.Text);
}
// Test Key
[Fact]
public void Key_Defaults_To_Empty ()
{
var shortcut = new Shortcut ();
Assert.Equal (Key.Empty, shortcut.Key);
}
[Fact]
public void Key_Can_Be_Set ()
{
var shortcut = new Shortcut ();
shortcut.Key = Key.F1;
Assert.Equal (Key.F1, shortcut.Key);
}
[Fact]
public void Key_Can_Be_Set_To_Empty ()
{
var shortcut = new Shortcut ();
shortcut.Key = Key.Empty;
Assert.Equal (Key.Empty, shortcut.Key);
}
[Fact]
public void Key_Set_Binds_Key_To_CommandView_Accept ()
{
var shortcut = new Shortcut ();
shortcut.Key = Key.F1;
// TODO:
}
[Fact]
public void Key_Changing_Removes_Previous_Binding ()
{
var shortcut = new Shortcut ();
shortcut.Key = Key.A;
Assert.True (shortcut.HotKeyBindings.TryGet (Key.A, out _));
shortcut.Key = Key.B;
Assert.False (shortcut.HotKeyBindings.TryGet (Key.A, out _));
Assert.True (shortcut.HotKeyBindings.TryGet (Key.B, out _));
}
// Test Key gets bound correctly
[Fact]
public void BindKeyToApplication_Defaults_To_HotKey ()
{
var shortcut = new Shortcut ();
Assert.False (shortcut.BindKeyToApplication);
}
[Fact]
public void BindKeyToApplication_Can_Be_Set ()
{
var shortcut = new Shortcut ();
shortcut.BindKeyToApplication = true;
Assert.True (shortcut.BindKeyToApplication);
}
[Fact]
public void BindKeyToApplication_Changing_Adjusts_KeyBindings ()
{
var shortcut = new Shortcut ();
shortcut.Key = Key.A;
Assert.True (shortcut.HotKeyBindings.TryGet (Key.A, out _));
shortcut.BindKeyToApplication = true;
Assert.False (shortcut.HotKeyBindings.TryGet (Key.A, out _));
Assert.True (Application.KeyBindings.TryGet (Key.A, out _));
shortcut.BindKeyToApplication = false;
Assert.True (shortcut.HotKeyBindings.TryGet (Key.A, out _));
Assert.False (Application.KeyBindings.TryGet (Key.A, out _));
}
[Theory]
[InlineData (Orientation.Horizontal)]
[InlineData (Orientation.Vertical)]
public void Orientation_SetsCorrectly (Orientation orientation)
{
var shortcut = new Shortcut
{
Orientation = orientation
};
Assert.Equal (orientation, shortcut.Orientation);
}
[Theory]
[InlineData (AlignmentModes.StartToEnd)]
[InlineData (AlignmentModes.EndToStart)]
public void AlignmentModes_SetsCorrectly (AlignmentModes alignmentModes)
{
var shortcut = new Shortcut
{
AlignmentModes = alignmentModes
};
Assert.Equal (alignmentModes, shortcut.AlignmentModes);
}
[Fact]
public void Action_SetsAndGetsCorrectly ()
{
var actionInvoked = false;
var shortcut = new Shortcut
{
Action = () => { actionInvoked = true; }
};
shortcut.Action.Invoke ();
Assert.True (actionInvoked);
}
[Fact]
public void Subview_Visibility_Controlled_By_Removal ()
{
var shortcut = new Shortcut ();
Assert.True (shortcut.CommandView.Visible);
Assert.Contains (shortcut.CommandView, shortcut.Subviews);
Assert.True (shortcut.HelpView.Visible);
Assert.DoesNotContain (shortcut.HelpView, shortcut.Subviews);
Assert.True (shortcut.KeyView.Visible);
Assert.DoesNotContain (shortcut.KeyView, shortcut.Subviews);
shortcut.HelpText = "help";
Assert.True (shortcut.HelpView.Visible);
Assert.Contains (shortcut.HelpView, shortcut.Subviews);
Assert.True (shortcut.KeyView.Visible);
Assert.DoesNotContain (shortcut.KeyView, shortcut.Subviews);
shortcut.Key = Key.A;
Assert.True (shortcut.HelpView.Visible);
Assert.Contains (shortcut.HelpView, shortcut.Subviews);
Assert.True (shortcut.KeyView.Visible);
Assert.Contains (shortcut.KeyView, shortcut.Subviews);
shortcut.HelpView.Visible = false;
shortcut.ShowHide ();
Assert.False (shortcut.HelpView.Visible);
Assert.DoesNotContain (shortcut.HelpView, shortcut.Subviews);
Assert.True (shortcut.KeyView.Visible);
Assert.Contains (shortcut.KeyView, shortcut.Subviews);
shortcut.KeyView.Visible = false;
shortcut.ShowHide ();
Assert.False (shortcut.HelpView.Visible);
Assert.DoesNotContain (shortcut.HelpView, shortcut.Subviews);
Assert.False (shortcut.KeyView.Visible);
Assert.DoesNotContain (shortcut.KeyView, shortcut.Subviews);
}
[Fact]
public void Focus_CanFocus_Default_Is_True ()
{
Shortcut shortcut = new ();
shortcut.Key = Key.A;
shortcut.Text = "Help";
shortcut.Title = "Command";
Assert.True (shortcut.CanFocus);
Assert.False (shortcut.CommandView.CanFocus);
}
[Fact]
public void Focus_CanFocus_CommandView_Add_Tracks ()
{
Shortcut shortcut = new ();
Assert.True (shortcut.CanFocus);
Assert.False (shortcut.CommandView.CanFocus);
shortcut.CommandView = new () { CanFocus = true };
Assert.False (shortcut.CommandView.CanFocus);
shortcut.CommandView.CanFocus = true;
Assert.True (shortcut.CommandView.CanFocus);
shortcut.CanFocus = false;
Assert.False (shortcut.CanFocus);
Assert.True (shortcut.CommandView.CanFocus);
shortcut.CommandView.CanFocus = false;
Assert.False (shortcut.CanFocus);
Assert.False (shortcut.CommandView.CanFocus);
shortcut.CommandView.CanFocus = true;
Assert.False (shortcut.CanFocus);
Assert.True (shortcut.CommandView.CanFocus);
}
[Theory]
// 0123456789
@@ -531,7 +95,7 @@ public class ShortcutTests
Application.Top.Add (shortcut);
Application.Top.SetRelativeLayout (new (100, 100));
Application.Top.LayoutSubviews ();
Application.Top.LayoutSubViews ();
Application.RaiseMouseEvent (
new ()
@@ -585,7 +149,7 @@ public class ShortcutTests
shortcut.CommandView.Accepting += (s, e) => { buttonAccepted++; };
Application.Top.Add (shortcut);
Application.Top.SetRelativeLayout (new (100, 100));
Application.Top.LayoutSubviews ();
Application.Top.LayoutSubViews ();
var accepted = 0;
shortcut.Accepting += (s, e) => { accepted++; };
@@ -650,7 +214,7 @@ public class ShortcutTests
Application.Top.Add (shortcut);
Application.Top.SetRelativeLayout (new (100, 100));
Application.Top.LayoutSubviews ();
Application.Top.LayoutSubViews ();
var selected = 0;
shortcut.Selecting += (s, e) =>
@@ -888,19 +452,6 @@ public class ShortcutTests
Application.ResetState (true);
}
[Fact]
public void ColorScheme_SetsAndGetsCorrectly ()
{
var colorScheme = new ColorScheme ();
var shortcut = new Shortcut
{
ColorScheme = colorScheme
};
Assert.Same (colorScheme, shortcut.ColorScheme);
}
// https://github.com/gui-cs/Terminal.Gui/issues/3664
[Fact]
public void ColorScheme_SetColorScheme_Does_Not_Fault_3664 ()