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