i3
config.c
Go to the documentation of this file.
1/*
2 * vim:ts=4:sw=4:expandtab
3 *
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
6 *
7 * config.c: Configuration file (calling the parser (src/config_parser.c) with
8 * the correct path, switching key bindings mode).
9 *
10 */
11#include "all.h"
12
13#include <libgen.h>
14#include <unistd.h>
15
16#include <xkbcommon/xkbcommon.h>
17
18char *current_configpath = NULL;
20struct modes_head modes;
23
24/*
25 * Ungrabs all keys, to be called before re-grabbing the keys because of a
26 * mapping_notify event or a configuration file reload
27 *
28 */
29void ungrab_all_keys(xcb_connection_t *conn) {
30 DLOG("Ungrabbing all keys\n");
31 xcb_ungrab_key(conn, XCB_GRAB_ANY, root, XCB_BUTTON_MASK_ANY);
32}
33
34static void free_configuration(void) {
35 assert(conn != NULL);
36
37 /* If we are currently in a binding mode, we first revert to the default
38 * since we have no guarantee that the current mode will even still exist
39 * after parsing the config again. See #2228. */
40 switch_mode("default");
41
42 /* First ungrab the keys */
44
45 struct Mode *mode;
46 while (!SLIST_EMPTY(&modes)) {
47 mode = SLIST_FIRST(&modes);
48 FREE(mode->name);
49
50 /* Clear the old binding list */
51 while (!TAILQ_EMPTY(mode->bindings)) {
52 Binding *bind = TAILQ_FIRST(mode->bindings);
53 TAILQ_REMOVE(mode->bindings, bind, bindings);
54 binding_free(bind);
55 }
56 FREE(mode->bindings);
57
58 SLIST_REMOVE(&modes, mode, Mode, modes);
59 FREE(mode);
60 }
61
62 while (!TAILQ_EMPTY(&assignments)) {
63 struct Assignment *assign = TAILQ_FIRST(&assignments);
64 if (assign->type == A_TO_WORKSPACE || assign->type == A_TO_WORKSPACE_NUMBER)
65 FREE(assign->dest.workspace);
66 else if (assign->type == A_COMMAND)
67 FREE(assign->dest.command);
68 else if (assign->type == A_TO_OUTPUT)
69 FREE(assign->dest.output);
70 match_free(&(assign->match));
72 FREE(assign);
73 }
74
75 while (!TAILQ_EMPTY(&ws_assignments)) {
77 FREE(assign->name);
78 FREE(assign->output);
80 FREE(assign);
81 }
82
83 /* Clear bar configs */
84 Barconfig *barconfig;
85 while (!TAILQ_EMPTY(&barconfigs)) {
86 barconfig = TAILQ_FIRST(&barconfigs);
87 FREE(barconfig->id);
88 for (int c = 0; c < barconfig->num_outputs; c++)
89 free(barconfig->outputs[c]);
90
91 while (!TAILQ_EMPTY(&(barconfig->bar_bindings))) {
92 struct Barbinding *binding = TAILQ_FIRST(&(barconfig->bar_bindings));
93 FREE(binding->command);
94 TAILQ_REMOVE(&(barconfig->bar_bindings), binding, bindings);
95 FREE(binding);
96 }
97
98 while (!TAILQ_EMPTY(&(barconfig->tray_outputs))) {
99 struct tray_output_t *tray_output = TAILQ_FIRST(&(barconfig->tray_outputs));
100 FREE(tray_output->output);
101 TAILQ_REMOVE(&(barconfig->tray_outputs), tray_output, tray_outputs);
102 FREE(tray_output);
103 }
104
105 FREE(barconfig->outputs);
106 FREE(barconfig->socket_path);
107 FREE(barconfig->status_command);
108 FREE(barconfig->workspace_command);
109 FREE(barconfig->i3bar_command);
110 FREE(barconfig->font);
111 FREE(barconfig->colors.background);
112 FREE(barconfig->colors.statusline);
113 FREE(barconfig->colors.separator);
114 FREE(barconfig->colors.focused_background);
115 FREE(barconfig->colors.focused_statusline);
116 FREE(barconfig->colors.focused_separator);
118 FREE(barconfig->colors.focused_workspace_bg);
121 FREE(barconfig->colors.active_workspace_bg);
127 FREE(barconfig->colors.urgent_workspace_bg);
129 FREE(barconfig->colors.binding_mode_border);
130 FREE(barconfig->colors.binding_mode_bg);
131 FREE(barconfig->colors.binding_mode_text);
132 TAILQ_REMOVE(&barconfigs, barconfig, configs);
133 FREE(barconfig);
134 }
135
136 Con *con;
138 /* Assignments changed, previously ran assignments are invalid. */
139 if (con->window) {
140 con->window->nr_assignments = 0;
142 }
143 /* Invalidate pixmap caches in case font or colors changed. */
145 }
146
147 /* Get rid of the current font */
148 free_font();
149
150 free(config.ipc_socket_path);
151 free(config.restart_state_path);
152 free(config.fake_outputs);
153}
154
155/*
156 * (Re-)loads the configuration file (sets useful defaults before).
157 *
158 * If you specify override_configpath, only this path is used to look for a
159 * configuration file.
160 *
161 * load_type specifies the type of loading: C_VALIDATE is used to only verify
162 * the correctness of the config file (used with the flag -C). C_LOAD will load
163 * the config for normal use and display errors in the nagbar. C_RELOAD will
164 * also clear the previous config.
165 *
166 */
167bool load_configuration(const char *override_configpath, config_load_t load_type) {
168 if (load_type == C_RELOAD) {
170 }
171
173
174 struct Mode *default_mode = scalloc(1, sizeof(struct Mode));
175 default_mode->name = sstrdup("default");
176 default_mode->bindings = scalloc(1, sizeof(struct bindings_head));
177 TAILQ_INIT(default_mode->bindings);
178 SLIST_INSERT_HEAD(&modes, default_mode, modes);
179
180 bindings = default_mode->bindings;
181 current_binding_mode = default_mode->name;
182
183 /* Clear the old config or initialize the data structure */
184 memset(&config, 0, sizeof(config));
185
186 /* Initialize default colors */
187#define INIT_COLOR(x, cborder, cbackground, ctext, cindicator) \
188 do { \
189 x.border = draw_util_hex_to_color(cborder); \
190 x.background = draw_util_hex_to_color(cbackground); \
191 x.text = draw_util_hex_to_color(ctext); \
192 x.indicator = draw_util_hex_to_color(cindicator); \
193 x.child_border = draw_util_hex_to_color(cbackground); \
194 } while (0)
195
196// config.client.got_focused_tab_title = false;
197 config.client[QUBE_DOM0].background = draw_util_hex_to_color("#c4c4c4");
198 INIT_COLOR(config.client[QUBE_DOM0].focused,
199 "#f7f7f7", "#f5f5f5", "#000000", "#0a0a0a");
200 INIT_COLOR(config.client[QUBE_DOM0].focused_inactive,
201 "#f7f7f7", "#dcdcdc", "#191919", "#232323");
202 INIT_COLOR(config.client[QUBE_DOM0].unfocused,
203 "#f7f7f7", "#c4c4c4", "#323232", "#3b3b3b");
204 INIT_COLOR(config.client[QUBE_DOM0].urgent,
205 "#bd2727", "#e79e27", "#333333", "#27bdbd");
206
207 config.client[QUBE_RED].background = draw_util_hex_to_color("#841b1b");
208 INIT_COLOR(config.client[QUBE_RED].focused,
209 "#d06767", "#bd2727", "#ffffff", "#27bdbd");
210 INIT_COLOR(config.client[QUBE_RED].focused_inactive,
211 "#d06767", "#971f1f", "#e5e5e5", "#1f9797");
212 INIT_COLOR(config.client[QUBE_RED].unfocused,
213 "#d06767", "#841b1b", "#cccccc", "#1b8484");
214 INIT_COLOR(config.client[QUBE_RED].urgent,
215 "#bd2727", "#e79e27", "#333333", "#27bdbd");
216
217 config.client[QUBE_ORANGE].background = draw_util_hex_to_color("#a16e1b");
218 INIT_COLOR(config.client[QUBE_ORANGE].focused,
219 "#eebb67", "#e79e27", "#000000", "#2770e7");
220 INIT_COLOR(config.client[QUBE_ORANGE].focused_inactive,
221 "#eebb67", "#b87e1f", "#191919", "#1f59b8");
222 INIT_COLOR(config.client[QUBE_ORANGE].unfocused,
223 "#eebb67", "#a16e1b", "#323232", "#1b4ea1");
224 INIT_COLOR(config.client[QUBE_ORANGE].urgent,
225 "#bd2727", "#e79e27", "#333333", "#27bdbd");
226
227 config.client[QUBE_YELLOW].background = draw_util_hex_to_color("#a1a023");
228 INIT_COLOR(config.client[QUBE_YELLOW].focused,
229 "#eeec6f", "#e7e532", "#000000", "#3234e7");
230 INIT_COLOR(config.client[QUBE_YELLOW].focused_inactive,
231 "#eeec6f", "#b8b728", "#191919", "#2829b8");
232 INIT_COLOR(config.client[QUBE_YELLOW].unfocused,
233 "#eeec6f", "#a1a023", "#323232", "#2324a1");
234 INIT_COLOR(config.client[QUBE_YELLOW].urgent,
235 "#bd2727", "#e79e27", "#333333", "#27bdbd");
236
237 config.client[QUBE_GREEN].background = draw_util_hex_to_color("#3e972c");
238 INIT_COLOR(config.client[QUBE_GREEN].focused,
239 "#8be379", "#5ad840", "#000000", "#be40d8");
240 INIT_COLOR(config.client[QUBE_GREEN].focused_inactive,
241 "#8be379", "#48ac33", "#191919", "#9833ac");
242 INIT_COLOR(config.client[QUBE_GREEN].unfocused,
243 "#8be379", "#3e972c", "#323232", "#852c97");
244 INIT_COLOR(config.client[QUBE_GREEN].urgent,
245 "#bd2727", "#e79e27", "#333333", "#27bdbd");
246
247 config.client[QUBE_GRAY].background = draw_util_hex_to_color("#636368");
248 INIT_COLOR(config.client[QUBE_GRAY].focused,
249 "#afafb4", "#8e8e95", "#ffffff", "#95958e");
250 INIT_COLOR(config.client[QUBE_GRAY].focused_inactive,
251 "#afafb4", "#717177", "#e5e5e5", "#777771");
252 INIT_COLOR(config.client[QUBE_GRAY].unfocused,
253 "#afafb4", "#636368", "#cccccc", "#686863");
254 INIT_COLOR(config.client[QUBE_GRAY].urgent,
255 "#bd2727", "#e79e27", "#333333", "#27bdbd");
256
257 config.client[QUBE_BLUE].background = draw_util_hex_to_color("#275197");
258 INIT_COLOR(config.client[QUBE_BLUE].focused,
259 "#739de3", "#3874d8", "#ffffff", "#d89c38");
260 INIT_COLOR(config.client[QUBE_BLUE].focused_inactive,
261 "#739de3", "#2c5cac", "#e5e5e5", "#ac7c2c");
262 INIT_COLOR(config.client[QUBE_BLUE].unfocused,
263 "#739de3", "#275197", "#cccccc", "#976d27");
264 INIT_COLOR(config.client[QUBE_BLUE].urgent,
265 "#bd2727", "#e79e27", "#333333", "#27bdbd");
266
267 config.client[QUBE_PURPLE].background = draw_util_hex_to_color("#6f276f");
268 INIT_COLOR(config.client[QUBE_PURPLE].focused,
269 "#bb73bb", "#9f389f", "#ffffff", "#389f38");
270 INIT_COLOR(config.client[QUBE_PURPLE].focused_inactive,
271 "#bb73bb", "#7f2c7f", "#e5e5e5", "#2c7f2c");
272 INIT_COLOR(config.client[QUBE_PURPLE].unfocused,
273 "#bb73bb", "#6f276f", "#cccccc", "#276f27");
274 INIT_COLOR(config.client[QUBE_PURPLE].urgent,
275 "#bd2727", "#e79e27", "#333333", "#27bdbd");
276
277 config.client[QUBE_BLACK].background = draw_util_hex_to_color("#141414");
278 INIT_COLOR(config.client[QUBE_BLACK].focused,
279 "#5b5b5b", "#333333", "#ffffff", "#cccccc");
280 INIT_COLOR(config.client[QUBE_BLACK].focused_inactive,
281 "#5b5b5b", "#1e1e1e", "#e5e5e5", "#e1e1e1");
282 INIT_COLOR(config.client[QUBE_BLACK].unfocused,
283 "#5b5b5b", "#141414", "#cccccc", "#ebebeb");
284 INIT_COLOR(config.client[QUBE_BLACK].urgent,
285 "#bd2727", "#e79e27", "#333333", "#27bdbd");
286
287 /* border and indicator color are ignored for placeholder contents */
288 INIT_COLOR(config.client[QUBE_DOM0].placeholder,"#000000", "#0c0c0c", "#ffffff", "#000000");
289
290 /* the last argument (indicator color) is ignored for bar colors */
291 INIT_COLOR(config.bar.focused, "#4c7899", "#285577", "#ffffff", "#000000");
292 INIT_COLOR(config.bar.unfocused, "#333333", "#222222", "#888888", "#000000");
293 INIT_COLOR(config.bar.urgent, "#2f343a", "#900000", "#ffffff", "#000000");
294
295 config.show_marks = true;
296
297 config.default_border = BS_NORMAL;
298 config.default_floating_border = BS_NORMAL;
299 config.default_border_width = logical_px(2);
300 config.default_floating_border_width = logical_px(2);
301 /* Set default_orientation to NO_ORIENTATION for auto orientation. */
302 config.default_orientation = NO_ORIENTATION;
303
304 config.gaps.inner = 0;
305 config.gaps.top = 0;
306 config.gaps.right = 0;
307 config.gaps.bottom = 0;
308 config.gaps.left = 0;
309
310 /* Set default urgency reset delay to 500ms */
311 if (config.workspace_urgency_timer == 0)
312 config.workspace_urgency_timer = 0.5;
313
314 config.focus_wrapping = FOCUS_WRAPPING_ON;
315
316 config.tiling_drag = TILING_DRAG_MODIFIER;
317
319 current_configpath = get_config_path(override_configpath, true);
320 if (current_configpath == NULL) {
321 die("Unable to find the configuration file (looked at "
322 "$XDG_CONFIG_HOME/i3/config, ~/.i3/config, $XDG_CONFIG_DIRS/i3/config "
323 "and " SYSCONFDIR "/i3/config)");
324 }
325
326 IncludedFile *file;
327 while (!TAILQ_EMPTY(&included_files)) {
329 FREE(file->path);
330 FREE(file->raw_contents);
332 TAILQ_REMOVE(&included_files, file, files);
333 FREE(file);
334 }
335
336 char resolved_path[PATH_MAX] = {'\0'};
337 if (realpath(current_configpath, resolved_path) == NULL) {
338 die("realpath(%s): %s", current_configpath, strerror(errno));
339 }
340
341 file = scalloc(1, sizeof(IncludedFile));
342 file->path = sstrdup(resolved_path);
343 TAILQ_INSERT_TAIL(&included_files, file, files);
344
345 LOG("Parsing configfile %s\n", resolved_path);
346 struct stack stack;
347 memset(&stack, '\0', sizeof(struct stack));
348 struct parser_ctx ctx = {
349 .use_nagbar = (load_type != C_VALIDATE),
350 .assume_v4 = false,
351 .stack = &stack,
352 };
353 SLIST_INIT(&(ctx.variables));
354 const int result = parse_file(&ctx, resolved_path, file);
356 if (result == -1) {
357 die("Could not open configuration file: %s\n", strerror(errno));
358 }
359
362
363 if (config.font.type == FONT_TYPE_NONE && load_type != C_VALIDATE) {
364 ELOG("You did not specify required configuration option \"font\"\n");
365 config.font = load_font("fixed", true);
366 set_font(&config.font);
367 }
368
369 /* redefine defaults, to overwrite user settings easily */
370 config.default_border = BS_NORMAL;
371 config.default_floating_border = BS_NORMAL;
372 config.default_border_width = logical_px(2);
373 config.default_floating_border_width = logical_px(2);
374
375 /* Make bar config blocks without a configured font use the i3-wide font. */
376 Barconfig *current;
377 if (load_type != C_VALIDATE) {
378 TAILQ_FOREACH (current, &barconfigs, configs) {
379 if (current->font != NULL) {
380 continue;
381 }
382 current->font = sstrdup(config.font.pattern);
383 }
384 }
385
386 if (load_type == C_RELOAD) {
391
392 /* Redraw the currently visible decorations on reload, so that the
393 * possibly new drawing parameters changed. */
394 tree_render();
395 }
396
397 return result == 0;
398}
struct all_cons_head all_cons
Definition tree.c:15
void tree_render(void)
Renders the tree, that is rendering all outputs using render_con() and pushing the changes to X11 usi...
Definition tree.c:451
void match_free(Match *match)
Frees the given match.
Definition match.c:276
xcb_connection_t * conn
XCB connection and root screen.
Definition main.c:54
xcb_window_t root
Definition main.c:67
const char * current_binding_mode
Definition main.c:88
struct assignments_head assignments
Definition main.c:97
struct ws_assignments_head ws_assignments
Definition main.c:101
struct bindings_head * bindings
Definition main.c:87
void gaps_reapply_workspace_assignments(void)
Re-applies all workspace gap assignments to existing workspaces after reloading the configuration fil...
Definition gaps.c:160
static void free_configuration(void)
Definition config.c:34
struct includedfiles_head included_files
Definition config.c:22
Config config
Definition config.c:19
bool load_configuration(const char *override_configpath, config_load_t load_type)
(Re-)loads the configuration file (sets useful defaults before).
Definition config.c:167
struct barconfig_head barconfigs
Definition config.c:21
struct modes_head modes
Definition config.c:20
#define INIT_COLOR(x, cborder, cbackground, ctext, cindicator)
char * current_configpath
Definition config.c:18
void ungrab_all_keys(xcb_connection_t *conn)
Ungrabs all keys, to be called before re-grabbing the keys because of a mapping_notify event or a con...
Definition config.c:29
parse_file_result_t parse_file(struct parser_ctx *ctx, const char *f, IncludedFile *included_file)
Parses the given file by first replacing the variables, then calling parse_config and launching i3-na...
void free_variables(struct parser_ctx *ctx)
Releases the memory of all variables in ctx.
void binding_free(Binding *bind)
Frees the binding.
Definition bindings.c:812
void grab_all_keys(xcb_connection_t *conn)
Grab the bound keys (tell X to send us keypress events for those keycodes)
Definition bindings.c:149
void regrab_all_buttons(xcb_connection_t *conn)
Release the button grabs on all managed windows and regrab them, reevaluating which buttons need to b...
Definition bindings.c:179
void switch_mode(const char *new_mode)
Switches the key bindings to the given mode, if the mode exists.
Definition bindings.c:620
void reorder_bindings(void)
Reorders bindings by event_state_mask descendingly so that get_binding() correctly matches more speci...
Definition bindings.c:711
void translate_keysyms(void)
Translates keysymbols to keycodes for all bindings which use keysyms.
Definition bindings.c:434
void extract_workspace_names_from_bindings(void)
Extracts workspace names from keybindings (e.g.
Definition workspace.c:181
static xcb_cursor_context_t * ctx
Definition xcursor.c:19
#define TAILQ_FOREACH(var, head, field)
Definition queue.h:347
#define SLIST_INIT(head)
Definition queue.h:127
#define TAILQ_INIT(head)
Definition queue.h:360
#define SLIST_INSERT_HEAD(head, elm, field)
Definition queue.h:138
#define TAILQ_INSERT_TAIL(head, elm, field)
Definition queue.h:376
#define SLIST_EMPTY(head)
Definition queue.h:111
#define TAILQ_FIRST(head)
Definition queue.h:336
#define SLIST_FIRST(head)
Definition queue.h:109
#define SLIST_REMOVE(head, elm, type, field)
Definition queue.h:154
#define TAILQ_REMOVE(head, elm, field)
Definition queue.h:402
#define TAILQ_HEAD_INITIALIZER(head)
Definition queue.h:324
#define TAILQ_EMPTY(head)
Definition queue.h:344
@ FOCUS_WRAPPING_ON
Definition data.h:174
@ NO_ORIENTATION
Definition data.h:60
@ BS_NORMAL
Definition data.h:68
@ QUBE_ORANGE
Definition data.h:185
@ QUBE_DOM0
Definition data.h:183
@ QUBE_BLUE
Definition data.h:189
@ QUBE_YELLOW
Definition data.h:186
@ QUBE_GRAY
Definition data.h:188
@ QUBE_GREEN
Definition data.h:187
@ QUBE_RED
Definition data.h:184
@ QUBE_PURPLE
Definition data.h:190
@ QUBE_BLACK
Definition data.h:191
int logical_px(const int logical)
Convert a logical amount of pixels (e.g.
#define DLOG(fmt,...)
Definition libi3.h:105
#define LOG(fmt,...)
Definition libi3.h:95
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
#define ELOG(fmt,...)
Definition libi3.h:100
void * scalloc(size_t num, size_t size)
Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there is no more memory a...
color_t draw_util_hex_to_color(const char *color)
Parses the given color in hex format to an internal color representation.
char * get_config_path(const char *override_configpath, bool use_system_paths)
Get the path of the first configuration file found.
void set_font(i3Font *font)
Defines the font to be used for the forthcoming calls.
i3Font load_font(const char *pattern, const bool fallback)
Loads a font for usage, also getting its height.
void free_font(void)
Frees the resources taken by the current font.
@ TILING_DRAG_MODIFIER
Definition tiling_drag.h:19
#define die(...)
Definition util.h:19
#define FREE(pointer)
Definition util.h:47
config_load_t
@ C_VALIDATE
@ C_RELOAD
List entry struct for an included file.
char * variable_replaced_contents
char * raw_contents
The configuration file can contain multiple sets of bindings.
char * name
struct bindings_head * bindings
Holds part of the configuration (the part which is not already in dedicated structures in include/dat...
Holds the status bar configuration (i3bar).
struct Barconfig::bar_colors colors
char * i3bar_command
Command that should be run to execute i3bar, give a full path if i3bar is not in your $PATH.
int num_outputs
Number of outputs in the outputs array.
char * font
Font specification for all text rendered on the bar.
char * id
Automatically generated ID for this bar config.
char * workspace_command
Command that should be run to get the workspace buttons.
char * status_command
Command that should be run to get a statusline, for example 'i3status'.
char ** outputs
Outputs on which this bar should show up on.
char * socket_path
Path to the i3 IPC socket.
Defines a mouse command to be executed instead of the default behavior when clicking on the non-statu...
char * command
The command which is to be executed for this button.
Stores which workspace (by name or number) goes to which output and its gaps config.
Definition data.h:257
Holds a keybinding, consisting of a keycode combined with modifiers and the command which is executed...
Definition data.h:328
Assignment ** ran_assignments
Definition data.h:457
uint32_t nr_assignments
Pointers to the Assignments which were already ran for this Window (assignments run only once)
Definition data.h:456
An Assignment makes specific windows go to a specific workspace/output or run a command for that wind...
Definition data.h:622
union Assignment::@222204053252343114274042165165310271133332337156 dest
destination workspace/command/output, depending on the type
Match match
the criteria to check if a window matches
Definition data.h:644
enum Assignment::@362164307203113023013316042237071156073024074140 type
type of this assignment:
char * output
Definition data.h:650
char * command
Definition data.h:648
char * workspace
Definition data.h:649
@ A_COMMAND
Definition data.h:636
@ A_TO_WORKSPACE
Definition data.h:637
@ A_TO_WORKSPACE_NUMBER
Definition data.h:639
@ A_TO_OUTPUT
Definition data.h:640
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition data.h:671
struct Window * window
Definition data.h:746
struct deco_render_params * deco_render_params
Cache for the decoration rendering.
Definition data.h:752