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
//! Simple library to listen and send events to keyboard and mouse on MacOS, Windows and Linux //! (x11). //! //! You can also check out [Enigo](https://github.com/Enigo-rs/Enigo) which is another //! crate which helped me write this one. //! //! This crate is so far a pet project for me to understand the rust ecosystem. //! //! ## Simple Usage //! //! ### Listening to global events //! //! ```no_run //! use rdev::{listen, Event}; //! //! // This will block. //! if let Err(error) = listen(callback) { //! println!("Error: {:?}", error) //! } //! //! fn callback(event: Event) { //! println!("My callback {:?}", event); //! match event.name { //! Some(string) => println!("User wrote {:?}", string), //! None => (), //! } //! } //! ``` //! //! ### Sending some events //! //! ```no_run //! use rdev::{simulate, Button, EventType, Key, SimulateError}; //! use std::{thread, time}; //! //! fn send(event_type: &EventType) { //! let delay = time::Duration::from_millis(20); //! match simulate(event_type) { //! Ok(()) => (), //! Err(SimulateError) => { //! println!("We could not send {:?}", event_type); //! } //! } //! // Let ths OS catchup (at least MacOS) //! thread::sleep(delay); //! } //! //! send(&EventType::KeyPress(Key::KeyS)); //! send(&EventType::KeyRelease(Key::KeyS)); //! //! send(&EventType::MouseMove { x: 0.0, y: 0.0 }); //! send(&EventType::MouseMove { x: 400.0, y: 400.0 }); //! send(&EventType::ButtonPress(Button::Left)); //! send(&EventType::ButtonRelease(Button::Right)); //! send(&EventType::Wheel { //! delta_x: 0, //! delta_y: 1, //! }); //! ``` //! ### Getting the main screen size //! //! ```no_run //! use rdev::{display_size}; //! //! let (w, h) = display_size(); //! assert!(w > 0); //! assert!(h > 0); //! ``` //! //! ### Grabbing global events. (Requires `unstable_grab` feature) //! //! In the callback, returning None ignores the event //! and returning the event let's it pass. There is no modification of the event //! possible here. //! Caveat: On MacOS, you require the grab //! loop needs to be the primary app (no fork before) and need to have accessibility //! settings enabled. //! **Not implemented on Linux, you will always receive an error.** //! //! ### Serialization //! //! Serialization and deserialization. (Requires `serialize` feature). mod rdev; pub use crate::rdev::{ Button, Callback, Event, EventType, GrabCallback, GrabError, Key, ListenError, SimulateError, }; #[cfg(target_os = "macos")] mod macos; #[cfg(target_os = "macos")] use crate::macos::{display_size as _display_size, listen as _listen, simulate as _simulate}; #[cfg(target_os = "linux")] mod linux; #[cfg(target_os = "linux")] use crate::linux::{display_size as _display_size, listen as _listen, simulate as _simulate}; #[cfg(target_os = "windows")] mod windows; #[cfg(target_os = "windows")] use crate::windows::{display_size as _display_size, listen as _listen, simulate as _simulate}; /// Listening to global events. Caveat: On MacOS, you require the listen /// loop needs to be the primary app (no fork before) and need to have accessibility /// settings enabled. /// /// ```no_run /// use rdev::{listen, Event}; /// /// fn callback(event: Event) { /// println!("My callback {:?}", event); /// match event.name{ /// Some(string) => println!("User wrote {:?}", string), /// None => () /// } /// } /// fn main(){ /// // This will block. /// if let Err(error) = listen(callback) { /// println!("Error: {:?}", error) /// } /// } /// ``` pub fn listen(callback: Callback) -> Result<(), ListenError> { _listen(callback) } /// Sending some events /// /// ```no_run /// use rdev::{simulate, Button, EventType, Key, SimulateError}; /// use std::{thread, time}; /// /// fn send(event_type: &EventType) { /// let delay = time::Duration::from_millis(20); /// match simulate(event_type) { /// Ok(()) => (), /// Err(SimulateError) => { /// println!("We could not send {:?}", event_type); /// } /// } /// // Let ths OS catchup (at least MacOS) /// thread::sleep(delay); /// } /// /// fn my_shortcut() { /// send(&EventType::KeyPress(Key::KeyS)); /// send(&EventType::KeyRelease(Key::KeyS)); /// /// send(&EventType::MouseMove { x: 0.0, y: 0.0 }); /// send(&EventType::MouseMove { x: 400.0, y: 400.0 }); /// send(&EventType::ButtonPress(Button::Left)); /// send(&EventType::ButtonRelease(Button::Right)); /// send(&EventType::Wheel { /// delta_x: 0, /// delta_y: 1, /// }); /// } /// ``` pub fn simulate(event_type: &EventType) -> Result<(), SimulateError> { _simulate(event_type) } /// Returns the size in pixels of the main screen. /// This is useful to use with x, y from MouseMove Event. /// /// ```no_run /// use rdev::{display_size}; /// /// let (w, h )= display_size(); /// println!("My screen size : {:?}x{:?}", w, h); /// ``` pub fn display_size() -> (u64, u64) { _display_size() } #[cfg(feature = "unstable_grab")] #[cfg(target_os = "linux")] pub use crate::linux::grab as _grab; #[cfg(feature = "unstable_grab")] #[cfg(target_os = "macos")] pub use crate::macos::grab as _grab; #[cfg(feature = "unstable_grab")] #[cfg(target_os = "windows")] pub use crate::windows::grab as _grab; #[cfg(any(feature = "unstable_grab"))] /// Grabbing global events. In the callback, returning None ignores the event /// and returning the event let's it pass. There is no modification of the event /// possible here. /// Caveat: On MacOS, you require the grab /// loop needs to be the primary app (no fork before) and need to have accessibility /// settings enabled. /// On Linux, this is not implemented, you will always receive an error. /// /// ```no_run /// use rdev::{grab, Event, EventType, Key}; /// /// fn callback(event: Event) -> Option<Event> { /// println!("My callback {:?}", event); /// match event.event_type{ /// EventType::KeyPress(Key::Tab) => None, /// _ => Some(event), /// } /// } /// fn main(){ /// // This will block. /// if let Err(error) = grab(callback) { /// println!("Error: {:?}", error) /// } /// } /// ``` #[cfg(any(feature = "unstable_grab"))] pub fn grab(callback: GrabCallback) -> Result<(), GrabError> { _grab(callback) }