sway/sway/input/keyboard.c

#include <assert.h>
#include <limits.h>
#include <wlr/backend/multi.h>
#include <wlr/backend/session.h>
#include <wlr/types/wlr_idle.h>
#include "sway/input/seat.h"
#include "sway/input/keyboard.h"
#include "sway/input/input-manager.h"
#include "sway/commands.h"
#include "log.h"

/**
 * Update the shortcut model state in response to new input
 */
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;
		}

		// Add current key to set; there may be duplicates
		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;
			}
		}
	} else {
		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;
			}
		}
	}
}

/**
 *
 * Returns a binding which matches the shortcut model state (ignoring the
 * `release` flag).
 */
static struct sway_binding *get_active_binding(
		struct sway_shortcut_state *state, list_t *bindings,
		uint32_t modifiers, bool locked) {
	int npressed_keys = 0;
	for (size_t i = 0; i < SWAY_KEYBOARD_PRESSED_KEYS_CAP; ++i) {
		if (state->pressed_keys[i]) {
			++npressed_keys;
		}
	}
	for (int i = 0; i < bindings->length; ++i) {
		struct sway_binding *binding = bindings->items[i];

		if (modifiers ^ binding->modifiers ||
			npressed_keys != binding->keys->length ||
			locked > binding->locked) {
			continue;
		}

		bool match = true;
		for (int j = 0; j < binding->keys->length; ++j) {
			uint32_t key = *(uint32_t *)binding->keys->items[j];

			bool key_found = false;
			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;
			}
		}

		if (match) {
			return binding;
		}
	}

	return NULL;
}

/**
 * Execute the command associated to a binding
 */
static void keyboard_execute_command(struct sway_keyboard *keyboard,
		struct sway_binding *binding) {
	wlr_log(L_DEBUG, "running command for binding: %s",
		binding->command);
	config_clear_handler_context(config);
	config->handler_context.seat = keyboard->seat_device->sway_seat;
	struct cmd_results *results = execute_command(binding->command, NULL);
	if (results->status != CMD_SUCCESS) {
		wlr_log(L_DEBUG, "could not run command for binding: %s (%s)",
			binding->command, results->error);
	}
	free_cmd_results(results);
}

/**
 * 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.
 */
static bool keyboard_execute_compositor_binding(struct sway_keyboard *keyboard,
		const xkb_keysym_t *pressed_keysyms, uint32_t modifiers, size_t keysyms_len) {
	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);
				}
			}
			return true;
		}
	}

	return false;
}

/**
 * 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);
}

/**
 * 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);
}

static void handle_keyboard_key(struct wl_listener *listener, void *data) {
	struct sway_keyboard *keyboard =
		wl_container_of(listener, keyboard, keyboard_key);
	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);
	struct wlr_event_keyboard_key *event = data;
	bool input_inhibited = keyboard->seat_device->sway_seat->exclusive_client != NULL;

	// Identify new keycode, raw keysym(s), and translated keysym(s)
	xkb_keycode_t keycode = event->keycode + 8;

	const xkb_keysym_t *translated_keysyms;
	uint32_t translated_modifiers;
	size_t translated_keysyms_len =
		keyboard_keysyms_translated(keyboard, keycode, &translated_keysyms,
			&translated_modifiers);

	const xkb_keysym_t *raw_keysyms;
	uint32_t raw_modifiers;
	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,
			(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);
	}
	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;
		}
	}

	// Compositor bindings
	if (!handled && event->state == WLR_KEY_PRESSED) {
		handled = keyboard_execute_compositor_binding(
				keyboard, translated_keysyms, translated_modifiers,
				translated_keysyms_len);
	}
	if (!handled && event->state == WLR_KEY_PRESSED) {
		handled = keyboard_execute_compositor_binding(
				keyboard, raw_keysyms, raw_modifiers,
				raw_keysyms_len);
	}

	if (!handled || event->state == WLR_KEY_RELEASED) {
		wlr_seat_set_keyboard(wlr_seat, wlr_device);
		wlr_seat_keyboard_notify_key(wlr_seat, event->time_msec,
				event->keycode, event->state);
	}
}

static void handle_keyboard_modifiers(struct wl_listener *listener,
		void *data) {
	struct sway_keyboard *keyboard =
		wl_container_of(listener, keyboard, keyboard_modifiers);
	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);
	wlr_seat_keyboard_notify_modifiers(wlr_seat, &wlr_device->keyboard->modifiers);
}

struct sway_keyboard *sway_keyboard_create(struct sway_seat *seat,
		struct sway_seat_device *device) {
	struct sway_keyboard *keyboard =
		calloc(1, sizeof(struct sway_keyboard));
	if (!sway_assert(keyboard, "could not allocate sway keyboard")) {
		return NULL;
	}

	keyboard->seat_device = device;
	device->keyboard = keyboard;

	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;

	return keyboard;
}

void sway_keyboard_configure(struct sway_keyboard *keyboard) {
	struct xkb_rule_names rules;
	memset(&rules, 0, sizeof(rules));
	struct input_config *input_config =
		input_device_get_config(keyboard->seat_device->input_device);
	struct wlr_input_device *wlr_device =
		keyboard->seat_device->input_device->wlr_device;

	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");
	}

	struct xkb_context *context = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
	if (!sway_assert(context, "cannot create XKB context")) {
		return;
	}

	struct xkb_keymap *keymap =
		xkb_keymap_new_from_names(context, &rules, XKB_KEYMAP_COMPILE_NO_FLAGS);

	if (!keymap) {
		wlr_log(L_DEBUG, "cannot configure keyboard: keymap does not exist");
		xkb_context_unref(context);
		return;
	}

	xkb_keymap_unref(keyboard->keymap);
	keyboard->keymap = keymap;
	wlr_keyboard_set_keymap(wlr_device->keyboard, keyboard->keymap);

	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);
	}
	xkb_context_unref(context);
	struct wlr_seat *seat = keyboard->seat_device->sway_seat->wlr_seat;
	wlr_seat_set_keyboard(seat, wlr_device);

	wl_list_remove(&keyboard->keyboard_key.link);
	wl_signal_add(&wlr_device->keyboard->events.key, &keyboard->keyboard_key);
	keyboard->keyboard_key.notify = handle_keyboard_key;

	wl_list_remove(&keyboard->keyboard_modifiers.link);
	wl_signal_add( &wlr_device->keyboard->events.modifiers,
		&keyboard->keyboard_modifiers);
	keyboard->keyboard_modifiers.notify = handle_keyboard_modifiers;
}

void sway_keyboard_destroy(struct sway_keyboard *keyboard) {
	if (!keyboard) {
		return;
	}
	wl_list_remove(&keyboard->keyboard_key.link);
	wl_list_remove(&keyboard->keyboard_modifiers.link);
	free(keyboard);
}