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 <xkbcommon/xkbcommon.h>
14 
15 char *current_configpath = NULL;
16 char *current_config = NULL;
18 struct modes_head modes;
19 struct barconfig_head barconfigs = TAILQ_HEAD_INITIALIZER(barconfigs);
20 
21 /*
22  * Ungrabs all keys, to be called before re-grabbing the keys because of a
23  * mapping_notify event or a configuration file reload
24  *
25  */
26 void ungrab_all_keys(xcb_connection_t *conn) {
27  DLOG("Ungrabbing all keys\n");
28  xcb_ungrab_key(conn, XCB_GRAB_ANY, root, XCB_BUTTON_MASK_ANY);
29 }
30 
31 /*
32  * Sends the current bar configuration as an event to all barconfig_update listeners.
33  *
34  */
35 void update_barconfig(void) {
36  Barconfig *current;
37  TAILQ_FOREACH(current, &barconfigs, configs) {
39  }
40 }
41 
42 static void free_configuration(void) {
43  assert(conn != NULL);
44 
45  /* If we are currently in a binding mode, we first revert to the default
46  * since we have no guarantee that the current mode will even still exist
47  * after parsing the config again. See #2228. */
48  switch_mode("default");
49 
50  /* First ungrab the keys */
52 
53  struct Mode *mode;
54  while (!SLIST_EMPTY(&modes)) {
55  mode = SLIST_FIRST(&modes);
56  FREE(mode->name);
57 
58  /* Clear the old binding list */
59  while (!TAILQ_EMPTY(mode->bindings)) {
60  Binding *bind = TAILQ_FIRST(mode->bindings);
61  TAILQ_REMOVE(mode->bindings, bind, bindings);
62  binding_free(bind);
63  }
64  FREE(mode->bindings);
65 
66  SLIST_REMOVE(&modes, mode, Mode, modes);
67  FREE(mode);
68  }
69 
70  while (!TAILQ_EMPTY(&assignments)) {
71  struct Assignment *assign = TAILQ_FIRST(&assignments);
72  if (assign->type == A_TO_WORKSPACE || assign->type == A_TO_WORKSPACE_NUMBER)
73  FREE(assign->dest.workspace);
74  else if (assign->type == A_COMMAND)
75  FREE(assign->dest.command);
76  else if (assign->type == A_TO_OUTPUT)
77  FREE(assign->dest.output);
78  match_free(&(assign->match));
80  FREE(assign);
81  }
82 
83  while (!TAILQ_EMPTY(&ws_assignments)) {
85  FREE(assign->name);
86  FREE(assign->output);
88  FREE(assign);
89  }
90 
91  /* Clear bar configs */
92  Barconfig *barconfig;
93  while (!TAILQ_EMPTY(&barconfigs)) {
94  barconfig = TAILQ_FIRST(&barconfigs);
95  FREE(barconfig->id);
96  for (int c = 0; c < barconfig->num_outputs; c++)
97  free(barconfig->outputs[c]);
98 
99  while (!TAILQ_EMPTY(&(barconfig->bar_bindings))) {
100  struct Barbinding *binding = TAILQ_FIRST(&(barconfig->bar_bindings));
101  FREE(binding->command);
102  TAILQ_REMOVE(&(barconfig->bar_bindings), binding, bindings);
103  FREE(binding);
104  }
105 
106  while (!TAILQ_EMPTY(&(barconfig->tray_outputs))) {
107  struct tray_output_t *tray_output = TAILQ_FIRST(&(barconfig->tray_outputs));
108  FREE(tray_output->output);
109  TAILQ_REMOVE(&(barconfig->tray_outputs), tray_output, tray_outputs);
110  FREE(tray_output);
111  }
112 
113  FREE(barconfig->outputs);
114  FREE(barconfig->socket_path);
115  FREE(barconfig->status_command);
116  FREE(barconfig->i3bar_command);
117  FREE(barconfig->font);
118  FREE(barconfig->colors.background);
119  FREE(barconfig->colors.statusline);
120  FREE(barconfig->colors.separator);
121  FREE(barconfig->colors.focused_background);
122  FREE(barconfig->colors.focused_statusline);
123  FREE(barconfig->colors.focused_separator);
125  FREE(barconfig->colors.focused_workspace_bg);
126  FREE(barconfig->colors.focused_workspace_text);
127  FREE(barconfig->colors.active_workspace_border);
128  FREE(barconfig->colors.active_workspace_bg);
129  FREE(barconfig->colors.active_workspace_text);
131  FREE(barconfig->colors.inactive_workspace_bg);
132  FREE(barconfig->colors.inactive_workspace_text);
133  FREE(barconfig->colors.urgent_workspace_border);
134  FREE(barconfig->colors.urgent_workspace_bg);
135  FREE(barconfig->colors.urgent_workspace_text);
136  FREE(barconfig->colors.binding_mode_border);
137  FREE(barconfig->colors.binding_mode_bg);
138  FREE(barconfig->colors.binding_mode_text);
139  TAILQ_REMOVE(&barconfigs, barconfig, configs);
140  FREE(barconfig);
141  }
142 
143  Con *con;
145  /* Assignments changed, previously ran assignments are invalid. */
146  if (con->window) {
147  con->window->nr_assignments = 0;
148  FREE(con->window->ran_assignments);
149  }
150  /* Invalidate pixmap caches in case font or colors changed. */
151  FREE(con->deco_render_params);
152  }
153 
154  /* Get rid of the current font */
155  free_font();
156 
157  free(config.ipc_socket_path);
159  free(config.fake_outputs);
160 }
161 
162 /*
163  * (Re-)loads the configuration file (sets useful defaults before).
164  *
165  * If you specify override_configpath, only this path is used to look for a
166  * configuration file.
167  *
168  * load_type specifies the type of loading: C_VALIDATE is used to only verify
169  * the correctness of the config file (used with the flag -C). C_LOAD will load
170  * the config for normal use and display errors in the nagbar. C_RELOAD will
171  * also clear the previous config.
172  *
173  */
174 bool load_configuration(const char *override_configpath, config_load_t load_type) {
175  if (load_type == C_RELOAD) {
177  }
178 
179  SLIST_INIT(&modes);
180 
181  struct Mode *default_mode = scalloc(1, sizeof(struct Mode));
182  default_mode->name = sstrdup("default");
183  default_mode->bindings = scalloc(1, sizeof(struct bindings_head));
184  TAILQ_INIT(default_mode->bindings);
185  SLIST_INSERT_HEAD(&modes, default_mode, modes);
186 
187  bindings = default_mode->bindings;
188 
189  /* Clear the old config or initialize the data structure */
190  memset(&config, 0, sizeof(config));
191 
192  /* Initialize default colors */
193 #define INIT_COLOR(x, cborder, cbackground, ctext, cindicator) \
194  do { \
195  x.border = draw_util_hex_to_color(cborder); \
196  x.background = draw_util_hex_to_color(cbackground); \
197  x.text = draw_util_hex_to_color(ctext); \
198  x.indicator = draw_util_hex_to_color(cindicator); \
199  x.child_border = draw_util_hex_to_color(cbackground); \
200  } while (0)
201 
204  "#f7f7f7", "#f5f5f5", "#000000", "#0a0a0a");
206  "#f7f7f7", "#dcdcdc", "#191919", "#232323");
208  "#f7f7f7", "#c4c4c4", "#323232", "#3b3b3b");
210  "#bd2727", "#e79e27", "#333333", "#27bdbd");
211 
214  "#d06767", "#bd2727", "#ffffff", "#27bdbd");
216  "#d06767", "#971f1f", "#e5e5e5", "#1f9797");
218  "#d06767", "#841b1b", "#cccccc", "#1b8484");
220  "#bd2727", "#e79e27", "#333333", "#27bdbd");
221 
224  "#eebb67", "#e79e27", "#000000", "#2770e7");
226  "#eebb67", "#b87e1f", "#191919", "#1f59b8");
228  "#eebb67", "#a16e1b", "#323232", "#1b4ea1");
230  "#bd2727", "#e79e27", "#333333", "#27bdbd");
231 
234  "#eeec6f", "#e7e532", "#000000", "#3234e7");
236  "#eeec6f", "#b8b728", "#191919", "#2829b8");
238  "#eeec6f", "#a1a023", "#323232", "#2324a1");
240  "#bd2727", "#e79e27", "#333333", "#27bdbd");
241 
244  "#8be379", "#5ad840", "#000000", "#be40d8");
246  "#8be379", "#48ac33", "#191919", "#9833ac");
248  "#8be379", "#3e972c", "#323232", "#852c97");
250  "#bd2727", "#e79e27", "#333333", "#27bdbd");
251 
254  "#afafb4", "#8e8e95", "#ffffff", "#95958e");
256  "#afafb4", "#717177", "#e5e5e5", "#777771");
258  "#afafb4", "#636368", "#cccccc", "#686863");
260  "#bd2727", "#e79e27", "#333333", "#27bdbd");
261 
264  "#739de3", "#3874d8", "#ffffff", "#d89c38");
266  "#739de3", "#2c5cac", "#e5e5e5", "#ac7c2c");
268  "#739de3", "#275197", "#cccccc", "#976d27");
270  "#bd2727", "#e79e27", "#333333", "#27bdbd");
271 
274  "#bb73bb", "#9f389f", "#ffffff", "#389f38");
276  "#bb73bb", "#7f2c7f", "#e5e5e5", "#2c7f2c");
278  "#bb73bb", "#6f276f", "#cccccc", "#276f27");
280  "#bd2727", "#e79e27", "#333333", "#27bdbd");
281 
284  "#5b5b5b", "#333333", "#ffffff", "#cccccc");
286  "#5b5b5b", "#1e1e1e", "#e5e5e5", "#e1e1e1");
288  "#5b5b5b", "#141414", "#cccccc", "#ebebeb");
290  "#bd2727", "#e79e27", "#333333", "#27bdbd");
291 
292  /* border and indicator color are ignored for placeholder contents */
294  "#000000", "#0c0c0c", "#ffffff", "#000000");
295 
296 
297  /* the last argument (indicator color) is ignored for bar colors */
298  INIT_COLOR(config.bar.focused, "#4c7899", "#285577", "#ffffff", "#000000");
299  INIT_COLOR(config.bar.unfocused, "#333333", "#222222", "#888888", "#000000");
300  INIT_COLOR(config.bar.urgent, "#2f343a", "#900000", "#ffffff", "#000000");
301 
302  config.show_marks = true;
303 
308  /* Set default_orientation to NO_ORIENTATION for auto orientation. */
310 
311  /* Set default urgency reset delay to 500ms */
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  LOG("Parsing configfile %s\n", current_configpath);
325  const bool result = parse_file(current_configpath, load_type != C_VALIDATE);
326 
327  if (config.font.type == FONT_TYPE_NONE && load_type != C_VALIDATE) {
328  ELOG("You did not specify required configuration option \"font\"\n");
329  config.font = load_font("fixed", true);
330  set_font(&config.font);
331  }
332 
333  /* redefine defaults, to overwrite user settings easily */
338 
339  if (load_type == C_RELOAD) {
343 
344  /* Redraw the currently visible decorations on reload, so that the
345  * possibly new drawing parameters changed. */
347  xcb_flush(conn);
348  }
349 
350  return result;
351 }
void binding_free(Binding *bind)
Frees the binding.
Definition: bindings.c:792
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:147
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:177
void switch_mode(const char *new_mode)
Switches the key bindings to the given mode, if the mode exists.
Definition: bindings.c:618
void translate_keysyms(void)
Translates keysymbols to keycodes for all bindings which use keysyms.
Definition: bindings.c:432
static void free_configuration(void)
Definition: config.c:42
void update_barconfig(void)
Sends the current bar configuration as an event to all barconfig_update listeners.
Definition: config.c:35
Config config
Definition: config.c:17
bool load_configuration(const char *override_configpath, config_load_t load_type)
(Re-)loads the configuration file (sets useful defaults before).
Definition: config.c:174
struct barconfig_head barconfigs
Definition: config.c:19
struct modes_head modes
Definition: config.c:18
#define INIT_COLOR(x, cborder, cbackground, ctext, cindicator)
char * current_configpath
Definition: config.c:15
char * current_config
Definition: config.c:16
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:26
bool parse_file(const char *f, bool use_nagbar)
Parses the given file by first replacing the variables, then calling parse_config and launching i3-na...
void ipc_send_barconfig_update_event(Barconfig *barconfig)
For the barconfig update events, we send the serialized barconfig.
Definition: ipc.c:1643
xcb_connection_t * conn
XCB connection and root screen.
Definition: main.c:44
xcb_window_t root
Definition: main.c:57
struct assignments_head assignments
Definition: main.c:83
struct ws_assignments_head ws_assignments
Definition: main.c:87
struct bindings_head * bindings
Definition: main.c:74
void match_free(Match *match)
Frees the given match.
Definition: match.c:241
struct Con * croot
Definition: tree.c:12
struct all_cons_head all_cons
Definition: tree.c:15
void x_deco_recurse(Con *con)
Recursively calls x_draw_decoration.
Definition: x.c:740
config_load_t
@ C_VALIDATE
@ C_RELOAD
@ FOCUS_WRAPPING_ON
Definition: data.h:143
@ NO_ORIENTATION
Definition: data.h:59
@ BS_NORMAL
Definition: data.h:64
@ QUBE_ORANGE
Definition: data.h:154
@ QUBE_DOM0
Definition: data.h:152
@ QUBE_BLUE
Definition: data.h:158
@ QUBE_YELLOW
Definition: data.h:155
@ QUBE_GRAY
Definition: data.h:157
@ QUBE_GREEN
Definition: data.h:156
@ QUBE_RED
Definition: data.h:153
@ QUBE_PURPLE
Definition: data.h:159
@ QUBE_BLACK
Definition: data.h:160
char * get_config_path(const char *override_configpath, bool use_system_paths)
Get the path of the first configuration file found.
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
int logical_px(const int logical)
Convert a logical amount of pixels (e.g.
#define DLOG(fmt,...)
Definition: libi3.h:104
#define LOG(fmt,...)
Definition: libi3.h:94
#define ELOG(fmt,...)
Definition: libi3.h:99
color_t draw_util_hex_to_color(const char *color)
Parses the given color in hex format to an internal color representation.
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 * 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...
void free_font(void)
Frees the resources taken by the current font.
#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 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
#define die(...)
Definition: util.h:19
#define FREE(pointer)
Definition: util.h:47
The configuration file can contain multiple sets of bindings.
Definition: configuration.h:82
char * name
Definition: configuration.h:83
struct bindings_head * bindings
Definition: configuration.h:85
Holds part of the configuration (the part which is not already in dedicated structures in include/dat...
Definition: configuration.h:96
focus_wrapping_t focus_wrapping
When focus wrapping is enabled (the default), attempting to move focus past the edge of the screen (i...
char * restart_state_path
int default_border_width
i3Font font
Definition: configuration.h:98
char * fake_outputs
Overwrites output detection (for testing), see src/fake_outputs.c.
int default_floating_border_width
int default_orientation
Default orientation for new containers.
char * ipc_socket_path
bool show_marks
Specifies whether or not marks should be displayed in the window decoration.
float workspace_urgency_timer
By default, urgency is cleared immediately when switching to another workspace leads to focusing the ...
struct Config::config_bar bar
border_style_t default_border
The default border style for new windows.
struct Config::config_client client[QUBE_NUM_LABELS]
border_style_t default_floating_border
The default border style for new floating windows.
struct Colortriple focused
struct Colortriple placeholder
struct Colortriple unfocused
struct Colortriple urgent
struct Colortriple focused_inactive
struct Colortriple focused
struct Colortriple unfocused
struct Colortriple urgent
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 * 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.
Definition: data.h:225
Holds a keybinding, consisting of a keycode combined with modifiers and the command which is executed...
Definition: data.h:300
Assignment ** ran_assignments
Definition: data.h:439
uint32_t nr_assignments
Pointers to the Assignments which were already ran for this Window (assignments run only once)
Definition: data.h:438
An Assignment makes specific windows go to a specific workspace/output or run a command for that wind...
Definition: data.h:590
Match match
the criteria to check if a window matches
Definition: data.h:612
@ A_COMMAND
Definition: data.h:604
@ A_TO_WORKSPACE
Definition: data.h:605
@ A_TO_WORKSPACE_NUMBER
Definition: data.h:607
@ A_TO_OUTPUT
Definition: data.h:608
char * output
Definition: data.h:618
union Assignment::@19 dest
destination workspace/command/output, depending on the type
char * command
Definition: data.h:616
char * workspace
Definition: data.h:617
enum Assignment::@18 type
type of this assignment:
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition: data.h:641
struct Window * window
Definition: data.h:709
struct deco_render_params * deco_render_params
Cache for the decoration rendering.
Definition: data.h:715
enum Font::@23 type
The type of font.