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
//! FFI bindings to the wayland system libraries. //! //! The names exported by this crate should *not* be used directly, but though //! the `ffi_dispatch` macro like this: //! //! ```ignore //! ffi_dispatch!(HANDLE_NAME, func_name, arg1, arg2, arg3); //! ``` //! //! Where `HANDLE_NAME` is the name of the handle generated if the cargo feature //! `dlopen` is on. //! //! For this to work, you must ensure every needed symbol is in scope (aka the static handle //! if `dlopen` is on, the extern function if not). The easiest way to do this is to glob import //! the appropriate module. For example: //! //! ```ignore //! #[macro_use] extern crate wayland_sys; //! //! use wayland_sys::client::*; //! //! fn main() { //! let display_ptr = unsafe { //! ffi_dispatch!(WAYLAND_CLIENT_HANDLE, wl_display_connect, ::std::ptr::null()) //! }; //! } //! ``` //! //! Each module except `common` corresponds to a system library. They all define a function named //! `is_lib_available()` which returns a boolean depending on whether the lib could be loaded. //! They always return true if the feature `dlopen` is absent, as the lib is then directly linked. #![allow(non_camel_case_types)] // If compiling with neither the `client` or `server` feature (non-sensical but // it's what happens when running `cargo test --all` from the workspace root), // dlib isn't actually used. This is not an issue, so don't warn about it. #[allow(unused_imports)] #[macro_use] extern crate dlib; // Same as with dlib, only that it's a little harder to accidentally trigger // (dlopen feature enabled, client and server features disabled) #[allow(unused_imports)] #[cfg(feature = "dlopen")] #[macro_use] extern crate lazy_static; #[cfg(feature = "server")] extern crate libc; /// Magic pointer for wayland objects managed by wayland-client or wayland-server /// /// This static serves no purpose other than existing, and thus providing a stable pointer /// to something we know what it is. /// /// It is used internally by wayland-client, wayland-server and wayland-scanner to ensure safety /// regarding to wayland objects that are created by some other library. pub static RUST_MANAGED: u8 = 42; pub mod common; #[cfg(feature = "client")] pub mod client; #[cfg(feature = "server")] pub mod server; #[cfg(all(feature = "egl", feature = "client"))] pub mod egl; #[cfg(all(feature = "cursor", feature = "client"))] pub mod cursor; #[cfg(feature = "server")] pub use libc::{gid_t, pid_t, uid_t}; // Small hack while #[macro_reexport] is not stable #[cfg(feature = "dlopen")] #[macro_export] macro_rules! ffi_dispatch( ($handle: ident, $func: ident, $($arg: expr),*) => ( ($handle.$func)($($arg),*) ) ); #[cfg(not(feature = "dlopen"))] #[macro_export] macro_rules! ffi_dispatch( ($handle: ident, $func: ident, $($arg: expr),*) => ( $func($($arg),*) ) );