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