Fixes #3692++ - Rearchitects drivers

[tznind]

Creates new drivers that are simpler versions of existing WindowsDriver and NetDriver. Also introduces a shared architecture such that only subcomponents vary between driver implementations, as discussed in #3821 .

After a period of shared execution with both sets of drivers available we will fix any bugs and then retire the old drivers.

Curses driver is not tackled, I am hopeful it can be retired completely now that net input is so strong and well implemented in core dotnet framework.

Fixes

• Fixes Using Console.WriteLine before Application.Init breaks resizing in WSL #3920
• Fixes Pressing Alt+any key closes app when using NetDriver #3916
• Fixes Slow keyboard #3904
• Fixes Comprehensive Logging and Metrics (Opt in) #3892
• Fixes Refactoring, cleanup, and abstraction for ConsoleDrivers #3692
• Fixes Refactor ConsoleDriver to minimize duplicated code in all drivers #2319
• Fixes Harden EscSeqUtils  #2803
• Fixes Refactor ConsoleDrivers to support ANSI sequences natively (e.g. Virtual Terminal Sequences on Windows) #2610
• Might fix Mouse API makes it way too hard to track button pressed #3312
• Might fix Mouse doubleclick stops continous pressed events. #3404
• Might fix Not always getting Button1Clicked events on Netdriver or CursesDriver #3374

Metrics

You can now see metrics on ant Terminal.Gui program by using its exe name and a metrics tool e.g.

 dotnet-counters monitor -n UICatalog --counters Terminal.Gui

Implementation uses System.Diagnostics.Metrics making it integrate easily with tools such as OpenTelemetry

Logging

You can enable logging of internals of Terminal.Gui by setting Logging.Logger to any Microsoft.Extensions.Logging compatible logging framework (nlog, serilog etc).

Naturally you must not use a console logger

For example with Serilog to a file:

Logging.Logger = CreateLogger ();

...

private static ILogger CreateLogger ()
{
	// Configure Serilog to write logs to a file
	Log.Logger = new LoggerConfiguration ()
				 .MinimumLevel.Verbose () // Verbose includes Trace and Debug
				 .WriteTo.File ("logs/logfile.txt", rollingInterval: RollingInterval.Day)
				 .CreateLogger ();

	// Create a logger factory compatible with Microsoft.Extensions.Logging
	using var loggerFactory = LoggerFactory.Create (builder =>
						{
							builder
								.AddSerilog (dispose: true) // Integrate Serilog with ILogger
								.SetMinimumLevel (LogLevel.Trace); // Set minimum log level
						});
	// Get an ILogger instance
	return loggerFactory.CreateLogger ("Global Logger");
}

Class Diagram

Progress

• Keyboard
  • Exit
  • Typing
  • Backspace
• Views
  • Run/RequestStop
  • MenuBar
• Mouse (see MouseInterpreter)
  • Button 1 click
  • Multi clicks
  • All buttons
  • Scroll wheel
• Other
  • Clipboard

Proposed Changes/Todos

Splits drivers up into logical components, simplifies and centralizes shared code patterns.

Pull Request checklist:

• I've named my PR in the form of "Fixes #issue. Terse description."
• My code follows the style guidelines of Terminal.Gui - if you use Visual Studio, hit CTRL-K-D to automatically reformat your files before committing.
• My code follows the Terminal.Gui library design guidelines
• I ran dotnet test before commit
• I have made corresponding changes to the API documentation (using /// style comments)
• My changes generate no new warnings
• I have checked my code and corrected any poor grammar or misspellings
• I conducted basic QA to assure all features are working

[tig]

Hope you're ok with me updating the title & first post...

[tznind]

Hope you're ok with me updating the title & first post...

No problem! Always appreciate a clear naming

Now we have fledgling support for

• Keyboard
• Mouse
• Screen size

Net (i.e. native dotnet) and Windows (i.e win 32 api) are the two implementations - I assume we can drop curses and don't need to port?

[tig]

Looking great! Just a few asks...

[tznind]

Merge conflict fixed

[tig]

I want to merge this, but we keep getting unit test failures (see #3930).

likely not due to this PR, but I'm not going to merge until this passes at least once. I just restarted the action....