]> git.sur5r.net Git - i3/i3/blob - src/bindings.c
Merge pull request #1632 from Deiz/binding-border
[i3/i3] / src / bindings.c
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009-2014 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
13 pid_t command_error_nagbar_pid = -1;
14
15 /*
16  * The name of the default mode.
17  *
18  */
19 const char *DEFAULT_BINDING_MODE = "default";
20
21 /*
22  * Returns the mode specified by `name` or creates a new mode and adds it to
23  * the list of modes.
24  *
25  */
26 static struct Mode *mode_from_name(const char *name) {
27     struct Mode *mode;
28
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)
32             return mode;
33     }
34
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);
41
42     return mode;
43 }
44
45 /*
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
48  * be parsed.
49  *
50  */
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
61                                        ? B_MOUSE
62                                        : B_KEYBOARD);
63
64         new_binding->symbol = sstrdup(input_code);
65     } else {
66         // TODO: strtol with proper error handling
67         new_binding->keycode = atoi(input_code);
68         new_binding->input_type = B_KEYBOARD;
69         if (new_binding->keycode == 0) {
70             ELOG("Could not parse \"%s\" as an input code, ignoring this binding.\n", input_code);
71             FREE(new_binding);
72             return NULL;
73         }
74     }
75     new_binding->mods = modifiers_from_str(modifiers);
76     new_binding->command = sstrdup(command);
77
78     struct Mode *mode = mode_from_name(modename);
79     TAILQ_INSERT_TAIL(mode->bindings, new_binding, bindings);
80
81     return new_binding;
82 }
83
84 static void grab_keycode_for_binding(xcb_connection_t *conn, Binding *bind, uint32_t keycode) {
85     if (bind->input_type != B_KEYBOARD)
86         return;
87
88     DLOG("Grabbing %d with modifiers %d (with mod_mask_lock %d)\n", keycode, bind->mods, bind->mods | XCB_MOD_MASK_LOCK);
89 /* Grab the key in all combinations */
90 #define GRAB_KEY(modifier)                                                                       \
91     do {                                                                                         \
92         xcb_grab_key(conn, 0, root, modifier, keycode, XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC); \
93     } while (0)
94     int mods = bind->mods;
95     if ((bind->mods & BIND_MODE_SWITCH) != 0) {
96         mods &= ~BIND_MODE_SWITCH;
97         if (mods == 0)
98             mods = XCB_MOD_MASK_ANY;
99     }
100     GRAB_KEY(mods);
101     GRAB_KEY(mods | xcb_numlock_mask);
102     GRAB_KEY(mods | XCB_MOD_MASK_LOCK);
103     GRAB_KEY(mods | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
104 }
105
106 /*
107  * Grab the bound keys (tell X to send us keypress events for those keycodes)
108  *
109  */
110 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch) {
111     Binding *bind;
112     TAILQ_FOREACH(bind, bindings, bindings) {
113         if (bind->input_type != B_KEYBOARD ||
114             (bind_mode_switch && (bind->mods & BIND_MODE_SWITCH) == 0) ||
115             (!bind_mode_switch && (bind->mods & BIND_MODE_SWITCH) != 0))
116             continue;
117
118         /* The easy case: the user specified a keycode directly. */
119         if (bind->keycode > 0) {
120             grab_keycode_for_binding(conn, bind, bind->keycode);
121             continue;
122         }
123
124         xcb_keycode_t *walk = bind->translated_to;
125         for (uint32_t i = 0; i < bind->number_keycodes; i++)
126             grab_keycode_for_binding(conn, bind, *walk++);
127     }
128 }
129
130 /*
131  * Returns a pointer to the Binding with the specified modifiers and
132  * keycode or NULL if no such binding exists.
133  *
134  */
135 static Binding *get_binding(uint16_t modifiers, bool is_release, uint16_t input_code, input_type_t input_type) {
136     Binding *bind;
137
138     if (!is_release) {
139         /* On a press event, we first reset all B_UPON_KEYRELEASE_IGNORE_MODS
140          * bindings back to B_UPON_KEYRELEASE */
141         TAILQ_FOREACH(bind, bindings, bindings) {
142             if (bind->input_type != input_type)
143                 continue;
144             if (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS)
145                 bind->release = B_UPON_KEYRELEASE;
146         }
147     }
148
149     TAILQ_FOREACH(bind, bindings, bindings) {
150         /* First compare the modifiers (unless this is a
151          * B_UPON_KEYRELEASE_IGNORE_MODS binding and this is a KeyRelease
152          * event) */
153         if (bind->input_type != input_type)
154             continue;
155         if (bind->mods != modifiers &&
156             (bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
157              !is_release))
158             continue;
159
160         /* For keyboard bindings where a symbol was specified by the user, we
161          * need to look in the array of translated keycodes for the event’s
162          * keycode */
163         if (input_type == B_KEYBOARD && bind->symbol != NULL) {
164             xcb_keycode_t input_keycode = (xcb_keycode_t)input_code;
165             if (memmem(bind->translated_to,
166                        bind->number_keycodes * sizeof(xcb_keycode_t),
167                        &input_keycode, sizeof(xcb_keycode_t)) == NULL)
168                 continue;
169         } else {
170             /* This case is easier: The user specified a keycode */
171             if (bind->keycode != input_code)
172                 continue;
173         }
174
175         /* If this binding is a release binding, it matches the key which the
176          * user pressed. We therefore mark it as B_UPON_KEYRELEASE_IGNORE_MODS
177          * for later, so that the user can release the modifiers before the
178          * actual key or button and the release event will still be matched. */
179         if (bind->release == B_UPON_KEYRELEASE && !is_release)
180             bind->release = B_UPON_KEYRELEASE_IGNORE_MODS;
181
182         /* Check if the binding is for a press or a release event */
183         if ((bind->release == B_UPON_KEYPRESS && is_release) ||
184             (bind->release >= B_UPON_KEYRELEASE && !is_release))
185             continue;
186
187         break;
188     }
189
190     return (bind == TAILQ_END(bindings) ? NULL : bind);
191 }
192
193 /*
194  * Returns a pointer to the Binding that matches the given xcb button or key
195  * event or NULL if no such binding exists.
196  *
197  */
198 Binding *get_binding_from_xcb_event(xcb_generic_event_t *event) {
199     bool is_release = (event->response_type == XCB_KEY_RELEASE || event->response_type == XCB_BUTTON_RELEASE);
200
201     input_type_t input_type = ((event->response_type == XCB_BUTTON_RELEASE || event->response_type == XCB_BUTTON_PRESS)
202                                    ? B_MOUSE
203                                    : B_KEYBOARD);
204
205     uint16_t event_state = ((xcb_key_press_event_t *)event)->state;
206     uint16_t event_detail = ((xcb_key_press_event_t *)event)->detail;
207
208     /* Remove the numlock bit, all other bits are modifiers we can bind to */
209     uint16_t state_filtered = event_state & ~(xcb_numlock_mask | XCB_MOD_MASK_LOCK);
210     DLOG("(removed numlock, state = %d)\n", state_filtered);
211     /* Only use the lower 8 bits of the state (modifier masks) so that mouse
212      * button masks are filtered out */
213     state_filtered &= 0xFF;
214     DLOG("(removed upper 8 bits, state = %d)\n", state_filtered);
215
216     if (xkb_current_group == XCB_XKB_GROUP_2)
217         state_filtered |= BIND_MODE_SWITCH;
218
219     DLOG("(checked mode_switch, state %d)\n", state_filtered);
220
221     /* Find the binding */
222     Binding *bind = get_binding(state_filtered, is_release, event_detail, input_type);
223
224     /* No match? Then the user has Mode_switch enabled but does not have a
225      * specific keybinding. Fall back to the default keybindings (without
226      * Mode_switch). Makes it much more convenient for users of a hybrid
227      * layout (like ru). */
228     if (bind == NULL) {
229         state_filtered &= ~(BIND_MODE_SWITCH);
230         DLOG("no match, new state_filtered = %d\n", state_filtered);
231         if ((bind = get_binding(state_filtered, is_release, event_detail, input_type)) == NULL) {
232             /* This is not a real error since we can have release and
233              * non-release bindings. On a press event for which there is only a
234              * !release-binding, but no release-binding, the corresponding
235              * release event will trigger this. No problem, though. */
236             DLOG("Could not lookup key binding (modifiers %d, keycode %d)\n",
237                  state_filtered, event_detail);
238         }
239     }
240
241     return bind;
242 }
243
244 /*
245  * Translates keysymbols to keycodes for all bindings which use keysyms.
246  *
247  */
248 void translate_keysyms(void) {
249     Binding *bind;
250     xcb_keysym_t keysym;
251     int col;
252     xcb_keycode_t i, min_keycode, max_keycode;
253
254     min_keycode = xcb_get_setup(conn)->min_keycode;
255     max_keycode = xcb_get_setup(conn)->max_keycode;
256
257     TAILQ_FOREACH(bind, bindings, bindings) {
258         if (bind->input_type == B_MOUSE) {
259             int button = atoi(bind->symbol + (sizeof("button") - 1));
260             bind->keycode = button;
261
262             if (button < 1)
263                 ELOG("Could not translate string to button: \"%s\"\n", bind->symbol);
264
265             continue;
266         }
267
268         if (bind->keycode > 0)
269             continue;
270
271         /* We need to translate the symbol to a keycode */
272         keysym = xkb_keysym_from_name(bind->symbol, XKB_KEYSYM_NO_FLAGS);
273         if (keysym == XKB_KEY_NoSymbol) {
274             ELOG("Could not translate string to key symbol: \"%s\"\n",
275                  bind->symbol);
276             continue;
277         }
278
279         /* Base column we use for looking up key symbols. We always consider
280          * the base column and the corresponding shift column, so without
281          * mode_switch, we look in 0 and 1, with mode_switch we look in 2 and
282          * 3. */
283         col = (bind->mods & BIND_MODE_SWITCH ? 2 : 0);
284
285         FREE(bind->translated_to);
286         bind->number_keycodes = 0;
287
288         for (i = min_keycode; i && i <= max_keycode; i++) {
289             if ((xcb_key_symbols_get_keysym(keysyms, i, col) != keysym) &&
290                 (xcb_key_symbols_get_keysym(keysyms, i, col + 1) != keysym))
291                 continue;
292             bind->number_keycodes++;
293             bind->translated_to = srealloc(bind->translated_to,
294                                            (sizeof(xcb_keycode_t) *
295                                             bind->number_keycodes));
296             bind->translated_to[bind->number_keycodes - 1] = i;
297         }
298
299         DLOG("Translated symbol \"%s\" to %d keycode (mods %d)\n", bind->symbol,
300              bind->number_keycodes, bind->mods);
301     }
302 }
303
304 /*
305  * Switches the key bindings to the given mode, if the mode exists
306  *
307  */
308 void switch_mode(const char *new_mode) {
309     struct Mode *mode;
310
311     DLOG("Switching to mode %s\n", new_mode);
312
313     SLIST_FOREACH(mode, &modes, modes) {
314         if (strcasecmp(mode->name, new_mode) != 0)
315             continue;
316
317         ungrab_all_keys(conn);
318         bindings = mode->bindings;
319         translate_keysyms();
320         grab_all_keys(conn, false);
321
322         char *event_msg;
323         sasprintf(&event_msg, "{\"change\":\"%s\"}", mode->name);
324
325         ipc_send_event("mode", I3_IPC_EVENT_MODE, event_msg);
326         FREE(event_msg);
327
328         return;
329     }
330
331     ELOG("ERROR: Mode not found\n");
332 }
333
334 /*
335  * Checks for duplicate key bindings (the same keycode or keysym is configured
336  * more than once). If a duplicate binding is found, a message is printed to
337  * stderr and the has_errors variable is set to true, which will start
338  * i3-nagbar.
339  *
340  */
341 void check_for_duplicate_bindings(struct context *context) {
342     Binding *bind, *current;
343     TAILQ_FOREACH(current, bindings, bindings) {
344         TAILQ_FOREACH(bind, bindings, bindings) {
345             /* Abort when we reach the current keybinding, only check the
346              * bindings before */
347             if (bind == current)
348                 break;
349
350             /* Check if the input types are different */
351             if (bind->input_type != current->input_type)
352                 continue;
353
354             /* Check if one is using keysym while the other is using bindsym.
355              * If so, skip. */
356             /* XXX: It should be checked at a later place (when translating the
357              * keysym to keycodes) if there are any duplicates */
358             if ((bind->symbol == NULL && current->symbol != NULL) ||
359                 (bind->symbol != NULL && current->symbol == NULL))
360                 continue;
361
362             /* If bind is NULL, current has to be NULL, too (see above).
363              * If the keycodes differ, it can't be a duplicate. */
364             if (bind->symbol != NULL &&
365                 strcasecmp(bind->symbol, current->symbol) != 0)
366                 continue;
367
368             /* Check if the keycodes or modifiers are different. If so, they
369              * can't be duplicate */
370             if (bind->keycode != current->keycode ||
371                 bind->mods != current->mods ||
372                 bind->release != current->release)
373                 continue;
374
375             context->has_errors = true;
376             if (current->keycode != 0) {
377                 ELOG("Duplicate keybinding in config file:\n  modmask %d with keycode %d, command \"%s\"\n",
378                      current->mods, current->keycode, current->command);
379             } else {
380                 ELOG("Duplicate keybinding in config file:\n  modmask %d with keysym %s, command \"%s\"\n",
381                      current->mods, current->symbol, current->command);
382             }
383         }
384     }
385 }
386
387 /*
388  * Creates a dynamically allocated copy of bind.
389  */
390 static Binding *binding_copy(Binding *bind) {
391     Binding *ret = smalloc(sizeof(Binding));
392     *ret = *bind;
393     if (bind->symbol != NULL)
394         ret->symbol = strdup(bind->symbol);
395     if (bind->command != NULL)
396         ret->command = strdup(bind->command);
397     if (bind->translated_to != NULL) {
398         ret->translated_to = smalloc(sizeof(xcb_keycode_t) * bind->number_keycodes);
399         memcpy(ret->translated_to, bind->translated_to, sizeof(xcb_keycode_t) * bind->number_keycodes);
400     }
401     return ret;
402 }
403
404 /*
405  * Frees the binding. If bind is null, it simply returns.
406  */
407 void binding_free(Binding *bind) {
408     if (bind == NULL) {
409         return;
410     }
411
412     FREE(bind->symbol);
413     FREE(bind->translated_to);
414     FREE(bind->command);
415     FREE(bind);
416 }
417
418 /*
419  * Runs the given binding and handles parse errors. If con is passed, it will
420  * execute the command binding with that container selected by criteria.
421  * Returns a CommandResult for running the binding's command. Caller should
422  * render tree if needs_tree_render is true. Free with command_result_free().
423  *
424  */
425 CommandResult *run_binding(Binding *bind, Con *con) {
426     char *command;
427
428     /* We need to copy the binding and command since “reload” may be part of
429      * the command, and then the memory that bind points to may not contain the
430      * same data anymore. */
431     if (con == NULL)
432         command = sstrdup(bind->command);
433     else
434         sasprintf(&command, "[con_id=\"%d\"] %s", con, bind->command);
435
436     Binding *bind_cp = binding_copy(bind);
437     CommandResult *result = parse_command(command, NULL);
438     free(command);
439
440     if (result->needs_tree_render)
441         tree_render();
442
443     if (result->parse_error) {
444         char *pageraction;
445         sasprintf(&pageraction, "i3-sensible-pager \"%s\"\n", errorfilename);
446         char *argv[] = {
447             NULL, /* will be replaced by the executable path */
448             "-f",
449             config.font.pattern,
450             "-t",
451             "error",
452             "-m",
453             "The configured command for this shortcut could not be run successfully.",
454             "-b",
455             "show errors",
456             pageraction,
457             NULL};
458         start_nagbar(&command_error_nagbar_pid, argv);
459         free(pageraction);
460     }
461
462     ipc_send_binding_event("run", bind_cp);
463     binding_free(bind_cp);
464
465     return result;
466 }