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.
81 struct bindings_head *bindings;
83 SLIST_ENTRY(Mode) modes;
87 * Holds part of the configuration (the part which is not already in dedicated
88 * structures in include/data.h).
95 char *ipc_socket_path;
96 const char *restart_state_path;
98 layout_t default_layout;
99 int container_stack_limit;
100 int container_stack_limit_value;
101 int default_border_width;
102 int default_floating_border_width;
104 /** Default orientation for new containers */
105 int default_orientation;
107 /** By default, focus follows mouse. If the user explicitly wants to
108 * turn this off (and instead rely only on the keyboard for changing
109 * focus), we allow them to do this with this relatively special option.
110 * It is not planned to add any different focus models. */
111 bool disable_focus_follows_mouse;
113 /** By default, when switching focus to a window on a different output
114 * (e.g. focusing a window on workspace 3 on output VGA-1, coming from
115 * workspace 2 on LVDS-1), the mouse cursor is warped to the center of
118 * With the mouse_warping option, you can control when the mouse cursor
119 * should be warped. "none" disables warping entirely, whereas "output"
120 * is the default behavior described above. */
121 warping_t mouse_warping;
123 /** Remove borders if they are adjacent to the screen edge.
124 * This is useful if you are reaching scrollbar on the edge of the
125 * screen or do not want to waste a single pixel of displayspace.
126 * By default, this is disabled. */
127 adjacent_t hide_edge_borders;
129 /** By default, a workspace bar is drawn at the bottom of the screen.
130 * If you want to have a more fancy bar, it is recommended to replace
131 * the whole bar by dzen2, for example using the i3-wsbar script which
132 * comes with i3. Thus, you can turn it off entirely. */
133 bool disable_workspace_bar;
135 /** Think of the following layout: Horizontal workspace with a tabbed
136 * con on the left of the screen and a terminal on the right of the
137 * screen. You are in the second container in the tabbed container and
138 * focus to the right. By default, i3 will set focus to the terminal on
139 * the right. If you are in the first container in the tabbed container
140 * however, focusing to the left will wrap. This option forces i3 to
141 * always wrap, which will result in you having to use "focus parent"
143 bool force_focus_wrapping;
145 /** By default, use the RandR API for multi-monitor setups.
146 * Unfortunately, the nVidia binary graphics driver doesn't support
147 * this API. Instead, it only support the less powerful Xinerama API,
148 * which can be enabled by this option.
150 * Note: this option takes only effect on the initial startup (eg.
151 * reconfiguration is not possible). On startup, the list of screens
152 * is fetched once and never updated. */
155 /** Overwrites output detection (for testing), see src/fake_outputs.c */
158 /** Automatic workspace back and forth switching. If this is set, a
159 * switch to the currently active workspace will switch to the
160 * previously focused one instead, making it possible to fast toggle
161 * between two workspaces. */
162 bool workspace_auto_back_and_forth;
164 /** By default, urgency is cleared immediately when switching to another
165 * workspace leads to focusing the con with the urgency hint. When having
166 * multiple windows on that workspace, the user needs to guess which
167 * application raised the event. To prevent this, the reset of the urgency
168 * flag can be delayed using an urgency timer. */
169 float workspace_urgency_timer;
171 /** Behavior when a window sends a NET_ACTIVE_WINDOW message. */
173 /* Focus if the target workspace is visible, set urgency hint otherwise. */
175 /* Always set the urgency hint. */
177 /* Always focus the window. */
179 /* Ignore the request (no focus, no urgency hint). */
181 } focus_on_window_activation;
183 /** Specifies whether or not marks should be displayed in the window
184 * decoration. Marks starting with a "_" will be ignored either way. */
187 /** The default border style for new windows. */
188 border_style_t default_border;
190 /** The default border style for new floating windows. */
191 border_style_t default_floating_border;
193 /** The modifier which needs to be pressed in combination with your mouse
194 * buttons to do things with floating windows (move, resize) */
195 uint32_t floating_modifier;
197 /** Maximum and minimum dimensions of a floating window */
198 int32_t floating_maximum_width;
199 int32_t floating_maximum_height;
200 int32_t floating_minimum_width;
201 int32_t floating_minimum_height;
203 /* Color codes are stored here */
204 struct config_client {
206 struct Colortriple focused;
207 struct Colortriple focused_inactive;
208 struct Colortriple unfocused;
209 struct Colortriple urgent;
210 struct Colortriple placeholder;
213 struct Colortriple focused;
214 struct Colortriple unfocused;
215 struct Colortriple urgent;
218 /** What should happen when a new popup is opened during fullscreen mode */
220 /* display (and focus) the popup when it belongs to the fullscreen
224 /* leave fullscreen mode unconditionally */
225 PDF_LEAVE_FULLSCREEN = 1,
227 /* just ignore the popup, that is, don’t map it */
229 } popup_during_fullscreen;
231 /* The number of currently parsed barconfigs */
232 int number_barconfigs;
236 * Holds the status bar configuration (i3bar). One of these structures is
237 * created for each 'bar' block in the config.
241 /** Automatically generated ID for this bar config. Used by the bar process
242 * to request a specific configuration. */
245 /** Number of outputs in the outputs array */
247 /** Outputs on which this bar should show up on. We use an array for
248 * simplicity (since we store just strings). */
251 /* List of outputs on which the tray is allowed to be shown, in order.
252 * The special value "none" disables it (per default, it will be shown) and
253 * the special value "primary" enabled it on the primary output. */
254 TAILQ_HEAD(tray_outputs_head, tray_output_t) tray_outputs;
256 /* Padding around the tray icons. */
259 /** Path to the i3 IPC socket. This option is discouraged since programs
260 * can find out the path by looking for the I3_SOCKET_PATH property on the
264 /** Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mode) */
267 M_INVISIBLE = 2 } mode;
269 /* The current hidden_state of the bar, which indicates whether it is hidden or shown */
271 S_SHOW = 1 } hidden_state;
273 /** Bar modifier (to show bar when in hide mode). */
285 TAILQ_HEAD(bar_bindings_head, Barbinding) bar_bindings;
287 /** Bar position (bottom by default). */
289 P_TOP = 1 } position;
291 /** Command that should be run to execute i3bar, give a full path if i3bar is not
293 * By default just 'i3bar' is executed. */
296 /** Command that should be run to get a statusline, for example 'i3status'.
297 * Will be passed to the shell. */
298 char *status_command;
300 /** Font specification for all text rendered on the bar. */
303 /** A custom separator to use instead of a vertical line. */
304 char *separator_symbol;
306 /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
307 * but we invert the bool to get the correct default when initializing with
309 bool hide_workspace_buttons;
311 /** Strip workspace numbers? Configuration option is
312 * 'strip_workspace_numbers yes'. */
313 bool strip_workspace_numbers;
315 /** Hide mode button? Configuration option is 'binding_mode_indicator no'
316 * but we invert the bool for the same reason as hide_workspace_buttons.*/
317 bool hide_binding_mode_indicator;
319 /** Enable verbose mode? Useful for debugging purposes. */
327 char *focused_background;
328 char *focused_statusline;
329 char *focused_separator;
331 char *focused_workspace_border;
332 char *focused_workspace_bg;
333 char *focused_workspace_text;
335 char *active_workspace_border;
336 char *active_workspace_bg;
337 char *active_workspace_text;
339 char *inactive_workspace_border;
340 char *inactive_workspace_bg;
341 char *inactive_workspace_text;
343 char *urgent_workspace_border;
344 char *urgent_workspace_bg;
345 char *urgent_workspace_text;
347 char *binding_mode_border;
348 char *binding_mode_bg;
349 char *binding_mode_text;
352 TAILQ_ENTRY(Barconfig) configs;
356 * Defines a mouse command to be executed instead of the default behavior when
357 * clicking on the non-statusline part of i3bar.
361 /** The button to be used (e.g., 1 for "button1"). */
364 /** The command which is to be executed for this button. */
367 TAILQ_ENTRY(Barbinding) bindings;
370 struct tray_output_t {
373 TAILQ_ENTRY(tray_output_t) tray_outputs;
377 * Finds the configuration file to use (either the one specified by
378 * override_configpath), the user’s one or the system default) and calls
381 * If you specify override_configpath, only this path is used to look for a
382 * configuration file.
384 * If use_nagbar is false, don't try to start i3-nagbar but log the errors to
385 * stdout/stderr instead.
388 bool parse_configuration(const char *override_configpath, bool use_nagbar);
391 * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
393 * If you specify override_configpath, only this path is used to look for a
394 * configuration file.
397 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
400 * Ungrabs all keys, to be called before re-grabbing the keys because of a
401 * mapping_notify event or a configuration file reload
404 void ungrab_all_keys(xcb_connection_t *conn);
407 * Sends the current bar configuration as an event to all barconfig_update listeners.
410 void update_barconfig();
413 * Kills the configerror i3-nagbar process, if any.
415 * Called when reloading/restarting.
417 * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
418 * ev is assumed to handle it (reloading).
421 void kill_configerror_nagbar(bool wait_for_it);