2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * bindings.c: Functions for configuring, finding and, running bindings.
11 #include <xkbcommon/xkbcommon.h>
12 #include <xkbcommon/xkbcommon-x11.h>
14 static struct xkb_context *xkb_context;
15 static struct xkb_keymap *xkb_keymap;
17 pid_t command_error_nagbar_pid = -1;
20 * The name of the default mode.
23 const char *DEFAULT_BINDING_MODE = "default";
26 * Returns the mode specified by `name` or creates a new mode and adds it to
30 static struct Mode *mode_from_name(const char *name, bool pango_markup) {
33 /* Try to find the mode in the list of modes and return it */
34 SLIST_FOREACH(mode, &modes, modes) {
35 if (strcmp(mode->name, name) == 0) {
40 /* If the mode was not found, create a new one */
41 mode = scalloc(1, sizeof(struct Mode));
42 mode->name = sstrdup(name);
43 mode->pango_markup = pango_markup;
44 mode->bindings = scalloc(1, sizeof(struct bindings_head));
45 TAILQ_INIT(mode->bindings);
46 SLIST_INSERT_HEAD(&modes, mode, modes);
52 * Adds a binding from config parameters given as strings and returns a
53 * pointer to the binding structure. Returns NULL if the input code could not
57 Binding *configure_binding(const char *bindtype, const char *modifiers, const char *input_code,
58 const char *release, const char *border, const char *whole_window,
59 const char *command, const char *modename, bool pango_markup) {
60 Binding *new_binding = scalloc(1, sizeof(Binding));
61 DLOG("Binding %p bindtype %s, modifiers %s, input code %s, release %s\n", new_binding, bindtype, modifiers, input_code, release);
62 new_binding->release = (release != NULL ? B_UPON_KEYRELEASE : B_UPON_KEYPRESS);
63 new_binding->border = (border != NULL);
64 new_binding->whole_window = (whole_window != NULL);
65 if (strcmp(bindtype, "bindsym") == 0) {
66 new_binding->input_type = (strncasecmp(input_code, "button", (sizeof("button") - 1)) == 0
70 new_binding->symbol = sstrdup(input_code);
73 long keycode = strtol(input_code, &endptr, 10);
74 new_binding->keycode = keycode;
75 new_binding->input_type = B_KEYBOARD;
76 if (keycode == LONG_MAX || keycode == LONG_MIN || keycode < 0 || *endptr != '\0' || endptr == input_code) {
77 ELOG("Could not parse \"%s\" as an input code, ignoring this binding.\n", input_code);
82 new_binding->command = sstrdup(command);
83 new_binding->event_state_mask = event_state_from_str(modifiers);
84 int group_bits_set = 0;
85 if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_1)
87 if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2)
89 if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3)
91 if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4)
93 if (group_bits_set > 1)
94 ELOG("Keybinding has more than one Group specified, but your X server is always in precisely one group. The keybinding can never trigger.\n");
96 struct Mode *mode = mode_from_name(modename, pango_markup);
97 TAILQ_INSERT_TAIL(mode->bindings, new_binding, bindings);
99 TAILQ_INIT(&(new_binding->keycodes_head));
104 static bool binding_in_current_group(const Binding *bind) {
105 /* If no bits are set, the binding should be installed in every group. */
106 if ((bind->event_state_mask >> 16) == I3_XKB_GROUP_MASK_ANY)
108 switch (xkb_current_group) {
109 case XCB_XKB_GROUP_1:
110 return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_1);
111 case XCB_XKB_GROUP_2:
112 return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2);
113 case XCB_XKB_GROUP_3:
114 return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3);
115 case XCB_XKB_GROUP_4:
116 return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4);
118 ELOG("BUG: xkb_current_group (= %d) outside of [XCB_XKB_GROUP_1..XCB_XKB_GROUP_4]\n", xkb_current_group);
123 static void grab_keycode_for_binding(xcb_connection_t *conn, Binding *bind, uint32_t keycode) {
124 /* Grab the key in all combinations */
125 #define GRAB_KEY(modifier) \
127 xcb_grab_key(conn, 0, root, modifier, keycode, XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC); \
129 const int mods = (bind->event_state_mask & 0xFFFF);
130 DLOG("Binding %p Grabbing keycode %d with event state mask 0x%x (mods 0x%x)\n",
131 bind, keycode, bind->event_state_mask, mods);
133 /* Also bind the key with active NumLock */
134 GRAB_KEY(mods | xcb_numlock_mask);
135 /* Also bind the key with active CapsLock */
136 GRAB_KEY(mods | XCB_MOD_MASK_LOCK);
137 /* Also bind the key with active NumLock+CapsLock */
138 GRAB_KEY(mods | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
142 * Grab the bound keys (tell X to send us keypress events for those keycodes)
145 void grab_all_keys(xcb_connection_t *conn) {
147 TAILQ_FOREACH(bind, bindings, bindings) {
148 if (bind->input_type != B_KEYBOARD)
151 if (!binding_in_current_group(bind))
154 /* The easy case: the user specified a keycode directly. */
155 if (bind->keycode > 0) {
156 grab_keycode_for_binding(conn, bind, bind->keycode);
160 struct Binding_Keycode *binding_keycode;
161 TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
162 const int keycode = binding_keycode->keycode;
163 const int mods = (binding_keycode->modifiers & 0xFFFF);
164 DLOG("Binding %p Grabbing keycode %d with mods %d\n", bind, keycode, mods);
165 xcb_grab_key(conn, 0, root, mods, keycode, XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC);
171 * Release the button grabs on all managed windows and regrab them,
172 * reevaluating which buttons need to be grabbed.
175 void regrab_all_buttons(xcb_connection_t *conn) {
176 int *buttons = bindings_get_buttons_to_grab();
177 xcb_grab_server(conn);
180 TAILQ_FOREACH(con, &all_cons, all_cons) {
181 if (con->window == NULL)
184 xcb_ungrab_button(conn, XCB_BUTTON_INDEX_ANY, con->window->id, XCB_BUTTON_MASK_ANY);
185 xcb_grab_buttons(conn, con->window->id, buttons);
189 xcb_ungrab_server(conn);
192 static bool modifiers_match(const uint32_t modifiers_mask, const uint32_t modifiers_state) {
193 /* modifiers_mask is a special case: a value of 0 does not mean “match
194 * all”, but rather “match exactly when no modifiers are present”. */
195 if (modifiers_mask == 0) {
196 /* Verify no modifiers are pressed. A bitwise AND would lead to
197 * false positives, see issue #2002. */
198 return (modifiers_state == 0);
200 return ((modifiers_state & modifiers_mask) == modifiers_mask);
204 * Returns a pointer to the Binding with the specified modifiers and
205 * keycode or NULL if no such binding exists.
208 static Binding *get_binding(i3_event_state_mask_t state_filtered, bool is_release, uint16_t input_code, input_type_t input_type) {
212 /* On a press event, we first reset all B_UPON_KEYRELEASE_IGNORE_MODS
213 * bindings back to B_UPON_KEYRELEASE */
214 TAILQ_FOREACH(bind, bindings, bindings) {
215 if (bind->input_type != input_type)
217 if (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS)
218 bind->release = B_UPON_KEYRELEASE;
222 const uint32_t xkb_group_state = (state_filtered & 0xFFFF0000);
223 const uint32_t modifiers_state = (state_filtered & 0x0000FFFF);
224 TAILQ_FOREACH(bind, bindings, bindings) {
225 if (bind->input_type != input_type)
228 const uint32_t xkb_group_mask = (bind->event_state_mask & 0xFFFF0000);
229 const bool groups_match = ((xkb_group_state & xkb_group_mask) == xkb_group_mask);
231 DLOG("skipping binding %p because XKB groups do not match\n", bind);
235 /* For keyboard bindings where a symbol was specified by the user, we
236 * need to look in the array of translated keycodes for the event’s
238 if (input_type == B_KEYBOARD && bind->symbol != NULL) {
239 xcb_keycode_t input_keycode = (xcb_keycode_t)input_code;
240 bool found_keycode = false;
241 struct Binding_Keycode *binding_keycode;
242 TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
243 const uint32_t modifiers_mask = (binding_keycode->modifiers & 0x0000FFFF);
244 const bool mods_match = modifiers_match(modifiers_mask, modifiers_state);
245 DLOG("binding_keycode->modifiers = %d, modifiers_mask = %d, modifiers_state = %d, mods_match = %s\n",
246 binding_keycode->modifiers, modifiers_mask, modifiers_state, (mods_match ? "yes" : "no"));
247 if (binding_keycode->keycode == input_keycode && mods_match) {
248 found_keycode = true;
255 const uint32_t modifiers_mask = (bind->event_state_mask & 0x0000FFFF);
256 const bool mods_match = modifiers_match(modifiers_mask, modifiers_state);
257 DLOG("binding mods_match = %s\n", (mods_match ? "yes" : "no"));
258 /* First compare the state_filtered (unless this is a
259 * B_UPON_KEYRELEASE_IGNORE_MODS binding and this is a KeyRelease
262 (bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
266 /* This case is easier: The user specified a keycode */
267 if (bind->keycode != input_code)
271 /* If this binding is a release binding, it matches the key which the
272 * user pressed. We therefore mark it as B_UPON_KEYRELEASE_IGNORE_MODS
273 * for later, so that the user can release the modifiers before the
274 * actual key or button and the release event will still be matched. */
275 if (bind->release == B_UPON_KEYRELEASE && !is_release) {
276 bind->release = B_UPON_KEYRELEASE_IGNORE_MODS;
277 DLOG("marked bind %p as B_UPON_KEYRELEASE_IGNORE_MODS\n", bind);
278 /* The correct binding has been found, so abort the search, but
279 * also don’t return this binding, since it should not be executed
280 * yet (only when the keys are released). */
281 bind = TAILQ_END(bindings);
285 /* Check if the binding is for a press or a release event */
286 if ((bind->release == B_UPON_KEYPRESS && is_release) ||
287 (bind->release >= B_UPON_KEYRELEASE && !is_release))
293 return (bind == TAILQ_END(bindings) ? NULL : bind);
297 * Returns a pointer to the Binding that matches the given xcb button or key
298 * event or NULL if no such binding exists.
301 Binding *get_binding_from_xcb_event(xcb_generic_event_t *event) {
302 const bool is_release = (event->response_type == XCB_KEY_RELEASE ||
303 event->response_type == XCB_BUTTON_RELEASE);
305 const input_type_t input_type = ((event->response_type == XCB_BUTTON_RELEASE ||
306 event->response_type == XCB_BUTTON_PRESS)
310 const uint16_t event_state = ((xcb_key_press_event_t *)event)->state;
311 const uint16_t event_detail = ((xcb_key_press_event_t *)event)->detail;
313 /* Remove the CapsLock bit */
314 i3_event_state_mask_t state_filtered = event_state & ~XCB_MOD_MASK_LOCK;
315 DLOG("(removed capslock, state = 0x%x)\n", state_filtered);
316 /* Transform the keyboard_group from bit 13 and bit 14 into an
317 * i3_xkb_group_mask_t, so that get_binding() can just bitwise AND the
318 * configured bindings against |state_filtered|.
320 * These bits are only set because we set the XKB client flags
321 * XCB_XKB_PER_CLIENT_FLAG_GRABS_USE_XKB_STATE and
322 * XCB_XKB_PER_CLIENT_FLAG_LOOKUP_STATE_WHEN_GRABBED. See also doc/kbproto
324 * http://www.x.org/releases/X11R7.7/doc/kbproto/xkbproto.html#Computing_A_State_Field_from_an_XKB_State */
325 switch ((event_state & 0x6000) >> 13) {
326 case XCB_XKB_GROUP_1:
327 state_filtered |= (I3_XKB_GROUP_MASK_1 << 16);
329 case XCB_XKB_GROUP_2:
330 state_filtered |= (I3_XKB_GROUP_MASK_2 << 16);
332 case XCB_XKB_GROUP_3:
333 state_filtered |= (I3_XKB_GROUP_MASK_3 << 16);
335 case XCB_XKB_GROUP_4:
336 state_filtered |= (I3_XKB_GROUP_MASK_4 << 16);
339 state_filtered &= ~0x6000;
340 DLOG("(transformed keyboard group, state = 0x%x)\n", state_filtered);
341 return get_binding(state_filtered, is_release, event_detail, input_type);
345 /* The binding which we are resolving. */
348 /* |bind|’s keysym (translated to xkb_keysym_t), e.g. XKB_KEY_R. */
351 /* The xkb state built from the user-provided modifiers and group. */
352 struct xkb_state *xkb_state;
354 /* Like |xkb_state|, just without the shift modifier, if shift was specified. */
355 struct xkb_state *xkb_state_no_shift;
357 /* Like |xkb_state|, but with NumLock. */
358 struct xkb_state *xkb_state_numlock;
360 /* Like |xkb_state|, but with NumLock, just without the shift modifier, if shift was specified. */
361 struct xkb_state *xkb_state_numlock_no_shift;
365 * add_keycode_if_matches is called for each keycode in the keymap and will add
366 * the keycode to |data->bind| if the keycode can result in the keysym
370 static void add_keycode_if_matches(struct xkb_keymap *keymap, xkb_keycode_t key, void *data) {
371 const struct resolve *resolving = data;
372 struct xkb_state *numlock_state = resolving->xkb_state_numlock;
373 xkb_keysym_t sym = xkb_state_key_get_one_sym(resolving->xkb_state, key);
374 if (sym != resolving->keysym) {
375 /* Check if Shift was specified, and try resolving the symbol without
376 * shift, so that “bindsym $mod+Shift+a nop” actually works. */
377 const xkb_layout_index_t layout = xkb_state_key_get_layout(resolving->xkb_state, key);
378 if (layout == XKB_LAYOUT_INVALID)
380 if (xkb_state_key_get_level(resolving->xkb_state, key, layout) > 1)
382 /* Skip the Shift fallback for keypad keys, otherwise one cannot bind
383 * KP_1 independent of KP_End. */
384 if (sym >= XKB_KEY_KP_Space && sym <= XKB_KEY_KP_Equal)
386 numlock_state = resolving->xkb_state_numlock_no_shift;
387 sym = xkb_state_key_get_one_sym(resolving->xkb_state_no_shift, key);
388 if (sym != resolving->keysym)
391 Binding *bind = resolving->bind;
393 #define ADD_TRANSLATED_KEY(mods) \
395 struct Binding_Keycode *binding_keycode = smalloc(sizeof(struct Binding_Keycode)); \
396 binding_keycode->modifiers = (mods); \
397 binding_keycode->keycode = key; \
398 TAILQ_INSERT_TAIL(&(bind->keycodes_head), binding_keycode, keycodes); \
401 ADD_TRANSLATED_KEY(bind->event_state_mask);
403 /* Also bind the key with active CapsLock */
404 ADD_TRANSLATED_KEY(bind->event_state_mask | XCB_MOD_MASK_LOCK);
406 /* If this binding is not explicitly for NumLock, check whether we need to
408 if ((bind->event_state_mask & xcb_numlock_mask) != xcb_numlock_mask) {
409 /* Check whether the keycode results in the same keysym when NumLock is
410 * active. If so, grab the key with NumLock as well, so that users don’t
411 * need to duplicate every key binding with an additional Mod2 specified.
413 xkb_keysym_t sym_numlock = xkb_state_key_get_one_sym(numlock_state, key);
414 if (sym_numlock == resolving->keysym) {
415 /* Also bind the key with active NumLock */
416 ADD_TRANSLATED_KEY(bind->event_state_mask | xcb_numlock_mask);
418 /* Also bind the key with active NumLock+CapsLock */
419 ADD_TRANSLATED_KEY(bind->event_state_mask | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
421 DLOG("Skipping automatic numlock fallback, key %d resolves to 0x%x with numlock\n",
426 #undef ADD_TRANSLATED_KEY
430 * Translates keysymbols to keycodes for all bindings which use keysyms.
433 void translate_keysyms(void) {
434 struct xkb_state *dummy_state = xkb_state_new(xkb_keymap);
435 if (dummy_state == NULL) {
436 ELOG("Could not create XKB state, cannot translate keysyms.\n");
440 struct xkb_state *dummy_state_no_shift = xkb_state_new(xkb_keymap);
441 if (dummy_state_no_shift == NULL) {
442 ELOG("Could not create XKB state, cannot translate keysyms.\n");
446 struct xkb_state *dummy_state_numlock = xkb_state_new(xkb_keymap);
447 if (dummy_state_numlock == NULL) {
448 ELOG("Could not create XKB state, cannot translate keysyms.\n");
452 struct xkb_state *dummy_state_numlock_no_shift = xkb_state_new(xkb_keymap);
453 if (dummy_state_numlock_no_shift == NULL) {
454 ELOG("Could not create XKB state, cannot translate keysyms.\n");
458 bool has_errors = false;
460 TAILQ_FOREACH(bind, bindings, bindings) {
461 if (bind->input_type == B_MOUSE) {
463 long button = strtol(bind->symbol + (sizeof("button") - 1), &endptr, 10);
464 bind->keycode = button;
466 if (button == LONG_MAX || button == LONG_MIN || button < 0 || *endptr != '\0' || endptr == bind->symbol)
467 ELOG("Could not translate string to button: \"%s\"\n", bind->symbol);
472 if (bind->keycode > 0)
475 /* We need to translate the symbol to a keycode */
476 const xkb_keysym_t keysym = xkb_keysym_from_name(bind->symbol, XKB_KEYSYM_NO_FLAGS);
477 if (keysym == XKB_KEY_NoSymbol) {
478 ELOG("Could not translate string to key symbol: \"%s\"\n",
483 xkb_layout_index_t group = XCB_XKB_GROUP_1;
484 if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2)
485 group = XCB_XKB_GROUP_2;
486 else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3)
487 group = XCB_XKB_GROUP_3;
488 else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4)
489 group = XCB_XKB_GROUP_4;
491 DLOG("Binding %p group = %d, event_state_mask = %d, &2 = %s, &3 = %s, &4 = %s\n",
494 bind->event_state_mask,
495 (bind->event_state_mask & I3_XKB_GROUP_MASK_2) ? "yes" : "no",
496 (bind->event_state_mask & I3_XKB_GROUP_MASK_3) ? "yes" : "no",
497 (bind->event_state_mask & I3_XKB_GROUP_MASK_4) ? "yes" : "no");
498 (void)xkb_state_update_mask(
500 (bind->event_state_mask & 0x1FFF) /* xkb_mod_mask_t base_mods, */,
501 0 /* xkb_mod_mask_t latched_mods, */,
502 0 /* xkb_mod_mask_t locked_mods, */,
503 0 /* xkb_layout_index_t base_group, */,
504 0 /* xkb_layout_index_t latched_group, */,
505 group /* xkb_layout_index_t locked_group, */);
507 (void)xkb_state_update_mask(
508 dummy_state_no_shift,
509 (bind->event_state_mask & 0x1FFF) ^ XCB_KEY_BUT_MASK_SHIFT /* xkb_mod_mask_t base_mods, */,
510 0 /* xkb_mod_mask_t latched_mods, */,
511 0 /* xkb_mod_mask_t locked_mods, */,
512 0 /* xkb_layout_index_t base_group, */,
513 0 /* xkb_layout_index_t latched_group, */,
514 group /* xkb_layout_index_t locked_group, */);
516 (void)xkb_state_update_mask(
518 (bind->event_state_mask & 0x1FFF) | xcb_numlock_mask /* xkb_mod_mask_t base_mods, */,
519 0 /* xkb_mod_mask_t latched_mods, */,
520 0 /* xkb_mod_mask_t locked_mods, */,
521 0 /* xkb_layout_index_t base_group, */,
522 0 /* xkb_layout_index_t latched_group, */,
523 group /* xkb_layout_index_t locked_group, */);
525 (void)xkb_state_update_mask(
526 dummy_state_numlock_no_shift,
527 ((bind->event_state_mask & 0x1FFF) | xcb_numlock_mask) ^ XCB_KEY_BUT_MASK_SHIFT /* xkb_mod_mask_t base_mods, */,
528 0 /* xkb_mod_mask_t latched_mods, */,
529 0 /* xkb_mod_mask_t locked_mods, */,
530 0 /* xkb_layout_index_t base_group, */,
531 0 /* xkb_layout_index_t latched_group, */,
532 group /* xkb_layout_index_t locked_group, */);
534 struct resolve resolving = {
537 .xkb_state = dummy_state,
538 .xkb_state_no_shift = dummy_state_no_shift,
539 .xkb_state_numlock = dummy_state_numlock,
540 .xkb_state_numlock_no_shift = dummy_state_numlock_no_shift,
542 while (!TAILQ_EMPTY(&(bind->keycodes_head))) {
543 struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head));
544 TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes);
547 xkb_keymap_key_for_each(xkb_keymap, add_keycode_if_matches, &resolving);
548 char *keycodes = sstrdup("");
549 int num_keycodes = 0;
550 struct Binding_Keycode *binding_keycode;
551 TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
553 sasprintf(&tmp, "%s %d", keycodes, binding_keycode->keycode);
558 /* check for duplicate bindings */
560 TAILQ_FOREACH(check, bindings, bindings) {
563 if (check->symbol != NULL)
565 if (check->keycode != binding_keycode->keycode ||
566 check->event_state_mask != binding_keycode->modifiers ||
567 check->release != bind->release)
570 ELOG("Duplicate keybinding in config file:\n keysym = %s, keycode = %d, state_mask = 0x%x\n", bind->symbol, check->keycode, bind->event_state_mask);
573 DLOG("state=0x%x, cfg=\"%s\", sym=0x%x → keycodes%s (%d)\n",
574 bind->event_state_mask, bind->symbol, keysym, keycodes, num_keycodes);
578 xkb_state_unref(dummy_state);
579 xkb_state_unref(dummy_state_no_shift);
580 xkb_state_unref(dummy_state_numlock);
581 xkb_state_unref(dummy_state_numlock_no_shift);
584 start_config_error_nagbar(current_configpath, true);
589 * Switches the key bindings to the given mode, if the mode exists
592 void switch_mode(const char *new_mode) {
595 DLOG("Switching to mode %s\n", new_mode);
597 SLIST_FOREACH(mode, &modes, modes) {
598 if (strcasecmp(mode->name, new_mode) != 0)
601 ungrab_all_keys(conn);
602 bindings = mode->bindings;
607 sasprintf(&event_msg, "{\"change\":\"%s\", \"pango_markup\":%s}",
608 mode->name, (mode->pango_markup ? "true" : "false"));
610 ipc_send_event("mode", I3_IPC_EVENT_MODE, event_msg);
616 ELOG("ERROR: Mode not found\n");
619 static int reorder_binding_cmp(const void *a, const void *b) {
620 Binding *first = *((Binding **)a);
621 Binding *second = *((Binding **)b);
622 if (first->event_state_mask < second->event_state_mask) {
624 } else if (first->event_state_mask == second->event_state_mask) {
631 static void reorder_bindings_of_mode(struct Mode *mode) {
632 /* Copy the bindings into an array, so that we can use qsort(3). */
635 TAILQ_FOREACH(current, mode->bindings, bindings) {
638 Binding **tmp = scalloc(n, sizeof(Binding *));
640 TAILQ_FOREACH(current, mode->bindings, bindings) {
644 qsort(tmp, n, sizeof(Binding *), reorder_binding_cmp);
646 struct bindings_head *reordered = scalloc(1, sizeof(struct bindings_head));
647 TAILQ_INIT(reordered);
648 for (int i = 0; i < n; i++) {
650 TAILQ_REMOVE(mode->bindings, current, bindings);
651 TAILQ_INSERT_TAIL(reordered, current, bindings);
654 assert(TAILQ_EMPTY(mode->bindings));
655 /* Free the old bindings_head, which is now empty. */
656 free(mode->bindings);
657 mode->bindings = reordered;
661 * Reorders bindings by event_state_mask descendingly so that get_binding()
662 * correctly matches more specific bindings before more generic bindings. Take
663 * the following binding configuration as an example:
665 * bindsym n nop lower-case n pressed
666 * bindsym Shift+n nop upper-case n pressed
668 * Without reordering, the first binding’s event_state_mask of 0x0 would match
669 * the actual event_stat_mask of 0x1 and hence trigger instead of the second
673 void reorder_bindings(void) {
675 SLIST_FOREACH(mode, &modes, modes) {
676 const bool current_mode = (mode->bindings == bindings);
677 reorder_bindings_of_mode(mode);
679 bindings = mode->bindings;
684 * Checks for duplicate key bindings (the same keycode or keysym is configured
685 * more than once). If a duplicate binding is found, a message is printed to
686 * stderr and the has_errors variable is set to true, which will start
690 void check_for_duplicate_bindings(struct context *context) {
691 Binding *bind, *current;
692 TAILQ_FOREACH(current, bindings, bindings) {
693 TAILQ_FOREACH(bind, bindings, bindings) {
694 /* Abort when we reach the current keybinding, only check the
699 /* Check if the input types are different */
700 if (bind->input_type != current->input_type)
703 /* Check if one is using keysym while the other is using bindsym.
705 if ((bind->symbol == NULL && current->symbol != NULL) ||
706 (bind->symbol != NULL && current->symbol == NULL))
709 /* If bind is NULL, current has to be NULL, too (see above).
710 * If the keycodes differ, it can't be a duplicate. */
711 if (bind->symbol != NULL &&
712 strcasecmp(bind->symbol, current->symbol) != 0)
715 /* Check if the keycodes or modifiers are different. If so, they
716 * can't be duplicate */
717 if (bind->keycode != current->keycode ||
718 bind->event_state_mask != current->event_state_mask ||
719 bind->release != current->release)
722 context->has_errors = true;
723 if (current->keycode != 0) {
724 ELOG("Duplicate keybinding in config file:\n state mask 0x%x with keycode %d, command \"%s\"\n",
725 current->event_state_mask, current->keycode, current->command);
727 ELOG("Duplicate keybinding in config file:\n state mask 0x%x with keysym %s, command \"%s\"\n",
728 current->event_state_mask, current->symbol, current->command);
735 * Creates a dynamically allocated copy of bind.
737 static Binding *binding_copy(Binding *bind) {
738 Binding *ret = smalloc(sizeof(Binding));
740 if (bind->symbol != NULL)
741 ret->symbol = sstrdup(bind->symbol);
742 if (bind->command != NULL)
743 ret->command = sstrdup(bind->command);
744 TAILQ_INIT(&(ret->keycodes_head));
745 struct Binding_Keycode *binding_keycode;
746 TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
747 struct Binding_Keycode *ret_binding_keycode = smalloc(sizeof(struct Binding_Keycode));
748 *ret_binding_keycode = *binding_keycode;
749 TAILQ_INSERT_TAIL(&(ret->keycodes_head), ret_binding_keycode, keycodes);
756 * Frees the binding. If bind is null, it simply returns.
758 void binding_free(Binding *bind) {
763 while (!TAILQ_EMPTY(&(bind->keycodes_head))) {
764 struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head));
765 TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes);
775 * Runs the given binding and handles parse errors. If con is passed, it will
776 * execute the command binding with that container selected by criteria.
777 * Returns a CommandResult for running the binding's command. Free with
778 * command_result_free().
781 CommandResult *run_binding(Binding *bind, Con *con) {
784 /* We need to copy the binding and command since “reload” may be part of
785 * the command, and then the memory that bind points to may not contain the
786 * same data anymore. */
788 command = sstrdup(bind->command);
790 sasprintf(&command, "[con_id=\"%p\"] %s", con, bind->command);
792 Binding *bind_cp = binding_copy(bind);
793 CommandResult *result = parse_command(command, NULL);
796 if (result->needs_tree_render)
799 if (result->parse_error) {
801 sasprintf(&pageraction, "i3-sensible-pager \"%s\"\n", errorfilename);
803 NULL, /* will be replaced by the executable path */
809 "The configured command for this shortcut could not be run successfully.",
814 start_nagbar(&command_error_nagbar_pid, argv);
818 ipc_send_binding_event("run", bind_cp);
819 binding_free(bind_cp);
824 static int fill_rmlvo_from_root(struct xkb_rule_names *xkb_names) {
825 xcb_intern_atom_reply_t *atom_reply;
826 size_t content_max_words = 256;
828 xcb_window_t root = root_screen->root;
830 atom_reply = xcb_intern_atom_reply(
831 conn, xcb_intern_atom(conn, 0, strlen("_XKB_RULES_NAMES"), "_XKB_RULES_NAMES"), NULL);
832 if (atom_reply == NULL)
835 xcb_get_property_cookie_t prop_cookie;
836 xcb_get_property_reply_t *prop_reply;
837 prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom,
838 XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words);
839 prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL);
840 if (prop_reply == NULL) {
844 if (xcb_get_property_value_length(prop_reply) > 0 && prop_reply->bytes_after > 0) {
845 /* We received an incomplete value. Ask again but with a properly
847 content_max_words += ceil(prop_reply->bytes_after / 4.0);
848 /* Repeat the request, with adjusted size */
850 prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom,
851 XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words);
852 prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL);
853 if (prop_reply == NULL) {
858 if (xcb_get_property_value_length(prop_reply) == 0) {
864 const char *walk = (const char *)xcb_get_property_value(prop_reply);
865 int remaining = xcb_get_property_value_length(prop_reply);
866 for (int i = 0; i < 5 && remaining > 0; i++) {
867 const int len = strnlen(walk, remaining);
871 sasprintf((char **)&(xkb_names->rules), "%.*s", len, walk);
874 sasprintf((char **)&(xkb_names->model), "%.*s", len, walk);
877 sasprintf((char **)&(xkb_names->layout), "%.*s", len, walk);
880 sasprintf((char **)&(xkb_names->variant), "%.*s", len, walk);
883 sasprintf((char **)&(xkb_names->options), "%.*s", len, walk);
886 DLOG("component %d of _XKB_RULES_NAMES is \"%.*s\"\n", i, len, walk);
896 * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
899 bool load_keymap(void) {
900 if (xkb_context == NULL) {
901 if ((xkb_context = xkb_context_new(0)) == NULL) {
902 ELOG("Could not create xkbcommon context\n");
907 struct xkb_keymap *new_keymap = NULL;
909 if (xkb_supported && (device_id = xkb_x11_get_core_keyboard_device_id(conn)) > -1) {
910 if ((new_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0)) == NULL) {
911 ELOG("xkb_x11_keymap_new_from_device failed\n");
915 /* Likely there is no XKB support on this server, possibly because it
916 * is a VNC server. */
917 LOG("No XKB / core keyboard device? Assembling keymap from local RMLVO.\n");
918 struct xkb_rule_names names = {
924 if (fill_rmlvo_from_root(&names) == -1) {
925 ELOG("Could not get _XKB_RULES_NAMES atom from root window, falling back to defaults.\n");
926 if ((new_keymap = xkb_keymap_new_from_names(xkb_context, &names, 0)) == NULL) {
927 ELOG("xkb_keymap_new_from_names(NULL) failed\n");
931 new_keymap = xkb_keymap_new_from_names(xkb_context, &names, 0);
932 free((char *)names.rules);
933 free((char *)names.model);
934 free((char *)names.layout);
935 free((char *)names.variant);
936 free((char *)names.options);
937 if (new_keymap == NULL) {
938 ELOG("xkb_keymap_new_from_names(RMLVO) failed\n");
942 xkb_keymap_unref(xkb_keymap);
943 xkb_keymap = new_keymap;
949 * Returns a list of buttons that should be grabbed on a window.
950 * This list will always contain 1–3, all higher buttons will only be returned
951 * if there is a whole-window binding for it on some window in the current
953 * The list is terminated by a 0.
955 int *bindings_get_buttons_to_grab(void) {
956 /* Let's make the reasonable assumption that there's no more than 25
963 /* We always return buttons 1 through 3. */
969 TAILQ_FOREACH(bind, bindings, bindings) {
970 if (num + 1 == num_max)
973 /* We are only interested in whole window mouse bindings. */
974 if (bind->input_type != B_MOUSE || !bind->whole_window)
978 long button = strtol(bind->symbol + (sizeof("button") - 1), &endptr, 10);
979 if (button == LONG_MAX || button == LONG_MIN || button < 0 || *endptr != '\0' || endptr == bind->symbol) {
980 ELOG("Could not parse button number, skipping this binding. Please report this bug in i3.\n");
984 /* Avoid duplicates. */
985 for (int i = 0; i < num; i++) {
986 if (buffer[i] == button)
990 buffer[num++] = button;
994 int *buttons = scalloc(num, sizeof(int));
995 memcpy(buttons, buffer, num * sizeof(int));