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/cfgparse.y) with the
10 * 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\n", keycode);
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_numlock_mask | XCB_MOD_MASK_LOCK);
53 * Returns a pointer to the Binding with the specified modifiers and keycode
54 * or NULL if no such binding exists.
57 Binding *get_binding(uint16_t modifiers, bool key_release, xcb_keycode_t keycode) {
61 /* On a KeyPress event, we first reset all
62 * B_UPON_KEYRELEASE_IGNORE_MODS bindings back to B_UPON_KEYRELEASE */
63 TAILQ_FOREACH(bind, bindings, bindings) {
64 if (bind->release == B_UPON_KEYRELEASE_IGNORE_MODS)
65 bind->release = B_UPON_KEYRELEASE;
68 /* Then we transition the KeyRelease bindings into a state where the
69 * modifiers no longer matter for the KeyRelease event so that users
70 * can release the modifier key before releasing the actual key. */
71 TAILQ_FOREACH(bind, bindings, bindings) {
72 if (bind->release == B_UPON_KEYRELEASE && !key_release)
73 bind->release = B_UPON_KEYRELEASE_IGNORE_MODS;
77 TAILQ_FOREACH(bind, bindings, bindings) {
78 /* First compare the modifiers (unless this is a
79 * B_UPON_KEYRELEASE_IGNORE_MODS binding and this is a KeyRelease
81 if (bind->mods != modifiers &&
82 (bind->release != B_UPON_KEYRELEASE_IGNORE_MODS ||
86 /* Check if the binding is for a KeyPress or a KeyRelease event */
87 if ((bind->release == B_UPON_KEYPRESS && key_release) ||
88 (bind->release >= B_UPON_KEYRELEASE && !key_release))
91 /* If a symbol was specified by the user, we need to look in
92 * the array of translated keycodes for the event’s keycode */
93 if (bind->symbol != NULL) {
94 if (memmem(bind->translated_to,
95 bind->number_keycodes * sizeof(xcb_keycode_t),
96 &keycode, sizeof(xcb_keycode_t)) != NULL)
99 /* This case is easier: The user specified a keycode */
100 if (bind->keycode == keycode)
105 return (bind == TAILQ_END(bindings) ? NULL : bind);
109 * Translates keysymbols to keycodes for all bindings which use keysyms.
112 void translate_keysyms(void) {
117 min_keycode = xcb_get_setup(conn)->min_keycode,
118 max_keycode = xcb_get_setup(conn)->max_keycode;
120 TAILQ_FOREACH(bind, bindings, bindings) {
121 if (bind->keycode > 0)
124 /* We need to translate the symbol to a keycode */
125 keysym = XStringToKeysym(bind->symbol);
126 if (keysym == NoSymbol) {
127 ELOG("Could not translate string to key symbol: \"%s\"\n",
132 /* Base column we use for looking up key symbols. We always consider
133 * the base column and the corresponding shift column, so without
134 * mode_switch, we look in 0 and 1, with mode_switch we look in 2 and
136 col = (bind->mods & BIND_MODE_SWITCH ? 2 : 0);
138 FREE(bind->translated_to);
139 bind->number_keycodes = 0;
141 for (i = min_keycode; i && i <= max_keycode; i++) {
142 if ((xcb_key_symbols_get_keysym(keysyms, i, col) != keysym) &&
143 (xcb_key_symbols_get_keysym(keysyms, i, col+1) != keysym))
145 bind->number_keycodes++;
146 bind->translated_to = srealloc(bind->translated_to,
147 (sizeof(xcb_keycode_t) *
148 bind->number_keycodes));
149 bind->translated_to[bind->number_keycodes-1] = i;
152 DLOG("Translated symbol \"%s\" to %d keycode\n", bind->symbol,
153 bind->number_keycodes);
158 * Grab the bound keys (tell X to send us keypress events for those keycodes)
161 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch) {
163 TAILQ_FOREACH(bind, bindings, bindings) {
164 if ((bind_mode_switch && (bind->mods & BIND_MODE_SWITCH) == 0) ||
165 (!bind_mode_switch && (bind->mods & BIND_MODE_SWITCH) != 0))
168 /* The easy case: the user specified a keycode directly. */
169 if (bind->keycode > 0) {
170 grab_keycode_for_binding(conn, bind, bind->keycode);
174 xcb_keycode_t *walk = bind->translated_to;
175 for (int i = 0; i < bind->number_keycodes; i++)
176 grab_keycode_for_binding(conn, bind, *walk++);
181 * Switches the key bindings to the given mode, if the mode exists
184 void switch_mode(const char *new_mode) {
187 LOG("Switching to mode %s\n", new_mode);
189 SLIST_FOREACH(mode, &modes, modes) {
190 if (strcasecmp(mode->name, new_mode) != 0)
193 ungrab_all_keys(conn);
194 bindings = mode->bindings;
196 grab_all_keys(conn, false);
200 ELOG("ERROR: Mode not found\n");
204 * Get the path of the first configuration file found. If override_configpath
205 * is specified, that path is returned and saved for further calls. Otherwise,
206 * checks the home directory first, then the system directory first, always
207 * taking into account the XDG Base Directory Specification ($XDG_CONFIG_HOME,
211 static char *get_config_path(const char *override_configpath) {
212 char *xdg_config_home, *xdg_config_dirs, *config_path;
214 static const char *saved_configpath = NULL;
216 if (override_configpath != NULL) {
217 saved_configpath = override_configpath;
218 return sstrdup(saved_configpath);
221 if (saved_configpath != NULL)
222 return sstrdup(saved_configpath);
224 /* 1: check the traditional path under the home directory */
225 config_path = resolve_tilde("~/.i3/config");
226 if (path_exists(config_path))
230 /* 2: check for $XDG_CONFIG_HOME/i3/config */
231 if ((xdg_config_home = getenv("XDG_CONFIG_HOME")) == NULL)
232 xdg_config_home = "~/.config";
234 xdg_config_home = resolve_tilde(xdg_config_home);
235 sasprintf(&config_path, "%s/i3/config", xdg_config_home);
236 free(xdg_config_home);
238 if (path_exists(config_path))
242 /* 3: check the traditional path under /etc */
243 config_path = SYSCONFDIR "/i3/config";
244 if (path_exists(config_path))
245 return sstrdup(config_path);
247 /* 4: check for $XDG_CONFIG_DIRS/i3/config */
248 if ((xdg_config_dirs = getenv("XDG_CONFIG_DIRS")) == NULL)
249 xdg_config_dirs = "/etc/xdg";
251 char *buf = sstrdup(xdg_config_dirs);
252 char *tok = strtok(buf, ":");
253 while (tok != NULL) {
254 tok = resolve_tilde(tok);
255 sasprintf(&config_path, "%s/i3/config", tok);
257 if (path_exists(config_path)) {
262 tok = strtok(NULL, ":");
266 die("Unable to find the configuration file (looked at "
267 "~/.i3/config, $XDG_CONFIG_HOME/i3/config, "
268 SYSCONFDIR "/i3/config and $XDG_CONFIG_DIRS/i3/config)");
272 * Finds the configuration file to use (either the one specified by
273 * override_configpath), the user’s one or the system default) and calls
277 static void parse_configuration(const char *override_configpath) {
278 char *path = get_config_path(override_configpath);
279 LOG("Parsing configfile %s\n", path);
280 FREE(current_configpath);
281 current_configpath = path;
286 * (Re-)loads the configuration file (sets useful defaults before).
289 void load_configuration(xcb_connection_t *conn, const char *override_configpath, bool reload) {
291 /* First ungrab the keys */
292 ungrab_all_keys(conn);
296 while (!SLIST_EMPTY(&modes)) {
297 mode = SLIST_FIRST(&modes);
300 /* Clear the old binding list */
301 bindings = mode->bindings;
302 while (!TAILQ_EMPTY(bindings)) {
303 bind = TAILQ_FIRST(bindings);
304 TAILQ_REMOVE(bindings, bind, bindings);
305 FREE(bind->translated_to);
310 SLIST_REMOVE(&modes, mode, Mode, modes);
313 struct Assignment *assign;
314 while (!TAILQ_EMPTY(&assignments)) {
315 assign = TAILQ_FIRST(&assignments);
316 if (assign->type == A_TO_WORKSPACE)
317 FREE(assign->dest.workspace);
318 else if (assign->type == A_TO_OUTPUT)
319 FREE(assign->dest.output);
320 else if (assign->type == A_COMMAND)
321 FREE(assign->dest.command);
322 match_free(&(assign->match));
323 TAILQ_REMOVE(&assignments, assign, assignments);
327 /* Clear bar configs */
328 Barconfig *barconfig;
329 while (!TAILQ_EMPTY(&barconfigs)) {
330 barconfig = TAILQ_FIRST(&barconfigs);
332 for (int c = 0; c < barconfig->num_outputs; c++)
333 free(barconfig->outputs[c]);
334 FREE(barconfig->outputs);
335 FREE(barconfig->tray_output);
336 FREE(barconfig->socket_path);
337 FREE(barconfig->status_command);
338 FREE(barconfig->i3bar_command);
339 FREE(barconfig->font);
340 FREE(barconfig->colors.background);
341 FREE(barconfig->colors.statusline);
342 FREE(barconfig->colors.focused_workspace_border);
343 FREE(barconfig->colors.focused_workspace_bg);
344 FREE(barconfig->colors.focused_workspace_text);
345 FREE(barconfig->colors.active_workspace_border);
346 FREE(barconfig->colors.active_workspace_bg);
347 FREE(barconfig->colors.active_workspace_text);
348 FREE(barconfig->colors.inactive_workspace_border);
349 FREE(barconfig->colors.inactive_workspace_bg);
350 FREE(barconfig->colors.inactive_workspace_text);
351 FREE(barconfig->colors.urgent_workspace_border);
352 FREE(barconfig->colors.urgent_workspace_bg);
353 FREE(barconfig->colors.urgent_workspace_text);
354 TAILQ_REMOVE(&barconfigs, barconfig, configs);
358 /* Clear workspace names */
361 TAILQ_FOREACH(ws, workspaces, workspaces)
362 workspace_set_name(ws, NULL);
365 /* Invalidate pixmap caches in case font or colors changed */
367 TAILQ_FOREACH(con, &all_cons, all_cons)
368 FREE(con->deco_render_params);
370 /* Get rid of the current font */
376 struct Mode *default_mode = scalloc(sizeof(struct Mode));
377 default_mode->name = sstrdup("default");
378 default_mode->bindings = scalloc(sizeof(struct bindings_head));
379 TAILQ_INIT(default_mode->bindings);
380 SLIST_INSERT_HEAD(&modes, default_mode, modes);
382 bindings = default_mode->bindings;
384 #define REQUIRED_OPTION(name) \
385 if (config.name == NULL) \
386 die("You did not specify required configuration option " #name "\n");
388 /* Clear the old config or initialize the data structure */
389 memset(&config, 0, sizeof(config));
391 /* Initialize default colors */
392 #define INIT_COLOR(x, cborder, cbackground, ctext, cindicator) \
394 x.border = get_colorpixel(cborder); \
395 x.background = get_colorpixel(cbackground); \
396 x.text = get_colorpixel(ctext); \
397 x.indicator = get_colorpixel(cindicator); \
400 config.client.background = get_colorpixel("#000000");
401 INIT_COLOR(config.client.focused, "#4c7899", "#285577", "#ffffff", "#2e9ef4");
402 INIT_COLOR(config.client.focused_inactive, "#333333", "#5f676a", "#ffffff", "#484e50");
403 INIT_COLOR(config.client.unfocused, "#333333", "#222222", "#888888", "#292d2e");
404 INIT_COLOR(config.client.urgent, "#2f343a", "#900000", "#ffffff", "#900000");
406 /* the last argument (indicator color) is ignored for bar colors */
407 INIT_COLOR(config.bar.focused, "#4c7899", "#285577", "#ffffff", "#000000");
408 INIT_COLOR(config.bar.unfocused, "#333333", "#222222", "#888888", "#000000");
409 INIT_COLOR(config.bar.urgent, "#2f343a", "#900000", "#ffffff", "#000000");
411 config.default_border = BS_NORMAL;
412 config.default_floating_border = BS_NORMAL;
413 /* Set default_orientation to NO_ORIENTATION for auto orientation. */
414 config.default_orientation = NO_ORIENTATION;
416 parse_configuration(override_configpath);
420 grab_all_keys(conn, false);
423 if (config.font.type == FONT_TYPE_NONE) {
424 ELOG("You did not specify required configuration option \"font\"\n");
425 config.font = load_font("fixed", true);
426 set_font(&config.font);
429 /* Redraw the currently visible decorations on reload, so that
430 * the possibly new drawing parameters changed. */
432 x_deco_recurse(croot);
437 /* Set an empty name for every workspace which got no name */
439 TAILQ_FOREACH(ws, workspaces, workspaces) {
440 if (ws->name != NULL) {
441 /* If the font was not specified when the workspace name
442 * was loaded, we need to predict the text width now */
443 if (ws->text_width == 0)
444 ws->text_width = predict_text_width(global_conn,
445 config.font, ws->name, ws->name_len);
449 workspace_set_name(ws, NULL);