2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2014 Michael Stapelberg and contributors (see also: LICENSE)
7 * bindings.c: Functions for configuring, finding and, running bindings.
12 * The name of the default mode.
15 const char *DEFAULT_BINDING_MODE = "default";
18 * Returns the mode specified by `name` or creates a new mode and adds it to
22 static struct Mode *mode_from_name(const char *name) {
25 /* Try to find the mode in the list of modes and return it */
26 SLIST_FOREACH(mode, &modes, modes) {
27 if (strcmp(mode->name, name) == 0)
31 /* If the mode was not found, create a new one */
32 mode = scalloc(sizeof(struct Mode));
33 mode->name = sstrdup(name);
34 mode->bindings = scalloc(sizeof(struct bindings_head));
35 TAILQ_INIT(mode->bindings);
36 SLIST_INSERT_HEAD(&modes, mode, modes);
42 * Adds a binding from config parameters given as strings and returns a
43 * pointer to the binding structure. Returns NULL if the input code could not
47 Binding *configure_binding(const char *bindtype, const char *modifiers, const char *input_code,
48 const char *release, const char *command, const char *modename) {
49 Binding *new_binding = scalloc(sizeof(Binding));
50 DLOG("bindtype %s, modifiers %s, input code %s, release %s\n", bindtype, modifiers, input_code, release);
51 new_binding->release = (release != NULL ? B_UPON_KEYRELEASE : B_UPON_KEYPRESS);
52 if (strcmp(bindtype, "bindsym") == 0) {
53 new_binding->input_type = (strncasecmp(input_code, "button", (sizeof("button") - 1)) == 0
57 new_binding->symbol = sstrdup(input_code);
59 // TODO: strtol with proper error handling
60 new_binding->keycode = atoi(input_code);
61 new_binding->input_type = B_KEYBOARD;
62 if (new_binding->keycode == 0) {
63 ELOG("Could not parse \"%s\" as an input code, ignoring this binding.\n", input_code);
68 new_binding->mods = modifiers_from_str(modifiers);
69 new_binding->command = sstrdup(command);
71 struct Mode *mode = mode_from_name(modename);
72 TAILQ_INSERT_TAIL(mode->bindings, new_binding, bindings);
77 static void grab_keycode_for_binding(xcb_connection_t *conn, Binding *bind, uint32_t keycode) {
78 if (bind->input_type != B_KEYBOARD)
81 DLOG("Grabbing %d with modifiers %d (with mod_mask_lock %d)\n", keycode, bind->mods, bind->mods | XCB_MOD_MASK_LOCK);
82 /* Grab the key in all combinations */
83 #define GRAB_KEY(modifier) \
85 xcb_grab_key(conn, 0, root, modifier, keycode, \
86 XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC); \
88 int mods = bind->mods;
89 if ((bind->mods & BIND_MODE_SWITCH) != 0) {
90 mods &= ~BIND_MODE_SWITCH;
92 mods = XCB_MOD_MASK_ANY;
95 GRAB_KEY(mods | xcb_numlock_mask);
96 GRAB_KEY(mods | XCB_MOD_MASK_LOCK);
97 GRAB_KEY(mods | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
102 * Grab the bound keys (tell X to send us keypress events for those keycodes)
105 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch) {
107 TAILQ_FOREACH(bind, bindings, bindings) {
108 if (bind->input_type != B_KEYBOARD ||
109 (bind_mode_switch && (bind->mods & BIND_MODE_SWITCH) == 0) ||
110 (!bind_mode_switch && (bind->mods & BIND_MODE_SWITCH) != 0))
113 /* The easy case: the user specified a keycode directly. */
114 if (bind->keycode > 0) {
115 grab_keycode_for_binding(conn, bind, bind->keycode);
119 xcb_keycode_t *walk = bind->translated_to;
120 for (uint32_t i = 0; i < bind->number_keycodes; i++)
121 grab_keycode_for_binding(conn, bind, *walk++);
126 * Returns a pointer to the Binding with the specified modifiers and
127 * keycode or NULL if no such binding exists.
130 static Binding *get_binding(uint16_t modifiers, bool is_release, uint16_t input_code, input_type_t input_type) {
134 /* On a press event, we first reset all B_UPON_KEYRELEASE_IGNORE_MODS
135 * bindings back to B_UPON_KEYRELEASE */
136 TAILQ_FOREACH(bind, bindings, bindings) {
137 if (bind->input_type != input_type)
139 if (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS)
140 bind->release = B_UPON_KEYRELEASE;
144 TAILQ_FOREACH(bind, bindings, bindings) {
145 /* First compare the modifiers (unless this is a
146 * B_UPON_KEYRELEASE_IGNORE_MODS binding and this is a KeyRelease
148 if (bind->input_type != input_type)
150 if (bind->mods != modifiers &&
151 (bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
155 /* For keyboard bindings where a symbol was specified by the user, we
156 * need to look in the array of translated keycodes for the event’s
158 if (input_type == B_KEYBOARD && bind->symbol != NULL) {
159 if (memmem(bind->translated_to,
160 bind->number_keycodes * sizeof(xcb_keycode_t),
161 &input_code, sizeof(xcb_keycode_t)) == NULL)
164 /* This case is easier: The user specified a keycode */
165 if (bind->keycode != input_code)
169 /* If this binding is a release binding, it matches the key which the
170 * user pressed. We therefore mark it as B_UPON_KEYRELEASE_IGNORE_MODS
171 * for later, so that the user can release the modifiers before the
172 * actual key or button and the release event will still be matched. */
173 if (bind->release == B_UPON_KEYRELEASE && !is_release)
174 bind->release = B_UPON_KEYRELEASE_IGNORE_MODS;
176 /* Check if the binding is for a press or a release event */
177 if ((bind->release == B_UPON_KEYPRESS && is_release) ||
178 (bind->release >= B_UPON_KEYRELEASE && !is_release))
184 return (bind == TAILQ_END(bindings) ? NULL : bind);
188 * Returns a pointer to the Binding that matches the given xcb button or key
189 * event or NULL if no such binding exists.
192 Binding *get_binding_from_xcb_event(xcb_generic_event_t *event) {
193 bool is_release = (event->response_type == XCB_KEY_RELEASE
194 || event->response_type == XCB_BUTTON_RELEASE);
196 input_type_t input_type = ((event->response_type == XCB_BUTTON_RELEASE
197 || event->response_type == XCB_BUTTON_PRESS)
201 uint16_t event_state = ((xcb_key_press_event_t *)event)->state;
202 uint16_t event_detail = ((xcb_key_press_event_t *)event)->detail;
204 /* Remove the numlock bit, all other bits are modifiers we can bind to */
205 uint16_t state_filtered = event_state & ~(xcb_numlock_mask | XCB_MOD_MASK_LOCK);
206 DLOG("(removed numlock, state = %d)\n", state_filtered);
207 /* Only use the lower 8 bits of the state (modifier masks) so that mouse
208 * button masks are filtered out */
209 state_filtered &= 0xFF;
210 DLOG("(removed upper 8 bits, state = %d)\n", state_filtered);
212 if (xkb_current_group == XkbGroup2Index)
213 state_filtered |= BIND_MODE_SWITCH;
215 DLOG("(checked mode_switch, state %d)\n", state_filtered);
217 /* Find the binding */
218 Binding *bind = get_binding(state_filtered, is_release, event_detail, input_type);
220 /* No match? Then the user has Mode_switch enabled but does not have a
221 * specific keybinding. Fall back to the default keybindings (without
222 * Mode_switch). Makes it much more convenient for users of a hybrid
223 * layout (like ru). */
225 state_filtered &= ~(BIND_MODE_SWITCH);
226 DLOG("no match, new state_filtered = %d\n", state_filtered);
227 if ((bind = get_binding(state_filtered, is_release, event_detail, input_type)) == NULL) {
228 /* This is not a real error since we can have release and
229 * non-release bindings. On a press event for which there is only a
230 * !release-binding, but no release-binding, the corresponding
231 * release event will trigger this. No problem, though. */
232 DLOG("Could not lookup key binding (modifiers %d, keycode %d)\n",
233 state_filtered, event_detail);
241 * Translates keysymbols to keycodes for all bindings which use keysyms.
244 void translate_keysyms(void) {
248 xcb_keycode_t i, min_keycode, max_keycode;
250 min_keycode = xcb_get_setup(conn)->min_keycode;
251 max_keycode = xcb_get_setup(conn)->max_keycode;
253 TAILQ_FOREACH(bind, bindings, bindings) {
254 if (bind->input_type == B_MOUSE) {
255 int button = atoi(bind->symbol + (sizeof("button") - 1));
256 bind->keycode = button;
259 ELOG("Could not translate string to button: \"%s\"\n", bind->symbol);
264 if (bind->keycode > 0)
267 /* We need to translate the symbol to a keycode */
268 keysym = XStringToKeysym(bind->symbol);
269 if (keysym == NoSymbol) {
270 ELOG("Could not translate string to key symbol: \"%s\"\n",
275 /* Base column we use for looking up key symbols. We always consider
276 * the base column and the corresponding shift column, so without
277 * mode_switch, we look in 0 and 1, with mode_switch we look in 2 and
279 col = (bind->mods & BIND_MODE_SWITCH ? 2 : 0);
281 FREE(bind->translated_to);
282 bind->number_keycodes = 0;
284 for (i = min_keycode; i && i <= max_keycode; i++) {
285 if ((xcb_key_symbols_get_keysym(keysyms, i, col) != keysym) &&
286 (xcb_key_symbols_get_keysym(keysyms, i, col+1) != keysym))
288 bind->number_keycodes++;
289 bind->translated_to = srealloc(bind->translated_to,
290 (sizeof(xcb_keycode_t) *
291 bind->number_keycodes));
292 bind->translated_to[bind->number_keycodes-1] = i;
295 DLOG("Translated symbol \"%s\" to %d keycode\n", bind->symbol,
296 bind->number_keycodes);
301 * Switches the key bindings to the given mode, if the mode exists
304 void switch_mode(const char *new_mode) {
307 DLOG("Switching to mode %s\n", new_mode);
309 SLIST_FOREACH(mode, &modes, modes) {
310 if (strcasecmp(mode->name, new_mode) != 0)
313 ungrab_all_keys(conn);
314 bindings = mode->bindings;
316 grab_all_keys(conn, false);
319 sasprintf(&event_msg, "{\"change\":\"%s\"}", mode->name);
321 ipc_send_event("mode", I3_IPC_EVENT_MODE, event_msg);
327 ELOG("ERROR: Mode not found\n");
331 * Checks for duplicate key bindings (the same keycode or keysym is configured
332 * more than once). If a duplicate binding is found, a message is printed to
333 * stderr and the has_errors variable is set to true, which will start
337 void check_for_duplicate_bindings(struct context *context) {
338 Binding *bind, *current;
339 TAILQ_FOREACH(current, bindings, bindings) {
340 TAILQ_FOREACH(bind, bindings, bindings) {
341 /* Abort when we reach the current keybinding, only check the
346 /* Check if the input types are different */
347 if (bind->input_type != current->input_type)
350 /* Check if one is using keysym while the other is using bindsym.
352 /* XXX: It should be checked at a later place (when translating the
353 * keysym to keycodes) if there are any duplicates */
354 if ((bind->symbol == NULL && current->symbol != NULL) ||
355 (bind->symbol != NULL && current->symbol == NULL))
358 /* If bind is NULL, current has to be NULL, too (see above).
359 * If the keycodes differ, it can't be a duplicate. */
360 if (bind->symbol != NULL &&
361 strcasecmp(bind->symbol, current->symbol) != 0)
364 /* Check if the keycodes or modifiers are different. If so, they
365 * can't be duplicate */
366 if (bind->keycode != current->keycode ||
367 bind->mods != current->mods ||
368 bind->release != current->release)
371 context->has_errors = true;
372 if (current->keycode != 0) {
373 ELOG("Duplicate keybinding in config file:\n modmask %d with keycode %d, command \"%s\"\n",
374 current->mods, current->keycode, current->command);
376 ELOG("Duplicate keybinding in config file:\n modmask %d with keysym %s, command \"%s\"\n",
377 current->mods, current->symbol, current->command);