Made more Driver APIs internal

Author: tig

Terminal.Gui/ConsoleDrivers/ConsoleDriver.cs

@@ -30,7 +30,7 @@ public abstract class ConsoleDriver
     ///     to.
     /// </summary>
     /// <value>The rectangle describing the of <see cref="Clip"/> region.</value>
-    public Region? Clip
+    internal Region? Clip
     {
         get => _clip;
         set
@@ -312,7 +312,7 @@ internal void AddRune (Rune rune)
     ///     <para>If <paramref name="str"/> requires more columns than are available, the output will be clipped.</para>
     /// </remarks>
     /// <param name="str">String.</param>
-    public void AddStr (string str)
+    internal void AddStr (string str)
     {
         List<Rune> runes = str.EnumerateRunes ().ToList ();
 
@@ -323,7 +323,7 @@ public void AddStr (string str)
     }
 
     /// <summary>Clears the <see cref="Contents"/> of the driver.</summary>
-    public void ClearContents ()
+    internal void ClearContents ()
     {
         Contents = new Cell [Rows, Cols];
 
@@ -362,7 +362,7 @@ public void ClearContents ()
     /// Sets <see cref="Contents"/> as dirty for situations where views
     /// don't need layout and redrawing, but just refresh the screen.
     /// </summary>
-    public void SetContentsAsDirty ()
+    internal void SetContentsAsDirty ()
     {
         lock (Contents!)
         {
@@ -387,7 +387,7 @@ public void SetContentsAsDirty ()
     /// </remarks>
     /// <param name="rect">The Screen-relative rectangle.</param>
     /// <param name="rune">The Rune used to fill the rectangle</param>
-    public void FillRect (Rectangle rect, Rune rune = default)
+    internal void FillRect (Rectangle rect, Rune rune = default)
     {
         // BUGBUG: This should be a method on Region
         rect = Rectangle.Intersect (rect, Clip?.GetBounds () ?? Screen);
@@ -418,7 +418,7 @@ public void FillRect (Rectangle rect, Rune rune = default)
     /// </summary>
     /// <param name="rect"></param>
     /// <param name="c"></param>
-    public void FillRect (Rectangle rect, char c) { FillRect (rect, new Rune (c)); }
+    internal void FillRect (Rectangle rect, char c) { FillRect (rect, new Rune (c)); }
 
     /// <summary>Gets the terminal cursor visibility.</summary>
     /// <param name="visibility">The current <see cref="CursorVisibility"/></param>
@@ -445,7 +445,7 @@ public void FillRect (Rectangle rect, Rune rune = default)
     ///     <see langword="false"/> if the coordinate is outside the screen bounds or outside of <see cref="Clip"/>.
     ///     <see langword="true"/> otherwise.
     /// </returns>
-    public bool IsValidLocation (Rune rune, int col, int row)
+    internal bool IsValidLocation (Rune rune, int col, int row)
     {
         if (rune.GetColumns () < 2)
         {
@@ -458,6 +458,7 @@ public bool IsValidLocation (Rune rune, int col, int row)
         }
     }
 
+    // TODO: Make internal once Menu is upgraded
     /// <summary>
     ///     Updates <see cref="Col"/> and <see cref="Row"/> to the specified column and row in <see cref="Contents"/>.
     ///     Used by <see cref="AddRune(Rune)"/> and <see cref="AddStr"/> to determine where to add content.
@@ -480,10 +481,10 @@ public virtual void Move (int col, int row)
 
     /// <summary>Called when the terminal size changes. Fires the <see cref="SizeChanged"/> event.</summary>
     /// <param name="args"></param>
-    public void OnSizeChanged (SizeChangedEventArgs args) { SizeChanged?.Invoke (this, args); }
+    internal void OnSizeChanged (SizeChangedEventArgs args) { SizeChanged?.Invoke (this, args); }
 
     /// <summary>Updates the screen to reflect all the changes that have been done to the display buffer</summary>
-    public void Refresh ()
+    internal void Refresh ()
     {
         bool updated = UpdateScreen ();
         UpdateCursor ();

Terminal.Gui/View/View.Drawing.Primitives.cs

@@ -154,4 +154,20 @@ public void FillRect (Rectangle rect, Color? color = null)
         SetClip (prevClip);
     }
 
+    /// <summary>Fills the specified <see cref="Viewport"/>-relative rectangle.</summary>
+    /// <param name="rect">The Viewport-relative rectangle to clear.</param>
+    /// <param name="rune">The Rune to fill with.</param>
+    public void FillRect (Rectangle rect, Rune rune)
+    {
+        if (Driver is null)
+        {
+            return;
+        }
+
+        Region prevClip = ClipViewport ();
+        Rectangle toClear = ViewportToScreen (rect);
+        Driver.FillRect (toClear, rune);
+        SetClip (prevClip);
+    }
+
 }

Terminal.Gui/Views/ListView.cs

@@ -32,7 +32,7 @@ public interface IListDataSource : IDisposable
 
     /// <summary>This method is invoked to render a specified item, the method should cover the entire provided width.</summary>
     /// <returns>The render.</returns>
-    /// <param name="container">The list view to render.</param>
+    /// <param name="listView">The list view to render.</param>
     /// <param name="selected">Describes whether the item being rendered is currently selected by the user.</param>
     /// <param name="item">The index of the item to render, zero for the first item and so on.</param>
     /// <param name="col">The column where the rendering will start</param>
@@ -44,7 +44,7 @@ public interface IListDataSource : IDisposable
     ///     or not.
     /// </remarks>
     void Render (
-        ListView container,
+        ListView listView,
         bool selected,
         int item,
         int col,

Terminal.Gui/Views/Menu/Menu.cs

@@ -436,9 +436,7 @@ private void Top_DrawComplete (object? sender, DrawEventArgs e)
 
             if (item is null && BorderStyle != LineStyle.None)
             {
-                Point s = ViewportToScreen (new Point (-1, i));
-                Driver.Move (s.X, s.Y);
-                Driver.AddRune (Glyphs.LeftTee);
+                AddRune (-1, i, Glyphs.LeftTee);
             }
             else if (Frame.X < Driver.Cols)
             {
@@ -462,31 +460,29 @@ private void Top_DrawComplete (object? sender, DrawEventArgs e)
 
                 if (item is null)
                 {
-                    Driver.AddRune (Glyphs.HLine);
+                    AddRune (Glyphs.HLine);
                 }
                 else if (i == 0 && p == 0 && _host.UseSubMenusSingleFrame && item.Parent!.Parent is { })
                 {
-                    Driver.AddRune (Glyphs.LeftArrow);
+                    AddRune (Glyphs.LeftArrow);
                 }
 
                 // This `- 3` is left border + right border + one row in from right
                 else if (p == Frame.Width - 3 && _barItems?.SubMenu (_barItems.Children [i]!) is { })
                 {
-                    Driver.AddRune (Glyphs.RightArrow);
+                    AddRune (Glyphs.RightArrow);
                 }
                 else
                 {
-                    Driver.AddRune ((Rune)' ');
+                    AddRune ((Rune)' ');
                 }
             }
 
             if (item is null)
             {
                 if (BorderStyle != LineStyle.None && SuperView?.Frame.Right - Frame.X > Frame.Width)
                 {
-                    Point s = ViewportToScreen (new Point (Frame.Width - 2, i));
-                    Driver.Move (s.X, s.Y);
-                    Driver.AddRune (Glyphs.RightTee);
+                    AddRune (Frame.Width - 2, i, Glyphs.RightTee);
                 }
 
                 continue;
@@ -572,6 +568,7 @@ private void Top_DrawComplete (object? sender, DrawEventArgs e)
                     // The shortcut tag string
                     if (!string.IsNullOrEmpty (item.ShortcutTag))
                     {
+
                         Driver.Move (screen.X + l - item.ShortcutTag.GetColumns (), screen.Y);
                         Driver.AddStr (item.ShortcutTag);
                     }

UICatalog/Scenarios/AdvancedClipping.cs

@@ -22,7 +22,7 @@ public override void Main ()
 
         app.DrawingContent += (s, e) =>
                            {
-                               Application.Driver?.FillRect (app.ViewportToScreen (app.Viewport), CM.Glyphs.Dot);
+                               app!.FillRect (app!.Viewport, CM.Glyphs.Dot);
                                e.Cancel = true;
                            };
 

UICatalog/Scenarios/CharacterMap.cs

@@ -695,7 +695,7 @@ protected override bool OnDrawingContent ()
 
         SetAttribute (GetHotNormalColor ());
         Move (0, 0);
-        Driver.AddStr (new (' ', RowLabelWidth + 1));
+        AddStr (new (' ', RowLabelWidth + 1));
 
         int firstColumnX = RowLabelWidth - Viewport.X;
 
@@ -708,11 +708,11 @@ protected override bool OnDrawingContent ()
             {
                 Move (x, 0);
                 SetAttribute (GetHotNormalColor ());
-                Driver.AddStr (" ");
+                AddStr (" ");
                 SetAttribute (HasFocus && cursorCol + firstColumnX == x ? ColorScheme.HotFocus : GetHotNormalColor ());
-                Driver.AddStr ($"{hexDigit:x}");
+                AddStr ($"{hexDigit:x}");
                 SetAttribute (GetHotNormalColor ());
-                Driver.AddStr (" ");
+                AddStr (" ");
             }
         }
 
@@ -799,7 +799,7 @@ protected override bool OnDrawingContent ()
                 {
                     // Draw the width of the rune
                     SetAttribute (ColorScheme.HotNormal);
-                    Driver.AddStr ($"{width}");
+                    AddStr ($"{width}");
                 }
 
                 // If we're at the cursor position, and we don't have focus, revert the colors to normal
@@ -816,11 +816,11 @@ protected override bool OnDrawingContent ()
 
             if (!ShowGlyphWidths || (y + Viewport.Y) % _rowHeight > 0)
             {
-                Driver.AddStr ($"U+{val / 16:x5}_ ");
+                AddStr ($"U+{val / 16:x5}_ ");
             }
             else
             {
-                Driver.AddStr (new (' ', RowLabelWidth));
+                AddStr (new (' ', RowLabelWidth));
             }
         }
 

UICatalog/Scenarios/ShadowStyles.cs

@@ -45,7 +45,7 @@ public override void Main ()
 
         app.DrawingContent += (s, e) =>
                            {
-                               Application.Driver?.FillRect (app.ViewportToScreen (app.Viewport), CM.Glyphs.Dot);
+                               app!.FillRect (app!.Viewport, CM.Glyphs.Dot);
                                e.Cancel = true;
                            };
 

UICatalog/Scenarios/SimpleDialog.cs

@@ -21,7 +21,7 @@ public override void Main ()
 
         appWindow.DrawingText += (s, e) =>
                                  {
-                                     Application.Driver?.FillRect (appWindow.ViewportToScreen (appWindow.Viewport), '*');
+                                     appWindow!.FillRect (appWindow!.Viewport, CM.Glyphs.Dot);
                                      e.Cancel = true;
                                  };
 

UICatalog/Scenarios/TextEffectsScenario.cs

@@ -180,7 +180,7 @@ private void CenterText (string text, int xOffset, int yOffset)
         int x = xOffset + (GRADIENT_WIDTH - width) / 2; // Center the text within the gradient area width
         SetAttribute (GetNormalColor ());
         Move (x, yOffset + 1);
-        Driver.AddStr (text);
+        AddStr (text);
     }
 
     private void DrawGradientArea (GradientDirection direction, int xOffset, int yOffset)