refactor mouse_mod into mouse_sensitvity and improved cli options

Author: NeoTheFox

config.toml

@@ -7,7 +7,7 @@ release_bind = ["KeyA", "KeyS", "KeyD", "KeyF"]
 port = 4242
 
 # linear mouse acceleration
-mouse_mod = 1.0
+mouse_sensitivity = 1.0
 # invert scrolling direction
 invert_scroll = false
 

input-emulation/src/lib.rs

@@ -72,14 +72,14 @@ impl Display for Backend {
 #[derive(Clone, Copy, Debug)]
 pub struct InputConfig {
     pub invert_scroll: bool,
-    pub mouse_mod: f64,
+    pub mouse_sensitivity: f64,
 }
 
 impl InputConfig {
-    pub fn new(invert_scroll: bool, mouse_mod: f64) -> Self {
+    pub fn new(invert_scroll: bool, mouse_sensitivity: f64) -> Self {
         InputConfig {
             invert_scroll,
-            mouse_mod,
+            mouse_sensitivity,
         }
     }
 }
@@ -176,8 +176,8 @@ impl InputEmulation {
             Event::Pointer(PointerEvent::Motion { time, dx, dy }) => {
                 // apply mouse mod
                 let (dx, dy) = (
-                    dx * self.input_config.mouse_mod,
-                    dy * self.input_config.mouse_mod,
+                    dx * self.input_config.mouse_sensitivity,
+                    dy * self.input_config.mouse_sensitivity,
                 );
                 let event = Event::Pointer(PointerEvent::Motion { time, dx, dy });
                 self.emulation.consume(event, handle).await?;

lan-mouse-cli/src/lib.rs

@@ -56,13 +56,13 @@ enum CliSubcommand {
     },
     /// change port
     SetPort { id: ClientHandle, port: u16 },
-    /// invert scrolling
-    SetScrollingInversion {
+    /// invert scrolling direction
+    InvertScrolling {
         #[clap(short, long)]
         invert_scroll: bool,
     },
-    /// set mouse mod
-    SetMouseMod { mouse_mod: f64 },
+    /// set mouse mouse sensitivity
+    SetMouseSensitivity { mouse_sensitivity: f64 },
     /// set position
     SetPosition { id: ClientHandle, pos: Position },
     /// set ips
@@ -147,12 +147,12 @@ async fn execute(cmd: CliSubcommand) -> Result<(), CliError> {
         CliSubcommand::SetPort { id, port } => {
             tx.request(FrontendRequest::UpdatePort(id, port)).await?
         }
-        CliSubcommand::SetScrollingInversion { invert_scroll } => {
+        CliSubcommand::InvertScrolling { invert_scroll } => {
             tx.request(FrontendRequest::UpdateScrollingInversion(invert_scroll))
                 .await?
         }
-        CliSubcommand::SetMouseMod { mouse_mod } => {
-            tx.request(FrontendRequest::UpdateMouseMod(mouse_mod))
+        CliSubcommand::SetMouseSensitivity { mouse_sensitivity } => {
+            tx.request(FrontendRequest::UpdateMouseSensitivity(mouse_sensitivity))
                 .await?
         }
         CliSubcommand::SetPosition { id, pos } => {

lan-mouse-ipc/src/lib.rs

@@ -253,9 +253,9 @@ pub enum FrontendRequest {
     RemoveAuthorizedKey(String),
     /// change the hook command
     UpdateEnterHook(u64, Option<String>),
-    /// update the input post-processing settings (invert-scroll, mouse_mod)
+    /// update the input post-processing settings (invert-scroll, mouse_sensitivity)
     UpdateScrollingInversion(bool),
-    UpdateMouseMod(f64),
+    UpdateMouseSensitivity(f64),
 }
 
 #[derive(Clone, Copy, PartialEq, Eq, Debug, Default, Serialize, Deserialize)]

src/config.rs

@@ -50,7 +50,7 @@ struct ConfigToml {
     emulation_backend: Option<EmulationBackend>,
     port: Option<u16>,
     release_bind: Option<Vec<scancode::Linux>>,
-    mouse_mod: Option<f64>,
+    mouse_sensitivity: Option<f64>,
     invert_scroll: Option<bool>,
     cert_path: Option<PathBuf>,
     clients: Option<Vec<TomlClient>>,
@@ -374,10 +374,10 @@ impl Config {
             .unwrap_or(false)
     }
 
-    pub fn mouse_mod(&self) -> f64 {
+    pub fn mouse_sensitivity(&self) -> f64 {
         self.config_toml
             .as_ref()
-            .and_then(|c| c.mouse_mod)
+            .and_then(|c| c.mouse_sensitivity)
             .unwrap_or(1.0)
     }
 

src/emulation.rs

@@ -60,7 +60,7 @@ enum EmulationRequest {
     ChangePort(u16),
     Terminate,
     UpdateScrollingInversion(bool),
-    UpdateMouseMod(f64),
+    UpdateMouseSensitivity(f64),
 }
 
 impl Emulation {
@@ -71,7 +71,7 @@ impl Emulation {
     ) -> Self {
         let input_config = InputConfig {
             invert_scroll: input_config.0,
-            mouse_mod: input_config.1,
+            mouse_sensitivity: input_config.1,
         };
         let emulation_proxy = EmulationProxy::new(backend, input_config);
         let (request_tx, request_rx) = channel();
@@ -114,9 +114,9 @@ impl Emulation {
             .expect("channel closed")
     }
 
-    pub(crate) fn request_mouse_mod_change(&self, mouse_mod: f64) {
+    pub(crate) fn request_mouse_sensitivity_change(&self, mouse_sensitivity: f64) {
         self.request_tx
-            .send(EmulationRequest::UpdateMouseMod(mouse_mod))
+            .send(EmulationRequest::UpdateMouseSensitivity(mouse_sensitivity))
             .expect("channel closed")
     }
 
@@ -192,7 +192,7 @@ impl ListenTask {
                     // notify the other end that we hit a barrier (should release capture)
                     EmulationRequest::Release(addr) => self.listener.reply(addr, ProtoEvent::Leave(0)).await,
                     EmulationRequest::UpdateScrollingInversion(invert_scroll) => self.emulation_proxy.input_config.invert_scroll = invert_scroll,
-                    EmulationRequest::UpdateMouseMod(mouse_mod) => self.emulation_proxy.input_config.mouse_mod = mouse_mod,
+                    EmulationRequest::UpdateMouseSensitivity(mouse_sensitivity) => self.emulation_proxy.input_config.mouse_sensitivity = mouse_sensitivity,
                     EmulationRequest::ChangePort(port) => {
                         self.listener.request_port_change(port);
                         let result = self.listener.port_changed().await;

src/emulation_test.rs

@@ -24,7 +24,7 @@ pub async fn run(config: Config, _args: TestEmulationArgs) -> Result<(), InputEm
     let backend = config.emulation_backend().map(|b| b.into());
     let input_config: InputConfig = InputConfig {
         invert_scroll: config.invert_scroll(),
-        mouse_mod: config.mouse_mod(),
+        mouse_sensitivity: config.mouse_sensitivity(),
     };
     let mut emulation = InputEmulation::new(backend, input_config).await?;
     emulation.create(0).await;

src/service.rs

@@ -118,7 +118,7 @@ impl Service {
         let emulation = Emulation::new(
             emulation_backend,
             listener,
-            (config.invert_scroll(), config.mouse_mod()),
+            (config.invert_scroll(), config.mouse_sensitivity()),
         );
 
         // create dns resolver
@@ -207,7 +207,7 @@ impl Service {
             FrontendRequest::UpdateScrollingInversion(invert_scroll) => {
                 self.update_scrolling_inversion(invert_scroll)
             }
-            FrontendRequest::UpdateMouseMod(mouse_mod) => self.update_mouse_mod(mouse_mod),
+            FrontendRequest::UpdateMouseSensitivity(mouse_sensitivity) => self.update_mouse_sensitivity(mouse_sensitivity),
         }
     }
 
@@ -523,8 +523,8 @@ impl Service {
         self.emulation.request_scrolling_inversion(invert_scroll);
     }
 
-    fn update_mouse_mod(&mut self, mouse_mod: f64) {
-        self.emulation.request_mouse_mod_change(mouse_mod);
+    fn update_mouse_sensitivity(&mut self, mouse_sensitivity: f64) {
+        self.emulation.request_mouse_sensitivity_change(mouse_sensitivity);
     }
 
     fn spawn_hook_command(&self, handle: ClientHandle) {