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     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     /** Behavior when a window sends a NET_ACTIVE_WINDOW message. */
 171     enum {
 172         /* Focus if the target workspace is visible, set urgency hint otherwise. */
 173         FOWA_SMART,
 174         /* Always set the urgency hint. */
 175         FOWA_URGENT,
 176         /* Always focus the window. */
 177         FOWA_FOCUS,
 178         /* Ignore the request (no focus, no urgency hint). */
 179         FOWA_NONE
 180     } focus_on_window_activation;
 181
 182     /** Specifies whether or not marks should be displayed in the window
 183      * decoration. Marks starting with a "_" will be ignored either way. */
 184     bool show_marks;
 185
 186     /** The default border style for new windows. */
 187     border_style_t default_border;
 188
 189     /** The default border style for new floating windows. */
 190     border_style_t default_floating_border;
 191
 192     /** The modifier which needs to be pressed in combination with your mouse
 193      * buttons to do things with floating windows (move, resize) */
 194     uint32_t floating_modifier;
 195
 196     /** Maximum and minimum dimensions of a floating window */
 197     int32_t floating_maximum_width;
 198     int32_t floating_maximum_height;
 199     int32_t floating_minimum_width;
 200     int32_t floating_minimum_height;
 201
 202     /* Color codes are stored here */
 203     struct config_client {
 204         uint32_t background;
 205         struct Colortriple focused;
 206         struct Colortriple focused_inactive;
 207         struct Colortriple unfocused;
 208         struct Colortriple urgent;
 209         struct Colortriple placeholder;
 210     } client;
 211     struct config_bar {
 212         struct Colortriple focused;
 213         struct Colortriple unfocused;
 214         struct Colortriple urgent;
 215     } bar;
 216
 217     /** What should happen when a new popup is opened during fullscreen mode */
 218     enum {
 219         /* display (and focus) the popup when it belongs to the fullscreen
 220          * window only. */
 221         PDF_SMART = 0,
 222
 223         /* leave fullscreen mode unconditionally */
 224         PDF_LEAVE_FULLSCREEN = 1,
 225
 226         /* just ignore the popup, that is, don’t map it */
 227         PDF_IGNORE = 2,
 228     } popup_during_fullscreen;
 229
 230     /* The number of currently parsed barconfigs */
 231     int number_barconfigs;
 232 };
 233
 234 /**
 235  * Holds the status bar configuration (i3bar). One of these structures is
 236  * created for each 'bar' block in the config.
 237  *
 238  */
 239 struct Barconfig {
 240     /** Automatically generated ID for this bar config. Used by the bar process
 241      * to request a specific configuration. */
 242     char *id;
 243
 244     /** Number of outputs in the outputs array */
 245     int num_outputs;
 246     /** Outputs on which this bar should show up on. We use an array for
 247      * simplicity (since we store just strings). */
 248     char **outputs;
 249
 250     /** Output on which the tray should be shown. The special value of 'no'
 251      * disables the tray (it’s enabled by default). */
 252     char *tray_output;
 253
 254     /* Padding around the tray icons. */
 255     int tray_padding;
 256
 257     /** Path to the i3 IPC socket. This option is discouraged since programs
 258      * can find out the path by looking for the I3_SOCKET_PATH property on the
 259      * root window! */
 260     char *socket_path;
 261
 262     /** Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mode) */
 263     enum { M_DOCK = 0,
 264            M_HIDE = 1,
 265            M_INVISIBLE = 2 } mode;
 266
 267     /* The current hidden_state of the bar, which indicates whether it is hidden or shown */
 268     enum { S_HIDE = 0,
 269            S_SHOW = 1 } hidden_state;
 270
 271     /** Bar modifier (to show bar when in hide mode). */
 272     enum {
 273         M_NONE = 0,
 274         M_CONTROL = 1,
 275         M_SHIFT = 2,
 276         M_MOD1 = 3,
 277         M_MOD2 = 4,
 278         M_MOD3 = 5,
 279         M_MOD4 = 6,
 280         M_MOD5 = 7
 281     } modifier;
 282
 283     TAILQ_HEAD(bar_bindings_head, Barbinding) bar_bindings;
 284
 285     /** Bar position (bottom by default). */
 286     enum { P_BOTTOM = 0,
 287            P_TOP = 1 } position;
 288
 289     /** Command that should be run to execute i3bar, give a full path if i3bar is not
 290      * in your $PATH.
 291      * By default just 'i3bar' is executed. */
 292     char *i3bar_command;
 293
 294     /** Command that should be run to get a statusline, for example 'i3status'.
 295      * Will be passed to the shell. */
 296     char *status_command;
 297
 298     /** Font specification for all text rendered on the bar. */
 299     char *font;
 300
 301     /** A custom separator to use instead of a vertical line. */
 302     char *separator_symbol;
 303
 304     /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
 305      * but we invert the bool to get the correct default when initializing with
 306      * zero. */
 307     bool hide_workspace_buttons;
 308
 309     /** Strip workspace numbers? Configuration option is
 310      * 'strip_workspace_numbers yes'. */
 311     bool strip_workspace_numbers;
 312
 313     /** Hide mode button? Configuration option is 'binding_mode_indicator no'
 314      * but we invert the bool for the same reason as hide_workspace_buttons.*/
 315     bool hide_binding_mode_indicator;
 316
 317     /** Enable verbose mode? Useful for debugging purposes. */
 318     bool verbose;
 319
 320     struct bar_colors {
 321         char *background;
 322         char *statusline;
 323         char *separator;
 324
 325         char *focused_workspace_border;
 326         char *focused_workspace_bg;
 327         char *focused_workspace_text;
 328
 329         char *active_workspace_border;
 330         char *active_workspace_bg;
 331         char *active_workspace_text;
 332
 333         char *inactive_workspace_border;
 334         char *inactive_workspace_bg;
 335         char *inactive_workspace_text;
 336
 337         char *urgent_workspace_border;
 338         char *urgent_workspace_bg;
 339         char *urgent_workspace_text;
 340
 341         char *binding_mode_border;
 342         char *binding_mode_bg;
 343         char *binding_mode_text;
 344     } colors;
 345
 346     TAILQ_ENTRY(Barconfig) configs;
 347 };
 348
 349 /**
 350  * Defines a mouse command to be executed instead of the default behavior when
 351  * clicking on the non-statusline part of i3bar.
 352  *
 353  */
 354 struct Barbinding {
 355     /** The button to be used (e.g., 1 for "button1"). */
 356     int input_code;
 357
 358     /** The command which is to be executed for this button. */
 359     char *command;
 360
 361     TAILQ_ENTRY(Barbinding) bindings;
 362 };
 363
 364 /**
 365  * Finds the configuration file to use (either the one specified by
 366  * override_configpath), the user’s one or the system default) and calls
 367  * parse_file().
 368  *
 369  * If you specify override_configpath, only this path is used to look for a
 370  * configuration file.
 371  *
 372  * If use_nagbar is false, don't try to start i3-nagbar but log the errors to
 373  * stdout/stderr instead.
 374  *
 375  */
 376 bool parse_configuration(const char *override_configpath, bool use_nagbar);
 377
 378 /**
 379  * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
 380  *
 381  * If you specify override_configpath, only this path is used to look for a
 382  * configuration file.
 383  *
 384  */
 385 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
 386
 387 /**
 388  * Ungrabs all keys, to be called before re-grabbing the keys because of a
 389  * mapping_notify event or a configuration file reload
 390  *
 391  */
 392 void ungrab_all_keys(xcb_connection_t *conn);
 393
 394 /**
 395  * Sends the current bar configuration as an event to all barconfig_update listeners.
 396  *
 397  */
 398 void update_barconfig();
 399
 400 /**
 401  * Kills the configerror i3-nagbar process, if any.
 402  *
 403  * Called when reloading/restarting.
 404  *
 405  * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
 406  * ev is assumed to handle it (reloading).
 407  *
 408  */
 409 void kill_configerror_nagbar(bool wait_for_it);