wayland: Update to xdg-shell unstable version 5

Updates the function type signatures and version number. The rest will
come as separate commits.

https://bugzilla.gnome.org/show_bug.cgi?id=744452

src/wayland/meta-wayland-surface.c

@@ -700,6 +700,13 @@ meta_wayland_surface_create (MetaWaylandCompositor *compositor,
   return surface;
 }
 
+static void
+xdg_shell_destroy (struct wl_client *client,
+                   struct wl_resource *resource)
+{
+  wl_resource_destroy (resource);
+}
+
 static void
 xdg_shell_use_unstable_version (struct wl_client *client,
                                 struct wl_resource *resource,
@@ -1010,8 +1017,7 @@ xdg_shell_get_xdg_popup (struct wl_client *client,
                          struct wl_resource *seat_resource,
                          uint32_t serial,
                          int32_t x,
-                         int32_t y,
+                         int32_t y)
-                         uint32_t flags)
 {
   MetaWaylandSurface *surface = wl_resource_get_user_data (surface_resource);
   MetaWaylandSurface *parent_surf = wl_resource_get_user_data (parent_resource);
@@ -1051,6 +1057,7 @@ xdg_shell_get_xdg_popup (struct wl_client *client,
 }
 
 static const struct xdg_shell_interface meta_wayland_xdg_shell_interface = {
+  xdg_shell_destroy,
   xdg_shell_use_unstable_version,
   xdg_shell_get_xdg_surface,
   xdg_shell_get_xdg_popup,
@@ -1801,12 +1808,8 @@ meta_wayland_surface_delete (MetaWaylandSurface *surface)
 void
 meta_wayland_surface_popup_done (MetaWaylandSurface *surface)
 {
-  struct wl_client *client = wl_resource_get_client (surface->resource);
-  struct wl_display *display = wl_client_get_display (client);
-  uint32_t serial = wl_display_next_serial (display);
-
   if (surface->xdg_popup)
-    xdg_popup_send_popup_done (surface->xdg_popup, serial);
+    xdg_popup_send_popup_done (surface->xdg_popup);
   else if (surface->wl_shell_surface)
     wl_shell_surface_send_popup_done (surface->wl_shell_surface);
 }

src/wayland/protocol/xdg-shell.xml

@@ -31,11 +31,10 @@
 
   <interface name="xdg_shell" version="1">
     <description summary="create desktop-style surfaces">
-      This interface is implemented by servers that provide
+      xdg_shell allows clients to turn a wl_surface into a "real window"
-      desktop-style user interfaces.
+      which can be dragged, resized, stacked, and moved around by the
-
+      user. Everything about this interface is suited towards traditional
-      It allows clients to associate a xdg_surface with
+      desktop environments.
-      a basic surface.
     </description>
 
     <enum name="version">
@@ -45,9 +44,23 @@
 	they implement using static_assert to ensure the protocol and
 	implementation versions match.
       </description>
-      <entry name="current" value="4" summary="Always the latest version"/>
+      <entry name="current" value="5" summary="Always the latest version"/>
     </enum>
 
+    <enum name="error">
+      <entry name="role" value="0" summary="given wl_surface has another role"/>
+    </enum>
+
+    <request name="destroy" type="destructor">
+      <description summary="destroy xdg_shell">
+        Destroy this xdg_shell object.
+
+        Destroying a bound xdg_shell object while there are surfaces
+        still alive with roles from this interface is illegal and will
+        result in a protocol error. Make sure to destroy all surfaces
+        before destroying this object.
+      </description>
+    </request>
 
     <request name="use_unstable_version">
       <description summary="enable use of this unstable version">
@@ -62,30 +75,28 @@
 
     <request name="get_xdg_surface">
       <description summary="create a shell surface from a surface">
-	Create a shell surface for an existing surface.
+	This creates an xdg_surface for the given surface and gives it the
-
+	xdg_surface role. See the documentation of xdg_surface for more details.
-	Only one shell or popup surface can be associated with a given
-	surface.
       </description>
       <arg name="id" type="new_id" interface="xdg_surface"/>
       <arg name="surface" type="object" interface="wl_surface"/>
     </request>
 
     <request name="get_xdg_popup">
-      <description summary="create a shell surface from a surface">
+      <description summary="create a popup for a surface">
-	Create a popup surface for an existing surface.
+	This creates an xdg_popup for the given surface and gives it the
+	xdg_popup role. See the documentation of xdg_popup for more details.
 
-	Only one shell or popup surface can be associated with a given
+	This request must be used in response to some sort of user action
-	surface.
+	like a button press, key press, or touch down event.
       </description>
       <arg name="id" type="new_id" interface="xdg_popup"/>
       <arg name="surface" type="object" interface="wl_surface"/>
       <arg name="parent" type="object" interface="wl_surface"/>
-      <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat whose pointer is used"/>
+      <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
-      <arg name="serial" type="uint" summary="serial of the implicit grab on the pointer"/>
+      <arg name="serial" type="uint" summary="the serial of the user event"/>
       <arg name="x" type="int"/>
       <arg name="y" type="int"/>
-      <arg name="flags" type="uint"/>
     </request>
 
     <event name="ping">
@@ -99,7 +110,7 @@
         respond to the ping request, or in what timeframe. Clients should
         try to respond in a reasonable amount of time.
       </description>
-      <arg name="serial" type="uint" summary="pass this to the callback"/>
+      <arg name="serial" type="uint" summary="pass this to the pong request"/>
     </event>
 
     <request name="pong">
@@ -112,38 +123,34 @@
   </interface>
 
   <interface name="xdg_surface" version="1">
-
+    <description summary="A desktop window">
-    <description summary="desktop-style metadata interface">
       An interface that may be implemented by a wl_surface, for
       implementations that provide a desktop-style user interface.
 
       It provides requests to treat surfaces like windows, allowing to set
       properties like maximized, fullscreen, minimized, and to move and resize
       them, and associate metadata like title and app id.
-
-      On the server side the object is automatically destroyed when
-      the related wl_surface is destroyed.  On client side,
-      xdg_surface.destroy() must be called before destroying
-      the wl_surface object.
     </description>
 
     <request name="destroy" type="destructor">
-      <description summary="remove xdg_surface interface">
+      <description summary="Destroy the xdg_surface">
-	The xdg_surface interface is removed from the wl_surface object
+	Unmap and destroy the window. The window will be effectively
-	that was turned into a xdg_surface with
+	hidden from the user's point of view, and all state like
-	xdg_shell.get_xdg_surface request. The xdg_surface properties,
+	maximization, fullscreen, and so on, will be lost.
-	like maximized and fullscreen, are lost. The wl_surface loses
-	its role as a xdg_surface. The wl_surface is unmapped.
       </description>
     </request>
 
     <request name="set_parent">
-      <description summary="surface is a child of another surface">
+      <description summary="set the parent of this surface">
-	Child surfaces are stacked above their parents, and will be
+	Set the "parent" of this surface. This window should be stacked
-	unmapped if the parent is unmapped too. They should not appear
+	above a parent. The parent surface must be mapped as long as this
-	on task bars and alt+tab.
+	surface is mapped.
+
+	Parent windows should be set on dialogs, toolboxes, or other
+	"auxilliary" surfaces, so that the parent is raised when the dialog
+	is raised.
       </description>
-      <arg name="parent" type="object" interface="wl_surface" allow-null="true"/>
+      <arg name="parent" type="object" interface="xdg_surface" allow-null="true"/>
     </request>
 
     <request name="set_title">
@@ -160,14 +167,19 @@
     </request>
 
     <request name="set_app_id">
-      <description summary="set surface class">
+      <description summary="set application ID">
-	Set an id for the surface.
+	Set an application identifier for the surface.
 
-	The app id identifies the general class of applications to which
+	The app ID identifies the general class of applications to which
-	the surface belongs.
+	the surface belongs. The compositor can use this to group multiple
+	applications together, or to determine how to launch a new
+	application.
 
-	It should be the ID that appears in the new desktop entry
+	See the desktop-entry specification [0] for more details on
-	specification, the interface name.
+	application identifiers and how they relate to well-known DBus
+	names and .desktop files.
+
+	[0] http://standards.freedesktop.org/desktop-entry-spec/
       </description>
       <arg name="app_id" type="string"/>
     </request>
@@ -179,29 +191,32 @@
         user a menu that they can use to maximize or minimize the window.
 
         This request asks the compositor to pop up such a window menu at
-        the given position, relative to the parent surface. There are
+        the given position, relative to the local surface coordinates of
-        no guarantees as to what the window menu contains.
+        the parent surface. There are no guarantees as to what menu items
+        the window menu contains.
 
-        Your surface must have focus on the seat passed in to pop up the
+        This request must be used in response to some sort of user action
-        window menu.
+        like a button press, key press, or touch down event.
       </description>
 
-      <arg name="seat" type="object" interface="wl_seat" summary="the seat to pop the window up on"/>
+      <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
-      <arg name="serial" type="uint" summary="serial of the event to pop up the window for"/>
+      <arg name="serial" type="uint" summary="the serial of the user event"/>
       <arg name="x" type="int" summary="the x position to pop up the window menu at"/>
       <arg name="y" type="int" summary="the y position to pop up the window menu at"/>
     </request>
 
     <request name="move">
       <description summary="start an interactive move">
-	Start a pointer-driven move of the surface.
+	Start an interactive, user-driven move of the surface.
+
+	This request must be used in response to some sort of user action
+	like a button press, key press, or touch down event.
 
-	This request must be used in response to a button press event.
 	The server may ignore move requests depending on the state of
 	the surface (e.g. fullscreen or maximized).
       </description>
-      <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat whose pointer is used"/>
+      <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
-      <arg name="serial" type="uint" summary="serial of the implicit grab on the pointer"/>
+      <arg name="serial" type="uint" summary="the serial of the user event"/>
     </request>
 
     <enum name="resize_edge">
@@ -224,14 +239,16 @@
 
     <request name="resize">
       <description summary="start an interactive resize">
-	Start a pointer-driven resizing of the surface.
+	Start a user-driven, interactive resize of the surface.
+
+	This request must be used in response to some sort of user action
+	like a button press, key press, or touch down event.
 
-	This request must be used in response to a button press event.
 	The server may ignore resize requests depending on the state of
 	the surface (e.g. fullscreen or maximized).
       </description>
-      <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat whose pointer is used"/>
+      <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/>
-      <arg name="serial" type="uint" summary="serial of the implicit grab on the pointer"/>
+      <arg name="serial" type="uint" summary="the serial of the user event"/>
       <arg name="edges" type="uint" summary="which edge or corner is being dragged"/>
     </request>
 
@@ -279,16 +296,21 @@
 
     <event name="configure">
       <description summary="suggest a surface change">
-	The configure event asks the client to resize its surface.
+	The configure event asks the client to resize its surface or to
+	change its state.
 
 	The width and height arguments specify a hint to the window
-        about how its surface should be resized in window geometry
+	about how its surface should be resized in window geometry
-        coordinates. The states listed in the event specify how the
+	coordinates.
-        width/height arguments should be interpreted.
 
-        A client should arrange a new surface, and then send a
+	The states listed in the event specify how the width/height
-        ack_configure request with the serial sent in this configure
+	arguments should be interpreted, and possibly how it should be
-        event before attaching a new surface.
+	drawn.
+
+	Clients should arrange their surface for the new size and
+	states, and then send a ack_configure request with the serial
+	sent in this configure event at some point before committing
+	the new surface.
 
 	If the client receives multiple configure events before it
         can respond to one, it is free to discard all but the last
@@ -303,14 +325,19 @@
 
     <request name="ack_configure">
       <description summary="ack a configure event">
-        When a configure event is received, a client should then ack it
+        When a configure event is received, if a client commits the
-        using the ack_configure request to ensure that the compositor
+        surface in response to the configure event, then the client
-        knows the client has seen the event.
+        must make a ack_configure request before the commit request,
+        passing along the serial of the configure event.
 
-        By this point, the state is confirmed, and the next attach should
+        The compositor might use this information to move a surface
-        contain the buffer drawn for the configure event you are acking.
+        to the top left only when the client has drawn itself for
+        the maximized or fullscreen state.
+
+        If the client receives multiple configure events before it
+        can respond to one, it only has to ack the last configure event.
       </description>
-      <arg name="serial" type="uint" summary="a serial to configure for"/>
+      <arg name="serial" type="uint" summary="the serial from the configure event"/>
     </request>
 
     <request name="set_window_geometry">
@@ -320,15 +347,20 @@
         portions like drop-shadows which should be ignored for the
         purposes of aligning, placing and constraining windows.
 
-        The default value is the full bounds of the surface, including any
+        Once the window geometry of the surface is set once, it is not
-        subsurfaces. Once the window geometry of the surface is set once,
+        possible to unset it, and it will remain the same until
-        it is not possible to unset it, and it will remain the same until
         set_window_geometry is called again, even if a new subsurface or
         buffer is attached.
 
+        If never set, the value is the full bounds of the surface,
+        including any subsurfaces. This updates dynamically on every
+        commit. This unset mode is meant for extremely simple clients.
+
         If responding to a configure event, the window geometry in here
         must respect the sizing negotiations specified by the states in
         the configure event.
+
+        The width and height must be greater than zero.
       </description>
       <arg name="x" type="int"/>
       <arg name="y" type="int"/>
@@ -351,7 +383,18 @@
     </request>
     <request name="unset_fullscreen" />
 
-    <request name="set_minimized" />
+    <request name="set_minimized">
+      <description summary="set the window as minimized">
+	Request that the compositor minimize your surface. There is no
+	way to know if the surface is currently minimized, nor is there
+	any way to unset minimization on this surface.
+
+	If you are looking to throttle redrawing when minimized, please
+	instead use the wl_surface.frame event for this, as this will
+	also work with live previews on windows in Alt-Tab, Expose or
+	similar compositor features.
+      </description>
+    </request>
 
     <event name="close">
       <description summary="surface wants to be closed">
@@ -368,45 +411,74 @@
   </interface>
 
   <interface name="xdg_popup" version="1">
-    <description summary="desktop-style metadata interface">
+    <description summary="short-lived, popup surfaces for menus">
-      An interface that may be implemented by a wl_surface, for
+      A popup surface is a short-lived, temporary surface that can be
-      implementations that provide a desktop-style popups/menus. A popup
+      used to implement menus. It takes an explicit grab on the surface
-      surface is a transient surface with an added pointer grab.
+      that will be dismissed when the user dismisses the popup. This can
+      be done by the user clicking outside the surface, using the keyboard,
+      or even locking the screen through closing the lid or a timeout.
 
-      An existing implicit grab will be changed to owner-events mode,
+      When the popup is dismissed, a popup_done event will be sent out,
-      and the popup grab will continue after the implicit grab ends
+      and at the same time the surface will be unmapped. The xdg_popup
-      (i.e. releasing the mouse button does not cause the popup to be
+      object is now inert and cannot be reactivated, so clients should
-      unmapped).
+      destroy it. Explicitly destroying the xdg_popup object will also
+      dismiss the popup and unmap the surface.
 
-      The popup grab continues until the window is destroyed or a mouse
+      Clients will receive events for all their surfaces during this
-      button is pressed in any other clients window. A click in any of
+      grab (which is an "owner-events" grab in X11 parlance). This is
-      the clients surfaces is reported as normal, however, clicks in
+      done so that users can navigate through submenus and other
-      other clients surfaces will be discarded and trigger the callback.
+      "nested" popup windows without having to dismiss the topmost
+      popup.
 
-      The x and y arguments specify the locations of the upper left
+      Clients that want to dismiss the popup when another surface of
-      corner of the surface relative to the upper left corner of the
+      their own is clicked should dismiss the popup using the destroy
-      parent surface, in surface local coordinates.
+      request.
 
-      xdg_popup surfaces are always transient for another surface.
+      The parent surface must have either an xdg_surface or xdg_popup
+      role.
+
+      Specifying an xdg_popup for the parent means that the popups are
+      nested, with this popup now being the topmost popup. Nested
+      popups must be destroyed in the reverse order they were created
+      in, e.g. the only popup you are allowed to destroy at all times
+      is the topmost one.
+
+      If there is an existing popup when creating a new popup, the
+      parent must be the current topmost popup.
+
+      A parent surface must be mapped before the new popup is mapped.
+
+      When compositors choose to dismiss a popup, they will likely
+      dismiss every nested popup as well.
+
+      The x and y arguments specify where the top left of the popup
+      should be placed, relative to the local surface coordinates of the
+      parent surface.
     </description>
 
+    <enum name="error">
+      <description summary="xdg_popup error values">
+	These errors can be emitted in response to xdg_popup requests.
+      </description>
+      <entry name="not_the_topmost_popup" value="0" summary="The client tried to map or destroy a non-toplevel popup"/>
+      <entry name="invalid_parent" value="1" summary="The client specified an invalid parent surface"/>
+    </enum>
+
     <request name="destroy" type="destructor">
-      <description summary="remove xdg_surface interface">
+      <description summary="remove xdg_popup interface">
-	The xdg_surface interface is removed from the wl_surface object
+	This destroys the popup. Explicitly destroying the xdg_popup
-	that was turned into a xdg_surface with
+	object will also dismiss the popup, and unmap the surface.
-	xdg_shell.get_xdg_surface request. The xdg_surface properties,
+
-	like maximized and fullscreen, are lost. The wl_surface loses
+	If this xdg_popup is not the "topmost" popup, a protocol error
-	its role as a xdg_surface. The wl_surface is unmapped.
+	will be sent.
       </description>
     </request>
 
     <event name="popup_done">
       <description summary="popup interaction is done">
-	The popup_done event is sent out when a popup grab is broken,
+	The popup_done event is sent out when a popup is dismissed
-	that is, when the users clicks a surface that doesn't belong
+	by the compositor.
-	to the client owning the popup surface.
       </description>
-      <arg name="serial" type="uint" summary="serial of the implicit grab on the pointer"/>
     </event>
 
   </interface>