[PATCH_v2] virtual-keyboard: Add new virtual keyboard protocol
Peter Hutterer
peter.hutterer at who-t.net
Wed May 30 04:28:12 UTC 2018
On Thu, May 24, 2018 at 08:27:29PM +0200, Dorota Czaplejewicz wrote:
> Provides the ability to emulate keyboards by applications. Complementary to input-method protocol.
>
> The interface is a mirror copy of wl_keyboard, with removed serials, and added seat binding.
> ---
> This is the slightly improved version of the virtual-keyboard-v1 protocol from Purism.
>
> Changes done:
> - fixed typos
> - enum arguments don't have the "enum" key in them, in order not to trip up wayland-scanner
> - added errors
>
> The test client is at https://code.puri.sm/Librem5/weston/src/virtual_keyboard - please use the weston-keyboard program:
>
> ./configure --enable-clients
> ./weston-keyboard
>
> A working wlroots implementation is available here:
>
> https://github.com/swaywm/wlroots/pull/999
>
> Thanks for feedback,
> Dorota Czaplejewicz
just one nitpick over Simon's comments, the copyright list starting at 2008
seems excessive.
However, I wonder what you're really trying to achieve here. For virtual
keyboards the mapping to a normal keyboard's physical buttons, then mapped
to the glyph elsewhere seems strange and limiting. On a virtual keyboard,
I'm not hitting KEY_A, I'm clicking on the button currently labelled with
'A'. There's a million things we could do to virtual keyboard that make the
assumption of virtual keyboard == physical keyboards go boom quite quickly.
e.g. on my phone once the emoticons are selected I don't get the normal
qwerty layout anymore but just a row/column arrangement of smileys.
I read your v1 email about splitting input-method and virtual-keyboard but
it's still not quite clear to me, sorry.
Cheers,
Peter
> Makefile.am | 1 +
> unstable/virtual-keyboard/README | 2 +
> .../virtual-keyboard-unstable-v1.xml | 113 +++++++++++++++++++++
> 3 files changed, 116 insertions(+)
> create mode 100644 unstable/virtual-keyboard/README
> create mode 100644 unstable/virtual-keyboard/virtual-keyboard-unstable-v1.xml
>
> diff --git a/Makefile.am b/Makefile.am
> index 4b9a901..fcd4572 100644
> --- a/Makefile.am
> +++ b/Makefile.am
> @@ -17,6 +17,7 @@ unstable_protocols = \
> unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml \
> unstable/xdg-output/xdg-output-unstable-v1.xml \
> unstable/input-timestamps/input-timestamps-unstable-v1.xml \
> + unstable/virtual-keyboard/virtual-keyboard-unstable-v1.xml \
> $(NULL)
>
> stable_protocols = \
> diff --git a/unstable/virtual-keyboard/README b/unstable/virtual-keyboard/README
> new file mode 100644
> index 0000000..a2c646d
> --- /dev/null
> +++ b/unstable/virtual-keyboard/README
> @@ -0,0 +1,2 @@
> +Virtual keyboard protocol
> +
> diff --git a/unstable/virtual-keyboard/virtual-keyboard-unstable-v1.xml b/unstable/virtual-keyboard/virtual-keyboard-unstable-v1.xml
> new file mode 100644
> index 0000000..df4d01c
> --- /dev/null
> +++ b/unstable/virtual-keyboard/virtual-keyboard-unstable-v1.xml
> @@ -0,0 +1,113 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<protocol name="virtual_keyboard_unstable_v1">
> + <copyright>
> + Copyright © 2008-2011 Kristian Høgsberg
> + Copyright © 2010-2013 Intel Corporation
> + Copyright © 2012-2013 Collabora, Ltd.
> + Copyright © 2018 Purism SPC
> +
> + 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>
> +
> + <interface name="zwp_virtual_keyboard_v1" version="1">
> + <description summary="virtual keyboard">
> + The virtual keyboard provides an application with requests which emulate
> + the behaviour of a physical keyboard.
> +
> + This interface can be used by clients on its own to provide raw input
> + events, or it can accompany the input method protocol.
> + </description>
> +
> + <request name="keymap">
> + <description summary="keyboard mapping">
> + Provide a file descriptor to the compositor which can be
> + memory-mapped to provide a keyboard mapping description.
> +
> + Format carries a value from the keymap_format enumeration.
> + </description>
> + <arg name="format" type="uint" summary="keymap format"/>
> + <arg name="fd" type="fd" summary="keymap file descriptor"/>
> + <arg name="size" type="uint" summary="keymap size, in bytes"/>
> + </request>
> +
> + <enum name="error">
> + <entry name="no_keymap" value="0" summary="No keymap was set"/>
> + </enum>
> +
> + <request name="key">
> + <description summary="key event">
> + A key was pressed or released.
> + The time argument is a timestamp with millisecond granularity, with an
> + undefined base. All requests regarding a single object must share the
> + same clock.
> +
> + Keymap must be set before issuing this request.
> +
> + State carries a value from the key_state enumeration.
> + </description>
> + <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
> + <arg name="key" type="uint" summary="key that produced the event"/>
> + <arg name="state" type="uint" summary="physical state of the key"/>
> + </request>
> +
> + <request name="modifiers">
> + <description summary="modifier and group state">
> + Notifies the compositor that the modifier and/or group state has
> + changed, and it should update state.
> +
> + The client should use wl_keyboard.modifiers event to synchronize its
> + internal state with seat state.
> +
> + Keymap must be set before issuing this request.
> + </description>
> + <arg name="mods_depressed" type="uint" summary="depressed modifiers"/>
> + <arg name="mods_latched" type="uint" summary="latched modifiers"/>
> + <arg name="mods_locked" type="uint" summary="locked modifiers"/>
> + <arg name="group" type="uint" summary="keyboard layout"/>
> + </request>
> +
> + <request name="destroy" type="destructor" since="1">
> + <description summary="destroy the virtual keyboard keyboard object"/>
> + </request>
> + </interface>
> +
> + <interface name="zwp_virtual_keyboard_manager_v1" version="1">
> + <description summary="virtual keyboard manager">
> + A virtual keyboard manager allows an application to provide keyboard
> + input events as if they came from a physical keyboard.
> + </description>
> +
> + <enum name="error">
> + <entry name="unauthorized" value="0" summary="client not authorized to use the interface"/>
> + </enum>
> +
> + <request name="create_virtual_keyboard">
> + <description summary="Create a new virtual keyboard">
> + Creates a new virtual keyboard associated to a seat.
> +
> + If the compositor enables a keyboard to perform arbitrary actions, it
> + should present an error when an untrusted client requests a new
> + keyboard.
> + </description>
> + <arg name="seat" type="object" interface="wl_seat"/>
> + <arg name="id" type="new_id" interface="zwp_virtual_keyboard_v1"/>
> + </request>
> + </interface>
> +</protocol>
> --
> 2.14.3
>
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/wayland-devel
>
More information about the wayland-devel
mailing list