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