4 * i3 - an improved dynamic tiling window manager
6 * © 2009-2010 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * include/config.h: Contains all structs/variables for the configurable
11 * part of i3 as well as functions handling the configuration file (calling
12 * the parser (src/cfgparse.y) with the correct path, switching key bindings
24 typedef struct Config Config;
25 extern char *current_configpath;
27 extern SLIST_HEAD(modes_head, Mode) modes;
30 * Used during the config file lexing/parsing to keep the state of the lexer
31 * 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 /** The default border style for new windows. */
127 border_style_t default_border;
129 /** The default border style for new floating windows. */
130 border_style_t default_floating_border;
132 /** The modifier which needs to be pressed in combination with your mouse
133 * buttons to do things with floating windows (move, resize) */
134 uint32_t floating_modifier;
136 /* Color codes are stored here */
137 struct config_client {
139 struct Colortriple focused;
140 struct Colortriple focused_inactive;
141 struct Colortriple unfocused;
142 struct Colortriple urgent;
145 struct Colortriple focused;
146 struct Colortriple unfocused;
147 struct Colortriple urgent;
150 /** What should happen when a new popup is opened during fullscreen mode */
152 PDF_LEAVE_FULLSCREEN = 0,
154 } popup_during_fullscreen;
158 * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
160 * If you specify override_configpath, only this path is used to look for a
161 * configuration file.
164 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
167 * Translates keysymbols to keycodes for all bindings which use keysyms.
170 void translate_keysyms();
173 * Ungrabs all keys, to be called before re-grabbing the keys because of a
174 * mapping_notify event or a configuration file reload
177 void ungrab_all_keys(xcb_connection_t *conn);
180 * Grab the bound keys (tell X to send us keypress events for those keycodes)
183 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch);
186 * Switches the key bindings to the given mode, if the mode exists
189 void switch_mode(const char *new_mode);
192 * Returns a pointer to the Binding with the specified modifiers and keycode
193 * or NULL if no such binding exists.
196 Binding *get_binding(uint16_t modifiers, xcb_keycode_t keycode);
199 * Kills the configerror i3-nagbar process, if any.
201 * Called when reloading/restarting.
203 * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
204 * ev is assumed to handle it (reloading).
207 void kill_configerror_nagbar(bool wait_for_it);
209 /* prototype for src/cfgparse.y */
210 void parse_file(const char *f);