Continuing Implementation of #3692 - Second round of ConsoleDriver cleanup

.editorconfig

@@ -5,7 +5,7 @@ csharp_space_after_keywords_in_control_flow_statements = true
 csharp_space_between_method_declaration_parameter_list_parentheses = false
 csharp_space_between_method_call_parameter_list_parentheses = false
 csharp_preserve_single_line_blocks = true
-dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:warning
 csharp_prefer_braces = true:warning
 csharp_space_between_method_call_name_and_opening_parenthesis = true
 csharp_space_between_method_declaration_name_and_open_parenthesis = true

Terminal.Gui/Application/Application.Initialization.cs

@@ -38,9 +38,40 @@ public static partial class Application // Initialization (Init/Shutdown)
     [RequiresDynamicCode ("AOT")]
     public static void Init (ConsoleDriver? driver = null, string? driverName = null) { InternalInit (driver, driverName); }
 
+    /// <summary>Initializes a new instance of <see cref="Terminal.Gui"/> Application.</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="ConsoleDriver"/> for the platform, Creates a <see cref="Toplevel"/>. and
+    ///     assigns it to <see cref="Top"/>
+    /// </para>
+    /// <para>
+    ///     <see cref="Shutdown"/> must be called when the application is closing (typically after
+    ///     <see cref="Run{T}"/> has returned) to ensure resources are cleaned up and
+    ///     terminal settings
+    ///     restored.
+    /// </para>
+    /// <para>
+    ///     The <see cref="Run{T}"/> function combines
+    ///     <see cref="Init(Terminal.Gui.ConsoleDriver,string)"/> and <see cref="Run(Toplevel, Func{Exception, bool})"/>
+    ///     into a single
+    ///     call. An application cam use <see cref="Run{T}"/> without explicitly calling
+    ///     <see cref="Init(Terminal.Gui.ConsoleDriver,string)"/>.
+    /// </para>
+    /// <typeparam name="TDriver">
+    ///     The <see cref="ConsoleDriver"/>-derived type to use. A default instance will be created.
+    /// </typeparam>
+    public static void Init<TDriver> () where TDriver : ConsoleDriver, new () { InternalInit (new TDriver ()); }
+
     internal static bool IsInitialized { get; set; }
     internal static int MainThreadId { get; set; } = -1;
 
+    /// <summary>
+    ///     Internal method to call <see cref="InternalInit"/> with a default instance of the driver type specified in <typeparamref name="TDriver"/>.
+    /// </summary>
+    /// <typeparam name="TDriver">The <see cref="ConsoleDriver"/>-derived type to create and pass to <see cref="InternalInit"/>.</typeparam>
+    /// <param name="calledViaRunT">If false (default) all state will be reset. If true the state will not be reset.</param>
+    internal static void InternalInit<TDriver> (bool calledViaRunT = false) where TDriver : ConsoleDriver, new () { InternalInit (new TDriver ()); }
+
     // INTERNAL function for initializing an app with a Toplevel factory object, driver, and mainloop.
     //
     // Called from:
@@ -58,14 +89,12 @@ internal static void InternalInit (
         bool calledViaRunT = false
     )
     {
-        if (IsInitialized && driver is null)
-        {
-            return;
-        }
-
-        if (IsInitialized)
+        switch (IsInitialized)
         {
-            throw new InvalidOperationException ("Init has already been called and must be bracketed by Shutdown.");
+            case true when driver is null:
+                return;
+            case true:
+                throw new InvalidOperationException ("Init has already been called and must be bracketed by Shutdown.");
         }
 
         if (!calledViaRunT)
@@ -117,7 +146,7 @@ internal static void InternalInit (
             else
             {
                 List<Type?> drivers = GetDriverTypes ();
-                Type? driverType = drivers.FirstOrDefault (t => t!.Name.Equals (ForceDriver, StringComparison.InvariantCultureIgnoreCase));
+                Type? driverType = drivers.FirstOrDefault (static t => t!.Name.Equals (ForceDriver, StringComparison.InvariantCultureIgnoreCase));
 
                 if (driverType is { })
                 {
@@ -134,7 +163,7 @@ internal static void InternalInit (
 
         try
         {
-            MainLoop = Driver!.Init ();
+            MainLoop = Driver.Init ();
         }
         catch (InvalidOperationException ex)
         {

Terminal.Gui/Application/Application.Run.cs

@@ -41,7 +41,7 @@ public static partial class Application // Run (Begin, Run, End, Stop)
     ///     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>
-    public static RunState Begin (Toplevel toplevel)
+    public static RunState Begin (Toplevel? toplevel)
     {
         ArgumentNullException.ThrowIfNull (toplevel);
 

Terminal.Gui/ConsoleDrivers/ConsoleDriver.cs

@@ -7,6 +7,8 @@
 
 namespace Terminal.Gui;
 
+using System.Runtime.CompilerServices;
+
 /// <summary>Base class for Terminal.Gui ConsoleDriver implementations.</summary>
 /// <remarks>
 ///     There are currently four implementations: - <see cref="CursesDriver"/> (for Unix and Mac) -
@@ -73,7 +75,7 @@ internal set
     public Cell [,]? Contents { get; internal set; }
 
     /// <summary>The leftmost column in the terminal.</summary>
-    public virtual int Left { get; internal set; } = 0;
+    public virtual int Left { get; internal set; }
 
     /// <summary>
     ///     Gets the row last set by <see cref="Move"/>. <see cref="Col"/> and <see cref="Row"/> are used by
@@ -135,6 +137,7 @@ public void AddRune (Rune rune)
             rune = rune.MakePrintable ();
             runeWidth = rune.GetColumns ();
 
+            // BUG: CONCURRENCY: This is broken.
             lock (Contents)
             {
                 if (runeWidth == 0 && rune.IsCombiningMark ())
@@ -266,6 +269,7 @@ public void AddRune (Rune rune)
 
             if (validLocation && Col < Clip.Right)
             {
+                // BUG: CONCURRENCY: This is broken.
                 lock (Contents!)
                 {
                     // This is a double-width character, and we are not at the end of the line.
@@ -314,7 +318,7 @@ public void AddStr (string str)
     public void ClearContents ()
     {
         Contents = new Cell [Rows, Cols];
-        //CONCURRENCY: Unsynchronized access to Clip isn't safe.
+        // CONCURRENCY: Unsynchronized access to Clip isn't safe.
         // TODO: ClearContents should not clear the clip; it should only clear the contents. Move clearing it elsewhere.
         Clip = Screen;
         _dirtyLines = new bool [Rows];
@@ -332,6 +336,7 @@ public void ClearContents ()
                         IsDirty = true
                     };
                 }
+
                 _dirtyLines [row] = true;
             }
         }
@@ -351,6 +356,7 @@ public void SetContentsAsDirty ()
                 {
                     Contents [row, c].IsDirty = true;
                 }
+
                 _dirtyLines! [row] = true;
             }
         }
@@ -369,6 +375,8 @@ public void SetContentsAsDirty ()
     public void FillRect (Rectangle rect, Rune rune = default)
     {
         rect = Rectangle.Intersect (rect, Clip);
+
+        // BUG: CONCURRENCY: This is broken.
         lock (Contents!)
         {
             for (int r = rect.Y; r < rect.Y + rect.Height; r++)
@@ -401,15 +409,16 @@ public void FillRect (Rectangle rect, Rune rune = default)
 
     /// <summary>Returns the name of the driver and relevant library version information.</summary>
     /// <returns></returns>
-    public virtual string GetVersionInfo () { return GetType ().Name; }
+    public abstract string GetVersionInfo ();
 
     /// <summary>Tests if the specified rune is supported by the driver.</summary>
     /// <param name="rune"></param>
     /// <returns>
     ///     <see langword="true"/> if the rune can be properly presented; <see langword="false"/> if the driver does not
     ///     support displaying this rune.
     /// </returns>
-    public virtual bool IsRuneSupported (Rune rune) { return Rune.IsValid (rune.Value); }
+    [MethodImpl (MethodImplOptions.AggressiveInlining)]
+    public virtual bool IsRuneSupported (in Rune rune) => Rune.IsValid (rune.Value);
 
     /// <summary>Tests whether the specified coordinate are valid for drawing.</summary>
     /// <param name="col">The column.</param>
@@ -420,6 +429,13 @@ public void FillRect (Rectangle rect, Rune rune = default)
     /// </returns>
     public bool IsValidLocation (int col, int row)
     {
+        // TODO: Remove this commentary or implement when partial-screen is supported.
+        // Screen is hard-coded to have origin at 0,0.
+        // Screen is also hard-coded to be Cols x Rows in size.
+        // Clip intersects it.
+        // Therefore, the call to Clip.Contains(col, row) already covers col >= 0 and row >= 0.
+        // The checks for col < Cols and row < Rows can also be eliminated by making the entire line be:
+        // return Clip.Contains (col + 1, row + 1);
         return col >= 0 && row >= 0 && col < Cols && row < Rows && Clip.Contains (col, row);
     }
 
@@ -455,6 +471,8 @@ public virtual void Move (int col, int row)
     /// <returns><see langword="true"/> upon success</returns>
     public abstract bool SetCursorVisibility (CursorVisibility visibility);
 
+    public abstract void SetWindowPosition (int left, int top);
+
     /// <summary>The event fired when the terminal is resized.</summary>
     public event EventHandler<SizeChangedEventArgs>? SizeChanged;