1 //! Bindings to the client library `libwayland-server.so`
2 //!
3 //! The generated handle is named `WAYLAND_SERVER_HANDLE`
4 
5 #![cfg_attr(rustfmt, rustfmt_skip)]
6 
7 use super::common::*;
8 use libc::{gid_t, pid_t, uid_t};
9 use std::os::raw::{c_char, c_int, c_void};
10 
11 pub enum wl_client {}
12 pub enum wl_display {}
13 pub enum wl_event_loop {}
14 pub enum wl_event_source {}
15 pub enum wl_global {}
16 pub enum wl_resource {}
17 pub enum wl_shm_buffer {}
18 
19 pub type wl_event_loop_fd_func_t = unsafe extern "C" fn(c_int, u32, *mut c_void) -> c_int;
20 pub type wl_event_loop_timer_func_t = unsafe extern "C" fn(*mut c_void) -> c_int;
21 pub type wl_event_loop_signal_func_t = unsafe extern "C" fn(c_int, *mut c_void) -> c_int;
22 pub type wl_event_loop_idle_func_t = unsafe extern "C" fn(*mut c_void) -> ();
23 pub type wl_global_bind_func_t = unsafe extern "C" fn(*mut wl_client, *mut c_void, u32, u32) -> ();
24 pub type wl_notify_func_t = unsafe extern "C" fn(*mut wl_listener, *mut c_void) -> ();
25 pub type wl_resource_destroy_func_t = unsafe extern "C" fn(*mut wl_resource) -> ();
26 pub type wl_display_global_filter_func_t = unsafe extern "C" fn(*const wl_client, *const wl_global, *mut c_void) -> bool;
27 
28 #[repr(C)]
29 pub struct wl_listener {
30     pub link: wl_list,
31     pub notify: wl_notify_func_t,
32 }
33 
34 #[repr(C)]
35 pub struct wl_signal {
36     pub listener_list: wl_list,
37 }
38 
39 external_library!(WaylandServer, "wayland-server",
40     functions:
41     // wl_client
42         fn wl_client_flush(*mut wl_client) -> (),
43         fn wl_client_destroy(*mut wl_client) -> (),
44         fn wl_client_get_display(*mut wl_client) -> *mut wl_display,
45         fn wl_client_get_credentials(*mut wl_client, *mut pid_t, *mut uid_t, *mut gid_t) -> (),
46         fn wl_client_get_object(*mut wl_client, u32) -> *mut wl_resource,
47         fn wl_client_add_destroy_listener(*mut wl_client, *mut wl_listener) -> (),
48         fn wl_client_get_destroy_listener(*mut wl_client, wl_notify_func_t) -> *mut wl_listener,
49         fn wl_client_post_no_memory(*mut wl_client) -> (),
50         fn wl_resource_create(*mut wl_client, *const wl_interface, c_int, u32) -> *mut wl_resource,
51     // wl_display
52         fn wl_client_create(*mut wl_display, c_int) -> *mut wl_client,
53         fn wl_display_create() -> *mut wl_display,
54         fn wl_display_destroy(*mut wl_display) -> (),
55         fn wl_display_get_serial(*mut wl_display) -> u32,
56         fn wl_display_next_serial(*mut wl_display) -> u32,
57         fn wl_display_add_socket(*mut wl_display, *const c_char) -> c_int,
58         fn wl_display_add_socket_auto(*mut wl_display) -> *const c_char,
59         fn wl_display_add_socket_fd(*mut wl_display, c_int) -> c_int,
60         fn wl_display_add_shm_format(*mut wl_display, u32) -> *mut u32,
61         fn wl_display_get_event_loop(*mut wl_display) -> *mut wl_event_loop,
62         fn wl_display_terminate(*mut wl_display) -> (),
63         fn wl_display_run(*mut wl_display) -> (),
64         fn wl_display_flush_clients(*mut wl_display) -> (),
65         fn wl_display_add_destroy_listener(*mut wl_display, *mut wl_listener) -> (),
66         fn wl_display_get_destroy_listener(*mut wl_display, wl_notify_func_t) -> *mut wl_listener,
67         fn wl_global_create(*mut wl_display, *const wl_interface, c_int, *mut c_void, wl_global_bind_func_t) -> *mut wl_global,
68         fn wl_display_init_shm(*mut wl_display) -> c_int,
69         fn wl_display_add_client_created_listener(*mut wl_display, *mut wl_listener) -> (),
70         fn wl_display_set_global_filter(*mut wl_display, wl_display_global_filter_func_t, *mut c_void) -> (),
71     // wl_event_loop
72         fn wl_event_loop_create() -> *mut wl_event_loop,
73         fn wl_event_loop_destroy(*mut wl_event_loop) -> (),
74         fn wl_event_loop_add_fd(*mut wl_event_loop, c_int, u32, wl_event_loop_fd_func_t, *mut c_void) -> *mut wl_event_source,
75         fn wl_event_loop_add_timer(*mut wl_event_loop, wl_event_loop_timer_func_t, *mut c_void) -> *mut wl_event_source,
76         fn wl_event_loop_add_signal(*mut wl_event_loop, c_int, wl_event_loop_signal_func_t, *mut c_void) -> *mut wl_event_source,
77         fn wl_event_loop_dispatch(*mut wl_event_loop, c_int) -> c_int,
78         fn wl_event_loop_dispatch_idle(*mut wl_event_loop) -> (),
79         fn wl_event_loop_add_idle(*mut wl_event_loop, wl_event_loop_idle_func_t, *mut c_void) -> *mut wl_event_source,
80         fn wl_event_loop_get_fd(*mut wl_event_loop) -> c_int,
81         fn wl_event_loop_add_destroy_listener(*mut wl_event_loop, *mut wl_listener) -> (),
82         fn wl_event_loop_get_destroy_listener(*mut wl_event_loop, wl_notify_func_t) -> *mut wl_listener,
83     // wl_event_source
84         fn wl_event_source_fd_update(*mut wl_event_source, u32) -> c_int,
85         fn wl_event_source_timer_update(*mut wl_event_source, c_int) -> c_int,
86         fn wl_event_source_remove(*mut wl_event_source) -> c_int,
87         fn wl_event_source_check(*mut wl_event_source) -> (),
88     // wl_global
89         fn wl_global_destroy(*mut wl_global) -> (),
90         fn wl_global_get_user_data(*const wl_global) -> *mut c_void,
91     // wl_resource
92         fn wl_resource_post_event_array(*mut wl_resource, u32, *mut wl_argument) -> (),
93         fn wl_resource_queue_event_array(*mut wl_resource, u32, *mut wl_argument) -> (),
94         fn wl_resource_post_no_memory(*mut wl_resource) -> (),
95         fn wl_resource_set_implementation(*mut wl_resource, *const c_void, *mut c_void, Option<wl_resource_destroy_func_t>) -> (),
96         fn wl_resource_set_dispatcher(*mut wl_resource, wl_dispatcher_func_t, *const c_void, *mut c_void, Option<wl_resource_destroy_func_t>) -> (),
97         fn wl_resource_destroy(*mut wl_resource) -> (),
98         fn wl_resource_get_client(*mut wl_resource) -> *mut wl_client,
99         fn wl_resource_get_id(*mut wl_resource) -> u32,
100         fn wl_resource_get_link(*mut wl_resource) -> *mut wl_list,
101         fn wl_resource_from_link(*mut wl_list) -> *mut wl_resource,
102         fn wl_resource_find_for_client(*mut wl_list, *mut wl_client) -> (),
103         fn wl_resource_set_user_data(*mut wl_resource, *mut c_void) -> (),
104         fn wl_resource_get_user_data(*mut wl_resource) -> *mut c_void,
105         fn wl_resource_get_version(*mut wl_resource) -> c_int,
106         fn wl_resource_set_destructor(*mut wl_resource, Option<wl_resource_destroy_func_t>) -> (),
107         fn wl_resource_instance_of(*mut wl_resource, *const wl_interface, *const c_void) -> c_int,
108         fn wl_resource_add_destroy_listener(*mut wl_resource, wl_notify_func_t) -> (),
109         fn wl_resource_get_destroy_listener(*mut wl_resource,wl_notify_func_t) -> *mut wl_listener,
110     // wl_shm
111         fn wl_shm_buffer_begin_access(*mut wl_shm_buffer) -> (),
112         fn wl_shm_buffer_end_access(*mut wl_shm_buffer) -> (),
113         fn wl_shm_buffer_get(*mut wl_resource) -> *mut wl_shm_buffer,
114         fn wl_shm_buffer_get_data(*mut wl_shm_buffer) -> *mut c_void,
115         fn wl_shm_buffer_get_stride(*mut wl_shm_buffer) -> i32,
116         fn wl_shm_buffer_get_format(*mut wl_shm_buffer) -> u32,
117         fn wl_shm_buffer_get_width(*mut wl_shm_buffer) -> i32,
118         fn wl_shm_buffer_get_height(*mut wl_shm_buffer) -> i32,
119     // wl_log
120         fn wl_log_set_handler_server(wl_log_func_t) -> (),
121     // wl_list
122         fn wl_list_init(*mut wl_list) -> (),
123         fn wl_list_insert(*mut wl_list, *mut wl_list) -> (),
124         fn wl_list_remove(*mut wl_list) -> (),
125         fn wl_list_length(*const wl_list) -> c_int,
126         fn wl_list_empty(*const wl_list) -> c_int,
127         fn wl_list_insert_list(*mut wl_list,*mut wl_list) -> (),
128 
129     // arrays
130         fn wl_array_init(*mut wl_array) -> (),
131         fn wl_array_release(*mut wl_array) -> (),
132         fn wl_array_add(*mut wl_array,usize) -> (),
133         fn wl_array_copy(*mut wl_array, *mut wl_array) -> (),
134     varargs:
135         fn wl_resource_post_event(*mut wl_resource, u32) -> (),
136         fn wl_resource_queue_event(*mut wl_resource, u32) -> (),
137         fn wl_resource_post_error(*mut wl_resource, u32, *const c_char) -> (),
138 );
139 
140 #[cfg(feature = "dlopen")]
141 lazy_static!(
142     pub static ref WAYLAND_SERVER_OPTION: Option<WaylandServer> = {
143         // This is a workaround for Ubuntu 17.04, which doesn't have a bare symlink
144         // for libwayland-server.so but does have it with the version numbers for
145         // whatever reason.
146         //
147         // We could do some trickery with str slices but that is more trouble
148         // than its worth
149         let versions = ["libwayland-server.so",
150                         "libwayland-server.so.0"];
151         for ver in &versions {
152             match WaylandServer::open(ver) {
153                 Ok(h) => return Some(h),
154                 Err(::dlib::DlError::NotFound) => continue,
155                 Err(::dlib::DlError::MissingSymbol(s)) => {
156                     if ::std::env::var_os("WAYLAND_RS_DEBUG").is_some() {
157                         // only print debug messages if WAYLAND_RS_DEBUG is set
158                         eprintln!("[wayland-server] Found library {} cannot be used: symbol {} is missing.", ver, s);
159                     }
160                     return None;
161                 }
162             }
163         }
164         None
165     };
166     pub static ref WAYLAND_SERVER_HANDLE: &'static WaylandServer = {
167         WAYLAND_SERVER_OPTION.as_ref().expect("Library libwayland-server.so could not be loaded.")
168     };
169 );
170 
171 #[cfg(not(feature = "dlopen"))]
is_lib_available() -> bool172 pub fn is_lib_available() -> bool {
173     true
174 }
175 #[cfg(feature = "dlopen")]
is_lib_available() -> bool176 pub fn is_lib_available() -> bool {
177     WAYLAND_SERVER_OPTION.is_some()
178 }
179 
180 pub mod signal {
181     #[cfg(not(feature = "dlopen"))]
182     use super::{wl_list_init, wl_list_insert};
183     use super::{wl_listener, wl_notify_func_t, wl_signal};
184     #[cfg(feature = "dlopen")]
185     use super::WAYLAND_SERVER_HANDLE as WSH;
186     use common::wl_list;
187     use std::os::raw::c_void;
188     use std::ptr;
189 
190     // TODO: Is this really not UB ?
191     macro_rules! offset_of(
192         ($ty:ty, $field:ident) => {
193             &(*(0 as *const $ty)).$field as *const _ as usize
194         }
195     );
196 
197     macro_rules! container_of(
198         ($ptr: expr, $container: ty, $field: ident) => {
199             ($ptr as *mut u8).offset(-(offset_of!($container, $field) as isize)) as *mut $container
200         }
201     );
202 
203     macro_rules! list_for_each(
204         ($pos: ident, $head:expr, $container: ty, $field: ident, $action: block) => {
205             let mut $pos = container_of!((*$head).next, $container, $field);
206             while &mut (*$pos).$field as *mut _ != $head {
207                 $action;
208                 $pos = container_of!((*$pos).$field.next, $container, $field);
209             }
210         }
211     );
212 
213     macro_rules! list_for_each_safe(
214         ($pos: ident, $head: expr, $container: ty, $field: ident, $action: block) => {
215             let mut $pos = container_of!((*$head).next, $container, $field);
216             let mut tmp = container_of!((*$pos).$field.next, $container, $field);
217             while &mut (*$pos).$field as *mut _ != $head {
218                 $action;
219                 $pos = tmp;
220                 tmp = container_of!((*$pos).$field.next, $container, $field);
221             }
222         }
223     );
224 
wl_signal_init(signal: *mut wl_signal)225     pub unsafe fn wl_signal_init(signal: *mut wl_signal) {
226         ffi_dispatch!(WSH, wl_list_init, &mut (*signal).listener_list);
227     }
228 
wl_signal_add(signal: *mut wl_signal, listener: *mut wl_listener)229     pub unsafe fn wl_signal_add(signal: *mut wl_signal, listener: *mut wl_listener) {
230         ffi_dispatch!(
231             WSH,
232             wl_list_insert,
233             (*signal).listener_list.prev,
234             &mut (*listener).link
235         )
236     }
237 
wl_signal_get(signal: *mut wl_signal, notify: wl_notify_func_t) -> *mut wl_listener238     pub unsafe fn wl_signal_get(signal: *mut wl_signal, notify: wl_notify_func_t) -> *mut wl_listener {
239         list_for_each!(
240             l,
241             &mut (*signal).listener_list as *mut wl_list,
242             wl_listener,
243             link,
244             {
245                 if (*l).notify == notify {
246                     return l;
247                 }
248             }
249         );
250         return ptr::null_mut();
251     }
252 
wl_signal_emit(signal: *mut wl_signal, data: *mut c_void)253     pub unsafe fn wl_signal_emit(signal: *mut wl_signal, data: *mut c_void) {
254         list_for_each_safe!(
255             l,
256             &mut (*signal).listener_list as *mut wl_list,
257             wl_listener,
258             link,
259             {
260                 ((*l).notify)(l, data);
261             }
262         );
263     }
264 
265     #[repr(C)]
266     struct ListenerWithUserData {
267         listener: wl_listener,
268         user_data: *mut c_void
269     }
270 
rust_listener_create(notify: wl_notify_func_t) -> *mut wl_listener271     pub fn rust_listener_create(notify: wl_notify_func_t) -> *mut wl_listener {
272         let data = Box::into_raw(Box::new(ListenerWithUserData {
273             listener: wl_listener {
274                 link: wl_list {
275                     prev: ptr::null_mut(),
276                     next: ptr::null_mut()
277                 },
278                 notify: notify
279             },
280             user_data: ptr::null_mut()
281         }));
282         return unsafe { &mut (*data).listener as *mut wl_listener }
283     }
284 
rust_listener_get_user_data(listener: *mut wl_listener) -> *mut c_void285     pub unsafe fn rust_listener_get_user_data(listener: *mut wl_listener) -> *mut c_void {
286         let data = container_of!(listener, ListenerWithUserData, listener);
287         return (*data).user_data
288     }
289 
rust_listener_set_user_data(listener: *mut wl_listener, user_data: *mut c_void)290     pub unsafe fn rust_listener_set_user_data(listener: *mut wl_listener, user_data: *mut c_void) {
291         let data = container_of!(listener, ListenerWithUserData, listener);
292         (*data).user_data = user_data
293     }
294 
rust_listener_destroy(listener: *mut wl_listener)295     pub unsafe fn rust_listener_destroy(listener: *mut wl_listener) {
296         let data = container_of!(listener, ListenerWithUserData, listener);
297         let _ = Box::from_raw(data);
298     }
299 }
300