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 
18 char *current_configpath = NULL;
20 struct modes_head modes;
21 struct barconfig_head barconfigs = TAILQ_HEAD_INITIALIZER(barconfigs);
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  */
29 void 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 
34 static 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->i3bar_command);
109  FREE(barconfig->font);
110  FREE(barconfig->colors.background);
111  FREE(barconfig->colors.statusline);
112  FREE(barconfig->colors.separator);
113  FREE(barconfig->colors.focused_background);
114  FREE(barconfig->colors.focused_statusline);
115  FREE(barconfig->colors.focused_separator);
117  FREE(barconfig->colors.focused_workspace_bg);
118  FREE(barconfig->colors.focused_workspace_text);
119  FREE(barconfig->colors.active_workspace_border);
120  FREE(barconfig->colors.active_workspace_bg);
121  FREE(barconfig->colors.active_workspace_text);
123  FREE(barconfig->colors.inactive_workspace_bg);
124  FREE(barconfig->colors.inactive_workspace_text);
125  FREE(barconfig->colors.urgent_workspace_border);
126  FREE(barconfig->colors.urgent_workspace_bg);
127  FREE(barconfig->colors.urgent_workspace_text);
128  FREE(barconfig->colors.binding_mode_border);
129  FREE(barconfig->colors.binding_mode_bg);
130  FREE(barconfig->colors.binding_mode_text);
131  TAILQ_REMOVE(&barconfigs, barconfig, configs);
132  FREE(barconfig);
133  }
134 
135  Con *con;
136  TAILQ_FOREACH (con, &all_cons, all_cons) {
137  /* Assignments changed, previously ran assignments are invalid. */
138  if (con->window) {
139  con->window->nr_assignments = 0;
140  FREE(con->window->ran_assignments);
141  }
142  /* Invalidate pixmap caches in case font or colors changed. */
143  FREE(con->deco_render_params);
144  }
145 
146  /* Get rid of the current font */
147  free_font();
148 
149  free(config.ipc_socket_path);
151  free(config.fake_outputs);
152 }
153 
154 /*
155  * (Re-)loads the configuration file (sets useful defaults before).
156  *
157  * If you specify override_configpath, only this path is used to look for a
158  * configuration file.
159  *
160  * load_type specifies the type of loading: C_VALIDATE is used to only verify
161  * the correctness of the config file (used with the flag -C). C_LOAD will load
162  * the config for normal use and display errors in the nagbar. C_RELOAD will
163  * also clear the previous config.
164  *
165  */
166 bool load_configuration(const char *override_configpath, config_load_t load_type) {
167  if (load_type == C_RELOAD) {
169  }
170 
171  SLIST_INIT(&modes);
172 
173  struct Mode *default_mode = scalloc(1, sizeof(struct Mode));
174  default_mode->name = sstrdup("default");
175  default_mode->bindings = scalloc(1, sizeof(struct bindings_head));
176  TAILQ_INIT(default_mode->bindings);
177  SLIST_INSERT_HEAD(&modes, default_mode, modes);
178 
179  bindings = default_mode->bindings;
180  current_binding_mode = default_mode->name;
181 
182  /* Clear the old config or initialize the data structure */
183  memset(&config, 0, sizeof(config));
184 
185  /* Initialize default colors */
186 #define INIT_COLOR(x, cborder, cbackground, ctext, cindicator) \
187  do { \
188  x.border = draw_util_hex_to_color(cborder); \
189  x.background = draw_util_hex_to_color(cbackground); \
190  x.text = draw_util_hex_to_color(ctext); \
191  x.indicator = draw_util_hex_to_color(cindicator); \
192  x.child_border = draw_util_hex_to_color(cbackground); \
193  } while (0)
194 
195 // config.client.got_focused_tab_title = false;
198  "#f7f7f7", "#f5f5f5", "#000000", "#0a0a0a");
200  "#f7f7f7", "#dcdcdc", "#191919", "#232323");
202  "#f7f7f7", "#c4c4c4", "#323232", "#3b3b3b");
204  "#bd2727", "#e79e27", "#333333", "#27bdbd");
205 
208  "#d06767", "#bd2727", "#ffffff", "#27bdbd");
210  "#d06767", "#971f1f", "#e5e5e5", "#1f9797");
212  "#d06767", "#841b1b", "#cccccc", "#1b8484");
214  "#bd2727", "#e79e27", "#333333", "#27bdbd");
215 
218  "#eebb67", "#e79e27", "#000000", "#2770e7");
220  "#eebb67", "#b87e1f", "#191919", "#1f59b8");
222  "#eebb67", "#a16e1b", "#323232", "#1b4ea1");
224  "#bd2727", "#e79e27", "#333333", "#27bdbd");
225 
228  "#eeec6f", "#e7e532", "#000000", "#3234e7");
230  "#eeec6f", "#b8b728", "#191919", "#2829b8");
232  "#eeec6f", "#a1a023", "#323232", "#2324a1");
234  "#bd2727", "#e79e27", "#333333", "#27bdbd");
235 
238  "#8be379", "#5ad840", "#000000", "#be40d8");
240  "#8be379", "#48ac33", "#191919", "#9833ac");
242  "#8be379", "#3e972c", "#323232", "#852c97");
244  "#bd2727", "#e79e27", "#333333", "#27bdbd");
245 
248  "#afafb4", "#8e8e95", "#ffffff", "#95958e");
250  "#afafb4", "#717177", "#e5e5e5", "#777771");
252  "#afafb4", "#636368", "#cccccc", "#686863");
254  "#bd2727", "#e79e27", "#333333", "#27bdbd");
255 
258  "#739de3", "#3874d8", "#ffffff", "#d89c38");
260  "#739de3", "#2c5cac", "#e5e5e5", "#ac7c2c");
262  "#739de3", "#275197", "#cccccc", "#976d27");
264  "#bd2727", "#e79e27", "#333333", "#27bdbd");
265 
268  "#bb73bb", "#9f389f", "#ffffff", "#389f38");
270  "#bb73bb", "#7f2c7f", "#e5e5e5", "#2c7f2c");
272  "#bb73bb", "#6f276f", "#cccccc", "#276f27");
274  "#bd2727", "#e79e27", "#333333", "#27bdbd");
275 
278  "#5b5b5b", "#333333", "#ffffff", "#cccccc");
280  "#5b5b5b", "#1e1e1e", "#e5e5e5", "#e1e1e1");
282  "#5b5b5b", "#141414", "#cccccc", "#ebebeb");
284  "#bd2727", "#e79e27", "#333333", "#27bdbd");
285 
286  /* border and indicator color are ignored for placeholder contents */
287  INIT_COLOR(config.client[QUBE_DOM0].placeholder,"#000000", "#0c0c0c", "#ffffff", "#000000");
288 
289  /* the last argument (indicator color) is ignored for bar colors */
290  INIT_COLOR(config.bar.focused, "#4c7899", "#285577", "#ffffff", "#000000");
291  INIT_COLOR(config.bar.unfocused, "#333333", "#222222", "#888888", "#000000");
292  INIT_COLOR(config.bar.urgent, "#2f343a", "#900000", "#ffffff", "#000000");
293 
294  config.show_marks = true;
295 
300  /* Set default_orientation to NO_ORIENTATION for auto orientation. */
302 
303  config.gaps.inner = 0;
304  config.gaps.top = 0;
305  config.gaps.right = 0;
306  config.gaps.bottom = 0;
307  config.gaps.left = 0;
308 
309  /* Set default urgency reset delay to 500ms */
312 
314 
316 
318  current_configpath = get_config_path(override_configpath, true);
319  if (current_configpath == NULL) {
320  die("Unable to find the configuration file (looked at "
321  "$XDG_CONFIG_HOME/i3/config, ~/.i3/config, $XDG_CONFIG_DIRS/i3/config "
322  "and " SYSCONFDIR "/i3/config)");
323  }
324 
325  IncludedFile *file;
326  while (!TAILQ_EMPTY(&included_files)) {
327  file = TAILQ_FIRST(&included_files);
328  FREE(file->path);
329  FREE(file->raw_contents);
331  TAILQ_REMOVE(&included_files, file, files);
332  FREE(file);
333  }
334 
335  char resolved_path[PATH_MAX] = {'\0'};
336  if (realpath(current_configpath, resolved_path) == NULL) {
337  die("realpath(%s): %s", current_configpath, strerror(errno));
338  }
339 
340  file = scalloc(1, sizeof(IncludedFile));
341  file->path = sstrdup(resolved_path);
342  TAILQ_INSERT_TAIL(&included_files, file, files);
343 
344  LOG("Parsing configfile %s\n", resolved_path);
345  struct stack stack;
346  memset(&stack, '\0', sizeof(struct stack));
347  struct parser_ctx ctx = {
348  .use_nagbar = (load_type != C_VALIDATE),
349  .assume_v4 = false,
350  .stack = &stack,
351  };
352  SLIST_INIT(&(ctx.variables));
353  const int result = parse_file(&ctx, resolved_path, file);
355  if (result == -1) {
356  die("Could not open configuration file: %s\n", strerror(errno));
357  }
358 
361 
362  if (config.font.type == FONT_TYPE_NONE && load_type != C_VALIDATE) {
363  ELOG("You did not specify required configuration option \"font\"\n");
364  config.font = load_font("fixed", true);
365  set_font(&config.font);
366  }
367 
368  /* redefine defaults, to overwrite user settings easily */
373 
374  /* Make bar config blocks without a configured font use the i3-wide font. */
375  Barconfig *current;
376  if (load_type != C_VALIDATE) {
377  TAILQ_FOREACH (current, &barconfigs, configs) {
378  if (current->font != NULL) {
379  continue;
380  }
381  current->font = sstrdup(config.font.pattern);
382  }
383  }
384 
385  if (load_type == C_RELOAD) {
390 
391  /* Redraw the currently visible decorations on reload, so that the
392  * possibly new drawing parameters changed. */
393  tree_render();
394  }
395 
396  return result == 0;
397 }
struct deco_render_params * deco_render_params
Cache for the decoration rendering.
Definition: data.h:752
struct bindings_head * bindings
Definition: main.c:87
char * workspace
Definition: data.h:649
int left
Definition: data.h:155
#define ELOG(fmt,...)
Definition: libi3.h:100
struct assignments_head assignments
Definition: main.c:97
Definition: data.h:68
struct Colortriple focused
Holds the status bar configuration (i3bar).
void set_font(i3Font *font)
Defines the font to be used for the forthcoming calls.
border_style_t default_floating_border
The default border style for new floating windows.
struct Barconfig::bar_colors colors
Holds part of the configuration (the part which is not already in dedicated structures in include/dat...
#define die(...)
Definition: util.h:19
#define TAILQ_FIRST(head)
Definition: queue.h:336
struct Window * window
Definition: data.h:746
union Assignment::@17 dest
destination workspace/command/output, depending on the type
struct barconfig_head barconfigs
Definition: config.c:21
struct includedfiles_head included_files
Definition: config.c:22
void free_font(void)
Frees the resources taken by the current font.
int top
Definition: data.h:152
char * command
Definition: data.h:648
Defines a mouse command to be executed instead of the default behavior when clicking on the non-statu...
struct all_cons_head all_cons
Definition: tree.c:15
char * restart_state_path
float workspace_urgency_timer
By default, urgency is cleared immediately when switching to another workspace leads to focusing the ...
char * status_command
Command that should be run to get a statusline, for example &#39;i3status&#39;.
struct Config::config_bar bar
The configuration file can contain multiple sets of bindings.
Definition: configuration.h:93
int default_floating_border_width
void switch_mode(const char *new_mode)
Switches the key bindings to the given mode, if the mode exists.
Definition: bindings.c:620
int right
Definition: data.h:153
struct ws_assignments_head ws_assignments
Definition: main.c:101
#define INIT_COLOR(x, cborder, cbackground, ctext, cindicator)
struct Colortriple unfocused
enum Assignment::@16 type
type of this assignment:
bool load_configuration(const char *override_configpath, config_load_t load_type)
(Re-)loads the configuration file (sets useful defaults before).
Definition: config.c:166
int logical_px(const int logical)
Convert a logical amount of pixels (e.g.
color_t draw_util_hex_to_color(const char *color)
Parses the given color in hex format to an internal color representation.
char * name
Definition: configuration.h:94
struct modes_head modes
Definition: config.c:20
int num_outputs
Number of outputs in the outputs array.
#define SLIST_REMOVE(head, elm, type, field)
Definition: queue.h:154
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...
char * output
Definition: data.h:650
enum Font::@21 type
The type of font.
struct Colortriple placeholder
#define SLIST_FIRST(head)
Definition: queue.h:109
char * raw_contents
Definition: configuration.h:81
Stores which workspace (by name or number) goes to which output and its gaps config.
Definition: data.h:257
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
int inner
Definition: data.h:151
int default_orientation
Default orientation for new containers.
#define TAILQ_INIT(head)
Definition: queue.h:360
static void free_configuration(void)
Definition: config.c:34
struct Config::config_client client[QUBE_NUM_LABELS]
#define TAILQ_EMPTY(head)
Definition: queue.h:344
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:347
char * variable_replaced_contents
Definition: configuration.h:82
void reorder_bindings(void)
Reorders bindings by event_state_mask descendingly so that get_binding() correctly matches more speci...
Definition: bindings.c:710
char ** outputs
Outputs on which this bar should show up on.
xcb_window_t root
Definition: main.c:67
bool assume_v4
Definition: config_parser.h:38
Holds a keybinding, consisting of a keycode combined with modifiers and the command which is executed...
Definition: data.h:328
struct Colortriple focused_inactive
struct Colortriple unfocused
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...
char * font
Font specification for all text rendered on the bar.
i3Font font
#define FREE(pointer)
Definition: util.h:47
char * current_configpath
Definition: config.c:18
Definition: data.h:184
#define SLIST_INSERT_HEAD(head, elm, field)
Definition: queue.h:138
focus_wrapping_t focus_wrapping
When focus wrapping is enabled (the default), attempting to move focus past the edge of the screen (i...
struct Colortriple urgent
Assignment ** ran_assignments
Definition: data.h:457
void binding_free(Binding *bind)
Frees the binding.
Definition: bindings.c:811
i3Font load_font(const char *pattern, const bool fallback)
Loads a font for usage, also getting its height.
uint32_t nr_assignments
Pointers to the Assignments which were already ran for this Window (assignments run only once) ...
Definition: data.h:456
int default_border_width
void match_free(Match *match)
Frees the given match.
Definition: match.c:275
xcb_connection_t * conn
XCB connection and root screen.
Definition: main.c:54
struct bindings_head * bindings
Definition: configuration.h:96
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
char * id
Automatically generated ID for this bar config.
gaps_t gaps
char * command
The command which is to be executed for this button.
tiling_drag_t tiling_drag
border_style_t default_border
The default border style for new windows.
#define SLIST_INIT(head)
Definition: queue.h:127
const char * current_binding_mode
Definition: main.c:88
#define SLIST_EMPTY(head)
Definition: queue.h:111
bool show_marks
Specifies whether or not marks should be displayed in the window decoration.
void translate_keysyms(void)
Translates keysymbols to keycodes for all bindings which use keysyms.
Definition: bindings.c:434
struct Colortriple urgent
char * get_config_path(const char *override_configpath, bool use_system_paths)
Get the path of the first configuration file found.
#define TAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:376
char * fake_outputs
Overwrites output detection (for testing), see src/fake_outputs.c.
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
char * ipc_socket_path
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
A &#39;Con&#39; represents everything from the X11 root window down to a single X11 window.
Definition: data.h:671
#define DLOG(fmt,...)
Definition: libi3.h:105
void free_variables(struct parser_ctx *ctx)
Releases the memory of all variables in ctx.
int bottom
Definition: data.h:154
Match match
the criteria to check if a window matches
Definition: data.h:644
#define TAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:324
Config config
Definition: config.c:19
void gaps_reapply_workspace_assignments(void)
Re-applies all workspace gap assignments to existing workspaces after reloading the configuration fil...
Definition: gaps.c:160
char * socket_path
Path to the i3 IPC socket.
#define LOG(fmt,...)
Definition: libi3.h:95
char * i3bar_command
Command that should be run to execute i3bar, give a full path if i3bar is not in your $PATH...
#define TAILQ_REMOVE(head, elm, field)
Definition: queue.h:402
config_load_t
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
static xcb_cursor_context_t * ctx
Definition: xcursor.c:19
void extract_workspace_names_from_bindings(void)
Extracts workspace names from keybindings (e.g.
Definition: workspace.c:181
struct Colortriple focused
List entry struct for an included file.
Definition: configuration.h:79
An Assignment makes specific windows go to a specific workspace/output or run a command for that wind...
Definition: data.h:622
char * pattern
The pattern/name used to load the font.
Definition: libi3.h:71