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

mux/src/localpane.rs

@@ -31,8 +31,8 @@ use url::Url;
 use wezterm_dynamic::Value;
 use wezterm_term::color::ColorPalette;
 use wezterm_term::{
-    Alert, AlertHandler, Clipboard, DownloadHandler, KeyCode, KeyModifiers, MouseEvent,
-    SemanticZone, StableRowIndex, Terminal, TerminalConfiguration, TerminalSize,
+    Alert, AlertHandler, Clipboard, DownloadHandler, KeyCode, KeyModifiers, MouseCursor,
+    MouseEvent, SemanticZone, StableRowIndex, Terminal, TerminalConfiguration, TerminalSize,
 };
 
 const PROC_INFO_CACHE_TTL: Duration = Duration::from_millis(300);
@@ -137,6 +137,10 @@ pub struct LocalPane {
 
 #[async_trait(?Send)]
 impl Pane for LocalPane {
+    fn get_mouse_cursor_shape(&self) -> MouseCursor {
+        self.terminal.lock().get_mouse_cursor_shape()
+    }
+
     fn pane_id(&self) -> PaneId {
         self.pane_id
     }

mux/src/pane.rs

@@ -16,6 +16,7 @@ use termwiz::surface::{Line, SequenceNo};
 use url::Url;
 use wezterm_dynamic::Value;
 use wezterm_term::color::ColorPalette;
+pub use wezterm_term::MouseCursor;
 use wezterm_term::{
     Clipboard, DownloadHandler, KeyCode, KeyModifiers, MouseEvent, SemanticZone, StableRowIndex,
     TerminalConfiguration, TerminalSize,
@@ -231,6 +232,8 @@ pub trait Pane: Downcast + Send + Sync {
     /// Returns render related dimensions
     fn get_dimensions(&self) -> RenderableDimensions;
 
+    fn get_mouse_cursor_shape(&self) -> MouseCursor;
+
     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,10 @@ mod test {
     }
 
     impl Pane for FakePane {
+        fn get_mouse_cursor_shape(&self) -> MouseCursor {
+            unimplemented!()
+        }
+
         fn pane_id(&self) -> PaneId {
             unimplemented!()
         }

mux/src/tab.rs

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

mux/src/termwiztermtab.rs

@@ -32,7 +32,8 @@ use termwiz::Context;
 use url::Url;
 use wezterm_term::color::ColorPalette;
 use wezterm_term::{
-    KeyCode, KeyModifiers, MouseEvent, StableRowIndex, TerminalConfiguration, TerminalSize,
+    KeyCode, KeyModifiers, MouseCursor, MouseEvent, StableRowIndex, TerminalConfiguration,
+    TerminalSize,
 };
 
 struct TermWizTerminalDomain {
@@ -126,6 +127,10 @@ impl TermWizTerminalPane {
 }
 
 impl Pane for TermWizTerminalPane {
+    fn get_mouse_cursor_shape(&self) -> MouseCursor {
+        MouseCursor::Arrow
+    }
+
     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

@@ -62,6 +62,15 @@ pub(crate) enum MouseEncoding {
     SgrPixels,
 }
 
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+pub enum MouseCursor {
+    Arrow,
+    Hand,
+    Text,
+    SizeUpDown,
+    SizeLeftRight,
+}
+
 impl TabStop {
     fn new(screen_width: usize, tab_width: usize) -> Self {
         let mut tabs = Vec::with_capacity(screen_width);
@@ -342,6 +351,9 @@ pub struct TerminalState {
 
     palette: Option<ColorPalette>,
 
+    /// The mouse cursor shape (OSC 22)
+    mouse_cursor_shape: String,
+
     pixel_width: usize,
     pixel_height: usize,
     dpi: u32,
@@ -547,6 +559,7 @@ impl TerminalState {
             any_event_mouse: false,
             button_event_mouse: false,
             mouse_tracking: false,
+            mouse_cursor_shape: String::from(""),
             last_mouse_move: None,
             cursor_visible: true,
             g0_charset: CharSet::Ascii,
@@ -665,6 +678,26 @@ 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) -> MouseCursor {
+        // FIXME: The log here is clearing a cache somewhere causing the mouse shape
+        //        to be updated correctly. Not sure what I need to change.
+        log::info!("Mouse cursor shape: {}", self.mouse_cursor_shape);
+        if self.mouse_cursor_shape == "pointer" {
+            MouseCursor::Hand
+        } else if self.mouse_cursor_shape == "text" {
+            MouseCursor::Text
+        } else if self.mouse_cursor_shape == "row-resize" || self.mouse_cursor_shape == "ns-resize"
+        {
+            MouseCursor::SizeUpDown
+        } else if self.mouse_cursor_shape == "col-resize" || self.mouse_cursor_shape == "ew-resize"
+        {
+            MouseCursor::SizeLeftRight
+        } else {
+            MouseCursor::Arrow
+        }
+    }
+
     /// 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 +960,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 = String::from("");
                 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 = 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) => {

wezterm-client/src/pane/clientpane.rs

@@ -27,7 +27,7 @@ use url::Url;
 use wezterm_dynamic::Value;
 use wezterm_term::color::ColorPalette;
 use wezterm_term::{
-    Alert, Clipboard, KeyCode, KeyModifiers, Line, MouseEvent, StableRowIndex,
+    Alert, Clipboard, KeyCode, KeyModifiers, Line, MouseCursor, MouseEvent, StableRowIndex,
     TerminalConfiguration, TerminalSize,
 };
 
@@ -245,6 +245,10 @@ impl ClientPane {
 
 #[async_trait(?Send)]
 impl Pane for ClientPane {
+    fn get_mouse_cursor_shape(&self) -> MouseCursor {
+        MouseCursor::Arrow
+    }
+
     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

@@ -27,8 +27,8 @@ use unicode_segmentation::*;
 use url::Url;
 use wezterm_term::color::ColorPalette;
 use wezterm_term::{
-    unicode_column_width, Clipboard, KeyCode, KeyModifiers, Line, MouseEvent, SemanticType,
-    StableRowIndex, TerminalSize,
+    unicode_column_width, Clipboard, KeyCode, KeyModifiers, Line, MouseCursor, MouseEvent,
+    SemanticType, StableRowIndex, TerminalSize,
 };
 use window::{KeyCode as WKeyCode, Modifiers, WindowOps};
 
@@ -1101,6 +1101,10 @@ impl CopyRenderable {
 }
 
 impl Pane for CopyOverlay {
+    fn get_mouse_cursor_shape(&self) -> MouseCursor {
+        MouseCursor::Arrow
+    }
+
     fn pane_id(&self) -> PaneId {
         self.delegate.pane_id()
     }

wezterm-gui/src/overlay/quickselect.rs

@@ -19,7 +19,7 @@ use termwiz::surface::{SequenceNo, SEQ_ZERO};
 use url::Url;
 use wezterm_term::color::ColorPalette;
 use wezterm_term::{
-    Clipboard, KeyCode, KeyModifiers, Line, MouseEvent, StableRowIndex, TerminalSize,
+    Clipboard, KeyCode, KeyModifiers, Line, MouseCursor, MouseEvent, StableRowIndex, TerminalSize,
 };
 use window::WindowOps;
 
@@ -317,6 +317,10 @@ impl QuickSelectOverlay {
 }
 
 impl Pane for QuickSelectOverlay {
+    fn get_mouse_cursor_shape(&self) -> MouseCursor {
+        MouseCursor::Arrow
+    }
+
     fn pane_id(&self) -> PaneId {
         self.delegate.pane_id()
     }

wezterm-gui/src/termwindow/mod.rs

@@ -1209,6 +1209,13 @@ impl TermWindow {
                 } => {
                     self.update_title();
                 }
+                MuxNotification::Alert {
+                    alert: Alert::MouseCursorShapeChanged,
+                    pane_id,
+                } => {
+                    // FIXME: Is there a cache that needs to be invalidated like for PaletteChanged?
+                    self.mux_pane_output_event(pane_id);
+                }
                 MuxNotification::Alert {
                     alert: Alert::PaletteChanged,
                     pane_id,
@@ -1519,6 +1526,12 @@ impl TermWindow {
             } => {
                 // fall through
             }
+            MuxNotification::Alert {
+                alert: Alert::MouseCursorShapeChanged { .. },
+                ..
+            } => {
+                // fall through
+            }
         }
 
         window.notify(TermWindowNotif::MuxNotification(n));

wezterm-gui/src/termwindow/mouseevent.rs

@@ -3,8 +3,8 @@ use crate::termwindow::{
     GuiWin, MouseCapture, PositionedSplit, ScrollHit, TermWindowNotif, UIItem, UIItemType, TMB,
 };
 use ::window::{
-    MouseButtons as WMB, MouseCursor, MouseEvent, MouseEventKind as WMEK, MousePress,
-    WindowDecorations, WindowOps, WindowState,
+    MouseButtons as WMB, MouseEvent, MouseEventKind as WMEK, MousePress, WindowDecorations,
+    WindowOps, WindowState,
 };
 use config::keyassignment::{KeyAssignment, MouseEventTrigger, SpawnTabDomain};
 use config::MouseEventAltScreen;
@@ -21,7 +21,7 @@ use termwiz::hyperlink::Hyperlink;
 use termwiz::surface::Line;
 use wezterm_dynamic::ToDynamic;
 use wezterm_term::input::{MouseButton, MouseEventKind as TMEK};
-use wezterm_term::{ClickPosition, LastMouseClick, StableRowIndex};
+use wezterm_term::{ClickPosition, LastMouseClick, MouseCursor, StableRowIndex};
 
 impl super::TermWindow {
     fn resolve_ui_item(&self, event: &MouseEvent) -> Option<UIItem> {
@@ -843,6 +843,10 @@ impl super::TermWindow {
             MouseCursor::Text
         }));
 
+        if let Some(pane) = self.get_active_pane_or_overlay() {
+            context.set_cursor(Some(pane.get_mouse_cursor_shape()));
+        }
+
         let event_trigger_type = match &event.kind {
             WMEK::Press(press) => {
                 let press = mouse_press_to_tmb(press);

window/Cargo.toml

@@ -46,6 +46,7 @@ wezterm-bidi = { path = "../bidi" }
 wezterm-color-types = { path = "../color-types" }
 wezterm-font = { path = "../wezterm-font" }
 wezterm-input-types = { path = "../wezterm-input-types" }
+wezterm-term = { path = "../term", features=["use_serde"] }
 
 [target."cfg(windows)".dependencies]
 clipboard-win = "2.2"

window/examples/async.rs

@@ -4,6 +4,7 @@ use promise::spawn::spawn;
 use std::cell::RefCell;
 use std::rc::Rc;
 use wezterm_font::FontConfiguration;
+use wezterm_term::MouseCursor;
 
 struct MyWindow {
     allow_close: bool,