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)
39 /* If the mode was not found, create a new one */
40 mode = scalloc(1, sizeof(struct Mode));
41 mode->name = sstrdup(name);
42 mode->pango_markup = pango_markup;
43 mode->bindings = scalloc(1, sizeof(struct bindings_head));
44 TAILQ_INIT(mode->bindings);
45 SLIST_INSERT_HEAD(&modes, mode, modes);
51 * Adds a binding from config parameters given as strings and returns a
52 * pointer to the binding structure. Returns NULL if the input code could not
56 Binding *configure_binding(const char *bindtype, const char *modifiers, const char *input_code,
57 const char *release, const char *border, const char *whole_window,
58 const char *command, const char *modename, bool pango_markup) {
59 Binding *new_binding = scalloc(1, sizeof(Binding));
60 DLOG("Binding %p bindtype %s, modifiers %s, input code %s, release %s\n", new_binding, bindtype, modifiers, input_code, release);
61 new_binding->release = (release != NULL ? B_UPON_KEYRELEASE : B_UPON_KEYPRESS);
62 new_binding->border = (border != NULL);
63 new_binding->whole_window = (whole_window != NULL);
64 if (strcmp(bindtype, "bindsym") == 0) {
65 new_binding->input_type = (strncasecmp(input_code, "button", (sizeof("button") - 1)) == 0
69 new_binding->symbol = sstrdup(input_code);
72 long keycode = strtol(input_code, &endptr, 10);
73 new_binding->keycode = keycode;
74 new_binding->input_type = B_KEYBOARD;
75 if (keycode == LONG_MAX || keycode == LONG_MIN || keycode < 0 || *endptr != '\0' || endptr == input_code) {
76 ELOG("Could not parse \"%s\" as an input code, ignoring this binding.\n", input_code);
81 new_binding->command = sstrdup(command);
82 new_binding->event_state_mask = event_state_from_str(modifiers);
83 int group_bits_set = 0;
84 if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_1)
86 if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2)
88 if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3)
90 if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4)
92 if (group_bits_set > 1)
93 ELOG("Keybinding has more than one Group specified, but your X server is always in precisely one group. The keybinding can never trigger.\n");
95 struct Mode *mode = mode_from_name(modename, pango_markup);
96 TAILQ_INSERT_TAIL(mode->bindings, new_binding, bindings);
98 TAILQ_INIT(&(new_binding->keycodes_head));
103 static bool binding_in_current_group(const Binding *bind) {
104 /* If no bits are set, the binding should be installed in every group. */
105 if ((bind->event_state_mask >> 16) == I3_XKB_GROUP_MASK_ANY)
107 switch (xkb_current_group) {
108 case XCB_XKB_GROUP_1:
109 return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_1);
110 case XCB_XKB_GROUP_2:
111 return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2);
112 case XCB_XKB_GROUP_3:
113 return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3);
114 case XCB_XKB_GROUP_4:
115 return ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4);
117 ELOG("BUG: xkb_current_group (= %d) outside of [XCB_XKB_GROUP_1..XCB_XKB_GROUP_4]\n", xkb_current_group);
122 static void grab_keycode_for_binding(xcb_connection_t *conn, Binding *bind, uint32_t keycode) {
123 /* Grab the key in all combinations */
124 #define GRAB_KEY(modifier) \
126 xcb_grab_key(conn, 0, root, modifier, keycode, XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC); \
128 const int mods = (bind->event_state_mask & 0xFFFF);
129 DLOG("Binding %p Grabbing keycode %d with event state mask 0x%x (mods 0x%x)\n",
130 bind, keycode, bind->event_state_mask, mods);
132 /* Also bind the key with active NumLock */
133 GRAB_KEY(mods | xcb_numlock_mask);
134 /* Also bind the key with active CapsLock */
135 GRAB_KEY(mods | XCB_MOD_MASK_LOCK);
136 /* Also bind the key with active NumLock+CapsLock */
137 GRAB_KEY(mods | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
141 * Grab the bound keys (tell X to send us keypress events for those keycodes)
144 void grab_all_keys(xcb_connection_t *conn) {
146 TAILQ_FOREACH(bind, bindings, bindings) {
147 if (bind->input_type != B_KEYBOARD)
150 if (!binding_in_current_group(bind))
153 /* The easy case: the user specified a keycode directly. */
154 if (bind->keycode > 0) {
155 grab_keycode_for_binding(conn, bind, bind->keycode);
159 struct Binding_Keycode *binding_keycode;
160 TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
161 const int keycode = binding_keycode->keycode;
162 const int mods = (binding_keycode->modifiers & 0xFFFF);
163 DLOG("Binding %p Grabbing keycode %d with mods %d\n", bind, keycode, mods);
164 xcb_grab_key(conn, 0, root, mods, keycode, XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC);
170 * Release the button grabs on all managed windows and regrab them,
171 * reevaluating which buttons need to be grabbed.
174 void regrab_all_buttons(xcb_connection_t *conn) {
175 int *buttons = bindings_get_buttons_to_grab();
176 xcb_grab_server(conn);
179 TAILQ_FOREACH(con, &all_cons, all_cons) {
180 if (con->window == NULL)
183 xcb_ungrab_button(conn, XCB_BUTTON_INDEX_ANY, con->window->id, XCB_BUTTON_MASK_ANY);
184 xcb_grab_buttons(conn, con->window->id, buttons);
188 xcb_ungrab_server(conn);
191 static bool modifiers_match(const uint32_t modifiers_mask, const uint32_t modifiers_state) {
192 /* modifiers_mask is a special case: a value of 0 does not mean “match
193 * all”, but rather “match exactly when no modifiers are present”. */
194 if (modifiers_mask == 0) {
195 /* Verify no modifiers are pressed. A bitwise AND would lead to
196 * false positives, see issue #2002. */
197 return (modifiers_state == 0);
199 return ((modifiers_state & modifiers_mask) == modifiers_mask);
203 * Returns a pointer to the Binding with the specified modifiers and
204 * keycode or NULL if no such binding exists.
207 static Binding *get_binding(i3_event_state_mask_t state_filtered, bool is_release, uint16_t input_code, input_type_t input_type) {
211 /* On a press event, we first reset all B_UPON_KEYRELEASE_IGNORE_MODS
212 * bindings back to B_UPON_KEYRELEASE */
213 TAILQ_FOREACH(bind, bindings, bindings) {
214 if (bind->input_type != input_type)
216 if (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS)
217 bind->release = B_UPON_KEYRELEASE;
221 const uint32_t xkb_group_state = (state_filtered & 0xFFFF0000);
222 const uint32_t modifiers_state = (state_filtered & 0x0000FFFF);
223 TAILQ_FOREACH(bind, bindings, bindings) {
224 if (bind->input_type != input_type)
227 const uint32_t xkb_group_mask = (bind->event_state_mask & 0xFFFF0000);
228 const bool groups_match = ((xkb_group_state & xkb_group_mask) == xkb_group_mask);
230 DLOG("skipping binding %p because XKB groups do not match\n", bind);
234 /* For keyboard bindings where a symbol was specified by the user, we
235 * need to look in the array of translated keycodes for the event’s
237 if (input_type == B_KEYBOARD && bind->symbol != NULL) {
238 xcb_keycode_t input_keycode = (xcb_keycode_t)input_code;
239 bool found_keycode = false;
240 struct Binding_Keycode *binding_keycode;
241 TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
242 const uint32_t modifiers_mask = (binding_keycode->modifiers & 0x0000FFFF);
243 const bool mods_match = modifiers_match(modifiers_mask, modifiers_state);
244 DLOG("binding_keycode->modifiers = %d, modifiers_mask = %d, modifiers_state = %d, mods_match = %s\n",
245 binding_keycode->modifiers, modifiers_mask, modifiers_state, (mods_match ? "yes" : "no"));
246 if (binding_keycode->keycode == input_keycode && mods_match) {
247 found_keycode = true;
254 const uint32_t modifiers_mask = (bind->event_state_mask & 0x0000FFFF);
255 const bool mods_match = modifiers_match(modifiers_mask, modifiers_state);
256 DLOG("binding mods_match = %s\n", (mods_match ? "yes" : "no"));
257 /* First compare the state_filtered (unless this is a
258 * B_UPON_KEYRELEASE_IGNORE_MODS binding and this is a KeyRelease
261 (bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
265 /* This case is easier: The user specified a keycode */
266 if (bind->keycode != input_code)
270 /* If this binding is a release binding, it matches the key which the
271 * user pressed. We therefore mark it as B_UPON_KEYRELEASE_IGNORE_MODS
272 * for later, so that the user can release the modifiers before the
273 * actual key or button and the release event will still be matched. */
274 if (bind->release == B_UPON_KEYRELEASE && !is_release) {
275 bind->release = B_UPON_KEYRELEASE_IGNORE_MODS;
276 DLOG("marked bind %p as B_UPON_KEYRELEASE_IGNORE_MODS\n", bind);
277 /* The correct binding has been found, so abort the search, but
278 * also don’t return this binding, since it should not be executed
279 * yet (only when the keys are released). */
280 bind = TAILQ_END(bindings);
284 /* Check if the binding is for a press or a release event */
285 if ((bind->release == B_UPON_KEYPRESS && is_release) ||
286 (bind->release >= B_UPON_KEYRELEASE && !is_release))
292 return (bind == TAILQ_END(bindings) ? NULL : bind);
296 * Returns a pointer to the Binding that matches the given xcb button or key
297 * event or NULL if no such binding exists.
300 Binding *get_binding_from_xcb_event(xcb_generic_event_t *event) {
301 const bool is_release = (event->response_type == XCB_KEY_RELEASE ||
302 event->response_type == XCB_BUTTON_RELEASE);
304 const input_type_t input_type = ((event->response_type == XCB_BUTTON_RELEASE ||
305 event->response_type == XCB_BUTTON_PRESS)
309 const uint16_t event_state = ((xcb_key_press_event_t *)event)->state;
310 const uint16_t event_detail = ((xcb_key_press_event_t *)event)->detail;
312 /* Remove the CapsLock bit */
313 i3_event_state_mask_t state_filtered = event_state & ~XCB_MOD_MASK_LOCK;
314 DLOG("(removed capslock, state = 0x%x)\n", state_filtered);
315 /* Transform the keyboard_group from bit 13 and bit 14 into an
316 * i3_xkb_group_mask_t, so that get_binding() can just bitwise AND the
317 * configured bindings against |state_filtered|.
319 * These bits are only set because we set the XKB client flags
320 * XCB_XKB_PER_CLIENT_FLAG_GRABS_USE_XKB_STATE and
321 * XCB_XKB_PER_CLIENT_FLAG_LOOKUP_STATE_WHEN_GRABBED. See also doc/kbproto
323 * http://www.x.org/releases/X11R7.7/doc/kbproto/xkbproto.html#Computing_A_State_Field_from_an_XKB_State */
324 switch ((event_state & 0x6000) >> 13) {
325 case XCB_XKB_GROUP_1:
326 state_filtered |= (I3_XKB_GROUP_MASK_1 << 16);
328 case XCB_XKB_GROUP_2:
329 state_filtered |= (I3_XKB_GROUP_MASK_2 << 16);
331 case XCB_XKB_GROUP_3:
332 state_filtered |= (I3_XKB_GROUP_MASK_3 << 16);
334 case XCB_XKB_GROUP_4:
335 state_filtered |= (I3_XKB_GROUP_MASK_4 << 16);
338 state_filtered &= ~0x6000;
339 DLOG("(transformed keyboard group, state = 0x%x)\n", state_filtered);
340 return get_binding(state_filtered, is_release, event_detail, input_type);
344 /* The binding which we are resolving. */
347 /* |bind|’s keysym (translated to xkb_keysym_t), e.g. XKB_KEY_R. */
350 /* The xkb state built from the user-provided modifiers and group. */
351 struct xkb_state *xkb_state;
353 /* Like |xkb_state|, just without the shift modifier, if shift was specified. */
354 struct xkb_state *xkb_state_no_shift;
356 /* Like |xkb_state|, but with NumLock. */
357 struct xkb_state *xkb_state_numlock;
359 /* Like |xkb_state|, but with NumLock, just without the shift modifier, if shift was specified. */
360 struct xkb_state *xkb_state_numlock_no_shift;
364 * add_keycode_if_matches is called for each keycode in the keymap and will add
365 * the keycode to |data->bind| if the keycode can result in the keysym
369 static void add_keycode_if_matches(struct xkb_keymap *keymap, xkb_keycode_t key, void *data) {
370 const struct resolve *resolving = data;
371 struct xkb_state *numlock_state = resolving->xkb_state_numlock;
372 xkb_keysym_t sym = xkb_state_key_get_one_sym(resolving->xkb_state, key);
373 if (sym != resolving->keysym) {
374 /* Check if Shift was specified, and try resolving the symbol without
375 * shift, so that “bindsym $mod+Shift+a nop” actually works. */
376 const xkb_layout_index_t layout = xkb_state_key_get_layout(resolving->xkb_state, key);
377 if (layout == XKB_LAYOUT_INVALID)
379 if (xkb_state_key_get_level(resolving->xkb_state, key, layout) > 1)
381 /* Skip the Shift fallback for keypad keys, otherwise one cannot bind
382 * KP_1 independent of KP_End. */
383 if (sym >= XKB_KEY_KP_Space && sym <= XKB_KEY_KP_Equal)
385 numlock_state = resolving->xkb_state_numlock_no_shift;
386 sym = xkb_state_key_get_one_sym(resolving->xkb_state_no_shift, key);
387 if (sym != resolving->keysym)
390 Binding *bind = resolving->bind;
392 #define ADD_TRANSLATED_KEY(mods) \
394 struct Binding_Keycode *binding_keycode = smalloc(sizeof(struct Binding_Keycode)); \
395 binding_keycode->modifiers = (mods); \
396 binding_keycode->keycode = key; \
397 TAILQ_INSERT_TAIL(&(bind->keycodes_head), binding_keycode, keycodes); \
400 ADD_TRANSLATED_KEY(bind->event_state_mask);
402 /* Also bind the key with active CapsLock */
403 ADD_TRANSLATED_KEY(bind->event_state_mask | XCB_MOD_MASK_LOCK);
405 /* If this binding is not explicitly for NumLock, check whether we need to
407 if ((bind->event_state_mask & xcb_numlock_mask) != xcb_numlock_mask) {
408 /* Check whether the keycode results in the same keysym when NumLock is
409 * active. If so, grab the key with NumLock as well, so that users don’t
410 * need to duplicate every key binding with an additional Mod2 specified.
412 xkb_keysym_t sym_numlock = xkb_state_key_get_one_sym(numlock_state, key);
413 if (sym_numlock == resolving->keysym) {
414 /* Also bind the key with active NumLock */
415 ADD_TRANSLATED_KEY(bind->event_state_mask | xcb_numlock_mask);
417 /* Also bind the key with active NumLock+CapsLock */
418 ADD_TRANSLATED_KEY(bind->event_state_mask | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
420 DLOG("Skipping automatic numlock fallback, key %d resolves to 0x%x with numlock\n",
425 #undef ADD_TRANSLATED_KEY
429 * Translates keysymbols to keycodes for all bindings which use keysyms.
432 void translate_keysyms(void) {
433 struct xkb_state *dummy_state = xkb_state_new(xkb_keymap);
434 if (dummy_state == NULL) {
435 ELOG("Could not create XKB state, cannot translate keysyms.\n");
439 struct xkb_state *dummy_state_no_shift = xkb_state_new(xkb_keymap);
440 if (dummy_state_no_shift == NULL) {
441 ELOG("Could not create XKB state, cannot translate keysyms.\n");
445 struct xkb_state *dummy_state_numlock = xkb_state_new(xkb_keymap);
446 if (dummy_state_numlock == NULL) {
447 ELOG("Could not create XKB state, cannot translate keysyms.\n");
451 struct xkb_state *dummy_state_numlock_no_shift = xkb_state_new(xkb_keymap);
452 if (dummy_state_numlock_no_shift == NULL) {
453 ELOG("Could not create XKB state, cannot translate keysyms.\n");
457 bool has_errors = false;
459 TAILQ_FOREACH(bind, bindings, bindings) {
460 if (bind->input_type == B_MOUSE) {
462 long button = strtol(bind->symbol + (sizeof("button") - 1), &endptr, 10);
463 bind->keycode = button;
465 if (button == LONG_MAX || button == LONG_MIN || button < 0 || *endptr != '\0' || endptr == bind->symbol)
466 ELOG("Could not translate string to button: \"%s\"\n", bind->symbol);
471 if (bind->keycode > 0)
474 /* We need to translate the symbol to a keycode */
475 const xkb_keysym_t keysym = xkb_keysym_from_name(bind->symbol, XKB_KEYSYM_NO_FLAGS);
476 if (keysym == XKB_KEY_NoSymbol) {
477 ELOG("Could not translate string to key symbol: \"%s\"\n",
482 xkb_layout_index_t group = XCB_XKB_GROUP_1;
483 if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2)
484 group = XCB_XKB_GROUP_2;
485 else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3)
486 group = XCB_XKB_GROUP_3;
487 else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4)
488 group = XCB_XKB_GROUP_4;
490 DLOG("Binding %p group = %d, event_state_mask = %d, &2 = %s, &3 = %s, &4 = %s\n",
493 bind->event_state_mask,
494 (bind->event_state_mask & I3_XKB_GROUP_MASK_2) ? "yes" : "no",
495 (bind->event_state_mask & I3_XKB_GROUP_MASK_3) ? "yes" : "no",
496 (bind->event_state_mask & I3_XKB_GROUP_MASK_4) ? "yes" : "no");
497 (void)xkb_state_update_mask(
499 (bind->event_state_mask & 0x1FFF) /* xkb_mod_mask_t base_mods, */,
500 0 /* xkb_mod_mask_t latched_mods, */,
501 0 /* xkb_mod_mask_t locked_mods, */,
502 0 /* xkb_layout_index_t base_group, */,
503 0 /* xkb_layout_index_t latched_group, */,
504 group /* xkb_layout_index_t locked_group, */);
506 (void)xkb_state_update_mask(
507 dummy_state_no_shift,
508 (bind->event_state_mask & 0x1FFF) ^ XCB_KEY_BUT_MASK_SHIFT /* xkb_mod_mask_t base_mods, */,
509 0 /* xkb_mod_mask_t latched_mods, */,
510 0 /* xkb_mod_mask_t locked_mods, */,
511 0 /* xkb_layout_index_t base_group, */,
512 0 /* xkb_layout_index_t latched_group, */,
513 group /* xkb_layout_index_t locked_group, */);
515 (void)xkb_state_update_mask(
517 (bind->event_state_mask & 0x1FFF) | xcb_numlock_mask /* xkb_mod_mask_t base_mods, */,
518 0 /* xkb_mod_mask_t latched_mods, */,
519 0 /* xkb_mod_mask_t locked_mods, */,
520 0 /* xkb_layout_index_t base_group, */,
521 0 /* xkb_layout_index_t latched_group, */,
522 group /* xkb_layout_index_t locked_group, */);
524 (void)xkb_state_update_mask(
525 dummy_state_numlock_no_shift,
526 ((bind->event_state_mask & 0x1FFF) | xcb_numlock_mask) ^ XCB_KEY_BUT_MASK_SHIFT /* xkb_mod_mask_t base_mods, */,
527 0 /* xkb_mod_mask_t latched_mods, */,
528 0 /* xkb_mod_mask_t locked_mods, */,
529 0 /* xkb_layout_index_t base_group, */,
530 0 /* xkb_layout_index_t latched_group, */,
531 group /* xkb_layout_index_t locked_group, */);
533 struct resolve resolving = {
536 .xkb_state = dummy_state,
537 .xkb_state_no_shift = dummy_state_no_shift,
538 .xkb_state_numlock = dummy_state_numlock,
539 .xkb_state_numlock_no_shift = dummy_state_numlock_no_shift,
541 while (!TAILQ_EMPTY(&(bind->keycodes_head))) {
542 struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head));
543 TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes);
546 xkb_keymap_key_for_each(xkb_keymap, add_keycode_if_matches, &resolving);
547 char *keycodes = sstrdup("");
548 int num_keycodes = 0;
549 struct Binding_Keycode *binding_keycode;
550 TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
552 sasprintf(&tmp, "%s %d", keycodes, binding_keycode->keycode);
557 /* check for duplicate bindings */
559 TAILQ_FOREACH(check, bindings, bindings) {
562 if (check->symbol != NULL)
564 if (check->keycode != binding_keycode->keycode ||
565 check->event_state_mask != binding_keycode->modifiers ||
566 check->release != bind->release)
569 ELOG("Duplicate keybinding in config file:\n keysym = %s, keycode = %d, state_mask = 0x%x\n", bind->symbol, check->keycode, bind->event_state_mask);
572 DLOG("state=0x%x, cfg=\"%s\", sym=0x%x → keycodes%s (%d)\n",
573 bind->event_state_mask, bind->symbol, keysym, keycodes, num_keycodes);
577 xkb_state_unref(dummy_state);
578 xkb_state_unref(dummy_state_no_shift);
579 xkb_state_unref(dummy_state_numlock);
580 xkb_state_unref(dummy_state_numlock_no_shift);
583 start_config_error_nagbar(current_configpath, true);
588 * Switches the key bindings to the given mode, if the mode exists
591 void switch_mode(const char *new_mode) {
594 DLOG("Switching to mode %s\n", new_mode);
596 SLIST_FOREACH(mode, &modes, modes) {
597 if (strcasecmp(mode->name, new_mode) != 0)
600 ungrab_all_keys(conn);
601 bindings = mode->bindings;
606 sasprintf(&event_msg, "{\"change\":\"%s\", \"pango_markup\":%s}",
607 mode->name, (mode->pango_markup ? "true" : "false"));
609 ipc_send_event("mode", I3_IPC_EVENT_MODE, event_msg);
615 ELOG("ERROR: Mode not found\n");
618 static int reorder_binding_cmp(const void *a, const void *b) {
619 Binding *first = *((Binding **)a);
620 Binding *second = *((Binding **)b);
621 if (first->event_state_mask < second->event_state_mask) {
623 } else if (first->event_state_mask == second->event_state_mask) {
630 static void reorder_bindings_of_mode(struct Mode *mode) {
631 /* Copy the bindings into an array, so that we can use qsort(3). */
634 TAILQ_FOREACH(current, mode->bindings, bindings) {
637 Binding **tmp = scalloc(n, sizeof(Binding *));
639 TAILQ_FOREACH(current, mode->bindings, bindings) {
643 qsort(tmp, n, sizeof(Binding *), reorder_binding_cmp);
645 struct bindings_head *reordered = scalloc(1, sizeof(struct bindings_head));
646 TAILQ_INIT(reordered);
647 for (int i = 0; i < n; i++) {
649 TAILQ_REMOVE(mode->bindings, current, bindings);
650 TAILQ_INSERT_TAIL(reordered, current, bindings);
653 assert(TAILQ_EMPTY(mode->bindings));
654 /* Free the old bindings_head, which is now empty. */
655 free(mode->bindings);
656 mode->bindings = reordered;
660 * Reorders bindings by event_state_mask descendingly so that get_binding()
661 * correctly matches more specific bindings before more generic bindings. Take
662 * the following binding configuration as an example:
664 * bindsym n nop lower-case n pressed
665 * bindsym Shift+n nop upper-case n pressed
667 * Without reordering, the first binding’s event_state_mask of 0x0 would match
668 * the actual event_stat_mask of 0x1 and hence trigger instead of the second
672 void reorder_bindings(void) {
674 SLIST_FOREACH(mode, &modes, modes) {
675 const bool current_mode = (mode->bindings == bindings);
676 reorder_bindings_of_mode(mode);
678 bindings = mode->bindings;
683 * Checks for duplicate key bindings (the same keycode or keysym is configured
684 * more than once). If a duplicate binding is found, a message is printed to
685 * stderr and the has_errors variable is set to true, which will start
689 void check_for_duplicate_bindings(struct context *context) {
690 Binding *bind, *current;
691 TAILQ_FOREACH(current, bindings, bindings) {
692 TAILQ_FOREACH(bind, bindings, bindings) {
693 /* Abort when we reach the current keybinding, only check the
698 /* Check if the input types are different */
699 if (bind->input_type != current->input_type)
702 /* Check if one is using keysym while the other is using bindsym.
704 if ((bind->symbol == NULL && current->symbol != NULL) ||
705 (bind->symbol != NULL && current->symbol == NULL))
708 /* If bind is NULL, current has to be NULL, too (see above).
709 * If the keycodes differ, it can't be a duplicate. */
710 if (bind->symbol != NULL &&
711 strcasecmp(bind->symbol, current->symbol) != 0)
714 /* Check if the keycodes or modifiers are different. If so, they
715 * can't be duplicate */
716 if (bind->keycode != current->keycode ||
717 bind->event_state_mask != current->event_state_mask ||
718 bind->release != current->release)
721 context->has_errors = true;
722 if (current->keycode != 0) {
723 ELOG("Duplicate keybinding in config file:\n state mask 0x%x with keycode %d, command \"%s\"\n",
724 current->event_state_mask, current->keycode, current->command);
726 ELOG("Duplicate keybinding in config file:\n state mask 0x%x with keysym %s, command \"%s\"\n",
727 current->event_state_mask, current->symbol, current->command);
734 * Creates a dynamically allocated copy of bind.
736 static Binding *binding_copy(Binding *bind) {
737 Binding *ret = smalloc(sizeof(Binding));
739 if (bind->symbol != NULL)
740 ret->symbol = sstrdup(bind->symbol);
741 if (bind->command != NULL)
742 ret->command = sstrdup(bind->command);
743 TAILQ_INIT(&(ret->keycodes_head));
744 struct Binding_Keycode *binding_keycode;
745 TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
746 struct Binding_Keycode *ret_binding_keycode = smalloc(sizeof(struct Binding_Keycode));
747 *ret_binding_keycode = *binding_keycode;
748 TAILQ_INSERT_TAIL(&(ret->keycodes_head), ret_binding_keycode, keycodes);
755 * Frees the binding. If bind is null, it simply returns.
757 void binding_free(Binding *bind) {
762 while (!TAILQ_EMPTY(&(bind->keycodes_head))) {
763 struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head));
764 TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes);
774 * Runs the given binding and handles parse errors. If con is passed, it will
775 * execute the command binding with that container selected by criteria.
776 * Returns a CommandResult for running the binding's command. Free with
777 * command_result_free().
780 CommandResult *run_binding(Binding *bind, Con *con) {
783 /* We need to copy the binding and command since “reload” may be part of
784 * the command, and then the memory that bind points to may not contain the
785 * same data anymore. */
787 command = sstrdup(bind->command);
789 sasprintf(&command, "[con_id=\"%p\"] %s", con, bind->command);
791 Binding *bind_cp = binding_copy(bind);
792 CommandResult *result = parse_command(command, NULL);
795 if (result->needs_tree_render)
798 if (result->parse_error) {
800 sasprintf(&pageraction, "i3-sensible-pager \"%s\"\n", errorfilename);
802 NULL, /* will be replaced by the executable path */
808 "The configured command for this shortcut could not be run successfully.",
813 start_nagbar(&command_error_nagbar_pid, argv);
817 ipc_send_binding_event("run", bind_cp);
818 binding_free(bind_cp);
823 static int fill_rmlvo_from_root(struct xkb_rule_names *xkb_names) {
824 xcb_intern_atom_reply_t *atom_reply;
825 size_t content_max_words = 256;
827 xcb_window_t root = root_screen->root;
829 atom_reply = xcb_intern_atom_reply(
830 conn, xcb_intern_atom(conn, 0, strlen("_XKB_RULES_NAMES"), "_XKB_RULES_NAMES"), NULL);
831 if (atom_reply == NULL)
834 xcb_get_property_cookie_t prop_cookie;
835 xcb_get_property_reply_t *prop_reply;
836 prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom,
837 XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words);
838 prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL);
839 if (prop_reply == NULL) {
843 if (xcb_get_property_value_length(prop_reply) > 0 && prop_reply->bytes_after > 0) {
844 /* We received an incomplete value. Ask again but with a properly
846 content_max_words += ceil(prop_reply->bytes_after / 4.0);
847 /* Repeat the request, with adjusted size */
849 prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom,
850 XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words);
851 prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL);
852 if (prop_reply == NULL) {
857 if (xcb_get_property_value_length(prop_reply) == 0) {
863 const char *walk = (const char *)xcb_get_property_value(prop_reply);
864 int remaining = xcb_get_property_value_length(prop_reply);
865 for (int i = 0; i < 5 && remaining > 0; i++) {
866 const int len = strnlen(walk, remaining);
870 sasprintf((char **)&(xkb_names->rules), "%.*s", len, walk);
873 sasprintf((char **)&(xkb_names->model), "%.*s", len, walk);
876 sasprintf((char **)&(xkb_names->layout), "%.*s", len, walk);
879 sasprintf((char **)&(xkb_names->variant), "%.*s", len, walk);
882 sasprintf((char **)&(xkb_names->options), "%.*s", len, walk);
885 DLOG("component %d of _XKB_RULES_NAMES is \"%.*s\"\n", i, len, walk);
895 * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
898 bool load_keymap(void) {
899 if (xkb_context == NULL) {
900 if ((xkb_context = xkb_context_new(0)) == NULL) {
901 ELOG("Could not create xkbcommon context\n");
906 struct xkb_keymap *new_keymap = NULL;
908 if (xkb_supported && (device_id = xkb_x11_get_core_keyboard_device_id(conn)) > -1) {
909 if ((new_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0)) == NULL) {
910 ELOG("xkb_x11_keymap_new_from_device failed\n");
914 /* Likely there is no XKB support on this server, possibly because it
915 * is a VNC server. */
916 LOG("No XKB / core keyboard device? Assembling keymap from local RMLVO.\n");
917 struct xkb_rule_names names = {
923 if (fill_rmlvo_from_root(&names) == -1) {
924 ELOG("Could not get _XKB_RULES_NAMES atom from root window, falling back to defaults.\n");
925 if ((new_keymap = xkb_keymap_new_from_names(xkb_context, &names, 0)) == NULL) {
926 ELOG("xkb_keymap_new_from_names(NULL) failed\n");
930 new_keymap = xkb_keymap_new_from_names(xkb_context, &names, 0);
931 free((char *)names.rules);
932 free((char *)names.model);
933 free((char *)names.layout);
934 free((char *)names.variant);
935 free((char *)names.options);
936 if (new_keymap == NULL) {
937 ELOG("xkb_keymap_new_from_names(RMLVO) failed\n");
941 xkb_keymap_unref(xkb_keymap);
942 xkb_keymap = new_keymap;
948 * Returns a list of buttons that should be grabbed on a window.
949 * This list will always contain 1–3, all higher buttons will only be returned
950 * if there is a whole-window binding for it on some window in the current
952 * The list is terminated by a 0.
954 int *bindings_get_buttons_to_grab(void) {
955 /* Let's make the reasonable assumption that there's no more than 25
962 /* We always return buttons 1 through 3. */
968 TAILQ_FOREACH(bind, bindings, bindings) {
969 if (num + 1 == num_max)
972 /* We are only interested in whole window mouse bindings. */
973 if (bind->input_type != B_MOUSE || !bind->whole_window)
977 long button = strtol(bind->symbol + (sizeof("button") - 1), &endptr, 10);
978 if (button == LONG_MAX || button == LONG_MIN || button < 0 || *endptr != '\0' || endptr == bind->symbol) {
979 ELOG("Could not parse button number, skipping this binding. Please report this bug in i3.\n");
983 /* Avoid duplicates. */
984 for (int i = 0; i < num; i++) {
985 if (buffer[i] == button)
989 buffer[num++] = button;
993 int *buttons = scalloc(num, sizeof(int));
994 memcpy(buttons, buffer, num * sizeof(int));