src/uterm_input_uxkb.c

   1 /*
   2  * uterm - Linux User-Space Terminal
   3  *
   4  * Copyright (c) 2011 Ran Benita <ran234@gmail.com>
   5  * Copyright (c) 2012 David Herrmann <dh.herrmann@googlemail.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining
   8  * a copy of this software and associated documentation files
   9  * (the "Software"), to deal in the Software without restriction, including
  10  * without limitation the rights to use, copy, modify, merge, publish,
  11  * distribute, sublicense, and/or sell copies of the Software, and to
  12  * permit persons to whom the Software is furnished to do so, subject to
  13  * the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included
  16  * in all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  21  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  22  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  */
  26
  27 #include <errno.h>
  28 #include <inttypes.h>
  29 #include <linux/input.h>
  30 #include <stdbool.h>
  31 #include <stdlib.h>
  32 #include <string.h>
  33 #include <xkbcommon/xkbcommon.h>
  34 #include "log.h"
  35 #include "shl_hook.h"
  36 #include "shl_misc.h"
  37 #include "uterm.h"
  38 #include "uterm_input.h"
  39
  40 #define LOG_SUBSYSTEM "input_uxkb"
  41
  42 int uxkb_desc_init(struct uterm_input *input,
  43                    const char *layout,
  44                    const char *variant,
  45                    const char *options)
  46 {
  47         int ret;
  48         struct xkb_rule_names rmlvo = {
  49                 .rules = "evdev",
  50                 .model = "evdev",
  51                 .layout = layout,
  52                 .variant = variant,
  53                 .options = options,
  54         };
  55
  56         input->ctx = xkb_context_new(0);
  57         if (!input->ctx) {
  58                 log_error("cannot create XKB context");
  59                 return -ENOMEM;
  60         }
  61
  62         input->keymap = xkb_map_new_from_names(input->ctx, &rmlvo, 0);
  63         if (!input->keymap) {
  64                 log_warn("failed to create keymap (%s, %s, %s), "
  65                          "reverting to default US keymap",
  66                          layout, variant, options);
  67
  68                 rmlvo.layout = "us";
  69                 rmlvo.variant = "";
  70                 rmlvo.options = "";
  71
  72                 input->keymap = xkb_map_new_from_names(input->ctx, &rmlvo, 0);
  73                 if (!input->keymap) {
  74                         log_warn("failed to create XKB keymap");
  75                         ret = -EFAULT;
  76                         goto err_ctx;
  77                 }
  78         }
  79
  80         log_debug("new keyboard description (%s, %s, %s)",
  81                   layout, variant, options);
  82         return 0;
  83
  84 err_ctx:
  85         xkb_context_unref(input->ctx);
  86         return ret;
  87 }
  88
  89 void uxkb_desc_destroy(struct uterm_input *input)
  90 {
  91         xkb_map_unref(input->keymap);
  92         xkb_context_unref(input->ctx);
  93 }
  94
  95 static void timer_event(struct ev_timer *timer, uint64_t num, void *data)
  96 {
  97         struct uterm_input_dev *dev = data;
  98
  99         dev->repeat_event.handled = false;
 100         shl_hook_call(dev->input->hook, dev->input, &dev->repeat_event);
 101 }
 102
 103 int uxkb_dev_init(struct uterm_input_dev *dev)
 104 {
 105         int ret;
 106
 107         ret = ev_eloop_new_timer(dev->input->eloop, &dev->repeat_timer, NULL,
 108                                  timer_event, dev);
 109         if (ret)
 110                 return ret;
 111
 112         dev->state = xkb_state_new(dev->input->keymap);
 113         if (!dev->state) {
 114                 log_error("cannot create XKB state");
 115                 ret = -ENOMEM;
 116                 goto err_timer;
 117         }
 118
 119         return 0;
 120
 121 err_timer:
 122         ev_eloop_rm_timer(dev->repeat_timer);
 123         return ret;
 124 }
 125
 126 void uxkb_dev_destroy(struct uterm_input_dev *dev)
 127 {
 128         xkb_state_unref(dev->state);
 129         ev_eloop_rm_timer(dev->repeat_timer);
 130 }
 131
 132 #define EVDEV_KEYCODE_OFFSET 8
 133 enum {
 134         KEY_RELEASED = 0,
 135         KEY_PRESSED = 1,
 136         KEY_REPEATED = 2,
 137 };
 138
 139 static inline int uxkb_dev_resize_event(struct uterm_input_dev *dev, size_t s)
 140 {
 141         uint32_t *tmp;
 142
 143         if (s > dev->num_syms) {
 144                 tmp = realloc(dev->event.keysyms,
 145                               sizeof(uint32_t) * s);
 146                 if (!tmp) {
 147                         log_warning("cannot reallocate keysym buffer");
 148                         return -ENOKEY;
 149                 }
 150                 dev->event.keysyms = tmp;
 151
 152                 tmp = realloc(dev->event.codepoints,
 153                               sizeof(uint32_t) * s);
 154                 if (!tmp) {
 155                         log_warning("cannot reallocate codepoints buffer");
 156                         return -ENOKEY;
 157                 }
 158                 dev->event.codepoints = tmp;
 159
 160                 tmp = realloc(dev->repeat_event.keysyms,
 161                               sizeof(uint32_t) * s);
 162                 if (!tmp) {
 163                         log_warning("cannot reallocate keysym buffer");
 164                         return -ENOKEY;
 165                 }
 166                 dev->repeat_event.keysyms = tmp;
 167
 168                 tmp = realloc(dev->repeat_event.codepoints,
 169                               sizeof(uint32_t) * s);
 170                 if (!tmp) {
 171                         log_warning("cannot reallocate codepoints buffer");
 172                         return -ENOKEY;
 173                 }
 174                 dev->repeat_event.codepoints = tmp;
 175
 176                 dev->num_syms = s;
 177         }
 178
 179         return 0;
 180 }
 181
 182 static int uxkb_dev_fill_event(struct uterm_input_dev *dev,
 183                                struct uterm_input_event *ev,
 184                                xkb_keycode_t code,
 185                                int num_syms,
 186                                const xkb_keysym_t *syms)
 187 {
 188         int ret, i;
 189
 190         ret = uxkb_dev_resize_event(dev, num_syms);
 191         if (ret)
 192                 return ret;
 193
 194         ev->keycode = code;
 195         ev->ascii = shl_get_ascii(dev->state, code, syms, num_syms);
 196         ev->mods = shl_get_xkb_mods(dev->state);
 197         ev->num_syms = num_syms;
 198         memcpy(ev->keysyms, syms, sizeof(uint32_t) * num_syms);
 199
 200         for (i = 0; i < num_syms; ++i) {
 201                 ev->codepoints[i] = xkb_keysym_to_utf32(syms[i]);
 202                 if (!ev->codepoints[i])
 203                         ev->codepoints[i] = UTERM_INPUT_INVALID;
 204         }
 205
 206         return 0;
 207 }
 208
 209 static void uxkb_dev_repeat(struct uterm_input_dev *dev, unsigned int state)
 210 {
 211         struct xkb_keymap *keymap = xkb_state_get_map(dev->state);
 212         unsigned int i;
 213         int num_keysyms, ret;
 214         const uint32_t *keysyms;
 215         struct itimerspec spec;
 216
 217         if (state == KEY_RELEASED &&
 218             dev->repeat_event.keycode == dev->event.keycode) {
 219                 dev->repeating = false;
 220                 ev_timer_update(dev->repeat_timer, NULL);
 221                 return;
 222         }
 223
 224         if (state == KEY_PRESSED &&
 225             xkb_key_repeats(keymap, dev->event.keycode)) {
 226                 dev->repeat_event.keycode = dev->event.keycode;
 227                 dev->repeat_event.ascii = dev->event.ascii;
 228                 dev->repeat_event.mods = dev->event.mods;
 229                 dev->repeat_event.num_syms = dev->event.num_syms;
 230
 231                 for (i = 0; i < dev->event.num_syms; ++i) {
 232                         dev->repeat_event.keysyms[i] = dev->event.keysyms[i];
 233                         dev->repeat_event.codepoints[i] =
 234                                                 dev->event.codepoints[i];
 235                 }
 236         } else if (dev->repeating &&
 237                    !xkb_key_repeats(keymap, dev->event.keycode)) {
 238                 num_keysyms = xkb_key_get_syms(dev->state,
 239                                                dev->repeat_event.keycode,
 240                                                &keysyms);
 241                 if (num_keysyms <= 0)
 242                         return;
 243
 244                 ret = uxkb_dev_fill_event(dev, &dev->repeat_event,
 245                                           dev->repeat_event.keycode,
 246                                           num_keysyms, keysyms);
 247                 if (ret)
 248                         return;
 249         } else {
 250                 return;
 251         }
 252
 253         if (dev->repeating)
 254                 return;
 255
 256         dev->repeating = true;
 257         spec.it_interval.tv_sec = 0;
 258         spec.it_interval.tv_nsec = dev->input->repeat_rate * 1000000;
 259         spec.it_value.tv_sec = 0;
 260         spec.it_value.tv_nsec = dev->input->repeat_delay * 1000000;
 261         ev_timer_update(dev->repeat_timer, &spec);
 262 }
 263
 264 int uxkb_dev_process(struct uterm_input_dev *dev,
 265                      uint16_t key_state, uint16_t code)
 266 {
 267         struct xkb_state *state;
 268         xkb_keycode_t keycode;
 269         const xkb_keysym_t *keysyms;
 270         int num_keysyms, ret;
 271
 272         if (key_state == KEY_REPEATED)
 273                 return -ENOKEY;
 274
 275         state = dev->state;
 276         keycode = code + EVDEV_KEYCODE_OFFSET;
 277
 278         num_keysyms = xkb_key_get_syms(state, keycode, &keysyms);
 279
 280         if (key_state == KEY_PRESSED)
 281                 xkb_state_update_key(state, keycode, XKB_KEY_DOWN);
 282         else if (key_state == KEY_RELEASED)
 283                 xkb_state_update_key(state, keycode, XKB_KEY_UP);
 284
 285         if (num_keysyms <= 0)
 286                 return -ENOKEY;
 287
 288         ret = uxkb_dev_fill_event(dev, &dev->event, keycode, num_keysyms,
 289                                   keysyms);
 290         if (ret)
 291                 return -ENOKEY;
 292
 293         uxkb_dev_repeat(dev, key_state);
 294
 295         if (key_state == KEY_RELEASED)
 296                 return -ENOKEY;
 297
 298         dev->event.handled = false;
 299         shl_hook_call(dev->input->hook, dev->input, &dev->event);
 300
 301         return 0;
 302 }
 303
 304 /*
 305  * Call this when we regain control of the keyboard after losing it.
 306  * We don't reset the locked group, this should survive a VT switch, etc. The
 307  * locked modifiers are reset according to the keyboard LEDs.
 308  */
 309 void uxkb_dev_reset(struct uterm_input_dev *dev, const unsigned long *ledbits)
 310 {
 311         unsigned int i;
 312         struct xkb_state *state;
 313         static const struct {
 314                 int led;
 315                 const char *name;
 316         } led_names[] = {
 317                 { LED_NUML, XKB_LED_NAME_NUM },
 318                 { LED_CAPSL, XKB_LED_NAME_CAPS },
 319                 { LED_SCROLLL, XKB_LED_NAME_SCROLL },
 320         };
 321
 322         /* TODO: Urghs, while the input device was closed we might have missed
 323          * some events that affect internal state. As xkbcommon does not provide
 324          * a way to reset the internal state, we simply recreate the state. This
 325          * should have the same effect.
 326          * It also has a bug that if the CTRL-Release event is skipped, then
 327          * every further release will never perform a _real_ release. Kind of
 328          * buggy so we should fix it upstream. */
 329         state = xkb_state_new(dev->input->keymap);
 330         if (!state) {
 331                 log_warning("cannot recreate xkb-state");
 332                 return;
 333         }
 334         xkb_state_unref(dev->state);
 335         dev->state = state;
 336
 337         for (i = 0; i < sizeof(led_names) / sizeof(*led_names); i++) {
 338                 if (!input_bit_is_set(ledbits, led_names[i].led))
 339                         continue;
 340
 341                 /*
 342                  * TODO: Add support in xkbcommon for setting the led state,
 343                  * and updating the modifier state accordingly. E.g., something
 344                  * like this:
 345                  *      xkb_state_led_name_set_active(state, led_names[i].led);
 346                  */
 347         }
 348 }