sway/sway/input/keyboard.c

411 lines
13 KiB
C
Raw Normal View History

2018-01-04 12:25:52 +00:00
#include <assert.h>
#include <limits.h>
2017-12-27 18:31:31 +00:00
#include <wlr/backend/multi.h>
#include <wlr/backend/session.h>
#include <wlr/types/wlr_idle.h>
2017-12-10 18:59:04 +00:00
#include "sway/input/seat.h"
#include "sway/input/keyboard.h"
2017-12-15 10:22:51 +00:00
#include "sway/input/input-manager.h"
2017-12-27 20:25:16 +00:00
#include "sway/commands.h"
2017-12-10 18:59:04 +00:00
#include "log.h"
/**
* Update the shortcut model state in response to new input
*/
2018-06-01 10:51:07 +00:00
static void update_shortcut_model(struct sway_shortcut_state *state,
struct wlr_event_keyboard_key *event, uint32_t new_key,
bool last_key_was_a_modifier) {
if (event->state == WLR_KEY_PRESSED) {
if (last_key_was_a_modifier && state->last_key_index >= 0) {
// Last pressed key before this one was a modifier. We nullify
// the key id but not the keycode (as that is used for erasure
// on release)
state->pressed_keys[state->last_key_index] = 0;
state->last_key_index = -1;
2017-12-27 20:17:01 +00:00
}
// Add current key to set; there may be duplicates
2018-06-01 10:51:07 +00:00
for (size_t i = 0; i < SWAY_KEYBOARD_PRESSED_KEYS_CAP; ++i) {
if (!state->pressed_keys[i]) {
state->pressed_keys[i] = new_key;
state->pressed_keycodes[i] = event->keycode;
state->last_key_index = i;
break;
}
2017-12-27 20:17:01 +00:00
}
} else {
2018-06-01 10:51:07 +00:00
for (size_t i = 0; i < SWAY_KEYBOARD_PRESSED_KEYS_CAP; ++i) {
// The same keycode may match multiple keysyms.
if (state->pressed_keycodes[i] == event->keycode) {
state->pressed_keys[i] = 0;
state->pressed_keycodes[i] = 0;
}
2018-01-04 12:54:14 +00:00
}
}
}
/**
*
* Returns a binding which matches the shortcut model state (ignoring the
* `release` flag).
*/
static struct sway_binding *get_active_binding(
2018-06-01 10:51:07 +00:00
struct sway_shortcut_state *state, list_t *bindings,
uint32_t modifiers, bool locked) {
int npressed_keys = 0;
2018-06-01 10:51:07 +00:00
for (size_t i = 0; i < SWAY_KEYBOARD_PRESSED_KEYS_CAP; ++i) {
if (state->pressed_keys[i]) {
++npressed_keys;
}
2018-01-04 12:54:14 +00:00
}
for (int i = 0; i < bindings->length; ++i) {
struct sway_binding *binding = bindings->items[i];
2018-01-04 12:54:14 +00:00
if (modifiers ^ binding->modifiers ||
npressed_keys != binding->keys->length ||
locked > binding->locked) {
2018-01-04 12:54:14 +00:00
continue;
}
bool match = true;
for (int j = 0; j < binding->keys->length; ++j) {
2018-06-01 10:51:07 +00:00
uint32_t key = *(uint32_t *)binding->keys->items[j];
bool key_found = false;
2018-06-01 10:51:07 +00:00
for (int k = 0; k < SWAY_KEYBOARD_PRESSED_KEYS_CAP; ++k) {
if (state->pressed_keys[k] == key) {
key_found = true;
break;
}
}
if (!key_found) {
match = false;
break;
}
2018-01-04 12:54:14 +00:00
}
if (match) {
return binding;
}
2018-01-04 12:54:14 +00:00
}
return NULL;
2018-01-04 12:54:14 +00:00
}
/**
* Execute the command associated to a binding
*/
2018-01-20 19:10:11 +00:00
static void keyboard_execute_command(struct sway_keyboard *keyboard,
struct sway_binding *binding) {
2018-01-05 21:32:51 +00:00
wlr_log(L_DEBUG, "running command for binding: %s",
2018-01-04 12:54:14 +00:00
binding->command);
2018-01-20 19:10:11 +00:00
config_clear_handler_context(config);
config->handler_context.seat = keyboard->seat_device->sway_seat;
struct cmd_results *results = execute_command(binding->command, NULL);
2018-01-04 12:54:14 +00:00
if (results->status != CMD_SUCCESS) {
wlr_log(L_DEBUG, "could not run command for binding: %s (%s)",
binding->command, results->error);
2018-01-04 12:54:14 +00:00
}
free_cmd_results(results);
}
2017-12-27 18:31:31 +00:00
/**
* Execute a built-in, hardcoded compositor binding. These are triggered from a
* single keysym.
*
* Returns true if the keysym was handled by a binding and false if the event
* should be propagated to clients.
*/
2017-12-28 00:07:17 +00:00
static bool keyboard_execute_compositor_binding(struct sway_keyboard *keyboard,
const xkb_keysym_t *pressed_keysyms, uint32_t modifiers, size_t keysyms_len) {
2017-12-28 00:07:17 +00:00
for (size_t i = 0; i < keysyms_len; ++i) {
xkb_keysym_t keysym = pressed_keysyms[i];
if (keysym >= XKB_KEY_XF86Switch_VT_1 &&
keysym <= XKB_KEY_XF86Switch_VT_12) {
if (wlr_backend_is_multi(server.backend)) {
struct wlr_session *session =
wlr_multi_get_session(server.backend);
if (session) {
unsigned vt = keysym - XKB_KEY_XF86Switch_VT_1 + 1;
wlr_session_change_vt(session, vt);
}
2017-12-27 18:31:31 +00:00
}
2017-12-28 00:07:17 +00:00
return true;
2017-12-27 18:31:31 +00:00
}
}
return false;
}
2017-12-28 19:51:17 +00:00
/**
2017-12-27 18:20:28 +00:00
* Get keysyms and modifiers from the keyboard as xkb sees them.
*
* This uses the xkb keysyms translation based on pressed modifiers and clears
* the consumed modifiers from the list of modifiers passed to keybind
* detection.
*
* On US layout, pressing Alt+Shift+2 will trigger Alt+@.
*/
static size_t keyboard_keysyms_translated(struct sway_keyboard *keyboard,
xkb_keycode_t keycode, const xkb_keysym_t **keysyms,
uint32_t *modifiers) {
struct wlr_input_device *device =
keyboard->seat_device->input_device->wlr_device;
*modifiers = wlr_keyboard_get_modifiers(device->keyboard);
xkb_mod_mask_t consumed = xkb_state_key_get_consumed_mods2(
device->keyboard->xkb_state, keycode, XKB_CONSUMED_MODE_XKB);
*modifiers = *modifiers & ~consumed;
return xkb_state_key_get_syms(device->keyboard->xkb_state,
keycode, keysyms);
}
2017-12-28 19:51:17 +00:00
/**
2017-12-27 18:20:28 +00:00
* Get keysyms and modifiers from the keyboard as if modifiers didn't change
* keysyms.
*
* This avoids the xkb keysym translation based on modifiers considered pressed
* in the state.
*
* This will trigger keybinds such as Alt+Shift+2.
*/
static size_t keyboard_keysyms_raw(struct sway_keyboard *keyboard,
xkb_keycode_t keycode, const xkb_keysym_t **keysyms,
uint32_t *modifiers) {
struct wlr_input_device *device =
keyboard->seat_device->input_device->wlr_device;
*modifiers = wlr_keyboard_get_modifiers(device->keyboard);
xkb_layout_index_t layout_index = xkb_state_key_get_layout(
device->keyboard->xkb_state, keycode);
return xkb_keymap_key_get_syms_by_level(device->keyboard->keymap,
keycode, layout_index, 0, keysyms);
}
2017-12-10 18:59:04 +00:00
static void handle_keyboard_key(struct wl_listener *listener, void *data) {
struct sway_keyboard *keyboard =
wl_container_of(listener, keyboard, keyboard_key);
2017-12-14 16:11:56 +00:00
struct wlr_seat *wlr_seat = keyboard->seat_device->sway_seat->wlr_seat;
struct wlr_input_device *wlr_device =
keyboard->seat_device->input_device->wlr_device;
wlr_idle_notify_activity(keyboard->seat_device->sway_seat->input->server->idle, wlr_seat);
2017-12-10 18:59:04 +00:00
struct wlr_event_keyboard_key *event = data;
bool input_inhibited = keyboard->seat_device->sway_seat->exclusive_client != NULL;
2017-12-27 18:20:28 +00:00
// Identify new keycode, raw keysym(s), and translated keysym(s)
2017-12-27 18:20:28 +00:00
xkb_keycode_t keycode = event->keycode + 8;
2017-12-28 00:07:17 +00:00
2017-12-28 23:50:22 +00:00
const xkb_keysym_t *translated_keysyms;
uint32_t translated_modifiers;
2017-12-28 00:07:17 +00:00
size_t translated_keysyms_len =
2017-12-28 23:50:22 +00:00
keyboard_keysyms_translated(keyboard, keycode, &translated_keysyms,
&translated_modifiers);
2017-12-27 18:20:28 +00:00
2017-12-28 23:50:22 +00:00
const xkb_keysym_t *raw_keysyms;
uint32_t raw_modifiers;
2017-12-29 14:10:07 +00:00
size_t raw_keysyms_len =
keyboard_keysyms_raw(keyboard, keycode, &raw_keysyms, &raw_modifiers);
struct wlr_input_device *device =
keyboard->seat_device->input_device->wlr_device;
uint32_t code_modifiers = wlr_keyboard_get_modifiers(device->keyboard);
bool last_key_was_a_modifier = code_modifiers != keyboard->last_modifiers;
keyboard->last_modifiers = code_modifiers;
// Update shortcut models
update_shortcut_model(&keyboard->state_keycodes, event,
2018-06-01 10:51:07 +00:00
(uint32_t)keycode, last_key_was_a_modifier);
for (size_t i = 0; i < translated_keysyms_len; ++i) {
update_shortcut_model(&keyboard->state_keysyms_translated,
event, (uint32_t)translated_keysyms[i],
last_key_was_a_modifier);
}
2018-06-01 10:51:07 +00:00
for (size_t i = 0; i < raw_keysyms_len; ++i) {
update_shortcut_model(&keyboard->state_keysyms_raw,
event, (uint32_t)raw_keysyms[i],
last_key_was_a_modifier);
}
// identify which binding should be executed.
struct sway_binding *binding = get_active_binding(
&keyboard->state_keycodes,
config->current_mode->keycode_bindings,
code_modifiers, input_inhibited);
struct sway_binding *translated_binding = get_active_binding(
&keyboard->state_keysyms_translated,
config->current_mode->keysym_bindings,
translated_modifiers, input_inhibited);
if (translated_binding && !binding) {
binding = translated_binding;
} else if (binding && translated_binding && binding != translated_binding) {
wlr_log(L_DEBUG, "encountered duplicate bindings %d and %d",
binding->order, translated_binding->order);
}
struct sway_binding *raw_binding = get_active_binding(
&keyboard->state_keysyms_raw,
config->current_mode->keysym_bindings,
raw_modifiers, input_inhibited);
if (raw_binding && !binding) {
binding = raw_binding;
} else if (binding && raw_binding && binding != raw_binding) {
wlr_log(L_DEBUG, "encountered duplicate bindings %d and %d",
binding->order, raw_binding->order);
}
bool handled = false;
// Execute the identified binding if need be.
if (keyboard->held_binding && binding != keyboard->held_binding &&
event->state == WLR_KEY_RELEASED) {
keyboard_execute_command(keyboard, keyboard->held_binding);
handled = true;
}
if (binding != keyboard->held_binding) {
keyboard->held_binding = NULL;
}
if (binding && event->state == WLR_KEY_PRESSED) {
if (binding->release) {
keyboard->held_binding = binding;
} else {
keyboard_execute_command(keyboard, binding);
handled = true;
}
2017-12-28 00:07:17 +00:00
}
// Compositor bindings
2018-01-04 12:25:52 +00:00
if (!handled && event->state == WLR_KEY_PRESSED) {
handled = keyboard_execute_compositor_binding(
keyboard, translated_keysyms, translated_modifiers,
2017-12-28 00:07:17 +00:00
translated_keysyms_len);
}
2018-01-04 12:25:52 +00:00
if (!handled && event->state == WLR_KEY_PRESSED) {
handled = keyboard_execute_compositor_binding(
keyboard, raw_keysyms, raw_modifiers,
2017-12-28 00:07:17 +00:00
raw_keysyms_len);
2017-12-27 18:20:28 +00:00
}
2018-01-04 12:25:52 +00:00
if (!handled || event->state == WLR_KEY_RELEASED) {
2017-12-27 18:20:28 +00:00
wlr_seat_set_keyboard(wlr_seat, wlr_device);
wlr_seat_keyboard_notify_key(wlr_seat, event->time_msec,
event->keycode, event->state);
}
2017-12-10 18:59:04 +00:00
}
static void handle_keyboard_modifiers(struct wl_listener *listener,
void *data) {
struct sway_keyboard *keyboard =
wl_container_of(listener, keyboard, keyboard_modifiers);
2017-12-14 16:11:56 +00:00
struct wlr_seat *wlr_seat = keyboard->seat_device->sway_seat->wlr_seat;
struct wlr_input_device *wlr_device =
keyboard->seat_device->input_device->wlr_device;
wlr_seat_set_keyboard(wlr_seat, wlr_device);
2018-01-17 16:47:27 +00:00
wlr_seat_keyboard_notify_modifiers(wlr_seat, &wlr_device->keyboard->modifiers);
2017-12-10 18:59:04 +00:00
}
struct sway_keyboard *sway_keyboard_create(struct sway_seat *seat,
2017-12-14 16:11:56 +00:00
struct sway_seat_device *device) {
2017-12-10 18:59:04 +00:00
struct sway_keyboard *keyboard =
calloc(1, sizeof(struct sway_keyboard));
if (!sway_assert(keyboard, "could not allocate sway keyboard")) {
return NULL;
}
2017-12-14 16:11:56 +00:00
keyboard->seat_device = device;
device->keyboard = keyboard;
2017-12-10 18:59:04 +00:00
2017-12-14 16:11:56 +00:00
wl_list_init(&keyboard->keyboard_key.link);
wl_list_init(&keyboard->keyboard_modifiers.link);
keyboard->state_keycodes.last_key_index = -1;
keyboard->state_keysyms_raw.last_key_index = -1;
keyboard->state_keysyms_translated.last_key_index = -1;
2017-12-14 16:11:56 +00:00
return keyboard;
}
void sway_keyboard_configure(struct sway_keyboard *keyboard) {
2017-12-10 18:59:04 +00:00
struct xkb_rule_names rules;
memset(&rules, 0, sizeof(rules));
2017-12-15 10:22:51 +00:00
struct input_config *input_config =
2018-04-02 17:19:58 +00:00
input_device_get_config(keyboard->seat_device->input_device);
2017-12-15 10:57:28 +00:00
struct wlr_input_device *wlr_device =
keyboard->seat_device->input_device->wlr_device;
2017-12-15 10:22:51 +00:00
if (input_config && input_config->xkb_layout) {
rules.layout = input_config->xkb_layout;
} else {
rules.layout = getenv("XKB_DEFAULT_LAYOUT");
}
if (input_config && input_config->xkb_model) {
rules.model = input_config->xkb_model;
} else {
rules.model = getenv("XKB_DEFAULT_MODEL");
}
if (input_config && input_config->xkb_options) {
rules.options = input_config->xkb_options;
} else {
rules.options = getenv("XKB_DEFAULT_OPTIONS");
}
if (input_config && input_config->xkb_rules) {
rules.rules = input_config->xkb_rules;
} else {
rules.rules = getenv("XKB_DEFAULT_RULES");
}
if (input_config && input_config->xkb_variant) {
rules.variant = input_config->xkb_variant;
} else {
rules.variant = getenv("XKB_DEFAULT_VARIANT");
}
2017-12-14 16:11:56 +00:00
2017-12-10 18:59:04 +00:00
struct xkb_context *context = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
if (!sway_assert(context, "cannot create XKB context")) {
2017-12-14 16:11:56 +00:00
return;
2017-12-10 18:59:04 +00:00
}
2017-12-19 10:36:17 +00:00
struct xkb_keymap *keymap =
2017-12-14 16:11:56 +00:00
xkb_keymap_new_from_names(context, &rules, XKB_KEYMAP_COMPILE_NO_FLAGS);
2017-12-19 10:36:17 +00:00
if (!keymap) {
2018-01-05 21:32:51 +00:00
wlr_log(L_DEBUG, "cannot configure keyboard: keymap does not exist");
2017-12-19 10:36:17 +00:00
xkb_context_unref(context);
return;
}
xkb_keymap_unref(keyboard->keymap);
keyboard->keymap = keymap;
2017-12-15 10:57:28 +00:00
wlr_keyboard_set_keymap(wlr_device->keyboard, keyboard->keymap);
2017-12-19 10:36:17 +00:00
if (input_config && input_config->repeat_delay != INT_MIN
&& input_config->repeat_rate != INT_MIN) {
wlr_keyboard_set_repeat_info(wlr_device->keyboard,
input_config->repeat_rate, input_config->repeat_delay);
} else {
wlr_keyboard_set_repeat_info(wlr_device->keyboard, 25, 600);
}
2017-12-10 18:59:04 +00:00
xkb_context_unref(context);
struct wlr_seat *seat = keyboard->seat_device->sway_seat->wlr_seat;
wlr_seat_set_keyboard(seat, wlr_device);
2017-12-10 18:59:04 +00:00
2017-12-14 16:11:56 +00:00
wl_list_remove(&keyboard->keyboard_key.link);
2017-12-15 10:57:28 +00:00
wl_signal_add(&wlr_device->keyboard->events.key, &keyboard->keyboard_key);
2017-12-10 18:59:04 +00:00
keyboard->keyboard_key.notify = handle_keyboard_key;
2017-12-14 16:11:56 +00:00
wl_list_remove(&keyboard->keyboard_modifiers.link);
2017-12-15 10:57:28 +00:00
wl_signal_add( &wlr_device->keyboard->events.modifiers,
2017-12-12 13:29:37 +00:00
&keyboard->keyboard_modifiers);
2017-12-10 18:59:04 +00:00
keyboard->keyboard_modifiers.notify = handle_keyboard_modifiers;
}
2017-12-10 20:37:17 +00:00
void sway_keyboard_destroy(struct sway_keyboard *keyboard) {
2017-12-17 00:16:00 +00:00
if (!keyboard) {
return;
}
2017-12-10 20:37:17 +00:00
wl_list_remove(&keyboard->keyboard_key.link);
wl_list_remove(&keyboard->keyboard_modifiers.link);
free(keyboard);
}