2 #define I3__FILE__ "config.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
9 * config.c: Configuration file (calling the parser (src/config_parser.c) with
10 * the correct path, switching key bindings mode).
15 /* We need Xlib for XStringToKeysym */
18 char *current_configpath = NULL;
20 struct modes_head modes;
21 struct barconfig_head barconfigs = TAILQ_HEAD_INITIALIZER(barconfigs);
24 * Ungrabs all keys, to be called before re-grabbing the keys because of a
25 * mapping_notify event or a configuration file reload
28 void ungrab_all_keys(xcb_connection_t *conn) {
29 DLOG("Ungrabbing all keys\n");
30 xcb_ungrab_key(conn, XCB_GRAB_ANY, root, XCB_BUTTON_MASK_ANY);
33 static void grab_keycode_for_binding(xcb_connection_t *conn, Binding *bind, uint32_t keycode) {
34 DLOG("Grabbing %d with modifiers %d (with mod_mask_lock %d)\n", keycode, bind->mods, bind->mods | XCB_MOD_MASK_LOCK);
35 /* Grab the key in all combinations */
36 #define GRAB_KEY(modifier) \
38 xcb_grab_key(conn, 0, root, modifier, keycode, \
39 XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC); \
41 int mods = bind->mods;
42 if ((bind->mods & BIND_MODE_SWITCH) != 0) {
43 mods &= ~BIND_MODE_SWITCH;
45 mods = XCB_MOD_MASK_ANY;
48 GRAB_KEY(mods | xcb_numlock_mask);
49 GRAB_KEY(mods | XCB_MOD_MASK_LOCK);
50 GRAB_KEY(mods | xcb_numlock_mask | XCB_MOD_MASK_LOCK);
54 * Returns a pointer to the Binding with the specified modifiers and keycode
55 * or NULL if no such binding exists.
58 Binding *get_binding(uint16_t modifiers, bool key_release, xcb_keycode_t keycode) {
62 /* On a KeyPress event, we first reset all
63 * B_UPON_KEYRELEASE_IGNORE_MODS bindings back to B_UPON_KEYRELEASE */
64 TAILQ_FOREACH(bind, bindings, bindings) {
65 if (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS)
66 bind->release = B_UPON_KEYRELEASE;
70 TAILQ_FOREACH(bind, bindings, bindings) {
71 /* First compare the modifiers (unless this is a
72 * B_UPON_KEYRELEASE_IGNORE_MODS binding and this is a KeyRelease
74 if (bind->mods != modifiers &&
75 (bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
79 /* If a symbol was specified by the user, we need to look in
80 * the array of translated keycodes for the event’s keycode */
81 if (bind->symbol != NULL) {
82 if (memmem(bind->translated_to,
83 bind->number_keycodes * sizeof(xcb_keycode_t),
84 &keycode, sizeof(xcb_keycode_t)) == NULL)
87 /* This case is easier: The user specified a keycode */
88 if (bind->keycode != keycode)
92 /* If this keybinding is a KeyRelease binding, it matches the key which
93 * the user pressed. We therefore mark it as
94 * B_UPON_KEYRELEASE_IGNORE_MODS for later, so that the user can
95 * release the modifiers before the actual key and the KeyRelease will
96 * still be matched. */
97 if (bind->release == B_UPON_KEYRELEASE && !key_release)
98 bind->release = B_UPON_KEYRELEASE_IGNORE_MODS;
100 /* Check if the binding is for a KeyPress or a KeyRelease event */
101 if ((bind->release == B_UPON_KEYPRESS && key_release) ||
102 (bind->release >= B_UPON_KEYRELEASE && !key_release))
108 return (bind == TAILQ_END(bindings) ? NULL : bind);
112 * Translates keysymbols to keycodes for all bindings which use keysyms.
115 void translate_keysyms(void) {
120 min_keycode = xcb_get_setup(conn)->min_keycode,
121 max_keycode = xcb_get_setup(conn)->max_keycode;
123 TAILQ_FOREACH(bind, bindings, bindings) {
124 if (bind->keycode > 0)
127 /* We need to translate the symbol to a keycode */
128 keysym = XStringToKeysym(bind->symbol);
129 if (keysym == NoSymbol) {
130 ELOG("Could not translate string to key symbol: \"%s\"\n",
135 /* Base column we use for looking up key symbols. We always consider
136 * the base column and the corresponding shift column, so without
137 * mode_switch, we look in 0 and 1, with mode_switch we look in 2 and
139 col = (bind->mods & BIND_MODE_SWITCH ? 2 : 0);
141 FREE(bind->translated_to);
142 bind->number_keycodes = 0;
144 for (i = min_keycode; i && i <= max_keycode; i++) {
145 if ((xcb_key_symbols_get_keysym(keysyms, i, col) != keysym) &&
146 (xcb_key_symbols_get_keysym(keysyms, i, col+1) != keysym))
148 bind->number_keycodes++;
149 bind->translated_to = srealloc(bind->translated_to,
150 (sizeof(xcb_keycode_t) *
151 bind->number_keycodes));
152 bind->translated_to[bind->number_keycodes-1] = i;
155 DLOG("Translated symbol \"%s\" to %d keycode\n", bind->symbol,
156 bind->number_keycodes);
161 * Grab the bound keys (tell X to send us keypress events for those keycodes)
164 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch) {
166 TAILQ_FOREACH(bind, bindings, bindings) {
167 if ((bind_mode_switch && (bind->mods & BIND_MODE_SWITCH) == 0) ||
168 (!bind_mode_switch && (bind->mods & BIND_MODE_SWITCH) != 0))
171 /* The easy case: the user specified a keycode directly. */
172 if (bind->keycode > 0) {
173 grab_keycode_for_binding(conn, bind, bind->keycode);
177 xcb_keycode_t *walk = bind->translated_to;
178 for (int i = 0; i < bind->number_keycodes; i++)
179 grab_keycode_for_binding(conn, bind, *walk++);
184 * Switches the key bindings to the given mode, if the mode exists
187 void switch_mode(const char *new_mode) {
190 LOG("Switching to mode %s\n", new_mode);
192 SLIST_FOREACH(mode, &modes, modes) {
193 if (strcasecmp(mode->name, new_mode) != 0)
196 ungrab_all_keys(conn);
197 bindings = mode->bindings;
199 grab_all_keys(conn, false);
202 sasprintf(&event_msg, "{\"change\":\"%s\"}", mode->name);
204 ipc_send_event("mode", I3_IPC_EVENT_MODE, event_msg);
210 ELOG("ERROR: Mode not found\n");
214 * Get the path of the first configuration file found. If override_configpath
215 * is specified, that path is returned and saved for further calls. Otherwise,
216 * checks the home directory first, then the system directory first, always
217 * taking into account the XDG Base Directory Specification ($XDG_CONFIG_HOME,
221 static char *get_config_path(const char *override_configpath) {
222 char *xdg_config_home, *xdg_config_dirs, *config_path;
224 static const char *saved_configpath = NULL;
226 if (override_configpath != NULL) {
227 saved_configpath = override_configpath;
228 return sstrdup(saved_configpath);
231 if (saved_configpath != NULL)
232 return sstrdup(saved_configpath);
234 /* 1: check the traditional path under the home directory */
235 config_path = resolve_tilde("~/.i3/config");
236 if (path_exists(config_path))
240 /* 2: check for $XDG_CONFIG_HOME/i3/config */
241 if ((xdg_config_home = getenv("XDG_CONFIG_HOME")) == NULL)
242 xdg_config_home = "~/.config";
244 xdg_config_home = resolve_tilde(xdg_config_home);
245 sasprintf(&config_path, "%s/i3/config", xdg_config_home);
246 free(xdg_config_home);
248 if (path_exists(config_path))
252 /* 3: check the traditional path under /etc */
253 config_path = SYSCONFDIR "/i3/config";
254 if (path_exists(config_path))
255 return sstrdup(config_path);
257 /* 4: check for $XDG_CONFIG_DIRS/i3/config */
258 if ((xdg_config_dirs = getenv("XDG_CONFIG_DIRS")) == NULL)
259 xdg_config_dirs = "/etc/xdg";
261 char *buf = sstrdup(xdg_config_dirs);
262 char *tok = strtok(buf, ":");
263 while (tok != NULL) {
264 tok = resolve_tilde(tok);
265 sasprintf(&config_path, "%s/i3/config", tok);
267 if (path_exists(config_path)) {
272 tok = strtok(NULL, ":");
276 die("Unable to find the configuration file (looked at "
277 "~/.i3/config, $XDG_CONFIG_HOME/i3/config, "
278 SYSCONFDIR "/i3/config and $XDG_CONFIG_DIRS/i3/config)");
282 * Finds the configuration file to use (either the one specified by
283 * override_configpath), the user’s one or the system default) and calls
287 static void parse_configuration(const char *override_configpath) {
288 char *path = get_config_path(override_configpath);
289 LOG("Parsing configfile %s\n", path);
290 FREE(current_configpath);
291 current_configpath = path;
296 * (Re-)loads the configuration file (sets useful defaults before).
299 void load_configuration(xcb_connection_t *conn, const char *override_configpath, bool reload) {
301 /* First ungrab the keys */
302 ungrab_all_keys(conn);
306 while (!SLIST_EMPTY(&modes)) {
307 mode = SLIST_FIRST(&modes);
310 /* Clear the old binding list */
311 bindings = mode->bindings;
312 while (!TAILQ_EMPTY(bindings)) {
313 bind = TAILQ_FIRST(bindings);
314 TAILQ_REMOVE(bindings, bind, bindings);
315 FREE(bind->translated_to);
320 SLIST_REMOVE(&modes, mode, Mode, modes);
323 struct Assignment *assign;
324 while (!TAILQ_EMPTY(&assignments)) {
325 assign = TAILQ_FIRST(&assignments);
326 if (assign->type == A_TO_WORKSPACE)
327 FREE(assign->dest.workspace);
328 else if (assign->type == A_TO_OUTPUT)
329 FREE(assign->dest.output);
330 else if (assign->type == A_COMMAND)
331 FREE(assign->dest.command);
332 match_free(&(assign->match));
333 TAILQ_REMOVE(&assignments, assign, assignments);
337 /* Clear bar configs */
338 Barconfig *barconfig;
339 while (!TAILQ_EMPTY(&barconfigs)) {
340 barconfig = TAILQ_FIRST(&barconfigs);
342 for (int c = 0; c < barconfig->num_outputs; c++)
343 free(barconfig->outputs[c]);
344 FREE(barconfig->outputs);
345 FREE(barconfig->tray_output);
346 FREE(barconfig->socket_path);
347 FREE(barconfig->status_command);
348 FREE(barconfig->i3bar_command);
349 FREE(barconfig->font);
350 FREE(barconfig->colors.background);
351 FREE(barconfig->colors.statusline);
352 FREE(barconfig->colors.focused_workspace_border);
353 FREE(barconfig->colors.focused_workspace_bg);
354 FREE(barconfig->colors.focused_workspace_text);
355 FREE(barconfig->colors.active_workspace_border);
356 FREE(barconfig->colors.active_workspace_bg);
357 FREE(barconfig->colors.active_workspace_text);
358 FREE(barconfig->colors.inactive_workspace_border);
359 FREE(barconfig->colors.inactive_workspace_bg);
360 FREE(barconfig->colors.inactive_workspace_text);
361 FREE(barconfig->colors.urgent_workspace_border);
362 FREE(barconfig->colors.urgent_workspace_bg);
363 FREE(barconfig->colors.urgent_workspace_text);
364 TAILQ_REMOVE(&barconfigs, barconfig, configs);
368 /* Clear workspace names */
371 TAILQ_FOREACH(ws, workspaces, workspaces)
372 workspace_set_name(ws, NULL);
375 /* Invalidate pixmap caches in case font or colors changed */
377 TAILQ_FOREACH(con, &all_cons, all_cons)
378 FREE(con->deco_render_params);
380 /* Get rid of the current font */
386 struct Mode *default_mode = scalloc(sizeof(struct Mode));
387 default_mode->name = sstrdup("default");
388 default_mode->bindings = scalloc(sizeof(struct bindings_head));
389 TAILQ_INIT(default_mode->bindings);
390 SLIST_INSERT_HEAD(&modes, default_mode, modes);
392 bindings = default_mode->bindings;
394 #define REQUIRED_OPTION(name) \
395 if (config.name == NULL) \
396 die("You did not specify required configuration option " #name "\n");
398 /* Clear the old config or initialize the data structure */
399 memset(&config, 0, sizeof(config));
401 /* Initialize default colors */
402 #define INIT_COLOR(x, cborder, cbackground, ctext, cindicator) \
404 x.border = get_colorpixel(cborder); \
405 x.background = get_colorpixel(cbackground); \
406 x.text = get_colorpixel(ctext); \
407 x.indicator = get_colorpixel(cindicator); \
410 config.client.background = get_colorpixel("#000000");
411 INIT_COLOR(config.client.focused, "#4c7899", "#285577", "#ffffff", "#2e9ef4");
412 INIT_COLOR(config.client.focused_inactive, "#333333", "#5f676a", "#ffffff", "#484e50");
413 INIT_COLOR(config.client.unfocused, "#333333", "#222222", "#888888", "#292d2e");
414 INIT_COLOR(config.client.urgent, "#2f343a", "#900000", "#ffffff", "#900000");
416 /* the last argument (indicator color) is ignored for bar colors */
417 INIT_COLOR(config.bar.focused, "#4c7899", "#285577", "#ffffff", "#000000");
418 INIT_COLOR(config.bar.unfocused, "#333333", "#222222", "#888888", "#000000");
419 INIT_COLOR(config.bar.urgent, "#2f343a", "#900000", "#ffffff", "#000000");
421 config.default_border = BS_NORMAL;
422 config.default_floating_border = BS_NORMAL;
423 config.default_border_width = 2;
424 /* Set default_orientation to NO_ORIENTATION for auto orientation. */
425 config.default_orientation = NO_ORIENTATION;
427 /* Set default urgency reset delay to 500ms */
428 if (config.workspace_urgency_timer == 0)
429 config.workspace_urgency_timer = 0.5;
431 parse_configuration(override_configpath);
435 grab_all_keys(conn, false);
438 if (config.font.type == FONT_TYPE_NONE) {
439 ELOG("You did not specify required configuration option \"font\"\n");
440 config.font = load_font("fixed", true);
441 set_font(&config.font);
444 /* Redraw the currently visible decorations on reload, so that
445 * the possibly new drawing parameters changed. */
447 x_deco_recurse(croot);
452 /* Set an empty name for every workspace which got no name */
454 TAILQ_FOREACH(ws, workspaces, workspaces) {
455 if (ws->name != NULL) {
456 /* If the font was not specified when the workspace name
457 * was loaded, we need to predict the text width now */
458 if (ws->text_width == 0)
459 ws->text_width = predict_text_width(global_conn,
460 config.font, ws->name, ws->name_len);
464 workspace_set_name(ws, NULL);