From a6aad756e5a38c777ac2e7ac7161fb4aea07473e Mon Sep 17 00:00:00 2001
From: Chris Marchesi <chrism@vancluevertech.com>
Date: Sat, 16 Dec 2023 22:21:44 -0800
Subject: [PATCH] Surface: ensure keyToMouseShape respects hidden state

This fixes keyToMouseShape (the new handler for mouse shape state for
key combinations, e.g. during mouse tracking override or rectangle
select) so that it respects whether or not the mouse is currently
hidden, and will not send back a shape to change the mouse to in these
situations.

Fixes #1107.
---
 src/Surface.zig       |  1 +
 src/surface_mouse.zig | 36 +++++++++++++++++++++++++++++++++---
 2 files changed, 34 insertions(+), 3 deletions(-)

diff --git a/src/Surface.zig b/src/Surface.zig
index 9e3e39708..f79818738 100644
--- a/src/Surface.zig
+++ b/src/Surface.zig
@@ -1294,6 +1294,7 @@ pub fn keyCallback(
         .mouse_shape = self.io.terminal.mouse_shape,
         .mods = self.mouse.mods,
         .over_link = self.mouse.over_link,
+        .hidden = self.mouse.hidden,
     }).keyToMouseShape()) |shape|
         try self.rt_surface.setMouseShape(shape);
 
diff --git a/src/surface_mouse.zig b/src/surface_mouse.zig
index f04898d32..2ba88540c 100644
--- a/src/surface_mouse.zig
+++ b/src/surface_mouse.zig
@@ -29,6 +29,9 @@ mods: input.Mods,
 /// True if the mouse position is currently over a link.
 over_link: bool,
 
+/// True if the mouse pointer is currently hidden.
+hidden: bool,
+
 /// Translates key state to mouse shape (cursor) state, based on a state
 /// machine.
 ///
@@ -52,11 +55,11 @@ pub fn keyToMouseShape(self: SurfaceMouse) ?MouseShape {
     // Filter for appropriate key events
     if (!eligibleMouseShapeKeyEvent(self.physical_key)) return null;
 
-    // Exception: link hover overrides any other shape processing currently and
-    // does not change state.
+    // Exceptions: link hover or hidden state overrides any other shape
+    // processing and does not change state.
     //
     // TODO: As we unravel mouse state, we can fix this to be more explicit.
-    if (self.over_link) {
+    if (self.over_link or self.hidden) {
         return null;
     }
 
@@ -129,6 +132,7 @@ test "keyToMouseShape" {
             .mouse_shape = .progress,
             .mods = .{},
             .over_link = false,
+            .hidden = false,
         };
 
         const got = m.keyToMouseShape();
@@ -144,6 +148,22 @@ test "keyToMouseShape" {
             .mouse_shape = .progress,
             .mods = .{},
             .over_link = true,
+            .hidden = false,
+        };
+
+        const got = m.keyToMouseShape();
+        try testing.expect(got == null);
+    }
+
+    {
+        // Mouse is currently hidden
+        const m: SurfaceMouse = .{
+            .physical_key = .left_shift,
+            .mouse_event = .none,
+            .mouse_shape = .progress,
+            .mods = .{},
+            .over_link = true,
+            .hidden = true,
         };
 
         const got = m.keyToMouseShape();
@@ -158,6 +178,7 @@ test "keyToMouseShape" {
             .mouse_shape = .default,
             .mods = .{},
             .over_link = false,
+            .hidden = false,
         };
 
         const want: MouseShape = .default;
@@ -173,6 +194,7 @@ test "keyToMouseShape" {
             .mouse_shape = .default,
             .mods = .{ .ctrl = true, .super = true, .alt = true, .shift = true },
             .over_link = false,
+            .hidden = false,
         };
 
         const want: MouseShape = .crosshair;
@@ -188,6 +210,7 @@ test "keyToMouseShape" {
             .mouse_shape = .default,
             .mods = .{ .shift = true },
             .over_link = false,
+            .hidden = false,
         };
 
         const want: MouseShape = .text;
@@ -203,6 +226,7 @@ test "keyToMouseShape" {
             .mouse_shape = .crosshair,
             .mods = .{ .shift = true },
             .over_link = false,
+            .hidden = false,
         };
 
         const want: MouseShape = .text;
@@ -218,6 +242,7 @@ test "keyToMouseShape" {
             .mouse_shape = .crosshair,
             .mods = .{},
             .over_link = false,
+            .hidden = false,
         };
 
         const want: MouseShape = .default;
@@ -233,6 +258,7 @@ test "keyToMouseShape" {
             .mouse_shape = .text,
             .mods = .{ .ctrl = true, .super = true, .alt = true, .shift = true },
             .over_link = false,
+            .hidden = false,
         };
 
         const want: MouseShape = .crosshair;
@@ -248,6 +274,7 @@ test "keyToMouseShape" {
             .mouse_shape = .text,
             .mods = .{},
             .over_link = false,
+            .hidden = false,
         };
 
         const want: MouseShape = .default;
@@ -263,6 +290,7 @@ test "keyToMouseShape" {
             .mouse_shape = .text,
             .mods = .{},
             .over_link = false,
+            .hidden = false,
         };
 
         const want: MouseShape = .text;
@@ -278,6 +306,7 @@ test "keyToMouseShape" {
             .mouse_shape = .text,
             .mods = .{ .ctrl = true, .super = true, .alt = true },
             .over_link = false,
+            .hidden = false,
         };
 
         const want: MouseShape = .crosshair;
@@ -293,6 +322,7 @@ test "keyToMouseShape" {
             .mouse_shape = .crosshair,
             .mods = .{},
             .over_link = false,
+            .hidden = false,
         };
 
         const want: MouseShape = .text;