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