git.sur5r.net Git - i3/i3/blob - 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("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
  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     TAILQ_INIT(&(new_binding->keycodes_head));
  99
 100     return new_binding;
 101 }
 102
 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)
 106         return true;
 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);
 116         default:
 117             ELOG("BUG: xkb_current_group (= %d) outside of [XCB_XKB_GROUP_1..XCB_XKB_GROUP_4]\n", xkb_current_group);
 118             return false;
 119     }
 120 }
 121
 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)                                                                       \
 125     do {                                                                                         \
 126         xcb_grab_key(conn, 0, root, modifier, keycode, XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC); \
 127     } while (0)
 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);
 131     GRAB_KEY(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);
 138 }
 139
 140 /*
 141  * Grab the bound keys (tell X to send us keypress events for those keycodes)
 142  *
 143  */
 144 void grab_all_keys(xcb_connection_t *conn) {
 145     Binding *bind;
 146     TAILQ_FOREACH(bind, bindings, bindings) {
 147         if (bind->input_type != B_KEYBOARD)
 148             continue;
 149
 150         if (!binding_in_current_group(bind))
 151             continue;
 152
 153         /* The easy case: the user specified a keycode directly. */
 154         if (bind->keycode > 0) {
 155             grab_keycode_for_binding(conn, bind, bind->keycode);
 156             continue;
 157         }
 158
 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);
 165         }
 166     }
 167 }
 168
 169 /*
 170  * Release the button grabs on all managed windows and regrab them,
 171  * reevaluating which buttons need to be grabbed.
 172  *
 173  */
 174 void regrab_all_buttons(xcb_connection_t *conn) {
 175     int *buttons = bindings_get_buttons_to_grab();
 176     xcb_grab_server(conn);
 177
 178     Con *con;
 179     TAILQ_FOREACH(con, &all_cons, all_cons) {
 180         if (con->window == NULL)
 181             continue;
 182
 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);
 185     }
 186
 187     FREE(buttons);
 188     xcb_ungrab_server(conn);
 189 }
 190
 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);
 198     }
 199     return ((modifiers_state & modifiers_mask) == modifiers_mask);
 200 }
 201
 202 /*
 203  * Returns a pointer to the Binding with the specified modifiers and
 204  * keycode or NULL if no such binding exists.
 205  *
 206  */
 207 static Binding *get_binding(i3_event_state_mask_t state_filtered, bool is_release, uint16_t input_code, input_type_t input_type) {
 208     Binding *bind;
 209
 210     if (!is_release) {
 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)
 215                 continue;
 216             if (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS)
 217                 bind->release = B_UPON_KEYRELEASE;
 218         }
 219     }
 220
 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)
 225             continue;
 226
 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);
 229         if (!groups_match) {
 230             DLOG("skipping binding %p because XKB groups do not match\n", bind);
 231             continue;
 232         }
 233
 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
 236          * keycode */
 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;
 248                     break;
 249                 }
 250             }
 251             if (!found_keycode)
 252                 continue;
 253         } else {
 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
 259              * event) */
 260             if (!mods_match &&
 261                 (bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
 262                  !is_release))
 263                 continue;
 264
 265             /* This case is easier: The user specified a keycode */
 266             if (bind->keycode != input_code)
 267                 continue;
 268         }
 269
 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);
 281             break;
 282         }
 283
 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))
 287             continue;
 288
 289         break;
 290     }
 291
 292     return (bind == TAILQ_END(bindings) ? NULL : bind);
 293 }
 294
 295 /*
 296  * Returns a pointer to the Binding that matches the given xcb button or key
 297  * event or NULL if no such binding exists.
 298  *
 299  */
 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);
 303
 304     const input_type_t input_type = ((event->response_type == XCB_BUTTON_RELEASE ||
 305                                       event->response_type == XCB_BUTTON_PRESS)
 306                                          ? B_MOUSE
 307                                          : B_KEYBOARD);
 308
 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;
 311
 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|.
 318      *
 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
 322      * section 2.2.2:
 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);
 327             break;
 328         case XCB_XKB_GROUP_2:
 329             state_filtered |= (I3_XKB_GROUP_MASK_2 << 16);
 330             break;
 331         case XCB_XKB_GROUP_3:
 332             state_filtered |= (I3_XKB_GROUP_MASK_3 << 16);
 333             break;
 334         case XCB_XKB_GROUP_4:
 335             state_filtered |= (I3_XKB_GROUP_MASK_4 << 16);
 336             break;
 337     }
 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);
 341 }
 342
 343 struct resolve {
 344     /* The binding which we are resolving. */
 345     Binding *bind;
 346
 347     /* |bind|’s keysym (translated to xkb_keysym_t), e.g. XKB_KEY_R. */
 348     xkb_keysym_t keysym;
 349
 350     /* The xkb state built from the user-provided modifiers and group. */
 351     struct xkb_state *xkb_state;
 352
 353     /* Like |xkb_state|, just without the shift modifier, if shift was specified. */
 354     struct xkb_state *xkb_state_no_shift;
 355
 356     /* Like |xkb_state|, but with NumLock. */
 357     struct xkb_state *xkb_state_numlock;
 358 };
 359
 360 /*
 361  * add_keycode_if_matches is called for each keycode in the keymap and will add
 362  * the keycode to |data->bind| if the keycode can result in the keysym
 363  * |data->resolving|.
 364  *
 365  */
 366 static void add_keycode_if_matches(struct xkb_keymap *keymap, xkb_keycode_t key, void *data) {
 367     const struct resolve *resolving = data;
 368     xkb_keysym_t sym = xkb_state_key_get_one_sym(resolving->xkb_state, key);
 369     if (sym != resolving->keysym) {
 370         /* Check if Shift was specified, and try resolving the symbol without
 371          * shift, so that “bindsym $mod+Shift+a nop” actually works. */
 372         const xkb_layout_index_t layout = xkb_state_key_get_layout(resolving->xkb_state, key);
 373         if (layout == XKB_LAYOUT_INVALID)
 374             return;
 375         if (xkb_state_key_get_level(resolving->xkb_state, key, layout) > 1)
 376             return;
 377         sym = xkb_state_key_get_one_sym(resolving->xkb_state_no_shift, key);
 378         if (sym != resolving->keysym)
 379             return;
 380     }
 381     Binding *bind = resolving->bind;
 382
 383 #define ADD_TRANSLATED_KEY(mods)                                                           \
 384     do {                                                                                   \
 385         struct Binding_Keycode *binding_keycode = smalloc(sizeof(struct Binding_Keycode)); \
 386         binding_keycode->modifiers = (mods);                                               \
 387         binding_keycode->keycode = key;                                                    \
 388         TAILQ_INSERT_TAIL(&(bind->keycodes_head), binding_keycode, keycodes);              \
 389     } while (0)
 390
 391     ADD_TRANSLATED_KEY(bind->event_state_mask);
 392
 393     /* Also bind the key with active CapsLock */
 394     ADD_TRANSLATED_KEY(bind->event_state_mask | XCB_MOD_MASK_LOCK);
 395
 396     /* If this binding is not explicitly for NumLock, check whether we need to
 397      * add a fallback. */
 398     if ((bind->event_state_mask & xcb_numlock_mask) != xcb_numlock_mask) {
 399         /* Check whether the keycode results in the same keysym when NumLock is
 400          * active. If so, grab the key with NumLock as well, so that users don’t
 401          * need to duplicate every key binding with an additional Mod2 specified.
 402          */
 403         xkb_keysym_t sym_numlock = xkb_state_key_get_one_sym(resolving->xkb_state_numlock, key);
 404         if (sym_numlock == resolving->keysym) {
 405             /* Also bind the key with active NumLock */
 406             ADD_TRANSLATED_KEY(bind->event_state_mask | xcb_numlock_mask);
 407
 408             /* Also bind the key with active NumLock+CapsLock */
 409             ADD_TRANSLATED_KEY(bind->event_state_mask | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
 410         } else {
 411             DLOG("Skipping automatic numlock fallback, key %d resolves to 0x%x with numlock\n",
 412                  key, sym_numlock);
 413         }
 414     }
 415
 416 #undef ADD_TRANSLATED_KEY
 417 }
 418
 419 /*
 420  * Translates keysymbols to keycodes for all bindings which use keysyms.
 421  *
 422  */
 423 void translate_keysyms(void) {
 424     struct xkb_state *dummy_state = xkb_state_new(xkb_keymap);
 425     if (dummy_state == NULL) {
 426         ELOG("Could not create XKB state, cannot translate keysyms.\n");
 427         return;
 428     }
 429
 430     struct xkb_state *dummy_state_no_shift = xkb_state_new(xkb_keymap);
 431     if (dummy_state_no_shift == NULL) {
 432         ELOG("Could not create XKB state, cannot translate keysyms.\n");
 433         return;
 434     }
 435
 436     struct xkb_state *dummy_state_numlock = xkb_state_new(xkb_keymap);
 437     if (dummy_state_numlock == NULL) {
 438         ELOG("Could not create XKB state, cannot translate keysyms.\n");
 439         return;
 440     }
 441
 442     bool has_errors = false;
 443     Binding *bind;
 444     TAILQ_FOREACH(bind, bindings, bindings) {
 445         if (bind->input_type == B_MOUSE) {
 446             char *endptr;
 447             long button = strtol(bind->symbol + (sizeof("button") - 1), &endptr, 10);
 448             bind->keycode = button;
 449
 450             if (button == LONG_MAX || button == LONG_MIN || button < 0 || *endptr != '\0' || endptr == bind->symbol)
 451                 ELOG("Could not translate string to button: \"%s\"\n", bind->symbol);
 452
 453             continue;
 454         }
 455
 456         if (bind->keycode > 0)
 457             continue;
 458
 459         /* We need to translate the symbol to a keycode */
 460         const xkb_keysym_t keysym = xkb_keysym_from_name(bind->symbol, XKB_KEYSYM_NO_FLAGS);
 461         if (keysym == XKB_KEY_NoSymbol) {
 462             ELOG("Could not translate string to key symbol: \"%s\"\n",
 463                  bind->symbol);
 464             continue;
 465         }
 466
 467         xkb_layout_index_t group = XCB_XKB_GROUP_1;
 468         if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2)
 469             group = XCB_XKB_GROUP_2;
 470         else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3)
 471             group = XCB_XKB_GROUP_3;
 472         else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4)
 473             group = XCB_XKB_GROUP_4;
 474
 475         DLOG("Binding %p group = %d, event_state_mask = %d, &2 = %s, &3 = %s, &4 = %s\n",
 476              bind,
 477              group,
 478              bind->event_state_mask,
 479              (bind->event_state_mask & I3_XKB_GROUP_MASK_2) ? "yes" : "no",
 480              (bind->event_state_mask & I3_XKB_GROUP_MASK_3) ? "yes" : "no",
 481              (bind->event_state_mask & I3_XKB_GROUP_MASK_4) ? "yes" : "no");
 482         (void)xkb_state_update_mask(
 483             dummy_state,
 484             (bind->event_state_mask & 0x1FFF) /* xkb_mod_mask_t base_mods, */,
 485             0 /* xkb_mod_mask_t latched_mods, */,
 486             0 /* xkb_mod_mask_t locked_mods, */,
 487             0 /* xkb_layout_index_t base_group, */,
 488             0 /* xkb_layout_index_t latched_group, */,
 489             group /* xkb_layout_index_t locked_group, */);
 490
 491         (void)xkb_state_update_mask(
 492             dummy_state_no_shift,
 493             (bind->event_state_mask & 0x1FFF) ^ XCB_KEY_BUT_MASK_SHIFT /* xkb_mod_mask_t base_mods, */,
 494             0 /* xkb_mod_mask_t latched_mods, */,
 495             0 /* xkb_mod_mask_t locked_mods, */,
 496             0 /* xkb_layout_index_t base_group, */,
 497             0 /* xkb_layout_index_t latched_group, */,
 498             group /* xkb_layout_index_t locked_group, */);
 499
 500         (void)xkb_state_update_mask(
 501             dummy_state_numlock,
 502             (bind->event_state_mask & 0x1FFF) | xcb_numlock_mask /* xkb_mod_mask_t base_mods, */,
 503             0 /* xkb_mod_mask_t latched_mods, */,
 504             0 /* xkb_mod_mask_t locked_mods, */,
 505             0 /* xkb_layout_index_t base_group, */,
 506             0 /* xkb_layout_index_t latched_group, */,
 507             group /* xkb_layout_index_t locked_group, */);
 508
 509         struct resolve resolving = {
 510             .bind = bind,
 511             .keysym = keysym,
 512             .xkb_state = dummy_state,
 513             .xkb_state_no_shift = dummy_state_no_shift,
 514             .xkb_state_numlock = dummy_state_numlock,
 515         };
 516         while (!TAILQ_EMPTY(&(bind->keycodes_head))) {
 517             struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head));
 518             TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes);
 519             FREE(first);
 520         }
 521         xkb_keymap_key_for_each(xkb_keymap, add_keycode_if_matches, &resolving);
 522         char *keycodes = sstrdup("");
 523         int num_keycodes = 0;
 524         struct Binding_Keycode *binding_keycode;
 525         TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
 526             char *tmp;
 527             sasprintf(&tmp, "%s %d", keycodes, binding_keycode->keycode);
 528             free(keycodes);
 529             keycodes = tmp;
 530             num_keycodes++;
 531
 532             /* check for duplicate bindings */
 533             Binding *check;
 534             TAILQ_FOREACH(check, bindings, bindings) {
 535                 if (check == bind)
 536                     continue;
 537                 if (check->symbol != NULL)
 538                     continue;
 539                 if (check->keycode != binding_keycode->keycode ||
 540                     check->event_state_mask != binding_keycode->modifiers ||
 541                     check->release != bind->release)
 542                     continue;
 543                 has_errors = true;
 544                 ELOG("Duplicate keybinding in config file:\n  keysym = %s, keycode = %d, state_mask = 0x%x\n", bind->symbol, check->keycode, bind->event_state_mask);
 545             }
 546         }
 547         DLOG("state=0x%x, cfg=\"%s\", sym=0x%x → keycodes%s (%d)\n",
 548              bind->event_state_mask, bind->symbol, keysym, keycodes, num_keycodes);
 549         free(keycodes);
 550     }
 551
 552     xkb_state_unref(dummy_state);
 553     xkb_state_unref(dummy_state_no_shift);
 554     xkb_state_unref(dummy_state_numlock);
 555
 556     if (has_errors) {
 557         start_config_error_nagbar(current_configpath, true);
 558     }
 559 }
 560
 561 /*
 562  * Switches the key bindings to the given mode, if the mode exists
 563  *
 564  */
 565 void switch_mode(const char *new_mode) {
 566     struct Mode *mode;
 567
 568     DLOG("Switching to mode %s\n", new_mode);
 569
 570     SLIST_FOREACH(mode, &modes, modes) {
 571         if (strcasecmp(mode->name, new_mode) != 0)
 572             continue;
 573
 574         ungrab_all_keys(conn);
 575         bindings = mode->bindings;
 576         translate_keysyms();
 577         grab_all_keys(conn);
 578
 579         char *event_msg;
 580         sasprintf(&event_msg, "{\"change\":\"%s\", \"pango_markup\":%s}",
 581                   mode->name, (mode->pango_markup ? "true" : "false"));
 582
 583         ipc_send_event("mode", I3_IPC_EVENT_MODE, event_msg);
 584         FREE(event_msg);
 585
 586         return;
 587     }
 588
 589     ELOG("ERROR: Mode not found\n");
 590 }
 591
 592 static int reorder_binding_cmp(const void *a, const void *b) {
 593     Binding *first = *((Binding **)a);
 594     Binding *second = *((Binding **)b);
 595     if (first->event_state_mask < second->event_state_mask) {
 596         return 1;
 597     } else if (first->event_state_mask == second->event_state_mask) {
 598         return 0;
 599     } else {
 600         return -1;
 601     }
 602 }
 603
 604 static void reorder_bindings_of_mode(struct Mode *mode) {
 605     /* Copy the bindings into an array, so that we can use qsort(3). */
 606     int n = 0;
 607     Binding *current;
 608     TAILQ_FOREACH(current, mode->bindings, bindings) {
 609         n++;
 610     }
 611     Binding **tmp = scalloc(n, sizeof(Binding *));
 612     n = 0;
 613     TAILQ_FOREACH(current, mode->bindings, bindings) {
 614         tmp[n++] = current;
 615     }
 616
 617     qsort(tmp, n, sizeof(Binding *), reorder_binding_cmp);
 618
 619     struct bindings_head *reordered = scalloc(1, sizeof(struct bindings_head));
 620     TAILQ_INIT(reordered);
 621     for (int i = 0; i < n; i++) {
 622         current = tmp[i];
 623         TAILQ_REMOVE(mode->bindings, current, bindings);
 624         TAILQ_INSERT_TAIL(reordered, current, bindings);
 625     }
 626     free(tmp);
 627     assert(TAILQ_EMPTY(mode->bindings));
 628     /* Free the old bindings_head, which is now empty. */
 629     free(mode->bindings);
 630     mode->bindings = reordered;
 631 }
 632
 633 /*
 634  * Reorders bindings by event_state_mask descendingly so that get_binding()
 635  * correctly matches more specific bindings before more generic bindings. Take
 636  * the following binding configuration as an example:
 637  *
 638  *   bindsym n nop lower-case n pressed
 639  *   bindsym Shift+n nop upper-case n pressed
 640  *
 641  * Without reordering, the first binding’s event_state_mask of 0x0 would match
 642  * the actual event_stat_mask of 0x1 and hence trigger instead of the second
 643  * keybinding.
 644  *
 645  */
 646 void reorder_bindings(void) {
 647     struct Mode *mode;
 648     SLIST_FOREACH(mode, &modes, modes) {
 649         const bool current_mode = (mode->bindings == bindings);
 650         reorder_bindings_of_mode(mode);
 651         if (current_mode)
 652             bindings = mode->bindings;
 653     }
 654 }
 655
 656 /*
 657  * Checks for duplicate key bindings (the same keycode or keysym is configured
 658  * more than once). If a duplicate binding is found, a message is printed to
 659  * stderr and the has_errors variable is set to true, which will start
 660  * i3-nagbar.
 661  *
 662  */
 663 void check_for_duplicate_bindings(struct context *context) {
 664     Binding *bind, *current;
 665     TAILQ_FOREACH(current, bindings, bindings) {
 666         TAILQ_FOREACH(bind, bindings, bindings) {
 667             /* Abort when we reach the current keybinding, only check the
 668              * bindings before */
 669             if (bind == current)
 670                 break;
 671
 672             /* Check if the input types are different */
 673             if (bind->input_type != current->input_type)
 674                 continue;
 675
 676             /* Check if one is using keysym while the other is using bindsym.
 677              * If so, skip. */
 678             if ((bind->symbol == NULL && current->symbol != NULL) ||
 679                 (bind->symbol != NULL && current->symbol == NULL))
 680                 continue;
 681
 682             /* If bind is NULL, current has to be NULL, too (see above).
 683              * If the keycodes differ, it can't be a duplicate. */
 684             if (bind->symbol != NULL &&
 685                 strcasecmp(bind->symbol, current->symbol) != 0)
 686                 continue;
 687
 688             /* Check if the keycodes or modifiers are different. If so, they
 689              * can't be duplicate */
 690             if (bind->keycode != current->keycode ||
 691                 bind->event_state_mask != current->event_state_mask ||
 692                 bind->release != current->release)
 693                 continue;
 694
 695             context->has_errors = true;
 696             if (current->keycode != 0) {
 697                 ELOG("Duplicate keybinding in config file:\n  state mask 0x%x with keycode %d, command \"%s\"\n",
 698                      current->event_state_mask, current->keycode, current->command);
 699             } else {
 700                 ELOG("Duplicate keybinding in config file:\n  state mask 0x%x with keysym %s, command \"%s\"\n",
 701                      current->event_state_mask, current->symbol, current->command);
 702             }
 703         }
 704     }
 705 }
 706
 707 /*
 708  * Creates a dynamically allocated copy of bind.
 709  */
 710 static Binding *binding_copy(Binding *bind) {
 711     Binding *ret = smalloc(sizeof(Binding));
 712     *ret = *bind;
 713     if (bind->symbol != NULL)
 714         ret->symbol = sstrdup(bind->symbol);
 715     if (bind->command != NULL)
 716         ret->command = sstrdup(bind->command);
 717     TAILQ_INIT(&(ret->keycodes_head));
 718     struct Binding_Keycode *binding_keycode;
 719     TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {
 720         struct Binding_Keycode *ret_binding_keycode = smalloc(sizeof(struct Binding_Keycode));
 721         *ret_binding_keycode = *binding_keycode;
 722         TAILQ_INSERT_TAIL(&(ret->keycodes_head), ret_binding_keycode, keycodes);
 723     }
 724
 725     return ret;
 726 }
 727
 728 /*
 729  * Frees the binding. If bind is null, it simply returns.
 730  */
 731 void binding_free(Binding *bind) {
 732     if (bind == NULL) {
 733         return;
 734     }
 735
 736     while (!TAILQ_EMPTY(&(bind->keycodes_head))) {
 737         struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head));
 738         TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes);
 739         FREE(first);
 740     }
 741
 742     FREE(bind->symbol);
 743     FREE(bind->command);
 744     FREE(bind);
 745 }
 746
 747 /*
 748  * Runs the given binding and handles parse errors. If con is passed, it will
 749  * execute the command binding with that container selected by criteria.
 750  * Returns a CommandResult for running the binding's command. Free with
 751  * command_result_free().
 752  *
 753  */
 754 CommandResult *run_binding(Binding *bind, Con *con) {
 755     char *command;
 756
 757     /* We need to copy the binding and command since “reload” may be part of
 758      * the command, and then the memory that bind points to may not contain the
 759      * same data anymore. */
 760     if (con == NULL)
 761         command = sstrdup(bind->command);
 762     else
 763         sasprintf(&command, "[con_id=\"%p\"] %s", con, bind->command);
 764
 765     Binding *bind_cp = binding_copy(bind);
 766     CommandResult *result = parse_command(command, NULL);
 767     free(command);
 768
 769     if (result->needs_tree_render)
 770         tree_render();
 771
 772     if (result->parse_error) {
 773         char *pageraction;
 774         sasprintf(&pageraction, "i3-sensible-pager \"%s\"\n", errorfilename);
 775         char *argv[] = {
 776             NULL, /* will be replaced by the executable path */
 777             "-f",
 778             config.font.pattern,
 779             "-t",
 780             "error",
 781             "-m",
 782             "The configured command for this shortcut could not be run successfully.",
 783             "-b",
 784             "show errors",
 785             pageraction,
 786             NULL};
 787         start_nagbar(&command_error_nagbar_pid, argv);
 788         free(pageraction);
 789     }
 790
 791     ipc_send_binding_event("run", bind_cp);
 792     binding_free(bind_cp);
 793
 794     return result;
 795 }
 796
 797 static int fill_rmlvo_from_root(struct xkb_rule_names *xkb_names) {
 798     xcb_intern_atom_reply_t *atom_reply;
 799     size_t content_max_words = 256;
 800
 801     xcb_window_t root = root_screen->root;
 802
 803     atom_reply = xcb_intern_atom_reply(
 804         conn, xcb_intern_atom(conn, 0, strlen("_XKB_RULES_NAMES"), "_XKB_RULES_NAMES"), NULL);
 805     if (atom_reply == NULL)
 806         return -1;
 807
 808     xcb_get_property_cookie_t prop_cookie;
 809     xcb_get_property_reply_t *prop_reply;
 810     prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom,
 811                                              XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words);
 812     prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL);
 813     if (prop_reply == NULL) {
 814         free(atom_reply);
 815         return -1;
 816     }
 817     if (xcb_get_property_value_length(prop_reply) > 0 && prop_reply->bytes_after > 0) {
 818         /* We received an incomplete value. Ask again but with a properly
 819          * adjusted size. */
 820         content_max_words += ceil(prop_reply->bytes_after / 4.0);
 821         /* Repeat the request, with adjusted size */
 822         free(prop_reply);
 823         prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom,
 824                                                  XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words);
 825         prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL);
 826         if (prop_reply == NULL) {
 827             free(atom_reply);
 828             return -1;
 829         }
 830     }
 831     if (xcb_get_property_value_length(prop_reply) == 0) {
 832         free(atom_reply);
 833         free(prop_reply);
 834         return -1;
 835     }
 836
 837     const char *walk = (const char *)xcb_get_property_value(prop_reply);
 838     int remaining = xcb_get_property_value_length(prop_reply);
 839     for (int i = 0; i < 5 && remaining > 0; i++) {
 840         const int len = strnlen(walk, remaining);
 841         remaining -= len;
 842         switch (i) {
 843             case 0:
 844                 sasprintf((char **)&(xkb_names->rules), "%.*s", len, walk);
 845                 break;
 846             case 1:
 847                 sasprintf((char **)&(xkb_names->model), "%.*s", len, walk);
 848                 break;
 849             case 2:
 850                 sasprintf((char **)&(xkb_names->layout), "%.*s", len, walk);
 851                 break;
 852             case 3:
 853                 sasprintf((char **)&(xkb_names->variant), "%.*s", len, walk);
 854                 break;
 855             case 4:
 856                 sasprintf((char **)&(xkb_names->options), "%.*s", len, walk);
 857                 break;
 858         }
 859         DLOG("component %d of _XKB_RULES_NAMES is \"%.*s\"\n", i, len, walk);
 860         walk += (len + 1);
 861     }
 862
 863     free(atom_reply);
 864     free(prop_reply);
 865     return 0;
 866 }
 867
 868 /*
 869  * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
 870  *
 871  */
 872 bool load_keymap(void) {
 873     if (xkb_context == NULL) {
 874         if ((xkb_context = xkb_context_new(0)) == NULL) {
 875             ELOG("Could not create xkbcommon context\n");
 876             return false;
 877         }
 878     }
 879
 880     struct xkb_keymap *new_keymap = NULL;
 881     int32_t device_id;
 882     if (xkb_supported && (device_id = xkb_x11_get_core_keyboard_device_id(conn)) > -1) {
 883         if ((new_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0)) == NULL) {
 884             ELOG("xkb_x11_keymap_new_from_device failed\n");
 885             return false;
 886         }
 887     } else {
 888         /* Likely there is no XKB support on this server, possibly because it
 889          * is a VNC server. */
 890         LOG("No XKB / core keyboard device? Assembling keymap from local RMLVO.\n");
 891         struct xkb_rule_names names = {
 892             .rules = NULL,
 893             .model = NULL,
 894             .layout = NULL,
 895             .variant = NULL,
 896             .options = NULL};
 897         if (fill_rmlvo_from_root(&names) == -1) {
 898             ELOG("Could not get _XKB_RULES_NAMES atom from root window, falling back to defaults.\n");
 899             if ((new_keymap = xkb_keymap_new_from_names(xkb_context, &names, 0)) == NULL) {
 900                 ELOG("xkb_keymap_new_from_names(NULL) failed\n");
 901                 return false;
 902             }
 903         }
 904         new_keymap = xkb_keymap_new_from_names(xkb_context, &names, 0);
 905         free((char *)names.rules);
 906         free((char *)names.model);
 907         free((char *)names.layout);
 908         free((char *)names.variant);
 909         free((char *)names.options);
 910         if (new_keymap == NULL) {
 911             ELOG("xkb_keymap_new_from_names(RMLVO) failed\n");
 912             return false;
 913         }
 914     }
 915     xkb_keymap_unref(xkb_keymap);
 916     xkb_keymap = new_keymap;
 917
 918     return true;
 919 }
 920
 921 /*
 922  * Returns a list of buttons that should be grabbed on a window.
 923  * This list will always contain 1–3, all higher buttons will only be returned
 924  * if there is a whole-window binding for it on some window in the current
 925  * config.
 926  * The list is terminated by a 0.
 927  */
 928 int *bindings_get_buttons_to_grab(void) {
 929     /* Let's make the reasonable assumption that there's no more than 25
 930      * buttons. */
 931     int num_max = 25;
 932
 933     int buffer[num_max];
 934     int num = 0;
 935
 936     /* We always return buttons 1 through 3. */
 937     buffer[num++] = 1;
 938     buffer[num++] = 2;
 939     buffer[num++] = 3;
 940
 941     Binding *bind;
 942     TAILQ_FOREACH(bind, bindings, bindings) {
 943         if (num + 1 == num_max)
 944             break;
 945
 946         /* We are only interested in whole window mouse bindings. */
 947         if (bind->input_type != B_MOUSE || !bind->whole_window)
 948             continue;
 949
 950         char *endptr;
 951         long button = strtol(bind->symbol + (sizeof("button") - 1), &endptr, 10);
 952         if (button == LONG_MAX || button == LONG_MIN || button < 0 || *endptr != '\0' || endptr == bind->symbol) {
 953             ELOG("Could not parse button number, skipping this binding. Please report this bug in i3.\n");
 954             continue;
 955         }
 956
 957         /* Avoid duplicates. */
 958         for (int i = 0; i < num_max; i++) {
 959             if (buffer[i] == button)
 960                 continue;
 961         }
 962
 963         buffer[num++] = button;
 964     }
 965     buffer[num++] = 0;
 966
 967     int *buttons = scalloc(num, sizeof(int));
 968     memcpy(buttons, buffer, num * sizeof(int));
 969
 970     return buttons;
 971 }