Add function to manually control mouse-capture (#80)

* feat(terminal): dont enable "MouseCapture" by default

* feat(terminal): add function "enable_mouse_capture" and "disable_mouse_capture"

---------

Co-authored-by: veeso <[email protected]>

CHANGELOG.md

@@ -53,6 +53,8 @@ Released on 13/10/2024
 - Added new `subclause_and!(Id::Foo, Id::Bar, Id::Baz)` and `subclause_or!(Id::Foo, Id::Bar, Id::Baz)` macros.
 - Removed `InputListener`. Now use `CrosstermInputListener` or `TermionInputListener`.
 - Bump `ratatui` version to `0.28`
+- Dont enable `MouseCapture` by default
+- Add function `enable_mouse_capture` and `disable_mouse_capture` to `TerminalBridge`
 
 ## 1.9.2
 

src/terminal.rs

@@ -41,6 +41,8 @@ pub enum TerminalError {
     CannotClear,
     #[error("backend doesn't support this command")]
     Unsupported,
+    #[error("cannot activate / deactivate mouse capture")]
+    CannotToggleMouseCapture,
 }
 
 /// An helper around [`Terminal`] to quickly setup and perform on terminal.
@@ -148,6 +150,16 @@ where
         self.terminal.disable_raw_mode()
     }
 
+    /// Enable mouse-event capture, if the backend supports it
+    pub fn enable_mouse_capture(&mut self) -> TerminalResult<()> {
+        self.terminal.enable_mouse_capture()
+    }
+
+    /// Disable mouse-event capture, if the backend supports it
+    pub fn disable_mouse_capture(&mut self) -> TerminalResult<()> {
+        self.terminal.disable_mouse_capture()
+    }
+
     /// Draws a single frame to the terminal.
     ///
     /// Returns a [`CompletedFrame`] if successful, otherwise a [`TerminalError`].

src/terminal/adapter.rs

@@ -54,4 +54,10 @@ pub trait TerminalAdapter {
 
     /// Leave the alternate screen using the terminal adapter
     fn leave_alternate_screen(&mut self) -> TerminalResult<()>;
+
+    /// Enable mouse capture using the terminal adapter
+    fn enable_mouse_capture(&mut self) -> TerminalResult<()>;
+
+    /// Disable mouse capture using the terminal adapter
+    fn disable_mouse_capture(&mut self) -> TerminalResult<()>;
 }

src/terminal/adapter/crossterm.rs

@@ -75,4 +75,14 @@ impl TerminalAdapter for CrosstermTerminalAdapter {
         )
         .map_err(|_| TerminalError::CannotLeaveAlternateMode)
     }
+
+    fn enable_mouse_capture(&mut self) -> TerminalResult<()> {
+        execute!(self.raw_mut().backend_mut(), EnableMouseCapture)
+            .map_err(|_| TerminalError::CannotToggleMouseCapture)
+    }
+
+    fn disable_mouse_capture(&mut self) -> TerminalResult<()> {
+        execute!(self.raw_mut().backend_mut(), DisableMouseCapture)
+            .map_err(|_| TerminalError::CannotToggleMouseCapture)
+    }
 }

src/terminal/adapter/termion.rs

@@ -74,4 +74,12 @@ impl TerminalAdapter for TermionTerminalAdapter {
     fn leave_alternate_screen(&mut self) -> TerminalResult<()> {
         Err(TerminalError::Unsupported)
     }
+
+    fn disable_mouse_capture(&mut self) -> TerminalResult<()> {
+        Err(TerminalError::Unsupported)
+    }
+
+    fn enable_mouse_capture(&mut self) -> TerminalResult<()> {
+        Err(TerminalError::Unsupported)
+    }
 }