Add support for OSC 22 control sequence to change mouse cursor shape

mux/src/localpane.rs

@@ -137,6 +137,14 @@ pub struct LocalPane {
 
 #[async_trait(?Send)]
 impl Pane for LocalPane {
+    fn get_mouse_cursor_shape(&self) -> Option<String> {
+        self.terminal.lock().get_mouse_cursor_shape()
+    }
+
+    fn clear_mouse_cursor_shape(&self) {
+        self.terminal.lock().clear_mosue_cursor_shape();
+    }
+
     fn pane_id(&self) -> PaneId {
         self.pane_id
     }

mux/src/pane.rs

@@ -231,6 +231,9 @@ pub trait Pane: Downcast + Send + Sync {
     /// Returns render related dimensions
     fn get_dimensions(&self) -> RenderableDimensions;
 
+    fn get_mouse_cursor_shape(&self) -> Option<String>;
+    fn clear_mouse_cursor_shape(&self);
+
     fn get_title(&self) -> String;
     fn send_paste(&self, text: &str) -> anyhow::Result<()>;
     fn reader(&self) -> anyhow::Result<Option<Box<dyn std::io::Read + Send>>>;
@@ -550,6 +553,14 @@ mod test {
     }
 
     impl Pane for FakePane {
+        fn get_mouse_cursor_shape(&self) -> Option<String> {
+            unimplemented!()
+        }
+
+        fn clear_mouse_cursor_shape(&self) {
+            unimplemented!();
+        }
+
         fn pane_id(&self) -> PaneId {
             unimplemented!()
         }

mux/src/tab.rs

@@ -2222,6 +2222,14 @@ mod test {
     }
 
     impl Pane for FakePane {
+        fn get_mouse_cursor_shape(&self) -> Option<String> {
+            unimplemented!();
+        }
+
+        fn clear_mouse_cursor_shape(&self) {
+            unimplemented!();
+        }
+
         fn pane_id(&self) -> PaneId {
             self.id
         }

mux/src/termwiztermtab.rs

@@ -126,6 +126,12 @@ impl TermWizTerminalPane {
 }
 
 impl Pane for TermWizTerminalPane {
+    fn get_mouse_cursor_shape(&self) -> Option<String> {
+        None
+    }
+
+    fn clear_mouse_cursor_shape(&self) {}
+
     fn pane_id(&self) -> PaneId {
         self.pane_id
     }

term/src/terminal.rs

@@ -51,6 +51,8 @@ pub enum Alert {
     TabTitleChanged(Option<String>),
     /// When the color palette has been updated
     PaletteChanged,
+    /// When the mouse cursor shape has been updated
+    MouseCursorShapeChanged,
     /// A UserVar has changed value
     SetUserVar {
         name: String,

term/src/terminalstate/mod.rs

@@ -342,6 +342,9 @@ pub struct TerminalState {
 
     palette: Option<ColorPalette>,
 
+    /// The mouse cursor shape (OSC 22)
+    mouse_cursor_shape: Option<String>,
+
     pixel_width: usize,
     pixel_height: usize,
     dpi: u32,
@@ -547,6 +550,7 @@ impl TerminalState {
             any_event_mouse: false,
             button_event_mouse: false,
             mouse_tracking: false,
+            mouse_cursor_shape: None,
             last_mouse_move: None,
             cursor_visible: true,
             g0_charset: CharSet::Ascii,
@@ -665,6 +669,16 @@ impl TerminalState {
             .unwrap_or_else(|| self.config.color_palette())
     }
 
+    /// Returns a copy of the current mouse cursor shape.
+    pub fn get_mouse_cursor_shape(&self) -> Option<String> {
+        self.mouse_cursor_shape.clone()
+    }
+
+    /// Clears the mouse cursor shape.
+    pub fn clear_mosue_cursor_shape(&mut self) {
+        self.mouse_cursor_shape = None;
+    }
+
     /// Called in response to dynamic color scheme escape sequences.
     /// Will make a copy of the palette from the config file if this
     /// is the first of these escapes we've seen.
@@ -927,6 +941,12 @@ impl TerminalState {
         }
     }
 
+    fn mouse_cursor_shape_did_change(&mut self) {
+        if let Some(handler) = self.alert_handler.as_mut() {
+            handler.alert(Alert::MouseCursorShapeChanged);
+        }
+    }
+
     /// When dealing with selection, mark a range of lines as dirty
     pub fn make_all_lines_dirty(&mut self) {
         let seqno = self.seqno;

term/src/terminalstate/performer.rs

@@ -678,6 +678,7 @@ impl<'a> Performer<'a> {
                 self.focus_tracking = false;
                 self.mouse_tracking = false;
                 self.mouse_encoding = MouseEncoding::X10;
+                self.mouse_cursor_shape = None;
                 self.keyboard_encoding = KeyboardEncoding::Xterm;
                 self.sixel_scrolls_right = false;
                 self.any_event_mouse = false;
@@ -704,6 +705,7 @@ impl<'a> Performer<'a> {
                 self.erase_in_display(EraseInDisplay::EraseScrollback);
                 self.erase_in_display(EraseInDisplay::EraseDisplay);
                 self.palette_did_change();
+                self.mouse_cursor_shape_did_change();
             }
 
             _ => {
@@ -718,6 +720,10 @@ impl<'a> Performer<'a> {
         self.pop_tmux_title_state();
         self.flush_print();
         match osc {
+            OperatingSystemCommand::SetMouseCursorShape(mouse_shape) => {
+                self.mouse_cursor_shape = Some(mouse_shape);
+                self.mouse_cursor_shape_did_change();
+            }
             OperatingSystemCommand::SetIconNameSun(title)
             | OperatingSystemCommand::SetIconName(title) => {
                 if title.is_empty() {

termwiz/src/escape/osc.rs

@@ -38,6 +38,7 @@ pub enum OperatingSystemCommand {
     QuerySelection(Selection),
     SetSelection(Selection, String),
     SystemNotification(String),
+    SetMouseCursorShape(String),
     ITermProprietary(ITermProprietary),
     FinalTermSemanticPrompt(FinalTermSemanticPrompt),
     ChangeColorNumber(Vec<ChangeColorPair>),
@@ -312,6 +313,7 @@ impl OperatingSystemCommand {
             SetHyperlink => Ok(OperatingSystemCommand::SetHyperlink(Hyperlink::parse(osc)?)),
             ManipulateSelectionData => Self::parse_selection(osc),
             SystemNotification => single_string!(SystemNotification),
+            SetMouseCursorShape => single_string!(SetMouseCursorShape),
             SetCurrentWorkingDirectory => single_string!(CurrentWorkingDirectory),
             ITermProprietary => {
                 self::ITermProprietary::parse(osc).map(OperatingSystemCommand::ITermProprietary)
@@ -419,6 +421,7 @@ osc_entries!(
     SetHighlightBackgroundColor = "17",
     SetTektronixCursorColor = "18",
     SetHighlightForegroundColor = "19",
+    SetMouseCursorShape = "22",
     SetLogFileName = "46",
     SetFont = "50",
     EmacsShell = "51",
@@ -509,6 +512,7 @@ impl Display for OperatingSystemCommand {
             QuerySelection(s) => write!(f, "52;{};?", s)?,
             SetSelection(s, val) => write!(f, "52;{};{}", s, base64_encode(val))?,
             SystemNotification(s) => write!(f, "9;{}", s)?,
+            SetMouseCursorShape(s) => write!(f, "22;{}", s)?,
             ITermProprietary(i) => i.fmt(f)?,
             FinalTermSemanticPrompt(i) => i.fmt(f)?,
             ResetColors(colors) => {
@@ -1362,6 +1366,24 @@ mod test {
         );
     }
 
+    #[test]
+    fn mouse_cursor_shape() {
+        assert_eq!(
+            parse(&["22", "pointer"], "\x1b]22;pointer\x1b\\"),
+            OperatingSystemCommand::SetMouseCursorShape("pointer".into())
+        );
+
+        assert_eq!(
+            parse(&["22", "default"], "\x1b]22;default\x1b\\"),
+            OperatingSystemCommand::SetMouseCursorShape("default".into())
+        );
+
+        assert_eq!(
+            parse(&["22", ""], "\x1b]22;\x1b\\"),
+            OperatingSystemCommand::SetMouseCursorShape("".into())
+        );
+    }
+
     #[test]
     fn hyperlink() {
         assert_eq!(

wezterm-client/src/pane/clientpane.rs

@@ -245,6 +245,12 @@ impl ClientPane {
 
 #[async_trait(?Send)]
 impl Pane for ClientPane {
+    fn get_mouse_cursor_shape(&self) -> Option<String> {
+        None
+    }
+
+    fn clear_mouse_cursor_shape(&self) {}
+
     fn pane_id(&self) -> PaneId {
         self.local_pane_id
     }

wezterm-gui/src/frontend.rs

@@ -143,6 +143,7 @@ impl GuiFrontEnd {
                     alert:
                         Alert::OutputSinceFocusLost
                         | Alert::PaletteChanged
+                        | Alert::MouseCursorShapeChanged
                         | Alert::CurrentWorkingDirectoryChanged
                         | Alert::WindowTitleChanged(_)
                         | Alert::TabTitleChanged(_)

wezterm-gui/src/overlay/copy.rs

@@ -1101,6 +1101,12 @@ impl CopyRenderable {
 }
 
 impl Pane for CopyOverlay {
+    fn get_mouse_cursor_shape(&self) -> Option<String> {
+        None
+    }
+
+    fn clear_mouse_cursor_shape(&self) {}
+
     fn pane_id(&self) -> PaneId {
         self.delegate.pane_id()
     }

wezterm-gui/src/overlay/quickselect.rs

@@ -317,6 +317,12 @@ impl QuickSelectOverlay {
 }
 
 impl Pane for QuickSelectOverlay {
+    fn get_mouse_cursor_shape(&self) -> Option<String> {
+        None
+    }
+
+    fn clear_mouse_cursor_shape(&self) {}
+
     fn pane_id(&self) -> PaneId {
         self.delegate.pane_id()
     }

wezterm-gui/src/termwindow/mod.rs

@@ -1209,6 +1209,12 @@ impl TermWindow {
                 } => {
                     self.update_title();
                 }
+                MuxNotification::Alert {
+                    alert: Alert::MouseCursorShapeChanged,
+                    pane_id,
+                } => {
+                    self.mux_pane_output_event(pane_id);
+                }
                 MuxNotification::Alert {
                     alert: Alert::PaletteChanged,
                     pane_id,
@@ -1519,6 +1525,12 @@ impl TermWindow {
             } => {
                 // fall through
             }
+            MuxNotification::Alert {
+                alert: Alert::MouseCursorShapeChanged { .. },
+                ..
+            } => {
+                // fall through
+            }
         }
 
         window.notify(TermWindowNotif::MuxNotification(n));
@@ -3528,6 +3540,16 @@ impl TermWindow {
     }
 }
 
+fn parse_mouse_cursor_shape(mouse_cursor_shape: &str) -> MouseCursor {
+    match mouse_cursor_shape {
+        "pointer" => MouseCursor::Hand,
+        "text" => MouseCursor::Text,
+        "row-resize" | "ns-resize" => MouseCursor::SizeUpDown,
+        "col-resize" | "ew-resize" => MouseCursor::SizeLeftRight,
+        _ => MouseCursor::Arrow,
+    }
+}
+
 impl Drop for TermWindow {
     fn drop(&mut self) {
         self.clear_all_overlays();

wezterm-gui/src/termwindow/mouseevent.rs

@@ -1,6 +1,7 @@
 use crate::tabbar::TabBarItem;
 use crate::termwindow::{
-    GuiWin, MouseCapture, PositionedSplit, ScrollHit, TermWindowNotif, UIItem, UIItemType, TMB,
+    parse_mouse_cursor_shape, GuiWin, MouseCapture, PositionedSplit, ScrollHit, TermWindowNotif,
+    UIItem, UIItemType, TMB,
 };
 use ::window::{
     MouseButtons as WMB, MouseCursor, MouseEvent, MouseEventKind as WMEK, MousePress,
@@ -837,7 +838,17 @@ impl super::TermWindow {
             // When hovering over a hyperlink, show an appropriate
             // mouse cursor to give the cue that it is clickable
             MouseCursor::Hand
-        } else if pane.is_mouse_grabbed() || outside_window {
+        } else if outside_window {
+            MouseCursor::Arrow
+        } else if let Some(shape) = pane.get_mouse_cursor_shape() {
+            if pane.is_mouse_grabbed() {
+                parse_mouse_cursor_shape(shape.as_str())
+            } else {
+                // If the mouse is no longer grabbed by a TUI, reset the cursor shape.
+                pane.clear_mouse_cursor_shape();
+                MouseCursor::Arrow
+            }
+        } else if pane.is_mouse_grabbed() {
             MouseCursor::Arrow
         } else {
             MouseCursor::Text