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;
25 extern SLIST_HEAD(modes_head, Mode) modes;
26 extern TAILQ_HEAD(barconfig_head, Barconfig) barconfigs;
29 * Used during the config file lexing/parsing to keep the state of the lexer
30 * in order to provide useful error messages in yyerror().
43 /* These are the same as in YYLTYPE */
49 * Part of the struct Config. It makes sense to group colors for background,
50 * border and text as every element in i3 has them (window decorations, bar).
62 * Holds a user-assigned variable for parsing the configuration file. The key
63 * is replaced by value in every following line of the file.
76 * The configuration file can contain multiple sets of bindings. Apart from the
77 * default set (name == "default"), you can specify other sets and change the
78 * currently active set of bindings by using the "mode <name>" command.
84 struct bindings_head *bindings;
91 * Holds part of the configuration (the part which is not already in dedicated
92 * structures in include/data.h).
99 char *ipc_socket_path;
100 char *restart_state_path;
102 layout_t default_layout;
103 int container_stack_limit;
104 int container_stack_limit_value;
105 int default_border_width;
106 int default_floating_border_width;
108 /** Default orientation for new containers */
109 int default_orientation;
111 /** By default, focus follows mouse. If the user explicitly wants to
112 * turn this off (and instead rely only on the keyboard for changing
113 * focus), we allow them to do this with this relatively special option.
114 * It is not planned to add any different focus models. */
115 bool disable_focus_follows_mouse;
117 /** By default, when switching focus to a window on a different output
118 * (e.g. focusing a window on workspace 3 on output VGA-1, coming from
119 * workspace 2 on LVDS-1), the mouse cursor is warped to the center of
122 * With the mouse_warping option, you can control when the mouse cursor
123 * should be warped. "none" disables warping entirely, whereas "output"
124 * is the default behavior described above. */
125 warping_t mouse_warping;
127 /** Remove borders if they are adjacent to the screen edge.
128 * This is useful if you are reaching scrollbar on the edge of the
129 * screen or do not want to waste a single pixel of displayspace.
130 * By default, this is disabled. */
131 hide_edge_borders_mode_t hide_edge_borders;
133 /** By default, a workspace bar is drawn at the bottom of the screen.
134 * If you want to have a more fancy bar, it is recommended to replace
135 * the whole bar by dzen2, for example using the i3-wsbar script which
136 * comes with i3. Thus, you can turn it off entirely. */
137 bool disable_workspace_bar;
139 /** Think of the following layout: Horizontal workspace with a tabbed
140 * con on the left of the screen and a terminal on the right of the
141 * screen. You are in the second container in the tabbed container and
142 * focus to the right. By default, i3 will set focus to the terminal on
143 * the right. If you are in the first container in the tabbed container
144 * however, focusing to the left will wrap. This option forces i3 to
145 * always wrap, which will result in you having to use "focus parent"
147 bool force_focus_wrapping;
149 /** By default, use the RandR API for multi-monitor setups.
150 * Unfortunately, the nVidia binary graphics driver doesn't support
151 * this API. Instead, it only support the less powerful Xinerama API,
152 * which can be enabled by this option.
154 * Note: this option takes only effect on the initial startup (eg.
155 * reconfiguration is not possible). On startup, the list of screens
156 * is fetched once and never updated. */
159 /** Don’t use RandR 1.5 for querying outputs. */
160 bool disable_randr15;
162 /** Overwrites output detection (for testing), see src/fake_outputs.c */
165 /** Automatic workspace back and forth switching. If this is set, a
166 * switch to the currently active workspace will switch to the
167 * previously focused one instead, making it possible to fast toggle
168 * between two workspaces. */
169 bool workspace_auto_back_and_forth;
171 /** By default, urgency is cleared immediately when switching to another
172 * workspace leads to focusing the con with the urgency hint. When having
173 * multiple windows on that workspace, the user needs to guess which
174 * application raised the event. To prevent this, the reset of the urgency
175 * flag can be delayed using an urgency timer. */
176 float workspace_urgency_timer;
178 /** Behavior when a window sends a NET_ACTIVE_WINDOW message. */
180 /* Focus if the target workspace is visible, set urgency hint otherwise. */
182 /* Always set the urgency hint. */
184 /* Always focus the window. */
186 /* Ignore the request (no focus, no urgency hint). */
188 } focus_on_window_activation;
190 /** Specifies whether or not marks should be displayed in the window
191 * decoration. Marks starting with a "_" will be ignored either way. */
194 /** The default border style for new windows. */
195 border_style_t default_border;
197 /** The default border style for new floating windows. */
198 border_style_t default_floating_border;
200 /** The modifier which needs to be pressed in combination with your mouse
201 * buttons to do things with floating windows (move, resize) */
202 uint32_t floating_modifier;
204 /** Maximum and minimum dimensions of a floating window */
205 int32_t floating_maximum_width;
206 int32_t floating_maximum_height;
207 int32_t floating_minimum_width;
208 int32_t floating_minimum_height;
210 /* Color codes are stored here */
211 struct config_client {
213 struct Colortriple focused;
214 struct Colortriple focused_inactive;
215 struct Colortriple unfocused;
216 struct Colortriple urgent;
217 struct Colortriple placeholder;
220 struct Colortriple focused;
221 struct Colortriple unfocused;
222 struct Colortriple urgent;
225 /** What should happen when a new popup is opened during fullscreen mode */
227 /* display (and focus) the popup when it belongs to the fullscreen
231 /* leave fullscreen mode unconditionally */
232 PDF_LEAVE_FULLSCREEN = 1,
234 /* just ignore the popup, that is, don’t map it */
236 } popup_during_fullscreen;
238 /* The number of currently parsed barconfigs */
239 int number_barconfigs;
243 * Holds the status bar configuration (i3bar). One of these structures is
244 * created for each 'bar' block in the config.
248 /** Automatically generated ID for this bar config. Used by the bar process
249 * to request a specific configuration. */
252 /** Number of outputs in the outputs array */
254 /** Outputs on which this bar should show up on. We use an array for
255 * simplicity (since we store just strings). */
258 /* List of outputs on which the tray is allowed to be shown, in order.
259 * The special value "none" disables it (per default, it will be shown) and
260 * the special value "primary" enabled it on the primary output. */
261 TAILQ_HEAD(tray_outputs_head, tray_output_t)
264 /* Padding around the tray icons. */
267 /** Path to the i3 IPC socket. This option is discouraged since programs
268 * can find out the path by looking for the I3_SOCKET_PATH property on the
272 /** Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mode) */
275 M_INVISIBLE = 2 } mode;
277 /* The current hidden_state of the bar, which indicates whether it is hidden or shown */
279 S_SHOW = 1 } hidden_state;
281 /** Bar modifier (to show bar when in hide mode). */
293 TAILQ_HEAD(bar_bindings_head, Barbinding)
296 /** Bar position (bottom by default). */
298 P_TOP = 1 } position;
300 /** Command that should be run to execute i3bar, give a full path if i3bar is not
302 * By default just 'i3bar' is executed. */
305 /** Command that should be run to get a statusline, for example 'i3status'.
306 * Will be passed to the shell. */
307 char *status_command;
309 /** Font specification for all text rendered on the bar. */
312 /** A custom separator to use instead of a vertical line. */
313 char *separator_symbol;
315 /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
316 * but we invert the bool to get the correct default when initializing with
318 bool hide_workspace_buttons;
320 /** Strip workspace numbers? Configuration option is
321 * 'strip_workspace_numbers yes'. */
322 bool strip_workspace_numbers;
324 /** Hide mode button? Configuration option is 'binding_mode_indicator no'
325 * but we invert the bool for the same reason as hide_workspace_buttons.*/
326 bool hide_binding_mode_indicator;
328 /** Enable verbose mode? Useful for debugging purposes. */
336 char *focused_background;
337 char *focused_statusline;
338 char *focused_separator;
340 char *focused_workspace_border;
341 char *focused_workspace_bg;
342 char *focused_workspace_text;
344 char *active_workspace_border;
345 char *active_workspace_bg;
346 char *active_workspace_text;
348 char *inactive_workspace_border;
349 char *inactive_workspace_bg;
350 char *inactive_workspace_text;
352 char *urgent_workspace_border;
353 char *urgent_workspace_bg;
354 char *urgent_workspace_text;
356 char *binding_mode_border;
357 char *binding_mode_bg;
358 char *binding_mode_text;
361 TAILQ_ENTRY(Barconfig)
366 * Defines a mouse command to be executed instead of the default behavior when
367 * clicking on the non-statusline part of i3bar.
371 /** The button to be used (e.g., 1 for "button1"). */
374 /** The command which is to be executed for this button. */
377 TAILQ_ENTRY(Barbinding)
381 struct tray_output_t {
384 TAILQ_ENTRY(tray_output_t)
389 * Finds the configuration file to use (either the one specified by
390 * override_configpath), the user’s one or the system default) and calls
393 * If you specify override_configpath, only this path is used to look for a
394 * configuration file.
396 * If use_nagbar is false, don't try to start i3-nagbar but log the errors to
397 * stdout/stderr instead.
400 bool parse_configuration(const char *override_configpath, bool use_nagbar);
403 * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
405 * If you specify override_configpath, only this path is used to look for a
406 * configuration file.
409 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
412 * Ungrabs all keys, to be called before re-grabbing the keys because of a
413 * mapping_notify event or a configuration file reload
416 void ungrab_all_keys(xcb_connection_t *conn);
419 * Sends the current bar configuration as an event to all barconfig_update listeners.
422 void update_barconfig();
425 * Kills the configerror i3-nagbar process, if any.
427 * Called when reloading/restarting.
429 * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
430 * ev is assumed to handle it (reloading).
433 void kill_configerror_nagbar(bool wait_for_it);