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 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
use {TimeVal, ReadStatus, InputEvent, LedState, ReadFlag, GrabMode, AbsInfo}; use libc::{c_int, c_uint, c_void}; use std::any::Any; use std::ffi::CString; use std::fs::File; use std::io; use std::os::unix::io::{AsRawFd, FromRawFd}; use std::ptr; use enums::*; use util::*; /// Opaque struct representing an evdev device pub struct Device { // The file descriptor of the device must live as long as the device itself. _file: Option<File>, pub(crate) raw: *mut raw::libevdev, } impl Device { /// Initialize a new libevdev device. /// /// This function only initializesthe struct to sane default values. /// To actually hook up the device to a kernel device, use `set_fd`. pub fn new() -> Option<Device> { let libevdev = unsafe { raw::libevdev_new() }; if libevdev.is_null() { None } else { Some(Device { _file: None, raw: libevdev, }) } } /// Initialize a new libevdev device from the given fd. /// /// This is a shortcut for /// /// ``` /// use evdev_rs::Device; /// # use std::fs::File; /// /// let mut device = Device::new().unwrap(); /// # let fd = File::open("/dev/input/event0").unwrap(); /// device.set_fd(fd); /// ``` pub fn new_from_fd(file: File) -> io::Result<Device> { let mut libevdev = 0 as *mut _; let result = unsafe { raw::libevdev_new_from_fd(file.as_raw_fd(), &mut libevdev) }; match result { 0 => Ok(Device { _file: Some(file), raw: libevdev }), error => Err(io::Error::from_raw_os_error(-error)), } } string_getter!(name, libevdev_get_name, phys, libevdev_get_phys, uniq, libevdev_get_uniq); string_setter!(set_name, libevdev_set_name, set_phys, libevdev_set_phys, set_uniq, libevdev_set_uniq); /// Returns the file associated with the device /// /// if the `set_fd` hasn't been called yet then it return `None` pub fn fd(&self) -> Option<File> { let result = unsafe { raw::libevdev_get_fd(self.raw) }; if result == 0 { None } else { unsafe { let f = File::from_raw_fd(result); Some(f) } } } /// Set the file for this struct and initialize internal data. /// /// This function may only be called once per device. If the device changed and /// you need to re-read a device, use `new` method. If you need to change the file after /// closing and re-opening the same device, use `change_fd`. /// /// Unless otherwise specified, evdev function behavior is undefined until /// a successfull call to `set_fd`. pub fn set_fd(&mut self, file: File) -> io::Result<()> { let result = unsafe { raw::libevdev_set_fd(self.raw, file.as_raw_fd()) }; match result { 0 => { self._file = Some(file); Ok(()) }, error => Err(io::Error::from_raw_os_error(-error)) } } /// Change the fd for this device, without re-reading the actual device. /// /// If the fd changes after initializing the device, for example after a /// VT-switch in the X.org X server, this function updates the internal fd /// to the newly opened. No check is made that new fd points to the same /// device. If the device has changed, evdev's behavior is undefined. /// /// evdev device does not sync itself after changing the fd and keeps the current /// device state. Use next_event with the FORCE_SYNC flag to force a re-sync. /// /// # Example /// /// ```rust,ignore /// dev.change_fd(new_fd); /// dev.next_event(evdev::FORCE_SYNC); /// while dev.next_event(evdev::SYNC).ok().unwrap().0 == ReadStatus::SYNC /// {} // noop /// ``` /// After changing the fd, the device is assumed ungrabbed and a caller must /// call libevdev_grab() again. /// /// It is an error to call this function before calling set_fd(). pub fn change_fd(&mut self, file: File) -> io::Result<()> { let result = unsafe { raw::libevdev_change_fd(self.raw, file.as_raw_fd()) }; match result { 0 => { self._file = Some(file); Ok(()) }, error => Err(io::Error::from_raw_os_error(-error)) } } /// Grab or ungrab the device through a kernel EVIOCGRAB. /// /// This prevents other clients (including kernel-internal ones such as /// rfkill) from receiving events from this device. This is generally a /// bad idea. Don't do this.Grabbing an already grabbed device, or /// ungrabbing an ungrabbed device is a noop and always succeeds. /// /// A grab is an operation tied to a file descriptor, not a device. If a /// client changes the file descriptor with libevdev_change_fd(), it must /// also re-issue a grab with libevdev_grab(). pub fn grab(&mut self, grab: GrabMode) -> io::Result<()> { let result = unsafe { raw::libevdev_grab(self.raw, grab as c_int) }; match result { 0 => Ok(()), error => Err(io::Error::from_raw_os_error(-error)), } } /// Get the axis info for the given axis, as advertised by the kernel. /// /// Returns the `AbsInfo` for the given the code or None if the device /// doesn't support this code pub fn abs_info(&self, code: &EventCode) -> Option<AbsInfo> { let (_, ev_code) = event_code_to_int(code); let a = unsafe { raw::libevdev_get_abs_info(self.raw, ev_code) }; if a.is_null() { return None } unsafe { let absinfo = AbsInfo { value: (*a).value, minimum: (*a).minimum, maximum: (*a).maximum, fuzz: (*a).fuzz, flat: (*a).flat, resolution: (*a).resolution, }; Some(absinfo) } } /// Change the abs info for the given EV_ABS event code, if the code exists. /// /// This function has no effect if `has_event_code` returns false for /// this code. pub fn set_abs_info(&self, code: &EventCode, absinfo: &AbsInfo) { let (_, ev_code) = event_code_to_int(code); unsafe { raw::libevdev_set_abs_info(self.raw, ev_code, &absinfo.as_raw() as *const _); } } /// Returns `true` if device support the InputProp/EventType/EventCode and false otherwise pub fn has(&self, blob: &dyn Any) -> bool { if let Some(ev_type) = blob.downcast_ref::<EventType>() { self.has_event_type(ev_type) } else if let Some(ev_code) = blob.downcast_ref::<EventCode>() { self.has_event_code(ev_code) } else if let Some(prop) = blob.downcast_ref::<InputProp>() { self.has_property(prop) } else { false } } /// Forcibly enable an EventType/InputProp on this device, even if the underlying /// device does not support it. While this cannot make the device actually /// report such events, it will now return true for has(). /// /// This is a local modification only affecting only this representation of /// this device. pub fn enable(&self, blob: &dyn Any) -> io::Result<()> { if let Some(ev_type) = blob.downcast_ref::<EventType>() { self.enable_event_type(ev_type) } else if let Some(ev_code) = blob.downcast_ref::<EventCode>() { self.enable_event_code(ev_code, None) } else if let Some(prop) = blob.downcast_ref::<InputProp>() { self.enable_property(prop) } else { Err(io::Error::from_raw_os_error(-1)) } } /// Returns `true` if device support the property and false otherwise /// /// Note: Please use the `has` function instead. This function is only /// available for the sake of maintaining compatibility with libevdev. pub fn has_property(&self, prop: &InputProp) -> bool { unsafe { raw::libevdev_has_property(self.raw, prop.clone() as c_uint) != 0 } } /// Enables this property, a call to `set_fd` will overwrite any previously set values /// /// Note: Please use the `enable` function instead. This function is only /// available for the sake of maintaining compatibility with libevdev. pub fn enable_property(&self, prop: &InputProp) -> io::Result<()> { let result = unsafe { raw::libevdev_enable_property(self.raw, prop.clone() as c_uint) as i32 }; match result { 0 => Ok(()), error => Err(io::Error::from_raw_os_error(-error)) } } /// Returns `true` is the device support this event type and `false` otherwise /// /// Note: Please use the `has` function instead. This function is only /// available for the sake of maintaining compatibility with libevdev. pub fn has_event_type(&self, ev_type: &EventType) -> bool { unsafe { raw::libevdev_has_event_type(self.raw, ev_type.clone() as c_uint) != 0 } } /// Return `true` is the device support this event type and code and `false` otherwise /// /// Note: Please use the `has` function instead. This function is only /// available for the sake of maintaining compatibility with libevdev. pub fn has_event_code(&self, code: &EventCode) -> bool { unsafe { let (ev_type, ev_code) = event_code_to_int(code); raw::libevdev_has_event_code(self.raw, ev_type, ev_code) != 0 } } /// Returns the current value of the event type. /// /// If the device supports this event type and code, the return value is /// set to the current value of this axis. Otherwise, `None` is returned. pub fn event_value(&self, code: &EventCode) -> Option<i32> { let mut value: i32 = 0; let (ev_type, ev_code) = event_code_to_int(code); let valid = unsafe { raw::libevdev_fetch_event_value(self.raw, ev_type, ev_code , &mut value) }; match valid { 0 => None, _ => Some(value), } } /// Set the value for a given event type and code. /// /// This only makes sense for some event types, e.g. setting the value for /// EV_REL is pointless. /// /// This is a local modification only affecting only this representation of /// this device. A future call to event_value() will return this /// value, unless the value was overwritten by an event. /// /// If the device supports ABS_MT_SLOT, the value set for any ABS_MT_* /// event code is the value of the currently active slot. You should use /// `set_slot_value` instead. /// /// If the device supports ABS_MT_SLOT and the type is EV_ABS and the code is /// ABS_MT_SLOT, the value must be a positive number less then the number of /// slots on the device. Otherwise, `set_event_value` returns Err. pub fn set_event_value(&self, code: &EventCode, val: i32) -> io::Result<()> { let (ev_type, ev_code) = event_code_to_int(code); let result = unsafe { raw::libevdev_set_event_value(self.raw, ev_type, ev_code, val as c_int) }; match result { 0 => Ok(()), error => Err(io::Error::from_raw_os_error(-error)) } } /// Check if there are events waiting for us. /// /// This function does not read an event off the fd and may not access the /// fd at all. If there are events queued internally this function will /// return non-zero. If the internal queue is empty, this function will poll /// the file descriptor for data. /// /// This is a convenience function for simple processes, most complex programs /// are expected to use select(2) or poll(2) on the file descriptor. The kernel /// guarantees that if data is available, it is a multiple of sizeof(struct /// input_event), and thus calling `next_event` when select(2) or /// poll(2) return is safe. You do not need `has_event_pending` if /// you're using select(2) or poll(2). pub fn has_event_pending(&self) -> bool { unsafe { raw::libevdev_has_event_pending(self.raw) > 0 } } product_getter!(product_id, libevdev_get_id_product, vendor_id, libevdev_get_id_vendor, bustype, libevdev_get_id_bustype, version, libevdev_get_id_version); product_setter!(set_product_id, libevdev_set_id_product, set_vendor_id, libevdev_set_id_vendor, set_bustype, libevdev_set_id_bustype, set_version, libevdev_set_id_version); /// Return the driver version of a device already intialize with `set_fd` pub fn driver_version(&self) -> i32 { unsafe { raw::libevdev_get_driver_version(self.raw) as i32 } } abs_getter!(abs_minimum, libevdev_get_abs_minimum, abs_maximum, libevdev_get_abs_maximum, abs_fuzz, libevdev_get_abs_fuzz, abs_flat, libevdev_get_abs_flat, abs_resolution, libevdev_get_abs_resolution); abs_setter!(set_abs_minimum, libevdev_set_abs_minimum, set_abs_maximum, libevdev_set_abs_maximum, set_abs_fuzz, libevdev_set_abs_fuzz, set_abs_flat, libevdev_set_abs_flat, set_abs_resolution, libevdev_set_abs_resolution); /// Return the current value of the code for the given slot. /// /// If the device supports this event code, the return value is /// is set to the current value of this axis. Otherwise, or /// if the event code is not an ABS_MT_* event code, `None` is returned pub fn slot_value(&self, slot: u32, code: &EventCode) -> Option<i32> { let (_, ev_code) = event_code_to_int(code); let mut value: i32 = 0; let valid = unsafe { raw::libevdev_fetch_slot_value(self.raw, slot as c_uint, ev_code, &mut value) }; match valid { 0 => None, _ => Some(value), } } /// Set the value for a given code for the given slot. /// /// This is a local modification only affecting only this representation of /// this device. A future call to `slot_value` will return this value, /// unless the value was overwritten by an event. /// /// This function does not set event values for axes outside the ABS_MT range, /// use `set_event_value` instead. pub fn set_slot_value(&self, slot: u32, code: &EventCode, val: i32) -> io::Result<()> { let (_, ev_code) = event_code_to_int(code); let result = unsafe { raw::libevdev_set_slot_value(self.raw, slot as c_uint, ev_code, val as c_int) }; match result { 0 => Ok(()), error => Err(io::Error::from_raw_os_error(-error)) } } /// Get the number of slots supported by this device. /// /// The number of slots supported, or `None` if the device does not provide /// any slots /// /// A device may provide ABS_MT_SLOT but a total number of 0 slots. Hence /// the return value of `None` for "device does not provide slots at all" pub fn num_slots(&self) -> Option<i32> { let result = unsafe { raw::libevdev_get_num_slots(self.raw) }; match result { -1 => None, slots => Some(slots), } } /// Get the currently active slot. /// /// This may differ from the value an ioctl may return at this time as /// events may have been read off the fd since changing the slot value /// but those events are still in the buffer waiting to be processed. /// The returned value is the value a caller would see if it were to /// process events manually one-by-one. pub fn current_slot(&self) -> Option<i32> { let result = unsafe { raw::libevdev_get_current_slot(self.raw) }; match result { -1 => None, slots => Some(slots), } } /// Forcibly enable an event type on this device, even if the underlying /// device does not support it. While this cannot make the device actually /// report such events, it will now return true for libevdev_has_event_type(). /// /// This is a local modification only affecting only this representation of /// this device. /// /// Note: Please use the `enable` function instead. This function is only /// available for the sake of maintaining compatibility with libevdev. pub fn enable_event_type(&self, ev_type: &EventType) -> io::Result<()> { let result = unsafe { raw::libevdev_enable_event_type(self.raw, ev_type.clone() as c_uint) }; match result { 0 => Ok(()), error => Err(io::Error::from_raw_os_error(-error)) } } /// Forcibly enable an event type on this device, even if the underlying /// device does not support it. While this cannot make the device actually /// report such events, it will now return true for libevdev_has_event_code(). /// /// The last argument depends on the type and code: /// If type is EV_ABS, data must be a pointer to a struct input_absinfo /// containing the data for this axis. /// If type is EV_REP, data must be a pointer to a int containing the data /// for this axis. /// For all other types, the argument must be NULL. /// /// Note: Please use the `enable` function instead. This function is only /// available for the sake of maintaining compatibility with libevdev. pub fn enable_event_code(&self, ev_code: &EventCode, blob: Option<&dyn Any>) -> io::Result<()> { let (ev_type, ev_code) = event_code_to_int(ev_code); let data = blob .map(|data| { data.downcast_ref::<AbsInfo>() .map(|absinfo| &absinfo.as_raw() as *const _ as *const c_void) .unwrap_or_else(|| data as *const _ as *const c_void) }) .unwrap_or_else(|| ptr::null() as *const _ as *const c_void); let result = unsafe { raw::libevdev_enable_event_code(self.raw, ev_type as c_uint, ev_code as c_uint, data) }; match result { 0 => Ok(()), error => Err(io::Error::from_raw_os_error(-error)) } } /// Forcibly disable an EventType/EventCode on this device, even if the /// underlying device provides it. This effectively mutes the respective set of /// events. has() will return false for this EventType/EventCode /// /// In most cases, a caller likely only wants to disable a single code, not /// the whole type. /// /// Disabling EV_SYN will not work. In Peter's Words "Don't shoot yourself /// in the foot. It hurts". /// /// This is a local modification only affecting only this representation of /// this device. pub fn disable(&self, blob: &dyn Any) -> io::Result<()> { if let Some(ev_type) = blob.downcast_ref::<EventType>() { self.disable_event_type(ev_type) } else if let Some(ev_code) = blob.downcast_ref::<EventCode>() { self.disable_event_code(ev_code) } else { Err(io::Error::from_raw_os_error(-1)) } } /// Forcibly disable an event type on this device, even if the underlying /// device provides it. This effectively mutes the respective set of /// events. libevdev will filter any events matching this type and none will /// reach the caller. libevdev_has_event_type() will return false for this /// type. /// /// In most cases, a caller likely only wants to disable a single code, not /// the whole type. Use `disable_event_code` for that. /// /// Disabling EV_SYN will not work. In Peter's Words "Don't shoot yourself /// in the foot. It hurts". /// /// This is a local modification only affecting only this representation of /// this device. /// /// Note: Please use the `disable` function instead. This function is only /// available for the sake of maintaining compatibility with libevdev. pub fn disable_event_type(&self, ev_type: &EventType) -> io::Result<()> { let result = unsafe { raw::libevdev_disable_event_type(self.raw, ev_type.clone() as c_uint) }; match result { 0 => Ok(()), error => Err(io::Error::from_raw_os_error(-error)) } } /// Forcibly disable an event code on this device, even if the underlying /// device provides it. This effectively mutes the respective set of /// events. libevdev will filter any events matching this type and code and /// none will reach the caller. `has_event_code` will return false for /// this code. /// /// Disabling all event codes for a given type will not disable the event /// type. Use `disable_event_type` for that. /// /// This is a local modification only affecting only this representation of /// this device. /// /// Disabling codes of type EV_SYN will not work. Don't shoot yourself in the /// foot. It hurts. /// /// Note: Please use the `disable` function instead. This function is only /// available for the sake of maintaining compatibility with libevdev. pub fn disable_event_code(&self, code: &EventCode) -> io::Result<()> { let (ev_type, ev_code) = event_code_to_int(code); let result = unsafe { raw::libevdev_disable_event_code(self.raw, ev_type, ev_code) }; match result { 0 => Ok(()), error => Err(io::Error::from_raw_os_error(-error)) } } /// Set the device's EV_ABS axis to the value defined in the abs /// parameter. This will be written to the kernel. pub fn set_kernel_abs_info(&self, code: &EventCode, absinfo: &AbsInfo) { let (_, ev_code) = event_code_to_int(code); unsafe { raw::libevdev_kernel_set_abs_info(self.raw, ev_code, &absinfo.as_raw() as *const _); } } /// Turn an LED on or off. /// /// enabling an LED requires write permissions on the device's file descriptor. pub fn kernel_set_led_value(&self, code: &EventCode, value: LedState) -> io::Result<()> { let (_, ev_code) = event_code_to_int(code); let result = unsafe { raw::libevdev_kernel_set_led_value(self.raw, ev_code, value as c_int) }; match result { 0 => Ok(()), error => Err(io::Error::from_raw_os_error(-error)) } } /// Set the clock ID to be used for timestamps. Further events from this device /// will report an event time based on the given clock. /// /// This is a modification only affecting this representation of /// this device. pub fn set_clock_id(&self, clockid: i32) -> io::Result<()> { let result = unsafe { raw::libevdev_set_clock_id(self.raw, clockid as c_int) }; match result { 0 => Ok(()), error => Err(io::Error::from_raw_os_error(-error)) } } /// Get the next event from the device. This function operates in two different /// modes: normal mode or sync mode. /// /// In normal mode (when flags has `evdev::NORMAL` set), this function returns /// `ReadStatus::Success` and returns the event. If no events are available at /// this time, it returns `-EAGAIN` as `Err`. /// /// If the current event is an `EV_SYN::SYN_DROPPED` event, this function returns /// `ReadStatus::Sync` and is set to the `EV_SYN` event.The caller should now call /// this function with the `evdev::SYNC` flag set, to get the set of events that /// make up the device state delta. This function returns ReadStatus::Sync for /// each event part of that delta, until it returns `-EAGAIN` once all events /// have been synced. /// /// If a device needs to be synced by the caller but the caller does not call /// with the `evdev::SYNC` flag set, all events from the diff are dropped after /// evdev updates its internal state and event processing continues as normal. /// Note that the current slot and the state of touch points may have updated /// during the `SYN_DROPPED` event, it is strongly recommended that a caller /// ignoring all sync events calls `current_slot` and checks the /// `ABS_MT_TRACKING_ID` values for all slots. /// /// If a device has changed state without events being enqueued in evdev, /// e.g. after changing the file descriptor, use the `evdev::FORCE_SYNC` flag. /// This triggers an internal sync of the device and `next_event` returns /// `ReadStatus::Sync`. pub fn next_event(&self, flags: ReadFlag) -> io::Result<(ReadStatus, InputEvent)> { let mut ev = raw::input_event { time: raw::timeval { tv_sec: 0, tv_usec: 0, }, type_: 0, code: 0, value: 0, }; let result = unsafe { raw::libevdev_next_event(self.raw, flags.bits as c_uint, &mut ev) }; let event = InputEvent { time: TimeVal { tv_sec: ev.time.tv_sec, tv_usec: ev.time.tv_usec, }, event_type: int_to_event_type(ev.type_ as u32).unwrap(), event_code: int_to_event_code(ev.type_ as u32, ev.code as u32), value: ev.value, }; match result { raw::LIBEVDEV_READ_STATUS_SUCCESS => Ok((ReadStatus::Success, event)), raw::LIBEVDEV_READ_STATUS_SYNC => Ok((ReadStatus::Sync, event)), error => Err(io::Error::from_raw_os_error(-error)), } } } impl Drop for Device { fn drop(&mut self) { unsafe { raw::libevdev_free(self.raw); } } }