]> git.sur5r.net Git - i3/i3/blob - src/bindings.c
Bugfix: correctly compare modifier mask when identifying keybindings
[i3/i3] / src / bindings.c
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
6  *
7  * bindings.c: Functions for configuring, finding and, running bindings.
8  */
9 #include "all.h"
10
11 #include <xkbcommon/xkbcommon.h>
12 #include <xkbcommon/xkbcommon-x11.h>
13
14 static struct xkb_context *xkb_context;
15 static struct xkb_keymap *xkb_keymap;
16
17 pid_t command_error_nagbar_pid = -1;
18
19 /*
20  * The name of the default mode.
21  *
22  */
23 const char *DEFAULT_BINDING_MODE = "default";
24
25 /*
26  * Returns the mode specified by `name` or creates a new mode and adds it to
27  * the list of modes.
28  *
29  */
30 static struct Mode *mode_from_name(const char *name, bool pango_markup) {
31     struct Mode *mode;
32
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)
36             return mode;
37     }
38
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);
46
47     return mode;
48 }
49
50 /*
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
53  * be parsed.
54  *
55  */
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("bindtype %s, modifiers %s, input code %s, release %s\n", 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
66                                        ? B_MOUSE
67                                        : B_KEYBOARD);
68
69         new_binding->symbol = sstrdup(input_code);
70     } else {
71         char *endptr;
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);
77             FREE(new_binding);
78             return NULL;
79         }
80     }
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)
85         group_bits_set++;
86     if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2)
87         group_bits_set++;
88     if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3)
89         group_bits_set++;
90     if ((new_binding->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4)
91         group_bits_set++;
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");
94
95     struct Mode *mode = mode_from_name(modename, pango_markup);
96     TAILQ_INSERT_TAIL(mode->bindings, new_binding, bindings);
97
98     return new_binding;
99 }
100
101 static void grab_keycode_for_binding(xcb_connection_t *conn, Binding *bind, uint32_t keycode) {
102     if (bind->input_type != B_KEYBOARD)
103         return;
104
105 /* Grab the key in all combinations */
106 #define GRAB_KEY(modifier)                                                                       \
107     do {                                                                                         \
108         xcb_grab_key(conn, 0, root, modifier, keycode, XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC); \
109     } while (0)
110     int mods = bind->event_state_mask;
111     if (((mods >> 16) & I3_XKB_GROUP_MASK_1) && xkb_current_group != XCB_XKB_GROUP_1)
112         return;
113     if (((mods >> 16) & I3_XKB_GROUP_MASK_2) && xkb_current_group != XCB_XKB_GROUP_2)
114         return;
115     if (((mods >> 16) & I3_XKB_GROUP_MASK_3) && xkb_current_group != XCB_XKB_GROUP_3)
116         return;
117     if (((mods >> 16) & I3_XKB_GROUP_MASK_4) && xkb_current_group != XCB_XKB_GROUP_4)
118         return;
119     mods &= 0xFFFF;
120     DLOG("Grabbing keycode %d with event state mask 0x%x (mods 0x%x)\n",
121          keycode, bind->event_state_mask, mods);
122     GRAB_KEY(mods);
123     GRAB_KEY(mods | xcb_numlock_mask);
124     GRAB_KEY(mods | XCB_MOD_MASK_LOCK);
125     GRAB_KEY(mods | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
126 }
127
128 /*
129  * Grab the bound keys (tell X to send us keypress events for those keycodes)
130  *
131  */
132 void grab_all_keys(xcb_connection_t *conn) {
133     Binding *bind;
134     TAILQ_FOREACH(bind, bindings, bindings) {
135         if (bind->input_type != B_KEYBOARD)
136             continue;
137
138         /* The easy case: the user specified a keycode directly. */
139         if (bind->keycode > 0) {
140             grab_keycode_for_binding(conn, bind, bind->keycode);
141             continue;
142         }
143
144         for (uint32_t i = 0; i < bind->number_keycodes; i++)
145             grab_keycode_for_binding(conn, bind, bind->translated_to[i]);
146     }
147 }
148
149 /*
150  * Returns a pointer to the Binding with the specified modifiers and
151  * keycode or NULL if no such binding exists.
152  *
153  */
154 static Binding *get_binding(i3_event_state_mask_t state_filtered, bool is_release, uint16_t input_code, input_type_t input_type) {
155     Binding *bind;
156
157     if (!is_release) {
158         /* On a press event, we first reset all B_UPON_KEYRELEASE_IGNORE_MODS
159          * bindings back to B_UPON_KEYRELEASE */
160         TAILQ_FOREACH(bind, bindings, bindings) {
161             if (bind->input_type != input_type)
162                 continue;
163             if (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS)
164                 bind->release = B_UPON_KEYRELEASE;
165         }
166     }
167
168     TAILQ_FOREACH(bind, bindings, bindings) {
169         bool state_matches;
170         if (bind->event_state_mask == 0) {
171             /* Verify no modifiers are pressed. A bitwise AND would lead to
172              * false positives, see issue #2002. */
173             state_matches = (state_filtered == 0);
174         } else {
175             state_matches = ((state_filtered & bind->event_state_mask) == bind->event_state_mask);
176         }
177
178         DLOG("binding with event_state_mask 0x%x, state_filtered 0x%x, match: %s\n",
179              bind->event_state_mask, state_filtered, (state_matches ? "yes" : "no"));
180         /* First compare the state_filtered (unless this is a
181          * B_UPON_KEYRELEASE_IGNORE_MODS binding and this is a KeyRelease
182          * event) */
183         if (bind->input_type != input_type)
184             continue;
185         if (!state_matches &&
186             (bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
187              !is_release))
188             continue;
189
190         /* For keyboard bindings where a symbol was specified by the user, we
191          * need to look in the array of translated keycodes for the event’s
192          * keycode */
193         if (input_type == B_KEYBOARD && bind->symbol != NULL) {
194             xcb_keycode_t input_keycode = (xcb_keycode_t)input_code;
195             if (memmem(bind->translated_to,
196                        bind->number_keycodes * sizeof(xcb_keycode_t),
197                        &input_keycode, sizeof(xcb_keycode_t)) == NULL)
198                 continue;
199         } else {
200             /* This case is easier: The user specified a keycode */
201             if (bind->keycode != input_code)
202                 continue;
203         }
204
205         /* If this binding is a release binding, it matches the key which the
206          * user pressed. We therefore mark it as B_UPON_KEYRELEASE_IGNORE_MODS
207          * for later, so that the user can release the modifiers before the
208          * actual key or button and the release event will still be matched. */
209         if (bind->release == B_UPON_KEYRELEASE && !is_release)
210             bind->release = B_UPON_KEYRELEASE_IGNORE_MODS;
211
212         /* Check if the binding is for a press or a release event */
213         if ((bind->release == B_UPON_KEYPRESS && is_release) ||
214             (bind->release >= B_UPON_KEYRELEASE && !is_release))
215             continue;
216
217         break;
218     }
219
220     return (bind == TAILQ_END(bindings) ? NULL : bind);
221 }
222
223 /*
224  * Returns a pointer to the Binding that matches the given xcb button or key
225  * event or NULL if no such binding exists.
226  *
227  */
228 Binding *get_binding_from_xcb_event(xcb_generic_event_t *event) {
229     const bool is_release = (event->response_type == XCB_KEY_RELEASE ||
230                              event->response_type == XCB_BUTTON_RELEASE);
231
232     const input_type_t input_type = ((event->response_type == XCB_BUTTON_RELEASE ||
233                                       event->response_type == XCB_BUTTON_PRESS)
234                                          ? B_MOUSE
235                                          : B_KEYBOARD);
236
237     const uint16_t event_state = ((xcb_key_press_event_t *)event)->state;
238     const uint16_t event_detail = ((xcb_key_press_event_t *)event)->detail;
239
240     /* Remove the numlock bit */
241     i3_event_state_mask_t state_filtered = event_state & ~(xcb_numlock_mask | XCB_MOD_MASK_LOCK);
242     DLOG("(removed numlock, state = 0x%x)\n", state_filtered);
243     /* Transform the keyboard_group from bit 13 and bit 14 into an
244      * i3_xkb_group_mask_t, so that get_binding() can just bitwise AND the
245      * configured bindings against |state_filtered|.
246      *
247      * These bits are only set because we set the XKB client flags
248      * XCB_XKB_PER_CLIENT_FLAG_GRABS_USE_XKB_STATE and
249      * XCB_XKB_PER_CLIENT_FLAG_LOOKUP_STATE_WHEN_GRABBED. See also doc/kbproto
250      * section 2.2.2:
251      * http://www.x.org/releases/X11R7.7/doc/kbproto/xkbproto.html#Computing_A_State_Field_from_an_XKB_State */
252     switch ((event_state & 0x6000) >> 13) {
253         case XCB_XKB_GROUP_1:
254             state_filtered |= (I3_XKB_GROUP_MASK_1 << 16);
255             break;
256         case XCB_XKB_GROUP_2:
257             state_filtered |= (I3_XKB_GROUP_MASK_2 << 16);
258             break;
259         case XCB_XKB_GROUP_3:
260             state_filtered |= (I3_XKB_GROUP_MASK_3 << 16);
261             break;
262         case XCB_XKB_GROUP_4:
263             state_filtered |= (I3_XKB_GROUP_MASK_4 << 16);
264             break;
265     }
266     state_filtered &= ~0x6000;
267     DLOG("(transformed keyboard group, state = 0x%x)\n", state_filtered);
268     return get_binding(state_filtered, is_release, event_detail, input_type);
269 }
270
271 struct resolve {
272     /* The binding which we are resolving. */
273     Binding *bind;
274
275     /* |bind|’s keysym (translated to xkb_keysym_t), e.g. XKB_KEY_R. */
276     xkb_keysym_t keysym;
277
278     /* The xkb state built from the user-provided modifiers and group. */
279     struct xkb_state *xkb_state;
280
281     /* Like |xkb_state|, just without the shift modifier, if shift was specified. */
282     struct xkb_state *xkb_state_no_shift;
283 };
284
285 /*
286  * add_keycode_if_matches is called for each keycode in the keymap and will add
287  * the keycode to |data->bind| if the keycode can result in the keysym
288  * |data->resolving|.
289  *
290  */
291 static void add_keycode_if_matches(struct xkb_keymap *keymap, xkb_keycode_t key, void *data) {
292     const struct resolve *resolving = data;
293     xkb_keysym_t sym = xkb_state_key_get_one_sym(resolving->xkb_state, key);
294     if (sym != resolving->keysym) {
295         /* Check if Shift was specified, and try resolving the symbol without
296          * shift, so that “bindsym $mod+Shift+a nop” actually works. */
297         const xkb_layout_index_t layout = xkb_state_key_get_layout(resolving->xkb_state, key);
298         if (layout == XKB_LAYOUT_INVALID)
299             return;
300         if (xkb_state_key_get_level(resolving->xkb_state, key, layout) > 1)
301             return;
302         sym = xkb_state_key_get_one_sym(resolving->xkb_state_no_shift, key);
303         if (sym != resolving->keysym)
304             return;
305     }
306     Binding *bind = resolving->bind;
307     bind->number_keycodes++;
308     bind->translated_to = srealloc(bind->translated_to,
309                                    (sizeof(xcb_keycode_t) *
310                                     bind->number_keycodes));
311     bind->translated_to[bind->number_keycodes - 1] = key;
312 }
313
314 /*
315  * Translates keysymbols to keycodes for all bindings which use keysyms.
316  *
317  */
318 void translate_keysyms(void) {
319     struct xkb_state *dummy_state = xkb_state_new(xkb_keymap);
320     if (dummy_state == NULL) {
321         ELOG("Could not create XKB state, cannot translate keysyms.\n");
322         return;
323     }
324
325     struct xkb_state *dummy_state_no_shift = xkb_state_new(xkb_keymap);
326     if (dummy_state_no_shift == NULL) {
327         ELOG("Could not create XKB state, cannot translate keysyms.\n");
328         return;
329     }
330
331     bool has_errors = false;
332     Binding *bind;
333     TAILQ_FOREACH(bind, bindings, bindings) {
334         if (bind->input_type == B_MOUSE) {
335             char *endptr;
336             long button = strtol(bind->symbol + (sizeof("button") - 1), &endptr, 10);
337             bind->keycode = button;
338
339             if (button == LONG_MAX || button == LONG_MIN || button < 0 || *endptr != '\0' || endptr == bind->symbol)
340                 ELOG("Could not translate string to button: \"%s\"\n", bind->symbol);
341
342             continue;
343         }
344
345         if (bind->keycode > 0)
346             continue;
347
348         /* We need to translate the symbol to a keycode */
349         const xkb_keysym_t keysym = xkb_keysym_from_name(bind->symbol, XKB_KEYSYM_NO_FLAGS);
350         if (keysym == XKB_KEY_NoSymbol) {
351             ELOG("Could not translate string to key symbol: \"%s\"\n",
352                  bind->symbol);
353             continue;
354         }
355
356         xkb_layout_index_t group = XCB_XKB_GROUP_1;
357         if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2)
358             group = XCB_XKB_GROUP_2;
359         else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3)
360             group = XCB_XKB_GROUP_3;
361         else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4)
362             group = XCB_XKB_GROUP_4;
363
364         DLOG("group = %d, event_state_mask = %d, &2 = %s, &3 = %s, &4 = %s\n", group,
365              bind->event_state_mask,
366              (bind->event_state_mask & I3_XKB_GROUP_MASK_2) ? "yes" : "no",
367              (bind->event_state_mask & I3_XKB_GROUP_MASK_3) ? "yes" : "no",
368              (bind->event_state_mask & I3_XKB_GROUP_MASK_4) ? "yes" : "no");
369         (void)xkb_state_update_mask(
370             dummy_state,
371             (bind->event_state_mask & 0x1FFF) /* xkb_mod_mask_t base_mods, */,
372             0 /* xkb_mod_mask_t latched_mods, */,
373             0 /* xkb_mod_mask_t locked_mods, */,
374             0 /* xkb_layout_index_t base_group, */,
375             0 /* xkb_layout_index_t latched_group, */,
376             group /* xkb_layout_index_t locked_group, */);
377
378         (void)xkb_state_update_mask(
379             dummy_state_no_shift,
380             (bind->event_state_mask & 0x1FFF) ^ XCB_KEY_BUT_MASK_SHIFT /* xkb_mod_mask_t base_mods, */,
381             0 /* xkb_mod_mask_t latched_mods, */,
382             0 /* xkb_mod_mask_t locked_mods, */,
383             0 /* xkb_layout_index_t base_group, */,
384             0 /* xkb_layout_index_t latched_group, */,
385             group /* xkb_layout_index_t locked_group, */);
386
387         struct resolve resolving = {
388             .bind = bind,
389             .keysym = keysym,
390             .xkb_state = dummy_state,
391             .xkb_state_no_shift = dummy_state_no_shift,
392         };
393         FREE(bind->translated_to);
394         bind->number_keycodes = 0;
395         xkb_keymap_key_for_each(xkb_keymap, add_keycode_if_matches, &resolving);
396         char *keycodes = sstrdup("");
397         for (uint32_t n = 0; n < bind->number_keycodes; n++) {
398             char *tmp;
399             sasprintf(&tmp, "%s %d", keycodes, bind->translated_to[n]);
400             free(keycodes);
401             keycodes = tmp;
402
403             /* check for duplicate bindings */
404             Binding *check;
405             TAILQ_FOREACH(check, bindings, bindings) {
406                 if (check == bind)
407                     continue;
408                 if (check->symbol != NULL)
409                     continue;
410                 if (check->keycode != bind->translated_to[n] ||
411                     check->event_state_mask != bind->event_state_mask ||
412                     check->release != bind->release)
413                     continue;
414                 has_errors = true;
415                 ELOG("Duplicate keybinding in config file:\n  keysym = %s, keycode = %d, state_mask = 0x%x\n", bind->symbol, check->keycode, bind->event_state_mask);
416             }
417         }
418         DLOG("state=0x%x, cfg=\"%s\", sym=0x%x → keycodes%s (%d)\n",
419              bind->event_state_mask, bind->symbol, keysym, keycodes, bind->number_keycodes);
420         free(keycodes);
421     }
422
423     xkb_state_unref(dummy_state);
424     xkb_state_unref(dummy_state_no_shift);
425
426     if (has_errors) {
427         start_config_error_nagbar(current_configpath, true);
428     }
429 }
430
431 /*
432  * Switches the key bindings to the given mode, if the mode exists
433  *
434  */
435 void switch_mode(const char *new_mode) {
436     struct Mode *mode;
437
438     DLOG("Switching to mode %s\n", new_mode);
439
440     SLIST_FOREACH(mode, &modes, modes) {
441         if (strcasecmp(mode->name, new_mode) != 0)
442             continue;
443
444         ungrab_all_keys(conn);
445         bindings = mode->bindings;
446         translate_keysyms();
447         grab_all_keys(conn);
448
449         char *event_msg;
450         sasprintf(&event_msg, "{\"change\":\"%s\", \"pango_markup\":%s}",
451                   mode->name, (mode->pango_markup ? "true" : "false"));
452
453         ipc_send_event("mode", I3_IPC_EVENT_MODE, event_msg);
454         FREE(event_msg);
455
456         return;
457     }
458
459     ELOG("ERROR: Mode not found\n");
460 }
461
462 static int reorder_binding_cmp(const void *a, const void *b) {
463     Binding *first = *((Binding **)a);
464     Binding *second = *((Binding **)b);
465     if (first->event_state_mask < second->event_state_mask) {
466         return 1;
467     } else if (first->event_state_mask == second->event_state_mask) {
468         return 0;
469     } else {
470         return -1;
471     }
472 }
473
474 static void reorder_bindings_of_mode(struct Mode *mode) {
475     /* Copy the bindings into an array, so that we can use qsort(3). */
476     int n = 0;
477     Binding *current;
478     TAILQ_FOREACH(current, mode->bindings, bindings) {
479         n++;
480     }
481     Binding **tmp = scalloc(n, sizeof(Binding *));
482     n = 0;
483     TAILQ_FOREACH(current, mode->bindings, bindings) {
484         tmp[n++] = current;
485     }
486
487     qsort(tmp, n, sizeof(Binding *), reorder_binding_cmp);
488
489     struct bindings_head *reordered = scalloc(1, sizeof(struct bindings_head));
490     TAILQ_INIT(reordered);
491     for (int i = 0; i < n; i++) {
492         current = tmp[i];
493         TAILQ_REMOVE(mode->bindings, current, bindings);
494         TAILQ_INSERT_TAIL(reordered, current, bindings);
495     }
496     free(tmp);
497     assert(TAILQ_EMPTY(mode->bindings));
498     /* Free the old bindings_head, which is now empty. */
499     free(mode->bindings);
500     mode->bindings = reordered;
501 }
502
503 /*
504  * Reorders bindings by event_state_mask descendingly so that get_binding()
505  * correctly matches more specific bindings before more generic bindings. Take
506  * the following binding configuration as an example:
507  *
508  *   bindsym n nop lower-case n pressed
509  *   bindsym Shift+n nop upper-case n pressed
510  *
511  * Without reordering, the first binding’s event_state_mask of 0x0 would match
512  * the actual event_stat_mask of 0x1 and hence trigger instead of the second
513  * keybinding.
514  *
515  */
516 void reorder_bindings(void) {
517     struct Mode *mode;
518     SLIST_FOREACH(mode, &modes, modes) {
519         const bool current_mode = (mode->bindings == bindings);
520         reorder_bindings_of_mode(mode);
521         if (current_mode)
522             bindings = mode->bindings;
523     }
524 }
525
526 /*
527  * Checks for duplicate key bindings (the same keycode or keysym is configured
528  * more than once). If a duplicate binding is found, a message is printed to
529  * stderr and the has_errors variable is set to true, which will start
530  * i3-nagbar.
531  *
532  */
533 void check_for_duplicate_bindings(struct context *context) {
534     Binding *bind, *current;
535     TAILQ_FOREACH(current, bindings, bindings) {
536         TAILQ_FOREACH(bind, bindings, bindings) {
537             /* Abort when we reach the current keybinding, only check the
538              * bindings before */
539             if (bind == current)
540                 break;
541
542             /* Check if the input types are different */
543             if (bind->input_type != current->input_type)
544                 continue;
545
546             /* Check if one is using keysym while the other is using bindsym.
547              * If so, skip. */
548             if ((bind->symbol == NULL && current->symbol != NULL) ||
549                 (bind->symbol != NULL && current->symbol == NULL))
550                 continue;
551
552             /* If bind is NULL, current has to be NULL, too (see above).
553              * If the keycodes differ, it can't be a duplicate. */
554             if (bind->symbol != NULL &&
555                 strcasecmp(bind->symbol, current->symbol) != 0)
556                 continue;
557
558             /* Check if the keycodes or modifiers are different. If so, they
559              * can't be duplicate */
560             if (bind->keycode != current->keycode ||
561                 bind->event_state_mask != current->event_state_mask ||
562                 bind->release != current->release)
563                 continue;
564
565             context->has_errors = true;
566             if (current->keycode != 0) {
567                 ELOG("Duplicate keybinding in config file:\n  state mask 0x%x with keycode %d, command \"%s\"\n",
568                      current->event_state_mask, current->keycode, current->command);
569             } else {
570                 ELOG("Duplicate keybinding in config file:\n  state mask 0x%x with keysym %s, command \"%s\"\n",
571                      current->event_state_mask, current->symbol, current->command);
572             }
573         }
574     }
575 }
576
577 /*
578  * Creates a dynamically allocated copy of bind.
579  */
580 static Binding *binding_copy(Binding *bind) {
581     Binding *ret = smalloc(sizeof(Binding));
582     *ret = *bind;
583     if (bind->symbol != NULL)
584         ret->symbol = sstrdup(bind->symbol);
585     if (bind->command != NULL)
586         ret->command = sstrdup(bind->command);
587     if (bind->translated_to != NULL) {
588         ret->translated_to = smalloc(sizeof(xcb_keycode_t) * bind->number_keycodes);
589         memcpy(ret->translated_to, bind->translated_to, sizeof(xcb_keycode_t) * bind->number_keycodes);
590     }
591     return ret;
592 }
593
594 /*
595  * Frees the binding. If bind is null, it simply returns.
596  */
597 void binding_free(Binding *bind) {
598     if (bind == NULL) {
599         return;
600     }
601
602     FREE(bind->symbol);
603     FREE(bind->translated_to);
604     FREE(bind->command);
605     FREE(bind);
606 }
607
608 /*
609  * Runs the given binding and handles parse errors. If con is passed, it will
610  * execute the command binding with that container selected by criteria.
611  * Returns a CommandResult for running the binding's command. Caller should
612  * render tree if needs_tree_render is true. Free with command_result_free().
613  *
614  */
615 CommandResult *run_binding(Binding *bind, Con *con) {
616     char *command;
617
618     /* We need to copy the binding and command since “reload” may be part of
619      * the command, and then the memory that bind points to may not contain the
620      * same data anymore. */
621     if (con == NULL)
622         command = sstrdup(bind->command);
623     else
624         sasprintf(&command, "[con_id=\"%p\"] %s", con, bind->command);
625
626     Binding *bind_cp = binding_copy(bind);
627     CommandResult *result = parse_command(command, NULL);
628     free(command);
629
630     if (result->needs_tree_render)
631         tree_render();
632
633     if (result->parse_error) {
634         char *pageraction;
635         sasprintf(&pageraction, "i3-sensible-pager \"%s\"\n", errorfilename);
636         char *argv[] = {
637             NULL, /* will be replaced by the executable path */
638             "-f",
639             config.font.pattern,
640             "-t",
641             "error",
642             "-m",
643             "The configured command for this shortcut could not be run successfully.",
644             "-b",
645             "show errors",
646             pageraction,
647             NULL};
648         start_nagbar(&command_error_nagbar_pid, argv);
649         free(pageraction);
650     }
651
652     ipc_send_binding_event("run", bind_cp);
653     binding_free(bind_cp);
654
655     return result;
656 }
657
658 static int fill_rmlvo_from_root(struct xkb_rule_names *xkb_names) {
659     xcb_intern_atom_reply_t *atom_reply;
660     size_t content_max_words = 256;
661
662     xcb_window_t root = root_screen->root;
663
664     atom_reply = xcb_intern_atom_reply(
665         conn, xcb_intern_atom(conn, 0, strlen("_XKB_RULES_NAMES"), "_XKB_RULES_NAMES"), NULL);
666     if (atom_reply == NULL)
667         return -1;
668
669     xcb_get_property_cookie_t prop_cookie;
670     xcb_get_property_reply_t *prop_reply;
671     prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom,
672                                              XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words);
673     prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL);
674     if (prop_reply == NULL) {
675         free(atom_reply);
676         return -1;
677     }
678     if (xcb_get_property_value_length(prop_reply) > 0 && prop_reply->bytes_after > 0) {
679         /* We received an incomplete value. Ask again but with a properly
680          * adjusted size. */
681         content_max_words += ceil(prop_reply->bytes_after / 4.0);
682         /* Repeat the request, with adjusted size */
683         free(prop_reply);
684         prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom,
685                                                  XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words);
686         prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL);
687         if (prop_reply == NULL) {
688             free(atom_reply);
689             return -1;
690         }
691     }
692     if (xcb_get_property_value_length(prop_reply) == 0) {
693         free(atom_reply);
694         free(prop_reply);
695         return -1;
696     }
697
698     const char *walk = (const char *)xcb_get_property_value(prop_reply);
699     int remaining = xcb_get_property_value_length(prop_reply);
700     for (int i = 0; i < 5 && remaining > 0; i++) {
701         const int len = strnlen(walk, remaining);
702         remaining -= len;
703         switch (i) {
704             case 0:
705                 sasprintf((char **)&(xkb_names->rules), "%.*s", len, walk);
706                 break;
707             case 1:
708                 sasprintf((char **)&(xkb_names->model), "%.*s", len, walk);
709                 break;
710             case 2:
711                 sasprintf((char **)&(xkb_names->layout), "%.*s", len, walk);
712                 break;
713             case 3:
714                 sasprintf((char **)&(xkb_names->variant), "%.*s", len, walk);
715                 break;
716             case 4:
717                 sasprintf((char **)&(xkb_names->options), "%.*s", len, walk);
718                 break;
719         }
720         DLOG("component %d of _XKB_RULES_NAMES is \"%.*s\"\n", i, len, walk);
721         walk += (len + 1);
722     }
723
724     free(atom_reply);
725     free(prop_reply);
726     return 0;
727 }
728
729 /*
730  * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
731  *
732  */
733 bool load_keymap(void) {
734     if (xkb_context == NULL) {
735         if ((xkb_context = xkb_context_new(0)) == NULL) {
736             ELOG("Could not create xkbcommon context\n");
737             return false;
738         }
739     }
740
741     struct xkb_keymap *new_keymap = NULL;
742     int32_t device_id;
743     if (xkb_supported && (device_id = xkb_x11_get_core_keyboard_device_id(conn)) > -1) {
744         if ((new_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0)) == NULL) {
745             ELOG("xkb_x11_keymap_new_from_device failed\n");
746             return false;
747         }
748     } else {
749         /* Likely there is no XKB support on this server, possibly because it
750          * is a VNC server. */
751         LOG("No XKB / core keyboard device? Assembling keymap from local RMLVO.\n");
752         struct xkb_rule_names names = {
753             .rules = NULL,
754             .model = NULL,
755             .layout = NULL,
756             .variant = NULL,
757             .options = NULL};
758         if (fill_rmlvo_from_root(&names) == -1) {
759             ELOG("Could not get _XKB_RULES_NAMES atom from root window, falling back to defaults.\n");
760             if ((new_keymap = xkb_keymap_new_from_names(xkb_context, &names, 0)) == NULL) {
761                 ELOG("xkb_keymap_new_from_names(NULL) failed\n");
762                 return false;
763             }
764         }
765         new_keymap = xkb_keymap_new_from_names(xkb_context, &names, 0);
766         free((char *)names.rules);
767         free((char *)names.model);
768         free((char *)names.layout);
769         free((char *)names.variant);
770         free((char *)names.options);
771         if (new_keymap == NULL) {
772             ELOG("xkb_keymap_new_from_names(RMLVO) failed\n");
773             return false;
774         }
775     }
776     xkb_keymap_unref(xkb_keymap);
777     xkb_keymap = new_keymap;
778
779     return true;
780 }