Adds ANSIDriver to replace WindowsDriver (use Console Virtual Terminal Sequences)

Terminal.Gui/NativeMethods.txt

@@ -0,0 +1 @@
+Windows.Win32.System.Console

Terminal.Gui/Terminal.Gui.csproj

@@ -38,6 +38,9 @@
  <!-- Dependencies -->
  <!-- =================================================================== -->
  <ItemGroup>
+ <PackageReference Include="Microsoft.Windows.CsWin32" Version="0.3.49-beta">
+ <PrivateAssets>all</PrivateAssets>
+ </PackageReference>
  <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.3" PrivateAssets="all" />
  <PackageReference Include="System.IO.Abstractions" Version="20.0.4" />
  <PackageReference Include="System.Text.Json" Version="8.0.1" />

UICatalog/Properties/launchSettings.json

@@ -7,6 +7,10 @@
  "commandName": "Project",
  "commandLineArgs": "--driver NetDriver"
  },
+ "UICatalog --driver ANSIDriver": {
+ "commandName": "Project",
+ "commandLineArgs": "--driver ANSIDriver"
+ },
  "UICatalog --driver WindowsDriver": {
  "commandName": "Project",
  "commandLineArgs": "--driver WindowsDriver"

UnitTests/ConsoleDrivers/AddRuneTests.cs

@@ -20,7 +20,7 @@ public AddRuneTests (ITestOutputHelper output)
  [Theory]
  [InlineData (typeof (FakeDriver))]
  [InlineData (typeof (NetDriver))]
- //[InlineData (typeof (ANSIDriver))]
+ [InlineData (typeof (ANSIDriver))]
  [InlineData (typeof (WindowsDriver))]
  [InlineData (typeof (CursesDriver))]
  public void AddRune (Type driverType)

UnitTests/ConsoleDrivers/ClipRegionTests.cs

@@ -14,24 +14,24 @@ namespace Terminal.Gui.DriverTests;
 public class ClipRegionTests {
  readonly ITestOutputHelper output;
 
- public ClipRegionTests (ITestOutputHelper output)
- {
- ConsoleDriver.RunningUnitTests = true;
- this.output = output;
- }
-
- [Theory]
- [InlineData (typeof (FakeDriver))]
- [InlineData (typeof (NetDriver))]
- //[InlineData (typeof (ANSIDriver))]
- [InlineData (typeof (WindowsDriver))]
- [InlineData (typeof (CursesDriver))]
- public void IsValidLocation (Type driverType)
- {
- var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
- Application.Init (driver);
- Application.Driver.Rows = 10;
- Application.Driver.Cols = 10;
+  public ClipRegionTests (ITestOutputHelper output)
+  {
+  ConsoleDriver.RunningUnitTests = true;
+  this.output = output;
+  }
+ 
+  [Theory]
+  [InlineData (typeof (FakeDriver))]
+  [InlineData (typeof (NetDriver))]
+  [InlineData (typeof (ANSIDriver))]
+  [InlineData (typeof (WindowsDriver))]
+  [InlineData (typeof (CursesDriver))]
+  public void IsValidLocation (Type driverType)
+  {
+  var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
+  Application.Init (driver);
+  Application.Driver.Rows = 10;
+  Application.Driver.Cols = 10;
 
  // positive
  Assert.True (driver.IsValidLocation (0, 0));
@@ -65,16 +65,16 @@ public void IsValidLocation (Type driverType)
  Application.Shutdown ();
  }
 
- [Theory]
- [InlineData (typeof (FakeDriver))]
- [InlineData (typeof (NetDriver))]
- //[InlineData (typeof (ANSIDriver))]
- [InlineData (typeof (WindowsDriver))]
- [InlineData (typeof (CursesDriver))]
- public void Clip_Set_To_Empty_AllInvalid (Type driverType)
- {
- var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
- Application.Init (driver);
+  [Theory]
+  [InlineData (typeof (FakeDriver))]
+  [InlineData (typeof (NetDriver))]
+  [InlineData (typeof (ANSIDriver))]
+  [InlineData (typeof (WindowsDriver))]
+  [InlineData (typeof (CursesDriver))]
+  public void Clip_Set_To_Empty_AllInvalid (Type driverType)
+  {
+  var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
+  Application.Init (driver);
 
  // Define a clip rectangle
  driver.Clip = Rect.Empty;
@@ -94,18 +94,18 @@ public void Clip_Set_To_Empty_AllInvalid (Type driverType)
  Application.Shutdown ();
  }
 
- [Theory]
- [InlineData (typeof (FakeDriver))]
- [InlineData (typeof (NetDriver))]
- //[InlineData (typeof (ANSIDriver))]
- [InlineData (typeof (WindowsDriver))]
- [InlineData (typeof (CursesDriver))]
- public void AddRune_Is_Clipped (Type driverType)
- {
- var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
- Application.Init (driver);
- Application.Driver.Rows = 25;
- Application.Driver.Cols = 80;
+  [Theory]
+  [InlineData (typeof (FakeDriver))]
+  [InlineData (typeof (NetDriver))]
+  [InlineData (typeof (ANSIDriver))]
+  [InlineData (typeof (WindowsDriver))]
+  [InlineData (typeof (CursesDriver))]
+  public void AddRune_Is_Clipped (Type driverType)
+  {
+  var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
+  Application.Init (driver);
+  Application.Driver.Rows = 25;
+  Application.Driver.Cols = 80;
 
  driver.Move (0, 0);
  driver.AddRune ('x');

UnitTests/ConsoleDrivers/ConsoleDriverTests.cs

@@ -19,38 +19,38 @@ public ConsoleDriverTests (ITestOutputHelper output)
  this.output = output;
  }
 
- [Theory]
- [InlineData (typeof (FakeDriver))]
- [InlineData (typeof (NetDriver))]
- //[InlineData (typeof (ANSIDriver))]
- [InlineData (typeof (WindowsDriver))]
- [InlineData (typeof (CursesDriver))]
- public void Init_Inits (Type driverType)
- {
- var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
- var ml = driver.Init ();
- Assert.NotNull (ml);
- Assert.NotNull (driver.Clipboard);
- Console.ForegroundColor = ConsoleColor.Red;
- Assert.Equal (ConsoleColor.Red, Console.ForegroundColor);
- Console.BackgroundColor = ConsoleColor.Green;
- Assert.Equal (ConsoleColor.Green, Console.BackgroundColor);
+  [Theory]
+  [InlineData (typeof (FakeDriver))]
+  [InlineData (typeof (NetDriver))]
+  [InlineData (typeof (ANSIDriver))]
+  [InlineData (typeof (WindowsDriver))]
+  [InlineData (typeof (CursesDriver))]
+  public void Init_Inits (Type driverType)
+  {
+  var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
+  var ml = driver.Init ();
+  Assert.NotNull (ml);
+  Assert.NotNull (driver.Clipboard);
+  Console.ForegroundColor = ConsoleColor.Red;
+  Assert.Equal (ConsoleColor.Red, Console.ForegroundColor);
+  Console.BackgroundColor = ConsoleColor.Green;
+  Assert.Equal (ConsoleColor.Green, Console.BackgroundColor);
 
  driver.End ();
  }
 
- [Theory]
- [InlineData (typeof (FakeDriver))]
- [InlineData (typeof (NetDriver))]
- //[InlineData (typeof (ANSIDriver))]
- [InlineData (typeof (WindowsDriver))]
- [InlineData (typeof (CursesDriver))]
- public void End_Cleans_Up (Type driverType)
- {
- var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
- driver.Init ();
- driver.End ();
- }
+  [Theory]
+  [InlineData (typeof (FakeDriver))]
+  [InlineData (typeof (NetDriver))]
+  [InlineData (typeof (ANSIDriver))]
+  [InlineData (typeof (WindowsDriver))]
+  [InlineData (typeof (CursesDriver))]
+  public void End_Cleans_Up (Type driverType)
+  {
+  var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
+  driver.Init ();
+  driver.End ();
+  }
 
  [Theory]
  [InlineData (typeof (FakeDriver))]
@@ -184,29 +184,29 @@ public void FakeDriver_MockKeyPresses (Type driverType)
 
  // Application.Run ();
 
- // // Shutdown must be called to safely clean up Application if Init has been called
- // Application.Shutdown ();
- //}
-
- [Theory]
- [InlineData (typeof (FakeDriver))]
- [InlineData (typeof (NetDriver))]
- //[InlineData (typeof (ANSIDriver))]
- [InlineData (typeof (WindowsDriver))]
- [InlineData (typeof (CursesDriver))]
- public void TerminalResized_Simulation (Type driverType)
- {
- var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
- driver?.Init ();
- driver.Cols = 80;
- driver.Rows = 25;
-
- bool wasTerminalResized = false;
- driver.SizeChanged += (s, e) => {
- wasTerminalResized = true;
- Assert.Equal (120, e.Size.Width);
- Assert.Equal (40, e.Size.Height);
- };
+  // // Shutdown must be called to safely clean up Application if Init has been called
+  // Application.Shutdown ();
+  //}
+ 
+  [Theory]
+  [InlineData (typeof (FakeDriver))]
+  [InlineData (typeof (NetDriver))]
+  [InlineData (typeof (ANSIDriver))]
+  [InlineData (typeof (WindowsDriver))]
+  [InlineData (typeof (CursesDriver))]
+  public void TerminalResized_Simulation (Type driverType)
+  {
+  var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
+  driver?.Init ();
+  driver.Cols = 80;
+  driver.Rows = 25;
+ 
+  var wasTerminalResized = false;
+  driver.SizeChanged += (s, e) => {
+  wasTerminalResized = true;
+  Assert.Equal (120, e.Size.Width);
+  Assert.Equal (40, e.Size.Height);
+  };
 
  Assert.Equal (80, driver.Cols);
  Assert.Equal (25, driver.Rows);

UnitTests/ConsoleDrivers/ConsoleScrolllingTests.cs

@@ -13,22 +13,22 @@ namespace Terminal.Gui.DriverTests;
 public class ConsoleScrollingTests {
  readonly ITestOutputHelper output;
 
- public ConsoleScrollingTests (ITestOutputHelper output)
- {
- ConsoleDriver.RunningUnitTests = true;
- this.output = output;
- }
-
- [Theory]
- [InlineData (typeof (FakeDriver))]
- //[InlineData (typeof (NetDriver))]
- //[InlineData (typeof (ANSIDriver))]
- //[InlineData (typeof (WindowsDriver))]
- //[InlineData (typeof (CursesDriver))]
- public void Left_And_Top_Is_Always_Zero (Type driverType)
- {
- var driver = (FakeDriver)Activator.CreateInstance (driverType);
- Application.Init (driver);
+  public ConsoleScrollingTests (ITestOutputHelper output)
+  {
+  ConsoleDriver.RunningUnitTests = true;
+  this.output = output;
+  }
+
+  [Theory]
+  [InlineData (typeof (FakeDriver))]
+  //[InlineData (typeof (NetDriver))]
+  //[InlineData (typeof (ANSIDriver))]
+  //[InlineData (typeof (WindowsDriver))]
+  //[InlineData (typeof (CursesDriver))]
+  public void Left_And_Top_Is_Always_Zero (Type driverType)
+  {
+  var driver = (FakeDriver)Activator.CreateInstance (driverType);
+  Application.Init (driver);
 
  Assert.Equal (0, Console.WindowLeft);
  Assert.Equal (0, Console.WindowTop);

UnitTests/ConsoleDrivers/ContentsTests.cs

@@ -96,7 +96,7 @@ public void AddStr_With_Combining_Characters (Type driverType)
  [Theory]
  [InlineData (typeof (FakeDriver))]
  [InlineData (typeof (NetDriver))]
- //[InlineData (typeof (ANSIDriver))]
+ [InlineData (typeof (ANSIDriver))]
  [InlineData (typeof (WindowsDriver))]
  [InlineData (typeof (CursesDriver))]
  public void Move_Bad_Coordinates (Type driverType)

UnitTests/ConsoleDrivers/DriverColorTests.cs

@@ -12,8 +12,8 @@ public class DriverColorTests {
  [Theory]
  [InlineData (typeof (FakeDriver))]
  [InlineData (typeof (NetDriver))]
- //[InlineData (typeof (ANSIDriver))]
  [InlineData (typeof (WindowsDriver))]
+ [InlineData (typeof (ANSIDriver))]
  [InlineData (typeof (CursesDriver))]
  public void SetColors_Changes_Colors (Type driverType)
  {
@@ -37,32 +37,32 @@ public void SetColors_Changes_Colors (Type driverType)
  }
 
 
- [Theory]
- [InlineData (typeof (FakeDriver), false)]
- [InlineData (typeof (NetDriver), true)]
- //[InlineData (typeof (ANSIDriver), true)]
- [InlineData (typeof (WindowsDriver), true)]
- [InlineData (typeof (CursesDriver), false)]
- public void SupportsTrueColor_Defaults (Type driverType, bool expectedSetting)
- {
- var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
- driver.Init ();
+  [Theory]
+  [InlineData (typeof (FakeDriver), false)]
+  [InlineData (typeof (NetDriver), true)]
+  [InlineData (typeof (ANSIDriver), true)]
+  [InlineData (typeof (WindowsDriver), true)]
+  [InlineData (typeof (CursesDriver), false)]
+  public void SupportsTrueColor_Defaults (Type driverType, bool expectedSetting)
+  {
+  var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
+  driver.Init ();
 
  Assert.Equal (expectedSetting, driver.SupportsTrueColor);
 
  driver.End ();
  }
 
- [Theory]
- [InlineData (typeof (FakeDriver))]
- [InlineData (typeof (NetDriver))]
- //[InlineData (typeof (ANSIDriver))]
- [InlineData (typeof (WindowsDriver))]
- [InlineData (typeof (CursesDriver))]
- public void Force16Colors_Sets (Type driverType)
- {
- var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
- driver.Init ();
+  [Theory]
+  [InlineData (typeof (FakeDriver))]
+  [InlineData (typeof (NetDriver))]
+  [InlineData (typeof (ANSIDriver))]
+  [InlineData (typeof (WindowsDriver))]
+  [InlineData (typeof (CursesDriver))]
+  public void Force16Colors_Sets (Type driverType)
+  {
+  var driver = (ConsoleDriver)Activator.CreateInstance (driverType);
+  driver.Init ();
 
  driver.Force16Colors = true;
  Assert.True (driver.Force16Colors);