Update protocols

Author: mahkoh

protocols/wayland/wayland.xml

@@ -170,7 +170,7 @@
       <arg name="callback_data" type="uint" summary="request-specific data for the callback"/>
     </event>
   </interface>
-  <interface name="wl_compositor" version="6">
+  <interface name="wl_compositor" version="7">
     <description summary="the compositor singleton">
       A compositor.  This object is a singleton global.  The
       compositor is in charge of combining the contents of multiple
@@ -188,6 +188,11 @@
       </description>
       <arg name="id" type="new_id" interface="wl_region" summary="the new region"/>
     </request>
+    <request name="release" type="destructor" since="7">
+      <description summary="destroy wl_compositor">
+        This request destroys the wl_compositor. This has no effect on any other objects.
+      </description>
+    </request>
   </interface>
   <interface name="wl_shm_pool" version="2">
     <description summary="a shared memory pool">
@@ -498,7 +503,7 @@
       </description>
     </event>
   </interface>
-  <interface name="wl_data_offer" version="3">
+  <interface name="wl_data_offer" version="4">
     <description summary="offer to transfer data">
       A wl_data_offer represents a piece of data offered for transfer
       by another client (the source client).  It is used by the
@@ -671,7 +676,7 @@
       <entry name="invalid_offer" value="3" summary="offer doesn&apos;t accept this request"/>
     </enum>
   </interface>
-  <interface name="wl_data_source" version="3">
+  <interface name="wl_data_source" version="4">
     <description summary="offer to transfer data">
       The wl_data_source object is the source side of a wl_data_offer.
       It is created by the source client in a data transfer and
@@ -809,7 +814,7 @@
       <entry name="invalid_source" value="1" summary="source doesn&apos;t accept this request"/>
     </enum>
   </interface>
-  <interface name="wl_data_device" version="3">
+  <interface name="wl_data_device" version="4">
     <description summary="data transfer device">
       There is one wl_data_device per seat which can be obtained
       from the global wl_data_device_manager singleton.
@@ -955,7 +960,7 @@
       <entry name="used_source" value="1" summary="source has already been used"/>
     </enum>
   </interface>
-  <interface name="wl_data_device_manager" version="3">
+  <interface name="wl_data_device_manager" version="4">
     <description summary="data transfer interface">
       The wl_data_device_manager is a singleton global object that
       provides access to inter-client data transfer mechanisms such as
@@ -981,6 +986,12 @@
       <arg name="id" type="new_id" interface="wl_data_device" summary="data device to create"/>
       <arg name="seat" type="object" interface="wl_seat" summary="seat associated with the data device"/>
     </request>
+    <request name="release" type="destructor" since="4">
+      <description summary="destroy wl_data_device_manager">
+        This request destroys the wl_data_device_manager. This has no effect on any other
+        objects.
+      </description>
+    </request>
     <enum name="dnd_action" since="3" bitfield="true">
       <description summary="drag and drop actions">
         This is a bitmask of the available/preferred actions in a
@@ -1295,7 +1306,7 @@
       <entry name="fill" value="3" summary="no upscaling, center on output and add black borders to compensate size mismatch"/>
     </enum>
   </interface>
-  <interface name="wl_surface" version="6">
+  <interface name="wl_surface" version="7">
     <description summary="an onscreen surface">
       A surface is a rectangular area that may be displayed on zero
       or more outputs, and shown any number of times at the compositor's
@@ -1391,9 +1402,11 @@
         If a pending wl_buffer has been committed to more than one wl_surface,
         the delivery of wl_buffer.release events becomes undefined. A well
         behaved client should not rely on wl_buffer.release events in this
-        case. Alternatively, a client could create multiple wl_buffer objects
-        from the same backing storage or use a protocol extension providing
-        per-commit release notifications.
+        case. Instead, clients hitting this case should use
+        wl_surface.get_release or use a protocol extension providing per-commit
+        release notifications (if none of these options are available, a
+        fallback can be implemented by creating multiple wl_buffer objects from
+        the same backing storage).
 
         Destroying the wl_buffer after wl_buffer.release does not change
         the surface contents. Destroying the wl_buffer before wl_buffer.release
@@ -1769,6 +1782,29 @@
       </description>
       <arg name="transform" type="uint" enum="wl_output.transform" summary="preferred transform"/>
     </event>
+    <request name="get_release" since="7">
+      <description summary="get a release callback">
+        Create a callback for the release of the buffer attached by the client
+        with wl_surface.attach.
+
+        The compositor will release the buffer when it has finished its usage of
+        the underlying storage for the relevant commit. Once the client receives
+        this event, and assuming the associated buffer is not pending release
+        from other wl_surface.commit requests, the client can safely re-use the
+        buffer.
+
+        Release callbacks are double-buffered state, and will be associated
+        with the pending buffer at wl_surface.commit time.
+
+        The callback_data passed in the wl_callback.done event is unused and
+        is always zero.
+
+        Sending this request without attaching a non-null buffer in the same
+        content update is a protocol error. The compositor will send the
+        no_buffer error in this case.
+      </description>
+      <arg name="callback" type="new_id" interface="wl_callback" summary="callback object for the release"/>
+    </request>
     <enum name="error">
       <description summary="wl_surface error values">
         These errors can be emitted in response to wl_surface requests.
@@ -1778,6 +1814,7 @@
       <entry name="invalid_size" value="2" summary="buffer size is invalid"/>
       <entry name="invalid_offset" value="3" summary="buffer offset is invalid"/>
       <entry name="defunct_role_object" value="4" summary="surface was destroyed before its role object"/>
+      <entry name="no_buffer" value="5" summary="no buffer was attached"/>
     </enum>
   </interface>
   <interface name="wl_seat" version="10">
@@ -2794,7 +2831,7 @@
       <entry name="preferred" value="0x2" summary="indicates this is the preferred mode"/>
     </enum>
   </interface>
-  <interface name="wl_region" version="1">
+  <interface name="wl_region" version="7">
     <description summary="region interface">
       A region object describes an area.
 

wl-proxy/src/baseline/versions/prototyping.rs

@@ -94,18 +94,18 @@ const weston_touch_calibrator: u32 = 1;
 const weston_touch_coordinate: u32 = 1;
 const wl_buffer: u32 = 1;
 const wl_callback: u32 = 1;
-const wl_compositor: u32 = 6;
-const wl_data_device: u32 = 3;
-const wl_data_device_manager: u32 = 3;
-const wl_data_offer: u32 = 3;
-const wl_data_source: u32 = 3;
+const wl_compositor: u32 = 7;
+const wl_data_device: u32 = 4;
+const wl_data_device_manager: u32 = 4;
+const wl_data_offer: u32 = 4;
+const wl_data_source: u32 = 4;
 const wl_display: u32 = 1;
 const wl_drm: u32 = 2;
 const wl_fixes: u32 = 1;
 const wl_keyboard: u32 = 10;
 const wl_output: u32 = 4;
 const wl_pointer: u32 = 10;
-const wl_region: u32 = 1;
+const wl_region: u32 = 7;
 const wl_registry: u32 = 1;
 const wl_seat: u32 = 10;
 const wl_shell: u32 = 1;
@@ -114,7 +114,7 @@ const wl_shm: u32 = 2;
 const wl_shm_pool: u32 = 2;
 const wl_subcompositor: u32 = 1;
 const wl_subsurface: u32 = 1;
-const wl_surface: u32 = 6;
+const wl_surface: u32 = 7;
 const wl_touch: u32 = 10;
 const wlproxy_sync_v1: u32 = 1;
 const wlproxy_test: u32 = 1;

wl-proxy/src/baseline/versions/prototyping.txt

@@ -89,18 +89,18 @@ weston_touch_calibrator = 1
 weston_touch_coordinate = 1
 wl_buffer = 1
 wl_callback = 1
-wl_compositor = 6
-wl_data_device = 3
-wl_data_device_manager = 3
-wl_data_offer = 3
-wl_data_source = 3
+wl_compositor = 7
+wl_data_device = 4
+wl_data_device_manager = 4
+wl_data_offer = 4
+wl_data_source = 4
 wl_display = 1
 wl_drm = 2
 wl_fixes = 1
 wl_keyboard = 10
 wl_output = 4
 wl_pointer = 10
-wl_region = 1
+wl_region = 7
 wl_registry = 1
 wl_seat = 10
 wl_shell = 1
@@ -109,7 +109,7 @@ wl_shm = 2
 wl_shm_pool = 2
 wl_subcompositor = 1
 wl_subsurface = 1
-wl_surface = 6
+wl_surface = 7
 wl_touch = 10
 wlproxy_sync_v1 = 1
 wlproxy_test = 1

wl-proxy/src/protocols.rs

@@ -5500,17 +5500,17 @@ impl ObjectInterface {
             Self::ZwpVirtualKeyboardV1 => 1,
             Self::WlBuffer => 1,
             Self::WlCallback => 1,
-            Self::WlCompositor => 6,
-            Self::WlDataDevice => 3,
-            Self::WlDataDeviceManager => 3,
-            Self::WlDataOffer => 3,
-            Self::WlDataSource => 3,
+            Self::WlCompositor => 7,
+            Self::WlDataDevice => 4,
+            Self::WlDataDeviceManager => 4,
+            Self::WlDataOffer => 4,
+            Self::WlDataSource => 4,
             Self::WlDisplay => 1,
             Self::WlFixes => 1,
             Self::WlKeyboard => 10,
             Self::WlOutput => 4,
             Self::WlPointer => 10,
-            Self::WlRegion => 1,
+            Self::WlRegion => 7,
             Self::WlRegistry => 1,
             Self::WlSeat => 10,
             Self::WlShell => 1,
@@ -5519,7 +5519,7 @@ impl ObjectInterface {
             Self::WlShmPool => 2,
             Self::WlSubcompositor => 1,
             Self::WlSubsurface => 1,
-            Self::WlSurface => 6,
+            Self::WlSurface => 7,
             Self::WlTouch => 10,
             #[cfg(feature = "protocol-alpha_modifier_v1")]
             Self::WpAlphaModifierSurfaceV1 => 1,

wl-proxy/src/protocols/wayland/wl_compositor.rs

@@ -20,7 +20,7 @@ struct DefaultHandler;
 impl WlCompositorHandler for DefaultHandler { }
 
 impl ConcreteObject for WlCompositor {
-    const XML_VERSION: u32 = 6;
+    const XML_VERSION: u32 = 7;
     const INTERFACE: ObjectInterface = ObjectInterface::WlCompositor;
     const INTERFACE_NAME: &str = "wl_compositor";
 }
@@ -260,6 +260,62 @@ impl WlCompositor {
         );
         id
     }
+
+    /// Since when the release message is available.
+    pub const MSG__RELEASE__SINCE: u32 = 7;
+
+    /// destroy wl_compositor
+    ///
+    /// This request destroys the wl_compositor. This has no effect on any other objects.
+    #[inline]
+    pub fn try_send_release(
+        &self,
+    ) -> Result<(), ObjectError> {
+        let core = self.core();
+        let Some(id) = core.server_obj_id.get() else {
+            return Err(ObjectError(ObjectErrorKind::ReceiverNoServerId));
+        };
+        #[cfg(feature = "logging")]
+        if self.core.state.log {
+            #[cold]
+            fn log(state: &State, id: u32) {
+                let (millis, micros) = time_since_epoch();
+                let prefix = &state.log_prefix;
+                let args = format_args!("[{millis:7}.{micros:03}] {prefix}server      <= wl_compositor#{}.release()\n", id);
+                state.log(args);
+            }
+            log(&self.core.state, id);
+        }
+        let Some(endpoint) = &self.core.state.server else {
+            return Ok(());
+        };
+        if !endpoint.flush_queued.replace(true) {
+            self.core.state.add_flushable_endpoint(endpoint, None);
+        }
+        let mut outgoing_ref = endpoint.outgoing.borrow_mut();
+        let outgoing = &mut *outgoing_ref;
+        let mut fmt = outgoing.formatter();
+        fmt.words([
+            id,
+            2,
+        ]);
+        self.core.handle_server_destroy();
+        Ok(())
+    }
+
+    /// destroy wl_compositor
+    ///
+    /// This request destroys the wl_compositor. This has no effect on any other objects.
+    #[inline]
+    pub fn send_release(
+        &self,
+    ) {
+        let res = self.try_send_release(
+        );
+        if let Err(e) = res {
+            log_send("wl_compositor.release", &e);
+        }
+    }
 }
 
 /// A message handler for [`WlCompositor`] proxies.
@@ -319,6 +375,24 @@ pub trait WlCompositorHandler: Any {
             log_forward("wl_compositor.create_region", &e);
         }
     }
+
+    /// destroy wl_compositor
+    ///
+    /// This request destroys the wl_compositor. This has no effect on any other objects.
+    #[inline]
+    fn handle_release(
+        &mut self,
+        slf: &Rc<WlCompositor>,
+    ) {
+        if !slf.core.forward_to_server.get() {
+            return;
+        }
+        let res = slf.try_send_release(
+        );
+        if let Err(e) = res {
+            log_forward("wl_compositor.release", &e);
+        }
+    }
 }
 
 impl ObjectPrivate for WlCompositor {
@@ -403,6 +477,28 @@ impl ObjectPrivate for WlCompositor {
                     DefaultHandler.handle_create_region(&self, arg0);
                 }
             }
+            2 => {
+                if msg.len() != 2 {
+                    return Err(ObjectError(ObjectErrorKind::WrongMessageSize(msg.len() as u32 * 4, 8)));
+                }
+                #[cfg(feature = "logging")]
+                if self.core.state.log {
+                    #[cold]
+                    fn log(state: &State, client_id: u64, id: u32) {
+                        let (millis, micros) = time_since_epoch();
+                        let prefix = &state.log_prefix;
+                        let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} -> wl_compositor#{}.release()\n", client_id, id);
+                        state.log(args);
+                    }
+                    log(&self.core.state, client.endpoint.id, msg[0]);
+                }
+                self.core.handle_client_destroy();
+                if let Some(handler) = handler {
+                    (**handler).handle_release(&self);
+                } else {
+                    DefaultHandler.handle_release(&self);
+                }
+            }
             n => {
                 let _ = client;
                 let _ = msg;
@@ -434,6 +530,7 @@ impl ObjectPrivate for WlCompositor {
         let name = match id {
             0 => "create_surface",
             1 => "create_region",
+            2 => "release",
             _ => return None,
         };
         Some(name)

wl-proxy/src/protocols/wayland/wl_data_device.rs

@@ -22,7 +22,7 @@ struct DefaultHandler;
 impl WlDataDeviceHandler for DefaultHandler { }
 
 impl ConcreteObject for WlDataDevice {
-    const XML_VERSION: u32 = 3;
+    const XML_VERSION: u32 = 4;
     const INTERFACE: ObjectInterface = ObjectInterface::WlDataDevice;
     const INTERFACE_NAME: &str = "wl_data_device";
 }