X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=src%2Fbindings.c;h=a0b876a44184966160d2798c6474ea6cfa54ced8;hb=959526314229c3bef26c8ca6316b91d3cff30d6c;hp=390ece7e4205e338dc89df54118d92d3f1af6c9f;hpb=ea514eb3d402ac6289dcba9e0a2f89922defa068;p=i3%2Fi3 diff --git a/src/bindings.c b/src/bindings.c index 390ece7e..a0b876a4 100644 --- a/src/bindings.c +++ b/src/bindings.c @@ -27,18 +27,20 @@ const char *DEFAULT_BINDING_MODE = "default"; * the list of modes. * */ -static struct Mode *mode_from_name(const char *name) { +static struct Mode *mode_from_name(const char *name, bool pango_markup) { struct Mode *mode; /* Try to find the mode in the list of modes and return it */ SLIST_FOREACH(mode, &modes, modes) { - if (strcmp(mode->name, name) == 0) + if (strcmp(mode->name, name) == 0) { return mode; + } } /* If the mode was not found, create a new one */ mode = scalloc(1, sizeof(struct Mode)); mode->name = sstrdup(name); + mode->pango_markup = pango_markup; mode->bindings = scalloc(1, sizeof(struct bindings_head)); TAILQ_INIT(mode->bindings); SLIST_INSERT_HEAD(&modes, mode, modes); @@ -54,12 +56,14 @@ static struct Mode *mode_from_name(const char *name) { */ Binding *configure_binding(const char *bindtype, const char *modifiers, const char *input_code, const char *release, const char *border, const char *whole_window, - const char *command, const char *modename) { + const char *exclude_titlebar, 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); + new_binding->exclude_titlebar = (exclude_titlebar != NULL); if (strcmp(bindtype, "bindsym") == 0) { new_binding->input_type = (strncasecmp(input_code, "button", (sizeof("button") - 1)) == 0 ? B_MOUSE @@ -67,60 +71,72 @@ Binding *configure_binding(const char *bindtype, const char *modifiers, const ch new_binding->symbol = sstrdup(input_code); } else { - char *endptr; - long keycode = strtol(input_code, &endptr, 10); - new_binding->keycode = keycode; - new_binding->input_type = B_KEYBOARD; - if (keycode == LONG_MAX || keycode == LONG_MIN || keycode < 0 || *endptr != '\0' || endptr == input_code) { + long keycode; + if (!parse_long(input_code, &keycode, 10)) { ELOG("Could not parse \"%s\" as an input code, ignoring this binding.\n", input_code); FREE(new_binding); return NULL; } + + new_binding->keycode = keycode; + new_binding->input_type = B_KEYBOARD; } 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) + if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_1) group_bits_set++; - if (new_binding->event_state_mask & I3_XKB_GROUP_MASK_2) + if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2) group_bits_set++; - if (new_binding->event_state_mask & I3_XKB_GROUP_MASK_3) + if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3) group_bits_set++; - if (new_binding->event_state_mask & I3_XKB_GROUP_MASK_4) + if ((new_binding->event_state_mask >> 16) & 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); + 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); } @@ -134,17 +150,47 @@ void grab_all_keys(xcb_connection_t *conn) { 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); + } } } +/* + * Release the button grabs on all managed windows and regrab them, + * reevaluating which buttons need to be grabbed. + * + */ +void regrab_all_buttons(xcb_connection_t *conn) { + int *buttons = bindings_get_buttons_to_grab(); + xcb_grab_server(conn); + + Con *con; + TAILQ_FOREACH(con, &all_cons, all_cons) { + if (con->window == NULL) + continue; + + xcb_ungrab_button(conn, XCB_BUTTON_INDEX_ANY, con->window->id, XCB_BUTTON_MASK_ANY); + xcb_grab_buttons(conn, con->window->id, buttons); + } + + FREE(buttons); + xcb_ungrab_server(conn); +} + /* * Returns a pointer to the Binding with the specified modifiers and * keycode or NULL if no such binding exists. @@ -152,6 +198,7 @@ void grab_all_keys(xcb_connection_t *conn) { */ 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; + Binding *result = NULL; if (!is_release) { /* On a press event, we first reset all B_UPON_KEYRELEASE_IGNORE_MODS @@ -164,51 +211,87 @@ static Binding *get_binding(i3_event_state_mask_t state_filtered, bool is_releas } } + const uint32_t xkb_group_state = (state_filtered & 0xFFFF0000); + const uint32_t modifiers_state = (state_filtered & 0x0000FFFF); TAILQ_FOREACH(bind, bindings, bindings) { - 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) + if (bind->input_type != input_type) { continue; - if ((state_filtered & bind->event_state_mask) != bind->event_state_mask && - (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 */ + bool found_keycode = false; 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) - continue; + 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_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 || (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS && is_release))) { + found_keycode = true; + break; + } + } } else { /* This case is easier: The user specified a keycode */ - if (bind->keycode != input_code) + if (bind->keycode != input_code) { continue; + } + + 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_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 (mods_match || (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS && is_release)) { + found_keycode = true; + break; + } + } + } + if (!found_keycode) { + continue; } /* If this binding is a release binding, it matches the key which the * 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); + if (result) { + break; + } + continue; + } /* Check if the binding is for a press or a release event */ - if ((bind->release == B_UPON_KEYPRESS && is_release) || - (bind->release >= B_UPON_KEYRELEASE && !is_release)) + if ((bind->release == B_UPON_KEYPRESS && is_release)) { continue; + } - break; + if (is_release) { + return bind; + } else if (!result) { + /* Continue looping to mark needed B_UPON_KEYRELEASE_IGNORE_MODS. */ + result = bind; + } } - return (bind == TAILQ_END(bindings) ? NULL : bind); + return result; } /* @@ -228,9 +311,9 @@ Binding *get_binding_from_xcb_event(xcb_generic_event_t *event) { 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|. @@ -239,7 +322,7 @@ Binding *get_binding_from_xcb_event(xcb_generic_event_t *event) { * 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 */ + * https://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); @@ -271,8 +354,22 @@ struct resolve { /* 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; }; +#define ADD_TRANSLATED_KEY(code, mods) \ + do { \ + struct Binding_Keycode *binding_keycode = smalloc(sizeof(struct Binding_Keycode)); \ + binding_keycode->modifiers = (mods); \ + binding_keycode->keycode = (code); \ + TAILQ_INSERT_TAIL(&(bind->keycodes_head), binding_keycode, keycodes); \ + } while (0) + /* * 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 @@ -281,6 +378,7 @@ struct resolve { */ 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 @@ -288,18 +386,43 @@ static void add_keycode_if_matches(struct xkb_keymap *keymap, xkb_keycode_t key, 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) + 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; + + ADD_TRANSLATED_KEY(key, bind->event_state_mask); + + /* Also bind the key with active CapsLock */ + ADD_TRANSLATED_KEY(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(key, bind->event_state_mask | xcb_numlock_mask); + + /* Also bind the key with active NumLock+CapsLock */ + ADD_TRANSLATED_KEY(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); + } + } } /* @@ -307,40 +430,31 @@ static void add_keycode_if_matches(struct xkb_keymap *keymap, xkb_keycode_t key, * */ void translate_keysyms(void) { - struct xkb_state *dummy_state = xkb_state_new(xkb_keymap); - if (dummy_state == NULL) { + struct xkb_state *dummy_state = NULL; + struct xkb_state *dummy_state_no_shift = NULL; + struct xkb_state *dummy_state_numlock = NULL; + struct xkb_state *dummy_state_numlock_no_shift = NULL; + bool has_errors = false; + + if ((dummy_state = xkb_state_new(xkb_keymap)) == NULL || + (dummy_state_no_shift = xkb_state_new(xkb_keymap)) == NULL || + (dummy_state_numlock = xkb_state_new(xkb_keymap)) == NULL || + (dummy_state_numlock_no_shift = xkb_state_new(xkb_keymap)) == NULL) { ELOG("Could not create XKB state, cannot translate keysyms.\n"); - return; - } - - 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; + goto out; } Binding *bind; TAILQ_FOREACH(bind, bindings, bindings) { if (bind->input_type == B_MOUSE) { - char *endptr; - long button = strtol(bind->symbol + (sizeof("button") - 1), &endptr, 10); - bind->keycode = button; - - if (button == LONG_MAX || button == LONG_MIN || button < 0 || *endptr != '\0' || endptr == bind->symbol) + long button; + if (!parse_long(bind->symbol + (sizeof("button") - 1), &button, 10)) { ELOG("Could not translate string to button: \"%s\"\n", bind->symbol); + } - continue; - } - - if (bind->keycode > 0) - continue; - - /* We need to translate the symbol to a keycode */ - 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; + xcb_keycode_t key = button; + bind->keycode = key; + DLOG("Binding Mouse button, Keycode = %d\n", key); } xkb_layout_index_t group = XCB_XKB_GROUP_1; @@ -351,7 +465,9 @@ void translate_keysyms(void) { 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", @@ -367,37 +483,134 @@ void translate_keysyms(void) { (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, */, + (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, */); + (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, */); + + if (bind->keycode > 0) { + /* We need to specify modifiers for the keycode binding (numlock + * fallback). */ + while (!TAILQ_EMPTY(&(bind->keycodes_head))) { + struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head)); + TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes); + FREE(first); + } + + ADD_TRANSLATED_KEY(bind->keycode, bind->event_state_mask); + + /* Also bind the key with active CapsLock */ + ADD_TRANSLATED_KEY(bind->keycode, 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 = xkb_state_key_get_one_sym(dummy_state, bind->keycode); + xkb_keysym_t sym_numlock = xkb_state_key_get_one_sym(dummy_state_numlock, bind->keycode); + if (sym == sym_numlock) { + /* Also bind the key with active NumLock */ + ADD_TRANSLATED_KEY(bind->keycode, bind->event_state_mask | xcb_numlock_mask); + + /* Also bind the key with active NumLock+CapsLock */ + ADD_TRANSLATED_KEY(bind->keycode, 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", + bind->keycode, sym_numlock); + } + } + + continue; + } + + /* We need to translate the symbol to a keycode */ + 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; + } + 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; + TAILQ_FOREACH(check, bindings, bindings) { + if (check == bind) + continue; + if (check->symbol != NULL) + continue; + if (check->keycode != binding_keycode->keycode || + check->event_state_mask != binding_keycode->modifiers || + check->release != bind->release) + continue; + has_errors = true; + ELOG("Duplicate keybinding in config file:\n keysym = %s, keycode = %d, state_mask = 0x%x\n", bind->symbol, check->keycode, bind->event_state_mask); + } } 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); } +out: 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); + } } +#undef ADD_TRANSLATED_KEY + /* * Switches the key bindings to the given mode, if the mode exists * @@ -416,8 +629,17 @@ void switch_mode(const char *new_mode) { translate_keysyms(); grab_all_keys(conn); + /* Reset all B_UPON_KEYRELEASE_IGNORE_MODS bindings to avoid possibly + * activating one of them. */ + Binding *bind; + TAILQ_FOREACH(bind, bindings, bindings) { + if (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS) + bind->release = B_UPON_KEYRELEASE; + } + char *event_msg; - sasprintf(&event_msg, "{\"change\":\"%s\"}", mode->name); + sasprintf(&event_msg, "{\"change\":\"%s\", \"pango_markup\":%s}", + mode->name, (mode->pango_markup ? "true" : "false")); ipc_send_event("mode", I3_IPC_EVENT_MODE, event_msg); FREE(event_msg); @@ -428,32 +650,41 @@ void switch_mode(const char *new_mode) { ELOG("ERROR: Mode not found\n"); } +static int reorder_binding_cmp(const void *a, const void *b) { + Binding *first = *((Binding **)a); + Binding *second = *((Binding **)b); + if (first->event_state_mask < second->event_state_mask) { + return 1; + } else if (first->event_state_mask == second->event_state_mask) { + return 0; + } else { + return -1; + } +} + static void reorder_bindings_of_mode(struct Mode *mode) { + /* Copy the bindings into an array, so that we can use qsort(3). */ + int n = 0; + Binding *current; + TAILQ_FOREACH(current, mode->bindings, bindings) { + n++; + } + Binding **tmp = scalloc(n, sizeof(Binding *)); + n = 0; + TAILQ_FOREACH(current, mode->bindings, bindings) { + tmp[n++] = current; + } + + qsort(tmp, n, sizeof(Binding *), reorder_binding_cmp); + 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); + for (int i = 0; i < n; i++) { + current = tmp[i]; + TAILQ_REMOVE(mode->bindings, current, bindings); + TAILQ_INSERT_TAIL(reordered, current, bindings); } + free(tmp); assert(TAILQ_EMPTY(mode->bindings)); /* Free the old bindings_head, which is now empty. */ free(mode->bindings); @@ -505,8 +736,6 @@ void check_for_duplicate_bindings(struct context *context) { /* Check if one is using keysym while the other is using bindsym. * If so, skip. */ - /* XXX: It should be checked at a later place (when translating the - * keysym to keycodes) if there are any duplicates */ if ((bind->symbol == NULL && current->symbol != NULL) || (bind->symbol != NULL && current->symbol == NULL)) continue; @@ -546,10 +775,14 @@ static Binding *binding_copy(Binding *bind) { 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; } @@ -561,8 +794,13 @@ void binding_free(Binding *bind) { 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); } @@ -570,8 +808,8 @@ void binding_free(Binding *bind) { /* * Runs the given binding and handles parse errors. If con is passed, it will * execute the command binding with that container selected by criteria. - * Returns a CommandResult for running the binding's command. Caller should - * render tree if needs_tree_render is true. Free with command_result_free(). + * Returns a CommandResult for running the binding's command. Free with + * command_result_free(). * */ CommandResult *run_binding(Binding *bind, Con *con) { @@ -617,6 +855,77 @@ CommandResult *run_binding(Binding *bind, Con *con) { return result; } +static int fill_rmlvo_from_root(struct xkb_rule_names *xkb_names) { + xcb_intern_atom_reply_t *atom_reply; + size_t content_max_words = 256; + + xcb_window_t root = root_screen->root; + + atom_reply = xcb_intern_atom_reply( + conn, xcb_intern_atom(conn, 0, strlen("_XKB_RULES_NAMES"), "_XKB_RULES_NAMES"), NULL); + if (atom_reply == NULL) + return -1; + + xcb_get_property_cookie_t prop_cookie; + xcb_get_property_reply_t *prop_reply; + prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom, + XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words); + prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL); + if (prop_reply == NULL) { + free(atom_reply); + return -1; + } + if (xcb_get_property_value_length(prop_reply) > 0 && prop_reply->bytes_after > 0) { + /* We received an incomplete value. Ask again but with a properly + * adjusted size. */ + content_max_words += ceil(prop_reply->bytes_after / 4.0); + /* Repeat the request, with adjusted size */ + free(prop_reply); + prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom, + XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words); + prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL); + if (prop_reply == NULL) { + free(atom_reply); + return -1; + } + } + if (xcb_get_property_value_length(prop_reply) == 0) { + free(atom_reply); + free(prop_reply); + return -1; + } + + const char *walk = (const char *)xcb_get_property_value(prop_reply); + int remaining = xcb_get_property_value_length(prop_reply); + for (int i = 0; i < 5 && remaining > 0; i++) { + const int len = strnlen(walk, remaining); + switch (i) { + case 0: + sasprintf((char **)&(xkb_names->rules), "%.*s", len, walk); + break; + case 1: + sasprintf((char **)&(xkb_names->model), "%.*s", len, walk); + break; + case 2: + sasprintf((char **)&(xkb_names->layout), "%.*s", len, walk); + break; + case 3: + sasprintf((char **)&(xkb_names->variant), "%.*s", len, walk); + break; + case 4: + sasprintf((char **)&(xkb_names->options), "%.*s", len, walk); + break; + } + DLOG("component %d of _XKB_RULES_NAMES is \"%.*s\"\n", i, len, walk); + walk += (len + 1); + remaining -= (len + 1); + } + + free(atom_reply); + free(prop_reply); + return 0; +} + /* * Loads the XKB keymap from the X11 server and feeds it to xkbcommon. * @@ -629,15 +938,91 @@ bool load_keymap(void) { } } - 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; + struct xkb_keymap *new_keymap = NULL; + int32_t device_id; + if (xkb_supported && (device_id = xkb_x11_get_core_keyboard_device_id(conn)) > -1) { + 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; + } + } else { + /* Likely there is no XKB support on this server, possibly because it + * is a VNC server. */ + LOG("No XKB / core keyboard device? Assembling keymap from local RMLVO.\n"); + struct xkb_rule_names names = { + .rules = NULL, + .model = NULL, + .layout = NULL, + .variant = NULL, + .options = NULL}; + if (fill_rmlvo_from_root(&names) == -1) { + ELOG("Could not get _XKB_RULES_NAMES atom from root window, falling back to defaults.\n"); + /* Using NULL for the fields of xkb_rule_names. */ + } + new_keymap = xkb_keymap_new_from_names(xkb_context, &names, 0); + free((char *)names.rules); + free((char *)names.model); + free((char *)names.layout); + free((char *)names.variant); + free((char *)names.options); + if (new_keymap == NULL) { + ELOG("xkb_keymap_new_from_names failed\n"); + return false; + } } xkb_keymap_unref(xkb_keymap); xkb_keymap = new_keymap; return true; } + +/* + * 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. + */ +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; + + long button; + if (!parse_long(bind->symbol + (sizeof("button") - 1), &button, 10)) { + ELOG("Could not parse button number, skipping this binding. Please report this bug in i3.\n"); + continue; + } + + /* Avoid duplicates. */ + for (int i = 0; i < num; 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 buttons; +}