git.sur5r.net Git - i3/i3/blob - include/config.h

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