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 /** 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 /** The default border style for new windows. */
153 border_style_t default_border;
155 /** The default border style for new floating windows. */
156 border_style_t default_floating_border;
158 /** The modifier which needs to be pressed in combination with your mouse
159 * buttons to do things with floating windows (move, resize) */
160 uint32_t floating_modifier;
162 /** Maximum and minimum dimensions of a floating window */
163 int32_t floating_maximum_width;
164 int32_t floating_maximum_height;
165 int32_t floating_minimum_width;
166 int32_t floating_minimum_height;
168 /* Color codes are stored here */
169 struct config_client {
171 struct Colortriple focused;
172 struct Colortriple focused_inactive;
173 struct Colortriple unfocused;
174 struct Colortriple urgent;
177 struct Colortriple focused;
178 struct Colortriple unfocused;
179 struct Colortriple urgent;
182 /** What should happen when a new popup is opened during fullscreen mode */
184 PDF_LEAVE_FULLSCREEN = 0,
186 } popup_during_fullscreen;
190 * Holds the status bar configuration (i3bar). One of these structures is
191 * created for each 'bar' block in the config.
195 /** Automatically generated ID for this bar config. Used by the bar process
196 * to request a specific configuration. */
199 /** Number of outputs in the outputs array */
201 /** Outputs on which this bar should show up on. We use an array for
202 * simplicity (since we store just strings). */
205 /** Output on which the tray should be shown. The special value of 'no'
206 * disables the tray (it’s enabled by default). */
209 /** Path to the i3 IPC socket. This option is discouraged since programs
210 * can find out the path by looking for the I3_SOCKET_PATH property on the
214 /** Bar display mode (hide unless modifier is pressed or show in dock mode) */
215 enum { M_DOCK = 0, M_HIDE = 1 } mode;
217 /** Bar modifier (to show bar when in hide mode). */
229 /** Bar position (bottom by default). */
230 enum { P_BOTTOM = 0, P_TOP = 1 } position;
232 /** Command that should be run to execute i3bar, give a full path if i3bar is not
234 * By default just 'i3bar' is executed. */
237 /** Command that should be run to get a statusline, for example 'i3status'.
238 * Will be passed to the shell. */
239 char *status_command;
241 /** Font specification for all text rendered on the bar. */
244 /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
245 * but we invert the bool to get the correct default when initializing with
247 bool hide_workspace_buttons;
249 /** Enable verbose mode? Useful for debugging purposes. */
256 char *focused_workspace_border;
257 char *focused_workspace_bg;
258 char *focused_workspace_text;
260 char *active_workspace_border;
261 char *active_workspace_bg;
262 char *active_workspace_text;
264 char *inactive_workspace_border;
265 char *inactive_workspace_bg;
266 char *inactive_workspace_text;
268 char *urgent_workspace_border;
269 char *urgent_workspace_bg;
270 char *urgent_workspace_text;
273 TAILQ_ENTRY(Barconfig) configs;
277 * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
279 * If you specify override_configpath, only this path is used to look for a
280 * configuration file.
283 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
286 * Translates keysymbols to keycodes for all bindings which use keysyms.
289 void translate_keysyms(void);
292 * Ungrabs all keys, to be called before re-grabbing the keys because of a
293 * mapping_notify event or a configuration file reload
296 void ungrab_all_keys(xcb_connection_t *conn);
299 * Grab the bound keys (tell X to send us keypress events for those keycodes)
302 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch);
305 * Switches the key bindings to the given mode, if the mode exists
308 void switch_mode(const char *new_mode);
311 * Returns a pointer to the Binding with the specified modifiers and keycode
312 * or NULL if no such binding exists.
315 Binding *get_binding(uint16_t modifiers, bool key_release, xcb_keycode_t keycode);
318 * Kills the configerror i3-nagbar process, if any.
320 * Called when reloading/restarting.
322 * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
323 * ev is assumed to handle it (reloading).
326 void kill_configerror_nagbar(bool wait_for_it);
328 /* prototype for src/cfgparse.y */
329 void parse_file(const char *f);