On Fri, Jun 30, 2017 at 06:10:01PM +0200, 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 > (thus not focused by the window manager) and issue an active grab on the > keyboard to capture all keyboard events. > > Signed-off-by: Olivier Fourdan <[email protected]> > Reviewed-by: Peter Hutterer <[email protected]>
Reviewed-by: Jonas Ådahl <[email protected]> and pushed. Thanks! > --- > Makefile.am | 1 + > unstable/xwayland-keyboard-grab/README | 4 + > .../xwayland-keyboard-grab-unstable-v1.xml | 121 > +++++++++++++++++++++ > 3 files changed, 126 insertions(+) > 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..12465e6 100644 > --- a/Makefile.am > +++ b/Makefile.am > @@ -12,6 +12,7 @@ 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 > \ > $(NULL) > > stable_protocols = > \ > 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 <[email protected]> > 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..be4992f > --- /dev/null > +++ b/unstable/xwayland-keyboard-grab/xwayland-keyboard-grab-unstable-v1.xml > @@ -0,0 +1,121 @@ > +<?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. > + </copyright> > + > + <description summary="Protocol for grabbing the keyboard from Xwayland"> > + This protocol is application-specific to meet the needs of the X11 > + protocol through Xwayland. It provides a way for Xwayland to request > + all keyboard events to be forwarded to a surface even when the > + surface does not have keyboard focus. > + > + In the X11 protocol, a client may request an "active grab" on the > + keyboard. On success, all key events are reported only to the > + grabbing X11 client. For details, see XGrabKeyboard(3). > + > + The core Wayland protocol does not have a notion of an active > + keyboard grab. When running in Xwayland, X11 applications may > + acquire an active grab inside Xwayland but that cannot be translated > + to the Wayland compositor who may set the input focus to some other > + surface. In doing so, it breaks the X11 client assumption that all > + key events are reported to the grabbing client. > + > + This protocol specifies a way for Xwayland to request all keyboard > + be directed to the given surface. The protocol does not guarantee > + that the compositor will honor this request and it does not > + prescribe user interfaces on how to handle the respond. For example, > + a compositor may inform the user that all key events are now > + forwarded to the given client surface, or it may ask the user for > + permission to do so. > + > + Compositors are required to restrict access to this application > + specific protocol to Xwayland alone. > + > + 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. > + </description> > + > + <interface name="zwp_xwayland_keyboard_grab_manager_v1" version="1"> > + <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 asks for a grab of the keyboard, forcing > + the keyboard focus for the given seat upon the given 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. > + > + The protocol: > + > + * does not guarantee that the grab itself is applied for a surface, > + the grab request may be silently ignored by the compositor, > + * does not guarantee that any events are sent to this client even > + if the grab is applied to a surface, > + * does not guarantee that events sent to this client are exhaustive, > + a compositor may filter some events for its own consumption, > + * does not guarantee that events sent to this client are continuous, > + a compositor may change and reroute keyboard events while the grab > + is nominally active. > + </description> > + > + <arg name="id" type="new_id" > interface="zwp_xwayland_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_xwayland_keyboard_grab_v1" version="1"> > + <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.4 > _______________________________________________ [email protected]: X.Org development Archives: http://lists.x.org/archives/xorg-devel Info: https://lists.x.org/mailman/listinfo/xorg-devel
