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