Files
Terminal.Gui/UnitTests/View/Navigation/CanFocusTests.cs
2024-08-23 14:09:44 -06:00

653 lines
20 KiB
C#

using Xunit.Abstractions;
namespace Terminal.Gui.ViewTests;
public class CanFocusTests (ITestOutputHelper _output) : TestsAllViews
{
[Fact]
public void CanFocus_False_Prevents_SubSubView_HasFocus ()
{
var view = new View { };
var subView = new View { };
var subSubView = new View { CanFocus = true };
subView.Add (subSubView);
view.Add (subView);
Assert.False (view.CanFocus);
Assert.False (subView.CanFocus);
Assert.True (subSubView.CanFocus);
view.SetFocus ();
Assert.False (view.HasFocus);
subView.SetFocus ();
Assert.False (subView.HasFocus);
subSubView.SetFocus ();
Assert.False (subSubView.HasFocus);
}
[Fact]
public void CanFocus_False_Prevents_SubView_HasFocus ()
{
var view = new View { };
var subView = new View { CanFocus = true };
var subSubView = new View { };
subView.Add (subSubView);
view.Add (subView);
Assert.False (view.CanFocus);
Assert.True (subView.CanFocus);
Assert.False (subSubView.CanFocus);
view.SetFocus ();
Assert.False (view.HasFocus);
subView.SetFocus ();
Assert.False (subView.HasFocus);
subSubView.SetFocus ();
Assert.False (subSubView.HasFocus);
}
[Fact]
public void CanFocus_Set_True_No_SuperView_Doesnt_Set_HasFocus ()
{
var view = new View { };
// Act
view.CanFocus = true;
Assert.False (view.HasFocus);
}
[Fact]
public void CanFocus_Set_True_Sets_HasFocus_To_True ()
{
var view = new View { };
var subView = new View { };
view.Add (subView);
Assert.False (view.CanFocus);
Assert.False (subView.CanFocus);
view.SetFocus ();
Assert.False (view.HasFocus);
Assert.False (subView.HasFocus);
view.CanFocus = true;
view.SetFocus ();
Assert.True (view.HasFocus);
// Act
subView.CanFocus = true;
Assert.True (subView.HasFocus);
}
[Fact]
public void CanFocus_Set_SubView_True_Sets_HasFocus_To_True ()
{
var view = new View
{
CanFocus = true
};
var subView = new View
{
CanFocus = false
};
var subSubView = new View
{
CanFocus = true
};
subView.Add (subSubView);
view.Add (subView);
view.SetFocus ();
Assert.True (view.HasFocus);
Assert.False (subView.HasFocus);
Assert.False (subSubView.HasFocus);
// Act
subView.CanFocus = true;
Assert.True (subView.HasFocus);
Assert.True (subSubView.HasFocus);
}
[Fact]
public void CanFocus_Set_SubView_True_Does_Not_Change_Focus_If_SuperView_Focused_Is_True ()
{
var top = new View
{
Id = "top",
CanFocus = true
};
var subView = new View
{
Id = "subView",
CanFocus = true
};
var subSubView = new View
{
Id = "subSubView",
CanFocus = true
};
subView.Add (subSubView);
var subView2 = new View
{
Id = "subView2",
CanFocus = false
};
top.Add (subView, subView2);
top.SetFocus ();
Assert.True (top.HasFocus);
Assert.Equal (subView, top.Focused);
Assert.True (subView.HasFocus);
Assert.True (subSubView.HasFocus);
// Act
subView2.CanFocus = true;
Assert.False (subView2.HasFocus);
Assert.True (subView.HasFocus);
Assert.True (subSubView.HasFocus);
}
[Fact]
public void CanFocus_Set_False_Sets_HasFocus_To_False ()
{
var view = new View { CanFocus = true };
var view2 = new View { CanFocus = true };
view2.Add (view);
Assert.True (view.CanFocus);
view.SetFocus ();
Assert.True (view.HasFocus);
view.CanFocus = false;
Assert.False (view.CanFocus);
Assert.False (view.HasFocus);
}
// TODO: Figure out what this test is supposed to be testing
[Fact]
public void CanFocus_Faced_With_Container ()
{
var t = new Toplevel ();
var w = new Window ();
var f = new FrameView ();
var v = new View { CanFocus = true };
f.Add (v);
w.Add (f);
t.Add (w);
Assert.True (t.CanFocus);
Assert.True (w.CanFocus);
Assert.True (f.CanFocus);
Assert.True (v.CanFocus);
f.CanFocus = false;
Assert.False (f.CanFocus);
Assert.True (v.CanFocus);
v.CanFocus = false;
Assert.False (f.CanFocus);
Assert.False (v.CanFocus);
v.CanFocus = true;
Assert.False (f.CanFocus);
Assert.True (v.CanFocus);
}
// TODO: Figure out what this test is supposed to be testing
[Fact]
public void CanFocus_Faced_With_Container_Before_Run ()
{
Application.Init (new FakeDriver ());
Toplevel t = new ();
var w = new Window ();
var f = new FrameView ();
var v = new View { CanFocus = true };
f.Add (v);
w.Add (f);
t.Add (w);
Assert.True (t.CanFocus);
Assert.True (w.CanFocus);
Assert.True (f.CanFocus);
Assert.True (v.CanFocus);
f.CanFocus = false;
Assert.False (f.CanFocus);
Assert.True (v.CanFocus);
v.CanFocus = false;
Assert.False (f.CanFocus);
Assert.False (v.CanFocus);
v.CanFocus = true;
Assert.False (f.CanFocus);
Assert.True (v.CanFocus);
Application.Iteration += (s, a) => Application.RequestStop ();
Application.Run (t);
t.Dispose ();
Application.Shutdown ();
}
[Fact]
public void CanFocus_Set_Changes_TabIndex_And_TabStop ()
{
var r = new View ();
var v1 = new View { Text = "1" };
var v2 = new View { Text = "2" };
var v3 = new View { Text = "3" };
r.Add (v1, v2, v3);
v2.CanFocus = true;
Assert.Equal (r.TabIndexes.IndexOf (v2), v2.TabIndex);
Assert.Equal (0, v2.TabIndex);
Assert.Equal (TabBehavior.TabStop, v2.TabStop);
v1.CanFocus = true;
Assert.Equal (r.TabIndexes.IndexOf (v1), v1.TabIndex);
Assert.Equal (1, v1.TabIndex);
Assert.Equal (TabBehavior.TabStop, v1.TabStop);
v1.TabIndex = 2;
Assert.Equal (r.TabIndexes.IndexOf (v1), v1.TabIndex);
Assert.Equal (1, v1.TabIndex);
v3.CanFocus = true;
Assert.Equal (r.TabIndexes.IndexOf (v1), v1.TabIndex);
Assert.Equal (1, v1.TabIndex);
Assert.Equal (r.TabIndexes.IndexOf (v3), v3.TabIndex);
Assert.Equal (2, v3.TabIndex);
Assert.Equal (TabBehavior.TabStop, v3.TabStop);
v2.CanFocus = false;
Assert.Equal (r.TabIndexes.IndexOf (v1), v1.TabIndex);
Assert.Equal (1, v1.TabIndex);
Assert.Equal (TabBehavior.TabStop, v1.TabStop);
Assert.Equal (r.TabIndexes.IndexOf (v2), v2.TabIndex); // TabIndex is not changed
Assert.NotEqual (-1, v2.TabIndex);
Assert.Equal (TabBehavior.TabStop, v2.TabStop); // TabStop is not changed
Assert.Equal (r.TabIndexes.IndexOf (v3), v3.TabIndex);
Assert.Equal (2, v3.TabIndex);
Assert.Equal (TabBehavior.TabStop, v3.TabStop);
r.Dispose ();
}
[Fact]
public void CanFocus_True_Focuses ()
{
View view = new ()
{
Id = "view"
};
View superView = new ()
{
Id = "superView",
CanFocus = true
};
superView.Add (view);
superView.SetFocus ();
Assert.True (superView.HasFocus);
Assert.NotEqual (view, superView.Focused);
view.CanFocus = true;
Assert.True (superView.HasFocus);
Assert.Equal (view, superView.Focused);
Assert.True (view.HasFocus);
view.CanFocus = false;
Assert.True (superView.HasFocus);
Assert.NotEqual (view, superView.Focused);
Assert.False (view.HasFocus);
}
[Fact]
public void CanFocus_Set_True_Get_AdvanceFocus_Works ()
{
Label label = new () { Text = "label" };
View view = new () { Text = "view", CanFocus = true };
Application.Current = new ();
Application.Current.Add (label, view);
Application.Current.SetFocus ();
Assert.Equal (view, Application.Current.MostFocused);
Assert.False (label.CanFocus);
Assert.False (label.HasFocus);
Assert.True (view.CanFocus);
Assert.True (view.HasFocus);
Assert.False (Application.Current.AdvanceFocus (NavigationDirection.Forward, null));
Assert.False (label.HasFocus);
Assert.True (view.HasFocus);
// Set label CanFocus to true
label.CanFocus = true;
Assert.False (label.HasFocus);
Assert.True (view.HasFocus);
// label can now be focused, so AdvanceFocus should move to it.
Assert.True (Application.Current.AdvanceFocus (NavigationDirection.Forward, null));
Assert.True (label.HasFocus);
Assert.False (view.HasFocus);
// Move back to view
view.SetFocus ();
Assert.False (label.HasFocus);
Assert.True (view.HasFocus);
Assert.True (Application.OnKeyDown (Key.Tab));
Assert.True (label.HasFocus);
Assert.False (view.HasFocus);
Application.Current.Dispose ();
Application.ResetState ();
}
#if V2_NEW_FOCUS_IMPL // Bogus test - depends on auto CanFocus behavior
[Fact]
public void CanFocus_Container_ToFalse_Turns_All_Subviews_ToFalse_Too ()
{
Application.Init (new FakeDriver ());
Toplevel t = new ();
var w = new Window ();
var f = new FrameView ();
var v1 = new View { CanFocus = true };
var v2 = new View { CanFocus = true };
f.Add (v1, v2);
w.Add (f);
t.Add (w);
t.Ready += (s, e) =>
{
Assert.True (t.CanFocus);
Assert.True (w.CanFocus);
Assert.True (f.CanFocus);
Assert.True (v1.CanFocus);
Assert.True (v2.CanFocus);
w.CanFocus = false;
Assert.False (w.CanFocus);
Assert.False (f.CanFocus);
Assert.False (v1.CanFocus);
Assert.False (v2.CanFocus);
};
Application.Iteration += (s, a) => Application.RequestStop ();
Application.Run (t);
t.Dispose ();
Application.Shutdown ();
}
#endif
#if V2_NEW_FOCUS_IMPL // Bogus test - depends on auto CanFocus behavior
[Fact]
public void CanFocus_Container_Toggling_All_Subviews_To_Old_Value_When_Is_True ()
{
Application.Init (new FakeDriver ());
Toplevel t = new ();
var w = new Window ();
var f = new FrameView ();
var v1 = new View ();
var v2 = new View { CanFocus = true };
f.Add (v1, v2);
w.Add (f);
t.Add (w);
t.Ready += (s, e) =>
{
Assert.True (t.CanFocus);
Assert.True (w.CanFocus);
Assert.True (f.CanFocus);
Assert.False (v1.CanFocus);
Assert.True (v2.CanFocus);
w.CanFocus = false;
Assert.False (w.CanFocus);
Assert.False (f.CanFocus);
Assert.False (v1.CanFocus);
Assert.False (v2.CanFocus);
w.CanFocus = true;
Assert.True (w.CanFocus);
Assert.True (f.CanFocus);
Assert.False (v1.CanFocus);
Assert.True (v2.CanFocus);
};
Application.Iteration += (s, a) => Application.RequestStop ();
Application.Run (t);
t.Dispose ();
Application.Shutdown ();
}
#endif
#if V2_NEW_FOCUS_IMPL // Bogus test - depends on auto CanFocus behavior
[Fact]
public void CanFocus_Faced_With_Container_After_Run ()
{
Application.Init (new FakeDriver ());
Toplevel t = new ();
var w = new Window ();
var f = new FrameView ();
var v = new View { CanFocus = true };
f.Add (v);
w.Add (f);
t.Add (w);
t.Ready += (s, e) =>
{
Assert.True (t.CanFocus);
Assert.True (w.CanFocus);
Assert.True (f.CanFocus);
Assert.True (v.CanFocus);
f.CanFocus = false;
Assert.False (f.CanFocus);
Assert.False (v.CanFocus);
v.CanFocus = false;
Assert.False (f.CanFocus);
Assert.False (v.CanFocus);
Assert.Throws<InvalidOperationException> (() => v.CanFocus = true);
Assert.False (f.CanFocus);
Assert.False (v.CanFocus);
f.CanFocus = true;
Assert.True (f.CanFocus);
Assert.True (v.CanFocus);
};
Application.Iteration += (s, a) => Application.RequestStop ();
Application.Run (t);
t.Dispose ();
Application.Shutdown ();
}
#endif
#if V2_NEW_FOCUS_IMPL
[Fact]
[AutoInitShutdown]
public void CanFocus_Sets_To_False_On_Single_View_Focus_View_On_Another_Toplevel ()
{
var view1 = new View { Id = "view1", Width = 10, Height = 1, CanFocus = true };
var win1 = new Window { Id = "win1", Width = Dim.Percent (50), Height = Dim.Fill () };
win1.Add (view1);
var view2 = new View { Id = "view2", Width = 20, Height = 2, CanFocus = true };
var win2 = new Window { Id = "win2", X = Pos.Right (win1), Width = Dim.Fill (), Height = Dim.Fill () };
win2.Add (view2);
var top = new Toplevel ();
top.Add (win1, win2);
Application.Begin (top);
Assert.True (view1.CanFocus);
Assert.True (view1.HasFocus);
Assert.True (view2.CanFocus);
Assert.False (view2.HasFocus); // Only one of the most focused toplevels view can have focus
Assert.True (Application.OnKeyDown (Key.F6));
Assert.True (view1.CanFocus);
Assert.False (view1.HasFocus); // Only one of the most focused toplevels view can have focus
Assert.True (view2.CanFocus);
Assert.True (view2.HasFocus);
Assert.True (Application.OnKeyDown (Key.F6));
Assert.True (view1.CanFocus);
Assert.True (view1.HasFocus);
Assert.True (view2.CanFocus);
Assert.False (view2.HasFocus); // Only one of the most focused toplevels view can have focus
view1.CanFocus = false;
Assert.False (view1.CanFocus);
Assert.False (view1.HasFocus);
Assert.True (view2.CanFocus);
Assert.True (view2.HasFocus);
Assert.Equal (win2, Application.Current.GetFocused ());
Assert.Equal (view2, Application.Current.GetMostFocused ());
top.Dispose ();
}
[Fact]
[AutoInitShutdown]
public void CanFocus_Sets_To_False_On_Toplevel_Focus_View_On_Another_Toplevel ()
{
var view1 = new View { Id = "view1", Width = 10, Height = 1, CanFocus = true };
var win1 = new Window { Id = "win1", Width = Dim.Percent (50), Height = Dim.Fill () };
win1.Add (view1);
var view2 = new View { Id = "view2", Width = 20, Height = 2, CanFocus = true };
var win2 = new Window { Id = "win2", X = Pos.Right (win1), Width = Dim.Fill (), Height = Dim.Fill () };
win2.Add (view2);
var top = new Toplevel ();
top.Add (win1, win2);
Application.Begin (top);
Assert.True (view1.CanFocus);
Assert.True (view1.HasFocus);
Assert.True (view2.CanFocus);
Assert.False (view2.HasFocus); // Only one of the most focused toplevels view can have focus
Assert.True (Application.OnKeyDown (Key.F6));
Assert.True (view1.CanFocus);
Assert.False (view1.HasFocus); // Only one of the most focused toplevels view can have focus
Assert.True (view2.CanFocus);
Assert.True (view2.HasFocus);
Assert.True (Application.OnKeyDown (Key.F6));
Assert.True (view1.CanFocus);
Assert.True (view1.HasFocus);
Assert.True (view2.CanFocus);
Assert.False (view2.HasFocus); // Only one of the most focused toplevels view can have focus
win1.CanFocus = false;
Assert.False (view1.CanFocus);
Assert.False (view1.HasFocus);
Assert.False (win1.CanFocus);
Assert.False (win1.HasFocus);
Assert.True (view2.CanFocus);
Assert.True (view2.HasFocus);
Assert.Equal (win2, Application.Current.GetFocused ());
Assert.Equal (view2, Application.Current.GetMostFocused ());
top.Dispose ();
}
[Fact]
[AutoInitShutdown]
public void CanFocus_Sets_To_False_With_Two_Views_Focus_Another_View_On_The_Same_Toplevel ()
{
var view1 = new View { Id = "view1", Width = 10, Height = 1, CanFocus = true };
var view12 = new View
{
Id = "view12",
Y = 5,
Width = 10,
Height = 1,
CanFocus = true
};
var win1 = new Window { Id = "win1", Width = Dim.Percent (50), Height = Dim.Fill () };
win1.Add (view1, view12);
var view2 = new View { Id = "view2", Width = 20, Height = 2, CanFocus = true };
var win2 = new Window { Id = "win2", X = Pos.Right (win1), Width = Dim.Fill (), Height = Dim.Fill () };
win2.Add (view2);
var top = new Toplevel ();
top.Add (win1, win2);
Application.Begin (top);
Assert.True (view1.CanFocus);
Assert.True (view1.HasFocus);
Assert.True (view2.CanFocus);
Assert.False (view2.HasFocus); // Only one of the most focused toplevels view can have focus
Assert.True (Application.OnKeyDown (Key.F6)); // move to win2
Assert.True (view1.CanFocus);
Assert.False (view1.HasFocus); // Only one of the most focused toplevels view can have focus
Assert.True (view2.CanFocus);
Assert.True (view2.HasFocus);
Assert.True (Application.OnKeyDown (Key.F6));
Assert.True (view1.CanFocus);
Assert.True (view1.HasFocus);
Assert.True (view2.CanFocus);
Assert.False (view2.HasFocus); // Only one of the most focused toplevels view can have focus
view1.CanFocus = false;
Assert.False (view1.CanFocus);
Assert.False (view1.HasFocus);
Assert.True (view2.CanFocus);
Assert.False (view2.HasFocus);
Assert.Equal (win1, Application.Current.GetFocused ());
Assert.Equal (view12, Application.Current.GetMostFocused ());
top.Dispose ();
}
#endif
[Fact (Skip = "Causes crash on Ubuntu in Github Action. Bogus test anyway.")]
public void WindowDispose_CanFocusProblem ()
{
// Arrange
Application.Init ();
using var top = new Toplevel ();
using var view = new View { X = 0, Y = 1, Text = nameof (WindowDispose_CanFocusProblem) };
using var window = new Window ();
top.Add (window);
window.Add (view);
// Act
RunState rs = Application.Begin (top);
Application.End (rs);
top.Dispose ();
Application.Shutdown ();
// Assert does Not throw NullReferenceException
top.SetFocus ();
}
}