2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2012 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;
102 /** Default orientation for new containers */
103 int default_orientation;
105 /** By default, focus follows mouse. If the user explicitly wants to
106 * turn this off (and instead rely only on the keyboard for changing
107 * focus), we allow him to do this with this relatively special option.
108 * It is not planned to add any different focus models. */
109 bool disable_focus_follows_mouse;
111 /** Remove borders if they are adjacent to the screen edge.
112 * This is useful if you are reaching scrollbar on the edge of the
113 * screen or do not want to waste a single pixel of displayspace.
114 * By default, this is disabled. */
115 adjacent_t hide_edge_borders;
117 /** By default, a workspace bar is drawn at the bottom of the screen.
118 * If you want to have a more fancy bar, it is recommended to replace
119 * the whole bar by dzen2, for example using the i3-wsbar script which
120 * comes with i3. Thus, you can turn it off entirely. */
121 bool disable_workspace_bar;
123 /** Think of the following layout: Horizontal workspace with a tabbed
124 * con on the left of the screen and a terminal on the right of the
125 * screen. You are in the second container in the tabbed container and
126 * focus to the right. By default, i3 will set focus to the terminal on
127 * the right. If you are in the first container in the tabbed container
128 * however, focusing to the left will wrap. This option forces i3 to
129 * always wrap, which will result in you having to use "focus parent"
131 bool force_focus_wrapping;
133 /** By default, use the RandR API for multi-monitor setups.
134 * Unfortunately, the nVidia binary graphics driver doesn't support
135 * this API. Instead, it only support the less powerful Xinerama API,
136 * which can be enabled by this option.
138 * Note: this option takes only effect on the initial startup (eg.
139 * reconfiguration is not possible). On startup, the list of screens
140 * is fetched once and never updated. */
143 /** Overwrites output detection (for testing), see src/fake_outputs.c */
146 /** Automatic workspace back and forth switching. If this is set, a
147 * switch to the currently active workspace will switch to the
148 * previously focused one instead, making it possible to fast toggle
149 * between two workspaces. */
150 bool workspace_auto_back_and_forth;
152 /** By default, urgency is cleared immediately when switching to another
153 * workspace leads to focusing the con with the urgency hint. When having
154 * multiple windows on that workspace, the user needs to guess which
155 * application raised the event. To prevent this, the reset of the urgency
156 * flag can be delayed using an urgency timer. */
157 float workspace_urgency_timer;
159 /** The default border style for new windows. */
160 border_style_t default_border;
162 /** The default border style for new floating windows. */
163 border_style_t default_floating_border;
165 /** The modifier which needs to be pressed in combination with your mouse
166 * buttons to do things with floating windows (move, resize) */
167 uint32_t floating_modifier;
169 /** Maximum and minimum dimensions of a floating window */
170 int32_t floating_maximum_width;
171 int32_t floating_maximum_height;
172 int32_t floating_minimum_width;
173 int32_t floating_minimum_height;
175 /* Color codes are stored here */
176 struct config_client {
178 struct Colortriple focused;
179 struct Colortriple focused_inactive;
180 struct Colortriple unfocused;
181 struct Colortriple urgent;
182 struct Colortriple placeholder;
185 struct Colortriple focused;
186 struct Colortriple unfocused;
187 struct Colortriple urgent;
190 /** What should happen when a new popup is opened during fullscreen mode */
192 /* display (and focus) the popup when it belongs to the fullscreen
196 /* leave fullscreen mode unconditionally */
197 PDF_LEAVE_FULLSCREEN = 1,
199 /* just ignore the popup, that is, don’t map it */
201 } popup_during_fullscreen;
203 /* The number of currently parsed barconfigs */
204 int number_barconfigs;
208 * Holds the status bar configuration (i3bar). One of these structures is
209 * created for each 'bar' block in the config.
213 /** Automatically generated ID for this bar config. Used by the bar process
214 * to request a specific configuration. */
217 /** Number of outputs in the outputs array */
219 /** Outputs on which this bar should show up on. We use an array for
220 * simplicity (since we store just strings). */
223 /** Output on which the tray should be shown. The special value of 'no'
224 * disables the tray (it’s enabled by default). */
227 /** Path to the i3 IPC socket. This option is discouraged since programs
228 * can find out the path by looking for the I3_SOCKET_PATH property on the
232 /** Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mode) */
233 enum { M_DOCK = 0, M_HIDE = 1, M_INVISIBLE = 2 } mode;
235 /* The current hidden_state of the bar, which indicates whether it is hidden or shown */
236 enum { S_HIDE = 0, S_SHOW = 1 } hidden_state;
238 /** Bar modifier (to show bar when in hide mode). */
250 /** Bar position (bottom by default). */
251 enum { P_BOTTOM = 0, P_TOP = 1 } position;
253 /** Command that should be run to execute i3bar, give a full path if i3bar is not
255 * By default just 'i3bar' is executed. */
258 /** Command that should be run to get a statusline, for example 'i3status'.
259 * Will be passed to the shell. */
260 char *status_command;
262 /** Font specification for all text rendered on the bar. */
265 /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
266 * but we invert the bool to get the correct default when initializing with
268 bool hide_workspace_buttons;
270 /** Hide mode button? Configuration option is 'binding_mode_indicator no'
271 * but we invert the bool for the same reason as hide_workspace_buttons.*/
272 bool hide_binding_mode_indicator;
274 /** Enable verbose mode? Useful for debugging purposes. */
282 char *focused_workspace_border;
283 char *focused_workspace_bg;
284 char *focused_workspace_text;
286 char *active_workspace_border;
287 char *active_workspace_bg;
288 char *active_workspace_text;
290 char *inactive_workspace_border;
291 char *inactive_workspace_bg;
292 char *inactive_workspace_text;
294 char *urgent_workspace_border;
295 char *urgent_workspace_bg;
296 char *urgent_workspace_text;
299 TAILQ_ENTRY(Barconfig) configs;
303 * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
305 * If you specify override_configpath, only this path is used to look for a
306 * configuration file.
309 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
312 * Translates keysymbols to keycodes for all bindings which use keysyms.
315 void translate_keysyms(void);
318 * Ungrabs all keys, to be called before re-grabbing the keys because of a
319 * mapping_notify event or a configuration file reload
322 void ungrab_all_keys(xcb_connection_t *conn);
325 * Switches the key bindings to the given mode, if the mode exists
328 void switch_mode(const char *new_mode);
331 * Sends the current bar configuration as an event to all barconfig_update listeners.
332 * This update mechnism currently only includes the hidden_state and the mode in the config.
334 */void update_barconfig();
337 * Returns a pointer to the Binding with the specified modifiers and keycode
338 * or NULL if no such binding exists.
341 Binding *get_binding(uint16_t modifiers, bool key_release, xcb_keycode_t keycode);
344 * Kills the configerror i3-nagbar process, if any.
346 * Called when reloading/restarting.
348 * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
349 * ev is assumed to handle it (reloading).
352 void kill_configerror_nagbar(bool wait_for_it);