Fixes 3941 - Do not repeatedly raise new sets of keystrokes when modals pop (stack overflow)

Terminal.Gui/Application/Application.Run.cs

@@ -516,6 +516,11 @@ public static bool RunIteration (ref RunState state, bool firstIteration = false
         return firstIteration;
     }
 
+    internal static void RaiseIteration ()
+    {
+        Iteration?.Invoke (null, new IterationEventArgs ());
+    }
+
     /// <summary>Stops the provided <see cref="Toplevel"/>, causing or the <paramref name="top"/> if provided.</summary>
     /// <param name="top">The <see cref="Toplevel"/> to stop.</param>
     /// <remarks>

Terminal.Gui/Application/Application.cs

@@ -26,6 +26,15 @@
     /// <summary>Gets all cultures supported by the application without the invariant language.</summary>
     public static List<CultureInfo>? SupportedCultures { get; private set; } = GetSupportedCultures ();
 
+    /// <summary>
+    /// Maximum number of iterations of the main loop (and hence draws)
+    /// to allow to occur per second. Defaults to 25 which is a 40ms sleep
+    /// after iteration (factoring in how long iteration took to run).
+    /// <remarks>Note that not ever iteration draws (see <see cref="View.NeedsDraw"/>).
+    /// Only affects v2 drivers.</remarks>
+    /// </summary>
+    public static ushort MaximumIterationsPerSecond = 25;
+
     /// <summary>
     ///     Gets a string representation of the Application as rendered by <see cref="Driver"/>.
     /// </summary>
@@ -63,7 +72,7 @@
             {
                 Rune rune = contents [r, c].Rune;
 
                 if (rune.DecodeSurrogatePair (out char [] sp))
                 {
                     sb.Append (sp);
                 }

Terminal.Gui/ConsoleDrivers/V2/MainLoop.cs

@@ -99,14 +99,17 @@
     public void Iteration ()
     {
         DateTime dt = Now ();
+        int timeAllowed = 1000 / Math.Max(1,(int)Application.MaximumIterationsPerSecond);
 
         IterationImpl ();
 
         TimeSpan took = Now () - dt;
-        TimeSpan sleepFor = TimeSpan.FromMilliseconds (50) - took;
+        TimeSpan sleepFor = TimeSpan.FromMilliseconds (timeAllowed) - took;
 
         Logging.TotalIterationMetric.Record (took.Milliseconds);
 
+        Application.RaiseIteration ();
+
         if (sleepFor.Milliseconds > 0)
         {
             Task.Delay (sleepFor).Wait ();
@@ -151,7 +154,7 @@
 
     private void SetCursor ()
     {
         View? mostFocused = Application.Top.MostFocused;
 
         if (mostFocused == null)
         {

UICatalog/Scenario.cs

@@ -229,13 +229,20 @@ private void OnApplicationOnIteration (object? s, IterationEventArgs a)
         }
     }
 
+    private HashSet<Scenario> _scenariosRun = new HashSet<Scenario> ();
     private void OnApplicationNotifyNewRunState (object? sender, RunStateEventArgs e)
     {
+        // We are just returning to the same scenario
+        if (!_scenariosRun.Add (this))
+        {
+            return;
+        }
+
         SubscribeAllSubviews (Application.Top!);
 
         _currentDemoKey = 0;
         _demoKeys = GetDemoKeyStrokes ();
-
+        
         Application.AddTimeout (
                                 new TimeSpan (0, 0, 0, 0, BENCHMARK_KEY_PACING),
                                 () =>

UICatalog/UICatalog.cs

@@ -527,6 +527,7 @@
 
     private static void BenchmarkAllScenarios ()
     {
+        Application.MaximumIterationsPerSecond = ushort.MaxValue;
         List<BenchmarkResults> resultsList = new ();
 
         var maxScenarios = 5;
@@ -1356,7 +1357,7 @@
                                //CanExecute = () => false
                            });
 
             return menuItems.ToArray ();
         }
 
         // TODO: This should be an ConfigurationManager setting