feat(bar): send commands by mouse/touchpad/screen

This commit makes it possible to send commands from the bar by using the
mouse/touchpad/touchscreen.

Komorebi or custom commands can be sent by clicking on the mouse's
primary, secondary, middle, back or forward buttons.

As the primary single click is already used by widgets, only primary
double clicks can send commands. This limitation is due to Egui also
triggering 2 single clicks before a double click is triggered. Egui does
not have an implementation for stopping event propagation out of the box
and would be too much work to include.

Similarly, commands can be sent on every "tick" of mouse scrolling,
touchpad or touchscreen swiping in any of the 4 directions. This "tick"
can be adjusted to fit user's preference.

This is due to the fact, that Egui does not have an event for when a
mouse "tick" occurs. It instead gives a number of points that the user
scrolled/swiped on each frame.

PR: #1403

Author: CtByte

Cargo.lock

@@ -33,6 +33,7 @@ strum = { version = "0.27", features = ["derive"] }
 tracing = "0.1"
 tracing-appender = "0.2"
 tracing-subscriber = { version = "0.3", features = ["env-filter"] }
+parking_lot = "0.12"
 paste = "1"
 sysinfo = "0.34"
 uds_windows = "1"

Cargo.toml

@@ -26,6 +26,7 @@ netdev = "0.34"
 num = "0.4"
 num-derive = "0.4"
 num-traits = "0.2"
+parking_lot = { workspace = true }
 random_word = { version = "0.5", features = ["en"] }
 reqwest = { version = "0.12", features = ["blocking"] }
 schemars = { workspace = true, optional = true }

komorebi-bar/Cargo.toml

@@ -38,6 +38,7 @@ use eframe::egui::Frame;
 use eframe::egui::Id;
 use eframe::egui::Layout;
 use eframe::egui::Margin;
+use eframe::egui::PointerButton;
 use eframe::egui::Rgba;
 use eframe::egui::Style;
 use eframe::egui::TextStyle;
@@ -57,13 +58,95 @@ use komorebi_themes::Base16Value;
 use komorebi_themes::Base16Wrapper;
 use komorebi_themes::Catppuccin;
 use komorebi_themes::CatppuccinValue;
+use lazy_static::lazy_static;
+use parking_lot::Mutex;
 use std::cell::RefCell;
 use std::collections::HashMap;
+use std::io::Error;
+use std::io::ErrorKind;
+use std::io::Result;
+use std::io::Write;
+use std::os::windows::process::CommandExt;
 use std::path::PathBuf;
+use std::process::ChildStdin;
+use std::process::Command;
+use std::process::Stdio;
 use std::rc::Rc;
 use std::sync::atomic::Ordering;
 use std::sync::Arc;
 
+const CREATE_NO_WINDOW: u32 = 0x0800_0000;
+
+lazy_static! {
+    static ref SESSION_STDIN: Mutex<Option<ChildStdin>> = Mutex::new(None);
+}
+
+fn start_powershell() -> Result<()> {
+    // found running session, do nothing
+    if SESSION_STDIN.lock().as_mut().is_some() {
+        tracing::debug!("PowerShell session already started");
+        return Ok(());
+    }
+
+    tracing::debug!("Starting PowerShell session");
+
+    let mut child = Command::new("powershell.exe")
+        .args(["-NoLogo", "-NoProfile", "-Command", "-"])
+        .stdin(Stdio::piped())
+        .creation_flags(CREATE_NO_WINDOW)
+        .spawn()?;
+
+    let stdin = child.stdin.take().expect("stdin piped");
+
+    // Store stdin for later commands
+    let mut session_stdin = SESSION_STDIN.lock();
+    *session_stdin = Option::from(stdin);
+
+    Ok(())
+}
+
+fn stop_powershell() -> Result<()> {
+    tracing::debug!("Stopping PowerShell session");
+
+    if let Some(mut session_stdin) = SESSION_STDIN.lock().take() {
+        if let Err(e) = session_stdin.write_all(b"exit\n") {
+            tracing::error!(error = %e, "failed to write exit command to PowerShell stdin");
+            return Err(e);
+        }
+        if let Err(e) = session_stdin.flush() {
+            tracing::error!(error = %e, "failed to flush PowerShell stdin");
+            return Err(e);
+        }
+
+        tracing::debug!("PowerShell session stopped");
+    } else {
+        tracing::debug!("PowerShell session already stopped");
+    }
+
+    Ok(())
+}
+
+pub fn exec_powershell(cmd: &str) -> Result<()> {
+    if let Some(session_stdin) = SESSION_STDIN.lock().as_mut() {
+        if let Err(e) = writeln!(session_stdin, "{}", cmd) {
+            tracing::error!(error = %e, cmd = cmd, "failed to write command to PowerShell stdin");
+            return Err(e);
+        }
+
+        if let Err(e) = session_stdin.flush() {
+            tracing::error!(error = %e, "failed to flush PowerShell stdin");
+            return Err(e);
+        }
+
+        return Ok(());
+    }
+
+    Err(Error::new(
+        ErrorKind::NotFound,
+        "PowerShell session not started",
+    ))
+}
+
 pub struct Komobar {
     pub hwnd: Option<isize>,
     pub monitor_index: Option<usize>,
@@ -82,6 +165,18 @@ pub struct Komobar {
     pub size_rect: komorebi_client::Rect,
     pub work_area_offset: komorebi_client::Rect,
     applied_theme_on_first_frame: bool,
+    mouse_follows_focus: bool,
+    input_config: InputConfig,
+}
+
+struct InputConfig {
+    accumulated_scroll_delta: Vec2,
+    act_on_vertical_scroll: bool,
+    act_on_horizontal_scroll: bool,
+    vertical_scroll_threshold: f32,
+    horizontal_scroll_threshold: f32,
+    vertical_scroll_max_threshold: f32,
+    horizontal_scroll_max_threshold: f32,
 }
 
 pub fn apply_theme(
@@ -368,15 +463,19 @@ impl Komobar {
             }
             MonitorConfigOrIndex::Index(idx) => (*idx, None),
         };
-        let monitor_index = self.komorebi_notification_state.as_ref().and_then(|state| {
-            state
-                .borrow()
-                .monitor_usr_idx_map
-                .get(&usr_monitor_index)
-                .copied()
+
+        let mapped_state = self.komorebi_notification_state.as_ref().map(|state| {
+            let state = state.borrow();
+            (
+                state.monitor_usr_idx_map.get(&usr_monitor_index).copied(),
+                state.mouse_follows_focus,
+            )
         });
 
-        self.monitor_index = monitor_index;
+        if let Some(state) = mapped_state {
+            self.monitor_index = state.0;
+            self.mouse_follows_focus = state.1;
+        }
 
         if let Some(monitor_index) = self.monitor_index {
             if let (prev_rect, Some(new_rect)) = (&self.work_area_offset, &config_work_area_offset)
@@ -435,6 +534,36 @@ impl Komobar {
             self.disabled = true;
         }
 
+        if let Some(mouse) = &self.config.mouse {
+            self.input_config.act_on_vertical_scroll =
+                mouse.on_scroll_up.is_some() || mouse.on_scroll_down.is_some();
+            self.input_config.act_on_horizontal_scroll =
+                mouse.on_scroll_left.is_some() || mouse.on_scroll_right.is_some();
+            self.input_config.vertical_scroll_threshold = mouse
+                .vertical_scroll_threshold
+                .unwrap_or(30.0)
+                .clamp(10.0, 300.0);
+            self.input_config.horizontal_scroll_threshold = mouse
+                .horizontal_scroll_threshold
+                .unwrap_or(30.0)
+                .clamp(10.0, 300.0);
+            // limit how many "ticks" can be accumulated
+            self.input_config.vertical_scroll_max_threshold =
+                self.input_config.vertical_scroll_threshold * 3.0;
+            self.input_config.horizontal_scroll_max_threshold =
+                self.input_config.horizontal_scroll_threshold * 3.0;
+
+            if mouse.has_command() {
+                start_powershell().unwrap_or_else(|_| {
+                    tracing::error!("failed to start powershell session");
+                });
+            } else {
+                stop_powershell().unwrap_or_else(|_| {
+                    tracing::error!("failed to stop powershell session");
+                });
+            }
+        }
+
         tracing::info!("widget configuration options applied");
 
         self.komorebi_notification_state = komorebi_notification_state;
@@ -608,6 +737,16 @@ impl Komobar {
             size_rect: komorebi_client::Rect::default(),
             work_area_offset: komorebi_client::Rect::default(),
             applied_theme_on_first_frame: false,
+            mouse_follows_focus: false,
+            input_config: InputConfig {
+                accumulated_scroll_delta: Vec2::new(0.0, 0.0),
+                act_on_vertical_scroll: false,
+                act_on_horizontal_scroll: false,
+                vertical_scroll_threshold: 0.0,
+                horizontal_scroll_threshold: 0.0,
+                vertical_scroll_max_threshold: 0.0,
+                horizontal_scroll_max_threshold: 0.0,
+            },
         };
 
         komobar.apply_config(&cc.egui_ctx, None);
@@ -961,6 +1100,111 @@ impl eframe::App for Komobar {
         let frame = render_config.change_frame_on_bar(frame, &ctx.style());
 
         CentralPanel::default().frame(frame).show(ctx, |ui| {
+            if let Some(mouse_config) = &self.config.mouse {
+                let command = if ui
+                    .input(|i| i.pointer.button_double_clicked(PointerButton::Primary))
+                {
+                    tracing::debug!("Input: primary button double clicked");
+                    &mouse_config.on_primary_double_click
+                } else if ui.input(|i| i.pointer.button_clicked(PointerButton::Secondary)) {
+                    tracing::debug!("Input: secondary button clicked");
+                    &mouse_config.on_secondary_click
+                } else if ui.input(|i| i.pointer.button_clicked(PointerButton::Middle)) {
+                    tracing::debug!("Input: middle button clicked");
+                    &mouse_config.on_middle_click
+                } else if ui.input(|i| i.pointer.button_clicked(PointerButton::Extra1)) {
+                    tracing::debug!("Input: extra1 button clicked");
+                    &mouse_config.on_extra1_click
+                } else if ui.input(|i| i.pointer.button_clicked(PointerButton::Extra2)) {
+                    tracing::debug!("Input: extra2 button clicked");
+                    &mouse_config.on_extra2_click
+                } else if self.input_config.act_on_vertical_scroll
+                    || self.input_config.act_on_horizontal_scroll
+                {
+                    let scroll_delta = ui.input(|input| input.smooth_scroll_delta);
+
+                    self.input_config.accumulated_scroll_delta += scroll_delta;
+
+                    if scroll_delta.y != 0.0 && self.input_config.act_on_vertical_scroll {
+                        // Do not store more than the max threshold
+                        self.input_config.accumulated_scroll_delta.y =
+                            self.input_config.accumulated_scroll_delta.y.clamp(
+                                -self.input_config.vertical_scroll_max_threshold,
+                                self.input_config.vertical_scroll_max_threshold,
+                            );
+
+                        // When the accumulated scroll passes the threshold, trigger a tick.
+                        if self.input_config.accumulated_scroll_delta.y.abs()
+                            >= self.input_config.vertical_scroll_threshold
+                        {
+                            let direction_command =
+                                if self.input_config.accumulated_scroll_delta.y > 0.0 {
+                                    &mouse_config.on_scroll_up
+                                } else {
+                                    &mouse_config.on_scroll_down
+                                };
+
+                            // Remove one tick's worth of scroll from the accumulator, preserving any excess.
+                            self.input_config.accumulated_scroll_delta.y -=
+                                self.input_config.vertical_scroll_threshold
+                                    * self.input_config.accumulated_scroll_delta.y.signum();
+
+                            tracing::debug!(
+                                "Input: vertical scroll ticked. excess: {} | threshold: {}",
+                                self.input_config.accumulated_scroll_delta.y,
+                                self.input_config.vertical_scroll_threshold
+                            );
+
+                            direction_command
+                        } else {
+                            &None
+                        }
+                    } else if scroll_delta.x != 0.0 && self.input_config.act_on_horizontal_scroll {
+                        // Do not store more than the max threshold
+                        self.input_config.accumulated_scroll_delta.x =
+                            self.input_config.accumulated_scroll_delta.x.clamp(
+                                -self.input_config.horizontal_scroll_max_threshold,
+                                self.input_config.horizontal_scroll_max_threshold,
+                            );
+
+                        // When the accumulated scroll passes the threshold, trigger a tick.
+                        if self.input_config.accumulated_scroll_delta.x.abs()
+                            >= self.input_config.horizontal_scroll_threshold
+                        {
+                            let direction_command =
+                                if self.input_config.accumulated_scroll_delta.x > 0.0 {
+                                    &mouse_config.on_scroll_left
+                                } else {
+                                    &mouse_config.on_scroll_right
+                                };
+
+                            // Remove one tick's worth of scroll from the accumulator, preserving any excess.
+                            self.input_config.accumulated_scroll_delta.x -=
+                                self.input_config.horizontal_scroll_threshold
+                                    * self.input_config.accumulated_scroll_delta.x.signum();
+
+                            tracing::debug!(
+                                "Input: horizontal scroll ticked. excess: {} | threshold: {}",
+                                self.input_config.accumulated_scroll_delta.x,
+                                self.input_config.horizontal_scroll_threshold
+                            );
+
+                            direction_command
+                        } else {
+                            &None
+                        }
+                    } else {
+                        &None
+                    }
+                } else {
+                    &None
+                };
+
+                if let Some(command) = command {
+                    command.execute(self.mouse_follows_focus);
+                }
+            }
+
             // Apply grouping logic for the bar as a whole
             let area_frame = if let Some(frame) = &self.config.frame {
                 Frame::NONE