Use python3 binary rather than unversioned python

Some distros do not provide an unversioned python binary and it could
point to either python2 or python3. Use python3 explicitly instead.

Signed-off-by: Ross Lagerwall <ross.lagerwall@citrix.com>

Revert "Add local argparse for compat with python 2.6"

This reverts commit 56ce5650d2c6ea216b4580df44b9a6dd3bc92c3b.

Python 2 is end of life and if by some chance there is still unexpected
usage of python 2, it is likely that it is is 2.7 which includes argparse.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>

Fix macOS "ISO" key

This is actually the common ISO "102nd" key, found between the left
shift and "Z".

Note that this is still technically wrong, as macOS swaps the key codes
for ANSI_Grave and ISO_Section for ISO layouts. This magic is not
something we can encode here though, so that swapping will have to be
done by the implementations using this data.

make the meson.build stub a bit more well-rounded by exporting files

Provide variables for:
- the found program keymap-gen
- the CSV mapping table

and for enhanced convenience, override keymap-gen

This allows grabbing the variables from another Meson project without
futzing with submodule paths, something that Meson doesn't really
encourage.

Add .gitattributes file

The files marked as export-ignore here are not going to be
included in the tarball produced by 'meson dist' when using
meson >= 0.60. Older versions of meson excluded some files
automatically, but that no longer happens.

Note that, while keycodemapdb itself doesn't use meson or
really produce release tarballs, the presence of this file
will help meson-using projects that include it as a git
submodule - for example libvirt.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>

add more japanese mappings

Add QEMU QKeyCode "lang1" and "lang2"

This corresponds to commit d7696ff884e35c6dacf83a7cbe3355e3b0a90125
of https://gitlab.com/qemu-project/qemu.

Signed-off-by: Akihiko Odaki <akihiko.odaki@gmail.com>

rust: fix cargo clippy

Fix clippy error about missing main().

Fix various clippy warnings "help: consider removing `'static`: `&str`"

Run clippy with the rust test.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>

tests: add rust test

gen: add --lang rust

The static maps use the phf crate.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>

tests: fix argument order

Fixes: 7381b9bfadd31c ("Introduce separate args for title & subtitle
with docs generator")

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>

Fix scan codes for Korean keys

No idea where the previous values are from, but they are not supported
by any information we can find now.

Fix argument order in output headers

The sub-command needs to come before all other arguments.

Add HTML entries for Korean layout keys

Add macOS entries for Japanese keyboards

Apple has a different layout for their Japanese keyboards compared to PC
and are reusing the scan codes used on Korean layouts for their special
keys.

Fix win32 keycode for VK_OEM_102

The win32 keycode for VK_OEM_102 is 0xe2. The Microsoft docu-
mentation for virtual-key codes agrees with mingw32/winuser.h.

Signed-off-by: Volker Rümelin <vr_qemu@t-online.de>

Add support for generating RST formatted docs pages

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>

Introduce separate args for title & subtitle with docs generator

With this change the calling conversion is different, the --varname
arg must be after the command name.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>

keymap-gen: Name sections in pod output

Properly formatted man pages have at least a NAME section,
which tools like apropos(1) parse and index.

The current implementation of PodLanguageGenerator doesn't
generate this section, and even if the user were to try and
work around the limitation by passing --varname=NAME, there
would still be nothing in the section to actually parse.

Change the generator so that varname will be used as the
contents of the NAME section, add a DESCRIPTION section in
which values are listed.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>

Add an empty meson project

This allows to make keycodemapdb a subproject() in meson.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>

remove buildtime from generated files

Each rebuild gets a different file even if the sources are unchanged.
Debian sells this as "reproducible build".
SUSE just wants to avoid needless republish of otherwise identical binaries.

Signed-off-by: Olaf Hering <olaf@aepfle.de>

add header file generators

keymap-gen can create header files that include the length of the array.  Using
ARRAY_SIZE on the array becomes then possible, and this can be preferrable to
the "x_len" symbols because static analysis cannot necessarily see the value of
"x_len".

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>

c++: add extern declaration to the generated file

The extern declaration affects how the C++ compiler does name mangling of global
variables.  With:

    $ g++ -c -Wall -std=c++11 -o osx2win32.o osx2win32.cc
    $ nm osx2win32.o | grep code_map_osx_to_win32
    0000000000000000 B code_map_osx_to_win32
    00000000000000a1 t _GLOBAL__sub_I_code_map_osx_to_win32

Without:

    $ g++ -c -Wall -std=c++11 -o osx2win32.o osx2win32.cc
    $ nm osx2win32.o | grep code_map_osx_to_win32
    0000000000000000 b _ZL21code_map_osx_to_win32

Not that unlike C, without "extern" you get a local variable ("b"), while
"extern" is needed to get a global!

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>

move CLanguageGenerator closer to CLanguageGenerator itself

This is a small aesthetic change before introducing the generator subclasses
for C and C++ header files; place each subclass close to the superclass.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>

Fix compat with py3 dict keys/values data types

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add missing QKeyCode values for JIS keyboards

The AT set1 code for KEY_ISO is removed because it conflicts with
KEY_KATAKANAHIRAGANA.

Signed-off-by: Miika S <miika9764@gmail.com>

Fix mistake in Pause/SysRq mapping for SUN scancode

The 0x15 scancode is actually referring to Pause, but was
mistakenly recorded as a second scancode for SysRq

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add hack for mapping qnum 0xb7 to sysrq

Historical versions of QEMU allowed both 0x54 and 0xb7 to trigger
a print/sysrq key. Although 0x54 is preferred, we must cope with
0xb7 for backwards compat.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add local argparse for compat with python 2.6

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Rename 'rfb' to 'qnum'

The 'rfb' keymap is not actually defined by the RFB protocol.
It is the QEMU key number mapping, that happens to be used
by a QEMU RFB extension.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Allow customizing the map length data type

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Fix USB menu key mapping

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Remove ??? from some keynames

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Fix ANSI_KeypadClear mapping for OSX

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Handle maps where 0x0 is a valid key

With OS-X / ADB keycodes 0x0 refers to key 'A', so cannot be
used as the default in the array. We must use 0xff instead and
thus explicitly fill every array entry with 0xff if no mapping
is available.

To handle this for enum based source maps, we need to use the
magic syntax

   [0 .... max] = value,

to set the default value in all elements, and then override
it afterwards for mappings which are known.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add support for array upper bounds with enums

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add missing Help key entry for OS-X key codes

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add many missing Sun scancodes

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add Apple Desktop Bus scancodes

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Misc fixes in AT set 3 scancodes

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Fix AT set3 mapping for backslash

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Fix AT Set2 scancode for F7

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add line for QKeyCode print

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add line for QKeyCode asterisk

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add some missing mappings for USB HID

Some USB scan codes map to the same Linux key code, and we were
missing the first mapping.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add Sun/Sparc keyboard keycodes

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Build tests with warnings enabled

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add ability to generate enums

While we know the integer values corresponding to most key sets, the
QEMU QKeyCode values are explicitly not-public, not guaranteed stable.
We must therefore be able to emit symbolic enum constants, instead of
raw int values.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add named constants for QKeyCode values

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Use STL types for C++ output

This give us much nicer lookup for string keys, boundary checks
and better introspection when it comes to iteration.

Signed-off-by: Pierre Ossman <ossman@cendio.se>

Provide array size constant for C output

The array might not be in the same unit as the code using it, so
we need a way of indicating the number of entries.

Signed-off-by: Pierre Ossman <ossman@cendio.se>

Add support for JavaScript output

Signed-off-by: Pierre Ossman <ossman@cendio.se>

Handle string based codes

Some systems use string identifiers rather than integers.

Signed-off-by: Pierre Ossman <ossman@cendio.se>

Fix some keys on macOS

The right command key was missing and the menu key was mis-assigned.

Signed-off-by: Pierre Ossman <ossman@cendio.se>

Add mapping for XKEYBOARD key names

Signed-off-by: Pierre Ossman <ossman@cendio.se>

Add mapping for HTML key codes

Signed-off-by: Pierre Ossman <ossman@cendio.se>

Add tests for name-table

Signed-off-by: Pierre Ossman <ossman@cendio.se>

Add tests for name-map

Signed-off-by: Pierre Ossman <ossman@cendio.se>

Add tests for code-table

Signed-off-by: Pierre Ossman <ossman@cendio.se>

Add basic tests

Signed-off-by: Pierre Ossman <ossman@cendio.se>

Add README for data columns

Rename X11 keycode header to keysym

keycode means something else in X11, so let's adjust this header to
avoid confusion.

Fix AT set 2 table

There were a lot of errors for the extended codes. Re-generate
the entries based on the mapping Linux uses.

Merge XT columns

XT, Linux RAW and and AT set 1 are all really the same thing so merge
them all together. Linux RAW uses a different encoding, but we can
compute that as needed.

Correct lookup of name in comment

The maps are indexed by Linux keycode, not by the keycode type
corresponding to the names.

keymap-gen: add support for generating output for C++

Designated initializers ([index] = value,) are not available in C++:

https://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html

So add a custom stdc++ output format which outputs all array entries instead
of the "sparse" C variant.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>

Fix message when seeing unknown map

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Fix incompatibility with older argparse

With older argparse (circa 2.7.4 vintage), using set_defaults
to set a function on the main parser prevents it from ever
calling the functions set on the sub-parser.

We registered this default function so that we could get help
usage with argparse on python 3.x, since it doesn't print
error by default if no sub-parser command is given (but 2.x
does).

To workaround this, we instead check for 'func' attribute
existing on the parsed args. This is a no-op for python 2.x
since it already printed a usage message by default.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Merge branch 'master' into 'master'

keymap-gen: Import sys

See merge request !1

keymap-gen: Import sys

It is used in usage()

Add ability to generate Perl POD docs for key map names & values

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Fix xorg kbd mapping generator

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Print help message if no sub-command is given

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Use print_function in python 2

To allow portability with py3 use the print_function. This
requires python >= 2.6.0

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Don't call next() method in CSV reader

The next() method was renamed in python3. Simply avoid calling
it to ensure portability

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Use correct generator class for glib2

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Use guint16 / unsigned short for C data types

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Add missing X11 map field

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Initial import of code

The data/keymaps.csv file is taken from the latest SPICE-GTK
repository. All contributions from this original file in both
SPICE-GTK and GTK-VNC repos were made under Red Hat copyright.
Red Hat grants permission to relicense to dual GPL2 or 3-clause
BSD.

The data/keymap-gen tool is a brand new file.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>