2 * uterm - Linux User-Space Terminal
4 * Copyright (c) 2011 Ran Benita <ran234@gmail.com>
5 * Copyright (c) 2012 David Herrmann <dh.herrmann@googlemail.com>
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:
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
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.
29 #include <linux/input.h>
33 #include <xkbcommon/xkbcommon.h>
38 #include "uterm_input.h"
40 #define LOG_SUBSYSTEM "input_uxkb"
42 int uxkb_desc_init(struct uterm_input *input,
48 struct xkb_rule_names rmlvo = {
56 input->ctx = xkb_context_new(0);
58 log_error("cannot create XKB context");
62 input->keymap = xkb_map_new_from_names(input->ctx, &rmlvo, 0);
64 log_warn("failed to create keymap (%s, %s, %s), "
65 "reverting to default US keymap",
66 layout, variant, options);
72 input->keymap = xkb_map_new_from_names(input->ctx, &rmlvo, 0);
74 log_warn("failed to create XKB keymap");
80 log_debug("new keyboard description (%s, %s, %s)",
81 layout, variant, options);
85 xkb_context_unref(input->ctx);
89 void uxkb_desc_destroy(struct uterm_input *input)
91 xkb_map_unref(input->keymap);
92 xkb_context_unref(input->ctx);
95 static void timer_event(struct ev_timer *timer, uint64_t num, void *data)
97 struct uterm_input_dev *dev = data;
99 dev->repeat_event.handled = false;
100 shl_hook_call(dev->input->hook, dev->input, &dev->repeat_event);
103 int uxkb_dev_init(struct uterm_input_dev *dev)
107 ret = ev_eloop_new_timer(dev->input->eloop, &dev->repeat_timer, NULL,
112 dev->state = xkb_state_new(dev->input->keymap);
114 log_error("cannot create XKB state");
122 ev_eloop_rm_timer(dev->repeat_timer);
126 void uxkb_dev_destroy(struct uterm_input_dev *dev)
128 xkb_state_unref(dev->state);
129 ev_eloop_rm_timer(dev->repeat_timer);
132 #define EVDEV_KEYCODE_OFFSET 8
139 static inline int uxkb_dev_resize_event(struct uterm_input_dev *dev, size_t s)
143 if (s > dev->num_syms) {
144 tmp = realloc(dev->event.keysyms,
145 sizeof(uint32_t) * s);
147 log_warning("cannot reallocate keysym buffer");
150 dev->event.keysyms = tmp;
152 tmp = realloc(dev->event.codepoints,
153 sizeof(uint32_t) * s);
155 log_warning("cannot reallocate codepoints buffer");
158 dev->event.codepoints = tmp;
160 tmp = realloc(dev->repeat_event.keysyms,
161 sizeof(uint32_t) * s);
163 log_warning("cannot reallocate keysym buffer");
166 dev->repeat_event.keysyms = tmp;
168 tmp = realloc(dev->repeat_event.codepoints,
169 sizeof(uint32_t) * s);
171 log_warning("cannot reallocate codepoints buffer");
174 dev->repeat_event.codepoints = tmp;
182 static int uxkb_dev_fill_event(struct uterm_input_dev *dev,
183 struct uterm_input_event *ev,
186 const xkb_keysym_t *syms)
190 ret = uxkb_dev_resize_event(dev, num_syms);
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);
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;
209 static void uxkb_dev_repeat(struct uterm_input_dev *dev, unsigned int state)
211 struct xkb_keymap *keymap = xkb_state_get_map(dev->state);
213 int num_keysyms, ret;
214 const uint32_t *keysyms;
215 struct itimerspec spec;
217 if (dev->repeating && dev->repeat_event.keycode == dev->event.keycode) {
218 if (state == KEY_RELEASED) {
219 dev->repeating = false;
220 ev_timer_update(dev->repeat_timer, NULL);
225 if (state == KEY_PRESSED &&
226 xkb_key_repeats(keymap, dev->event.keycode)) {
227 dev->repeat_event.keycode = dev->event.keycode;
228 dev->repeat_event.ascii = dev->event.ascii;
229 dev->repeat_event.mods = dev->event.mods;
230 dev->repeat_event.num_syms = dev->event.num_syms;
232 for (i = 0; i < dev->event.num_syms; ++i) {
233 dev->repeat_event.keysyms[i] = dev->event.keysyms[i];
234 dev->repeat_event.codepoints[i] =
235 dev->event.codepoints[i];
237 } else if (dev->repeating &&
238 !xkb_key_repeats(keymap, dev->event.keycode)) {
239 num_keysyms = xkb_key_get_syms(dev->state,
240 dev->repeat_event.keycode,
242 if (num_keysyms <= 0)
245 ret = uxkb_dev_fill_event(dev, &dev->repeat_event,
246 dev->repeat_event.keycode,
247 num_keysyms, keysyms);
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);
264 int uxkb_dev_process(struct uterm_input_dev *dev,
265 uint16_t key_state, uint16_t code)
267 struct xkb_state *state;
268 xkb_keycode_t keycode;
269 const xkb_keysym_t *keysyms;
270 int num_keysyms, ret;
272 if (key_state == KEY_REPEATED)
276 keycode = code + EVDEV_KEYCODE_OFFSET;
278 num_keysyms = xkb_key_get_syms(state, keycode, &keysyms);
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);
285 if (num_keysyms <= 0)
288 ret = uxkb_dev_fill_event(dev, &dev->event, keycode, num_keysyms,
293 uxkb_dev_repeat(dev, key_state);
295 if (key_state == KEY_RELEASED)
298 dev->event.handled = false;
299 shl_hook_call(dev->input->hook, dev->input, &dev->event);
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.
309 void uxkb_dev_reset(struct uterm_input_dev *dev, const unsigned long *ledbits)
312 struct xkb_state *state;
313 static const struct {
317 { LED_NUML, XKB_LED_NAME_NUM },
318 { LED_CAPSL, XKB_LED_NAME_CAPS },
319 { LED_SCROLLL, XKB_LED_NAME_SCROLL },
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);
331 log_warning("cannot recreate xkb-state");
334 xkb_state_unref(dev->state);
337 for (i = 0; i < sizeof(led_names) / sizeof(*led_names); i++) {
338 if (!input_bit_is_set(ledbits, led_names[i].led))
342 * TODO: Add support in xkbcommon for setting the led state,
343 * and updating the modifier state accordingly. E.g., something
345 * xkb_state_led_name_set_active(state, led_names[i].led);