tools/interactive-evdev.c

   1 /*
   2  * Copyright © 2012 Ran Benita <ran234@gmail.com>
   3  *
   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:
  10  *
  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
  13  * Software.
  14  *
  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.
  22  */
  23
  24 #include "config.h"
  25
  26 #include <assert.h>
  27 #include <dirent.h>
  28 #include <errno.h>
  29 #include <fcntl.h>
  30 #include <fnmatch.h>
  31 #include <getopt.h>
  32 #include <limits.h>
  33 #include <locale.h>
  34 #include <poll.h>
  35 #include <signal.h>
  36 #include <stdbool.h>
  37 #include <stdio.h>
  38 #include <stdlib.h>
  39 #include <string.h>
  40 #include <unistd.h>
  41
  42 #include <linux/input.h>
  43
  44 #include "xkbcommon/xkbcommon.h"
  45
  46 #include "tools-common.h"
  47
  48 struct keyboard {
  49     char *path;
  50     int fd;
  51     struct xkb_state *state;
  52     struct xkb_compose_state *compose_state;
  53     struct keyboard *next;
  54 };
  55
  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;
  61
  62 #define NLONGS(n) (((n) + LONG_BIT - 1) / LONG_BIT)
  63
  64 static bool
  65 evdev_bit_is_set(const unsigned long *array, int bit)
  66 {
  67     return array[bit / LONG_BIT] & (1LL << (bit % LONG_BIT));
  68 }
  69
  70 /* Some heuristics to see if the device is a keyboard. */
  71 static bool
  72 is_keyboard(int fd)
  73 {
  74     int i;
  75     unsigned long evbits[NLONGS(EV_CNT)] = { 0 };
  76     unsigned long keybits[NLONGS(KEY_CNT)] = { 0 };
  77
  78     errno = 0;
  79     ioctl(fd, EVIOCGBIT(0, sizeof(evbits)), evbits);
  80     if (errno)
  81         return false;
  82
  83     if (!evdev_bit_is_set(evbits, EV_KEY))
  84         return false;
  85
  86     errno = 0;
  87     ioctl(fd, EVIOCGBIT(EV_KEY, sizeof(keybits)), keybits);
  88     if (errno)
  89         return false;
  90
  91     for (i = KEY_RESERVED; i <= KEY_MIN_INTERESTING; i++)
  92         if (evdev_bit_is_set(keybits, i))
  93             return true;
  94
  95     return false;
  96 }
  97
  98 static int
  99 keyboard_new(struct dirent *ent, struct xkb_keymap *keymap,
 100              struct xkb_compose_table *compose_table, struct keyboard **out)
 101 {
 102     int ret;
 103     char *path;
 104     int fd;
 105     struct xkb_state *state;
 106     struct xkb_compose_state *compose_state = NULL;
 107     struct keyboard *kbd;
 108
 109     ret = asprintf(&path, "/dev/input/%s", ent->d_name);
 110     if (ret < 0)
 111         return -ENOMEM;
 112
 113     fd = open(path, O_NONBLOCK | O_CLOEXEC | O_RDONLY);
 114     if (fd < 0) {
 115         ret = -errno;
 116         goto err_path;
 117     }
 118
 119     if (!is_keyboard(fd)) {
 120         /* Dummy "skip this device" value. */
 121         ret = -ENOTSUP;
 122         goto err_fd;
 123     }
 124
 125     state = xkb_state_new(keymap);
 126     if (!state) {
 127         fprintf(stderr, "Couldn't create xkb state for %s\n", path);
 128         ret = -EFAULT;
 129         goto err_fd;
 130     }
 131
 132     if (with_compose) {
 133         compose_state = xkb_compose_state_new(compose_table,
 134                                               XKB_COMPOSE_STATE_NO_FLAGS);
 135         if (!compose_state) {
 136             fprintf(stderr, "Couldn't create compose state for %s\n", path);
 137             ret = -EFAULT;
 138             goto err_state;
 139         }
 140     }
 141
 142     kbd = calloc(1, sizeof(*kbd));
 143     if (!kbd) {
 144         ret = -ENOMEM;
 145         goto err_compose_state;
 146     }
 147
 148     kbd->path = path;
 149     kbd->fd = fd;
 150     kbd->state = state;
 151     kbd->compose_state = compose_state;
 152     *out = kbd;
 153     return 0;
 154
 155 err_compose_state:
 156     xkb_compose_state_unref(compose_state);
 157 err_state:
 158     xkb_state_unref(state);
 159 err_fd:
 160     close(fd);
 161 err_path:
 162     free(path);
 163     return ret;
 164 }
 165
 166 static void
 167 keyboard_free(struct keyboard *kbd)
 168 {
 169     if (!kbd)
 170         return;
 171     if (kbd->fd >= 0)
 172         close(kbd->fd);
 173     free(kbd->path);
 174     xkb_state_unref(kbd->state);
 175     xkb_compose_state_unref(kbd->compose_state);
 176     free(kbd);
 177 }
 178
 179 static int
 180 filter_device_name(const struct dirent *ent)
 181 {
 182     return !fnmatch("event*", ent->d_name, 0);
 183 }
 184
 185 static struct keyboard *
 186 get_keyboards(struct xkb_keymap *keymap,
 187               struct xkb_compose_table *compose_table)
 188 {
 189     int ret, i, nents;
 190     struct dirent **ents;
 191     struct keyboard *kbds = NULL, *kbd = NULL;
 192
 193     nents = scandir("/dev/input", &ents, filter_device_name, alphasort);
 194     if (nents < 0) {
 195         fprintf(stderr, "Couldn't scan /dev/input: %s\n", strerror(errno));
 196         return NULL;
 197     }
 198
 199     for (i = 0; i < nents; i++) {
 200         ret = keyboard_new(ents[i], keymap, compose_table, &kbd);
 201         if (ret) {
 202             if (ret == -EACCES) {
 203                 fprintf(stderr, "Couldn't open /dev/input/%s: %s. "
 204                                 "You probably need root to run this.\n",
 205                         ents[i]->d_name, strerror(-ret));
 206                 break;
 207             }
 208             if (ret != -ENOTSUP) {
 209                 fprintf(stderr, "Couldn't open /dev/input/%s: %s. Skipping.\n",
 210                         ents[i]->d_name, strerror(-ret));
 211             }
 212             continue;
 213         }
 214
 215         assert(kbd != NULL);
 216         kbd->next = kbds;
 217         kbds = kbd;
 218     }
 219
 220     if (!kbds) {
 221         fprintf(stderr, "Couldn't find any keyboards I can use! Quitting.\n");
 222         goto err;
 223     }
 224
 225 err:
 226     for (i = 0; i < nents; i++)
 227         free(ents[i]);
 228     free(ents);
 229     return kbds;
 230 }
 231
 232 static void
 233 free_keyboards(struct keyboard *kbds)
 234 {
 235     struct keyboard *next;
 236
 237     while (kbds) {
 238         next = kbds->next;
 239         keyboard_free(kbds);
 240         kbds = next;
 241     }
 242 }
 243
 244 /* The meaning of the input_event 'value' field. */
 245 enum {
 246     KEY_STATE_RELEASE = 0,
 247     KEY_STATE_PRESS = 1,
 248     KEY_STATE_REPEAT = 2,
 249 };
 250
 251 static void
 252 process_event(struct keyboard *kbd, uint16_t type, uint16_t code, int32_t value)
 253 {
 254     xkb_keycode_t keycode;
 255     struct xkb_keymap *keymap;
 256     enum xkb_state_component changed;
 257     enum xkb_compose_status status;
 258
 259     if (type != EV_KEY)
 260         return;
 261
 262     keycode = evdev_offset + code;
 263     keymap = xkb_state_get_keymap(kbd->state);
 264
 265     if (value == KEY_STATE_REPEAT && !xkb_keymap_key_repeats(keymap, keycode))
 266         return;
 267
 268     if (with_compose && value != KEY_STATE_RELEASE) {
 269         xkb_keysym_t keysym = xkb_state_key_get_one_sym(kbd->state, keycode);
 270         xkb_compose_state_feed(kbd->compose_state, keysym);
 271     }
 272
 273     if (value != KEY_STATE_RELEASE)
 274         tools_print_keycode_state(kbd->state, kbd->compose_state, keycode,
 275                                   consumed_mode);
 276
 277     if (with_compose) {
 278         status = xkb_compose_state_get_status(kbd->compose_state);
 279         if (status == XKB_COMPOSE_CANCELLED || status == XKB_COMPOSE_COMPOSED)
 280             xkb_compose_state_reset(kbd->compose_state);
 281     }
 282
 283     if (value == KEY_STATE_RELEASE)
 284         changed = xkb_state_update_key(kbd->state, keycode, XKB_KEY_UP);
 285     else
 286         changed = xkb_state_update_key(kbd->state, keycode, XKB_KEY_DOWN);
 287
 288     if (report_state_changes)
 289         tools_print_state_changes(changed);
 290 }
 291
 292 static int
 293 read_keyboard(struct keyboard *kbd)
 294 {
 295     ssize_t len;
 296     struct input_event evs[16];
 297
 298     /* No fancy error checking here. */
 299     while ((len = read(kbd->fd, &evs, sizeof(evs))) > 0) {
 300         const size_t nevs = len / sizeof(struct input_event);
 301         for (size_t i = 0; i < nevs; i++)
 302             process_event(kbd, evs[i].type, evs[i].code, evs[i].value);
 303     }
 304
 305     if (len < 0 && errno != EWOULDBLOCK) {
 306         fprintf(stderr, "Couldn't read %s: %s\n", kbd->path, strerror(errno));
 307         return 1;
 308     }
 309
 310     return 0;
 311 }
 312
 313 static int
 314 loop(struct keyboard *kbds)
 315 {
 316     int ret = -1;
 317     struct keyboard *kbd;
 318     nfds_t nfds, i;
 319     struct pollfd *fds = NULL;
 320
 321     for (kbd = kbds, nfds = 0; kbd; kbd = kbd->next, nfds++) {}
 322     fds = calloc(nfds, sizeof(*fds));
 323     if (fds == NULL) {
 324         fprintf(stderr, "Out of memory");
 325         goto out;
 326     }
 327
 328     for (i = 0, kbd = kbds; kbd; kbd = kbd->next, i++) {
 329         fds[i].fd = kbd->fd;
 330         fds[i].events = POLLIN;
 331     }
 332
 333     while (!terminate) {
 334         ret = poll(fds, nfds, -1);
 335         if (ret < 0) {
 336             if (errno == EINTR)
 337                 continue;
 338             fprintf(stderr, "Couldn't poll for events: %s\n",
 339                     strerror(errno));
 340             goto out;
 341         }
 342
 343         for (i = 0, kbd = kbds; kbd; kbd = kbd->next, i++) {
 344             if (fds[i].revents != 0) {
 345                 ret = read_keyboard(kbd);
 346                 if (ret) {
 347                     goto out;
 348                 }
 349             }
 350         }
 351     }
 352
 353     ret = 0;
 354 out:
 355     free(fds);
 356     return ret;
 357 }
 358
 359 static void
 360 sigintr_handler(int signum)
 361 {
 362     terminate = true;
 363 }
 364
 365 static void
 366 usage(FILE *fp, char *progname)
 367 {
 368         fprintf(fp, "Usage: %s [--rules=<rules>] [--model=<model>] "
 369                 "[--layout=<layout>] [--variant=<variant>] [--options=<options>]\n",
 370                 progname);
 371         fprintf(fp, "      or: %s --keymap <path to keymap file>\n",
 372                 progname);
 373         fprintf(fp, "For both:\n"
 374                         "          --report-state-changes (report changes to the state)\n"
 375                         "          --enable-compose (enable Compose)\n"
 376                         "          --consumed-mode={xkb|gtk} (select the consumed modifiers mode, default: xkb)\n"
 377                         "          --without-x11-offset (don't add X11 keycode offset)\n"
 378         );
 379 }
 380
 381 int
 382 main(int argc, char *argv[])
 383 {
 384     int ret = EXIT_FAILURE;
 385     struct keyboard *kbds;
 386     struct xkb_context *ctx = NULL;
 387     struct xkb_keymap *keymap = NULL;
 388     struct xkb_compose_table *compose_table = NULL;
 389     const char *rules = NULL;
 390     const char *model = NULL;
 391     const char *layout = NULL;
 392     const char *variant = NULL;
 393     const char *options = NULL;
 394     const char *keymap_path = NULL;
 395     const char *locale;
 396     struct sigaction act;
 397     enum options {
 398         OPT_RULES,
 399         OPT_MODEL,
 400         OPT_LAYOUT,
 401         OPT_VARIANT,
 402         OPT_OPTION,
 403         OPT_KEYMAP,
 404         OPT_WITHOUT_X11_OFFSET,
 405         OPT_CONSUMED_MODE,
 406         OPT_COMPOSE,
 407         OPT_REPORT_STATE,
 408     };
 409     static struct option opts[] = {
 410         {"help",                 no_argument,            0, 'h'},
 411         {"rules",                required_argument,      0, OPT_RULES},
 412         {"model",                required_argument,      0, OPT_MODEL},
 413         {"layout",               required_argument,      0, OPT_LAYOUT},
 414         {"variant",              required_argument,      0, OPT_VARIANT},
 415         {"options",              required_argument,      0, OPT_OPTION},
 416         {"keymap",               required_argument,      0, OPT_KEYMAP},
 417         {"consumed-mode",        required_argument,      0, OPT_CONSUMED_MODE},
 418         {"enable-compose",       no_argument,            0, OPT_COMPOSE},
 419         {"report-state-changes", no_argument,            0, OPT_REPORT_STATE},
 420         {"without-x11-offset",   no_argument,            0, OPT_WITHOUT_X11_OFFSET},
 421         {0, 0, 0, 0},
 422     };
 423
 424     setlocale(LC_ALL, "");
 425
 426     while (1) {
 427         int opt;
 428         int option_index = 0;
 429
 430         opt = getopt_long(argc, argv, "h", opts, &option_index);
 431         if (opt == -1)
 432             break;
 433
 434         switch (opt) {
 435         case OPT_RULES:
 436             rules = optarg;
 437             break;
 438         case OPT_MODEL:
 439             model = optarg;
 440             break;
 441         case OPT_LAYOUT:
 442             layout = optarg;
 443             break;
 444         case OPT_VARIANT:
 445             variant = optarg;
 446             break;
 447         case OPT_OPTION:
 448             options = optarg;
 449             break;
 450         case OPT_KEYMAP:
 451             keymap_path = optarg;
 452             break;
 453         case OPT_WITHOUT_X11_OFFSET:
 454             evdev_offset = 0;
 455             break;
 456         case OPT_REPORT_STATE:
 457             report_state_changes = true;
 458             break;
 459         case OPT_COMPOSE:
 460             with_compose = true;
 461             break;
 462         case OPT_CONSUMED_MODE:
 463             if (strcmp(optarg, "gtk") == 0) {
 464                 consumed_mode = XKB_CONSUMED_MODE_GTK;
 465             } else if (strcmp(optarg, "xkb") == 0) {
 466                 consumed_mode = XKB_CONSUMED_MODE_XKB;
 467             } else {
 468                 fprintf(stderr, "error: invalid --consumed-mode \"%s\"\n", optarg);
 469                 usage(stderr, argv[0]);
 470                 return EXIT_INVALID_USAGE;
 471             }
 472             break;
 473         case 'h':
 474             usage(stdout, argv[0]);
 475             return EXIT_SUCCESS;
 476         case '?':
 477             usage(stderr, argv[0]);
 478             return EXIT_INVALID_USAGE;
 479         }
 480     }
 481
 482     ctx = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
 483     if (!ctx) {
 484         fprintf(stderr, "Couldn't create xkb context\n");
 485         goto out;
 486     }
 487
 488     if (keymap_path) {
 489         FILE *file = fopen(keymap_path, "rb");
 490         if (!file) {
 491             fprintf(stderr, "Couldn't open '%s': %s\n",
 492                     keymap_path, strerror(errno));
 493             goto out;
 494         }
 495         keymap = xkb_keymap_new_from_file(ctx, file,
 496                                           XKB_KEYMAP_FORMAT_TEXT_V1,
 497                                           XKB_KEYMAP_COMPILE_NO_FLAGS);
 498         fclose(file);
 499     }
 500     else {
 501         struct xkb_rule_names rmlvo = {
 502             .rules = (rules == NULL || rules[0] == '\0') ? NULL : rules,
 503             .model = (model == NULL || model[0] == '\0') ? NULL : model,
 504             .layout = (layout == NULL || layout[0] == '\0') ? NULL : layout,
 505             .variant = (variant == NULL || variant[0] == '\0') ? NULL : variant,
 506             .options = (options == NULL || options[0] == '\0') ? NULL : options
 507         };
 508
 509         if (!rules && !model && !layout && !variant && !options)
 510             keymap = xkb_keymap_new_from_names(ctx, NULL, 0);
 511         else
 512             keymap = xkb_keymap_new_from_names(ctx, &rmlvo, 0);
 513
 514         if (!keymap) {
 515             fprintf(stderr,
 516                     "Failed to compile RMLVO: '%s', '%s', '%s', '%s', '%s'\n",
 517                     rules, model, layout, variant, options);
 518             goto out;
 519         }
 520     }
 521
 522     if (!keymap) {
 523         fprintf(stderr, "Couldn't create xkb keymap\n");
 524         goto out;
 525     }
 526
 527     if (with_compose) {
 528         locale = setlocale(LC_CTYPE, NULL);
 529         compose_table =
 530             xkb_compose_table_new_from_locale(ctx, locale,
 531                                               XKB_COMPOSE_COMPILE_NO_FLAGS);
 532         if (!compose_table) {
 533             fprintf(stderr, "Couldn't create compose from locale\n");
 534             goto out;
 535         }
 536     }
 537
 538     kbds = get_keyboards(keymap, compose_table);
 539     if (!kbds) {
 540         goto out;
 541     }
 542
 543     act.sa_handler = sigintr_handler;
 544     sigemptyset(&act.sa_mask);
 545     act.sa_flags = 0;
 546     sigaction(SIGINT, &act, NULL);
 547     sigaction(SIGTERM, &act, NULL);
 548
 549     tools_disable_stdin_echo();
 550     ret = loop(kbds);
 551     tools_enable_stdin_echo();
 552
 553     free_keyboards(kbds);
 554 out:
 555     xkb_compose_table_unref(compose_table);
 556     xkb_keymap_unref(keymap);
 557     xkb_context_unref(ctx);
 558
 559     return ret;
 560 }