wayland_sys/
server.rs

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
7use super::common::*;
8#[cfg(feature = "server")]
9use libc::{gid_t, pid_t, uid_t};
10#[cfg(feature = "server")]
11use std::os::raw::c_char;
12use std::os::raw::{c_int, c_void};
13#[cfg(all(feature = "server", feature = "dlopen"))]
14use std::sync::LazyLock;
15
16pub enum wl_client {}
17pub enum wl_display {}
18pub enum wl_event_loop {}
19pub enum wl_event_source {}
20pub enum wl_global {}
21pub enum wl_resource {}
22pub enum wl_shm_buffer {}
23
24pub type wl_event_loop_fd_func_t = unsafe extern "C" fn(c_int, u32, *mut c_void) -> c_int;
25pub type wl_event_loop_timer_func_t = unsafe extern "C" fn(*mut c_void) -> c_int;
26pub type wl_event_loop_signal_func_t = unsafe extern "C" fn(c_int, *mut c_void) -> c_int;
27pub type wl_event_loop_idle_func_t = unsafe extern "C" fn(*mut c_void) -> ();
28pub type wl_global_bind_func_t = unsafe extern "C" fn(*mut wl_client, *mut c_void, u32, u32) -> ();
29pub type wl_global_withdrawn_func_t = unsafe extern "C" fn (*mut wl_global) -> ();
30pub type wl_notify_func_t = unsafe extern "C" fn(*mut wl_listener, *mut c_void) -> ();
31pub type wl_resource_destroy_func_t = unsafe extern "C" fn(*mut wl_resource) -> ();
32pub type wl_display_global_filter_func_t =
33    unsafe extern "C" fn(*const wl_client, *const wl_global, *mut c_void) -> bool;
34pub type wl_client_for_each_resource_iterator_func_t =
35    unsafe extern "C" fn(*mut wl_resource, *mut c_void) -> c_int;
36
37#[repr(C)]
38pub struct wl_listener {
39    pub link: wl_list,
40    pub notify: wl_notify_func_t,
41}
42
43#[repr(C)]
44pub struct wl_signal {
45    pub listener_list: wl_list,
46}
47
48#[cfg(feature = "server")]
49external_library!(WaylandServer, "wayland-server",
50    functions:
51    // wl_client
52        fn wl_client_flush(*mut wl_client) -> (),
53        fn wl_client_destroy(*mut wl_client) -> (),
54        fn wl_client_get_display(*mut wl_client) -> *mut wl_display,
55        fn wl_client_get_credentials(*mut wl_client, *mut pid_t, *mut uid_t, *mut gid_t) -> (),
56        fn wl_client_get_object(*mut wl_client, u32) -> *mut wl_resource,
57        fn wl_client_add_destroy_listener(*mut wl_client, *mut wl_listener) -> (),
58        fn wl_client_get_destroy_listener(*mut wl_client, wl_notify_func_t) -> *mut wl_listener,
59        fn wl_client_post_no_memory(*mut wl_client) -> (),
60        #[cfg(feature = "libwayland_server_1_23")]
61        fn wl_client_set_max_buffer_size(*mut wl_client, usize) -> (),
62        fn wl_resource_create(*mut wl_client, *const wl_interface, c_int, u32) -> *mut wl_resource,
63        fn wl_client_get_link(*mut wl_client) -> *mut wl_list,
64        fn wl_client_from_link(*mut wl_list) -> *mut wl_client,
65        fn wl_client_for_each_resource(*mut wl_client, wl_client_for_each_resource_iterator_func_t, *mut c_void) -> (),
66    // wl_display
67        fn wl_client_create(*mut wl_display, c_int) -> *mut wl_client,
68        fn wl_display_create() -> *mut wl_display,
69        fn wl_display_destroy(*mut wl_display) -> (),
70        fn wl_display_destroy_clients(*mut wl_display) -> (),
71        fn wl_display_get_serial(*mut wl_display) -> u32,
72        fn wl_display_next_serial(*mut wl_display) -> u32,
73        fn wl_display_add_socket(*mut wl_display, *const c_char) -> c_int,
74        fn wl_display_add_socket_auto(*mut wl_display) -> *const c_char,
75        fn wl_display_add_socket_fd(*mut wl_display, c_int) -> c_int,
76        fn wl_display_add_shm_format(*mut wl_display, u32) -> *mut u32,
77        fn wl_display_get_event_loop(*mut wl_display) -> *mut wl_event_loop,
78        fn wl_display_terminate(*mut wl_display) -> (),
79        fn wl_display_run(*mut wl_display) -> (),
80        fn wl_display_flush_clients(*mut wl_display) -> (),
81        fn wl_display_add_destroy_listener(*mut wl_display, *mut wl_listener) -> (),
82        fn wl_display_get_destroy_listener(*mut wl_display, wl_notify_func_t) -> *mut wl_listener,
83        fn wl_global_create(*mut wl_display, *const wl_interface, c_int, *mut c_void, wl_global_bind_func_t) -> *mut wl_global,
84        fn wl_display_init_shm(*mut wl_display) -> c_int,
85        fn wl_display_add_client_created_listener(*mut wl_display, *mut wl_listener) -> (),
86        fn wl_display_set_global_filter(*mut wl_display, wl_display_global_filter_func_t, *mut c_void) -> (),
87        fn wl_display_get_client_list(*mut wl_display) -> *mut wl_list,
88        #[cfg(feature = "libwayland_server_1_23")]
89        fn wl_display_set_default_max_buffer_size(*mut wl_display, usize) -> (),
90    // wl_event_loop
91        fn wl_event_loop_create() -> *mut wl_event_loop,
92        fn wl_event_loop_destroy(*mut wl_event_loop) -> (),
93        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,
94        fn wl_event_loop_add_timer(*mut wl_event_loop, wl_event_loop_timer_func_t, *mut c_void) -> *mut wl_event_source,
95        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,
96        fn wl_event_loop_dispatch(*mut wl_event_loop, c_int) -> c_int,
97        fn wl_event_loop_dispatch_idle(*mut wl_event_loop) -> (),
98        fn wl_event_loop_add_idle(*mut wl_event_loop, wl_event_loop_idle_func_t, *mut c_void) -> *mut wl_event_source,
99        fn wl_event_loop_get_fd(*mut wl_event_loop) -> c_int,
100        fn wl_event_loop_add_destroy_listener(*mut wl_event_loop, *mut wl_listener) -> (),
101        fn wl_event_loop_get_destroy_listener(*mut wl_event_loop, wl_notify_func_t) -> *mut wl_listener,
102    // wl_event_source
103        fn wl_event_source_fd_update(*mut wl_event_source, u32) -> c_int,
104        fn wl_event_source_timer_update(*mut wl_event_source, c_int) -> c_int,
105        fn wl_event_source_remove(*mut wl_event_source) -> c_int,
106        fn wl_event_source_check(*mut wl_event_source) -> (),
107    // wl_fixes
108        #[cfg(feature = "libwayland_server_1_26")]
109        fn wl_fixes_handle_ack_global_remove(*mut wl_resource, *mut wl_resource, u32) -> (),
110    // wl_global
111        fn wl_global_remove(*mut wl_global) -> (),
112        fn wl_global_destroy(*mut wl_global) -> (),
113        #[cfg(feature = "libwayland_server_1_22")]
114        fn wl_global_get_name(*mut wl_global, *mut wl_client) -> u32,
115        fn wl_global_get_user_data(*const wl_global) -> *mut c_void,
116        #[cfg(feature = "libwayland_server_1_26")]
117        fn wl_global_set_withdrawn_listener(*mut wl_global, wl_global_withdrawn_func_t) -> (),
118    // wl_resource
119        fn wl_resource_post_event_array(*mut wl_resource, u32, *mut wl_argument) -> (),
120        fn wl_resource_queue_event_array(*mut wl_resource, u32, *mut wl_argument) -> (),
121        fn wl_resource_post_no_memory(*mut wl_resource) -> (),
122        fn wl_resource_set_implementation(*mut wl_resource, *const c_void, *mut c_void, Option<wl_resource_destroy_func_t>) -> (),
123        fn wl_resource_set_dispatcher(*mut wl_resource, wl_dispatcher_func_t, *const c_void, *mut c_void, Option<wl_resource_destroy_func_t>) -> (),
124        fn wl_resource_destroy(*mut wl_resource) -> (),
125        fn wl_resource_get_client(*mut wl_resource) -> *mut wl_client,
126        fn wl_resource_get_id(*mut wl_resource) -> u32,
127        fn wl_resource_get_link(*mut wl_resource) -> *mut wl_list,
128        fn wl_resource_from_link(*mut wl_list) -> *mut wl_resource,
129        fn wl_resource_find_for_client(*mut wl_list, *mut wl_client) -> (),
130        fn wl_resource_set_user_data(*mut wl_resource, *mut c_void) -> (),
131        fn wl_resource_get_user_data(*mut wl_resource) -> *mut c_void,
132        fn wl_resource_get_version(*mut wl_resource) -> c_int,
133        fn wl_resource_get_class(*mut wl_resource) -> *const c_char,
134        fn wl_resource_set_destructor(*mut wl_resource, Option<wl_resource_destroy_func_t>) -> (),
135        fn wl_resource_instance_of(*mut wl_resource, *const wl_interface, *const c_void) -> c_int,
136        fn wl_resource_add_destroy_listener(*mut wl_resource, *mut wl_listener) -> (),
137        fn wl_resource_get_destroy_listener(*mut wl_resource, wl_notify_func_t) -> *mut wl_listener,
138    // wl_shm
139        fn wl_shm_buffer_begin_access(*mut wl_shm_buffer) -> (),
140        fn wl_shm_buffer_end_access(*mut wl_shm_buffer) -> (),
141        fn wl_shm_buffer_get(*mut wl_resource) -> *mut wl_shm_buffer,
142        fn wl_shm_buffer_get_data(*mut wl_shm_buffer) -> *mut c_void,
143        fn wl_shm_buffer_get_stride(*mut wl_shm_buffer) -> i32,
144        fn wl_shm_buffer_get_format(*mut wl_shm_buffer) -> u32,
145        fn wl_shm_buffer_get_width(*mut wl_shm_buffer) -> i32,
146        fn wl_shm_buffer_get_height(*mut wl_shm_buffer) -> i32,
147    // wl_log
148        fn wl_log_set_handler_server(wl_log_func_t) -> (),
149    // wl_list
150        fn wl_list_init(*mut wl_list) -> (),
151        fn wl_list_insert(*mut wl_list, *mut wl_list) -> (),
152        fn wl_list_remove(*mut wl_list) -> (),
153        fn wl_list_length(*const wl_list) -> c_int,
154        fn wl_list_empty(*const wl_list) -> c_int,
155        fn wl_list_insert_list(*mut wl_list,*mut wl_list) -> (),
156
157    // arrays
158        fn wl_array_init(*mut wl_array) -> (),
159        fn wl_array_release(*mut wl_array) -> (),
160        fn wl_array_add(*mut wl_array,usize) -> (),
161        fn wl_array_copy(*mut wl_array, *mut wl_array) -> (),
162    varargs:
163        fn wl_resource_post_event(*mut wl_resource, u32) -> (),
164        fn wl_resource_queue_event(*mut wl_resource, u32) -> (),
165        fn wl_resource_post_error(*mut wl_resource, u32, *const c_char) -> (),
166);
167
168#[cfg(all(feature = "server", feature = "dlopen"))]
169pub fn wayland_server_option() -> Option<&'static WaylandServer> {
170    static WAYLAND_SERVER_OPTION: LazyLock<Option<WaylandServer>> = LazyLock::new(||{
171        let versions = ["libwayland-server.so.0", "libwayland-server.so"];
172        for ver in &versions {
173            match unsafe { WaylandServer::open(ver) } {
174                Ok(h) => return Some(h),
175                Err(::dlib::DlError::CantOpen(_)) => continue,
176                Err(::dlib::DlError::MissingSymbol(s)) => {
177                    log::error!("Found library {ver} cannot be used: symbol {s} is missing.");
178                    return None;
179                }
180            }
181        }
182        None
183    });
184
185    WAYLAND_SERVER_OPTION.as_ref()
186}
187
188#[cfg(all(feature = "server", feature = "dlopen"))]
189pub fn wayland_server_handle() -> &'static WaylandServer {
190    static WAYLAND_SERVER_HANDLE: LazyLock<&'static WaylandServer> = LazyLock::new(|| wayland_server_option().expect("Library libwayland-server.so could not be loaded."));
191
192    &WAYLAND_SERVER_HANDLE
193}
194
195#[cfg(all(feature = "server", not(feature = "dlopen")))]
196pub fn is_lib_available() -> bool {
197    true
198}
199#[cfg(all(feature = "server", feature = "dlopen"))]
200pub fn is_lib_available() -> bool {
201    wayland_server_option().is_some()
202}
203
204#[cfg(feature = "server")]
205pub mod signal {
206    #![allow(clippy::cast_ptr_alignment, clippy::missing_safety_doc)]
207    #[cfg(feature = "dlopen")]
208    use super::wayland_server_handle as wsh;
209    #[cfg(not(feature = "dlopen"))]
210    use super::{wl_list_init, wl_list_insert};
211    use super::{wl_listener, wl_notify_func_t, wl_signal};
212    use crate::common::wl_list;
213    use std::os::raw::c_void;
214    use std::ptr;
215
216    macro_rules! container_of(
217        ($ptr: expr, $container: ident, $field: ident) => {
218            ($ptr as *mut u8).sub(core::mem::offset_of!($container, $field)) as *mut $container
219        }
220    );
221
222    macro_rules! list_for_each(
223        ($pos: ident, $head:expr, $container: ident, $field: ident, $action: block) => {
224            let mut $pos = container_of!((*$head).next, $container, $field);
225            while &mut (*$pos).$field as *mut _ != $head {
226                $action;
227                $pos = container_of!((*$pos).$field.next, $container, $field);
228            }
229        }
230    );
231
232    macro_rules! list_for_each_safe(
233        ($pos: ident, $head: expr, $container: ident, $field: ident, $action: block) => {
234            let mut $pos = container_of!((*$head).next, $container, $field);
235            let mut tmp = container_of!((*$pos).$field.next, $container, $field);
236            while &mut (*$pos).$field as *mut _ != $head {
237                $action;
238                $pos = tmp;
239                tmp = container_of!((*$pos).$field.next, $container, $field);
240            }
241        }
242    );
243
244    pub unsafe fn wl_signal_init(signal: *mut wl_signal) {
245        // Safety: signal is a valid initialized wl_signal
246        ffi_dispatch!(wsh(), wl_list_init, unsafe { &mut (*signal).listener_list });
247    }
248
249    pub unsafe fn wl_signal_add(signal: *mut wl_signal, listener: *mut wl_listener) {
250        // Safety: signal and listener are valid pointers
251        ffi_dispatch!(
252            wsh(),
253            wl_list_insert,
254            unsafe { (*signal).listener_list.prev },
255            unsafe { &mut (*listener).link }
256        )
257    }
258
259    pub unsafe fn wl_signal_get(
260        signal: *mut wl_signal,
261        notify: wl_notify_func_t,
262    ) -> *mut wl_listener {
263        // Safety: the signal pointer is valid
264        unsafe {
265            list_for_each!(l, &mut (*signal).listener_list as *mut wl_list, wl_listener, link, {
266                // nightly only lint
267                #[allow(unknown_lints)]
268                #[allow(unpredictable_function_pointer_comparisons)]
269                if (*l).notify == notify {
270                    return l;
271                }
272            });
273        }
274
275        ptr::null_mut()
276    }
277
278    pub unsafe fn wl_signal_emit(signal: *mut wl_signal, data: *mut c_void) {
279        // Safety: the signal pointer is valid
280        unsafe {
281            list_for_each_safe!(l, &mut (*signal).listener_list as *mut wl_list, wl_listener, link, {
282                ((*l).notify)(l, data);
283            });
284        }
285    }
286
287    #[repr(C)]
288    struct ListenerWithUserData {
289        listener: wl_listener,
290        user_data: *mut c_void,
291    }
292
293    pub fn rust_listener_create(notify: wl_notify_func_t) -> *mut wl_listener {
294        let data = Box::into_raw(Box::new(ListenerWithUserData {
295            listener: wl_listener {
296                link: wl_list { prev: ptr::null_mut(), next: ptr::null_mut() },
297                notify,
298            },
299            user_data: ptr::null_mut(),
300        }));
301
302        // SAFETY: data is a valid pointer for `ListenerWithUserData`.
303        unsafe { std::ptr::addr_of_mut!((*data).listener) }
304    }
305
306    pub unsafe fn rust_listener_get_user_data(listener: *mut wl_listener) -> *mut c_void {
307        // Safety: listener is a valid pointer to a listener created by rust_listener_create
308        let data = unsafe { container_of!(listener, ListenerWithUserData, listener) };
309        unsafe { (*data).user_data }
310    }
311
312    pub unsafe fn rust_listener_set_user_data(listener: *mut wl_listener, user_data: *mut c_void) {
313        // Safety: listener is a valid pointer to a listener created by rust_listener_create
314        let data = unsafe { container_of!(listener, ListenerWithUserData, listener) };
315        unsafe { (*data).user_data = user_data }
316    }
317
318    pub unsafe fn rust_listener_destroy(listener: *mut wl_listener) {
319        // Safety: listener is a valid pointer to a listener created by rust_listener_create
320        let data = unsafe { container_of!(listener, ListenerWithUserData, listener) };
321        let _ = unsafe { Box::from_raw(data) };
322    }
323}
wayland_sys/server.rs

wayland_sys/
server.rs
