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 #define DEFAULT_INCLUDE_PATH_PLACEHOLDER "__defaults__"
63 #define NLONGS(n) (((n) + LONG_BIT - 1) / LONG_BIT)
66 evdev_bit_is_set(const unsigned long *array, int bit)
68 return array[bit / LONG_BIT] & (1LL << (bit % LONG_BIT));
71 /* Some heuristics to see if the device is a keyboard. */
76 unsigned long evbits[NLONGS(EV_CNT)] = { 0 };
77 unsigned long keybits[NLONGS(KEY_CNT)] = { 0 };
80 ioctl(fd, EVIOCGBIT(0, sizeof(evbits)), evbits);
84 if (!evdev_bit_is_set(evbits, EV_KEY))
88 ioctl(fd, EVIOCGBIT(EV_KEY, sizeof(keybits)), keybits);
92 for (i = KEY_RESERVED; i <= KEY_MIN_INTERESTING; i++)
93 if (evdev_bit_is_set(keybits, i))
100 keyboard_new(struct dirent *ent, struct xkb_keymap *keymap,
101 struct xkb_compose_table *compose_table, struct keyboard **out)
106 struct xkb_state *state;
107 struct xkb_compose_state *compose_state = NULL;
108 struct keyboard *kbd;
110 ret = asprintf(&path, "/dev/input/%s", ent->d_name);
114 fd = open(path, O_NONBLOCK | O_CLOEXEC | O_RDONLY);
120 if (!is_keyboard(fd)) {
121 /* Dummy "skip this device" value. */
126 state = xkb_state_new(keymap);
128 fprintf(stderr, "Couldn't create xkb state for %s\n", path);
134 compose_state = xkb_compose_state_new(compose_table,
135 XKB_COMPOSE_STATE_NO_FLAGS);
136 if (!compose_state) {
137 fprintf(stderr, "Couldn't create compose state for %s\n", path);
143 kbd = calloc(1, sizeof(*kbd));
146 goto err_compose_state;
152 kbd->compose_state = compose_state;
157 xkb_compose_state_unref(compose_state);
159 xkb_state_unref(state);
168 keyboard_free(struct keyboard *kbd)
175 xkb_state_unref(kbd->state);
176 xkb_compose_state_unref(kbd->compose_state);
181 filter_device_name(const struct dirent *ent)
183 return !fnmatch("event*", ent->d_name, 0);
186 static struct keyboard *
187 get_keyboards(struct xkb_keymap *keymap,
188 struct xkb_compose_table *compose_table)
191 struct dirent **ents;
192 struct keyboard *kbds = NULL, *kbd = NULL;
194 nents = scandir("/dev/input", &ents, filter_device_name, alphasort);
196 fprintf(stderr, "Couldn't scan /dev/input: %s\n", strerror(errno));
200 for (i = 0; i < nents; i++) {
201 ret = keyboard_new(ents[i], keymap, compose_table, &kbd);
203 if (ret == -EACCES) {
204 fprintf(stderr, "Couldn't open /dev/input/%s: %s. "
205 "You probably need root to run this.\n",
206 ents[i]->d_name, strerror(-ret));
209 if (ret != -ENOTSUP) {
210 fprintf(stderr, "Couldn't open /dev/input/%s: %s. Skipping.\n",
211 ents[i]->d_name, strerror(-ret));
222 fprintf(stderr, "Couldn't find any keyboards I can use! Quitting.\n");
227 for (i = 0; i < nents; i++)
234 free_keyboards(struct keyboard *kbds)
236 struct keyboard *next;
245 /* The meaning of the input_event 'value' field. */
247 KEY_STATE_RELEASE = 0,
249 KEY_STATE_REPEAT = 2,
253 process_event(struct keyboard *kbd, uint16_t type, uint16_t code, int32_t value)
255 xkb_keycode_t keycode;
256 struct xkb_keymap *keymap;
257 enum xkb_state_component changed;
258 enum xkb_compose_status status;
263 keycode = evdev_offset + code;
264 keymap = xkb_state_get_keymap(kbd->state);
266 if (value == KEY_STATE_REPEAT && !xkb_keymap_key_repeats(keymap, keycode))
269 if (with_compose && value != KEY_STATE_RELEASE) {
270 xkb_keysym_t keysym = xkb_state_key_get_one_sym(kbd->state, keycode);
271 xkb_compose_state_feed(kbd->compose_state, keysym);
274 if (value != KEY_STATE_RELEASE)
275 tools_print_keycode_state(kbd->state, kbd->compose_state, keycode,
279 status = xkb_compose_state_get_status(kbd->compose_state);
280 if (status == XKB_COMPOSE_CANCELLED || status == XKB_COMPOSE_COMPOSED)
281 xkb_compose_state_reset(kbd->compose_state);
284 if (value == KEY_STATE_RELEASE)
285 changed = xkb_state_update_key(kbd->state, keycode, XKB_KEY_UP);
287 changed = xkb_state_update_key(kbd->state, keycode, XKB_KEY_DOWN);
289 if (report_state_changes)
290 tools_print_state_changes(changed);
294 read_keyboard(struct keyboard *kbd)
297 struct input_event evs[16];
299 /* No fancy error checking here. */
300 while ((len = read(kbd->fd, &evs, sizeof(evs))) > 0) {
301 const size_t nevs = len / sizeof(struct input_event);
302 for (size_t i = 0; i < nevs; i++)
303 process_event(kbd, evs[i].type, evs[i].code, evs[i].value);
306 if (len < 0 && errno != EWOULDBLOCK) {
307 fprintf(stderr, "Couldn't read %s: %s\n", kbd->path, strerror(errno));
315 loop(struct keyboard *kbds)
318 struct keyboard *kbd;
320 struct pollfd *fds = NULL;
322 for (kbd = kbds, nfds = 0; kbd; kbd = kbd->next, nfds++) {}
323 fds = calloc(nfds, sizeof(*fds));
325 fprintf(stderr, "Out of memory");
329 for (i = 0, kbd = kbds; kbd; kbd = kbd->next, i++) {
331 fds[i].events = POLLIN;
335 ret = poll(fds, nfds, -1);
339 fprintf(stderr, "Couldn't poll for events: %s\n",
344 for (i = 0, kbd = kbds; kbd; kbd = kbd->next, i++) {
345 if (fds[i].revents != 0) {
346 ret = read_keyboard(kbd);
361 sigintr_handler(int signum)
367 usage(FILE *fp, char *progname)
369 fprintf(fp, "Usage: %s [--include=<path>] [--include-defaults] "
370 "[--rules=<rules>] [--model=<model>] [--layout=<layout>] "
371 "[--variant=<variant>] [--options=<options>]\n",
373 fprintf(fp, " or: %s --keymap <path to keymap file>\n",
375 fprintf(fp, "For both:\n"
376 " --report-state-changes (report changes to the state)\n"
377 " --enable-compose (enable Compose)\n"
378 " --consumed-mode={xkb|gtk} (select the consumed modifiers mode, default: xkb)\n"
379 " --without-x11-offset (don't add X11 keycode offset)\n"
384 main(int argc, char *argv[])
386 int ret = EXIT_FAILURE;
387 struct keyboard *kbds;
388 struct xkb_context *ctx = NULL;
389 struct xkb_keymap *keymap = NULL;
390 struct xkb_compose_table *compose_table = NULL;
391 const char *includes[64];
392 size_t num_includes = 0;
393 const char *rules = NULL;
394 const char *model = NULL;
395 const char *layout = NULL;
396 const char *variant = NULL;
397 const char *options = NULL;
398 const char *keymap_path = NULL;
400 struct sigaction act;
403 OPT_INCLUDE_DEFAULTS,
410 OPT_WITHOUT_X11_OFFSET,
415 static struct option opts[] = {
416 {"help", no_argument, 0, 'h'},
417 {"include", required_argument, 0, OPT_INCLUDE},
418 {"include-defaults", no_argument, 0, OPT_INCLUDE_DEFAULTS},
419 {"rules", required_argument, 0, OPT_RULES},
420 {"model", required_argument, 0, OPT_MODEL},
421 {"layout", required_argument, 0, OPT_LAYOUT},
422 {"variant", required_argument, 0, OPT_VARIANT},
423 {"options", required_argument, 0, OPT_OPTION},
424 {"keymap", required_argument, 0, OPT_KEYMAP},
425 {"consumed-mode", required_argument, 0, OPT_CONSUMED_MODE},
426 {"enable-compose", no_argument, 0, OPT_COMPOSE},
427 {"report-state-changes", no_argument, 0, OPT_REPORT_STATE},
428 {"without-x11-offset", no_argument, 0, OPT_WITHOUT_X11_OFFSET},
432 setlocale(LC_ALL, "");
436 int option_index = 0;
438 opt = getopt_long(argc, argv, "h", opts, &option_index);
444 if (num_includes >= ARRAY_SIZE(includes)) {
445 fprintf(stderr, "error: too many includes\n");
446 exit(EXIT_INVALID_USAGE);
448 includes[num_includes++] = optarg;
450 case OPT_INCLUDE_DEFAULTS:
451 if (num_includes >= ARRAY_SIZE(includes)) {
452 fprintf(stderr, "error: too many includes\n");
453 exit(EXIT_INVALID_USAGE);
455 includes[num_includes++] = DEFAULT_INCLUDE_PATH_PLACEHOLDER;
473 keymap_path = optarg;
475 case OPT_WITHOUT_X11_OFFSET:
478 case OPT_REPORT_STATE:
479 report_state_changes = true;
484 case OPT_CONSUMED_MODE:
485 if (strcmp(optarg, "gtk") == 0) {
486 consumed_mode = XKB_CONSUMED_MODE_GTK;
487 } else if (strcmp(optarg, "xkb") == 0) {
488 consumed_mode = XKB_CONSUMED_MODE_XKB;
490 fprintf(stderr, "error: invalid --consumed-mode \"%s\"\n", optarg);
491 usage(stderr, argv[0]);
492 return EXIT_INVALID_USAGE;
496 usage(stdout, argv[0]);
499 usage(stderr, argv[0]);
500 return EXIT_INVALID_USAGE;
504 ctx = xkb_context_new(XKB_CONTEXT_NO_DEFAULT_INCLUDES);
506 fprintf(stderr, "Couldn't create xkb context\n");
510 if (num_includes == 0)
511 includes[num_includes++] = DEFAULT_INCLUDE_PATH_PLACEHOLDER;
513 for (size_t i = 0; i < num_includes; i++) {
514 const char *include = includes[i];
515 if (strcmp(include, DEFAULT_INCLUDE_PATH_PLACEHOLDER) == 0)
516 xkb_context_include_path_append_default(ctx);
518 xkb_context_include_path_append(ctx, include);
522 FILE *file = fopen(keymap_path, "rb");
524 fprintf(stderr, "Couldn't open '%s': %s\n",
525 keymap_path, strerror(errno));
528 keymap = xkb_keymap_new_from_file(ctx, file,
529 XKB_KEYMAP_FORMAT_TEXT_V1,
530 XKB_KEYMAP_COMPILE_NO_FLAGS);
534 struct xkb_rule_names rmlvo = {
535 .rules = (rules == NULL || rules[0] == '\0') ? NULL : rules,
536 .model = (model == NULL || model[0] == '\0') ? NULL : model,
537 .layout = (layout == NULL || layout[0] == '\0') ? NULL : layout,
538 .variant = (variant == NULL || variant[0] == '\0') ? NULL : variant,
539 .options = (options == NULL || options[0] == '\0') ? NULL : options
542 if (!rules && !model && !layout && !variant && !options)
543 keymap = xkb_keymap_new_from_names(ctx, NULL, 0);
545 keymap = xkb_keymap_new_from_names(ctx, &rmlvo, 0);
549 "Failed to compile RMLVO: '%s', '%s', '%s', '%s', '%s'\n",
550 rules, model, layout, variant, options);
556 fprintf(stderr, "Couldn't create xkb keymap\n");
561 locale = setlocale(LC_CTYPE, NULL);
563 xkb_compose_table_new_from_locale(ctx, locale,
564 XKB_COMPOSE_COMPILE_NO_FLAGS);
565 if (!compose_table) {
566 fprintf(stderr, "Couldn't create compose from locale\n");
571 kbds = get_keyboards(keymap, compose_table);
576 act.sa_handler = sigintr_handler;
577 sigemptyset(&act.sa_mask);
579 sigaction(SIGINT, &act, NULL);
580 sigaction(SIGTERM, &act, NULL);
582 tools_disable_stdin_echo();
584 tools_enable_stdin_echo();
586 free_keyboards(kbds);
588 xkb_compose_table_unref(compose_table);
589 xkb_keymap_unref(keymap);
590 xkb_context_unref(ctx);