2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * include/config.h: Contains all structs/variables for the configurable
8 * part of i3 as well as functions handling the configuration file (calling
9 * the parser (src/config_parse.c) with the correct path, switching key
20 typedef struct Config Config;
21 typedef struct Barconfig Barconfig;
22 extern char *current_configpath;
24 extern SLIST_HEAD(modes_head, Mode) modes;
25 extern TAILQ_HEAD(barconfig_head, Barconfig) barconfigs;
28 * Used during the config file lexing/parsing to keep the state of the lexer
29 * in order to provide useful error messages in yyerror().
42 /* These are the same as in YYLTYPE */
48 * Part of the struct Config. It makes sense to group colors for background,
49 * border and text as every element in i3 has them (window decorations, bar).
60 * Holds a user-assigned variable for parsing the configuration file. The key
61 * is replaced by value in every following line of the file.
69 SLIST_ENTRY(Variable) variables;
73 * The configuration file can contain multiple sets of bindings. Apart from the
74 * default set (name == "default"), you can specify other sets and change the
75 * currently active set of bindings by using the "mode <name>" command.
80 struct bindings_head *bindings;
82 SLIST_ENTRY(Mode) modes;
86 * Holds part of the configuration (the part which is not already in dedicated
87 * structures in include/data.h).
94 char *ipc_socket_path;
95 const char *restart_state_path;
97 layout_t default_layout;
98 int container_stack_limit;
99 int container_stack_limit_value;
100 int default_border_width;
101 int default_floating_border_width;
103 /** Default orientation for new containers */
104 int default_orientation;
106 /** By default, focus follows mouse. If the user explicitly wants to
107 * turn this off (and instead rely only on the keyboard for changing
108 * focus), we allow them to do this with this relatively special option.
109 * It is not planned to add any different focus models. */
110 bool disable_focus_follows_mouse;
112 /** By default, when switching focus to a window on a different output
113 * (e.g. focusing a window on workspace 3 on output VGA-1, coming from
114 * workspace 2 on LVDS-1), the mouse cursor is warped to the center of
117 * With the mouse_warping option, you can control when the mouse cursor
118 * should be warped. "none" disables warping entirely, whereas "output"
119 * is the default behavior described above. */
120 warping_t mouse_warping;
122 /** Remove borders if they are adjacent to the screen edge.
123 * This is useful if you are reaching scrollbar on the edge of the
124 * screen or do not want to waste a single pixel of displayspace.
125 * By default, this is disabled. */
126 adjacent_t hide_edge_borders;
128 /** By default, a workspace bar is drawn at the bottom of the screen.
129 * If you want to have a more fancy bar, it is recommended to replace
130 * the whole bar by dzen2, for example using the i3-wsbar script which
131 * comes with i3. Thus, you can turn it off entirely. */
132 bool disable_workspace_bar;
134 /** Think of the following layout: Horizontal workspace with a tabbed
135 * con on the left of the screen and a terminal on the right of the
136 * screen. You are in the second container in the tabbed container and
137 * focus to the right. By default, i3 will set focus to the terminal on
138 * the right. If you are in the first container in the tabbed container
139 * however, focusing to the left will wrap. This option forces i3 to
140 * always wrap, which will result in you having to use "focus parent"
142 bool force_focus_wrapping;
144 /** By default, use the RandR API for multi-monitor setups.
145 * Unfortunately, the nVidia binary graphics driver doesn't support
146 * this API. Instead, it only support the less powerful Xinerama API,
147 * which can be enabled by this option.
149 * Note: this option takes only effect on the initial startup (eg.
150 * reconfiguration is not possible). On startup, the list of screens
151 * is fetched once and never updated. */
154 /** Overwrites output detection (for testing), see src/fake_outputs.c */
157 /** Automatic workspace back and forth switching. If this is set, a
158 * switch to the currently active workspace will switch to the
159 * previously focused one instead, making it possible to fast toggle
160 * between two workspaces. */
161 bool workspace_auto_back_and_forth;
163 /** By default, urgency is cleared immediately when switching to another
164 * workspace leads to focusing the con with the urgency hint. When having
165 * multiple windows on that workspace, the user needs to guess which
166 * application raised the event. To prevent this, the reset of the urgency
167 * flag can be delayed using an urgency timer. */
168 float workspace_urgency_timer;
170 /** Use a timer to delay exiting when no output is available.
171 * This can prevent i3 from exiting when all outputs disappear momentarily. */
172 float zero_disp_exit_timer_ms;
174 /** Behavior when a window sends a NET_ACTIVE_WINDOW message. */
176 /* Focus if the target workspace is visible, set urgency hint otherwise. */
178 /* Always set the urgency hint. */
180 /* Always focus the window. */
182 /* Ignore the request (no focus, no urgency hint). */
184 } focus_on_window_activation;
186 /** Specifies whether or not marks should be displayed in the window
187 * decoration. Marks starting with a "_" will be ignored either way. */
190 /** The default border style for new windows. */
191 border_style_t default_border;
193 /** The default border style for new floating windows. */
194 border_style_t default_floating_border;
196 /** The modifier which needs to be pressed in combination with your mouse
197 * buttons to do things with floating windows (move, resize) */
198 uint32_t floating_modifier;
200 /** Maximum and minimum dimensions of a floating window */
201 int32_t floating_maximum_width;
202 int32_t floating_maximum_height;
203 int32_t floating_minimum_width;
204 int32_t floating_minimum_height;
206 /* Color codes are stored here */
207 struct config_client {
209 struct Colortriple focused;
210 struct Colortriple focused_inactive;
211 struct Colortriple unfocused;
212 struct Colortriple urgent;
213 struct Colortriple placeholder;
216 struct Colortriple focused;
217 struct Colortriple unfocused;
218 struct Colortriple urgent;
221 /** What should happen when a new popup is opened during fullscreen mode */
223 /* display (and focus) the popup when it belongs to the fullscreen
227 /* leave fullscreen mode unconditionally */
228 PDF_LEAVE_FULLSCREEN = 1,
230 /* just ignore the popup, that is, don’t map it */
232 } popup_during_fullscreen;
234 /* The number of currently parsed barconfigs */
235 int number_barconfigs;
239 * Holds the status bar configuration (i3bar). One of these structures is
240 * created for each 'bar' block in the config.
244 /** Automatically generated ID for this bar config. Used by the bar process
245 * to request a specific configuration. */
248 /** Number of outputs in the outputs array */
250 /** Outputs on which this bar should show up on. We use an array for
251 * simplicity (since we store just strings). */
254 /** Output on which the tray should be shown. The special value of 'no'
255 * disables the tray (it’s enabled by default). */
258 /** Path to the i3 IPC socket. This option is discouraged since programs
259 * can find out the path by looking for the I3_SOCKET_PATH property on the
263 /** Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mode) */
266 M_INVISIBLE = 2 } mode;
268 /* The current hidden_state of the bar, which indicates whether it is hidden or shown */
270 S_SHOW = 1 } hidden_state;
272 /** Bar modifier (to show bar when in hide mode). */
284 TAILQ_HEAD(mouse_commands_head, Mousecommand) mouse_commands;
286 /** Bar position (bottom by default). */
288 P_TOP = 1 } position;
290 /** Command that should be run to execute i3bar, give a full path if i3bar is not
292 * By default just 'i3bar' is executed. */
295 /** Command that should be run to get a statusline, for example 'i3status'.
296 * Will be passed to the shell. */
297 char *status_command;
299 /** Font specification for all text rendered on the bar. */
302 /** A custom separator to use instead of a vertical line. */
303 char *separator_symbol;
305 /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
306 * but we invert the bool to get the correct default when initializing with
308 bool hide_workspace_buttons;
310 /** Strip workspace numbers? Configuration option is
311 * 'strip_workspace_numbers yes'. */
312 bool strip_workspace_numbers;
314 /** Hide mode button? Configuration option is 'binding_mode_indicator no'
315 * but we invert the bool for the same reason as hide_workspace_buttons.*/
316 bool hide_binding_mode_indicator;
318 /** Enable verbose mode? Useful for debugging purposes. */
326 char *focused_workspace_border;
327 char *focused_workspace_bg;
328 char *focused_workspace_text;
330 char *active_workspace_border;
331 char *active_workspace_bg;
332 char *active_workspace_text;
334 char *inactive_workspace_border;
335 char *inactive_workspace_bg;
336 char *inactive_workspace_text;
338 char *urgent_workspace_border;
339 char *urgent_workspace_bg;
340 char *urgent_workspace_text;
342 char *binding_mode_border;
343 char *binding_mode_bg;
344 char *binding_mode_text;
347 TAILQ_ENTRY(Barconfig) configs;
351 * Defines a mouse command to be executed instead of the default behavior when
352 * clicking on the non-statusline part of i3bar.
355 struct Mousecommand {
356 /** The button for this command (e.g., "button1") */
359 /** The command which is to be executed for this button. */
362 TAILQ_ENTRY(Mousecommand) commands;
366 * Finds the configuration file to use (either the one specified by
367 * override_configpath), the user’s one or the system default) and calls
370 * If you specify override_configpath, only this path is used to look for a
371 * configuration file.
373 * If use_nagbar is false, don't try to start i3-nagbar but log the errors to
374 * stdout/stderr instead.
377 bool parse_configuration(const char *override_configpath, bool use_nagbar);
380 * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
382 * If you specify override_configpath, only this path is used to look for a
383 * configuration file.
386 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
389 * Ungrabs all keys, to be called before re-grabbing the keys because of a
390 * mapping_notify event or a configuration file reload
393 void ungrab_all_keys(xcb_connection_t *conn);
396 * Sends the current bar configuration as an event to all barconfig_update listeners.
399 void update_barconfig();
402 * Kills the configerror i3-nagbar process, if any.
404 * Called when reloading/restarting.
406 * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
407 * ev is assumed to handle it (reloading).
410 void kill_configerror_nagbar(bool wait_for_it);