Fixes #4471, #4474, #3714, #2588 - MASSIVE: Refactors Mouse Support

CONTRIBUTING.md

@@ -120,16 +120,15 @@ Welcome! This guide provides everything you need to know to contribute effective
 
 **⚠️ CRITICAL - These rules MUST be followed in ALL new or modified code:**
 
-- **Do NOT add formatting tools** - Use existing `.editorconfig` and `Terminal.sln.DotSettings`
+**AI or AI Agent Written or Modified Code MUST Follow these instructions**
+
+- Use existing `.editorconfig` and `Terminal.sln.DotSettings` to determine code style and formatting.
 - Format code with:
   1. ReSharper/Rider (`Ctrl-E-C`)
   2. JetBrains CleanupCode CLI tool (free)
   3. Visual Studio (`Ctrl-K-D`) as fallback
-- **Only format files you modify**
-- Follow `.editorconfig` settings (e.g., braces on new lines, spaces after keywords)
-- 4-space indentation
-- No trailing whitespace
-- File-scoped namespaces
+- Only format files you modify
+- Follow `.editorconfig` settings
 - **ALWAYS use explicit types** - Never use `var` except for built-in simple types (`int`, `string`, `bool`, `double`, `float`, `decimal`, `char`, `byte`)
   ```csharp
   // ✅ CORRECT - Explicit types
@@ -144,7 +143,6 @@ Welcome! This guide provides everything you need to know to contribute effective
   var args = new MouseEventArgs { Position = new Point(5, 5) };
   var views = new List<View?>();
   ```
-
 - **ALWAYS use target-typed `new ()`** - Use `new ()` instead of `new TypeName()` when the type is already declared
   ```csharp
   // ✅ CORRECT - Target-typed new
@@ -155,8 +153,21 @@ Welcome! This guide provides everything you need to know to contribute effective
   View view = new View() { Width = 10 };
   MouseEventArgs args = new MouseEventArgs();
   ```
+- **ALWAYS** use collection initializers if possible:
+  ```csharp
+  // ✅ CORRECT - Collection initializer
+  List<View> views = [
+      new Button("OK"),
+      new Button("Cancel")
+  ];
+
+  // ❌ WRONG - Adding items separately
+  List<View> views = new ();
+  views.Add(new Button("OK"));
+  views.Add(new Button("Cancel"));
+  ```
 
-**⚠️ CRITICAL - These conventions apply to ALL code - production code, test code, examples, and samples.**
+**⚠️ CRITICAL - These conventions apply to ALL code - production code, test code, examples, documentation, and samples.**
 
 ## Testing Requirements
 
@@ -173,6 +184,8 @@ Welcome! This guide provides everything you need to know to contribute effective
 
 ### Test Patterns
 
+- **AI Created Tests MUST follow these patterns exactly.**
+- **Add comment indicating the test was AI generated** - e.g., `// CoPilot - ChatGPT v4`
 - **Make tests granular** - Each test should cover smallest area possible
 - Follow existing test patterns in respective test projects
 - **Avoid adding new tests to the `UnitTests` Project** - Make them parallelizable and add them to `UnitTests.Parallelizable`
@@ -241,7 +254,7 @@ Welcome! This guide provides everything you need to know to contribute effective
 **`/Terminal.Gui/`** - Core library (496 C# files):
 - `App/` - Application lifecycle (`Application.cs` static class, `SessionToken`, `MainLoop`)
 - `Configuration/` - `ConfigurationManager` for settings
-- `Drivers/` - Console driver implementations (`Dotnet`, `Windows`, `Unix`, `Fake`)
+- `Drivers/` - Console driver implementations (`dotnet`, `Windows`, `Unix`, `ansi`)
 - `Drawing/` - Rendering system (attributes, colors, glyphs)
 - `Input/` - Keyboard and mouse input handling
 - `ViewBase/` - Core `View` class hierarchy and layout

Examples/UICatalog/Properties/launchSettings.json

@@ -12,6 +12,10 @@
       "commandName": "Project",
       "commandLineArgs": "--driver dotnet -dl Trace"
     },
+    "UICatalog --driver ansi": {
+      "commandName": "Project",
+      "commandLineArgs": "--driver ansi -dl Trace"
+    },
     "WSL: UICatalog": {
       "commandName": "Executable",
       "executablePath": "wsl",
@@ -30,6 +34,12 @@
       "commandLineArgs": "dotnet UICatalog.dll --driver unix",
       "distributionName": ""
     },
+    "WSL: UICatalog --driver ansi": {
+      "commandName": "Executable",
+      "executablePath": "wsl",
+      "commandLineArgs": "dotnet UICatalog.dll --driver ansi",
+      "distributionName": ""
+    },
     "WSL-Gnome: UICatalog": {
       "commandName": "Executable",
       "executablePath": "wsl",
@@ -60,6 +70,10 @@
       "commandName": "Project",
       "commandLineArgs": "--driver windows --benchmark"
     },
+    "Benchmark All --driver ansi": {
+      "commandName": "Project",
+      "commandLineArgs": "--driver ansi --benchmark"
+    },
     "WSL: Benchmark All": {
       "commandName": "Executable",
       "executablePath": "wsl",

Examples/UICatalog/Resources/config.json

@@ -137,7 +137,7 @@
       "UI Catalog Theme": {
         "Window.DefaultShadow": "Transparent",
         "Button.DefaultShadow": "None",
-        "CheckBox.DefaultHighlightStates": "In, Pressed, PressedOutside",
+        "CheckBox.DefaultMouseHighlightStates": "In, Pressed, PressedOutside",
         "MessageBox.DefaultButtonAlignment": "Start",
         "StatusBar.DefaultSeparatorLineStyle": "Single",
         "Dialog.DefaultMinimumWidth": 80,
@@ -148,7 +148,7 @@
         "Dialog.DefaultButtonAlignment": "Start",
         "FrameView.DefaultBorderStyle": "Double",
         "MessageBox.DefaultMinimumHeight": 0,
-        "Button.DefaultHighlightStates": "In, Pressed",
+        "Button.DefaultMouseHighlightStates": "In, Pressed",
         "Menu.DefaultBorderStyle": "Heavy",
         "MenuBar.DefaultBorderStyle": "Heavy",
         "Schemes": [

Examples/UICatalog/Scenarios/Adornments.cs

@@ -130,7 +130,7 @@ public override void Main ()
                                       Y = 1,
                                       Text = "_Button in Padding Y = 1",
                                       CanFocus = true,
-                                      HighlightStates = MouseState.None,
+                                      MouseHighlightStates = MouseState.None,
                                   };
                                   btnButtonInPadding.Accepting += (s, e) => MessageBox.Query (appWindow.App, 20, 7, "Hi", "Button in Padding Pressed!", "Ok");
                                   btnButtonInPadding.BorderStyle = LineStyle.Dashed;

Examples/UICatalog/Scenarios/Bars.cs

@@ -187,12 +187,12 @@ void PopOverMenuOnAccept (object o, CommandEventArgs args)
 
         menuLikeExamples.MouseEvent += MenuLikeExamplesMouseEvent;
 
-        void MenuLikeExamplesMouseEvent (object _, MouseEventArgs e)
+        void MenuLikeExamplesMouseEvent (object _, Terminal.Gui.Input.Mouse mouse)
         {
-            if (e.Flags.HasFlag (MouseFlags.Button3Clicked))
+            if (mouse.Flags.HasFlag (MouseFlags.RightButtonClicked))
             {
-                popOverMenu.X = e.Position.X;
-                popOverMenu.Y = e.Position.Y;
+                popOverMenu.X = mouse.Position!.Value.X;
+                popOverMenu.Y = mouse.Position!.Value.Y;
                 popOverMenu.Visible = true;
                 //popOverMenu.Enabled = popOverMenu.Visible;
                 popOverMenu.SetFocus ();
@@ -275,7 +275,7 @@ void MenuLikeExamplesMouseEvent (object _, MouseEventArgs e)
 
     //private void ShowContextMenu (object s, MouseEventEventArgs e)
     //{
-    //    if (e.Flags != MouseFlags.Button3Clicked)
+    //    if (e.Flags != MouseFlags.RightButtonClicked)
     //    {
     //        return;
     //    }
@@ -392,7 +392,7 @@ void MenuLikeExamplesMouseEvent (object _, MouseEventArgs e)
     //        // If user clicks outside of the menuWindow, close it
     //        if (!contextMenu.Frame.Contains (e.Position.X, e.Position.Y))
     //        {
-    //            if (e.Flags is (MouseFlags.Button1Clicked or MouseFlags.Button3Clicked))
+    //            if (e.Flags is (MouseFlags.LeftButtonClicked or MouseFlags.RightButtonClicked))
     //            {
     //                contextMenu.RequestStop ();
     //            }
@@ -415,23 +415,23 @@ private void ConfigMenuBar (Bar bar)
             Title = "_File",
             HelpText = "File Menu",
             Key = Key.D0.WithAlt,
-            HighlightStates = MouseState.In
+            MouseHighlightStates = MouseState.In
         };
 
         var editMenuBarItem = new Shortcut
         {
             Title = "_Edit",
             HelpText = "Edit Menu",
             Key = Key.D1.WithAlt,
-            HighlightStates = MouseState.In
+            MouseHighlightStates = MouseState.In
         };
 
         var helpMenuBarItem = new Shortcut
         {
             Title = "_Help",
             HelpText = "Halp Menu",
             Key = Key.D2.WithAlt,
-            HighlightStates = MouseState.In
+            MouseHighlightStates = MouseState.In
         };
 
         bar.Add (fileMenuBarItem, editMenuBarItem, helpMenuBarItem);
@@ -445,23 +445,23 @@ private void ConfigureMenu (Bar bar)
             Title = "Z_igzag",
             Key = Key.I.WithCtrl,
             Text = "Gonna zig zag",
-            HighlightStates = MouseState.In
+            MouseHighlightStates = MouseState.In
         };
 
         var shortcut2 = new Shortcut
         {
             Title = "Za_G",
             Text = "Gonna zag",
             Key = Key.G.WithAlt,
-            HighlightStates = MouseState.In
+            MouseHighlightStates = MouseState.In
         };
 
         var shortcut3 = new Shortcut
         {
             Title = "_Three",
             Text = "The 3rd item",
             Key = Key.D3.WithAlt,
-            HighlightStates = MouseState.In
+            MouseHighlightStates = MouseState.In
         };
 
         var line = new Line ()
@@ -475,13 +475,13 @@ private void ConfigureMenu (Bar bar)
             Title = "_Four",
             Text = "Below the line",
             Key = Key.D3.WithAlt,
-            HighlightStates = MouseState.In
+            MouseHighlightStates = MouseState.In
         };
 
         shortcut4.CommandView = new CheckBox ()
         {
             Title = shortcut4.Title,
-            HighlightStates = MouseState.None,
+            MouseHighlightStates = MouseState.None,
             CanFocus = false
         };
         // This ensures the checkbox state toggles when the hotkey of Title is pressed.
@@ -523,18 +523,18 @@ public void ConfigStatusBar (Bar bar)
 
         bar.Add (shortcut);
 
-        var button1 = new Button
+        var LeftButton = new Button
         {
             Text = "I'll Hide",
             // Visible = false
         };
-        button1.Accepting += Button_Clicked;
-        bar.Add (button1);
+        LeftButton.Accepting += Button_Clicked;
+        bar.Add (LeftButton);
 
         shortcut.Accepting += (s, e) =>
                                                     {
-                                                        button1.Visible = !button1.Visible;
-                                                        button1.Enabled = button1.Visible;
+                                                        LeftButton.Visible = !LeftButton.Visible;
+                                                        LeftButton.Enabled = LeftButton.Visible;
                                                         e.Handled = true;
                                                     };
 
@@ -545,13 +545,13 @@ public void ConfigStatusBar (Bar bar)
             CanFocus = true
         });
 
-        var button2 = new Button
+        var MiddleButton = new Button
         {
             Text = "Or me!",
         };
-        button2.Accepting += (s, e) => Application.RequestStop ();
+        MiddleButton.Accepting += (s, e) => Application.RequestStop ();
 
-        bar.Add (button2);
+        bar.Add (MiddleButton);
 
         return;
 

Examples/UICatalog/Scenarios/Buttons.cs

@@ -341,7 +341,7 @@ string MoveHotkey (string txt)
         {
             X = 0,
             Y = Pos.Bottom (moveUnicodeHotKeyBtn) + 1,
-            Title = "_Numeric Up/Down (press-and-hold):",
+            Title = "Numeric Up/Down (press-and-_hold):",
         };
 
         var numericUpDown = new NumericUpDown<int>
@@ -360,43 +360,69 @@ void NumericUpDown_ValueChanged (object sender, EventArgs<int> e) { }
         {
             X = 0,
             Y = Pos.Bottom (numericUpDown) + 1,
-            Title = "_No Repeat:"
+            Title = "No Repea_t:"
         };
         var noRepeatAcceptCount = 0;
 
         var noRepeatButton = new Button
         {
             X = Pos.Right (label) + 1,
             Y = Pos.Top (label),
-            Title = $"Accept Cou_nt: {noRepeatAcceptCount}",
-            WantContinuousButtonPressed = false
+            Title = $"Accepting Count: {noRepeatAcceptCount}",
+            MouseHoldRepeat = false
         };
         noRepeatButton.Accepting += (s, e) =>
                                  {
-                                     noRepeatButton.Title = $"Accept Cou_nt: {++noRepeatAcceptCount}";
+                                     noRepeatButton.Title = $"Accepting Count: {++noRepeatAcceptCount}";
+                                     Logging.Trace ("noRepeatButton Button Pressed");
                                      e.Handled = true;
                                  };
         main.Add (label, noRepeatButton);
 
+        label = new ()
+        {
+            X = Pos.Right (noRepeatButton) + 1,
+            Y = Pos.Top (label),
+            Title = "N_o Repeat (no highlight):"
+        };
+        var noRepeatNoHighlightAcceptCount = 0;
+
+        var noRepeatNoHighlight = new Button
+        {
+            X = Pos.Right (label) + 1,
+            Y = Pos.Top (label),
+            Title = $"Accepting Count: {noRepeatNoHighlightAcceptCount}",
+            MouseHoldRepeat = false,
+            MouseHighlightStates = MouseState.None
+        };
+        noRepeatNoHighlight.Accepting += (s, e) =>
+                                         {
+                                             noRepeatNoHighlight.Title = $"Accepting Count: {++noRepeatNoHighlightAcceptCount}";
+                                             Logging.Trace ("noRepeatNoHighlight Button Pressed");
+                                             e.Handled = true;
+                                         };
+        main.Add (label, noRepeatNoHighlight);
+
         label = new ()
         {
             X = 0,
             Y = Pos.Bottom (label) + 1,
-            Title = "_Repeat (press-and-hold):"
+            Title = "Repeat (_press-and-hold):"
         };
-        var acceptCount = 0;
+
+        var repeatButtonAcceptingCount = 0;
 
         var repeatButton = new Button
         {
             Id = "repeatButton",
             X = Pos.Right (label) + 1,
             Y = Pos.Top (label),
-            Title = $"Accept Co_unt: {acceptCount}",
-            WantContinuousButtonPressed = true
+            Title = $"Accepting Count: {repeatButtonAcceptingCount}",
+            MouseHoldRepeat = true
         };
         repeatButton.Accepting += (s, e) =>
                                {
-                                   repeatButton.Title = $"Accept Co_unt: {++acceptCount}";
+                                   repeatButton.Title = $"Accepting Count: {++repeatButtonAcceptingCount}";
                                    e.Handled = true;
                                };
 

Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs

@@ -137,14 +137,14 @@ public override void Main ()
         _categoryList.Activating += (_, e) =>
                                    {
                                        // Only handle mouse clicks
-                                       if (e.Context is not CommandContext<MouseBinding> { Binding.MouseEventArgs: { } mouseArgs })
+                                       if (e.Context is not CommandContext<MouseBinding> { Binding.MouseEventArgs: { } mouse })
                                        {
                                            return;
                                        }
 
-                                       _categoryList.ScreenToCell (mouseArgs.Position, out int? clickedCol);
+                                       _categoryList.ScreenToCell (mouse.Position!.Value, out int? clickedCol);
 
-                                       if (clickedCol != null && mouseArgs.Flags.HasFlag (MouseFlags.Button1Clicked))
+                                       if (clickedCol != null && mouse.Flags.HasFlag (MouseFlags.LeftButtonClicked))
                                        {
                                            EnumerableTableSource<UnicodeRange> table = (EnumerableTableSource<UnicodeRange>)_categoryList.Table;
                                            string prevSelection = table.Data.ElementAt (_categoryList.SelectedRow).Category;

Examples/UICatalog/Scenarios/ContextMenus.cs

@@ -95,7 +95,7 @@ void OnAppWindowOnActivating (object? s, CommandEventArgs e)
         {
             if (e.Context is CommandContext<MouseBinding> { Binding.MouseEventArgs: { } mouseArgs })
             {
-                if (mouseArgs.Flags == MouseFlags.Button3Clicked)
+                if (mouseArgs.Flags == MouseFlags.RightButtonClicked)
                 {
                     // ReSharper disable once AccessToDisposedClosure
                     _winContextMenu?.MakeVisible (mouseArgs.ScreenPosition);