#include "all.h"
#include <xkbcommon/xkbcommon.h>
+#include <xkbcommon/xkbcommon-x11.h>
+
+static struct xkb_context *xkb_context;
+static struct xkb_keymap *xkb_keymap;
pid_t command_error_nagbar_pid = -1;
return NULL;
}
}
- new_binding->mods = modifiers_from_str(modifiers);
new_binding->command = sstrdup(command);
+ new_binding->event_state_mask = event_state_from_str(modifiers);
+ int group_bits_set = 0;
+ if (new_binding->event_state_mask & I3_XKB_GROUP_MASK_1)
+ group_bits_set++;
+ if (new_binding->event_state_mask & I3_XKB_GROUP_MASK_2)
+ group_bits_set++;
+ if (new_binding->event_state_mask & I3_XKB_GROUP_MASK_3)
+ group_bits_set++;
+ if (new_binding->event_state_mask & I3_XKB_GROUP_MASK_4)
+ group_bits_set++;
+ if (group_bits_set > 1)
+ ELOG("Keybinding has more than one Group specified, but your X server is always in precisely one group. The keybinding can never trigger.\n");
struct Mode *mode = mode_from_name(modename);
TAILQ_INSERT_TAIL(mode->bindings, new_binding, bindings);
if (bind->input_type != B_KEYBOARD)
return;
- DLOG("Grabbing %d with modifiers %d (with mod_mask_lock %d)\n", keycode, bind->mods, bind->mods | XCB_MOD_MASK_LOCK);
/* Grab the key in all combinations */
#define GRAB_KEY(modifier) \
do { \
xcb_grab_key(conn, 0, root, modifier, keycode, XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC); \
} while (0)
- int mods = bind->mods;
- if ((bind->mods & BIND_MODE_SWITCH) != 0) {
- mods &= ~BIND_MODE_SWITCH;
- if (mods == 0)
- mods = XCB_MOD_MASK_ANY;
- }
+ int mods = bind->event_state_mask;
+ if (((mods >> 16) & I3_XKB_GROUP_MASK_1) && xkb_current_group != XCB_XKB_GROUP_1)
+ return;
+ if (((mods >> 16) & I3_XKB_GROUP_MASK_2) && xkb_current_group != XCB_XKB_GROUP_2)
+ return;
+ if (((mods >> 16) & I3_XKB_GROUP_MASK_3) && xkb_current_group != XCB_XKB_GROUP_3)
+ return;
+ if (((mods >> 16) & I3_XKB_GROUP_MASK_4) && xkb_current_group != XCB_XKB_GROUP_4)
+ return;
+ mods &= 0xFFFF;
+ DLOG("Grabbing keycode %d with event state mask 0x%x (mods 0x%x)\n",
+ keycode, bind->event_state_mask, mods);
GRAB_KEY(mods);
GRAB_KEY(mods | xcb_numlock_mask);
GRAB_KEY(mods | XCB_MOD_MASK_LOCK);
* Grab the bound keys (tell X to send us keypress events for those keycodes)
*
*/
-void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch) {
+void grab_all_keys(xcb_connection_t *conn) {
Binding *bind;
TAILQ_FOREACH(bind, bindings, bindings) {
if (bind->input_type != B_KEYBOARD)
continue;
}
- xcb_keycode_t *walk = bind->translated_to;
for (uint32_t i = 0; i < bind->number_keycodes; i++)
- grab_keycode_for_binding(conn, bind, *walk++);
+ grab_keycode_for_binding(conn, bind, bind->translated_to[i]);
}
}
* keycode or NULL if no such binding exists.
*
*/
-static Binding *get_binding(uint16_t modifiers, bool is_release, uint16_t input_code, input_type_t input_type) {
+static Binding *get_binding(i3_event_state_mask_t state_filtered, bool is_release, uint16_t input_code, input_type_t input_type) {
Binding *bind;
if (!is_release) {
}
TAILQ_FOREACH(bind, bindings, bindings) {
- /* First compare the modifiers (unless this is a
+ DLOG("binding with event_state_mask 0x%x, state_filtered 0x%x, match: %s\n",
+ bind->event_state_mask, state_filtered,
+ ((state_filtered & bind->event_state_mask) == bind->event_state_mask) ? "yes" : "no");
+ /* First compare the state_filtered (unless this is a
* B_UPON_KEYRELEASE_IGNORE_MODS binding and this is a KeyRelease
* event) */
if (bind->input_type != input_type)
continue;
- if (bind->mods != modifiers &&
+ if ((state_filtered & bind->event_state_mask) != bind->event_state_mask &&
(bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
!is_release))
continue;
*
*/
Binding *get_binding_from_xcb_event(xcb_generic_event_t *event) {
- bool is_release = (event->response_type == XCB_KEY_RELEASE || event->response_type == XCB_BUTTON_RELEASE);
-
- input_type_t input_type = ((event->response_type == XCB_BUTTON_RELEASE || event->response_type == XCB_BUTTON_PRESS)
- ? B_MOUSE
- : B_KEYBOARD);
-
- uint16_t event_state = ((xcb_key_press_event_t *)event)->state;
- uint16_t event_detail = ((xcb_key_press_event_t *)event)->detail;
+ const bool is_release = (event->response_type == XCB_KEY_RELEASE ||
+ event->response_type == XCB_BUTTON_RELEASE);
+
+ const input_type_t input_type = ((event->response_type == XCB_BUTTON_RELEASE ||
+ event->response_type == XCB_BUTTON_PRESS)
+ ? B_MOUSE
+ : B_KEYBOARD);
+
+ const uint16_t event_state = ((xcb_key_press_event_t *)event)->state;
+ const uint16_t event_detail = ((xcb_key_press_event_t *)event)->detail;
+
+ /* Remove the numlock bit */
+ i3_event_state_mask_t state_filtered = event_state & ~(xcb_numlock_mask | XCB_MOD_MASK_LOCK);
+ DLOG("(removed numlock, state = 0x%x)\n", state_filtered);
+ /* Transform the keyboard_group from bit 13 and bit 14 into an
+ * i3_xkb_group_mask_t, so that get_binding() can just bitwise AND the
+ * configured bindings against |state_filtered|.
+ *
+ * These bits are only set because we set the XKB client flags
+ * XCB_XKB_PER_CLIENT_FLAG_GRABS_USE_XKB_STATE and
+ * XCB_XKB_PER_CLIENT_FLAG_LOOKUP_STATE_WHEN_GRABBED. See also doc/kbproto
+ * section 2.2.2:
+ * http://www.x.org/releases/X11R7.7/doc/kbproto/xkbproto.html#Computing_A_State_Field_from_an_XKB_State */
+ switch ((event_state & 0x6000) >> 13) {
+ case XCB_XKB_GROUP_1:
+ state_filtered |= (I3_XKB_GROUP_MASK_1 << 16);
+ break;
+ case XCB_XKB_GROUP_2:
+ state_filtered |= (I3_XKB_GROUP_MASK_2 << 16);
+ break;
+ case XCB_XKB_GROUP_3:
+ state_filtered |= (I3_XKB_GROUP_MASK_3 << 16);
+ break;
+ case XCB_XKB_GROUP_4:
+ state_filtered |= (I3_XKB_GROUP_MASK_4 << 16);
+ break;
+ }
+ state_filtered &= ~0x6000;
+ DLOG("(transformed keyboard group, state = 0x%x)\n", state_filtered);
+ return get_binding(state_filtered, is_release, event_detail, input_type);
+}
- /* Remove the numlock bit, all other bits are modifiers we can bind to */
- uint16_t state_filtered = event_state & ~(xcb_numlock_mask | XCB_MOD_MASK_LOCK);
- DLOG("(removed numlock, state = %d)\n", state_filtered);
- /* Only use the lower 8 bits of the state (modifier masks) so that mouse
- * button masks are filtered out */
- state_filtered &= 0xFF;
- DLOG("(removed upper 8 bits, state = %d)\n", state_filtered);
+struct resolve {
+ /* The binding which we are resolving. */
+ Binding *bind;
- if (xkb_current_group == XCB_XKB_GROUP_2)
- state_filtered |= BIND_MODE_SWITCH;
+ /* |bind|’s keysym (translated to xkb_keysym_t), e.g. XKB_KEY_R. */
+ xkb_keysym_t keysym;
- DLOG("(checked mode_switch, state %d)\n", state_filtered);
+ /* The xkb state built from the user-provided modifiers and group. */
+ struct xkb_state *xkb_state;
- /* Find the binding */
- Binding *bind = get_binding(state_filtered, is_release, event_detail, input_type);
+ /* Like |xkb_state|, just without the shift modifier, if shift was specified. */
+ struct xkb_state *xkb_state_no_shift;
+};
- /* No match? Then the user has Mode_switch enabled but does not have a
- * specific keybinding. Fall back to the default keybindings (without
- * Mode_switch). Makes it much more convenient for users of a hybrid
- * layout (like {us, ru} or {dvorak, us}, see e.g. ticket #1775). */
- if (bind == NULL) {
- state_filtered &= ~(BIND_MODE_SWITCH);
- DLOG("no match, new state_filtered = %d\n", state_filtered);
- if ((bind = get_binding(state_filtered, is_release, event_detail, input_type)) == NULL) {
- /* This is not a real error since we can have release and
- * non-release bindings. On a press event for which there is only a
- * !release-binding, but no release-binding, the corresponding
- * release event will trigger this. No problem, though. */
- DLOG("Could not lookup key binding (modifiers %d, keycode %d)\n",
- state_filtered, event_detail);
- }
+/*
+ * add_keycode_if_matches is called for each keycode in the keymap and will add
+ * the keycode to |data->bind| if the keycode can result in the keysym
+ * |data->resolving|.
+ *
+ */
+static void add_keycode_if_matches(struct xkb_keymap *keymap, xkb_keycode_t key, void *data) {
+ const struct resolve *resolving = data;
+ xkb_keysym_t sym = xkb_state_key_get_one_sym(resolving->xkb_state, key);
+ if (sym != resolving->keysym) {
+ /* Check if Shift was specified, and try resolving the symbol without
+ * shift, so that “bindsym $mod+Shift+a nop” actually works. */
+ const xkb_layout_index_t layout = xkb_state_key_get_layout(resolving->xkb_state, key);
+ if (layout == XKB_LAYOUT_INVALID)
+ return;
+ if (xkb_state_key_get_level(resolving->xkb_state, key, layout) != 1)
+ return;
+ sym = xkb_state_key_get_one_sym(resolving->xkb_state_no_shift, key);
+ if (sym != resolving->keysym)
+ return;
}
-
- return bind;
+ Binding *bind = resolving->bind;
+ bind->number_keycodes++;
+ bind->translated_to = srealloc(bind->translated_to,
+ (sizeof(xcb_keycode_t) *
+ bind->number_keycodes));
+ bind->translated_to[bind->number_keycodes - 1] = key;
}
/*
*
*/
void translate_keysyms(void) {
- Binding *bind;
- xcb_keysym_t keysym;
- int col;
- xcb_keycode_t i, min_keycode, max_keycode;
-
- const bool mode_switch = (xkb_current_group == XCB_XKB_GROUP_2);
+ struct xkb_state *dummy_state = xkb_state_new(xkb_keymap);
+ if (dummy_state == NULL) {
+ ELOG("Could not create XKB state, cannot translate keysyms.\n");
+ return;
+ }
- min_keycode = xcb_get_setup(conn)->min_keycode;
- max_keycode = xcb_get_setup(conn)->max_keycode;
+ struct xkb_state *dummy_state_no_shift = xkb_state_new(xkb_keymap);
+ if (dummy_state_no_shift == NULL) {
+ ELOG("Could not create XKB state, cannot translate keysyms.\n");
+ return;
+ }
+ Binding *bind;
TAILQ_FOREACH(bind, bindings, bindings) {
if (bind->input_type == B_MOUSE) {
char *endptr;
continue;
/* We need to translate the symbol to a keycode */
- keysym = xkb_keysym_from_name(bind->symbol, XKB_KEYSYM_NO_FLAGS);
+ const xkb_keysym_t keysym = xkb_keysym_from_name(bind->symbol, XKB_KEYSYM_NO_FLAGS);
if (keysym == XKB_KEY_NoSymbol) {
ELOG("Could not translate string to key symbol: \"%s\"\n",
bind->symbol);
continue;
}
- /* Base column we use for looking up key symbols. We always consider
- * the base column and the corresponding shift column, so without
- * mode_switch, we look in 0 and 1, with mode_switch we look in 2 and
- * 3. */
- col = (bind->mods & BIND_MODE_SWITCH || mode_switch ? 2 : 0);
-
+ xkb_layout_index_t group = XCB_XKB_GROUP_1;
+ if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2)
+ group = XCB_XKB_GROUP_2;
+ else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3)
+ group = XCB_XKB_GROUP_3;
+ else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4)
+ group = XCB_XKB_GROUP_4;
+
+ DLOG("group = %d, event_state_mask = %d, &2 = %s, &3 = %s, &4 = %s\n", group,
+ bind->event_state_mask,
+ (bind->event_state_mask & I3_XKB_GROUP_MASK_2) ? "yes" : "no",
+ (bind->event_state_mask & I3_XKB_GROUP_MASK_3) ? "yes" : "no",
+ (bind->event_state_mask & I3_XKB_GROUP_MASK_4) ? "yes" : "no");
+ (void)xkb_state_update_mask(
+ dummy_state,
+ (bind->event_state_mask & 0x1FFF) /* xkb_mod_mask_t base_mods, */,
+ 0 /* xkb_mod_mask_t latched_mods, */,
+ 0 /* xkb_mod_mask_t locked_mods, */,
+ 0 /* xkb_layout_index_t base_group, */,
+ 0 /* xkb_layout_index_t latched_group, */,
+ group /* xkb_layout_index_t locked_group, */);
+
+ (void)xkb_state_update_mask(
+ dummy_state_no_shift,
+ (bind->event_state_mask & 0x1FFF) & ~XCB_KEY_BUT_MASK_SHIFT /* xkb_mod_mask_t base_mods, */,
+ 0 /* xkb_mod_mask_t latched_mods, */,
+ 0 /* xkb_mod_mask_t locked_mods, */,
+ 0 /* xkb_layout_index_t base_group, */,
+ 0 /* xkb_layout_index_t latched_group, */,
+ group /* xkb_layout_index_t locked_group, */);
+
+ struct resolve resolving = {
+ .bind = bind,
+ .keysym = keysym,
+ .xkb_state = dummy_state,
+ .xkb_state_no_shift = dummy_state_no_shift,
+ };
FREE(bind->translated_to);
bind->number_keycodes = 0;
-
- for (i = min_keycode; i && i <= max_keycode; i++) {
- if ((xcb_key_symbols_get_keysym(keysyms, i, col) != keysym) &&
- (xcb_key_symbols_get_keysym(keysyms, i, col + 1) != keysym))
- continue;
- bind->number_keycodes++;
- bind->translated_to = srealloc(bind->translated_to,
- (sizeof(xcb_keycode_t) *
- bind->number_keycodes));
- bind->translated_to[bind->number_keycodes - 1] = i;
+ xkb_keymap_key_for_each(xkb_keymap, add_keycode_if_matches, &resolving);
+ char *keycodes = sstrdup("");
+ for (uint32_t n = 0; n < bind->number_keycodes; n++) {
+ char *tmp;
+ sasprintf(&tmp, "%s %d", keycodes, bind->translated_to[n]);
+ free(keycodes);
+ keycodes = tmp;
}
-
- DLOG("Translated symbol \"%s\" to %d keycode (mods %d)\n", bind->symbol,
- bind->number_keycodes, bind->mods);
+ DLOG("state=0x%x, cfg=\"%s\", sym=0x%x → keycodes%s (%d)\n",
+ bind->event_state_mask, bind->symbol, keysym, keycodes, bind->number_keycodes);
+ free(keycodes);
}
+
+ xkb_state_unref(dummy_state);
}
/*
ungrab_all_keys(conn);
bindings = mode->bindings;
translate_keysyms();
- grab_all_keys(conn, false);
+ grab_all_keys(conn);
char *event_msg;
sasprintf(&event_msg, "{\"change\":\"%s\"}", mode->name);
ELOG("ERROR: Mode not found\n");
}
+static void reorder_bindings_of_mode(struct Mode *mode) {
+ struct bindings_head *reordered = scalloc(1, sizeof(struct bindings_head));
+ TAILQ_INIT(reordered);
+ /* 20 bits are in use in an i3_event_state_mask_t. */
+ for (int n = 19; n >= 0; n--) {
+ Binding *current;
+ for (current = TAILQ_FIRST(mode->bindings); current != TAILQ_END(mode->bindings); ) {
+ /* Advance |current| so that we can use TAILQ_REMOVE safely. */
+ Binding *bind = current;
+ current = TAILQ_NEXT(current, bindings);
+ if ((bind->event_state_mask & (1 << n)) == 0)
+ continue;
+ TAILQ_REMOVE(mode->bindings, bind, bindings);
+ TAILQ_INSERT_TAIL(reordered, bind, bindings);
+ }
+ }
+ /* Move over the bindings with event_state_mask == 0x0. */
+ Binding *current;
+ for (current = TAILQ_FIRST(mode->bindings); current != TAILQ_END(mode->bindings); ) {
+ /* Advance |current| so that we can use TAILQ_REMOVE safely. */
+ Binding *bind = current;
+ current = TAILQ_NEXT(current, bindings);
+ assert(bind->event_state_mask == 0);
+ TAILQ_REMOVE(mode->bindings, bind, bindings);
+ TAILQ_INSERT_TAIL(reordered, bind, bindings);
+ }
+ assert(TAILQ_EMPTY(mode->bindings));
+ /* Free the old bindings_head, which is now empty. */
+ free(mode->bindings);
+ mode->bindings = reordered;
+}
+
+/*
+ * Reorders bindings by event_state_mask descendingly so that get_binding()
+ * correctly matches more specific bindings before more generic bindings. Take
+ * the following binding configuration as an example:
+ *
+ * bindsym n nop lower-case n pressed
+ * bindsym Shift+n nop upper-case n pressed
+ *
+ * Without reordering, the first binding’s event_state_mask of 0x0 would match
+ * the actual event_stat_mask of 0x1 and hence trigger instead of the second
+ * keybinding.
+ *
+ */
+void reorder_bindings(void) {
+ struct Mode *mode;
+ SLIST_FOREACH(mode, &modes, modes) {
+ const bool current_mode = (mode->bindings == bindings);
+ reorder_bindings_of_mode(mode);
+ if (current_mode)
+ bindings = mode->bindings;
+ }
+}
+
/*
* Checks for duplicate key bindings (the same keycode or keysym is configured
* more than once). If a duplicate binding is found, a message is printed to
/* Check if the keycodes or modifiers are different. If so, they
* can't be duplicate */
if (bind->keycode != current->keycode ||
- bind->mods != current->mods ||
+ bind->event_state_mask != current->event_state_mask ||
bind->release != current->release)
continue;
context->has_errors = true;
if (current->keycode != 0) {
- ELOG("Duplicate keybinding in config file:\n modmask %d with keycode %d, command \"%s\"\n",
- current->mods, current->keycode, current->command);
+ ELOG("Duplicate keybinding in config file:\n state mask 0x%x with keycode %d, command \"%s\"\n",
+ current->event_state_mask, current->keycode, current->command);
} else {
- ELOG("Duplicate keybinding in config file:\n modmask %d with keysym %s, command \"%s\"\n",
- current->mods, current->symbol, current->command);
+ ELOG("Duplicate keybinding in config file:\n state mask 0x%x with keysym %s, command \"%s\"\n",
+ current->event_state_mask, current->symbol, current->command);
}
}
}
return result;
}
+
+/*
+ * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
+ *
+ */
+bool load_keymap(void) {
+ if (xkb_context == NULL) {
+ if ((xkb_context = xkb_context_new(0)) == NULL) {
+ ELOG("Could not create xkbcommon context\n");
+ return false;
+ }
+ }
+
+ struct xkb_keymap *new_keymap;
+ const int32_t device_id = xkb_x11_get_core_keyboard_device_id(conn);
+ DLOG("device_id = %d\n", device_id);
+ if ((new_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0)) == NULL) {
+ ELOG("xkb_x11_keymap_new_from_device failed\n");
+ return false;
+ }
+ xkb_keymap_unref(xkb_keymap);
+ xkb_keymap = new_keymap;
+
+ return true;
+}
projects / i3 / i3 / commitdiff