From 4c1afb126b9a49aee367276f634f8686428d6147 Mon Sep 17 00:00:00 2001
From: Isaac Freund <mail@isaacfreund.com>
Date: Thu, 30 Jun 2022 14:01:46 +0200
Subject: wlr-output-management: Implement version 3 release requests

Head/mode resources older than version 3 and lacking a release request
are intentionally leaked as this is the only way to fix the race.

Implements: https://gitlab.freedesktop.org/wlroots/wlr-protocols/-/merge_requests/114
---
 protocol/wlr-output-management-unstable-v1.xml | 47 ++++++++++++++++++--------
 1 file changed, 33 insertions(+), 14 deletions(-)

(limited to 'protocol/wlr-output-management-unstable-v1.xml')

diff --git a/protocol/wlr-output-management-unstable-v1.xml b/protocol/wlr-output-management-unstable-v1.xml
index cadc45fb..3568e04c 100644
--- a/protocol/wlr-output-management-unstable-v1.xml
+++ b/protocol/wlr-output-management-unstable-v1.xml
@@ -39,7 +39,7 @@
     interface version number is reset.
   </description>
 
-  <interface name="zwlr_output_manager_v1" version="2">
+  <interface name="zwlr_output_manager_v1" version="3">
     <description summary="output device configuration manager">
       This interface is a manager that allows reading and writing the current
       output device configuration.
@@ -115,7 +115,7 @@
       </description>
     </request>
 
-    <event name="finished">
+    <event name="finished" type="destructor">
       <description summary="the compositor has finished with the manager">
         This event indicates that the compositor is done sending manager events.
         The compositor will destroy the object immediately after sending this
@@ -125,7 +125,7 @@
     </event>
   </interface>
 
-  <interface name="zwlr_output_head_v1" version="2">
+  <interface name="zwlr_output_head_v1" version="3">
     <description summary="output device">
       A head is an output device. The difference between a wl_output object and
       a head is that heads are advertised even if they are turned off. A head
@@ -251,14 +251,15 @@
     </event>
 
     <event name="finished">
-      <description summary="the head has been destroyed">
-        The compositor will destroy the object immediately after sending this
-        event, so it will become invalid and the client should release any
-        resources associated with it.
+      <description summary="the head has disappeared">
+        This event indicates that the head is no longer available. The head
+        object becomes inert. Clients should send a destroy request and release
+        any resources associated with it.
       </description>
     </event>
 
     <!-- Version 2 additions -->
+
     <event name="make" since="2">
       <description summary="head manufacturer">
         This event describes the manufacturer of the head.
@@ -328,9 +329,18 @@
       </description>
       <arg name="serial_number" type="string"/>
     </event>
+
+    <!-- Version 3 additions -->
+
+    <request name="release" type="destructor" since="3">
+      <description summary="destroy the head object">
+        This request indicates that the client will no longer use this head
+        object.
+      </description>
+    </request>
   </interface>
 
-  <interface name="zwlr_output_mode_v1" version="2">
+  <interface name="zwlr_output_mode_v1" version="3">
     <description summary="output mode">
       This object describes an output mode.
 
@@ -368,15 +378,24 @@
     </event>
 
     <event name="finished">
-      <description summary="the mode has been destroyed">
-        The compositor will destroy the object immediately after sending this
-        event, so it will become invalid and the client should release any
-        resources associated with it.
+      <description summary="the mode has disappeared">
+        This event indicates that the mode is no longer available. The mode
+        object becomes inert. Clients should send a destroy request and release
+        any resources associated with it.
       </description>
     </event>
+
+    <!-- Version 3 additions -->
+
+    <request name="release" type="destructor" since="3">
+      <description summary="destroy the mode object">
+        This request indicates that the client will no longer use this mode
+        object.
+      </description>
+    </request>
   </interface>
 
-  <interface name="zwlr_output_configuration_v1" version="2">
+  <interface name="zwlr_output_configuration_v1" version="3">
     <description summary="output configuration">
       This object is used by the client to describe a full output configuration.
 
@@ -494,7 +513,7 @@
     </request>
   </interface>
 
-  <interface name="zwlr_output_configuration_head_v1" version="2">
+  <interface name="zwlr_output_configuration_head_v1" version="3">
     <description summary="head configuration">
       This object is used by the client to update a single head's configuration.
 
-- 
cgit v1.2.3