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 
203  INIT_COLOR(config.client.focused, "#4c7899", "#285577", "#ffffff", "#2e9ef4");
204  INIT_COLOR(config.client.focused_inactive, "#333333", "#5f676a", "#ffffff", "#484e50");
205  INIT_COLOR(config.client.unfocused, "#333333", "#222222", "#888888", "#292d2e");
206  INIT_COLOR(config.client.urgent, "#2f343a", "#900000", "#ffffff", "#900000");
207 
208  /* border and indicator color are ignored for placeholder contents */
209  INIT_COLOR(config.client.placeholder, "#000000", "#0c0c0c", "#ffffff", "#000000");
210 
211  /* the last argument (indicator color) is ignored for bar colors */
212  INIT_COLOR(config.bar.focused, "#4c7899", "#285577", "#ffffff", "#000000");
213  INIT_COLOR(config.bar.unfocused, "#333333", "#222222", "#888888", "#000000");
214  INIT_COLOR(config.bar.urgent, "#2f343a", "#900000", "#ffffff", "#000000");
215 
216  config.show_marks = true;
217 
222  /* Set default_orientation to NO_ORIENTATION for auto orientation. */
224 
225  /* Set default urgency reset delay to 500ms */
228 
230 
232  current_configpath = get_config_path(override_configpath, true);
233  if (current_configpath == NULL) {
234  die("Unable to find the configuration file (looked at "
235  "$XDG_CONFIG_HOME/i3/config, ~/.i3/config, $XDG_CONFIG_DIRS/i3/config "
236  "and " SYSCONFDIR "/i3/config)");
237  }
238  LOG("Parsing configfile %s\n", current_configpath);
239  const bool result = parse_file(current_configpath, load_type != C_VALIDATE);
240 
241  if (config.font.type == FONT_TYPE_NONE && load_type != C_VALIDATE) {
242  ELOG("You did not specify required configuration option \"font\"\n");
243  config.font = load_font("fixed", true);
244  set_font(&config.font);
245  }
246 
247  if (load_type == C_RELOAD) {
251 
252  /* Redraw the currently visible decorations on reload, so that the
253  * possibly new drawing parameters changed. */
255  xcb_flush(conn);
256  }
257 
258  return result;
259 }
struct Barconfig::bar_colors colors
#define FREE(pointer)
Definition: util.h:47
char * i3bar_command
Command that should be run to execute i3bar, give a full path if i3bar is not in your $PATH...
xcb_window_t root
Definition: main.c:57
struct Config::config_client client
Match match
the criteria to check if a window matches
Definition: data.h:584
Defines a mouse command to be executed instead of the default behavior when clicking on the non-statu...
Assignment ** ran_assignments
Definition: data.h:421
uint32_t nr_assignments
Pointers to the Assignments which were already ran for this Window (assignments run only once) ...
Definition: data.h:420
char * workspace
Definition: data.h:589
int logical_px(const int logical)
Convert a logical amount of pixels (e.g.
void update_barconfig(void)
Sends the current bar configuration as an event to all barconfig_update listeners.
Definition: config.c:35
char ** outputs
Outputs on which this bar should show up on.
struct barconfig_head barconfigs
Definition: config.c:19
char * id
Automatically generated ID for this bar config.
struct Con * croot
Definition: tree.c:12
#define DLOG(fmt,...)
Definition: libi3.h:104
char * ipc_socket_path
#define SLIST_REMOVE(head, elm, type, field)
Definition: queue.h:154
#define TAILQ_EMPTY(head)
Definition: queue.h:344
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...
xcb_connection_t * conn
XCB connection and root screen.
Definition: main.c:44
char * restart_state_path
void match_free(Match *match)
Frees the given match.
Definition: match.c:241
void switch_mode(const char *new_mode)
Switches the key bindings to the given mode, if the mode exists.
Definition: bindings.c:618
#define SLIST_EMPTY(head)
Definition: queue.h:111
#define INIT_COLOR(x, cborder, cbackground, ctext, cindicator)
i3Font font
Definition: configuration.h:98
struct deco_render_params * deco_render_params
Cache for the decoration rendering.
Definition: data.h:687
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
char * current_config
Definition: config.c:16
struct bindings_head * bindings
Definition: main.c:74
config_load_t
void free_font(void)
Frees the resources taken by the current font.
char * status_command
Command that should be run to get a statusline, for example &#39;i3status&#39;.
int num_outputs
Number of outputs in the outputs array.
struct assignments_head assignments
Definition: main.c:83
float workspace_urgency_timer
By default, urgency is cleared immediately when switching to another workspace leads to focusing the ...
struct modes_head modes
Definition: config.c:18
struct Colortriple focused
char * fake_outputs
Overwrites output detection (for testing), see src/fake_outputs.c.
union Assignment::@19 dest
destination workspace/command/output, depending on the type
void ipc_send_barconfig_update_event(Barconfig *barconfig)
For the barconfig update events, we send the serialized barconfig.
Definition: ipc.c:1607
#define TAILQ_REMOVE(head, elm, field)
Definition: queue.h:402
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
#define SLIST_INIT(head)
Definition: queue.h:127
focus_wrapping_t focus_wrapping
When focus wrapping is enabled (the default), attempting to move focus past the edge of the screen (i...
static void free_configuration(void)
Definition: config.c:42
A &#39;Con&#39; represents everything from the X11 root window down to a single X11 window.
Definition: data.h:613
#define TAILQ_FIRST(head)
Definition: queue.h:336
Holds part of the configuration (the part which is not already in dedicated structures in include/dat...
Definition: configuration.h:96
char * command
Definition: data.h:588
#define SLIST_FIRST(head)
Definition: queue.h:109
#define TAILQ_INIT(head)
Definition: queue.h:360
enum Font::@23 type
The type of font.
struct Colortriple urgent
int default_floating_border_width
char * current_configpath
Definition: config.c:15
char * output
Definition: data.h:590
Stores which workspace (by name or number) goes to which output.
Definition: data.h:207
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
Definition: data.h:62
enum Assignment::@18 type
type of this assignment:
char * font
Font specification for all text rendered on the bar.
void binding_free(Binding *bind)
Frees the binding.
Definition: bindings.c:792
char * command
The command which is to be executed for this button.
#define LOG(fmt,...)
Definition: libi3.h:94
border_style_t default_floating_border
The default border style for new floating windows.
An Assignment makes specific windows go to a specific workspace/output or run a command for that wind...
Definition: data.h:562
char * name
Definition: configuration.h:83
char * get_config_path(const char *override_configpath, bool use_system_paths)
Get the path of the first configuration file found.
Holds a keybinding, consisting of a keycode combined with modifiers and the command which is executed...
Definition: data.h:282
struct Colortriple focused_inactive
color_t draw_util_hex_to_color(const char *color)
Parses the given color in hex format to an internal color representation.
struct all_cons_head all_cons
Definition: tree.c:15
struct Colortriple focused
struct Window * window
Definition: data.h:681
struct Colortriple unfocused
void x_deco_recurse(Con *con)
Recursively calls x_draw_decoration.
Definition: x.c:725
The configuration file can contain multiple sets of bindings.
Definition: configuration.h:82
bool show_marks
Specifies whether or not marks should be displayed in the window decoration.
i3Font load_font(const char *pattern, const bool fallback)
Loads a font for usage, also getting its height.
#define ELOG(fmt,...)
Definition: libi3.h:99
int default_orientation
Default orientation for new containers.
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 translate_keysyms(void)
Translates keysymbols to keycodes for all bindings which use keysyms.
Definition: bindings.c:432
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
struct Colortriple urgent
border_style_t default_border
The default border style for new windows.
struct ws_assignments_head ws_assignments
Definition: main.c:87
#define SLIST_INSERT_HEAD(head, elm, field)
Definition: queue.h:138
int default_border_width
struct Colortriple placeholder
struct Config::config_bar bar
Config config
Definition: config.c:17
void set_font(i3Font *font)
Defines the font to be used for the forthcoming calls.
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
struct Colortriple unfocused
Holds the status bar configuration (i3bar).
#define TAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:324
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:347
struct bindings_head * bindings
Definition: configuration.h:85
char * socket_path
Path to the i3 IPC socket.
#define die(...)
Definition: util.h:19