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