const char *release, const char *border, const char *whole_window,
const char *command, const char *modename, bool pango_markup) {
Binding *new_binding = scalloc(1, sizeof(Binding));
- DLOG("bindtype %s, modifiers %s, input code %s, release %s\n", bindtype, modifiers, input_code, release);
+ DLOG("Binding %p bindtype %s, modifiers %s, input code %s, release %s\n", new_binding, bindtype, modifiers, input_code, release);
new_binding->release = (release != NULL ? B_UPON_KEYRELEASE : B_UPON_KEYPRESS);
new_binding->border = (border != NULL);
new_binding->whole_window = (whole_window != NULL);
struct Mode *mode = mode_from_name(modename, pango_markup);
TAILQ_INSERT_TAIL(mode->bindings, new_binding, bindings);
+ TAILQ_INIT(&(new_binding->keycodes_head));
+
return new_binding;
}
-static void grab_keycode_for_binding(xcb_connection_t *conn, Binding *bind, uint32_t keycode) {
- if (bind->input_type != B_KEYBOARD)
- return;
+static bool binding_in_current_group(const Binding *bind) {
+ /* If no bits are set, the binding should be installed in every group. */
+ if ((bind->event_state_mask >> 16) == I3_XKB_GROUP_MASK_ANY)
+ return true;
+ switch (xkb_current_group) {
+ case XCB_XKB_GROUP_1:
+ return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_1);
+ case XCB_XKB_GROUP_2:
+ return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2);
+ case XCB_XKB_GROUP_3:
+ return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3);
+ case XCB_XKB_GROUP_4:
+ return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4);
+ default:
+ ELOG("BUG: xkb_current_group (= %d) outside of [XCB_XKB_GROUP_1..XCB_XKB_GROUP_4]\n", xkb_current_group);
+ return false;
+ }
+}
+static void grab_keycode_for_binding(xcb_connection_t *conn, Binding *bind, uint32_t keycode) {
/* 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->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);
+ const int mods = (bind->event_state_mask & 0xFFFF);
+ DLOG("Binding %p Grabbing keycode %d with event state mask 0x%x (mods 0x%x)\n",
+ bind, keycode, bind->event_state_mask, mods);
GRAB_KEY(mods);
+ /* Also bind the key with active NumLock */
GRAB_KEY(mods | xcb_numlock_mask);
+ /* Also bind the key with active CapsLock */
GRAB_KEY(mods | XCB_MOD_MASK_LOCK);
+ /* Also bind the key with active NumLock+CapsLock */
GRAB_KEY(mods | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
}
if (bind->input_type != B_KEYBOARD)
continue;
+ if (!binding_in_current_group(bind))
+ continue;
+
/* The easy case: the user specified a keycode directly. */
if (bind->keycode > 0) {
grab_keycode_for_binding(conn, bind, bind->keycode);
continue;
}
- for (uint32_t i = 0; i < bind->number_keycodes; i++)
- grab_keycode_for_binding(conn, bind, bind->translated_to[i]);
+ struct Binding_Keycode *binding_keycode;
+ TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
+ const int keycode = binding_keycode->keycode;
+ const int mods = (binding_keycode->modifiers & 0xFFFF);
+ DLOG("Binding %p Grabbing keycode %d with mods %d\n", bind, keycode, mods);
+ xcb_grab_key(conn, 0, root, mods, keycode, XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC);
+ }
}
}
*
*/
void regrab_all_buttons(xcb_connection_t *conn) {
- bool grab_scrollwheel = bindings_should_grab_scrollwheel_buttons();
+ int *buttons = bindings_get_buttons_to_grab();
xcb_grab_server(conn);
Con *con;
continue;
xcb_ungrab_button(conn, XCB_BUTTON_INDEX_ANY, con->window->id, XCB_BUTTON_MASK_ANY);
- xcb_grab_buttons(conn, con->window->id, grab_scrollwheel);
+ xcb_grab_buttons(conn, con->window->id, buttons);
}
- /* Also grab the root window to allow bindings to work on there as well. */
- xcb_ungrab_button(conn, XCB_BUTTON_INDEX_ANY, root, XCB_BUTTON_MASK_ANY);
- xcb_grab_buttons(conn, root, grab_scrollwheel);
-
+ FREE(buttons);
xcb_ungrab_server(conn);
}
+static bool modifiers_match(const uint32_t modifiers_mask, const uint32_t modifiers_state) {
+ /* modifiers_mask is a special case: a value of 0 does not mean “match
+ * all”, but rather “match exactly when no modifiers are present”. */
+ if (modifiers_mask == 0) {
+ /* Verify no modifiers are pressed. A bitwise AND would lead to
+ * false positives, see issue #2002. */
+ return (modifiers_state == 0);
+ }
+ return ((modifiers_state & modifiers_mask) == modifiers_mask);
+}
+
/*
* Returns a pointer to the Binding with the specified modifiers and
* keycode or NULL if no such binding exists.
const uint32_t xkb_group_state = (state_filtered & 0xFFFF0000);
const uint32_t modifiers_state = (state_filtered & 0x0000FFFF);
TAILQ_FOREACH(bind, bindings, bindings) {
- const uint32_t xkb_group_mask = (bind->event_state_mask & 0xFFFF0000);
- /* modifiers_mask is a special case: a value of 0 does not mean “match all”,
- * but rather “match exactly when no modifiers are present”. */
- const uint32_t modifiers_mask = (bind->event_state_mask & 0x0000FFFF);
- const bool groups_match = ((xkb_group_state & xkb_group_mask) == xkb_group_mask);
- bool mods_match;
- if (modifiers_mask == 0) {
- /* Verify no modifiers are pressed. A bitwise AND would lead to
- * false positives, see issue #2002. */
- mods_match = (modifiers_state == 0);
- } else {
- mods_match = ((modifiers_state & modifiers_mask) == modifiers_mask);
- }
- const bool state_matches = (groups_match && mods_match);
-
- DLOG("binding groups_match = %s, mods_match = %s, state_matches = %s\n",
- (groups_match ? "yes" : "no"),
- (mods_match ? "yes" : "no"),
- (state_matches ? "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 (!state_matches &&
- (bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
- !is_release))
+
+ const uint32_t xkb_group_mask = (bind->event_state_mask & 0xFFFF0000);
+ const bool groups_match = ((xkb_group_state & xkb_group_mask) == xkb_group_mask);
+ if (!groups_match) {
+ DLOG("skipping binding %p because XKB groups do not match\n", bind);
continue;
+ }
/* For keyboard bindings where a symbol was specified by the user, we
* need to look in the array of translated keycodes for the event’s
* keycode */
if (input_type == B_KEYBOARD && bind->symbol != NULL) {
xcb_keycode_t input_keycode = (xcb_keycode_t)input_code;
- if (memmem(bind->translated_to,
- bind->number_keycodes * sizeof(xcb_keycode_t),
- &input_keycode, sizeof(xcb_keycode_t)) == NULL)
+ bool found_keycode = false;
+ struct Binding_Keycode *binding_keycode;
+ TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
+ const uint32_t modifiers_mask = (binding_keycode->modifiers & 0x0000FFFF);
+ const bool mods_match = modifiers_match(modifiers_mask, modifiers_state);
+ DLOG("binding_keycode->modifiers = %d, modifiers_mask = %d, modifiers_state = %d, mods_match = %s\n",
+ binding_keycode->modifiers, modifiers_mask, modifiers_state, (mods_match ? "yes" : "no"));
+ if (binding_keycode->keycode == input_keycode && mods_match) {
+ found_keycode = true;
+ break;
+ }
+ }
+ if (!found_keycode)
continue;
} else {
+ const uint32_t modifiers_mask = (bind->event_state_mask & 0x0000FFFF);
+ const bool mods_match = modifiers_match(modifiers_mask, modifiers_state);
+ DLOG("binding mods_match = %s\n", (mods_match ? "yes" : "no"));
+ /* First compare the state_filtered (unless this is a
+ * B_UPON_KEYRELEASE_IGNORE_MODS binding and this is a KeyRelease
+ * event) */
+ if (!mods_match &&
+ (bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
+ !is_release))
+ continue;
+
/* This case is easier: The user specified a keycode */
if (bind->keycode != input_code)
continue;
* user pressed. We therefore mark it as B_UPON_KEYRELEASE_IGNORE_MODS
* for later, so that the user can release the modifiers before the
* actual key or button and the release event will still be matched. */
- if (bind->release == B_UPON_KEYRELEASE && !is_release)
+ if (bind->release == B_UPON_KEYRELEASE && !is_release) {
bind->release = B_UPON_KEYRELEASE_IGNORE_MODS;
+ DLOG("marked bind %p as B_UPON_KEYRELEASE_IGNORE_MODS\n", bind);
+ /* The correct binding has been found, so abort the search, but
+ * also don’t return this binding, since it should not be executed
+ * yet (only when the keys are released). */
+ bind = TAILQ_END(bindings);
+ break;
+ }
/* Check if the binding is for a press or a release event */
if ((bind->release == B_UPON_KEYPRESS && is_release) ||
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);
+ /* Remove the CapsLock bit */
+ i3_event_state_mask_t state_filtered = event_state & ~XCB_MOD_MASK_LOCK;
+ DLOG("(removed capslock, 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|.
/* Like |xkb_state|, just without the shift modifier, if shift was specified. */
struct xkb_state *xkb_state_no_shift;
+
+ /* Like |xkb_state|, but with NumLock. */
+ struct xkb_state *xkb_state_numlock;
+
+ /* Like |xkb_state|, but with NumLock, just without the shift modifier, if shift was specified. */
+ struct xkb_state *xkb_state_numlock_no_shift;
};
/*
*/
static void add_keycode_if_matches(struct xkb_keymap *keymap, xkb_keycode_t key, void *data) {
const struct resolve *resolving = data;
+ struct xkb_state *numlock_state = resolving->xkb_state_numlock;
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
return;
if (xkb_state_key_get_level(resolving->xkb_state, key, layout) > 1)
return;
+ /* Skip the Shift fallback for keypad keys, otherwise one cannot bind
+ * KP_1 independent of KP_End. */
+ if (sym >= XKB_KEY_KP_Space && sym <= XKB_KEY_KP_Equal)
+ return;
+ numlock_state = resolving->xkb_state_numlock_no_shift;
sym = xkb_state_key_get_one_sym(resolving->xkb_state_no_shift, key);
if (sym != resolving->keysym)
return;
}
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;
+
+#define ADD_TRANSLATED_KEY(mods) \
+ do { \
+ struct Binding_Keycode *binding_keycode = smalloc(sizeof(struct Binding_Keycode)); \
+ binding_keycode->modifiers = (mods); \
+ binding_keycode->keycode = key; \
+ TAILQ_INSERT_TAIL(&(bind->keycodes_head), binding_keycode, keycodes); \
+ } while (0)
+
+ ADD_TRANSLATED_KEY(bind->event_state_mask);
+
+ /* Also bind the key with active CapsLock */
+ ADD_TRANSLATED_KEY(bind->event_state_mask | XCB_MOD_MASK_LOCK);
+
+ /* If this binding is not explicitly for NumLock, check whether we need to
+ * add a fallback. */
+ if ((bind->event_state_mask & xcb_numlock_mask) != xcb_numlock_mask) {
+ /* Check whether the keycode results in the same keysym when NumLock is
+ * active. If so, grab the key with NumLock as well, so that users don’t
+ * need to duplicate every key binding with an additional Mod2 specified.
+ */
+ xkb_keysym_t sym_numlock = xkb_state_key_get_one_sym(numlock_state, key);
+ if (sym_numlock == resolving->keysym) {
+ /* Also bind the key with active NumLock */
+ ADD_TRANSLATED_KEY(bind->event_state_mask | xcb_numlock_mask);
+
+ /* Also bind the key with active NumLock+CapsLock */
+ ADD_TRANSLATED_KEY(bind->event_state_mask | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
+ } else {
+ DLOG("Skipping automatic numlock fallback, key %d resolves to 0x%x with numlock\n",
+ key, sym_numlock);
+ }
+ }
+
+#undef ADD_TRANSLATED_KEY
}
/*
return;
}
+ struct xkb_state *dummy_state_numlock = xkb_state_new(xkb_keymap);
+ if (dummy_state_numlock == NULL) {
+ ELOG("Could not create XKB state, cannot translate keysyms.\n");
+ return;
+ }
+
+ struct xkb_state *dummy_state_numlock_no_shift = xkb_state_new(xkb_keymap);
+ if (dummy_state_numlock_no_shift == NULL) {
+ ELOG("Could not create XKB state, cannot translate keysyms.\n");
+ return;
+ }
+
bool has_errors = false;
Binding *bind;
TAILQ_FOREACH(bind, bindings, bindings) {
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,
+ DLOG("Binding %p group = %d, event_state_mask = %d, &2 = %s, &3 = %s, &4 = %s\n",
+ bind,
+ 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",
0 /* xkb_layout_index_t latched_group, */,
group /* xkb_layout_index_t locked_group, */);
+ (void)xkb_state_update_mask(
+ dummy_state_numlock,
+ (bind->event_state_mask & 0x1FFF) | xcb_numlock_mask /* 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_numlock_no_shift,
+ ((bind->event_state_mask & 0x1FFF) | xcb_numlock_mask) ^ 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,
+ .xkb_state_numlock = dummy_state_numlock,
+ .xkb_state_numlock_no_shift = dummy_state_numlock_no_shift,
};
- FREE(bind->translated_to);
- bind->number_keycodes = 0;
+ while (!TAILQ_EMPTY(&(bind->keycodes_head))) {
+ struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head));
+ TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes);
+ FREE(first);
+ }
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++) {
+ int num_keycodes = 0;
+ struct Binding_Keycode *binding_keycode;
+ TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
char *tmp;
- sasprintf(&tmp, "%s %d", keycodes, bind->translated_to[n]);
+ sasprintf(&tmp, "%s %d", keycodes, binding_keycode->keycode);
free(keycodes);
keycodes = tmp;
+ num_keycodes++;
/* check for duplicate bindings */
Binding *check;
continue;
if (check->symbol != NULL)
continue;
- if (check->keycode != bind->translated_to[n] ||
- check->event_state_mask != bind->event_state_mask ||
+ if (check->keycode != binding_keycode->keycode ||
+ check->event_state_mask != binding_keycode->modifiers ||
check->release != bind->release)
continue;
has_errors = true;
}
}
DLOG("state=0x%x, cfg=\"%s\", sym=0x%x → keycodes%s (%d)\n",
- bind->event_state_mask, bind->symbol, keysym, keycodes, bind->number_keycodes);
+ bind->event_state_mask, bind->symbol, keysym, keycodes, num_keycodes);
free(keycodes);
}
xkb_state_unref(dummy_state);
xkb_state_unref(dummy_state_no_shift);
+ xkb_state_unref(dummy_state_numlock);
+ xkb_state_unref(dummy_state_numlock_no_shift);
if (has_errors) {
start_config_error_nagbar(current_configpath, true);
ret->symbol = sstrdup(bind->symbol);
if (bind->command != NULL)
ret->command = sstrdup(bind->command);
- if (bind->translated_to != NULL) {
- ret->translated_to = smalloc(sizeof(xcb_keycode_t) * bind->number_keycodes);
- memcpy(ret->translated_to, bind->translated_to, sizeof(xcb_keycode_t) * bind->number_keycodes);
+ TAILQ_INIT(&(ret->keycodes_head));
+ struct Binding_Keycode *binding_keycode;
+ TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
+ struct Binding_Keycode *ret_binding_keycode = smalloc(sizeof(struct Binding_Keycode));
+ *ret_binding_keycode = *binding_keycode;
+ TAILQ_INSERT_TAIL(&(ret->keycodes_head), ret_binding_keycode, keycodes);
}
+
return ret;
}
return;
}
+ while (!TAILQ_EMPTY(&(bind->keycodes_head))) {
+ struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head));
+ TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes);
+ FREE(first);
+ }
+
FREE(bind->symbol);
- FREE(bind->translated_to);
FREE(bind->command);
FREE(bind);
}
}
/*
- * Returns true if the current config has any binding to a scroll wheel button
- * (4 or 5) which is a whole-window binding.
- * We need this to figure out whether we should grab all buttons or just 1-3
- * when managing a window. See #2049.
- *
+ * Returns a list of buttons that should be grabbed on a window.
+ * This list will always contain 1–3, all higher buttons will only be returned
+ * if there is a whole-window binding for it on some window in the current
+ * config.
+ * The list is terminated by a 0.
*/
-bool bindings_should_grab_scrollwheel_buttons(void) {
+int *bindings_get_buttons_to_grab(void) {
+ /* Let's make the reasonable assumption that there's no more than 25
+ * buttons. */
+ int num_max = 25;
+
+ int buffer[num_max];
+ int num = 0;
+
+ /* We always return buttons 1 through 3. */
+ buffer[num++] = 1;
+ buffer[num++] = 2;
+ buffer[num++] = 3;
+
Binding *bind;
TAILQ_FOREACH(bind, bindings, bindings) {
+ if (num + 1 == num_max)
+ break;
+
/* We are only interested in whole window mouse bindings. */
if (bind->input_type != B_MOUSE || !bind->whole_window)
continue;
continue;
}
- /* If the binding is for either scrollwheel button, we need to grab everything. */
- if (button == 4 || button == 5) {
- return true;
+ /* Avoid duplicates. */
+ for (int i = 0; i < num_max; i++) {
+ if (buffer[i] == button)
+ continue;
}
+
+ buffer[num++] = button;
}
+ buffer[num++] = 0;
+
+ int *buttons = scalloc(num, sizeof(int));
+ memcpy(buttons, buffer, num * sizeof(int));
- return false;
+ return buttons;
}