2 * Copyright © 2012 Ran Benita <ran234@gmail.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
42 #include <linux/input.h>
44 #include "xkbcommon/xkbcommon.h"
46 #include "tools-common.h"
51 struct xkb_state *state;
52 struct xkb_compose_state *compose_state;
53 struct keyboard *next;
56 static bool terminate;
57 static int evdev_offset = 8;
58 static bool report_state_changes;
59 static bool with_compose;
60 static enum xkb_consumed_mode consumed_mode = XKB_CONSUMED_MODE_XKB;
62 #ifdef ENABLE_PRIVATE_APIS
63 #define DEFAULT_PRINT_FIELDS (PRINT_ALL_FIELDS & ~PRINT_MODMAPS)
65 #define DEFAULT_PRINT_FIELDS PRINT_ALL_FIELDS
67 print_state_fields_mask_t print_fields = DEFAULT_PRINT_FIELDS;
69 #define DEFAULT_INCLUDE_PATH_PLACEHOLDER "__defaults__"
70 #define NLONGS(n) (((n) + LONG_BIT - 1) / LONG_BIT)
73 evdev_bit_is_set(const unsigned long *array, int bit)
75 return array[bit / LONG_BIT] & (1LL << (bit % LONG_BIT));
78 /* Some heuristics to see if the device is a keyboard. */
83 unsigned long evbits[NLONGS(EV_CNT)] = { 0 };
84 unsigned long keybits[NLONGS(KEY_CNT)] = { 0 };
87 ioctl(fd, EVIOCGBIT(0, sizeof(evbits)), evbits);
91 if (!evdev_bit_is_set(evbits, EV_KEY))
95 ioctl(fd, EVIOCGBIT(EV_KEY, sizeof(keybits)), keybits);
99 for (i = KEY_RESERVED; i <= KEY_MIN_INTERESTING; i++)
100 if (evdev_bit_is_set(keybits, i))
107 keyboard_new(struct dirent *ent, struct xkb_keymap *keymap,
108 struct xkb_compose_table *compose_table, struct keyboard **out)
113 struct xkb_state *state;
114 struct xkb_compose_state *compose_state = NULL;
115 struct keyboard *kbd;
117 ret = asprintf(&path, "/dev/input/%s", ent->d_name);
121 fd = open(path, O_NONBLOCK | O_CLOEXEC | O_RDONLY);
127 if (!is_keyboard(fd)) {
128 /* Dummy "skip this device" value. */
133 state = xkb_state_new(keymap);
135 fprintf(stderr, "Couldn't create xkb state for %s\n", path);
141 compose_state = xkb_compose_state_new(compose_table,
142 XKB_COMPOSE_STATE_NO_FLAGS);
143 if (!compose_state) {
144 fprintf(stderr, "Couldn't create compose state for %s\n", path);
150 kbd = calloc(1, sizeof(*kbd));
153 goto err_compose_state;
159 kbd->compose_state = compose_state;
164 xkb_compose_state_unref(compose_state);
166 xkb_state_unref(state);
175 keyboard_free(struct keyboard *kbd)
182 xkb_state_unref(kbd->state);
183 xkb_compose_state_unref(kbd->compose_state);
188 filter_device_name(const struct dirent *ent)
190 return !fnmatch("event*", ent->d_name, 0);
193 static struct keyboard *
194 get_keyboards(struct xkb_keymap *keymap,
195 struct xkb_compose_table *compose_table)
198 struct dirent **ents;
199 struct keyboard *kbds = NULL, *kbd = NULL;
201 nents = scandir("/dev/input", &ents, filter_device_name, alphasort);
203 fprintf(stderr, "Couldn't scan /dev/input: %s\n", strerror(errno));
207 for (i = 0; i < nents; i++) {
208 ret = keyboard_new(ents[i], keymap, compose_table, &kbd);
210 if (ret == -EACCES) {
211 fprintf(stderr, "Couldn't open /dev/input/%s: %s. "
212 "You probably need root to run this.\n",
213 ents[i]->d_name, strerror(-ret));
216 if (ret != -ENOTSUP) {
217 fprintf(stderr, "Couldn't open /dev/input/%s: %s. Skipping.\n",
218 ents[i]->d_name, strerror(-ret));
229 fprintf(stderr, "Couldn't find any keyboards I can use! Quitting.\n");
234 for (i = 0; i < nents; i++)
241 free_keyboards(struct keyboard *kbds)
243 struct keyboard *next;
252 /* The meaning of the input_event 'value' field. */
254 KEY_STATE_RELEASE = 0,
256 KEY_STATE_REPEAT = 2,
260 process_event(struct keyboard *kbd, uint16_t type, uint16_t code, int32_t value)
262 xkb_keycode_t keycode;
263 struct xkb_keymap *keymap;
264 enum xkb_state_component changed;
265 enum xkb_compose_status status;
270 keycode = evdev_offset + code;
271 keymap = xkb_state_get_keymap(kbd->state);
273 if (value == KEY_STATE_REPEAT && !xkb_keymap_key_repeats(keymap, keycode))
276 if (with_compose && value != KEY_STATE_RELEASE) {
277 xkb_keysym_t keysym = xkb_state_key_get_one_sym(kbd->state, keycode);
278 xkb_compose_state_feed(kbd->compose_state, keysym);
281 if (value != KEY_STATE_RELEASE) {
282 tools_print_keycode_state(
283 kbd->state, kbd->compose_state, keycode,
284 consumed_mode, print_fields
289 status = xkb_compose_state_get_status(kbd->compose_state);
290 if (status == XKB_COMPOSE_CANCELLED || status == XKB_COMPOSE_COMPOSED)
291 xkb_compose_state_reset(kbd->compose_state);
294 if (value == KEY_STATE_RELEASE)
295 changed = xkb_state_update_key(kbd->state, keycode, XKB_KEY_UP);
297 changed = xkb_state_update_key(kbd->state, keycode, XKB_KEY_DOWN);
299 if (report_state_changes)
300 tools_print_state_changes(changed);
304 read_keyboard(struct keyboard *kbd)
307 struct input_event evs[16];
309 /* No fancy error checking here. */
310 while ((len = read(kbd->fd, &evs, sizeof(evs))) > 0) {
311 const size_t nevs = len / sizeof(struct input_event);
312 for (size_t i = 0; i < nevs; i++)
313 process_event(kbd, evs[i].type, evs[i].code, evs[i].value);
316 if (len < 0 && errno != EWOULDBLOCK) {
317 fprintf(stderr, "Couldn't read %s: %s\n", kbd->path, strerror(errno));
325 loop(struct keyboard *kbds)
328 struct keyboard *kbd;
330 struct pollfd *fds = NULL;
332 for (kbd = kbds, nfds = 0; kbd; kbd = kbd->next, nfds++) {}
333 fds = calloc(nfds, sizeof(*fds));
335 fprintf(stderr, "Out of memory");
339 for (i = 0, kbd = kbds; kbd; kbd = kbd->next, i++) {
341 fds[i].events = POLLIN;
345 ret = poll(fds, nfds, -1);
349 fprintf(stderr, "Couldn't poll for events: %s\n",
354 for (i = 0, kbd = kbds; kbd; kbd = kbd->next, i++) {
355 if (fds[i].revents != 0) {
356 ret = read_keyboard(kbd);
371 sigintr_handler(int signum)
377 usage(FILE *fp, char *progname)
379 fprintf(fp, "Usage: %s [--include=<path>] [--include-defaults] "
380 "[--rules=<rules>] [--model=<model>] [--layout=<layout>] "
381 "[--variant=<variant>] [--options=<options>]\n",
383 fprintf(fp, " or: %s --keymap <path to keymap file>\n",
385 fprintf(fp, "For both:\n"
386 #ifdef ENABLE_PRIVATE_APIS
387 " --print-modmaps (print real & virtual key modmaps)\n"
389 " --short (do not print layout nor Unicode keysym translation)\n"
390 " --report-state-changes (report changes to the state)\n"
391 " --enable-compose (enable Compose)\n"
392 " --consumed-mode={xkb|gtk} (select the consumed modifiers mode, default: xkb)\n"
393 " --without-x11-offset (don't add X11 keycode offset)\n"
398 main(int argc, char *argv[])
400 int ret = EXIT_FAILURE;
401 struct keyboard *kbds;
402 struct xkb_context *ctx = NULL;
403 struct xkb_keymap *keymap = NULL;
404 struct xkb_compose_table *compose_table = NULL;
405 const char *includes[64];
406 size_t num_includes = 0;
407 const char *rules = NULL;
408 const char *model = NULL;
409 const char *layout = NULL;
410 const char *variant = NULL;
411 const char *options = NULL;
412 const char *keymap_path = NULL;
414 struct sigaction act;
417 OPT_INCLUDE_DEFAULTS,
424 OPT_WITHOUT_X11_OFFSET,
429 #ifdef ENABLE_PRIVATE_APIS
433 static struct option opts[] = {
434 {"help", no_argument, 0, 'h'},
435 {"include", required_argument, 0, OPT_INCLUDE},
436 {"include-defaults", no_argument, 0, OPT_INCLUDE_DEFAULTS},
437 {"rules", required_argument, 0, OPT_RULES},
438 {"model", required_argument, 0, OPT_MODEL},
439 {"layout", required_argument, 0, OPT_LAYOUT},
440 {"variant", required_argument, 0, OPT_VARIANT},
441 {"options", required_argument, 0, OPT_OPTION},
442 {"keymap", required_argument, 0, OPT_KEYMAP},
443 {"consumed-mode", required_argument, 0, OPT_CONSUMED_MODE},
444 {"enable-compose", no_argument, 0, OPT_COMPOSE},
445 {"short", no_argument, 0, OPT_SHORT},
446 {"report-state-changes", no_argument, 0, OPT_REPORT_STATE},
447 {"without-x11-offset", no_argument, 0, OPT_WITHOUT_X11_OFFSET},
448 #ifdef ENABLE_PRIVATE_APIS
449 {"print-modmaps", no_argument, 0, OPT_PRINT_MODMAPS},
454 setlocale(LC_ALL, "");
458 int option_index = 0;
460 opt = getopt_long(argc, argv, "h", opts, &option_index);
466 if (num_includes >= ARRAY_SIZE(includes)) {
467 fprintf(stderr, "error: too many includes\n");
468 exit(EXIT_INVALID_USAGE);
470 includes[num_includes++] = optarg;
472 case OPT_INCLUDE_DEFAULTS:
473 if (num_includes >= ARRAY_SIZE(includes)) {
474 fprintf(stderr, "error: too many includes\n");
475 exit(EXIT_INVALID_USAGE);
477 includes[num_includes++] = DEFAULT_INCLUDE_PATH_PLACEHOLDER;
495 keymap_path = optarg;
497 case OPT_WITHOUT_X11_OFFSET:
500 case OPT_REPORT_STATE:
501 report_state_changes = true;
507 print_fields &= ~PRINT_VERBOSE_FIELDS;
509 case OPT_CONSUMED_MODE:
510 if (strcmp(optarg, "gtk") == 0) {
511 consumed_mode = XKB_CONSUMED_MODE_GTK;
512 } else if (strcmp(optarg, "xkb") == 0) {
513 consumed_mode = XKB_CONSUMED_MODE_XKB;
515 fprintf(stderr, "error: invalid --consumed-mode \"%s\"\n", optarg);
516 usage(stderr, argv[0]);
517 return EXIT_INVALID_USAGE;
520 #ifdef ENABLE_PRIVATE_APIS
521 case OPT_PRINT_MODMAPS:
522 print_fields |= PRINT_MODMAPS;
526 usage(stdout, argv[0]);
529 usage(stderr, argv[0]);
530 return EXIT_INVALID_USAGE;
534 ctx = xkb_context_new(XKB_CONTEXT_NO_DEFAULT_INCLUDES);
536 fprintf(stderr, "Couldn't create xkb context\n");
540 if (num_includes == 0)
541 includes[num_includes++] = DEFAULT_INCLUDE_PATH_PLACEHOLDER;
543 for (size_t i = 0; i < num_includes; i++) {
544 const char *include = includes[i];
545 if (strcmp(include, DEFAULT_INCLUDE_PATH_PLACEHOLDER) == 0)
546 xkb_context_include_path_append_default(ctx);
548 xkb_context_include_path_append(ctx, include);
552 FILE *file = fopen(keymap_path, "rb");
554 fprintf(stderr, "Couldn't open '%s': %s\n",
555 keymap_path, strerror(errno));
558 keymap = xkb_keymap_new_from_file(ctx, file,
559 XKB_KEYMAP_FORMAT_TEXT_V1,
560 XKB_KEYMAP_COMPILE_NO_FLAGS);
564 struct xkb_rule_names rmlvo = {
565 .rules = (rules == NULL || rules[0] == '\0') ? NULL : rules,
566 .model = (model == NULL || model[0] == '\0') ? NULL : model,
567 .layout = (layout == NULL || layout[0] == '\0') ? NULL : layout,
568 .variant = (variant == NULL || variant[0] == '\0') ? NULL : variant,
569 .options = (options == NULL || options[0] == '\0') ? NULL : options
572 if (!rules && !model && !layout && !variant && !options)
573 keymap = xkb_keymap_new_from_names(ctx, NULL, 0);
575 keymap = xkb_keymap_new_from_names(ctx, &rmlvo, 0);
579 "Failed to compile RMLVO: '%s', '%s', '%s', '%s', '%s'\n",
580 rules, model, layout, variant, options);
586 fprintf(stderr, "Couldn't create xkb keymap\n");
591 locale = setlocale(LC_CTYPE, NULL);
593 xkb_compose_table_new_from_locale(ctx, locale,
594 XKB_COMPOSE_COMPILE_NO_FLAGS);
595 if (!compose_table) {
596 fprintf(stderr, "Couldn't create compose from locale\n");
601 kbds = get_keyboards(keymap, compose_table);
606 #ifdef ENABLE_PRIVATE_APIS
607 if (print_fields & PRINT_MODMAPS) {
608 print_keys_modmaps(keymap);
610 print_keymap_modmaps(keymap);
615 act.sa_handler = sigintr_handler;
616 sigemptyset(&act.sa_mask);
618 sigaction(SIGINT, &act, NULL);
619 sigaction(SIGTERM, &act, NULL);
621 tools_disable_stdin_echo();
623 tools_enable_stdin_echo();
625 free_keyboards(kbds);
627 xkb_compose_table_unref(compose_table);
628 xkb_keymap_unref(keymap);
629 xkb_context_unref(ctx);