[PATCH 1/2] Introduce keyboard grabbing protocol for Xwayland

Wed Apr 12 08:26:02 UTC 2017

On Wed, Mar 22, 2017 at 05:27:22PM +0100, Olivier Fourdan wrote:
> This patch introduces a new protocol for grabbing the keyboard from
> Xwayland.
> 
> This is needed for X11 applications that map an override redirect window
> (ths not focused by the window manager) and issue an active grab on the
> keyboard to capture all keyboard events.
> 

Here are some input; I'll also send some others as a reply to another
mail in this thread, but these are more "standalone" and nitpick:y.

> Signed-off-by: Olivier Fourdan <ofourdan at redhat.com>
> ---
>  Makefile.am                                        |   2 +
>  configure.ac                                       |   2 +-
>  unstable/xwayland-keyboard-grab/README             |   4 +
>  .../xwayland-keyboard-grab-unstable-v1.xml         | 101 +++++++++++++++++++++
>  4 files changed, 108 insertions(+), 1 deletion(-)
>  create mode 100644 unstable/xwayland-keyboard-grab/README
>  create mode 100644 unstable/xwayland-keyboard-grab/xwayland-keyboard-grab-unstable-v1.xml
> 
> diff --git a/Makefile.am b/Makefile.am
> index e693afa..d100c13 100644
> --- a/Makefile.am
> +++ b/Makefile.am
> @@ -12,6 +12,8 @@ unstable_protocols =								\
>  	unstable/tablet/tablet-unstable-v2.xml			                \
>  	unstable/xdg-foreign/xdg-foreign-unstable-v1.xml			\
>  	unstable/idle-inhibit/idle-inhibit-unstable-v1.xml			\
> +	unstable/xwayland-keyboard-grab/xwayland-keyboard-grab-unstable-v1.xml	\
> +	unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml \
>  	$(NULL)
>  
>  stable_protocols =								\
> diff --git a/configure.ac b/configure.ac
> index fbb0ec2..e98bceb 100644
> --- a/configure.ac
> +++ b/configure.ac
> @@ -1,7 +1,7 @@
>  AC_PREREQ([2.64])
>  
>  m4_define([wayland_protocols_major_version], [1])
> -m4_define([wayland_protocols_minor_version], [7])
> +m4_define([wayland_protocols_minor_version], [8])

Leave the version bumping to the release process.

>  m4_define([wayland_protocols_version],
>            [wayland_protocols_major_version.wayland_protocols_minor_version])
>  
> diff --git a/unstable/xwayland-keyboard-grab/README b/unstable/xwayland-keyboard-grab/README
> new file mode 100644
> index 0000000..dbe45a5
> --- /dev/null
> +++ b/unstable/xwayland-keyboard-grab/README
> @@ -0,0 +1,4 @@
> +Xwayland keyboard grabbing protocol
> +
> +Maintainers:
> +Olivier Fourdan <ofourdan at redhat.com>
> diff --git a/unstable/xwayland-keyboard-grab/xwayland-keyboard-grab-unstable-v1.xml b/unstable/xwayland-keyboard-grab/xwayland-keyboard-grab-unstable-v1.xml
> new file mode 100644
> index 0000000..31dc365
> --- /dev/null
> +++ b/unstable/xwayland-keyboard-grab/xwayland-keyboard-grab-unstable-v1.xml
> @@ -0,0 +1,101 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<protocol name="xwayland_keyboard_grab_unstable_v1">
> +
> +  <copyright>
> +	Copyright © 2017 Red Hat Inc.
> +
> +	Permission is hereby granted, free of charge, to any person obtaining a
> +	copy of this software and associated documentation files (the "Software"),
> +	to deal in the Software without restriction, including without limitation
> +	the rights to use, copy, modify, merge, publish, distribute, sublicense,
> +	and/or sell copies of the Software, and to permit persons to whom the
> +	Software is furnished to do so, subject to the following conditions:
> +
> +	The above copyright notice and this permission notice (including the next
> +	paragraph) shall be included in all copies or substantial portions of the
> +	Software.
> +
> +	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> +	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> +	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
> +	THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> +	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> +	FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
> +	DEALINGS IN THE SOFTWARE.

Indentation seems wrong.

> +  </copyright>
> +
> +  <description summary="Protocol for grabbing the keyboard from Xwayland">
> +	This protocol specifies a way for Xwayland to request all keyboard
> +	events to be forwarded to a surface even when the surface does not
> +	have keyboard focus.
> +
> +	Unlike the X11 protocol, Wayland doesn't have the notion of
> +	active grab on the keyboard.
> +
> +	When an	X11 client acquires an active grab on the keyboard, all
> +	key events are reported only to the grabbing X11 client.
> +	When running in Xwayland, X11 applications may acquire an active
> +	grab but that cannot be translated to the Wayland compositor who
> +	may set the input focus to some other surface, thus breaking the
> +	X11 client assumption that all key events are reported.
> +
> +	When an X11 client requests a keyboard grab, the Wayland compositor
> +	may either inform or ask the user for the right to forward all key
> +	events to the given client surface.
> +
> +	Warning! The protocol described in this file is experimental and
> +	backward incompatible changes may be made. Backward compatible
> +	changes may be added together with the corresponding interface
> +	version bump.
> +	Backward incompatible changes are done by bumping the version
> +	number in the protocol and interface names and resetting the
> +	interface version. Once the protocol is to be declared stable,
> +	the 'z' prefix and the version number in the protocol and
> +	interface names are removed and the interface version number is
> +	reset.

Indentation seems wrong. Also in the interface descriptions.

> +  </description>
> +
> +  <interface name="zwp_keyboard_grab_manager_v1" version="1">

How about we start a new trend here and prefix xwayland protocols (there
might be more of these in the future I suspect) with xwayland? I.e.
something like wp_xwayland_keyboard_grabber. It'll make it painfully
obvious that its Xwayland related, and will enable us to have a
non-Xwayland "keyboard grab manager" in the future would we ever want
to.

> +    <description summary="context object for keyboard grab_manager">
> +	A global interface used for grabbing the keyboard.
> +    </description>
> +
> +    <request name="destroy" type="destructor">
> +      <description summary="destroy the keyboard grab manager">
> +	Destroy the keyboard grab manager.
> +      </description>
> +    </request>
> +
> +    <request name="grab_keyboard">
> +      <description summary="grab the keyboard to a surface">
> +	The grab_keyboard request can be used by the client to ask for a
> +	grab of the keyboard, effectively reporting all key events to a
> +	surface.
> +
> +	The protocol provides no guarantee that the grab is ever satisfied,
> +	and does not require the compositor to send an error if the grab
> +	cannot ever be satisfied. It is thus possible to request a keyboard
> +	grab that will never be effective.
> +      </description>
> +
> +      <arg name="id" type="new_id" interface="zwp_keyboard_grab_v1"/>
> +      <arg name="surface" type="object" interface="wl_surface"
> +	   summary="surface to report keyboard events to"/>
> +      <arg name="seat" type="object" interface="wl_seat"
> +	   summary="the seat for which the keyboard should be grabbed"/>
> +    </request>
> +  </interface>
> +
> +  <interface name="zwp_keyboard_grab_v1" version="1">

Same here, this could be a "wp_xwayland_keyboard_grab", making things
more obvious.

Jonas

> +    <description summary="interface for grabbing the keyboard">
> +	A global interface used for grabbing the keyboard.
> +    </description>
> +
> +    <request name="destroy" type="destructor">
> +      <description summary="destroy the grabbed keyboard object">
> +	Destroy the grabbed keyboard object. If applicable, the compositor
> +	will ungrab the keyboard.
> +      </description>
> +    </request>
> +  </interface>
> +</protocol>
> -- 
> 2.9.3
> 

> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/wayland-devel