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/configuration.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
21 typedef struct Config Config;
22 typedef struct Barconfig Barconfig;
23 extern char *current_configpath;
24 extern char *current_config;
26 extern SLIST_HEAD(modes_head, Mode) modes;
27 extern TAILQ_HEAD(barconfig_head, Barconfig) barconfigs;
30 * Used during the config file lexing/parsing to keep the state of the lexer
31 * in order to provide useful error messages in yyerror().
44 /* These are the same as in YYLTYPE */
50 * Part of the struct Config. It makes sense to group colors for background,
51 * border and text as every element in i3 has them (window decorations, bar).
63 * Holds a user-assigned variable for parsing the configuration file. The key
64 * is replaced by value in every following line of the file.
77 * The configuration file can contain multiple sets of bindings. Apart from the
78 * default set (name == "default"), you can specify other sets and change the
79 * currently active set of bindings by using the "mode <name>" command.
85 struct bindings_head *bindings;
92 * Holds part of the configuration (the part which is not already in dedicated
93 * structures in include/data.h).
100 char *ipc_socket_path;
101 char *restart_state_path;
103 layout_t default_layout;
104 int container_stack_limit;
105 int container_stack_limit_value;
106 int default_border_width;
107 int default_floating_border_width;
109 /** Default orientation for new containers */
110 int default_orientation;
112 /** By default, focus follows mouse. If the user explicitly wants to
113 * turn this off (and instead rely only on the keyboard for changing
114 * focus), we allow them to do this with this relatively special option.
115 * It is not planned to add any different focus models. */
116 bool disable_focus_follows_mouse;
118 /** By default, when switching focus to a window on a different output
119 * (e.g. focusing a window on workspace 3 on output VGA-1, coming from
120 * workspace 2 on LVDS-1), the mouse cursor is warped to the center of
123 * With the mouse_warping option, you can control when the mouse cursor
124 * should be warped. "none" disables warping entirely, whereas "output"
125 * is the default behavior described above. */
126 warping_t mouse_warping;
128 /** Remove borders if they are adjacent to the screen edge.
129 * This is useful if you are reaching scrollbar on the edge of the
130 * screen or do not want to waste a single pixel of displayspace.
131 * By default, this is disabled. */
132 hide_edge_borders_mode_t hide_edge_borders;
134 /** By default, a workspace bar is drawn at the bottom of the screen.
135 * If you want to have a more fancy bar, it is recommended to replace
136 * the whole bar by dzen2, for example using the i3-wsbar script which
137 * comes with i3. Thus, you can turn it off entirely. */
138 bool disable_workspace_bar;
140 /** When focus wrapping is enabled (the default), attempting to
141 * move focus past the edge of the screen (in other words, in a
142 * direction in which there are no more containers to focus) will
143 * cause the focus to wrap to the opposite edge of the current
144 * container. When it is disabled, nothing happens; the current
145 * focus is preserved. */
148 /** Think of the following layout: Horizontal workspace with a tabbed
149 * con on the left of the screen and a terminal on the right of the
150 * screen. You are in the second container in the tabbed container and
151 * focus to the right. By default, i3 will set focus to the terminal on
152 * the right. If you are in the first container in the tabbed container
153 * however, focusing to the left will wrap. This option forces i3 to
154 * always wrap, which will result in you having to use "focus parent"
156 bool force_focus_wrapping;
158 /** By default, use the RandR API for multi-monitor setups.
159 * Unfortunately, the nVidia binary graphics driver doesn't support
160 * this API. Instead, it only support the less powerful Xinerama API,
161 * which can be enabled by this option.
163 * Note: this option takes only effect on the initial startup (eg.
164 * reconfiguration is not possible). On startup, the list of screens
165 * is fetched once and never updated. */
168 /** Don’t use RandR 1.5 for querying outputs. */
169 bool disable_randr15;
171 /** Overwrites output detection (for testing), see src/fake_outputs.c */
174 /** Automatic workspace back and forth switching. If this is set, a
175 * switch to the currently active workspace will switch to the
176 * previously focused one instead, making it possible to fast toggle
177 * between two workspaces. */
178 bool workspace_auto_back_and_forth;
180 /** By default, urgency is cleared immediately when switching to another
181 * workspace leads to focusing the con with the urgency hint. When having
182 * multiple windows on that workspace, the user needs to guess which
183 * application raised the event. To prevent this, the reset of the urgency
184 * flag can be delayed using an urgency timer. */
185 float workspace_urgency_timer;
187 /** Behavior when a window sends a NET_ACTIVE_WINDOW message. */
189 /* Focus if the target workspace is visible, set urgency hint otherwise. */
191 /* Always set the urgency hint. */
193 /* Always focus the window. */
195 /* Ignore the request (no focus, no urgency hint). */
197 } focus_on_window_activation;
199 /** Specifies whether or not marks should be displayed in the window
200 * decoration. Marks starting with a "_" will be ignored either way. */
203 /** The default border style for new windows. */
204 border_style_t default_border;
206 /** The default border style for new floating windows. */
207 border_style_t default_floating_border;
209 /** The modifier which needs to be pressed in combination with your mouse
210 * buttons to do things with floating windows (move, resize) */
211 uint32_t floating_modifier;
213 /** Maximum and minimum dimensions of a floating window */
214 int32_t floating_maximum_width;
215 int32_t floating_maximum_height;
216 int32_t floating_minimum_width;
217 int32_t floating_minimum_height;
219 /* Color codes are stored here */
220 struct config_client {
222 struct Colortriple focused;
223 struct Colortriple focused_inactive;
224 struct Colortriple unfocused;
225 struct Colortriple urgent;
226 struct Colortriple placeholder;
229 struct Colortriple focused;
230 struct Colortriple unfocused;
231 struct Colortriple urgent;
234 /** What should happen when a new popup is opened during fullscreen mode */
236 /* display (and focus) the popup when it belongs to the fullscreen
240 /* leave fullscreen mode unconditionally */
241 PDF_LEAVE_FULLSCREEN = 1,
243 /* just ignore the popup, that is, don’t map it */
245 } popup_during_fullscreen;
247 /* The number of currently parsed barconfigs */
248 int number_barconfigs;
252 * Holds the status bar configuration (i3bar). One of these structures is
253 * created for each 'bar' block in the config.
257 /** Automatically generated ID for this bar config. Used by the bar process
258 * to request a specific configuration. */
261 /** Number of outputs in the outputs array */
263 /** Outputs on which this bar should show up on. We use an array for
264 * simplicity (since we store just strings). */
267 /* List of outputs on which the tray is allowed to be shown, in order.
268 * The special value "none" disables it (per default, it will be shown) and
269 * the special value "primary" enabled it on the primary output. */
270 TAILQ_HEAD(tray_outputs_head, tray_output_t)
273 /* Padding around the tray icons. */
276 /** Path to the i3 IPC socket. This option is discouraged since programs
277 * can find out the path by looking for the I3_SOCKET_PATH property on the
281 /** Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mode) */
284 M_INVISIBLE = 2 } mode;
286 /* The current hidden_state of the bar, which indicates whether it is hidden or shown */
288 S_SHOW = 1 } hidden_state;
290 /** Bar modifier (to show bar when in hide mode). */
302 TAILQ_HEAD(bar_bindings_head, Barbinding)
305 /** Bar position (bottom by default). */
307 P_TOP = 1 } position;
309 /** Command that should be run to execute i3bar, give a full path if i3bar is not
311 * By default just 'i3bar' is executed. */
314 /** Command that should be run to get a statusline, for example 'i3status'.
315 * Will be passed to the shell. */
316 char *status_command;
318 /** Font specification for all text rendered on the bar. */
321 /** A custom separator to use instead of a vertical line. */
322 char *separator_symbol;
324 /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
325 * but we invert the bool to get the correct default when initializing with
327 bool hide_workspace_buttons;
329 /** Strip workspace numbers? Configuration option is
330 * 'strip_workspace_numbers yes'. */
331 bool strip_workspace_numbers;
333 /** Hide mode button? Configuration option is 'binding_mode_indicator no'
334 * but we invert the bool for the same reason as hide_workspace_buttons.*/
335 bool hide_binding_mode_indicator;
337 /** Enable verbose mode? Useful for debugging purposes. */
345 char *focused_background;
346 char *focused_statusline;
347 char *focused_separator;
349 char *focused_workspace_border;
350 char *focused_workspace_bg;
351 char *focused_workspace_text;
353 char *active_workspace_border;
354 char *active_workspace_bg;
355 char *active_workspace_text;
357 char *inactive_workspace_border;
358 char *inactive_workspace_bg;
359 char *inactive_workspace_text;
361 char *urgent_workspace_border;
362 char *urgent_workspace_bg;
363 char *urgent_workspace_text;
365 char *binding_mode_border;
366 char *binding_mode_bg;
367 char *binding_mode_text;
370 TAILQ_ENTRY(Barconfig)
375 * Defines a mouse command to be executed instead of the default behavior when
376 * clicking on the non-statusline part of i3bar.
380 /** The button to be used (e.g., 1 for "button1"). */
383 /** The command which is to be executed for this button. */
386 TAILQ_ENTRY(Barbinding)
390 struct tray_output_t {
393 TAILQ_ENTRY(tray_output_t)
398 * Finds the configuration file to use (either the one specified by
399 * override_configpath), the user’s one or the system default) and calls
402 * If you specify override_configpath, only this path is used to look for a
403 * configuration file.
405 * If use_nagbar is false, don't try to start i3-nagbar but log the errors to
406 * stdout/stderr instead.
409 bool parse_configuration(const char *override_configpath, bool use_nagbar);
412 * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
414 * If you specify override_configpath, only this path is used to look for a
415 * configuration file.
418 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
421 * Ungrabs all keys, to be called before re-grabbing the keys because of a
422 * mapping_notify event or a configuration file reload
425 void ungrab_all_keys(xcb_connection_t *conn);
428 * Sends the current bar configuration as an event to all barconfig_update listeners.
431 void update_barconfig();
434 * Kills the configerror i3-nagbar process, if any.
436 * Called when reloading/restarting.
438 * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
439 * ev is assumed to handle it (reloading).
442 void kill_configerror_nagbar(bool wait_for_it);