[Qemu-devel] [PATCH v5 00/12] Convert over to use keycodemapdb

[Daniel P. Berrange]

An update of:

  v1: https://lists.gnu.org/archive/html/qemu-devel/2017-08/msg02047.html
  v2: https://lists.gnu.org/archive/html/qemu-devel/2017-08/msg02471.html
  v3: https://lists.gnu.org/archive/html/qemu-devel/2017-08/msg02517.html
  v4: https://lists.gnu.org/archive/html/qemu-devel/2017-08/msg02708.html

The keycodemap project[1] provides a database mapping between many different
keysym/keycode/scancode sets, along with a tool to generate mapping/lookup
tables in various programming languages. It is already used by GTK-VNC,
SPICE-GTK and libvirt.

This series enables its use in QEMU, thus fixing a great many bugs/ommissions
in the 15+ key mapping tables people have manually written for QEMU.

The keycodemapdb code is designed to be used as a git sub-module, it is
not an external dependancy you need installed before use. In this version,
however, the sub-module is not directly use. Instead all the generated
files are checked into GIT. The downside to this is that we get an
enourmous pile of errors from checkpatch.pl. The tool that generates the
mapping files doesn't care about QEMU's coding style rules, because it is
a general purpose tool intended for use by many different projects.

As such I'm not very happy about the idea of checking the generated files into
GIT, and would prefer to go back to generating the files from the submodule
on every build, as was done in v4. I did this this in v5 way to illustrate the
approach, but on balance I think v4 approach was better. Using the v4 approach
would also means when updating the submodule later on, we don't have to post
largely meaningless patches of diffs to all the generated files.

This series converts all the front ends and all the input devices which are
using the new InputEvent framework. A handful of devices still use the
legacy kbd handler

  $ git grep -l add_kbd_event_handler hw
  hw/arm/musicpal.c
  hw/arm/nseries.c
  hw/arm/palm.c
  hw/arm/spitz.c
  hw/input/pxa2xx_keypad.c
  hw/input/stellaris_input.c

and could be usefully converted too.

I've not done much realworld testing of this yet. I did however write code
that compared the mapping tables before and after conversion to identify what
mapping changes have resulted in each frontend/backend.  What I still need to
go back and validate is the Print/Sysrq handling, because that is special
everywhere and I'm not entirely sure I've done that correctly yet. The GTK
frontend should now work correctly when run on X11 servers on Win32 and OS-X,
as well as when run on native Win32/OS-X display backends.

[1] https://gitlab.com/keycodemap/keycodemapdb/

Changed in v5:

 - Don't try to initialize git submodule at all
 - Store generate keymap files in GIT

Changed in v4:

 - Run submodule update in source_dir for vpath builds (patchew)
 - Force submodule update in docker rules in case they
   are run without configure (patchew)

Changed in v3:

 - Ensure docker builds pull in keycodemapdb submodule (patchew)
 - Add compat with py26 for RHEL-6 in keycodemapdb tools (patchew)
 - Initialize submodule in configure script (patchew)

Changed in v2:

 - Change filename pattern to 'ui/input-keymap-$SRC-to-$DST.c'
   and map names 'qemu_input_map_$SRC_to_$DST'  (Eric)
 - Fix typos (Eric)
 - Drop changes to InputKeyEvent struct (Eric)
 - Fix VPATH build (patchew)
 - Fix code style errors (patchew)


Daniel P. Berrange (12):
  ui: add keycodemapdb repository as a GIT submodule
  ui: convert common input code to keycodemapdb
  ui: convert key events to QKeyCodes immediately
  ui: don't export qemu_input_event_new_key
  input: convert virtio-input-hid device to keycodemapdb
  input: convert ps2 device to keycodemapdb
  input: convert the adb device to keycodemapdb
  char: convert the escc device to keycodemapdb
  ui: convert cocoa frontend to keycodemapdb
  ui: convert the SDL2 frontend to keycodemapdb
  ui: convert GTK and SDL1 frontends to keycodemapdb
  display: convert XenInput keyboard to keycodemapdb

 .gitmodules                            |   3 +
 hw/char/escc.c                         | 126 +--------
 hw/display/xenfb.c                     | 133 +++-------
 hw/input/adb.c                         | 124 +--------
 hw/input/ps2.c                         | 406 +----------------------------
 hw/input/virtio-input-hid.c            | 136 +---------
 include/hw/input/adb-keys.h            | 141 ----------
 include/ui/input.h                     |  57 +++-
 ui/Makefile.objs                       |  43 ++-
 ui/cocoa.m                             | 129 +--------
 ui/gtk.c                               | 205 +++++++++------
 ui/input-keymap-atset1-to-qcode.c      | 245 +++++++++++++++++
 ui/input-keymap-linux-to-qcode.c       | 463 +++++++++++++++++++++++++++++++++
 ui/input-keymap-osx-to-qcode.c         | 128 +++++++++
 ui/input-keymap-qcode-to-adb.c         | 156 +++++++++++
 ui/input-keymap-qcode-to-atset1.c      | 154 +++++++++++
 ui/input-keymap-qcode-to-atset2.c      | 142 ++++++++++
 ui/input-keymap-qcode-to-atset3.c      | 138 ++++++++++
 ui/input-keymap-qcode-to-linux.c       | 156 +++++++++++
 ui/input-keymap-qcode-to-qnum.c        | 154 +++++++++++
 ui/input-keymap-qnum-to-qcode.c        | 245 +++++++++++++++++
 ui/input-keymap-usb-to-qcode.c         | 177 +++++++++++++
 ui/input-keymap-win32-to-qcode.c       | 157 +++++++++++
 ui/input-keymap-x11-to-qcode.c         | 163 ++++++++++++
 ui/input-keymap-xorgevdev-to-qcode.c   | 463 +++++++++++++++++++++++++++++++++
 ui/input-keymap-xorgkbd-to-qcode.c     | 122 +++++++++
 ui/input-keymap-xorgxquartz-to-qcode.c | 128 +++++++++
 ui/input-keymap-xorgxwin-to-qcode.c    | 122 +++++++++
 ui/input-keymap.c                      | 341 +++---------------------
 ui/input.c                             |   8 +-
 ui/keycodemapdb                        |   1 +
 ui/sdl.c                               | 105 +++-----
 ui/sdl2-input.c                        |  16 +-
 ui/sdl2-keymap.h                       | 267 -------------------
 ui/trace-events                        |   9 +-
 ui/x_keymap.c                          | 250 +++++++-----------
 ui/x_keymap.h                          |   8 +-
 37 files changed, 3774 insertions(+), 2047 deletions(-)
 delete mode 100644 include/hw/input/adb-keys.h
 create mode 100644 ui/input-keymap-atset1-to-qcode.c
 create mode 100644 ui/input-keymap-linux-to-qcode.c
 create mode 100644 ui/input-keymap-osx-to-qcode.c
 create mode 100644 ui/input-keymap-qcode-to-adb.c
 create mode 100644 ui/input-keymap-qcode-to-atset1.c
 create mode 100644 ui/input-keymap-qcode-to-atset2.c
 create mode 100644 ui/input-keymap-qcode-to-atset3.c
 create mode 100644 ui/input-keymap-qcode-to-linux.c
 create mode 100644 ui/input-keymap-qcode-to-qnum.c
 create mode 100644 ui/input-keymap-qnum-to-qcode.c
 create mode 100644 ui/input-keymap-usb-to-qcode.c
 create mode 100644 ui/input-keymap-win32-to-qcode.c
 create mode 100644 ui/input-keymap-x11-to-qcode.c
 create mode 100644 ui/input-keymap-xorgevdev-to-qcode.c
 create mode 100644 ui/input-keymap-xorgkbd-to-qcode.c
 create mode 100644 ui/input-keymap-xorgxquartz-to-qcode.c
 create mode 100644 ui/input-keymap-xorgxwin-to-qcode.c
 create mode 160000 ui/keycodemapdb
 delete mode 100644 ui/sdl2-keymap.h

-- 
2.13.5