Merge branch 'v2_develop' of tig:tig/Terminal.Gui into v2_develop

Author: tig

Terminal.Gui/Application/Application.Initialization.cs

@@ -7,7 +7,7 @@ namespace Terminal.Gui;
 
 public static partial class Application // Initialization (Init/Shutdown)
 {
-    /// <summary>Initializes a new instance of <see cref="Terminal.Gui"/> Application.</summary>
+    /// <summary>Initializes a new instance of a Terminal.Gui Application. <see cref="Shutdown"/> must be called when the application is closing.</summary>
     /// <para>Call this method once per instance (or after <see cref="Shutdown"/> has been called).</para>
     /// <para>
     ///     This function loads the right <see cref="IConsoleDriver"/> for the platform, Creates a <see cref="Toplevel"/>. and

Terminal.Gui/Application/Application.Run.cs

@@ -71,7 +71,7 @@ public static Key ArrangeKey
     /// <param name="toplevel">The <see cref="Toplevel"/> to prepare execution for.</param>
     /// <remarks>
     ///     This method prepares the provided <see cref="Toplevel"/> for running with the focus, it adds this to the list
-    ///     of <see cref="Toplevel"/>s, lays out the Subviews, focuses the first element, and draws the <see cref="Toplevel"/>
+    ///     of <see cref="Toplevel"/>s, lays out the SubViews, focuses the first element, and draws the <see cref="Toplevel"/>
     ///     in the screen. This is usually followed by executing the <see cref="RunLoop"/> method, and then the
     ///     <see cref="End(RunState)"/> method upon termination which will undo these changes.
     /// </remarks>
@@ -89,7 +89,11 @@ public static RunState Begin (Toplevel toplevel)
         //#endif
 
         // Ensure the mouse is ungrabbed.
-        MouseGrabView = null;
+        if (MouseGrabView is { })
+        {
+            UngrabMouse ();
+            MouseGrabView = null;
+        }
 
         var rs = new RunState (toplevel);
 

Terminal.Gui/Application/ApplicationNavigation.cs

@@ -33,7 +33,7 @@ public ApplicationNavigation ()
     }
 
     /// <summary>
-    ///     Gets whether <paramref name="view"/> is in the Subview hierarchy of <paramref name="start"/>.
+    ///     Gets whether <paramref name="view"/> is in the SubView hierarchy of <paramref name="start"/>.
     /// </summary>
     /// <param name="start"></param>
     /// <param name="view"></param>
@@ -50,7 +50,7 @@ public static bool IsInHierarchy (View? start, View? view)
             return true;
         }
 
-        foreach (View subView in start.Subviews)
+        foreach (View subView in start.SubViews)
         {
             if (view == subView)
             {

Terminal.Gui/ConsoleDrivers/AnsiEscapeSequence.cs

@@ -33,7 +33,7 @@ public class AnsiEscapeSequence
     ///         to the oldest outstanding request.
     ///     </para>
     /// </summary>
-    public required string Terminator { get; init; }
+    public required string? Terminator { get; init; }
 
 
 

Terminal.Gui/ConsoleDrivers/AnsiEscapeSequenceRequest.cs

@@ -12,7 +12,7 @@ public class AnsiEscapeSequenceRequest : AnsiEscapeSequence
     ///     Invoked when the console responds with an ANSI response code that matches the
     ///     <see cref="AnsiEscapeSequence.Terminator"/>
     /// </summary>
-    public required Action<string> ResponseReceived { get; init; }
+    public required Action<string?> ResponseReceived { get; init; }
 
     /// <summary>
     ///     Invoked if the console fails to responds to the ANSI response code

Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiMouseParser.cs

@@ -17,11 +17,11 @@ public class AnsiMouseParser
     /// </summary>
     /// <param name="cur"></param>
     /// <returns></returns>
-    public bool IsMouse (string cur)
+    public bool IsMouse (string? cur)
     {
         // Typically in this format
         // ESC [ < {button_code};{x_pos};{y_pos}{final_byte}
-        return cur.EndsWith ('M') || cur.EndsWith ('m');
+        return cur!.EndsWith ('M') || cur.EndsWith ('m');
     }
 
     /// <summary>
@@ -30,10 +30,10 @@ public bool IsMouse (string cur)
     /// </summary>
     /// <param name="input"></param>
     /// <returns></returns>
-    public MouseEventArgs? ProcessMouseInput (string input)
+    public MouseEventArgs? ProcessMouseInput (string? input)
     {
         // Match mouse wheel events first
-        Match match = _mouseEventPattern.Match (input);
+        Match match = _mouseEventPattern.Match (input!);
 
         if (match.Success)
         {

Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiRequestScheduler.cs

@@ -108,7 +108,7 @@ private bool SendOrSchedule (AnsiEscapeSequenceRequest request, bool addToQueue)
 
     private void EvictStaleRequests ()
     {
-        foreach (string stale in _lastSend.Where (v => IsStale (v.Value)).Select (k => k.Key))
+        foreach (string? stale in _lastSend.Where (v => IsStale (v.Value)).Select (k => k.Key))
         {
             EvictStaleRequests (stale);
         }
@@ -123,9 +123,9 @@ private void EvictStaleRequests ()
     /// </summary>
     /// <param name="withTerminator"></param>
     /// <returns></returns>
-    private bool EvictStaleRequests (string withTerminator)
+    private bool EvictStaleRequests (string? withTerminator)
     {
-        if (_lastSend.TryGetValue (withTerminator, out DateTime dt))
+        if (_lastSend.TryGetValue (withTerminator!, out DateTime dt))
         {
             if (IsStale (dt))
             {
@@ -178,7 +178,7 @@ public bool RunSchedule (bool force = false)
 
     private void Send (AnsiEscapeSequenceRequest r)
     {
-        _lastSend.AddOrUpdate (r.Terminator, _ => Now (), (_, _) => Now ());
+        _lastSend.AddOrUpdate (r.Terminator!, _ => Now (), (_, _) => Now ());
         _parser.ExpectResponse (r.Terminator, r.ResponseReceived, r.Abandoned, false);
         r.Send ();
     }
@@ -206,7 +206,7 @@ private bool CanSend (AnsiEscapeSequenceRequest r, out ReasonCannotSend reason)
 
     private bool ShouldThrottle (AnsiEscapeSequenceRequest r)
     {
-        if (_lastSend.TryGetValue (r.Terminator, out DateTime value))
+        if (_lastSend.TryGetValue (r.Terminator!, out DateTime value))
         {
             return Now () - value < _throttle;
         }

Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiResponseExpectation.cs

@@ -1,7 +1,7 @@
 #nullable enable
 namespace Terminal.Gui;
 
-internal record AnsiResponseExpectation (string Terminator, Action<IHeld> Response, Action? Abandoned)
+internal record AnsiResponseExpectation (string? Terminator, Action<IHeld> Response, Action? Abandoned)
 {
-    public bool Matches (string cur) { return cur.EndsWith (Terminator); }
+    public bool Matches (string? cur) { return cur!.EndsWith (Terminator!); }
 }

Terminal.Gui/ConsoleDrivers/AnsiResponseParser/AnsiResponseParser.cs

@@ -6,12 +6,32 @@ namespace Terminal.Gui;
 
 internal abstract class AnsiResponseParserBase : IAnsiResponseParser
 {
-    private const char Escape = '\x1B';
+    private const char ESCAPE = '\x1B';
     private readonly AnsiMouseParser _mouseParser = new ();
+#pragma warning disable IDE1006 // Naming Styles
     protected readonly AnsiKeyboardParser _keyboardParser = new ();
     protected object _lockExpectedResponses = new ();
 
     protected object _lockState = new ();
+    protected readonly IHeld _heldContent;
+
+    /// <summary>
+    ///     Responses we are expecting to come in.
+    /// </summary>
+    protected readonly List<AnsiResponseExpectation> _expectedResponses = [];
+
+    /// <summary>
+    ///     Collection of responses that we <see cref="StopExpecting"/>.
+    /// </summary>
+    protected readonly List<AnsiResponseExpectation> _lateResponses = [];
+
+    /// <summary>
+    ///     Responses that you want to look out for that will come in continuously e.g. mouse events.
+    ///     Key is the terminator.
+    /// </summary>
+    protected readonly List<AnsiResponseExpectation> _persistentExpectations = [];
+
+#pragma warning restore IDE1006 // Naming Styles
 
     /// <summary>
     ///     Event raised when mouse events are detected - requires setting <see cref="HandleMouse"/> to true
@@ -35,22 +55,6 @@ internal abstract class AnsiResponseParserBase : IAnsiResponseParser
     /// </summary>
     public bool HandleKeyboard { get; set; } = false;
 
-    /// <summary>
-    ///     Responses we are expecting to come in.
-    /// </summary>
-    protected readonly List<AnsiResponseExpectation> _expectedResponses = [];
-
-    /// <summary>
-    ///     Collection of responses that we <see cref="StopExpecting"/>.
-    /// </summary>
-    protected readonly List<AnsiResponseExpectation> _lateResponses = [];
-
-    /// <summary>
-    ///     Responses that you want to look out for that will come in continuously e.g. mouse events.
-    ///     Key is the terminator.
-    /// </summary>
-    protected readonly List<AnsiResponseExpectation> _persistentExpectations = [];
-
     private AnsiResponseParserState _state = AnsiResponseParserState.Normal;
 
     /// <inheritdoc/>
@@ -64,8 +68,6 @@ protected set
         }
     }
 
-    protected readonly IHeld _heldContent;
-
     /// <summary>
     ///     When <see cref="State"/> was last changed.
     /// </summary>
@@ -74,17 +76,17 @@ protected set
     // These all are valid terminators on ansi responses,
     // see CSI in https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s
     // No - N or O
-    protected readonly HashSet<char> _knownTerminators = new (
-                                                              [
-                                                                  '@', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
-
-                                                                  // No - N or O
-                                                                  'P', 'Q', 'R', 'S', 'T', 'W', 'X', 'Z',
-                                                                  '^', '`', '~',
-                                                                  'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i',
-                                                                  'l', 'm', 'n',
-                                                                  'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'
-                                                              ]);
+    protected readonly HashSet<char> _knownTerminators =
+    [
+        '@', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
+
+        // No - N or O
+        'P', 'Q', 'R', 'S', 'T', 'W', 'X', 'Z',
+        '^', '`', '~',
+        'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i',
+        'l', 'm', 'n',
+        'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'
+    ];
 
     protected AnsiResponseParserBase (IHeld heldContent) { _heldContent = heldContent; }
 
@@ -137,7 +139,7 @@ int inputLength
             char currentChar = getCharAtIndex (index);
             object currentObj = getObjectAtIndex (index);
 
-            bool isEscape = currentChar == Escape;
+            bool isEscape = currentChar == ESCAPE;
 
             switch (State)
             {
@@ -233,7 +235,7 @@ protected void TryLastMinuteSequences ()
     {
         lock (_lockState)
         {
-            string cur = _heldContent.HeldToString ();
+            string? cur = _heldContent.HeldToString ();
 
             if (HandleKeyboard)
             {
@@ -250,7 +252,7 @@ protected void TryLastMinuteSequences ()
 
             // We have something totally unexpected, not a CSI and
             // still Esc+<something>. So give last minute swallow chance
-            if (cur.Length >= 2 && cur [0] == Escape)
+            if (cur!.Length >= 2 && cur [0] == ESCAPE)
             {
                 // Maybe swallow anyway if user has custom delegate
                 bool swallow = ShouldSwallowUnexpectedResponse ();
@@ -270,7 +272,7 @@ protected bool ShouldReleaseHeldContent ()
     {
         lock (_lockState)
         {
-            string cur = _heldContent.HeldToString ();
+            string? cur = _heldContent.HeldToString ();
 
             if (HandleMouse && IsMouse (cur))
             {
@@ -328,7 +330,7 @@ protected bool ShouldReleaseHeldContent ()
 
             // Finally if it is a valid ansi response but not one we are expect (e.g. its mouse activity)
             // then we can release it back to input processing stream
-            if (_knownTerminators.Contains (cur.Last ()) && cur.StartsWith (EscSeqUtils.CSI))
+            if (_knownTerminators.Contains (cur!.Last ()) && cur!.StartsWith (EscSeqUtils.CSI))
             {
                 // We have found a terminator so bail
                 State = AnsiResponseParserState.Normal;
@@ -354,7 +356,7 @@ protected bool ShouldReleaseHeldContent ()
         return false; // Continue accumulating
     }
 
-    private void RaiseMouseEvent (string cur)
+    private void RaiseMouseEvent (string? cur)
     {
         MouseEventArgs? ev = _mouseParser.ProcessMouseInput (cur);
 
@@ -364,9 +366,9 @@ private void RaiseMouseEvent (string cur)
         }
     }
 
-    private bool IsMouse (string cur) { return _mouseParser.IsMouse (cur); }
+    private bool IsMouse (string? cur) { return _mouseParser.IsMouse (cur); }
 
-    protected void RaiseKeyboardEvent (AnsiKeyboardParserPattern pattern, string cur)
+    protected void RaiseKeyboardEvent (AnsiKeyboardParserPattern pattern, string? cur)
     {
         Key? k = pattern.GetKey (cur);
 
@@ -394,7 +396,7 @@ protected void RaiseKeyboardEvent (AnsiKeyboardParserPattern pattern, string cur
     /// <returns></returns>
     protected abstract bool ShouldSwallowUnexpectedResponse ();
 
-    private bool MatchResponse (string cur, List<AnsiResponseExpectation> collection, bool invokeCallback, bool removeExpectation)
+    private bool MatchResponse (string? cur, List<AnsiResponseExpectation> collection, bool invokeCallback, bool removeExpectation)
     {
         // Check for expected responses
         AnsiResponseExpectation? matchingResponse = collection.FirstOrDefault (r => r.Matches (cur));
@@ -422,7 +424,7 @@ private bool MatchResponse (string cur, List<AnsiResponseExpectation> collection
     }
 
     /// <inheritdoc/>
-    public void ExpectResponse (string terminator, Action<string> response, Action? abandoned, bool persistent)
+    public void ExpectResponse (string? terminator, Action<string?> response, Action? abandoned, bool persistent)
     {
         lock (_lockExpectedResponses)
         {
@@ -438,17 +440,17 @@ public void ExpectResponse (string terminator, Action<string> response, Action?
     }
 
     /// <inheritdoc/>
-    public bool IsExpecting (string terminator)
+    public bool IsExpecting (string? terminator)
     {
         lock (_lockExpectedResponses)
         {
             // If any of the new terminator matches any existing terminators characters it's a collision so true.
-            return _expectedResponses.Any (r => r.Terminator.Intersect (terminator).Any ());
+            return _expectedResponses.Any (r => r.Terminator!.Intersect (terminator!).Any ());
         }
     }
 
     /// <inheritdoc/>
-    public void StopExpecting (string terminator, bool persistent)
+    public void StopExpecting (string? terminator, bool persistent)
     {
         lock (_lockExpectedResponses)
         {
@@ -530,7 +532,7 @@ public Tuple<char, T> [] Release ()
     /// <param name="response"></param>
     /// <param name="abandoned"></param>
     /// <param name="persistent"></param>
-    public void ExpectResponseT (string terminator, Action<IEnumerable<Tuple<char, T>>> response, Action? abandoned, bool persistent)
+    public void ExpectResponseT (string? terminator, Action<IEnumerable<Tuple<char, T>>> response, Action? abandoned, bool persistent)
     {
         lock (_lockExpectedResponses)
         {
@@ -562,7 +564,7 @@ internal class AnsiResponseParser () : AnsiResponseParserBase (new StringHeld ()
     ///         keystrokes 'swallowed' (i.e. not returned to input stream).
     ///     </para>
     /// </summary>
-    public Func<string, bool> UnknownResponseHandler { get; set; } = _ => false;
+    public Func<string?, bool> UnknownResponseHandler { get; set; } = _ => false;
 
     public string ProcessInput (string input)
     {
@@ -583,13 +585,13 @@ private void AppendOutput (StringBuilder output, char c)
         output.Append (c);
     }
 
-    public string Release ()
+    public string? Release ()
     {
         lock (_lockState)
         {
             TryLastMinuteSequences ();
 
-            string output = _heldContent.HeldToString ();
+            string? output = _heldContent.HeldToString ();
             ResetState ();
 
             return output;

Terminal.Gui/ConsoleDrivers/AnsiResponseParser/GenericHeld.cs

@@ -11,7 +11,7 @@ internal class GenericHeld<T> : IHeld
 
     public void ClearHeld () { held.Clear (); }
 
-    public string HeldToString () { return new (held.Select (h => h.Item1).ToArray ()); }
+    public string? HeldToString () { return new (held.Select (h => h.Item1).ToArray ()); }
 
     public IEnumerable<object> HeldToObjects () { return held; }