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;
27 /* defined in src/cfgparse.y */
28 extern bool force_old_config_parser;
31 * Used during the config file lexing/parsing to keep the state of the lexer
32 * in order to provide useful error messages in yyerror().
45 /* These are the same as in YYLTYPE */
51 * Part of the struct Config. It makes sense to group colors for background,
52 * 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.
72 SLIST_ENTRY(Variable) variables;
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.
83 struct bindings_head *bindings;
85 SLIST_ENTRY(Mode) modes;
89 * Holds part of the configuration (the part which is not already in dedicated
90 * structures in include/data.h).
97 char *ipc_socket_path;
98 const char *restart_state_path;
101 int container_stack_limit;
102 int container_stack_limit_value;
103 int default_border_width;
105 /** Default orientation for new containers */
106 int default_orientation;
108 /** By default, focus follows mouse. If the user explicitly wants to
109 * turn this off (and instead rely only on the keyboard for changing
110 * focus), we allow him to do this with this relatively special option.
111 * It is not planned to add any different focus models. */
112 bool disable_focus_follows_mouse;
114 /** Remove borders if they are adjacent to the screen edge.
115 * This is useful if you are reaching scrollbar on the edge of the
116 * screen or do not want to waste a single pixel of displayspace.
117 * By default, this is disabled. */
118 adjacent_t hide_edge_borders;
120 /** By default, a workspace bar is drawn at the bottom of the screen.
121 * If you want to have a more fancy bar, it is recommended to replace
122 * the whole bar by dzen2, for example using the i3-wsbar script which
123 * comes with i3. Thus, you can turn it off entirely. */
124 bool disable_workspace_bar;
126 /** Think of the following layout: Horizontal workspace with a tabbed
127 * con on the left of the screen and a terminal on the right of the
128 * screen. You are in the second container in the tabbed container and
129 * focus to the right. By default, i3 will set focus to the terminal on
130 * the right. If you are in the first container in the tabbed container
131 * however, focusing to the left will wrap. This option forces i3 to
132 * always wrap, which will result in you having to use "focus parent"
134 bool force_focus_wrapping;
136 /** By default, use the RandR API for multi-monitor setups.
137 * Unfortunately, the nVidia binary graphics driver doesn't support
138 * this API. Instead, it only support the less powerful Xinerama API,
139 * which can be enabled by this option.
141 * Note: this option takes only effect on the initial startup (eg.
142 * reconfiguration is not possible). On startup, the list of screens
143 * is fetched once and never updated. */
146 /** Overwrites output detection (for testing), see src/fake_outputs.c */
149 /** Automatic workspace back and forth switching. If this is set, a
150 * switch to the currently active workspace will switch to the
151 * previously focused one instead, making it possible to fast toggle
152 * between two workspaces. */
153 bool workspace_auto_back_and_forth;
155 /** By default, urgency is cleared immediately when switching to another
156 * workspace leads to focusing the con with the urgency hint. When having
157 * multiple windows on that workspace, the user needs to guess which
158 * application raised the event. To prevent this, the reset of the urgency
159 * flag can be delayed using an urgency timer. */
160 float workspace_urgency_timer;
162 /** The default border style for new windows. */
163 border_style_t default_border;
165 /** The default border style for new floating windows. */
166 border_style_t default_floating_border;
168 /** The modifier which needs to be pressed in combination with your mouse
169 * buttons to do things with floating windows (move, resize) */
170 uint32_t floating_modifier;
172 /** Maximum and minimum dimensions of a floating window */
173 int32_t floating_maximum_width;
174 int32_t floating_maximum_height;
175 int32_t floating_minimum_width;
176 int32_t floating_minimum_height;
178 /* Color codes are stored here */
179 struct config_client {
181 struct Colortriple focused;
182 struct Colortriple focused_inactive;
183 struct Colortriple unfocused;
184 struct Colortriple urgent;
187 struct Colortriple focused;
188 struct Colortriple unfocused;
189 struct Colortriple urgent;
192 /** What should happen when a new popup is opened during fullscreen mode */
194 /* display (and focus) the popup when it belongs to the fullscreen
198 /* leave fullscreen mode unconditionally */
199 PDF_LEAVE_FULLSCREEN = 1,
201 /* just ignore the popup, that is, don’t map it */
203 } popup_during_fullscreen;
207 * Holds the status bar configuration (i3bar). One of these structures is
208 * created for each 'bar' block in the config.
212 /** Automatically generated ID for this bar config. Used by the bar process
213 * to request a specific configuration. */
216 /** Number of outputs in the outputs array */
218 /** Outputs on which this bar should show up on. We use an array for
219 * simplicity (since we store just strings). */
222 /** Output on which the tray should be shown. The special value of 'no'
223 * disables the tray (it’s enabled by default). */
226 /** Path to the i3 IPC socket. This option is discouraged since programs
227 * can find out the path by looking for the I3_SOCKET_PATH property on the
231 /** Bar display mode (hide unless modifier is pressed or show in dock mode) */
232 enum { M_DOCK = 0, M_HIDE = 1 } mode;
234 /** Bar modifier (to show bar when in hide mode). */
246 /** Bar position (bottom by default). */
247 enum { P_BOTTOM = 0, P_TOP = 1 } position;
249 /** Command that should be run to execute i3bar, give a full path if i3bar is not
251 * By default just 'i3bar' is executed. */
254 /** Command that should be run to get a statusline, for example 'i3status'.
255 * Will be passed to the shell. */
256 char *status_command;
258 /** Font specification for all text rendered on the bar. */
261 /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
262 * but we invert the bool to get the correct default when initializing with
264 bool hide_workspace_buttons;
266 /** Enable verbose mode? Useful for debugging purposes. */
273 char *focused_workspace_border;
274 char *focused_workspace_bg;
275 char *focused_workspace_text;
277 char *active_workspace_border;
278 char *active_workspace_bg;
279 char *active_workspace_text;
281 char *inactive_workspace_border;
282 char *inactive_workspace_bg;
283 char *inactive_workspace_text;
285 char *urgent_workspace_border;
286 char *urgent_workspace_bg;
287 char *urgent_workspace_text;
290 TAILQ_ENTRY(Barconfig) configs;
294 * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
296 * If you specify override_configpath, only this path is used to look for a
297 * configuration file.
300 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
303 * Translates keysymbols to keycodes for all bindings which use keysyms.
306 void translate_keysyms(void);
309 * Ungrabs all keys, to be called before re-grabbing the keys because of a
310 * mapping_notify event or a configuration file reload
313 void ungrab_all_keys(xcb_connection_t *conn);
316 * Grab the bound keys (tell X to send us keypress events for those keycodes)
319 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch);
322 * Switches the key bindings to the given mode, if the mode exists
325 void switch_mode(const char *new_mode);
328 * Returns a pointer to the Binding with the specified modifiers and keycode
329 * or NULL if no such binding exists.
332 Binding *get_binding(uint16_t modifiers, bool key_release, xcb_keycode_t keycode);
335 * Kills the configerror i3-nagbar process, if any.
337 * Called when reloading/restarting.
339 * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
340 * ev is assumed to handle it (reloading).
343 void kill_configerror_nagbar(bool wait_for_it);
345 /* prototype for src/cfgparse.y */
346 void parse_file(const char *f);