git.sur5r.net Git - i3/i3/blob

1 /*

2 * vim:ts=4:sw=4:expandtab

3 *

4 * i3 - an improved dynamic tiling window manager

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 /*

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 = NULL;

435 struct xkb_state *dummy_state_no_shift = NULL;

436 struct xkb_state *dummy_state_numlock = NULL;

437 struct xkb_state *dummy_state_numlock_no_shift = NULL;

438 bool has_errors = false;

439

440 if ((dummy_state = xkb_state_new(xkb_keymap)) == NULL ||

441 (dummy_state_no_shift = xkb_state_new(xkb_keymap)) == NULL ||

442 (dummy_state_numlock = xkb_state_new(xkb_keymap)) == NULL ||

443 (dummy_state_numlock_no_shift = xkb_state_new(xkb_keymap)) == NULL) {

444 ELOG("Could not create XKB state, cannot translate keysyms.\n");

445 goto out;

446 }

447

448 Binding *bind;

449 TAILQ_FOREACH(bind, bindings, bindings) {

450 #define ADD_TRANSLATED_KEY(code, mods) \

451 do { \

452 struct Binding_Keycode *binding_keycode = smalloc(sizeof(struct Binding_Keycode)); \

453 binding_keycode->modifiers = (mods); \

454 binding_keycode->keycode = (code); \

455 TAILQ_INSERT_TAIL(&(bind->keycodes_head), binding_keycode, keycodes); \

456 } while (0)

457

458 if (bind->input_type == B_MOUSE) {

459 long button;

460 if (!parse_long(bind->symbol + (sizeof("button") - 1), &button, 10)) {

461 ELOG("Could not translate string to button: \"%s\"\n", bind->symbol);

462 }

463

464 xcb_keycode_t key = button;

465 bind->keycode = key;

466 DLOG("Binding Mouse button, Keycode = %d\n", key);

467 }

468

469 xkb_layout_index_t group = XCB_XKB_GROUP_1;

470 if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_2)

471 group = XCB_XKB_GROUP_2;

472 else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_3)

473 group = XCB_XKB_GROUP_3;

474 else if ((bind->event_state_mask >> 16) & I3_XKB_GROUP_MASK_4)

475 group = XCB_XKB_GROUP_4;

476

477 DLOG("Binding %p group = %d, event_state_mask = %d, &2 = %s, &3 = %s, &4 = %s\n",

478 bind,

479 group,

480 bind->event_state_mask,

481 (bind->event_state_mask & I3_XKB_GROUP_MASK_2) ? "yes" : "no",

482 (bind->event_state_mask & I3_XKB_GROUP_MASK_3) ? "yes" : "no",

483 (bind->event_state_mask & I3_XKB_GROUP_MASK_4) ? "yes" : "no");

484 (void)xkb_state_update_mask(

485 dummy_state,

486 (bind->event_state_mask & 0x1FFF) /* xkb_mod_mask_t base_mods, */,

487 0 /* xkb_mod_mask_t latched_mods, */,

488 0 /* xkb_mod_mask_t locked_mods, */,

489 0 /* xkb_layout_index_t base_group, */,

490 0 /* xkb_layout_index_t latched_group, */,

491 group /* xkb_layout_index_t locked_group, */);

492

493 (void)xkb_state_update_mask(

494 dummy_state_no_shift,

495 (bind->event_state_mask & 0x1FFF) ^ XCB_KEY_BUT_MASK_SHIFT /* xkb_mod_mask_t base_mods, */,

496 0 /* xkb_mod_mask_t latched_mods, */,

497 0 /* xkb_mod_mask_t locked_mods, */,

498 0 /* xkb_layout_index_t base_group, */,

499 0 /* xkb_layout_index_t latched_group, */,

500 group /* xkb_layout_index_t locked_group, */);

501

502 (void)xkb_state_update_mask(

503 dummy_state_numlock,

504 (bind->event_state_mask & 0x1FFF) | xcb_numlock_mask /* xkb_mod_mask_t base_mods, */,

505 0 /* xkb_mod_mask_t latched_mods, */,

506 0 /* xkb_mod_mask_t locked_mods, */,

507 0 /* xkb_layout_index_t base_group, */,

508 0 /* xkb_layout_index_t latched_group, */,

509 group /* xkb_layout_index_t locked_group, */);

510

511 (void)xkb_state_update_mask(

512 dummy_state_numlock_no_shift,

513 ((bind->event_state_mask & 0x1FFF) | xcb_numlock_mask) ^ XCB_KEY_BUT_MASK_SHIFT /* xkb_mod_mask_t base_mods, */,

514 0 /* xkb_mod_mask_t latched_mods, */,

515 0 /* xkb_mod_mask_t locked_mods, */,

516 0 /* xkb_layout_index_t base_group, */,

517 0 /* xkb_layout_index_t latched_group, */,

518 group /* xkb_layout_index_t locked_group, */);

519

520 if (bind->keycode > 0) {

521 /* We need to specify modifiers for the keycode binding (numlock

522 * fallback). */

523 while (!TAILQ_EMPTY(&(bind->keycodes_head))) {

524 struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head));

525 TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes);

526 FREE(first);

527 }

528

529 ADD_TRANSLATED_KEY(bind->keycode, bind->event_state_mask);

530

531 /* Also bind the key with active CapsLock */

532 ADD_TRANSLATED_KEY(bind->keycode, bind->event_state_mask | XCB_MOD_MASK_LOCK);

533

534 /* If this binding is not explicitly for NumLock, check whether we need to

535 * add a fallback. */

536 if ((bind->event_state_mask & xcb_numlock_mask) != xcb_numlock_mask) {

537 /* Check whether the keycode results in the same keysym when NumLock is

538 * active. If so, grab the key with NumLock as well, so that users don’t

539 * need to duplicate every key binding with an additional Mod2 specified.

540 */

541 xkb_keysym_t sym = xkb_state_key_get_one_sym(dummy_state, bind->keycode);

542 xkb_keysym_t sym_numlock = xkb_state_key_get_one_sym(dummy_state_numlock, bind->keycode);

543 if (sym == sym_numlock) {

544 /* Also bind the key with active NumLock */

545 ADD_TRANSLATED_KEY(bind->keycode, bind->event_state_mask | xcb_numlock_mask);

546

547 /* Also bind the key with active NumLock+CapsLock */

548 ADD_TRANSLATED_KEY(bind->keycode, bind->event_state_mask | xcb_numlock_mask | XCB_MOD_MASK_LOCK);

549 } else {

550 DLOG("Skipping automatic numlock fallback, key %d resolves to 0x%x with numlock\n",

551 bind->keycode, sym_numlock);

552 }

553 }

554

555 continue;

556 }

557

558 /* We need to translate the symbol to a keycode */

559 const xkb_keysym_t keysym = xkb_keysym_from_name(bind->symbol, XKB_KEYSYM_NO_FLAGS);

560 if (keysym == XKB_KEY_NoSymbol) {

561 ELOG("Could not translate string to key symbol: \"%s\"\n",

562 bind->symbol);

563 continue;

564 }

565

566 struct resolve resolving = {

567 .bind = bind,

568 .keysym = keysym,

569 .xkb_state = dummy_state,

570 .xkb_state_no_shift = dummy_state_no_shift,

571 .xkb_state_numlock = dummy_state_numlock,

572 .xkb_state_numlock_no_shift = dummy_state_numlock_no_shift,

573 };

574 while (!TAILQ_EMPTY(&(bind->keycodes_head))) {

575 struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head));

576 TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes);

577 FREE(first);

578 }

579 xkb_keymap_key_for_each(xkb_keymap, add_keycode_if_matches, &resolving);

580 char *keycodes = sstrdup("");

581 int num_keycodes = 0;

582 struct Binding_Keycode *binding_keycode;

583 TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {

584 char *tmp;

585 sasprintf(&tmp, "%s %d", keycodes, binding_keycode->keycode);

586 free(keycodes);

587 keycodes = tmp;

588 num_keycodes++;

589

590 /* check for duplicate bindings */

591 Binding *check;

592 TAILQ_FOREACH(check, bindings, bindings) {

593 if (check == bind)

594 continue;

595 if (check->symbol != NULL)

596 continue;

597 if (check->keycode != binding_keycode->keycode ||

598 check->event_state_mask != binding_keycode->modifiers ||

599 check->release != bind->release)

600 continue;

601 has_errors = true;

602 ELOG("Duplicate keybinding in config file:\n keysym = %s, keycode = %d, state_mask = 0x%x\n", bind->symbol, check->keycode, bind->event_state_mask);

603 }

604 }

605 DLOG("state=0x%x, cfg=\"%s\", sym=0x%x → keycodes%s (%d)\n",

606 bind->event_state_mask, bind->symbol, keysym, keycodes, num_keycodes);

607 free(keycodes);

608

609 #undef ADD_TRANSLATED_KEY

610 }

611

612 out:

613 xkb_state_unref(dummy_state);

614 xkb_state_unref(dummy_state_no_shift);

615 xkb_state_unref(dummy_state_numlock);

616 xkb_state_unref(dummy_state_numlock_no_shift);

617

618 if (has_errors) {

619 start_config_error_nagbar(current_configpath, true);

620 }

621 }

622

623 /*

624 * Switches the key bindings to the given mode, if the mode exists

625 *

626 */

627 void switch_mode(const char *new_mode) {

628 struct Mode *mode;

629

630 DLOG("Switching to mode %s\n", new_mode);

631

632 SLIST_FOREACH(mode, &modes, modes) {

633 if (strcasecmp(mode->name, new_mode) != 0)

634 continue;

635

636 ungrab_all_keys(conn);

637 bindings = mode->bindings;

638 translate_keysyms();

639 grab_all_keys(conn);

640

641 char *event_msg;

642 sasprintf(&event_msg, "{\"change\":\"%s\", \"pango_markup\":%s}",

643 mode->name, (mode->pango_markup ? "true" : "false"));

644

645 ipc_send_event("mode", I3_IPC_EVENT_MODE, event_msg);

646 FREE(event_msg);

647

648 return;

649 }

650

651 ELOG("ERROR: Mode not found\n");

652 }

653

654 static int reorder_binding_cmp(const void *a, const void *b) {

655 Binding *first = *((Binding **)a);

656 Binding *second = *((Binding **)b);

657 if (first->event_state_mask < second->event_state_mask) {

658 return 1;

659 } else if (first->event_state_mask == second->event_state_mask) {

660 return 0;

661 } else {

662 return -1;

663 }

664 }

665

666 static void reorder_bindings_of_mode(struct Mode *mode) {

667 /* Copy the bindings into an array, so that we can use qsort(3). */

668 int n = 0;

669 Binding *current;

670 TAILQ_FOREACH(current, mode->bindings, bindings) {

671 n++;

672 }

673 Binding **tmp = scalloc(n, sizeof(Binding *));

674 n = 0;

675 TAILQ_FOREACH(current, mode->bindings, bindings) {

676 tmp[n++] = current;

677 }

678

679 qsort(tmp, n, sizeof(Binding *), reorder_binding_cmp);

680

681 struct bindings_head *reordered = scalloc(1, sizeof(struct bindings_head));

682 TAILQ_INIT(reordered);

683 for (int i = 0; i < n; i++) {

684 current = tmp[i];

685 TAILQ_REMOVE(mode->bindings, current, bindings);

686 TAILQ_INSERT_TAIL(reordered, current, bindings);

687 }

688 free(tmp);

689 assert(TAILQ_EMPTY(mode->bindings));

690 /* Free the old bindings_head, which is now empty. */

691 free(mode->bindings);

692 mode->bindings = reordered;

693 }

694

695 /*

696 * Reorders bindings by event_state_mask descendingly so that get_binding()

697 * correctly matches more specific bindings before more generic bindings. Take

698 * the following binding configuration as an example:

699 *

700 * bindsym n nop lower-case n pressed

701 * bindsym Shift+n nop upper-case n pressed

702 *

703 * Without reordering, the first binding’s event_state_mask of 0x0 would match

704 * the actual event_stat_mask of 0x1 and hence trigger instead of the second

705 * keybinding.

706 *

707 */

708 void reorder_bindings(void) {

709 struct Mode *mode;

710 SLIST_FOREACH(mode, &modes, modes) {

711 const bool current_mode = (mode->bindings == bindings);

712 reorder_bindings_of_mode(mode);

713 if (current_mode)

714 bindings = mode->bindings;

715 }

716 }

717

718 /*

719 * Checks for duplicate key bindings (the same keycode or keysym is configured

720 * more than once). If a duplicate binding is found, a message is printed to

721 * stderr and the has_errors variable is set to true, which will start

722 * i3-nagbar.

723 *

724 */

725 void check_for_duplicate_bindings(struct context *context) {

726 Binding *bind, *current;

727 TAILQ_FOREACH(current, bindings, bindings) {

728 TAILQ_FOREACH(bind, bindings, bindings) {

729 /* Abort when we reach the current keybinding, only check the

730 * bindings before */

731 if (bind == current)

732 break;

733

734 /* Check if the input types are different */

735 if (bind->input_type != current->input_type)

736 continue;

737

738 /* Check if one is using keysym while the other is using bindsym.

739 * If so, skip. */

740 if ((bind->symbol == NULL && current->symbol != NULL) ||

741 (bind->symbol != NULL && current->symbol == NULL))

742 continue;

743

744 /* If bind is NULL, current has to be NULL, too (see above).

745 * If the keycodes differ, it can't be a duplicate. */

746 if (bind->symbol != NULL &&

747 strcasecmp(bind->symbol, current->symbol) != 0)

748 continue;

749

750 /* Check if the keycodes or modifiers are different. If so, they

751 * can't be duplicate */

752 if (bind->keycode != current->keycode ||

753 bind->event_state_mask != current->event_state_mask ||

754 bind->release != current->release)

755 continue;

756

757 context->has_errors = true;

758 if (current->keycode != 0) {

759 ELOG("Duplicate keybinding in config file:\n state mask 0x%x with keycode %d, command \"%s\"\n",

760 current->event_state_mask, current->keycode, current->command);

761 } else {

762 ELOG("Duplicate keybinding in config file:\n state mask 0x%x with keysym %s, command \"%s\"\n",

763 current->event_state_mask, current->symbol, current->command);

764 }

765 }

766 }

767 }

768

769 /*

770 * Creates a dynamically allocated copy of bind.

771 */

772 static Binding *binding_copy(Binding *bind) {

773 Binding *ret = smalloc(sizeof(Binding));

774 *ret = *bind;

775 if (bind->symbol != NULL)

776 ret->symbol = sstrdup(bind->symbol);

777 if (bind->command != NULL)

778 ret->command = sstrdup(bind->command);

779 TAILQ_INIT(&(ret->keycodes_head));

780 struct Binding_Keycode *binding_keycode;

781 TAILQ_FOREACH(binding_keycode, &(bind->keycodes_head), keycodes) {

782 struct Binding_Keycode *ret_binding_keycode = smalloc(sizeof(struct Binding_Keycode));

783 *ret_binding_keycode = *binding_keycode;

784 TAILQ_INSERT_TAIL(&(ret->keycodes_head), ret_binding_keycode, keycodes);

785 }

786

787 return ret;

788 }

789

790 /*

791 * Frees the binding. If bind is null, it simply returns.

792 */

793 void binding_free(Binding *bind) {

794 if (bind == NULL) {

795 return;

796 }

797

798 while (!TAILQ_EMPTY(&(bind->keycodes_head))) {

799 struct Binding_Keycode *first = TAILQ_FIRST(&(bind->keycodes_head));

800 TAILQ_REMOVE(&(bind->keycodes_head), first, keycodes);

801 FREE(first);

802 }

803

804 FREE(bind->symbol);

805 FREE(bind->command);

806 FREE(bind);

807 }

808

809 /*

810 * Runs the given binding and handles parse errors. If con is passed, it will

811 * execute the command binding with that container selected by criteria.

812 * Returns a CommandResult for running the binding's command. Free with

813 * command_result_free().

814 *

815 */

816 CommandResult *run_binding(Binding *bind, Con *con) {

817 char *command;

818

819 /* We need to copy the binding and command since “reload” may be part of

820 * the command, and then the memory that bind points to may not contain the

821 * same data anymore. */

822 if (con == NULL)

823 command = sstrdup(bind->command);

824 else

825 sasprintf(&command, "[con_id=\"%p\"] %s", con, bind->command);

826

827 Binding *bind_cp = binding_copy(bind);

828 CommandResult *result = parse_command(command, NULL);

829 free(command);

830

831 if (result->needs_tree_render)

832 tree_render();

833

834 if (result->parse_error) {

835 char *pageraction;

836 sasprintf(&pageraction, "i3-sensible-pager \"%s\"\n", errorfilename);

837 char *argv[] = {

838 NULL, /* will be replaced by the executable path */

839 "-f",

840 config.font.pattern,

841 "-t",

842 "error",

843 "-m",

844 "The configured command for this shortcut could not be run successfully.",

845 "-b",

846 "show errors",

847 pageraction,

848 NULL};

849 start_nagbar(&command_error_nagbar_pid, argv);

850 free(pageraction);

851 }

852

853 ipc_send_binding_event("run", bind_cp);

854 binding_free(bind_cp);

855

856 return result;

857 }

858

859 static int fill_rmlvo_from_root(struct xkb_rule_names *xkb_names) {

860 xcb_intern_atom_reply_t *atom_reply;

861 size_t content_max_words = 256;

862

863 xcb_window_t root = root_screen->root;

864

865 atom_reply = xcb_intern_atom_reply(

866 conn, xcb_intern_atom(conn, 0, strlen("_XKB_RULES_NAMES"), "_XKB_RULES_NAMES"), NULL);

867 if (atom_reply == NULL)

868 return -1;

869

870 xcb_get_property_cookie_t prop_cookie;

871 xcb_get_property_reply_t *prop_reply;

872 prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom,

873 XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words);

874 prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL);

875 if (prop_reply == NULL) {

876 free(atom_reply);

877 return -1;

878 }

879 if (xcb_get_property_value_length(prop_reply) > 0 && prop_reply->bytes_after > 0) {

880 /* We received an incomplete value. Ask again but with a properly

881 * adjusted size. */

882 content_max_words += ceil(prop_reply->bytes_after / 4.0);

883 /* Repeat the request, with adjusted size */

884 free(prop_reply);

885 prop_cookie = xcb_get_property_unchecked(conn, false, root, atom_reply->atom,

886 XCB_GET_PROPERTY_TYPE_ANY, 0, content_max_words);

887 prop_reply = xcb_get_property_reply(conn, prop_cookie, NULL);

888 if (prop_reply == NULL) {

889 free(atom_reply);

890 return -1;

891 }

892 }

893 if (xcb_get_property_value_length(prop_reply) == 0) {

894 free(atom_reply);

895 free(prop_reply);

896 return -1;

897 }

898

899 const char *walk = (const char *)xcb_get_property_value(prop_reply);

900 int remaining = xcb_get_property_value_length(prop_reply);

901 for (int i = 0; i < 5 && remaining > 0; i++) {

902 const int len = strnlen(walk, remaining);

903 switch (i) {

904 case 0:

905 sasprintf((char **)&(xkb_names->rules), "%.*s", len, walk);

906 break;

907 case 1:

908 sasprintf((char **)&(xkb_names->model), "%.*s", len, walk);

909 break;

910 case 2:

911 sasprintf((char **)&(xkb_names->layout), "%.*s", len, walk);

912 break;

913 case 3:

914 sasprintf((char **)&(xkb_names->variant), "%.*s", len, walk);

915 break;

916 case 4:

917 sasprintf((char **)&(xkb_names->options), "%.*s", len, walk);

918 break;

919 }

920 DLOG("component %d of _XKB_RULES_NAMES is \"%.*s\"\n", i, len, walk);

921 walk += (len + 1);

922 remaining -= (len + 1);

923 }

924

925 free(atom_reply);

926 free(prop_reply);

927 return 0;

928 }

929

930 /*

931 * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.

932 *

933 */

934 bool load_keymap(void) {

935 if (xkb_context == NULL) {

936 if ((xkb_context = xkb_context_new(0)) == NULL) {

937 ELOG("Could not create xkbcommon context\n");

938 return false;

939 }

940 }

941

942 struct xkb_keymap *new_keymap = NULL;

943 int32_t device_id;

944 if (xkb_supported && (device_id = xkb_x11_get_core_keyboard_device_id(conn)) > -1) {

945 if ((new_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0)) == NULL) {

946 ELOG("xkb_x11_keymap_new_from_device failed\n");

947 return false;

948 }

949 } else {

950 /* Likely there is no XKB support on this server, possibly because it

951 * is a VNC server. */

952 LOG("No XKB / core keyboard device? Assembling keymap from local RMLVO.\n");

953 struct xkb_rule_names names = {

954 .rules = NULL,

955 .model = NULL,

956 .layout = NULL,

957 .variant = NULL,

958 .options = NULL};

959 if (fill_rmlvo_from_root(&names) == -1) {

960 ELOG("Could not get _XKB_RULES_NAMES atom from root window, falling back to defaults.\n");

961 if ((new_keymap = xkb_keymap_new_from_names(xkb_context, &names, 0)) == NULL) {

962 ELOG("xkb_keymap_new_from_names(NULL) failed\n");

963 return false;

964 }

965 }

966 new_keymap = xkb_keymap_new_from_names(xkb_context, &names, 0);

967 free((char *)names.rules);

968 free((char *)names.model);

969 free((char *)names.layout);

970 free((char *)names.variant);

971 free((char *)names.options);

972 if (new_keymap == NULL) {

973 ELOG("xkb_keymap_new_from_names(RMLVO) failed\n");

974 return false;

975 }

976 }

977 xkb_keymap_unref(xkb_keymap);

978 xkb_keymap = new_keymap;

979

980 return true;

981 }

982

983 /*

984 * Returns a list of buttons that should be grabbed on a window.

985 * This list will always contain 1–3, all higher buttons will only be returned

986 * if there is a whole-window binding for it on some window in the current

987 * config.

988 * The list is terminated by a 0.

989 */

990 int *bindings_get_buttons_to_grab(void) {

991 /* Let's make the reasonable assumption that there's no more than 25

992 * buttons. */

993 int num_max = 25;

994

995 int buffer[num_max];

996 int num = 0;

997

998 /* We always return buttons 1 through 3. */

999 buffer[num++] = 1;

1000 buffer[num++] = 2;

1001 buffer[num++] = 3;

1002

1003 Binding *bind;

1004 TAILQ_FOREACH(bind, bindings, bindings) {

1005 if (num + 1 == num_max)

1006 break;

1007

1008 /* We are only interested in whole window mouse bindings. */

1009 if (bind->input_type != B_MOUSE || !bind->whole_window)

1010 continue;

1011

1012 long button;

1013 if (!parse_long(bind->symbol + (sizeof("button") - 1), &button, 10)) {

1014 ELOG("Could not parse button number, skipping this binding. Please report this bug in i3.\n");

1015 continue;

1016 }

1017

1018 /* Avoid duplicates. */

1019 for (int i = 0; i < num; i++) {

1020 if (buffer[i] == button)

1021 continue;

1022 }

1023

1024 buffer[num++] = button;

1025 }

1026 buffer[num++] = 0;

1027

1028 int *buttons = scalloc(num, sizeof(int));

1029 memcpy(buttons, buffer, num * sizeof(int));

1030

1031 return buttons;

1032 }