[PATCH wayland-protocols v5 2/2] Add keyboard shortcuts inhibitor
Peter Hutterer
peter.hutterer at who-t.net
Tue Jun 6 06:56:01 UTC 2017
On Fri, Jun 02, 2017 at 11:06:26AM +0200, Olivier Fourdan wrote:
> This adds a new protocol to let Wayland clients specify that they want
> all keyboard events to be sent to the client, regardless of the
> compositor own shortcuts.
>
> This protocol can be used for virtual machine and remote connection
> viewers which require to pass all keyboard shortcuts to the hosted or
> remote system instead of being caught up by the compositor locally.
>
> Signed-off-by: Olivier Fourdan <ofourdan at redhat.com>
> ---
> Makefile.am | 1 +
> unstable/keyboard-shortcuts-inhibit/README | 4 +
> .../keyboard-shortcuts-inhibit-unstable-v1.xml | 170 +++++++++++++++++++++
> 3 files changed, 175 insertions(+)
> create mode 100644 unstable/keyboard-shortcuts-inhibit/README
> create mode 100644 unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml
>
> diff --git a/Makefile.am b/Makefile.am
> index 12465e6..d100c13 100644
> --- a/Makefile.am
> +++ b/Makefile.am
> @@ -13,6 +13,7 @@ unstable_protocols = \
> 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/unstable/keyboard-shortcuts-inhibit/README b/unstable/keyboard-shortcuts-inhibit/README
> new file mode 100644
> index 0000000..63ff335
> --- /dev/null
> +++ b/unstable/keyboard-shortcuts-inhibit/README
> @@ -0,0 +1,4 @@
> +Compositor shortcuts inhibit protocol
> +
> +Maintainers:
> +Olivier Fourdan <ofourdan at redhat.com>
> diff --git a/unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml b/unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml
> new file mode 100644
> index 0000000..6c9f6e9
> --- /dev/null
> +++ b/unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml
> @@ -0,0 +1,170 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<protocol name="keyboard_shortcuts_inhibit_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 inhibiting the compositor keyboard shortcuts">
> + This protocol specifies a way for a client to request the compositor
> + to ignore its own keyboard shortcuts for a given seat, so that all
> + key events from that seat get forwarded to a 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.
> + </description>
> +
> + <interface name="zwp_keyboard_shortcuts_inhibit_manager_v1" version="1">
> + <description summary="context object for keyboard grab_manager">
> + A global interface used for inhibiting the compositor keyboard shortcuts.
> + </description>
> +
> + <request name="destroy" type="destructor">
> + <description summary="destroy the keyboard shortcuts inhibitor object">
> + Destroy the keyboard shortcuts inhibitor manager.
> + </description>
> + </request>
> +
> + <request name="inhibit_shortcuts">
> + <description summary="create a new keyboard shortcuts inhibitor object">
> + Create a new keyboard shortcuts inhibitor object associated with
> + the given surface for the given seat.
> +
> + If shortcuts are already inhibited for the specified seat and surface,
> + a protocol error "already_inhibited" is raised by the compositor.
> + </description>
> + <arg name="id" type="new_id" interface="zwp_keyboard_shortcuts_inhibitor_v1"/>
> + <arg name="surface" type="object" interface="wl_surface"
> + summary="the surface that inhibits the keyboard shortcuts behavior"/>
> + <arg name="seat" type="object" interface="wl_seat"
> + summary="the wl_seat for which keyboard shortcuts should be disabled"/>
indentation mismatch, sorry :(
> + </request>
> +
> + </interface>
> +
> + <interface name="zwp_keyboard_shortcuts_inhibitor_v1" version="1">
> + <description summary="context object for keyboard shortcuts inhibitor">
> + A keyboard shortcuts inhibitor instructs the compositor to ignore
> + its own keyboard shortcuts when the associated surface has keyboard
> + focus. As a result, when the surface is focused, it will receive all
> + key events originating from the specified seat, even those which
> + would normally be caught by the compositor for its own shortcuts.
> +
> + The Wayland compositor is however under no obligation to disable
> + all of its shortcuts, and may keep some special key combo for its own
> + use, including but not limited to one allowing the user to forcibly
> + restore normal keyboard events routing in the case of an unwilling
> + client. The compositor may also use the same key combo to reactivate
> + an existing shortcut inhibitor that was previously deactivated on
> + user request.
> +
> + When the compositor implements a special key combo to forcibly
> + deactivate a keyboard shortcut inhibitor, it must provide the client
> + with a key combo definition sequence which allows the client to use
> + the same key combo and possibly display a hint to the user on how
> + deactivate the shortcut inhibitor. The sequence comprises a series
> + of wl_keyboard keymap, modifier and key events surrounded by
> + key_combo_start and key_combo_end events (see the key_combo_start
> + and key_combo_end events description).
> +
> + When the compositor restores its own keyboard shortcuts, an
> + "inactive" event is emitted to notify the client that the keyboard
> + shortcuts inhibitor is not effectively active for the surface and
> + seat any more, and the client should not expect to receive all
> + keyboard events.
> +
> + When the keyboard shortcuts inhibitor is inactive, the client has
> + no way to forcibly reactivate the keyboard shortcuts inhibitor.
> +
> + The user can chose to re-enable a previously deactivated keyboard
> + shortcuts inhibitor using any mechanism the compositor may offer,
> + in which case the compositor will send an "active" event to notify
> + the client.
> +
> + If the surface is destroyed, unmapped, or loses the seat's keyboard
> + focus, the keyboard shortcuts inhibitor becomes irrelevant and the
> + compositor will restore its own keyboard shortcuts but no "inactive"
> + event is emitted in this case.
> + </description>
> +
> + <request name="destroy" type="destructor">
> + <description summary="destroy the keyboard shortcuts inhibitor object">
> + Remove the keyboard shortcuts inhibitor from the associated wl_surface.
> + </description>
> + </request>
> +
> + <event name="active">
> + <description summary="shortcuts are inhibited">
> + This event indicates that the shortcut inhibitor is active.
> +
> + The compositor will send this event every time it deactivates its
> + shortcuts for the given surface, this occurs typically when the
> + initial request "inhibit_shortcuts" first becomes active or when
> + the user instructs the compositor to re-enable and existing shortcuts
> + inhibitor using any mechanism offered by the compositor.
sending an "active" event every time the compositor deactivates is
confusing :) How about:
"The compositor sends this event every time the given surface is given
full access to all keyboard shortcuts, including the ones usually reserved
by the compositors (though see zwp_keyboard_shortcuts_inhibitor_v1 for
details. This occurs typically..."
(also: "every time" or "each time"? Someone who's not ESL or at least better
at E than me should clarify)
> + </description>
> + </event>
> +
> + <event name="key_combo_start">
> + <description summary="Start of a key combo sequence definition">
> + This event indicates the beginning of keyboard combo definition.
typo: "of *a* keyboard combo definition". Having said that, my gut tells me
this approach is a bad idea (though I'm not 100% sure how else to solve it).
First problem: you have to define modifier behaviour for that keyboard
combo, because ctl+alt+L is the same as alt+ctrl+l, right? And that's
handled by the modifier + key event approach. But a screen/emacs-like
C-a C-x or something like that, how would you do that?
Afaict, you're also allowing yourself only one combination here? Which is
probably good enough, but still...
But you're definitely restricting yourself to a specific key combination
rather than, say: "bump the top of the screen, wait for the dock to come
down, then click on button X" which is used by browsers/video players in
full-screen. Or "wobble the mouse really fast", or something like that.
But most importantly, the client doesn't need to care what the magic
sequence is because it has no control for it anyway. Maybe the solution is
to send a UTF8 string intended for display by the client. That way you can
have "switch your webcam on and do the macarena" as escape sequence too.
Sorry, should've pointed that out earlier, but you know how it is.
Cheers,
Peter
> +
> + The compositor sends this event before sending a sequence of
> + wl_keyboard keymap, modifier and key events describing the key
> + combo used by the compositor to allow the user to forcibly
> + deactivate a shortcut inhibitor.
> +
> + The client can use this shortcut sequence definition to show the
> + user an indication on how to deactivate the shortcut inhibitor.
> +
> + The compositor sends the key combo definition sequence when a
> + keyboard inhibitor is created and whenever the keymap or key combo
> + definition changes (so that the client is updated with the new
> + key combo definition).
> + </description>
> + </event>
> +
> + <event name="key_combo_end">
> + <description summary="End of a key combo sequence definition">
> + This event indicates the end of keyboard combo definition.
> +
> + The compositor sends this event once all keymap, modifier and key
> + sequence of events describing the key combo to deactivate the
> + shortcut inhibitor is complete.
> + </description>
> + </event>
> +
> + <enum name="error">
> + <entry name="already_inhibited"
> + value="0"
> + summary="the shortcuts are already inhibited for this surface"/>
> + </enum>
> + </interface>
> +</protocol>
> --
> 2.9.4
>
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/wayland-devel
>
More information about the xorg-devel
mailing list