]> git.sur5r.net Git - i3/i3/blob - include/config.h
release.sh: set up git remotes appropriately
[i3/i3] / include / config.h
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
6  *
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/config_parse.c) with the correct path, switching key
10  * bindings mode).
11  *
12  */
13 #pragma once
14
15 #include <stdbool.h>
16 #include "queue.h"
17 #include "i3.h"
18 #include "libi3.h"
19
20 typedef struct Config Config;
21 typedef struct Barconfig Barconfig;
22 extern char *current_configpath;
23 extern Config config;
24 extern SLIST_HEAD(modes_head, Mode) modes;
25 extern TAILQ_HEAD(barconfig_head, Barconfig) barconfigs;
26
27 /**
28  * Used during the config file lexing/parsing to keep the state of the lexer
29  * in order to provide useful error messages in yyerror().
30  *
31  */
32 struct context {
33     bool has_errors;
34     bool has_warnings;
35
36     int line_number;
37     char *line_copy;
38     const char *filename;
39
40     char *compact_error;
41
42     /* These are the same as in YYLTYPE */
43     int first_column;
44     int last_column;
45 };
46
47 /**
48  * Part of the struct Config. It makes sense to group colors for background,
49  * border and text as every element in i3 has them (window decorations, bar).
50  *
51  */
52 struct Colortriple {
53     uint32_t border;
54     uint32_t background;
55     uint32_t text;
56     uint32_t indicator;
57 };
58
59 /**
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.
62  *
63  */
64 struct Variable {
65     char *key;
66     char *value;
67     char *next_match;
68
69     SLIST_ENTRY(Variable) variables;
70 };
71
72 /**
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.
76  *
77  */
78 struct Mode {
79     char *name;
80     struct bindings_head *bindings;
81
82     SLIST_ENTRY(Mode) modes;
83 };
84
85 /**
86  * Holds part of the configuration (the part which is not already in dedicated
87  * structures in include/data.h).
88  *
89  */
90 struct Config {
91     const char *terminal;
92     i3Font font;
93
94     char *ipc_socket_path;
95     const char *restart_state_path;
96
97     layout_t default_layout;
98     int container_stack_limit;
99     int container_stack_limit_value;
100     int default_border_width;
101     int default_floating_border_width;
102
103     /** Default orientation for new containers */
104     int default_orientation;
105
106     /** By default, focus follows mouse. If the user explicitly wants to
107      * turn this off (and instead rely only on the keyboard for changing
108      * focus), we allow them to do this with this relatively special option.
109      * It is not planned to add any different focus models. */
110     bool disable_focus_follows_mouse;
111
112     /** By default, when switching focus to a window on a different output
113      * (e.g. focusing a window on workspace 3 on output VGA-1, coming from
114      * workspace 2 on LVDS-1), the mouse cursor is warped to the center of
115      * that window.
116      *
117      * With the mouse_warping option, you can control when the mouse cursor
118      * should be warped. "none" disables warping entirely, whereas "output"
119      * is the default behavior described above. */
120     warping_t mouse_warping;
121
122     /** Remove borders if they are adjacent to the screen edge.
123      * This is useful if you are reaching scrollbar on the edge of the
124      * screen or do not want to waste a single pixel of displayspace.
125      * By default, this is disabled. */
126     adjacent_t hide_edge_borders;
127
128     /** By default, a workspace bar is drawn at the bottom of the screen.
129      * If you want to have a more fancy bar, it is recommended to replace
130      * the whole bar by dzen2, for example using the i3-wsbar script which
131      * comes with i3. Thus, you can turn it off entirely. */
132     bool disable_workspace_bar;
133
134     /** Think of the following layout: Horizontal workspace with a tabbed
135      * con on the left of the screen and a terminal on the right of the
136      * screen. You are in the second container in the tabbed container and
137      * focus to the right. By default, i3 will set focus to the terminal on
138      * the right. If you are in the first container in the tabbed container
139      * however, focusing to the left will wrap. This option forces i3 to
140      * always wrap, which will result in you having to use "focus parent"
141      * more often. */
142     bool force_focus_wrapping;
143
144     /** By default, use the RandR API for multi-monitor setups.
145      * Unfortunately, the nVidia binary graphics driver doesn't support
146      * this API. Instead, it only support the less powerful Xinerama API,
147      * which can be enabled by this option.
148      *
149      * Note: this option takes only effect on the initial startup (eg.
150      * reconfiguration is not possible). On startup, the list of screens
151      * is fetched once and never updated. */
152     bool force_xinerama;
153
154     /** Overwrites output detection (for testing), see src/fake_outputs.c */
155     char *fake_outputs;
156
157     /** Automatic workspace back and forth switching. If this is set, a
158      * switch to the currently active workspace will switch to the
159      * previously focused one instead, making it possible to fast toggle
160      * between two workspaces. */
161     bool workspace_auto_back_and_forth;
162
163     /** By default, urgency is cleared immediately when switching to another
164      * workspace leads to focusing the con with the urgency hint. When having
165      * multiple windows on that workspace, the user needs to guess which
166      * application raised the event. To prevent this, the reset of the urgency
167      * flag can be delayed using an urgency timer. */
168     float workspace_urgency_timer;
169
170     /** The default border style for new windows. */
171     border_style_t default_border;
172
173     /** The default border style for new floating windows. */
174     border_style_t default_floating_border;
175
176     /** The modifier which needs to be pressed in combination with your mouse
177      * buttons to do things with floating windows (move, resize) */
178     uint32_t floating_modifier;
179
180     /** Maximum and minimum dimensions of a floating window */
181     int32_t floating_maximum_width;
182     int32_t floating_maximum_height;
183     int32_t floating_minimum_width;
184     int32_t floating_minimum_height;
185
186     /* Color codes are stored here */
187     struct config_client {
188         uint32_t background;
189         struct Colortriple focused;
190         struct Colortriple focused_inactive;
191         struct Colortriple unfocused;
192         struct Colortriple urgent;
193         struct Colortriple placeholder;
194     } client;
195     struct config_bar {
196         struct Colortriple focused;
197         struct Colortriple unfocused;
198         struct Colortriple urgent;
199     } bar;
200
201     /** What should happen when a new popup is opened during fullscreen mode */
202     enum {
203         /* display (and focus) the popup when it belongs to the fullscreen
204          * window only. */
205         PDF_SMART = 0,
206
207         /* leave fullscreen mode unconditionally */
208         PDF_LEAVE_FULLSCREEN = 1,
209
210         /* just ignore the popup, that is, don’t map it */
211         PDF_IGNORE = 2,
212     } popup_during_fullscreen;
213
214     /* The number of currently parsed barconfigs */
215     int number_barconfigs;
216 };
217
218 /**
219  * Holds the status bar configuration (i3bar). One of these structures is
220  * created for each 'bar' block in the config.
221  *
222  */
223 struct Barconfig {
224     /** Automatically generated ID for this bar config. Used by the bar process
225      * to request a specific configuration. */
226     char *id;
227
228     /** Number of outputs in the outputs array */
229     int num_outputs;
230     /** Outputs on which this bar should show up on. We use an array for
231      * simplicity (since we store just strings). */
232     char **outputs;
233
234     /** Output on which the tray should be shown. The special value of 'no'
235      * disables the tray (it’s enabled by default). */
236     char *tray_output;
237
238     /** Path to the i3 IPC socket. This option is discouraged since programs
239      * can find out the path by looking for the I3_SOCKET_PATH property on the
240      * root window! */
241     char *socket_path;
242
243     /** Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mode) */
244     enum { M_DOCK = 0,
245            M_HIDE = 1,
246            M_INVISIBLE = 2 } mode;
247
248     /* The current hidden_state of the bar, which indicates whether it is hidden or shown */
249     enum { S_HIDE = 0,
250            S_SHOW = 1 } hidden_state;
251
252     /** Bar modifier (to show bar when in hide mode). */
253     enum {
254         M_NONE = 0,
255         M_CONTROL = 1,
256         M_SHIFT = 2,
257         M_MOD1 = 3,
258         M_MOD2 = 4,
259         M_MOD3 = 5,
260         M_MOD4 = 6,
261         M_MOD5 = 7
262     } modifier;
263
264     /** Command that should be run when mouse wheel up button is pressed over
265      * i3bar to override the default behavior. */
266     char *wheel_up_cmd;
267
268     /** Command that should be run when mouse wheel down button is pressed over
269      * i3bar to override the default behavior. */
270     char *wheel_down_cmd;
271
272     /** Bar position (bottom by default). */
273     enum { P_BOTTOM = 0,
274            P_TOP = 1 } position;
275
276     /** Command that should be run to execute i3bar, give a full path if i3bar is not
277      * in your $PATH.
278      * By default just 'i3bar' is executed. */
279     char *i3bar_command;
280
281     /** Command that should be run to get a statusline, for example 'i3status'.
282      * Will be passed to the shell. */
283     char *status_command;
284
285     /** Font specification for all text rendered on the bar. */
286     char *font;
287
288     /** A custom separator to use instead of a vertical line. */
289     char *separator_symbol;
290
291     /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
292      * but we invert the bool to get the correct default when initializing with
293      * zero. */
294     bool hide_workspace_buttons;
295
296     /** Strip workspace numbers? Configuration option is
297      * 'strip_workspace_numbers yes'. */
298     bool strip_workspace_numbers;
299
300     /** Hide mode button? Configuration option is 'binding_mode_indicator no'
301      * but we invert the bool for the same reason as hide_workspace_buttons.*/
302     bool hide_binding_mode_indicator;
303
304     /** Enable verbose mode? Useful for debugging purposes. */
305     bool verbose;
306
307     struct bar_colors {
308         char *background;
309         char *statusline;
310         char *separator;
311
312         char *focused_workspace_border;
313         char *focused_workspace_bg;
314         char *focused_workspace_text;
315
316         char *active_workspace_border;
317         char *active_workspace_bg;
318         char *active_workspace_text;
319
320         char *inactive_workspace_border;
321         char *inactive_workspace_bg;
322         char *inactive_workspace_text;
323
324         char *urgent_workspace_border;
325         char *urgent_workspace_bg;
326         char *urgent_workspace_text;
327     } colors;
328
329     TAILQ_ENTRY(Barconfig) configs;
330 };
331
332 /**
333  * Finds the configuration file to use (either the one specified by
334  * override_configpath), the user’s one or the system default) and calls
335  * parse_file().
336  *
337  * If you specify override_configpath, only this path is used to look for a
338  * configuration file.
339  *
340  * If use_nagbar is false, don't try to start i3-nagbar but log the errors to
341  * stdout/stderr instead.
342  *
343  */
344 bool parse_configuration(const char *override_configpath, bool use_nagbar);
345
346 /**
347  * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
348  *
349  * If you specify override_configpath, only this path is used to look for a
350  * configuration file.
351  *
352  */
353 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
354
355 /**
356  * Ungrabs all keys, to be called before re-grabbing the keys because of a
357  * mapping_notify event or a configuration file reload
358  *
359  */
360 void ungrab_all_keys(xcb_connection_t *conn);
361
362 /**
363  * Sends the current bar configuration as an event to all barconfig_update listeners.
364  *
365  */
366 void update_barconfig();
367
368 /**
369  * Kills the configerror i3-nagbar process, if any.
370  *
371  * Called when reloading/restarting.
372  *
373  * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
374  * ev is assumed to handle it (reloading).
375  *
376  */
377 void kill_configerror_nagbar(bool wait_for_it);