#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
+#include <unistd.h>
#include <xkbcommon/xkbcommon.h>
-#include "log.h"
+#include "shl_hook.h"
+#include "shl_log.h"
#include "shl_misc.h"
-#include "uterm.h"
#include "uterm_input.h"
+#include "uterm_input_internal.h"
#define LOG_SUBSYSTEM "input_uxkb"
int uxkb_desc_init(struct uterm_input *input,
+ const char *model,
const char *layout,
const char *variant,
const char *options)
int ret;
struct xkb_rule_names rmlvo = {
.rules = "evdev",
- .model = "evdev",
+ .model = model,
.layout = layout,
.variant = variant,
.options = options,
return -ENOMEM;
}
- input->keymap = xkb_map_new_from_names(input->ctx, &rmlvo, 0);
+ input->keymap = xkb_keymap_new_from_names(input->ctx, &rmlvo, 0);
if (!input->keymap) {
- log_warn("failed to create keymap (%s, %s, %s), "
- "reverting to default US keymap",
- layout, variant, options);
+ log_warn("failed to create keymap (%s, %s, %s, %s), "
+ "reverting to default system keymap",
+ model, layout, variant, options);
- rmlvo.layout = "us";
+ rmlvo.model = "";
+ rmlvo.layout = "";
rmlvo.variant = "";
rmlvo.options = "";
- input->keymap = xkb_map_new_from_names(input->ctx, &rmlvo, 0);
+ input->keymap = xkb_keymap_new_from_names(input->ctx,
+ &rmlvo, 0);
if (!input->keymap) {
log_warn("failed to create XKB keymap");
ret = -EFAULT;
}
}
- log_debug("new keyboard description (%s, %s, %s)",
- layout, variant, options);
+ log_debug("new keyboard description (%s, %s, %s, %s)",
+ model, layout, variant, options);
return 0;
err_ctx:
void uxkb_desc_destroy(struct uterm_input *input)
{
- xkb_map_unref(input->keymap);
+ xkb_keymap_unref(input->keymap);
xkb_context_unref(input->ctx);
}
+static void timer_event(struct ev_timer *timer, uint64_t num, void *data)
+{
+ struct uterm_input_dev *dev = data;
+
+ dev->repeat_event.handled = false;
+ shl_hook_call(dev->input->hook, dev->input, &dev->repeat_event);
+}
+
int uxkb_dev_init(struct uterm_input_dev *dev)
{
+ int ret;
+
+ ret = ev_eloop_new_timer(dev->input->eloop, &dev->repeat_timer, NULL,
+ timer_event, dev);
+ if (ret)
+ return ret;
+
dev->state = xkb_state_new(dev->input->keymap);
- if (!dev->state)
- return -ENOMEM;
+ if (!dev->state) {
+ log_error("cannot create XKB state");
+ ret = -ENOMEM;
+ goto err_timer;
+ }
return 0;
+
+err_timer:
+ ev_eloop_rm_timer(dev->repeat_timer);
+ return ret;
}
void uxkb_dev_destroy(struct uterm_input_dev *dev)
{
xkb_state_unref(dev->state);
+ ev_eloop_rm_timer(dev->repeat_timer);
}
#define EVDEV_KEYCODE_OFFSET 8
KEY_REPEATED = 2,
};
-int uxkb_dev_process(struct uterm_input_dev *dev,
- uint16_t key_state, uint16_t code)
+static void uxkb_dev_update_keyboard_leds(struct uterm_input_dev *dev)
{
- struct xkb_state *state;
- struct xkb_keymap *keymap;
- xkb_keycode_t keycode;
- const xkb_keysym_t *keysyms;
- int num_keysyms, i;
- uint32_t *tmp;
-
- state = dev->state;
- keymap = xkb_state_get_map(state);
- keycode = code + EVDEV_KEYCODE_OFFSET;
+ static const struct {
+ int evdev_led;
+ const char *xkb_led;
+ } leds[] = {
+ { LED_NUML, XKB_LED_NAME_NUM },
+ { LED_CAPSL, XKB_LED_NAME_CAPS },
+ { LED_SCROLLL, XKB_LED_NAME_SCROLL },
+ };
+ struct input_event events[sizeof(leds) / sizeof(*leds)];
+ int i, ret;
- num_keysyms = xkb_key_get_syms(state, keycode, &keysyms);
+ if (!(dev->capabilities & UTERM_DEVICE_HAS_LEDS))
+ return;
- if (key_state == KEY_PRESSED)
- xkb_state_update_key(state, keycode, XKB_KEY_DOWN);
- else if (key_state == KEY_RELEASED)
- xkb_state_update_key(state, keycode, XKB_KEY_UP);
+ memset(events, 0, sizeof(events));
- if (key_state == KEY_RELEASED)
- return -ENOKEY;
+ for (i = 0; i < sizeof(leds) / sizeof(*leds); i++) {
+ events[i].type = EV_LED;
+ events[i].code = leds[i].evdev_led;
+ if (xkb_state_led_name_is_active(dev->state,
+ leds[i].xkb_led) > 0)
+ events[i].value = 1;
+ }
- if (key_state == KEY_REPEATED && !xkb_key_repeats(keymap, keycode))
- return -ENOKEY;
+ ret = write(dev->rfd, events, sizeof(events));
+ if (ret != sizeof(events))
+ log_warning("cannot update LED state (%d): %m", errno);
+}
- if (num_keysyms <= 0)
- return -ENOKEY;
+static inline int uxkb_dev_resize_event(struct uterm_input_dev *dev, size_t s)
+{
+ uint32_t *tmp;
- if (dev->num_syms < num_keysyms) {
+ if (s > dev->num_syms) {
tmp = realloc(dev->event.keysyms,
- sizeof(uint32_t) * num_keysyms);
+ sizeof(uint32_t) * s);
if (!tmp) {
log_warning("cannot reallocate keysym buffer");
return -ENOKEY;
dev->event.keysyms = tmp;
tmp = realloc(dev->event.codepoints,
- sizeof(uint32_t) * num_keysyms);
+ sizeof(uint32_t) * s);
if (!tmp) {
log_warning("cannot reallocate codepoints buffer");
return -ENOKEY;
}
dev->event.codepoints = tmp;
- dev->num_syms = num_keysyms;
+ tmp = realloc(dev->repeat_event.keysyms,
+ sizeof(uint32_t) * s);
+ if (!tmp) {
+ log_warning("cannot reallocate keysym buffer");
+ return -ENOKEY;
+ }
+ dev->repeat_event.keysyms = tmp;
+
+ tmp = realloc(dev->repeat_event.codepoints,
+ sizeof(uint32_t) * s);
+ if (!tmp) {
+ log_warning("cannot reallocate codepoints buffer");
+ return -ENOKEY;
+ }
+ dev->repeat_event.codepoints = tmp;
+
+ dev->num_syms = s;
}
- dev->event.handled = false;
- dev->event.keycode = code;
- dev->event.mods = shl_get_xkb_mods(state);
- dev->event.num_syms = num_keysyms;
- memcpy(dev->event.keysyms, keysyms, sizeof(uint32_t) * num_keysyms);
-
- for (i = 0; i < num_keysyms; ++i) {
- dev->event.codepoints[i] = xkb_keysym_to_utf32(keysyms[i]);
- if (!dev->event.codepoints[i])
- dev->event.codepoints[i] = UTERM_INPUT_INVALID;
+ return 0;
+}
+
+static int uxkb_dev_fill_event(struct uterm_input_dev *dev,
+ struct uterm_input_event *ev,
+ xkb_keycode_t code,
+ int num_syms,
+ const xkb_keysym_t *syms)
+{
+ int ret, i;
+
+ ret = uxkb_dev_resize_event(dev, num_syms);
+ if (ret)
+ return ret;
+
+ ev->keycode = code;
+ ev->ascii = shl_get_ascii(dev->state, code, syms, num_syms);
+ ev->mods = shl_get_xkb_mods(dev->state);
+ ev->num_syms = num_syms;
+ memcpy(ev->keysyms, syms, sizeof(uint32_t) * num_syms);
+
+ for (i = 0; i < num_syms; ++i) {
+ ev->codepoints[i] = xkb_keysym_to_utf32(syms[i]);
+ if (!ev->codepoints[i])
+ ev->codepoints[i] = UTERM_INPUT_INVALID;
}
return 0;
}
-/*
- * Call this when we regain control of the keyboard after losing it.
- * We don't reset the locked group, this should survive a VT switch, etc. The
- * locked modifiers are reset according to the keyboard LEDs.
- */
-void uxkb_dev_reset(struct uterm_input_dev *dev, const unsigned long *ledbits)
+static void uxkb_dev_repeat(struct uterm_input_dev *dev, unsigned int state)
{
+ struct xkb_keymap *keymap = xkb_state_get_keymap(dev->state);
unsigned int i;
+ int num_keysyms, ret;
+ const uint32_t *keysyms;
+ struct itimerspec spec;
+
+ if (dev->repeating && dev->repeat_event.keycode == dev->event.keycode) {
+ if (state == KEY_RELEASED) {
+ dev->repeating = false;
+ ev_timer_update(dev->repeat_timer, NULL);
+ }
+ return;
+ }
+
+ if (state == KEY_PRESSED &&
+ xkb_keymap_key_repeats(keymap, dev->event.keycode)) {
+ dev->repeat_event.keycode = dev->event.keycode;
+ dev->repeat_event.ascii = dev->event.ascii;
+ dev->repeat_event.mods = dev->event.mods;
+ dev->repeat_event.num_syms = dev->event.num_syms;
+
+ for (i = 0; i < dev->event.num_syms; ++i) {
+ dev->repeat_event.keysyms[i] = dev->event.keysyms[i];
+ dev->repeat_event.codepoints[i] =
+ dev->event.codepoints[i];
+ }
+ } else if (dev->repeating &&
+ !xkb_keymap_key_repeats(keymap, dev->event.keycode)) {
+ num_keysyms = xkb_state_key_get_syms(dev->state,
+ dev->repeat_event.keycode,
+ &keysyms);
+ if (num_keysyms <= 0)
+ return;
+
+ ret = uxkb_dev_fill_event(dev, &dev->repeat_event,
+ dev->repeat_event.keycode,
+ num_keysyms, keysyms);
+ if (ret)
+ return;
+
+ return;
+ } else {
+ return;
+ }
+
+ dev->repeating = true;
+ spec.it_interval.tv_sec = 0;
+ spec.it_interval.tv_nsec = dev->input->repeat_rate * 1000000;
+ spec.it_value.tv_sec = 0;
+ spec.it_value.tv_nsec = dev->input->repeat_delay * 1000000;
+ ev_timer_update(dev->repeat_timer, &spec);
+}
+
+int uxkb_dev_process(struct uterm_input_dev *dev,
+ uint16_t key_state, uint16_t code)
+{
struct xkb_state *state;
- static const struct {
- int led;
- const char *name;
- } led_names[] = {
- { LED_NUML, XKB_LED_NAME_NUM },
- { LED_CAPSL, XKB_LED_NAME_CAPS },
- { LED_SCROLLL, XKB_LED_NAME_SCROLL },
- };
+ xkb_keycode_t keycode;
+ const xkb_keysym_t *keysyms;
+ int num_keysyms, ret;
+ enum xkb_state_component changed;
+
+ if (key_state == KEY_REPEATED)
+ return -ENOKEY;
+
+ state = dev->state;
+ keycode = code + EVDEV_KEYCODE_OFFSET;
- /* TODO: Urghs, while the input device was closed we might have missed
- * some events that affect internal state. As xkbcommon does not provide
- * a way to reset the internal state, we simply recreate the state. This
- * should have the same effect.
- * It also has a bug that if the CTRL-Release event is skipped, then
- * every further release will never perform a _real_ release. Kind of
- * buggy so we should fix it upstream. */
- state = xkb_state_new(dev->input->keymap);
- if (!state) {
- log_warning("cannot recreate xkb-state");
+ num_keysyms = xkb_state_key_get_syms(state, keycode, &keysyms);
+
+ changed = 0;
+ if (key_state == KEY_PRESSED)
+ changed = xkb_state_update_key(state, keycode, XKB_KEY_DOWN);
+ else if (key_state == KEY_RELEASED)
+ changed = xkb_state_update_key(state, keycode, XKB_KEY_UP);
+
+ if (changed & XKB_STATE_LEDS)
+ uxkb_dev_update_keyboard_leds(dev);
+
+ if (num_keysyms <= 0)
+ return -ENOKEY;
+
+ ret = uxkb_dev_fill_event(dev, &dev->event, keycode, num_keysyms,
+ keysyms);
+ if (ret)
+ return -ENOKEY;
+
+ uxkb_dev_repeat(dev, key_state);
+
+ if (key_state == KEY_RELEASED)
+ return -ENOKEY;
+
+ dev->event.handled = false;
+ shl_hook_call(dev->input->hook, dev->input, &dev->event);
+
+ return 0;
+}
+
+void uxkb_dev_sleep(struct uterm_input_dev *dev)
+{
+ /*
+ * While the device is asleep, we don't receive key events. This
+ * means that when we wake up, the keyboard state may be different
+ * (e.g. some key is pressed but we don't know about it). This can
+ * cause various problems, like stuck modifiers: consider if we
+ * miss a release of the left Shift key. When the user presses it
+ * again, xkb_state_update_key() will think there is *another* left
+ * Shift key that was pressed. When the key is released, it's as if
+ * this "second" key was released, but the "first" is still left
+ * pressed.
+ * To handle this, when the device goes to sleep, we save our
+ * current knowledge of the keyboard's press/release state. On wake
+ * up, we compare the states before and after, and just feed
+ * xkb_state_update_key() the deltas.
+ */
+ memset(dev->key_state_bits, 0, sizeof(dev->key_state_bits));
+ errno = 0;
+ ioctl(dev->rfd, EVIOCGKEY(sizeof(dev->key_state_bits)),
+ dev->key_state_bits);
+ if (errno)
+ log_warn("failed to save keyboard state (%d): %m", errno);
+}
+
+void uxkb_dev_wake_up(struct uterm_input_dev *dev)
+{
+ uint32_t code;
+ char *old_bits, cur_bits[sizeof(dev->key_state_bits)];
+ char old_bit, cur_bit;
+
+ old_bits = dev->key_state_bits;
+
+ memset(cur_bits, 0, sizeof(cur_bits));
+ errno = 0;
+ ioctl(dev->rfd, EVIOCGKEY(sizeof(cur_bits)), cur_bits);
+ if (errno) {
+ log_warn("failed to get current keyboard state (%d): %m",
+ errno);
return;
}
- xkb_state_unref(dev->state);
- dev->state = state;
- for (i = 0; i < sizeof(led_names) / sizeof(*led_names); i++) {
- if (!input_bit_is_set(ledbits, led_names[i].led))
+ for (code = 0; code < KEY_CNT; code++) {
+ old_bit = (old_bits[code / 8] & (1 << (code % 8)));
+ cur_bit = (cur_bits[code / 8] & (1 << (code % 8)));
+
+ if (old_bit == cur_bit)
continue;
- /*
- * TODO: Add support in xkbcommon for setting the led state,
- * and updating the modifier state accordingly. E.g., something
- * like this:
- * xkb_state_led_name_set_active(state, led_names[i].led);
- */
+ xkb_state_update_key(dev->state, code + EVDEV_KEYCODE_OFFSET,
+ cur_bit ? XKB_KEY_DOWN : XKB_KEY_UP);
}
+
+ uxkb_dev_update_keyboard_leds(dev);
}