From f7c007623458a3872dbda11d6e51140cc1c40f54 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Mary=C5=84czak?=
 <marynczakbartlomiej@gmail.com>
Date: Sat, 14 Dec 2024 22:38:03 +0100
Subject: [PATCH] Add `globals::registry_queue_init_delegated` and
 `GlobalList::bind_delegated`

---
 wayland-client/CHANGELOG.md       |  4 +++
 wayland-client/src/event_queue.rs |  2 +-
 wayland-client/src/globals.rs     | 56 +++++++++++++++++++++++++++----
 3 files changed, 55 insertions(+), 7 deletions(-)

diff --git a/wayland-client/CHANGELOG.md b/wayland-client/CHANGELOG.md
index bb408e76f8..0a1fcaafde 100644
--- a/wayland-client/CHANGELOG.md
+++ b/wayland-client/CHANGELOG.md
@@ -8,6 +8,10 @@
   therefore allowing users to dispatch events to types different than main `State`
 - `delegate_dispatch` Removed in favour of `DelegateTo` generic on `QueueHandle::make_data`
 
+#### Additions
+
+- `globals::registry_queue_init_delegated` and `GlobalList::bind_delegated`
+
 ## 0.31.7 -- 2024-10-23
 
 - Updated Wayland core protocol to 1.23
diff --git a/wayland-client/src/event_queue.rs b/wayland-client/src/event_queue.rs
index b499b39c2e..fa09d31d6d 100644
--- a/wayland-client/src/event_queue.rs
+++ b/wayland-client/src/event_queue.rs
@@ -727,4 +727,4 @@ impl<I: Proxy, U: std::fmt::Debug, State, DispatchTo> std::fmt::Debug
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         f.debug_struct("QueueProxyData").field("udata", &self.udata).finish()
     }
-}
\ No newline at end of file
+}
diff --git a/wayland-client/src/globals.rs b/wayland-client/src/globals.rs
index 3f84f64fe0..308d07942d 100644
--- a/wayland-client/src/globals.rs
+++ b/wayland-client/src/globals.rs
@@ -54,6 +54,7 @@
 
 use std::{
     fmt,
+    marker::PhantomData,
     ops::RangeInclusive,
     os::unix::io::OwnedFd,
     sync::{
@@ -80,13 +81,30 @@ pub fn registry_queue_init<State>(
 ) -> Result<(GlobalList, EventQueue<State>), GlobalError>
 where
     State: Dispatch<wl_registry::WlRegistry, GlobalListContents> + 'static,
+{
+    registry_queue_init_delegated::<State, State>(conn)
+}
+
+/// Initialize a new event queue with its associated registry and retrieve the initial list of globals
+///
+/// This is a delegating variant of [`registry_queue_init`], it dispatches events to `DelegateTo`
+/// generic rather than to `State`.
+///
+/// See [the module level documentation][self] for more.
+pub fn registry_queue_init_delegated<State, DelegateTo>(
+    conn: &Connection,
+) -> Result<(GlobalList, EventQueue<State>), GlobalError>
+where
+    State: 'static,
+    DelegateTo: Dispatch<wl_registry::WlRegistry, GlobalListContents, State> + 'static,
 {
     let event_queue = conn.new_event_queue();
     let display = conn.display();
-    let data = Arc::new(RegistryState {
+    let data = Arc::new(RegistryState::<State, DelegateTo> {
         globals: GlobalListContents { contents: Default::default() },
         handle: event_queue.handle(),
         initial_roundtrip_done: AtomicBool::new(false),
+        _ph: PhantomData,
     });
     let registry = display.send_constructor(wl_display::Request::GetRegistry {}, data.clone())?;
     // We don't need to dispatch the event queue as for now nothing will be sent to it
@@ -139,6 +157,25 @@ impl GlobalList {
         I: Proxy + 'static,
         State: Dispatch<I, U> + 'static,
         U: Send + Sync + 'static,
+    {
+        self.bind_delegated::<I, State, U, State>(qh, version, udata)
+    }
+
+    /// Binds a global, returning a new protocol object associated with the global.
+    ///
+    /// This is a delegating variant of [`Self::bind`], it dispatches events to `DelegateTo`
+    /// generic rather than to `State`. Read full docs at [`Self::bind`].
+    pub fn bind_delegated<I, State, U, DelegateTo>(
+        &self,
+        qh: &QueueHandle<State>,
+        version: RangeInclusive<u32>,
+        udata: U,
+    ) -> Result<I, BindError>
+    where
+        I: Proxy + 'static,
+        State: 'static,
+        U: Send + Sync + 'static,
+        DelegateTo: Dispatch<I, U, State> + 'static,
     {
         let version_start = *version.start();
         let version_end = *version.end();
@@ -175,7 +212,13 @@ impl GlobalList {
         // requested version.
         let version = version.min(version_end);
 
-        Ok(self.registry.bind(name, version, qh, udata))
+        Ok(self
+            .registry
+            .send_constructor(
+                wl_registry::Request::Bind { name, id: (I::interface(), version) },
+                qh.make_data::<I, U, DelegateTo>(udata),
+            )
+            .unwrap())
     }
 
     /// Returns the [`WlRegistry`][wl_registry] protocol object.
@@ -293,15 +336,16 @@ impl GlobalListContents {
     }
 }
 
-struct RegistryState<State> {
+struct RegistryState<State, DelegateTo> {
     globals: GlobalListContents,
     handle: QueueHandle<State>,
     initial_roundtrip_done: AtomicBool,
+    _ph: PhantomData<fn() -> DelegateTo>,
 }
 
-impl<State: 'static> ObjectData for RegistryState<State>
+impl<State: 'static, DelegateTo: 'static> ObjectData for RegistryState<State, DelegateTo>
 where
-    State: Dispatch<wl_registry::WlRegistry, GlobalListContents>,
+    DelegateTo: Dispatch<wl_registry::WlRegistry, GlobalListContents, State>,
 {
     fn event(
         self: Arc<Self>,
@@ -344,7 +388,7 @@ where
                 .inner
                 .lock()
                 .unwrap()
-                .enqueue_event::<wl_registry::WlRegistry, GlobalListContents, State>(
+                .enqueue_event::<wl_registry::WlRegistry, GlobalListContents, DelegateTo>(
                     msg,
                     self.clone(),
                 )