2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * bindings.c: Functions for configuring, finding and, running bindings.
11 #include <xkbcommon/xkbcommon.h>
13 pid_t command_error_nagbar_pid = -1;
16 * The name of the default mode.
19 const char *DEFAULT_BINDING_MODE = "default";
22 * Returns the mode specified by `name` or creates a new mode and adds it to
26 static struct Mode *mode_from_name(const char *name) {
29 /* Try to find the mode in the list of modes and return it */
30 SLIST_FOREACH(mode, &modes, modes) {
31 if (strcmp(mode->name, name) == 0)
35 /* If the mode was not found, create a new one */
36 mode = scalloc(sizeof(struct Mode));
37 mode->name = sstrdup(name);
38 mode->bindings = scalloc(sizeof(struct bindings_head));
39 TAILQ_INIT(mode->bindings);
40 SLIST_INSERT_HEAD(&modes, mode, modes);
46 * Adds a binding from config parameters given as strings and returns a
47 * pointer to the binding structure. Returns NULL if the input code could not
51 Binding *configure_binding(const char *bindtype, const char *modifiers, const char *input_code,
52 const char *release, const char *border, const char *whole_window,
53 const char *command, const char *modename) {
54 Binding *new_binding = scalloc(sizeof(Binding));
55 DLOG("bindtype %s, modifiers %s, input code %s, release %s\n", bindtype, modifiers, input_code, release);
56 new_binding->release = (release != NULL ? B_UPON_KEYRELEASE : B_UPON_KEYPRESS);
57 new_binding->border = (border != NULL);
58 new_binding->whole_window = (whole_window != NULL);
59 if (strcmp(bindtype, "bindsym") == 0) {
60 new_binding->input_type = (strncasecmp(input_code, "button", (sizeof("button") - 1)) == 0
64 new_binding->symbol = sstrdup(input_code);
67 long keycode = strtol(input_code, &endptr, 10);
68 new_binding->keycode = keycode;
69 new_binding->input_type = B_KEYBOARD;
70 if (keycode == LONG_MAX || keycode == LONG_MIN || keycode < 0 || *endptr != '\0' || endptr == input_code) {
71 ELOG("Could not parse \"%s\" as an input code, ignoring this binding.\n", input_code);
76 new_binding->mods = modifiers_from_str(modifiers);
77 new_binding->command = sstrdup(command);
79 struct Mode *mode = mode_from_name(modename);
80 TAILQ_INSERT_TAIL(mode->bindings, new_binding, bindings);
85 static void grab_keycode_for_binding(xcb_connection_t *conn, Binding *bind, uint32_t keycode) {
86 if (bind->input_type != B_KEYBOARD)
89 DLOG("Grabbing %d with modifiers %d (with mod_mask_lock %d)\n", keycode, bind->mods, bind->mods | XCB_MOD_MASK_LOCK);
90 /* Grab the key in all combinations */
91 #define GRAB_KEY(modifier) \
93 xcb_grab_key(conn, 0, root, modifier, keycode, XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC); \
95 int mods = bind->mods;
96 if ((bind->mods & BIND_MODE_SWITCH) != 0) {
97 mods &= ~BIND_MODE_SWITCH;
99 mods = XCB_MOD_MASK_ANY;
102 GRAB_KEY(mods | xcb_numlock_mask);
103 GRAB_KEY(mods | XCB_MOD_MASK_LOCK);
104 GRAB_KEY(mods | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
108 * Grab the bound keys (tell X to send us keypress events for those keycodes)
111 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch) {
113 TAILQ_FOREACH(bind, bindings, bindings) {
114 if (bind->input_type != B_KEYBOARD ||
115 (bind_mode_switch && (bind->mods & BIND_MODE_SWITCH) == 0) ||
116 (!bind_mode_switch && (bind->mods & BIND_MODE_SWITCH) != 0))
119 /* The easy case: the user specified a keycode directly. */
120 if (bind->keycode > 0) {
121 grab_keycode_for_binding(conn, bind, bind->keycode);
125 xcb_keycode_t *walk = bind->translated_to;
126 for (uint32_t i = 0; i < bind->number_keycodes; i++)
127 grab_keycode_for_binding(conn, bind, *walk++);
132 * Returns a pointer to the Binding with the specified modifiers and
133 * keycode or NULL if no such binding exists.
136 static Binding *get_binding(uint16_t modifiers, bool is_release, uint16_t input_code, input_type_t input_type) {
140 /* On a press event, we first reset all B_UPON_KEYRELEASE_IGNORE_MODS
141 * bindings back to B_UPON_KEYRELEASE */
142 TAILQ_FOREACH(bind, bindings, bindings) {
143 if (bind->input_type != input_type)
145 if (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS)
146 bind->release = B_UPON_KEYRELEASE;
150 TAILQ_FOREACH(bind, bindings, bindings) {
151 /* First compare the modifiers (unless this is a
152 * B_UPON_KEYRELEASE_IGNORE_MODS binding and this is a KeyRelease
154 if (bind->input_type != input_type)
156 if (bind->mods != modifiers &&
157 (bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
161 /* For keyboard bindings where a symbol was specified by the user, we
162 * need to look in the array of translated keycodes for the event’s
164 if (input_type == B_KEYBOARD && bind->symbol != NULL) {
165 xcb_keycode_t input_keycode = (xcb_keycode_t)input_code;
166 if (memmem(bind->translated_to,
167 bind->number_keycodes * sizeof(xcb_keycode_t),
168 &input_keycode, sizeof(xcb_keycode_t)) == NULL)
171 /* This case is easier: The user specified a keycode */
172 if (bind->keycode != input_code)
176 /* If this binding is a release binding, it matches the key which the
177 * user pressed. We therefore mark it as B_UPON_KEYRELEASE_IGNORE_MODS
178 * for later, so that the user can release the modifiers before the
179 * actual key or button and the release event will still be matched. */
180 if (bind->release == B_UPON_KEYRELEASE && !is_release)
181 bind->release = B_UPON_KEYRELEASE_IGNORE_MODS;
183 /* Check if the binding is for a press or a release event */
184 if ((bind->release == B_UPON_KEYPRESS && is_release) ||
185 (bind->release >= B_UPON_KEYRELEASE && !is_release))
191 return (bind == TAILQ_END(bindings) ? NULL : bind);
195 * Returns a pointer to the Binding that matches the given xcb button or key
196 * event or NULL if no such binding exists.
199 Binding *get_binding_from_xcb_event(xcb_generic_event_t *event) {
200 bool is_release = (event->response_type == XCB_KEY_RELEASE || event->response_type == XCB_BUTTON_RELEASE);
202 input_type_t input_type = ((event->response_type == XCB_BUTTON_RELEASE || event->response_type == XCB_BUTTON_PRESS)
206 uint16_t event_state = ((xcb_key_press_event_t *)event)->state;
207 uint16_t event_detail = ((xcb_key_press_event_t *)event)->detail;
209 /* Remove the numlock bit, all other bits are modifiers we can bind to */
210 uint16_t state_filtered = event_state & ~(xcb_numlock_mask | XCB_MOD_MASK_LOCK);
211 DLOG("(removed numlock, state = %d)\n", state_filtered);
212 /* Only use the lower 8 bits of the state (modifier masks) so that mouse
213 * button masks are filtered out */
214 state_filtered &= 0xFF;
215 DLOG("(removed upper 8 bits, state = %d)\n", state_filtered);
217 if (xkb_current_group == XCB_XKB_GROUP_2)
218 state_filtered |= BIND_MODE_SWITCH;
220 DLOG("(checked mode_switch, state %d)\n", state_filtered);
222 /* Find the binding */
223 Binding *bind = get_binding(state_filtered, is_release, event_detail, input_type);
225 /* No match? Then the user has Mode_switch enabled but does not have a
226 * specific keybinding. Fall back to the default keybindings (without
227 * Mode_switch). Makes it much more convenient for users of a hybrid
228 * layout (like ru). */
230 state_filtered &= ~(BIND_MODE_SWITCH);
231 DLOG("no match, new state_filtered = %d\n", state_filtered);
232 if ((bind = get_binding(state_filtered, is_release, event_detail, input_type)) == NULL) {
233 /* This is not a real error since we can have release and
234 * non-release bindings. On a press event for which there is only a
235 * !release-binding, but no release-binding, the corresponding
236 * release event will trigger this. No problem, though. */
237 DLOG("Could not lookup key binding (modifiers %d, keycode %d)\n",
238 state_filtered, event_detail);
246 * Translates keysymbols to keycodes for all bindings which use keysyms.
249 void translate_keysyms(void) {
253 xcb_keycode_t i, min_keycode, max_keycode;
255 min_keycode = xcb_get_setup(conn)->min_keycode;
256 max_keycode = xcb_get_setup(conn)->max_keycode;
258 TAILQ_FOREACH(bind, bindings, bindings) {
259 if (bind->input_type == B_MOUSE) {
261 long button = strtol(bind->symbol + (sizeof("button") - 1), &endptr, 10);
262 bind->keycode = button;
264 if (button == LONG_MAX || button == LONG_MIN || button < 0 || *endptr != '\0' || endptr == bind->symbol)
265 ELOG("Could not translate string to button: \"%s\"\n", bind->symbol);
270 if (bind->keycode > 0)
273 /* We need to translate the symbol to a keycode */
274 keysym = xkb_keysym_from_name(bind->symbol, XKB_KEYSYM_NO_FLAGS);
275 if (keysym == XKB_KEY_NoSymbol) {
276 ELOG("Could not translate string to key symbol: \"%s\"\n",
281 /* Base column we use for looking up key symbols. We always consider
282 * the base column and the corresponding shift column, so without
283 * mode_switch, we look in 0 and 1, with mode_switch we look in 2 and
285 col = (bind->mods & BIND_MODE_SWITCH ? 2 : 0);
287 FREE(bind->translated_to);
288 bind->number_keycodes = 0;
290 for (i = min_keycode; i && i <= max_keycode; i++) {
291 if ((xcb_key_symbols_get_keysym(keysyms, i, col) != keysym) &&
292 (xcb_key_symbols_get_keysym(keysyms, i, col + 1) != keysym))
294 bind->number_keycodes++;
295 bind->translated_to = srealloc(bind->translated_to,
296 (sizeof(xcb_keycode_t) *
297 bind->number_keycodes));
298 bind->translated_to[bind->number_keycodes - 1] = i;
301 DLOG("Translated symbol \"%s\" to %d keycode (mods %d)\n", bind->symbol,
302 bind->number_keycodes, bind->mods);
307 * Switches the key bindings to the given mode, if the mode exists
310 void switch_mode(const char *new_mode) {
313 DLOG("Switching to mode %s\n", new_mode);
315 SLIST_FOREACH(mode, &modes, modes) {
316 if (strcasecmp(mode->name, new_mode) != 0)
319 ungrab_all_keys(conn);
320 bindings = mode->bindings;
322 grab_all_keys(conn, false);
325 sasprintf(&event_msg, "{\"change\":\"%s\"}", mode->name);
327 ipc_send_event("mode", I3_IPC_EVENT_MODE, event_msg);
333 ELOG("ERROR: Mode not found\n");
337 * Checks for duplicate key bindings (the same keycode or keysym is configured
338 * more than once). If a duplicate binding is found, a message is printed to
339 * stderr and the has_errors variable is set to true, which will start
343 void check_for_duplicate_bindings(struct context *context) {
344 Binding *bind, *current;
345 TAILQ_FOREACH(current, bindings, bindings) {
346 TAILQ_FOREACH(bind, bindings, bindings) {
347 /* Abort when we reach the current keybinding, only check the
352 /* Check if the input types are different */
353 if (bind->input_type != current->input_type)
356 /* Check if one is using keysym while the other is using bindsym.
358 /* XXX: It should be checked at a later place (when translating the
359 * keysym to keycodes) if there are any duplicates */
360 if ((bind->symbol == NULL && current->symbol != NULL) ||
361 (bind->symbol != NULL && current->symbol == NULL))
364 /* If bind is NULL, current has to be NULL, too (see above).
365 * If the keycodes differ, it can't be a duplicate. */
366 if (bind->symbol != NULL &&
367 strcasecmp(bind->symbol, current->symbol) != 0)
370 /* Check if the keycodes or modifiers are different. If so, they
371 * can't be duplicate */
372 if (bind->keycode != current->keycode ||
373 bind->mods != current->mods ||
374 bind->release != current->release)
377 context->has_errors = true;
378 if (current->keycode != 0) {
379 ELOG("Duplicate keybinding in config file:\n modmask %d with keycode %d, command \"%s\"\n",
380 current->mods, current->keycode, current->command);
382 ELOG("Duplicate keybinding in config file:\n modmask %d with keysym %s, command \"%s\"\n",
383 current->mods, current->symbol, current->command);
390 * Creates a dynamically allocated copy of bind.
392 static Binding *binding_copy(Binding *bind) {
393 Binding *ret = smalloc(sizeof(Binding));
395 if (bind->symbol != NULL)
396 ret->symbol = strdup(bind->symbol);
397 if (bind->command != NULL)
398 ret->command = strdup(bind->command);
399 if (bind->translated_to != NULL) {
400 ret->translated_to = smalloc(sizeof(xcb_keycode_t) * bind->number_keycodes);
401 memcpy(ret->translated_to, bind->translated_to, sizeof(xcb_keycode_t) * bind->number_keycodes);
407 * Frees the binding. If bind is null, it simply returns.
409 void binding_free(Binding *bind) {
415 FREE(bind->translated_to);
421 * Runs the given binding and handles parse errors. If con is passed, it will
422 * execute the command binding with that container selected by criteria.
423 * Returns a CommandResult for running the binding's command. Caller should
424 * render tree if needs_tree_render is true. Free with command_result_free().
427 CommandResult *run_binding(Binding *bind, Con *con) {
430 /* We need to copy the binding and command since “reload” may be part of
431 * the command, and then the memory that bind points to may not contain the
432 * same data anymore. */
434 command = sstrdup(bind->command);
436 sasprintf(&command, "[con_id=\"%p\"] %s", con, bind->command);
438 Binding *bind_cp = binding_copy(bind);
439 CommandResult *result = parse_command(command, NULL);
442 if (result->needs_tree_render)
445 if (result->parse_error) {
447 sasprintf(&pageraction, "i3-sensible-pager \"%s\"\n", errorfilename);
449 NULL, /* will be replaced by the executable path */
455 "The configured command for this shortcut could not be run successfully.",
460 start_nagbar(&command_error_nagbar_pid, argv);
464 ipc_send_binding_event("run", bind_cp);
465 binding_free(bind_cp);