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
//! # Libinput bindings for rust
//!
//! These bindings closely follow libinput's concepts and it's original API.
//! Please refer to the [libinput documentation](https://wayland.freedesktop.org/libinput/doc/latest/)
//! to understand the general structure and concepts.
//!
//! ## Differences to the C-Library:
//!
//! - Refcounting does not need to be done manually. Just call `clone` when you need an additional reference.
//! - Libinput logging cannot (currently) not be customized.
//!
//! ## Userdata handling
//!
//! Multiple types in the libinput library allow to attach a pointer of an arbitrary type, so called `userdata`.
//! Using this data is unsafe as there is no way to find out what type is stored in the libinput struct.
//! Additionally multiple references to the same libinput object may exist and userdata may be shared mutably.
//!
//! This is why using and setting userdata is an unsafe operation (except when creating an object).
//!
//! If you heavily rely on userdata, you should always stored them wrapped in a `Mutex` and use the same
//! type for every userdata access to further simplify usage.
//!
//! You need to be especially cautious when initializing libinput types from raw pointers, you obtained
//! from other libraries which may set their own userdata. If accessing their userdata make sure no shared
//! mutable access may happen and don't store something else instead, if the library does not explicitly
//! allow this.
//!
//! Generally usage of this api is error-prone and discouraged if not needed.
//!
//! ## Getting started
//!
//! To get started check out the [`Libinput` struct](./struct.Libinput.html).
//!
#![deny(missing_docs)]
extern crate input_sys;
extern crate libc;
#[macro_use]
extern crate bitflags;
#[cfg(feature = "udev")]
extern crate udev;
/// Unsafe c-api.
pub mod ffi {
pub use input_sys::*;
}
/// Trait for types that allow to optain the underlying raw libinput pointer.
pub trait AsRaw<T> {
/// Receive a raw pointer representing this type.
fn as_raw(&self) -> *const T;
#[doc(hidden)]
fn as_raw_mut(&self) -> *mut T {
self.as_raw() as *mut _
}
}
/// Trait to receive the underlying context
pub trait Context {
/// Returns the underlying libinput context
fn context(&self) -> &Libinput;
}
/// Trait for types that allow to be initialized from a raw pointer
pub trait FromRaw<T> {
/// Create a new instance of this type from a raw pointer and it's context.
///
/// ## Warning
///
/// If you make use of [`Userdata`](./trait.Userdata.html) make sure you use the correct types
/// to allow receiving the set userdata. When dealing with raw pointers initialized by other
/// libraries this must be done extra carefully to select a correct representation.
///
/// If unsure using `()` is always a safe option..
///
/// ## Unsafety
///
/// If the pointer is pointing to a different struct, invalid memory or `NULL` the returned
/// struct may panic on use or cause other undefined behavior.
unsafe fn from_raw(*mut T, context: &context::Libinput) -> Self;
}
macro_rules! ffi_ref_struct {
($(#[$attr:meta])* struct $struct_name:ident, $ffi_name:path, $ref_fn:path, $unref_fn:path) => (
#[derive(Eq)]
$(#[$attr])*
pub struct $struct_name
{
ffi: *mut $ffi_name,
context: $crate::context::Libinput,
}
impl ::std::fmt::Debug for $struct_name {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
write!(f, "$struct_name @{:p}", self.as_raw())
}
}
impl $crate::FromRaw<$ffi_name> for $struct_name
{
unsafe fn from_raw(ffi: *mut $ffi_name, context: &$crate::Libinput) -> Self {
$struct_name {
ffi: $ref_fn(ffi),
context: context.clone(),
}
}
}
impl $crate::AsRaw<$ffi_name> for $struct_name
{
fn as_raw(&self) -> *const $ffi_name {
self.ffi as *const _
}
}
impl $crate::Context for $struct_name
{
fn context(&self) -> &$crate::Libinput {
&self.context
}
}
impl Clone for $struct_name {
fn clone(&self) -> Self {
unsafe { $struct_name::from_raw(self.as_raw_mut(), &self.context) }
}
}
impl Drop for $struct_name
{
fn drop(&mut self) {
unsafe {
$unref_fn(self.ffi);
}
}
}
impl PartialEq for $struct_name {
fn eq(&self, other: &Self) -> bool {
self.as_raw() == other.as_raw()
}
}
impl ::std::hash::Hash for $struct_name {
fn hash<H: ::std::hash::Hasher>(&self, state: &mut H) {
self.as_raw().hash(state);
}
}
)
}
macro_rules! ffi_func {
($(#[$attr:meta])* fn $name:ident, $ffi_fn:path, bool) => (
$(#[$attr])*
fn $name(&self) -> bool {
unsafe { $ffi_fn(self.as_raw_mut()) != 0 }
}
);
($(#[$attr:meta])* pub fn $name:ident, $ffi_fn:path, bool) => (
$(#[$attr])*
pub fn $name(&self) -> bool {
unsafe { $ffi_fn(self.as_raw_mut()) != 0 }
}
);
($(#[$attr:meta])* fn $name:ident, $ffi_fn:path, $return_type:ty) => (
$(#[$attr])*
fn $name(&self) -> $return_type {
unsafe { $ffi_fn(self.as_raw_mut()) as $return_type }
}
);
($(#[$attr:meta])* pub fn $name:ident, $ffi_fn:path, $return_type:ty) => (
$(#[$attr])*
pub fn $name(&self) -> $return_type {
unsafe { $ffi_fn(self.as_raw_mut()) as $return_type }
}
);
}
mod context;
mod device;
pub mod event;
mod seat;
pub use context::*;
pub use device::*;
pub use event::Event;
pub use seat::*;