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
//! Utilities for binding globals with [`wl_registry`] in delegates.
//!
//! This module is based around the [`RegistryHandler`] trait and [`RegistryState`].
//!
//! [`RegistryState`] provides an interface to bind globals regularly, creating an object with each new
//! instantiation or caching bound globals to prevent duplicate object instances from being created. Binding
//! a global regularly is accomplished through [`RegistryState::bind_one`].
//!
//! The [`delegate_registry`](crate::delegate_registry) macro is used to implement handling for [`wl_registry`].
//!
//! ## Sample implementation of [`RegistryHandler`]
//!
//! ```
//! use smithay_client_toolkit::reexports::client::{
//! Connection, Dispatch, QueueHandle,
//! delegate_dispatch,
//! globals::GlobalList,
//! protocol::wl_output,
//! };
//!
//! use smithay_client_toolkit::registry::{
//! GlobalProxy, ProvidesRegistryState, RegistryHandler, RegistryState,
//! };
//!
//! struct ExampleApp {
//! /// The registry state is needed to use the global abstractions.
//! registry_state: RegistryState,
//! /// This is a type we want to delegate global handling to.
//! delegate_that_wants_registry: Delegate,
//! }
//!
//! /// The delegate a global should be provided to.
//! struct Delegate {
//! outputs: Vec<wl_output::WlOutput>,
//! }
//!
//! // When implementing RegistryHandler, you must be able to dispatch any type you could bind using the registry state.
//! impl<D> RegistryHandler<D> for Delegate
//! where
//! // In order to bind a global, you must statically assert the global may be handled with the data type.
//! D: Dispatch<wl_output::WlOutput, ()>
//! // ProvidesRegistryState provides a function to access the RegistryState within the impl.
//! + ProvidesRegistryState
//! // We need some way to access our part of the application's state. This uses AsMut,
//! // but you may prefer to create your own trait to avoid making .as_mut() ambiguous.
//! + AsMut<Delegate>
//! + 'static,
//! {
//! /// New global added after initial enumeration.
//! fn new_global(
//! data: &mut D,
//! conn: &Connection,
//! qh: &QueueHandle<D>,
//! name: u32,
//! interface: &str,
//! version: u32,
//! ) {
//! if interface == "wl_output" {
//! // Bind `wl_output` with newest version from 1 to 4 the compositor supports
//! let output = data.registry().bind_specific(qh, name, 1..=4, ()).unwrap();
//! data.as_mut().outputs.push(output);
//! }
//!
//! // You could either handle errors here or when attempting to use the interface. Most
//! // Wayland protocols are optional, so if your application can function without a
//! // protocol it should try to do so; the From impl of GlobalProxy is written to make
//! // this straightforward.
//! }
//! }
//! ```
use crate::{error::GlobalError, globals::ProvidesBoundGlobal};
use wayland_client::{
globals::{BindError, Global, GlobalList, GlobalListContents},
protocol::wl_registry,
Connection, Dispatch, Proxy, QueueHandle,
};
/// A trait implemented by modular parts of a smithay's client toolkit and protocol delegates that may be used
/// to receive notification of a global being created or destroyed.
///
/// Delegates that choose to implement this trait may be used in [`registry_handlers`] which
/// automatically notifies delegates about the creation and destruction of globals.
///
/// [`registry_handlers`]: crate::registry_handlers
///
/// Note that in order to delegate registry handling to a type which implements this trait, your `D` data type
/// must implement [`ProvidesRegistryState`].
pub trait RegistryHandler<D>
where
D: ProvidesRegistryState,
{
/// Called when a new global has been advertised by the compositor.
///
/// The provided registry handle may be used to bind the global. This is not called during
/// initial enumeration of globals. It is primarily useful for multi-instance globals such as
/// `wl_output` and `wl_seat`.
///
/// The default implementation does nothing.
fn new_global(
data: &mut D,
conn: &Connection,
qh: &QueueHandle<D>,
name: u32,
interface: &str,
version: u32,
) {
let _ = (data, conn, qh, name, interface, version);
}
/// Called when a global has been destroyed by the compositor.
///
/// The default implementation does nothing.
fn remove_global(
data: &mut D,
conn: &Connection,
qh: &QueueHandle<D>,
name: u32,
interface: &str,
) {
let _ = (data, conn, qh, name, interface);
}
}
/// Trait which asserts a data type may provide a mutable reference to the registry state.
///
/// Typically this trait will be required by delegates or [`RegistryHandler`] implementations which need
/// to access the registry utilities provided by Smithay's client toolkit.
pub trait ProvidesRegistryState: Sized {
/// Returns a mutable reference to the registry state.
fn registry(&mut self) -> &mut RegistryState;
/// Called when a new global has been advertised by the compositor.
///
/// This is not called during initial global enumeration.
fn runtime_add_global(
&mut self,
conn: &Connection,
qh: &QueueHandle<Self>,
name: u32,
interface: &str,
version: u32,
);
/// Called when a global has been destroyed by the compositor.
fn runtime_remove_global(
&mut self,
conn: &Connection,
qh: &QueueHandle<Self>,
name: u32,
interface: &str,
);
}
/// State object associated with the registry handling for smithay's client toolkit.
///
/// This object provides utilities to cache bound globals that are needed by multiple modules.
#[derive(Debug)]
pub struct RegistryState {
registry: wl_registry::WlRegistry,
globals: Vec<Global>,
}
impl RegistryState {
/// Creates a new registry handle.
///
/// This type may be used to bind globals as they are advertised.
pub fn new(global_list: &GlobalList) -> Self {
let registry = global_list.registry().clone();
let globals = global_list.contents().clone_list();
RegistryState { registry, globals }
}
pub fn registry(&self) -> &wl_registry::WlRegistry {
&self.registry
}
/// Returns an iterator over all globals.
///
/// This list may change if the compositor adds or removes globals after initial
/// enumeration.
///
/// No guarantees are provided about the ordering of the globals in this iterator.
pub fn globals(&self) -> impl Iterator<Item = &Global> + '_ {
self.globals.iter()
}
/// Returns an iterator over all globals implementing the given interface.
///
/// This may be more efficient than searching [Self::globals].
pub fn globals_by_interface<'a>(
&'a self,
interface: &'a str,
) -> impl Iterator<Item = &Global> + 'a {
self.globals.iter().filter(move |g| g.interface == interface)
}
/// Binds a global, returning a new object associated with the global.
///
/// This should not be used to bind globals that have multiple instances such as `wl_output`;
/// use [Self::bind_all] instead.
pub fn bind_one<I, D, U>(
&self,
qh: &QueueHandle<D>,
version: std::ops::RangeInclusive<u32>,
udata: U,
) -> Result<I, BindError>
where
D: Dispatch<I, U> + 'static,
I: Proxy + 'static,
U: Send + Sync + 'static,
{
bind_one(&self.registry, &self.globals, qh, version, udata)
}
/// Binds a global, returning a new object associated with the global.
///
/// This binds a specific object by its name as provided by the [RegistryHandler::new_global]
/// callback.
pub fn bind_specific<I, D, U>(
&self,
qh: &QueueHandle<D>,
name: u32,
version: std::ops::RangeInclusive<u32>,
udata: U,
) -> Result<I, BindError>
where
D: Dispatch<I, U> + 'static,
I: Proxy + 'static,
U: Send + Sync + 'static,
{
let iface = I::interface();
if *version.end() > iface.version {
// This is a panic because it's a compile-time programmer error, not a runtime error.
panic!("Maximum version ({}) was higher than the proxy's maximum version ({}); outdated wayland XML files?",
version.end(), iface.version);
}
// Optimize for runtime_add_global which will use the last entry
for global in self.globals.iter().rev() {
if global.name != name || global.interface != iface.name {
continue;
}
if global.version < *version.start() {
return Err(BindError::UnsupportedVersion);
}
let version = global.version.min(*version.end());
let proxy = self.registry.bind(global.name, version, qh, udata);
log::debug!(target: "sctk", "Bound new global [{}] {} v{}", global.name, iface.name, version);
return Ok(proxy);
}
Err(BindError::NotPresent)
}
/// Binds all globals with a given interface.
pub fn bind_all<I, D, U, F>(
&self,
qh: &QueueHandle<D>,
version: std::ops::RangeInclusive<u32>,
make_udata: F,
) -> Result<Vec<I>, BindError>
where
D: Dispatch<I, U> + 'static,
I: Proxy + 'static,
F: FnMut(u32) -> U,
U: Send + Sync + 'static,
{
bind_all(&self.registry, &self.globals, qh, version, make_udata)
}
}
/// Delegates the handling of [`wl_registry`].
///
/// Anything which implements [`RegistryHandler`] may be used in the delegate.
///
/// ## Usage
///
/// ```
/// use smithay_client_toolkit::{
/// delegate_registry, delegate_shm, registry_handlers,
/// shm::{ShmHandler, Shm},
/// };
///
/// struct ExampleApp {
/// shm_state: Shm,
/// }
///
/// // Here is the implementation of wl_shm to compile:
/// delegate_shm!(ExampleApp);
///
/// impl ShmHandler for ExampleApp {
/// fn shm_state(&mut self) -> &mut Shm {
/// &mut self.shm_state
/// }
/// }
/// ```
#[macro_export]
macro_rules! delegate_registry {
($(@<$( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+>)? $ty: ty) => {
$crate::reexports::client::delegate_dispatch!($(@< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)? $ty:
[
$crate::reexports::client::protocol::wl_registry::WlRegistry: $crate::reexports::client::globals::GlobalListContents
] => $crate::registry::RegistryState
);
};
}
impl<D> Dispatch<wl_registry::WlRegistry, GlobalListContents, D> for RegistryState
where
D: Dispatch<wl_registry::WlRegistry, GlobalListContents> + ProvidesRegistryState,
{
fn event(
state: &mut D,
_: &wl_registry::WlRegistry,
event: wl_registry::Event,
_: &GlobalListContents,
conn: &Connection,
qh: &QueueHandle<D>,
) {
match event {
wl_registry::Event::Global { name, interface, version } => {
let iface = interface.clone();
state.registry().globals.push(Global { name, interface, version });
state.runtime_add_global(conn, qh, name, &iface, version);
}
wl_registry::Event::GlobalRemove { name } => {
if let Some(i) = state.registry().globals.iter().position(|g| g.name == name) {
let global = state.registry().globals.swap_remove(i);
state.runtime_remove_global(conn, qh, name, &global.interface);
}
}
_ => unreachable!("wl_registry is frozen"),
}
}
}
/// A helper for storing a bound global.
///
/// This helper is intended to simplify the implementation of [RegistryHandler] for state objects
/// that cache a bound global.
#[derive(Debug)]
pub enum GlobalProxy<I> {
/// The requested global was not present after a complete enumeration.
NotPresent,
/// The cached global.
Bound(I),
}
impl<I> From<Result<I, BindError>> for GlobalProxy<I> {
fn from(r: Result<I, BindError>) -> Self {
match r {
Ok(proxy) => GlobalProxy::Bound(proxy),
Err(_) => GlobalProxy::NotPresent,
}
}
}
impl<I: Proxy> GlobalProxy<I> {
pub fn get(&self) -> Result<&I, GlobalError> {
self.with_min_version(0)
}
pub fn with_min_version(&self, min_version: u32) -> Result<&I, GlobalError> {
match self {
GlobalProxy::Bound(proxy) => {
if proxy.version() < min_version {
Err(GlobalError::InvalidVersion {
name: I::interface().name,
required: min_version,
available: proxy.version(),
})
} else {
Ok(proxy)
}
}
GlobalProxy::NotPresent => Err(GlobalError::MissingGlobal(I::interface().name)),
}
}
}
#[derive(Debug)]
pub struct SimpleGlobal<I, const MAX_VERSION: u32> {
proxy: GlobalProxy<I>,
}
impl<I: Proxy + 'static, const MAX_VERSION: u32> SimpleGlobal<I, MAX_VERSION> {
pub fn bind<State>(globals: &GlobalList, qh: &QueueHandle<State>) -> Result<Self, BindError>
where
State: Dispatch<I, (), State> + 'static,
{
let proxy = globals.bind(qh, 0..=MAX_VERSION, ())?;
Ok(Self { proxy: GlobalProxy::Bound(proxy) })
}
pub fn get(&self) -> Result<&I, GlobalError> {
self.proxy.get()
}
pub fn with_min_version(&self, min_version: u32) -> Result<&I, GlobalError> {
self.proxy.with_min_version(min_version)
}
}
impl<I: Proxy + Clone, const MAX_VERSION: u32> ProvidesBoundGlobal<I, MAX_VERSION>
for SimpleGlobal<I, MAX_VERSION>
{
fn bound_global(&self) -> Result<I, GlobalError> {
self.proxy.get().cloned()
}
}
impl<D, I, const MAX_VERSION: u32> Dispatch<I, (), D> for SimpleGlobal<I, MAX_VERSION>
where
D: Dispatch<I, ()>,
I: Proxy,
{
fn event(_: &mut D, _: &I, _: <I as Proxy>::Event, _: &(), _: &Connection, _: &QueueHandle<D>) {
unreachable!("SimpleGlobal is not suitable for {} which has events", I::interface().name);
}
}
/// Binds all globals with a given interface.
pub(crate) fn bind_all<I, D, U, F>(
registry: &wl_registry::WlRegistry,
globals: &[Global],
qh: &QueueHandle<D>,
version: std::ops::RangeInclusive<u32>,
mut make_udata: F,
) -> Result<Vec<I>, BindError>
where
D: Dispatch<I, U> + 'static,
I: Proxy + 'static,
F: FnMut(u32) -> U,
U: Send + Sync + 'static,
{
let iface = I::interface();
if *version.end() > iface.version {
// This is a panic because it's a compile-time programmer error, not a runtime error.
panic!("Maximum version ({}) was higher than the proxy's maximum version ({}); outdated wayland XML files?",
version.end(), iface.version);
}
let mut rv = Vec::new();
for global in globals {
if global.interface != iface.name {
continue;
}
if global.version < *version.start() {
return Err(BindError::UnsupportedVersion);
}
let version = global.version.min(*version.end());
let udata = make_udata(global.name);
let proxy = registry.bind(global.name, version, qh, udata);
log::debug!(target: "sctk", "Bound new global [{}] {} v{}", global.name, iface.name, version);
rv.push(proxy);
}
Ok(rv)
}
/// Binds a global, returning a new object associated with the global.
pub(crate) fn bind_one<I, D, U>(
registry: &wl_registry::WlRegistry,
globals: &[Global],
qh: &QueueHandle<D>,
version: std::ops::RangeInclusive<u32>,
udata: U,
) -> Result<I, BindError>
where
D: Dispatch<I, U> + 'static,
I: Proxy + 'static,
U: Send + Sync + 'static,
{
let iface = I::interface();
if *version.end() > iface.version {
// This is a panic because it's a compile-time programmer error, not a runtime error.
panic!("Maximum version ({}) of {} was higher than the proxy's maximum version ({}); outdated wayland XML files?",
version.end(), iface.name, iface.version);
}
if *version.end() < iface.version {
// This is a reminder to evaluate the new API and bump the maximum in order to be able
// to use new APIs. Actual use of new APIs still needs runtime version checks.
log::trace!(target: "sctk", "Version {} of {} is available; binding is currently limited to {}", iface.version, iface.name, version.end());
}
for global in globals {
if global.interface != iface.name {
continue;
}
if global.version < *version.start() {
return Err(BindError::UnsupportedVersion);
}
let version = global.version.min(*version.end());
let proxy = registry.bind(global.name, version, qh, udata);
log::debug!(target: "sctk", "Bound new global [{}] {} v{}", global.name, iface.name, version);
return Ok(proxy);
}
Err(BindError::NotPresent)
}
#[macro_export]
macro_rules! delegate_simple {
($(@<$( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+>)? $ty:ty, $iface:ty, $max:expr) => {
$crate::reexports::client::delegate_dispatch!($(@< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)? $ty: [ $iface: () ]
=> $crate::registry::SimpleGlobal<$iface, $max>
);
};
}
/// A helper macro for implementing [`ProvidesRegistryState`].
///
/// See [`delegate_registry`] for an example.
#[macro_export]
macro_rules! registry_handlers {
($(@<$( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+>)? $($ty:ty),* $(,)?) => {
fn runtime_add_global(
&mut self,
conn: &$crate::reexports::client::Connection,
qh: &$crate::reexports::client::QueueHandle<Self>,
name: u32,
interface: &str,
version: u32,
) {
$(
<$ty as $crate::registry::RegistryHandler<Self>>::new_global(self, conn, qh, name, interface, version);
)*
}
fn runtime_remove_global(
&mut self,
conn: &$crate::reexports::client::Connection,
qh: &$crate::reexports::client::QueueHandle<Self>,
name: u32,
interface: &str,
) {
$(
<$ty as $crate::registry::RegistryHandler<Self>>::remove_global(self, conn, qh, name, interface);
)*
}
}
}