2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2011 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).
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;
98 int container_stack_limit;
99 int container_stack_limit_value;
101 /** Default orientation for new containers */
102 int default_orientation;
104 /** By default, focus follows mouse. If the user explicitly wants to
105 * turn this off (and instead rely only on the keyboard for changing
106 * focus), we allow him to do this with this relatively special option.
107 * It is not planned to add any different focus models. */
108 bool disable_focus_follows_mouse;
110 /** By default, a workspace bar is drawn at the bottom of the screen.
111 * If you want to have a more fancy bar, it is recommended to replace
112 * the whole bar by dzen2, for example using the i3-wsbar script which
113 * comes with i3. Thus, you can turn it off entirely. */
114 bool disable_workspace_bar;
116 /** Think of the following layout: Horizontal workspace with a tabbed
117 * con on the left of the screen and a terminal on the right of the
118 * screen. You are in the second container in the tabbed container and
119 * focus to the right. By default, i3 will set focus to the terminal on
120 * the right. If you are in the first container in the tabbed container
121 * however, focusing to the left will wrap. This option forces i3 to
122 * always wrap, which will result in you having to use "focus parent"
124 bool force_focus_wrapping;
126 /** By default, use the RandR API for multi-monitor setups.
127 * Unfortunately, the nVidia binary graphics driver doesn't support
128 * this API. Instead, it only support the less powerful Xinerama API,
129 * which can be enabled by this option.
131 * Note: this option takes only effect on the initial startup (eg.
132 * reconfiguration is not possible). On startup, the list of screens
133 * is fetched once and never updated. */
136 /** Automatic workspace back and forth switching. If this is set, a
137 * switch to the currently active workspace will switch to the
138 * previously focused one instead, making it possible to fast toggle
139 * between two workspaces. */
140 bool workspace_auto_back_and_forth;
142 /** The default border style for new windows. */
143 border_style_t default_border;
145 /** The default border style for new floating windows. */
146 border_style_t default_floating_border;
148 /** The modifier which needs to be pressed in combination with your mouse
149 * buttons to do things with floating windows (move, resize) */
150 uint32_t floating_modifier;
152 /* Color codes are stored here */
153 struct config_client {
155 struct Colortriple focused;
156 struct Colortriple focused_inactive;
157 struct Colortriple unfocused;
158 struct Colortriple urgent;
161 struct Colortriple focused;
162 struct Colortriple unfocused;
163 struct Colortriple urgent;
166 /** What should happen when a new popup is opened during fullscreen mode */
168 PDF_LEAVE_FULLSCREEN = 0,
170 } popup_during_fullscreen;
174 * Holds the status bar configuration (i3bar). One of these structures is
175 * created for each 'bar' block in the config.
179 /** Automatically generated ID for this bar config. Used by the bar process
180 * to request a specific configuration. */
183 /** Number of outputs in the outputs array */
185 /** Outputs on which this bar should show up on. We use an array for
186 * simplicity (since we store just strings). */
189 /** Output on which the tray should be shown. The special value of 'no'
190 * disables the tray (it’s enabled by default). */
193 /** Path to the i3 IPC socket. This option is discouraged since programs
194 * can find out the path by looking for the I3_SOCKET_PATH property on the
198 /** Bar display mode (hide unless modifier is pressed or show in dock mode) */
199 enum { M_DOCK = 0, M_HIDE = 1 } mode;
201 /** Bar position (bottom by default). */
202 enum { P_BOTTOM = 0, P_TOP = 1 } position;
204 /** Command that should be run to execute i3bar, give a full path if i3bar is not
206 * By default just 'i3bar' is executed. */
209 /** Command that should be run to get a statusline, for example 'i3status'.
210 * Will be passed to the shell. */
211 char *status_command;
213 /** Font specification for all text rendered on the bar. */
216 /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
217 * but we invert the bool to get the correct default when initializing with
219 bool hide_workspace_buttons;
221 /** Enable verbose mode? Useful for debugging purposes. */
228 char *focused_workspace_text;
229 char *focused_workspace_bg;
231 char *active_workspace_text;
232 char *active_workspace_bg;
234 char *inactive_workspace_text;
235 char *inactive_workspace_bg;
237 char *urgent_workspace_text;
238 char *urgent_workspace_bg;
241 TAILQ_ENTRY(Barconfig) configs;
245 * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
247 * If you specify override_configpath, only this path is used to look for a
248 * configuration file.
251 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
254 * Translates keysymbols to keycodes for all bindings which use keysyms.
257 void translate_keysyms();
260 * Ungrabs all keys, to be called before re-grabbing the keys because of a
261 * mapping_notify event or a configuration file reload
264 void ungrab_all_keys(xcb_connection_t *conn);
267 * Grab the bound keys (tell X to send us keypress events for those keycodes)
270 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch);
273 * Switches the key bindings to the given mode, if the mode exists
276 void switch_mode(const char *new_mode);
279 * Returns a pointer to the Binding with the specified modifiers and keycode
280 * or NULL if no such binding exists.
283 Binding *get_binding(uint16_t modifiers, xcb_keycode_t keycode);
286 * Kills the configerror i3-nagbar process, if any.
288 * Called when reloading/restarting.
290 * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
291 * ev is assumed to handle it (reloading).
294 void kill_configerror_nagbar(bool wait_for_it);
296 /* prototype for src/cfgparse.y */
297 void parse_file(const char *f);