Merge with develop

2026-01-01 16:59:35 +01:00 · 2022-11-02 16:59:39 -06:00
parent b06e4229c4 1ad55909bc
commit 86a7b0764c
17 changed files with 1202 additions and 341 deletions
--- a/UnitTests/CollectionNavigatorTests.cs
+++ b/UnitTests/CollectionNavigatorTests.cs
@@ -0,0 +1,370 @@
+using System;
+using System.Threading;
+using Xunit;
+
+namespace Terminal.Gui.Core {
+	public class CollectionNavigatorTests {
+		static string [] simpleStrings = new string []{
+		    "appricot", // 0
+		    "arm",      // 1
+		    "bat",      // 2
+		    "batman",   // 3
+		    "candle"    // 4
+		  };
+
+		[Fact]
+		public void ShouldAcceptNegativeOne ()
+		{
+			var n = new CollectionNavigator (simpleStrings);
+
+			// Expect that index of -1 (i.e. no selection) should work correctly
+			// and select the first entry of the letter 'b'
+			Assert.Equal (2, n.GetNextMatchingItem (-1, 'b'));
+		}
+		[Fact]
+		public void OutOfBoundsShouldBeIgnored ()
+		{
+			var n = new CollectionNavigator (simpleStrings);
+
+			// Expect saying that index 500 is the current selection should not cause
+			// error and just be ignored (treated as no selection)
+			Assert.Equal (2, n.GetNextMatchingItem (500, 'b'));
+		}
+
+		[Fact]
+		public void Cycling ()
+		{
+			var n = new CollectionNavigator (simpleStrings);
+			Assert.Equal (2, n.GetNextMatchingItem (0, 'b'));
+			Assert.Equal (3, n.GetNextMatchingItem (2, 'b'));
+
+			// if 4 (candle) is selected it should loop back to bat
+			Assert.Equal (2, n.GetNextMatchingItem (4, 'b'));
+		}
+
+		[Fact]
+		public void FullText ()
+		{
+			var strings = new string []{
+			    "appricot",
+			    "arm",
+			    "ta",
+			    "target",
+			    "text",
+			    "egg",
+			    "candle"
+			  };
+
+			var n = new CollectionNavigator (strings);
+			int current = 0;
+			Assert.Equal (strings.IndexOf ("ta"), current = n.GetNextMatchingItem (current, 't'));
+
+			// should match "te" in "text"
+			Assert.Equal (strings.IndexOf ("text"), current = n.GetNextMatchingItem (current, 'e'));
+
+			// still matches text
+			Assert.Equal (strings.IndexOf ("text"), current = n.GetNextMatchingItem (current, 'x'));
+
+			// nothing starts texa so it should NOT jump to appricot
+			Assert.Equal (strings.IndexOf ("text"), current = n.GetNextMatchingItem (current, 'a'));
+
+			Thread.Sleep (n.TypingDelay + 100);
+			// nothing starts "texa". Since were past timedelay we DO jump to appricot
+			Assert.Equal (strings.IndexOf ("appricot"), current = n.GetNextMatchingItem (current, 'a'));
+		}
+
+		[Fact]
+		public void Unicode ()
+		{
+			var strings = new string []{
+			    "appricot",
+			    "arm",
+			    "ta",
+			    "丗丙业丞",
+			    "丗丙丛",
+			    "text",
+			    "egg",
+			    "candle"
+			  };
+
+			var n = new CollectionNavigator (strings);
+			int current = 0;
+			Assert.Equal (strings.IndexOf ("丗丙业丞"), current = n.GetNextMatchingItem (current, '丗'));
+
+			// 丗丙业丞 is as good a match as 丗丙丛
+			// so when doing multi character searches we should
+			// prefer to stay on the same index unless we invalidate
+			// our typed text
+			Assert.Equal (strings.IndexOf ("丗丙业丞"), current = n.GetNextMatchingItem (current, '丙'));
+
+			// No longer matches 丗丙业丞 and now only matches 丗丙丛
+			// so we should move to the new match
+			Assert.Equal (strings.IndexOf ("丗丙丛"), current = n.GetNextMatchingItem (current, '丛'));
+
+			// nothing starts "丗丙丛a". Since were still in the timedelay we do not jump to appricot
+			Assert.Equal (strings.IndexOf ("丗丙丛"), current = n.GetNextMatchingItem (current, 'a'));
+
+			Thread.Sleep (n.TypingDelay + 100);
+			// nothing starts "丗丙丛a". Since were past timedelay we DO jump to appricot
+			Assert.Equal (strings.IndexOf ("appricot"), current = n.GetNextMatchingItem (current, 'a'));
+		}
+
+		[Fact]
+		public void AtSymbol ()
+		{
+			var strings = new string []{
+			    "appricot",
+			    "arm",
+			    "ta",
+			    "@bob",
+			    "@bb",
+			    "text",
+			    "egg",
+			    "candle"
+			  };
+
+			var n = new CollectionNavigator (strings);
+			Assert.Equal (3, n.GetNextMatchingItem (0, '@'));
+			Assert.Equal (3, n.GetNextMatchingItem (3, 'b'));
+			Assert.Equal (4, n.GetNextMatchingItem (3, 'b'));
+		}
+
+		[Fact]
+		public void Word ()
+		{
+			var strings = new string []{
+			    "appricot",
+			    "arm",
+			    "bat",
+			    "batman",
+			    "bates hotel",
+			    "candle"
+			  };
+			int current = 0;
+			var n = new CollectionNavigator (strings);
+			Assert.Equal (strings.IndexOf ("bat"), current = n.GetNextMatchingItem (current, 'b')); // match bat
+			Assert.Equal (strings.IndexOf ("bat"), current = n.GetNextMatchingItem (current, 'a')); // match bat
+			Assert.Equal (strings.IndexOf ("bat"), current = n.GetNextMatchingItem (current, 't')); // match bat
+			Assert.Equal (strings.IndexOf ("bates hotel"), current = n.GetNextMatchingItem (current, 'e')); // match bates hotel
+			Assert.Equal (strings.IndexOf ("bates hotel"), current = n.GetNextMatchingItem (current, 's')); // match bates hotel
+			Assert.Equal (strings.IndexOf ("bates hotel"), current = n.GetNextMatchingItem (current, ' ')); // match bates hotel
+		}
+
+		[Fact]
+		public void Symbols ()
+		{
+			var strings = new string []{
+			    "$$",
+			    "$100.00",
+			    "$101.00",
+			    "$101.10",
+			    "$200.00",
+			    "appricot"
+			  };
+			int current = 0;
+			var n = new CollectionNavigator (strings);
+			Assert.Equal (strings.IndexOf ("appricot"), current = n.GetNextMatchingItem (current, 'a'));
+			Assert.Equal ("a", n.SearchString);
+
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, '$'));
+			Assert.Equal ("$", n.SearchString);
+
+			Assert.Equal (strings.IndexOf ("$100.00"), current = n.GetNextMatchingItem (current, '1'));
+			Assert.Equal ("$1", n.SearchString);
+
+			Assert.Equal (strings.IndexOf ("$100.00"), current = n.GetNextMatchingItem (current, '0'));
+			Assert.Equal ("$10", n.SearchString);
+
+			Assert.Equal (strings.IndexOf ("$101.00"), current = n.GetNextMatchingItem (current, '1'));
+			Assert.Equal ("$101", n.SearchString);
+
+			Assert.Equal (strings.IndexOf ("$101.00"), current = n.GetNextMatchingItem (current, '.'));
+			Assert.Equal ("$101.", n.SearchString);
+
+			// stay on the same item becuase still in timedelay
+			Assert.Equal (strings.IndexOf ("$101.00"), current = n.GetNextMatchingItem (current, 'a'));
+			Assert.Equal ("$101.", n.SearchString);
+
+			Thread.Sleep (n.TypingDelay + 100);
+			// another '$' means searching for "$" again
+			Assert.Equal (strings.IndexOf ("$101.10"), current = n.GetNextMatchingItem (current, '$'));
+			Assert.Equal ("$", n.SearchString);
+
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, '$'));
+			Assert.Equal ("$$", n.SearchString);
+
+		}
+
+		[Fact]
+		public void Delay ()
+		{
+			var strings = new string []{
+			    "$$",
+			    "$100.00",
+			    "$101.00",
+			    "$101.10",
+			    "$200.00",
+			    "appricot"
+			  };
+			int current = 0;
+			var n = new CollectionNavigator (strings);
+
+			// No delay
+			Assert.Equal (strings.IndexOf ("appricot"), current = n.GetNextMatchingItem (current, 'a'));
+			Assert.Equal ("a", n.SearchString);
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, '$'));
+			Assert.Equal ("$", n.SearchString);
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, '$'));
+			Assert.Equal ("$$", n.SearchString);
+
+			// Delay 
+			Thread.Sleep (n.TypingDelay + 10);
+			Assert.Equal (strings.IndexOf ("appricot"), current = n.GetNextMatchingItem (current, 'a'));
+			Assert.Equal ("a", n.SearchString);
+
+			Thread.Sleep (n.TypingDelay + 10);
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, '$'));
+			Assert.Equal ("$", n.SearchString);
+
+			Thread.Sleep (n.TypingDelay + 10);
+			Assert.Equal (strings.IndexOf ("$100.00"), current = n.GetNextMatchingItem (current, '$'));
+			Assert.Equal ("$", n.SearchString);
+
+			Thread.Sleep (n.TypingDelay + 10);
+			Assert.Equal (strings.IndexOf ("$101.00"), current = n.GetNextMatchingItem (current, '$'));
+			Assert.Equal ("$", n.SearchString);
+
+			Thread.Sleep (n.TypingDelay + 10);
+			Assert.Equal (strings.IndexOf ("$101.10"), current = n.GetNextMatchingItem (current, '$'));
+			Assert.Equal ("$", n.SearchString);
+
+			Thread.Sleep (n.TypingDelay + 10);
+			Assert.Equal (strings.IndexOf ("$101.10"), current = n.GetNextMatchingItem (current, '2')); // Shouldn't move
+			Assert.Equal ("2", n.SearchString);
+		}
+
+		[Fact]
+		public void MutliKeySearchPlusWrongKeyStays ()
+		{
+			var strings = new string []{
+				"a",
+			    "c",
+			    "can",
+			    "candle",
+			    "candy",
+			    "yellow",
+				"zebra"
+			  };
+			int current = 0;
+			var n = new CollectionNavigator (strings);
+
+			// https://github.com/gui-cs/Terminal.Gui/pull/2132#issuecomment-1298425573
+			// One thing that it currently does that is different from Explorer is that as soon as you hit a wrong key then it jumps to that index.
+			// So if you type cand then z it jumps you to something beginning with z. In the same situation Windows Explorer beeps (not the best!)
+			// but remains on candle.
+			// We might be able to update the behaviour so that a 'wrong' keypress (z) within 500ms of a 'right' keypress ("can" + 'd') is
+			// simply ignored (possibly ending the search process though). That would give a short delay for user to realise the thing
+			// they typed doesn't exist and then start a new search (which would be possible 500ms after the last 'good' keypress).
+			// This would only apply for 2+ character searches where theres been a successful 2+ character match right before.
+
+			Assert.Equal (strings.IndexOf ("a"), current = n.GetNextMatchingItem (current, 'a'));
+			Assert.Equal ("a", n.SearchString);
+			Assert.Equal (strings.IndexOf ("c"), current = n.GetNextMatchingItem (current, 'c'));
+			Assert.Equal ("c", n.SearchString);
+			Assert.Equal (strings.IndexOf ("can"), current = n.GetNextMatchingItem (current, 'a'));
+			Assert.Equal ("ca", n.SearchString);
+			Assert.Equal (strings.IndexOf ("can"), current = n.GetNextMatchingItem (current, 'n'));
+			Assert.Equal ("can", n.SearchString);
+			Assert.Equal (strings.IndexOf ("candle"), current = n.GetNextMatchingItem (current, 'd'));
+			Assert.Equal ("cand", n.SearchString);
+
+			// Same as above, but with a 'wrong' key (z)
+			Thread.Sleep (n.TypingDelay + 10);
+			Assert.Equal (strings.IndexOf ("a"), current = n.GetNextMatchingItem (current, 'a'));
+			Assert.Equal ("a", n.SearchString);
+			Assert.Equal (strings.IndexOf ("c"), current = n.GetNextMatchingItem (current, 'c'));
+			Assert.Equal ("c", n.SearchString);
+			Assert.Equal (strings.IndexOf ("can"), current = n.GetNextMatchingItem (current, 'a'));
+			Assert.Equal ("ca", n.SearchString);
+			Assert.Equal (strings.IndexOf ("can"), current = n.GetNextMatchingItem (current, 'n'));
+			Assert.Equal ("can", n.SearchString);
+			Assert.Equal (strings.IndexOf ("can"), current = n.GetNextMatchingItem (current, 'z')); // Shouldn't move
+			Assert.Equal ("can", n.SearchString); // Shouldn't change
+		}
+
+		[Fact]
+		public void MinimizeMovement_False_ShouldMoveIfMultipleMatches ()
+		{
+			var strings = new string [] {
+				"$$",
+				"$100.00",
+				"$101.00",
+				"$101.10",
+				"$200.00",
+				"appricot",
+				"c",
+				"car",
+				"cart",
+			};
+			int current = 0;
+			var n = new CollectionNavigator (strings);
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, "$$", false));
+			Assert.Equal (strings.IndexOf ("$100.00"), current = n.GetNextMatchingItem (current, "$", false));
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, "$$", false)); // back to top
+			Assert.Equal (strings.IndexOf ("$100.00"), current = n.GetNextMatchingItem (current, "$", false));
+			Assert.Equal (strings.IndexOf ("$101.00"), current = n.GetNextMatchingItem (current, "$", false));
+			Assert.Equal (strings.IndexOf ("$101.10"), current = n.GetNextMatchingItem (current, "$", false));
+			Assert.Equal (strings.IndexOf ("$200.00"), current = n.GetNextMatchingItem (current, "$", false));
+
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, "$", false)); // back to top
+			Assert.Equal (strings.IndexOf ("appricot"), current = n.GetNextMatchingItem (current, "a", false));
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, "$", false)); // back to top
+
+			Assert.Equal (strings.IndexOf ("$100.00"), current = n.GetNextMatchingItem (current, "$100.00", false));
+			Assert.Equal (strings.IndexOf ("$101.00"), current = n.GetNextMatchingItem (current, "$", false));
+			Assert.Equal (strings.IndexOf ("$101.00"), current = n.GetNextMatchingItem (current, "$101.00", false));
+			Assert.Equal (strings.IndexOf ("$200.00"), current = n.GetNextMatchingItem (current, "$2", false));
+
+			Assert.Equal (strings.IndexOf ("$200.00"), current = n.GetNextMatchingItem (current, "$200.00", false));
+			Assert.Equal (strings.IndexOf ("$101.00"), current = n.GetNextMatchingItem (current, "$101.00", false));
+			Assert.Equal (strings.IndexOf ("$200.00"), current = n.GetNextMatchingItem (current, "$2", false));
+
+			Assert.Equal (strings.IndexOf ("$101.00"), current = n.GetNextMatchingItem (current, "$101.00", false));
+			Assert.Equal (strings.IndexOf ("$200.00"), current = n.GetNextMatchingItem (current, "$2", false));
+
+			Assert.Equal (strings.IndexOf ("car"), current = n.GetNextMatchingItem (current, "car", false));
+			Assert.Equal (strings.IndexOf ("cart"), current = n.GetNextMatchingItem (current, "car", false));
+
+			Assert.Equal (-1, current = n.GetNextMatchingItem (current, "x", false));
+		}
+
+		[Fact]
+		public void  MinimizeMovement_True_ShouldStayOnCurrentIfMultipleMatches ()
+		{
+			var strings = new string [] {
+				"$$",
+				"$100.00",
+				"$101.00",
+				"$101.10",
+				"$200.00",
+				"appricot",
+				"c",
+				"car",
+				"cart",
+			};
+			int current = 0;
+			var n = new CollectionNavigator (strings);
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, "$$", true));
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, "$", true));
+			Assert.Equal (strings.IndexOf ("$$"), current = n.GetNextMatchingItem (current, "$$", true)); // back to top
+			Assert.Equal (strings.IndexOf ("$100.00"), current = n.GetNextMatchingItem (current, "$1", true));
+			Assert.Equal (strings.IndexOf ("$100.00"), current = n.GetNextMatchingItem (current, "$", true));
+			Assert.Equal (strings.IndexOf ("$100.00"), current = n.GetNextMatchingItem (current, "$", true));
+
+			Assert.Equal (strings.IndexOf ("car"), current = n.GetNextMatchingItem (current, "car", true));
+			Assert.Equal (strings.IndexOf ("car"), current = n.GetNextMatchingItem (current, "car", true));
+
+			Assert.Equal (-1, current = n.GetNextMatchingItem (current, "x", true));
+		}
+	}
+}
--- a/UnitTests/ListViewTests.cs
+++ b/UnitTests/ListViewTests.cs
@@ -151,7 +151,7 @@ namespace Terminal.Gui.Views {

 			public IList ToList ()
 			{
-				throw new NotImplementedException ();
+				return new List<string> () { "One", "Two", "Three" };
 			}
 		}

--- a/UnitTests/ResponderTests.cs
+++ b/UnitTests/ResponderTests.cs
@@ -3,6 +3,7 @@ using System.Collections.Generic;
 using System.Linq;
 using Terminal.Gui;
 using Xunit;
+using static Terminal.Gui.Core.ViewTests;

 // Alias Console to MockConsole so we don't accidentally use Console
 using Console = Terminal.Gui.FakeConsole;
@@ -44,5 +45,52 @@ namespace Terminal.Gui.Core {
 		{

 		}
+		
+		public class DerivedView : View {
+			public DerivedView ()
+			{
+			}
+
+			public override bool OnKeyDown (KeyEvent keyEvent)
+			{
+				return true;
+			}
+		}
+
+		[Fact]
+		public void IsOverridden_False_IfNotOverridden ()
+		{
+			// MouseEvent IS defined on Responder but NOT overridden
+			Assert.False (Responder.IsOverridden (new Responder () { }, "MouseEvent"));
+
+			// MouseEvent is defined on Responder and NOT overrident on View
+			Assert.False (Responder.IsOverridden (new View () { Text = "View does not override MouseEvent" }, "MouseEvent"));
+			Assert.False (Responder.IsOverridden (new DerivedView () { Text = "DerivedView does not override MouseEvent" }, "MouseEvent"));
+
+			// MouseEvent is NOT defined on DerivedView 
+			Assert.False (Responder.IsOverridden (new DerivedView () { Text = "DerivedView does not override MouseEvent" }, "MouseEvent"));
+
+			// OnKeyDown is defined on View and NOT overrident on Button
+			Assert.False (Responder.IsOverridden (new Button () { Text = "Button does not override OnKeyDown" }, "OnKeyDown"));
+		}
+
+		[Fact]
+		public void IsOverridden_True_IfOverridden ()
+		{
+			// MouseEvent is defined on Responder IS overriden on ScrollBarView (but not View)
+			Assert.True (Responder.IsOverridden (new ScrollBarView () { Text = "ScrollBarView overrides MouseEvent" }, "MouseEvent"));
+
+			// OnKeyDown is defined on View
+			Assert.True (Responder.IsOverridden (new View () { Text = "View overrides OnKeyDown" }, "OnKeyDown"));
+
+			// OnKeyDown is defined on DerivedView
+			Assert.True (Responder.IsOverridden (new DerivedView () { Text = "DerivedView overrides OnKeyDown" }, "OnKeyDown"));
+			
+			// ScrollBarView overrides both MouseEvent (from Responder) and Redraw (from View)
+			Assert.True (Responder.IsOverridden (new ScrollBarView () { Text = "ScrollBarView overrides MouseEvent" }, "MouseEvent"));
+			Assert.True (Responder.IsOverridden (new ScrollBarView () { Text = "ScrollBarView overrides Redraw" }, "Redraw"));
+
+			Assert.True (Responder.IsOverridden (new Button () { Text = "Button overrides MouseEvent" }, "MouseEvent"));
+		}
 	}
 }