/* * This file is part of espanso. * * Copyright (C) 2019-2021 Federico Terzi * * espanso is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * espanso is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with espanso. If not, see . */ use anyhow::Result; use log::info; pub mod keys; #[cfg(target_os = "windows")] mod win32; #[cfg(target_os = "linux")] #[cfg(not(feature = "wayland"))] mod x11; #[cfg(target_os = "linux")] mod evdev; #[cfg(target_os = "linux")] mod linux; #[cfg(target_os = "macos")] mod mac; #[macro_use] extern crate lazy_static; pub trait Injector { fn send_string(&self, string: &str, options: InjectionOptions) -> Result<()>; fn send_keys(&self, keys: &[keys::Key], options: InjectionOptions) -> Result<()>; fn send_key_combination(&self, keys: &[keys::Key], options: InjectionOptions) -> Result<()>; } #[allow(dead_code)] pub struct InjectionOptions { // Delay between injected events delay: i32, // Use original libxdo methods instead of patched version // using XSendEvent rather than XTestFakeKeyEvent // NOTE: Only relevant on X11 linux systems. disable_fast_inject: bool, } impl Default for InjectionOptions { fn default() -> Self { let default_delay = if cfg!(target_os = "windows") { 0 } else if cfg!(target_os = "macos") { 2 } else if cfg!(target_os = "linux") { if cfg!(feature = "wayland") { 1 } else { 0 } } else { panic!("unsupported OS"); }; Self { delay: default_delay, disable_fast_inject: false, } } } #[allow(dead_code)] pub struct InjectorCreationOptions { // Only relevant in X11 Linux systems, use the EVDEV backend instead of X11. use_evdev: bool, // Overwrite the list of modifiers to be scanned when // populating the evdev injector lookup maps evdev_modifiers: Option>, // Overwrite the maximum number of modifiers used tested in // a single combination to populate the lookup maps evdev_max_modifier_combination_len: Option, // Can be used to overwrite the keymap configuration // used by espanso to inject key presses. evdev_keyboard_rmlvo: Option, } // This struct identifies the keyboard layout that // should be used by EVDEV when loading the keymap. // For more information: https://xkbcommon.org/doc/current/structxkb__rule__names.html pub struct KeyboardConfig { pub rules: Option, pub model: Option, pub layout: Option, pub variant: Option, pub options: Option, } impl Default for InjectorCreationOptions { fn default() -> Self { Self { use_evdev: false, evdev_modifiers: None, evdev_max_modifier_combination_len: None, evdev_keyboard_rmlvo: None, } } } #[cfg(target_os = "windows")] pub fn get_injector(_options: InjectorCreationOptions) -> Result> { info!("using Win32Injector"); Ok(Box::new(win32::Win32Injector::new())) } #[cfg(target_os = "macos")] pub fn get_injector(_options: InjectorCreationOptions) -> Result> { info!("using MacInjector"); Ok(Box::new(mac::MacInjector::new())) } #[cfg(target_os = "linux")] #[cfg(not(feature = "wayland"))] pub fn get_injector(options: InjectorCreationOptions) -> Result> { if options.use_evdev { info!("using EVDEVInjector"); Ok(Box::new(evdev::EVDEVInjector::new(options)?)) } else { info!("using X11Injector"); Ok(Box::new(x11::X11Injector::new()?)) } } #[cfg(target_os = "linux")] #[cfg(feature = "wayland")] pub fn get_injector(options: InjectorCreationOptions) -> Result> { info!("using EVDEVInjector"); Ok(Box::new(evdev::EVDEVInjector::new(options)?)) }