| 1 | /* |
| 2 | * QEMU keymap utility |
| 3 | * |
| 4 | * Copyright Red Hat, Inc. 2017 |
| 5 | * |
| 6 | * Authors: |
| 7 | * Gerd Hoffmann <kraxel@redhat.com> |
| 8 | * |
| 9 | * This work is licensed under the terms of the GNU GPL, version 2 or later. |
| 10 | * See the COPYING file in the top-level directory. |
| 11 | */ |
| 12 | #include "qemu/osdep.h" |
| 13 | #include "qemu/notify.h" |
| 14 | #include "standard-headers/linux/input-event-codes.h" |
| 15 | #include "ui/input.h" |
| 16 | |
| 17 | #include <xkbcommon/xkbcommon.h> |
| 18 | |
| 19 | struct xkb_rule_names names = { |
| 20 | .rules = NULL, |
| 21 | .model = "pc105", |
| 22 | .layout = "us", |
| 23 | .variant = NULL, |
| 24 | .options = NULL, |
| 25 | }; |
| 26 | |
| 27 | static xkb_mod_mask_t shift; |
| 28 | static xkb_mod_mask_t ctrl; |
| 29 | static xkb_mod_mask_t altgr; |
| 30 | static xkb_mod_mask_t numlock; |
| 31 | |
| 32 | static FILE *outfile; |
| 33 | |
| 34 | /* ------------------------------------------------------------------------ */ |
| 35 | |
| 36 | static uint32_t linux_to_number(uint32_t lnx) |
| 37 | { |
| 38 | uint32_t number; |
| 39 | |
| 40 | assert(lnx < qemu_input_map_linux_to_qnum_len); |
| 41 | number = qemu_input_map_linux_to_qnum[lnx]; |
| 42 | assert(number != 0); |
| 43 | return number; |
| 44 | } |
| 45 | |
| 46 | static void print_sym(xkb_keysym_t sym, uint32_t lnx, const char *mod) |
| 47 | { |
| 48 | char name[64]; |
| 49 | |
| 50 | if (sym == XKB_KEY_NoSymbol) { |
| 51 | return; |
| 52 | } |
| 53 | xkb_keysym_get_name(sym, name, sizeof(name)); |
| 54 | |
| 55 | /* TODO: make ui/keymap.c parser accept QKeyCode names */ |
| 56 | fprintf(outfile, "%s 0x%02x%s\n", name, linux_to_number(lnx), mod); |
| 57 | } |
| 58 | |
| 59 | static void walk_map(struct xkb_keymap *map, xkb_keycode_t code, void *data) |
| 60 | { |
| 61 | struct xkb_state *state = data; |
| 62 | xkb_keysym_t kbase, knumlock, kshift, kaltgr, kaltgrshift; |
| 63 | uint32_t evdev, qcode; |
| 64 | char name[64]; |
| 65 | |
| 66 | fprintf(outfile, "\n"); |
| 67 | |
| 68 | /* |
| 69 | * map xkb keycode -> QKeyCode |
| 70 | * |
| 71 | * xkb keycode is linux evdev shifted by 8 |
| 72 | */ |
| 73 | evdev = code - 8; |
| 74 | qcode = qemu_input_linux_to_qcode(evdev); |
| 75 | if (qcode == Q_KEY_CODE_UNMAPPED) { |
| 76 | xkb_state_update_mask(state, 0, 0, 0, 0, 0, 0); |
| 77 | kbase = xkb_state_key_get_one_sym(state, code); |
| 78 | xkb_keysym_get_name(kbase, name, sizeof(name)); |
| 79 | fprintf(outfile, "# evdev %d (0x%x): no evdev -> QKeyCode mapping" |
| 80 | " (xkb keysym %s)\n", evdev, evdev, name); |
| 81 | return; |
| 82 | } |
| 83 | fprintf(outfile, "# evdev %d (0x%x), QKeyCode \"%s\", number 0x%x\n", |
| 84 | evdev, evdev, |
| 85 | QKeyCode_str(qcode), |
| 86 | linux_to_number(evdev)); |
| 87 | |
| 88 | /* |
| 89 | * check which modifier states generate which keysyms |
| 90 | */ |
| 91 | xkb_state_update_mask(state, 0, 0, 0, 0, 0, 0); |
| 92 | kbase = xkb_state_key_get_one_sym(state, code); |
| 93 | print_sym(kbase, evdev, ""); |
| 94 | |
| 95 | xkb_state_update_mask(state, 0, 0, numlock, 0, 0, 0); |
| 96 | knumlock = xkb_state_key_get_one_sym(state, code); |
| 97 | if (kbase != knumlock) { |
| 98 | print_sym(knumlock, evdev, " numlock"); |
| 99 | } |
| 100 | |
| 101 | xkb_state_update_mask(state, shift, 0, 0, 0, 0, 0); |
| 102 | kshift = xkb_state_key_get_one_sym(state, code); |
| 103 | if (kbase != kshift && knumlock != kshift) { |
| 104 | print_sym(kshift, evdev, " shift"); |
| 105 | } |
| 106 | |
| 107 | xkb_state_update_mask(state, altgr, 0, 0, 0, 0, 0); |
| 108 | kaltgr = xkb_state_key_get_one_sym(state, code); |
| 109 | if (kbase != kaltgr) { |
| 110 | print_sym(kaltgr, evdev, " altgr"); |
| 111 | } |
| 112 | |
| 113 | xkb_state_update_mask(state, altgr | shift, 0, 0, 0, 0, 0); |
| 114 | kaltgrshift = xkb_state_key_get_one_sym(state, code); |
| 115 | if (kshift != kaltgrshift && kaltgr != kaltgrshift) { |
| 116 | print_sym(kaltgrshift, evdev, " shift altgr"); |
| 117 | } |
| 118 | } |
| 119 | |
| 120 | static void usage(FILE *out) |
| 121 | { |
| 122 | fprintf(out, |
| 123 | "\n" |
| 124 | "This tool generates qemu reverse keymaps from xkb keymaps,\n" |
| 125 | "which can be used with the qemu \"-k\" command line switch.\n" |
| 126 | "\n" |
| 127 | "usage: qemu-keymap <options>\n" |
| 128 | "options:\n" |
| 129 | " -h print this text\n" |
| 130 | " -f <file> set output file (default: stdout)\n" |
| 131 | " -m <model> set kbd model (default: %s)\n" |
| 132 | " -l <layout> set kbd layout (default: %s)\n" |
| 133 | " -v <variant> set kbd variant (default: %s)\n" |
| 134 | " -o <options> set kbd options (default: %s)\n" |
| 135 | "\n", |
| 136 | names.model, names.layout, |
| 137 | names.variant ?: "-", |
| 138 | names.options ?: "-"); |
| 139 | } |
| 140 | |
| 141 | static xkb_mod_mask_t get_mod(struct xkb_keymap *map, const char *name) |
| 142 | { |
| 143 | xkb_mod_index_t mod; |
| 144 | xkb_mod_mask_t mask = 0; |
| 145 | |
| 146 | mod = xkb_keymap_mod_get_index(map, name); |
| 147 | if (mod != XKB_MOD_INVALID) { |
| 148 | mask = (1 << mod); |
| 149 | } |
| 150 | return mask; |
| 151 | } |
| 152 | |
| 153 | int main(int argc, char *argv[]) |
| 154 | { |
| 155 | struct xkb_context *ctx; |
| 156 | struct xkb_keymap *map; |
| 157 | struct xkb_state *state; |
| 158 | xkb_mod_index_t mod, mods; |
| 159 | int rc; |
| 160 | |
| 161 | for (;;) { |
| 162 | rc = getopt(argc, argv, "hm:l:v:o:f:"); |
| 163 | if (rc == -1) { |
| 164 | break; |
| 165 | } |
| 166 | switch (rc) { |
| 167 | case 'm': |
| 168 | names.model = optarg; |
| 169 | break; |
| 170 | case 'l': |
| 171 | names.layout = optarg; |
| 172 | break; |
| 173 | case 'v': |
| 174 | names.variant = optarg; |
| 175 | break; |
| 176 | case 'o': |
| 177 | names.options = optarg; |
| 178 | break; |
| 179 | case 'f': |
| 180 | outfile = fopen(optarg, "w"); |
| 181 | if (outfile == NULL) { |
| 182 | fprintf(stderr, "open %s: %s\n", optarg, strerror(errno)); |
| 183 | exit(1); |
| 184 | } |
| 185 | break; |
| 186 | case 'h': |
| 187 | usage(stdout); |
| 188 | exit(0); |
| 189 | default: |
| 190 | usage(stderr); |
| 191 | exit(1); |
| 192 | } |
| 193 | } |
| 194 | |
| 195 | if (outfile == NULL) { |
| 196 | outfile = stdout; |
| 197 | } |
| 198 | |
| 199 | fprintf(outfile, |
| 200 | "# SPDX-License-Identifier: GPL-2.0-or-later\n" |
| 201 | "#\n" |
| 202 | "# generated by qemu-keymap\n" |
| 203 | "# model : %s\n" |
| 204 | "# layout : %s\n" |
| 205 | "# variant : %s\n" |
| 206 | "# options : %s\n" |
| 207 | "\n", |
| 208 | names.model, names.layout, |
| 209 | names.variant ?: "-", |
| 210 | names.options ?: "-"); |
| 211 | |
| 212 | ctx = xkb_context_new(XKB_CONTEXT_NO_FLAGS); |
| 213 | map = xkb_keymap_new_from_names(ctx, &names, XKB_KEYMAP_COMPILE_NO_FLAGS); |
| 214 | xkb_context_unref(ctx); |
| 215 | if (!map) { |
| 216 | /* libxkbcommon prints error */ |
| 217 | exit(1); |
| 218 | } |
| 219 | |
| 220 | fprintf(outfile, "# name: \"%s\"\n\n", |
| 221 | xkb_keymap_layout_get_name(map, 0)); |
| 222 | fprintf(outfile, "# modifiers\n"); |
| 223 | mods = xkb_keymap_num_mods(map); |
| 224 | for (mod = 0; mod < mods; mod++) { |
| 225 | fprintf(outfile, "# %2d: %s\n", |
| 226 | mod, xkb_keymap_mod_get_name(map, mod)); |
| 227 | } |
| 228 | |
| 229 | shift = get_mod(map, "Shift"); |
| 230 | ctrl = get_mod(map, "Control"); |
| 231 | altgr = get_mod(map, "AltGr"); |
| 232 | if (!altgr) { |
| 233 | altgr = get_mod(map, "Mod5"); |
| 234 | } |
| 235 | numlock = get_mod(map, "NumLock"); |
| 236 | |
| 237 | state = xkb_state_new(map); |
| 238 | xkb_keymap_key_for_each(map, walk_map, state); |
| 239 | xkb_state_unref(state); |
| 240 | xkb_keymap_unref(map); |
| 241 | |
| 242 | /* add quirks */ |
| 243 | fprintf(outfile, |
| 244 | "\n" |
| 245 | "#\n" |
| 246 | "# quirks section start\n" |
| 247 | "#\n" |
| 248 | "# Sometimes multiple keysyms map to the same keycodes.\n" |
| 249 | "# The keycode -> keysym lookup finds only one of the\n" |
| 250 | "# keysyms. So append them here.\n" |
| 251 | "#\n" |
| 252 | "\n"); |
| 253 | print_sym(XKB_KEY_Print, KEY_SYSRQ, ""); |
| 254 | print_sym(XKB_KEY_Sys_Req, KEY_SYSRQ, ""); |
| 255 | print_sym(XKB_KEY_Execute, KEY_SYSRQ, ""); |
| 256 | |
| 257 | print_sym(XKB_KEY_KP_Decimal, KEY_KPDOT, " numlock"); |
| 258 | print_sym(XKB_KEY_KP_Separator, KEY_KPDOT, " numlock"); |
| 259 | |
| 260 | print_sym(XKB_KEY_Alt_R, KEY_RIGHTALT, ""); |
| 261 | print_sym(XKB_KEY_ISO_Level3_Shift, KEY_RIGHTALT, ""); |
| 262 | print_sym(XKB_KEY_Mode_switch, KEY_RIGHTALT, ""); |
| 263 | |
| 264 | fprintf(outfile, |
| 265 | "\n" |
| 266 | "# quirks section end\n"); |
| 267 | |
| 268 | exit(0); |
| 269 | } |