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/cfgparse.y) with the correct path, switching key bindings
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).
61 * Holds a user-assigned variable for parsing the configuration file. The key
62 * is replaced by value in every following line of the file.
70 SLIST_ENTRY(Variable) variables;
74 * The configuration file can contain multiple sets of bindings. Apart from the
75 * default set (name == "default"), you can specify other sets and change the
76 * 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;
99 int container_stack_limit;
100 int container_stack_limit_value;
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 /** By default, a workspace bar is drawn at the bottom of the screen.
112 * If you want to have a more fancy bar, it is recommended to replace
113 * the whole bar by dzen2, for example using the i3-wsbar script which
114 * comes with i3. Thus, you can turn it off entirely. */
115 bool disable_workspace_bar;
117 /** Think of the following layout: Horizontal workspace with a tabbed
118 * con on the left of the screen and a terminal on the right of the
119 * screen. You are in the second container in the tabbed container and
120 * focus to the right. By default, i3 will set focus to the terminal on
121 * the right. If you are in the first container in the tabbed container
122 * however, focusing to the left will wrap. This option forces i3 to
123 * always wrap, which will result in you having to use "focus parent"
125 bool force_focus_wrapping;
127 /** By default, use the RandR API for multi-monitor setups.
128 * Unfortunately, the nVidia binary graphics driver doesn't support
129 * this API. Instead, it only support the less powerful Xinerama API,
130 * which can be enabled by this option.
132 * Note: this option takes only effect on the initial startup (eg.
133 * reconfiguration is not possible). On startup, the list of screens
134 * is fetched once and never updated. */
137 /** Overwrites output detection (for testing), see src/fake_outputs.c */
140 /** Automatic workspace back and forth switching. If this is set, a
141 * switch to the currently active workspace will switch to the
142 * previously focused one instead, making it possible to fast toggle
143 * between two workspaces. */
144 bool workspace_auto_back_and_forth;
146 /** The default border style for new windows. */
147 border_style_t default_border;
149 /** The default border style for new floating windows. */
150 border_style_t default_floating_border;
152 /** The modifier which needs to be pressed in combination with your mouse
153 * buttons to do things with floating windows (move, resize) */
154 uint32_t floating_modifier;
156 /** Maximum and minimum dimensions of a floating window */
157 int32_t floating_maximum_width;
158 int32_t floating_maximum_height;
159 int32_t floating_minimum_width;
160 int32_t floating_minimum_height;
162 /* Color codes are stored here */
163 struct config_client {
165 struct Colortriple focused;
166 struct Colortriple focused_inactive;
167 struct Colortriple unfocused;
168 struct Colortriple urgent;
171 struct Colortriple focused;
172 struct Colortriple unfocused;
173 struct Colortriple urgent;
176 /** What should happen when a new popup is opened during fullscreen mode */
178 PDF_LEAVE_FULLSCREEN = 0,
180 } popup_during_fullscreen;
184 * Holds the status bar configuration (i3bar). One of these structures is
185 * created for each 'bar' block in the config.
189 /** Automatically generated ID for this bar config. Used by the bar process
190 * to request a specific configuration. */
193 /** Number of outputs in the outputs array */
195 /** Outputs on which this bar should show up on. We use an array for
196 * simplicity (since we store just strings). */
199 /** Output on which the tray should be shown. The special value of 'no'
200 * disables the tray (it’s enabled by default). */
203 /** Path to the i3 IPC socket. This option is discouraged since programs
204 * can find out the path by looking for the I3_SOCKET_PATH property on the
208 /** Bar display mode (hide unless modifier is pressed or show in dock mode) */
209 enum { M_DOCK = 0, M_HIDE = 1 } mode;
211 /** Bar modifier (to show bar when in hide mode). */
223 /** Bar position (bottom by default). */
224 enum { P_BOTTOM = 0, P_TOP = 1 } position;
226 /** Command that should be run to execute i3bar, give a full path if i3bar is not
228 * By default just 'i3bar' is executed. */
231 /** Command that should be run to get a statusline, for example 'i3status'.
232 * Will be passed to the shell. */
233 char *status_command;
235 /** Font specification for all text rendered on the bar. */
238 /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
239 * but we invert the bool to get the correct default when initializing with
241 bool hide_workspace_buttons;
243 /** Enable verbose mode? Useful for debugging purposes. */
250 char *focused_workspace_border;
251 char *focused_workspace_bg;
252 char *focused_workspace_text;
254 char *active_workspace_border;
255 char *active_workspace_bg;
256 char *active_workspace_text;
258 char *inactive_workspace_border;
259 char *inactive_workspace_bg;
260 char *inactive_workspace_text;
262 char *urgent_workspace_border;
263 char *urgent_workspace_bg;
264 char *urgent_workspace_text;
267 TAILQ_ENTRY(Barconfig) configs;
271 * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
273 * If you specify override_configpath, only this path is used to look for a
274 * configuration file.
277 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
280 * Translates keysymbols to keycodes for all bindings which use keysyms.
283 void translate_keysyms(void);
286 * Ungrabs all keys, to be called before re-grabbing the keys because of a
287 * mapping_notify event or a configuration file reload
290 void ungrab_all_keys(xcb_connection_t *conn);
293 * Grab the bound keys (tell X to send us keypress events for those keycodes)
296 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch);
299 * Switches the key bindings to the given mode, if the mode exists
302 void switch_mode(const char *new_mode);
305 * Returns a pointer to the Binding with the specified modifiers and keycode
306 * or NULL if no such binding exists.
309 Binding *get_binding(uint16_t modifiers, xcb_keycode_t keycode);
312 * Kills the configerror i3-nagbar process, if any.
314 * Called when reloading/restarting.
316 * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
317 * ev is assumed to handle it (reloading).
320 void kill_configerror_nagbar(bool wait_for_it);
322 /* prototype for src/cfgparse.y */
323 void parse_file(const char *f);