1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
//! Enigo lets you simulate mouse and keyboard input-events as if they were
//! made by the actual hardware. It is available on Linux (X11), macOS and
//! Windows.
//!
//! It can be used for testing user interfaces on different platforms, building
//! remote control applications or just automating tasks for user interfaces
//! unaccessible by a public API or scripting language.
//!
//! This library is in an early alpha status, the API will change in
//! in the future.
//!
//! In order to use the library, you only have to know about three
//! things:
//! - [`KeyboardControllable`] (trait): used to simulate a key click, enter text
//! or something similar
//! - [`MouseControllable`] (trait): do something with the mouse or you find out
//! the display
//! size
//! - [`Enigo`] (struct): implements the two traits [`KeyboardControllable`] and
//! [`MouseControllable`]
//!
//! A simple [DSL](https://en.wikipedia.org/wiki/Domain-specific_language)
//! is available. It is documented in the [`dsl`] module.
//! # Examples
//! ```no_run
//! use enigo::*;
//! let mut enigo = Enigo::new();
//! //paste
//! enigo.key_down(Key::Control);
//! enigo.key_click(Key::Layout('v'));
//! enigo.key_up(Key::Control);
//! ```
//!
//! ```no_run
//! use enigo::*;
//! let mut enigo = Enigo::new();
//! enigo.mouse_move_to(500, 200);
//! enigo.mouse_down(MouseButton::Left);
//! enigo.mouse_move_relative(100, 100);
//! enigo.mouse_up(MouseButton::Left);
//! enigo.key_sequence("hello world");
//! ```
#![deny(clippy::pedantic)]
#![allow(clippy::cast_lossless)]
#![allow(clippy::cast_possible_truncation)]
#![allow(clippy::cast_possible_wrap)]
#![allow(clippy::cast_sign_loss)]
#![allow(deprecated)]
#[cfg(target_os = "macos")]
#[macro_use]
extern crate objc;
#[cfg(feature = "with_serde")]
extern crate serde;
#[cfg(feature = "with_serde")]
#[macro_use]
extern crate serde_derive;
// TODO(dustin) use interior mutability not &mut self
use std::fmt;
pub use keycodes::Key;
#[cfg(target_os = "linux")]
pub use crate::linux::Enigo;
#[cfg(target_os = "macos")]
pub use crate::macos::Enigo;
#[cfg(target_os = "windows")]
pub use crate::win::Enigo;
/// DSL parser module
///
/// The current status is that you can just print [unicode](http://unicode.org/) characters like [emoji](http://getemoji.com/) without the `{+SHIFT}`
/// [DSL](https://en.wikipedia.org/wiki/Domain-specific_language) or any other "special" key on the Linux, macOS and Windows operating system.
pub mod dsl;
#[cfg(target_os = "linux")]
mod linux;
#[cfg(target_os = "macos")]
mod macos;
#[cfg(target_os = "windows")]
mod win;
/// Contains the available keycodes
pub mod keycodes;
#[cfg_attr(feature = "with_serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
/// [`MouseButton`] represents a mouse button and is used in e.g
/// [`MouseControllable::mouse_click`].
// Warning! If there are ANY CHANGES to this enum, we
// need to change the size of the array in the macOS implementation of the Enigo
// struct that stores the nth click for each MouseButton
pub enum MouseButton {
/// Left mouse button
Left,
/// Middle mouse button
Middle,
/// Right mouse button
Right,
#[cfg(any(target_os = "windows", target_os = "linux"))]
/// 4th mouse button. Typically performs the same function as Browser_Back
Back,
#[cfg(any(target_os = "windows", target_os = "linux"))]
/// 5th mouse button. Typically performs the same function as
/// Browser_Forward
Forward,
/// Scroll up button. It is better to use the
/// [MouseControllable::mouse_scroll_y] method to scroll.
ScrollUp,
/// Scroll down button. It is better to use the
/// [MouseControllable::mouse_scroll_y] method to scroll.
ScrollDown,
/// Scroll left button. It is better to use the
/// [MouseControllable::mouse_scroll_x] method to scroll.
ScrollLeft,
/// Scroll right button. It is better to use the
/// [MouseControllable::mouse_scroll_x] method to scroll.
ScrollRight,
}
/// Contains functions to control the mouse and to get the size of the display.
/// Enigo uses a Cartesian coordinate system for specifying coordinates. The
/// origin in this system is located in the top-left corner of the current
/// screen, with positive values extending along the axes down and to the
/// right of the origin point and it is measured in pixels. The same coordinate
/// system is used on all operating systems.
pub trait MouseControllable {
/// Move the mouse cursor to the specified x and y coordinates.
///
/// The topleft corner of your monitor screen is x=0 y=0. Move
/// the cursor down the screen by increasing the y and to the right
/// by increasing x coordinate.
///
/// # Example
///
/// ```no_run
/// use enigo::*;
/// let mut enigo = Enigo::new();
/// enigo.mouse_move_to(500, 200);
/// ```
fn mouse_move_to(&mut self, x: i32, y: i32);
/// Move the mouse cursor the specified amount in the x and y
/// direction. A positive x value moves the mouse cursor `x` pixels to the
/// right. A negative value for `x` moves the mouse cursor to the left.
/// A positive value of y moves the mouse cursor down, a negative one
/// moves the mouse cursor up.
///
/// # Example
///
/// ```no_run
/// use enigo::*;
/// let mut enigo = Enigo::new();
/// enigo.mouse_move_relative(100, 100);
/// ```
fn mouse_move_relative(&mut self, x: i32, y: i32);
/// Push down the mouse button specified by the parameter
/// `button` of type [`MouseButton`] and hold it until it is released by
/// [`MouseControllable::mouse_up`].
/// Calls to [`MouseControllable::mouse_move_to`] or
/// [`MouseControllable::mouse_move_relative`] will
/// work like expected and will e.g. drag widgets or highlight text.
///
/// # Example
///
/// ```no_run
/// use enigo::*;
/// let mut enigo = Enigo::new();
/// enigo.mouse_down(MouseButton::Left);
/// ```
fn mouse_down(&mut self, button: MouseButton);
/// Release a pushed down mouse button
///
/// Lift up a previously pushed down button (by invoking
/// [`MouseControllable::mouse_down`]).
/// If the button was not pushed down or consecutive calls without
/// invoking [`MouseControllable::mouse_down`] will emit lift up
/// events. It depends on the operating system whats actually happening
/// – my guess is it will just get ignored.
///
/// # Example
///
/// ```no_run
/// use enigo::*;
/// let mut enigo = Enigo::new();
/// enigo.mouse_down(MouseButton::Right);
/// enigo.mouse_up(MouseButton::Right);
/// ```
fn mouse_up(&mut self, button: MouseButton);
/// Click a mouse button
///
/// It is essentially just a consecutive invocation of
/// [`MouseControllable::mouse_down`]
/// followed by a [`MouseControllable::mouse_up`]. Just for
/// convenience.
///
/// # Example
///
/// ```no_run
/// use enigo::*;
/// let mut enigo = Enigo::new();
/// enigo.mouse_click(MouseButton::Right);
/// ```
fn mouse_click(&mut self, button: MouseButton);
/// Scroll the mouse (wheel) left or right
///
/// Positive numbers for `length` scroll to the right and negative ones to
/// the left. The value that is specified translates to `lines` defined
/// by the operating system and is essentially one 15° (click) rotation
/// on the mouse wheel. How many lines it moves depends on the current
/// setting in the operating system.
///
/// # Example
///
/// ```no_run
/// use enigo::*;
/// let mut enigo = Enigo::new();
/// enigo.mouse_scroll_x(2);
/// ```
fn mouse_scroll_x(&mut self, length: i32);
/// Scroll the mouse (wheel) up or down
///
/// Positive numbers for `length` scroll down and negative ones up. The
/// value that is specified translates to `lines` defined by the
/// operating system and is essentially one 15° (click) rotation on the
/// mouse wheel. How many lines it moves depends on the current setting
/// in the operating system.
///
/// # Example
///
/// ```no_run
/// use enigo::*;
/// let mut enigo = Enigo::new();
/// enigo.mouse_scroll_y(2);
/// ```
fn mouse_scroll_y(&mut self, length: i32);
/// Get the (width, height) of the main display in screen coordinates
/// (pixels). This currently only works on the main display
///
/// # Example
///
/// ```no_run
/// use enigo::*;
/// let mut enigo = Enigo::new();
/// let (width, height) = enigo.main_display_size();
/// ```
#[must_use]
fn main_display_size(&self) -> (i32, i32);
/// Get the location of the mouse in screen coordinates (pixels).
///
/// # Example
///
/// ```no_run
/// use enigo::*;
/// let mut enigo = Enigo::new();
/// let (x, y) = enigo.mouse_location();
/// ```
#[must_use]
fn mouse_location(&self) -> (i32, i32);
}
/// Contains functions to simulate key presses and to input text.
///
/// For the keyboard there are currently two modes you can use. The first mode
/// is represented by the [`key_sequence`](KeyboardControllable::key_sequence)
/// function. It's purpose is to simply write unicode characters. This is
/// independent of the keyboard layout. Please note that
/// you're not be able to use modifier keys like Control
/// to influence the outcome. If you want to use modifier keys to e.g.
/// copy/paste, use the Layout variant. Please note that this is indeed layout
/// dependent.
pub trait KeyboardControllable {
/// Type the string parsed with DSL.
///
/// Typing {+SHIFT}hello{-SHIFT} becomes HELLO.
/// Please have a look at the [dsl] module for more information.
fn key_sequence_parse(&mut self, sequence: &str)
where
Self: Sized,
{
self.key_sequence_parse_try(sequence)
.expect("Could not parse sequence");
}
/// Same as [`KeyboardControllable::key_sequence_parse`] except returns any
/// errors
/// # Errors
///
/// Returns a [`dsl::ParseError`] if the sequence cannot be parsed
fn key_sequence_parse_try(&mut self, sequence: &str) -> Result<(), dsl::ParseError>
where
Self: Sized,
{
dsl::eval(self, sequence)
}
/// Enter the text. You can use unicode here like: ❤️. This works
/// regardless of the current keyboardlayout. You cannot use this function
/// for entering shortcuts or something similar. For shortcuts, use the
/// [`KeyboardControllable::key_click`] method instead.
///
/// # Example
///
/// ```no_run
/// use enigo::*;
/// let mut enigo = Enigo::new();
/// enigo.key_sequence("hello world ❤️");
/// ```
fn key_sequence(&mut self, sequence: &str);
/// Press down the given key
fn key_down(&mut self, key: Key);
/// Release a pressed down key
fn key_up(&mut self, key: Key);
/// Press and release the key. It is the same as calling the
/// [`KeyboardControllable::key_down`] and
/// [`KeyboardControllable::key_up`] functions consecutively
fn key_click(&mut self, key: Key);
}
impl Enigo {
/// Constructs a new `Enigo` instance.
///
/// # Example
///
/// ```no_run
/// use enigo::*;
/// let mut enigo = Enigo::new();
/// ```
#[must_use]
pub fn new() -> Self {
Self::default()
}
}
impl fmt::Debug for Enigo {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "Enigo")
}
}