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