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-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 #ifndef I3_CONFIG_H
  14 #define I3_CONFIG_H
  15
  16 #include <stdbool.h>
  17 #include "queue.h"
  18 #include "i3.h"
  19 #include "libi3.h"
  20
  21 typedef struct Config Config;
  22 typedef struct Barconfig Barconfig;
  23 extern char *current_configpath;
  24 extern Config config;
  25 extern SLIST_HEAD(modes_head, Mode) modes;
  26 extern TAILQ_HEAD(barconfig_head, Barconfig) barconfigs;
  27
  28 /**
  29  * Used during the config file lexing/parsing to keep the state of the lexer
  30  * in order to provide useful error messages in yyerror().
  31  *
  32  */
  33 struct context {
  34     bool has_errors;
  35     bool has_warnings;
  36
  37     int line_number;
  38     char *line_copy;
  39     const char *filename;
  40
  41     char *compact_error;
  42
  43     /* These are the same as in YYLTYPE */
  44     int first_column;
  45     int last_column;
  46 };
  47
  48 /**
  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).
  51  *
  52  */
  53 struct Colortriple {
  54     uint32_t border;
  55     uint32_t background;
  56     uint32_t text;
  57     uint32_t indicator;
  58 };
  59
  60 /**
  61  * Holds a user-assigned variable for parsing the configuration file. The key
  62  * is replaced by value in every following line of the file.
  63  *
  64  */
  65 struct Variable {
  66     char *key;
  67     char *value;
  68     char *next_match;
  69
  70     SLIST_ENTRY(Variable) variables;
  71 };
  72
  73 /**
  74  * The configuration file can contain multiple sets of bindings. Apart from the
  75  * default set (name == "default"), you can specify other sets and change the
  76  * currently active set of bindings by using the "mode <name>" command.
  77  *
  78  */
  79 struct Mode {
  80     char *name;
  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
 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 him 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     /** Remove borders if they are adjacent to the screen edge.
 113      * This is useful if you are reaching scrollbar on the edge of the
 114      * screen or do not want to waste a single pixel of displayspace.
 115      * By default, this is disabled. */
 116     adjacent_t hide_edge_borders;
 117
 118     /** By default, a workspace bar is drawn at the bottom of the screen.
 119      * If you want to have a more fancy bar, it is recommended to replace
 120      * the whole bar by dzen2, for example using the i3-wsbar script which
 121      * comes with i3. Thus, you can turn it off entirely. */
 122     bool disable_workspace_bar;
 123
 124     /** Think of the following layout: Horizontal workspace with a tabbed
 125      * con on the left of the screen and a terminal on the right of the
 126      * screen. You are in the second container in the tabbed container and
 127      * focus to the right. By default, i3 will set focus to the terminal on
 128      * the right. If you are in the first container in the tabbed container
 129      * however, focusing to the left will wrap. This option forces i3 to
 130      * always wrap, which will result in you having to use "focus parent"
 131      * more often. */
 132     bool force_focus_wrapping;
 133
 134     /** By default, use the RandR API for multi-monitor setups.
 135      * Unfortunately, the nVidia binary graphics driver doesn't support
 136      * this API. Instead, it only support the less powerful Xinerama API,
 137      * which can be enabled by this option.
 138      *
 139      * Note: this option takes only effect on the initial startup (eg.
 140      * reconfiguration is not possible). On startup, the list of screens
 141      * is fetched once and never updated. */
 142     bool force_xinerama;
 143
 144     /** Overwrites output detection (for testing), see src/fake_outputs.c */
 145     char *fake_outputs;
 146
 147     /** Automatic workspace back and forth switching. If this is set, a
 148      * switch to the currently active workspace will switch to the
 149      * previously focused one instead, making it possible to fast toggle
 150      * between two workspaces. */
 151     bool workspace_auto_back_and_forth;
 152
 153     /** By default, urgency is cleared immediately when switching to another
 154      * workspace leads to focusing the con with the urgency hint. When having
 155      * multiple windows on that workspace, the user needs to guess which
 156      * application raised the event. To prevent this, the reset of the urgency
 157      * flag can be delayed using an urgency timer. */
 158     float workspace_urgency_timer;
 159
 160     /** The default border style for new windows. */
 161     border_style_t default_border;
 162
 163     /** The default border style for new floating windows. */
 164     border_style_t default_floating_border;
 165
 166     /** The modifier which needs to be pressed in combination with your mouse
 167      * buttons to do things with floating windows (move, resize) */
 168     uint32_t floating_modifier;
 169
 170     /** Maximum and minimum dimensions of a floating window */
 171     int32_t floating_maximum_width;
 172     int32_t floating_maximum_height;
 173     int32_t floating_minimum_width;
 174     int32_t floating_minimum_height;
 175
 176     /* Color codes are stored here */
 177     struct config_client {
 178         uint32_t background;
 179         struct Colortriple focused;
 180         struct Colortriple focused_inactive;
 181         struct Colortriple unfocused;
 182         struct Colortriple urgent;
 183     } client;
 184     struct config_bar {
 185         struct Colortriple focused;
 186         struct Colortriple unfocused;
 187         struct Colortriple urgent;
 188     } bar;
 189
 190     /** What should happen when a new popup is opened during fullscreen mode */
 191     enum {
 192         /* display (and focus) the popup when it belongs to the fullscreen
 193          * window only. */
 194         PDF_SMART = 0,
 195
 196         /* leave fullscreen mode unconditionally */
 197         PDF_LEAVE_FULLSCREEN = 1,
 198
 199         /* just ignore the popup, that is, don’t map it */
 200         PDF_IGNORE = 2,
 201     } popup_during_fullscreen;
 202 };
 203
 204 /**
 205  * Holds the status bar configuration (i3bar). One of these structures is
 206  * created for each 'bar' block in the config.
 207  *
 208  */
 209 struct Barconfig {
 210     /** Automatically generated ID for this bar config. Used by the bar process
 211      * to request a specific configuration. */
 212     char *id;
 213
 214     /** Number of outputs in the outputs array */
 215     int num_outputs;
 216     /** Outputs on which this bar should show up on. We use an array for
 217      * simplicity (since we store just strings). */
 218     char **outputs;
 219
 220     /** Output on which the tray should be shown. The special value of 'no'
 221      * disables the tray (it’s enabled by default). */
 222     char *tray_output;
 223
 224     /** Path to the i3 IPC socket. This option is discouraged since programs
 225      * can find out the path by looking for the I3_SOCKET_PATH property on the
 226      * root window! */
 227     char *socket_path;
 228
 229     /** Bar display mode (hide unless modifier is pressed or show in dock mode) */
 230     enum { M_DOCK = 0, M_HIDE = 1 } mode;
 231
 232     /** Bar modifier (to show bar when in hide mode). */
 233     enum {
 234         M_NONE = 0,
 235         M_CONTROL = 1,
 236         M_SHIFT = 2,
 237         M_MOD1 = 3,
 238         M_MOD2 = 4,
 239         M_MOD3 = 5,
 240         M_MOD4 = 6,
 241         M_MOD5 = 7
 242     } modifier;
 243
 244     /** Bar position (bottom by default). */
 245     enum { P_BOTTOM = 0, P_TOP = 1 } position;
 246
 247     /** Command that should be run to execute i3bar, give a full path if i3bar is not
 248      * in your $PATH.
 249      * By default just 'i3bar' is executed. */
 250     char *i3bar_command;
 251
 252     /** Command that should be run to get a statusline, for example 'i3status'.
 253      * Will be passed to the shell. */
 254     char *status_command;
 255
 256     /** Font specification for all text rendered on the bar. */
 257     char *font;
 258
 259     /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
 260      * but we invert the bool to get the correct default when initializing with
 261      * zero. */
 262     bool hide_workspace_buttons;
 263
 264     /** Enable verbose mode? Useful for debugging purposes. */
 265     bool verbose;
 266
 267     struct bar_colors {
 268         char *background;
 269         char *statusline;
 270         char *separator;
 271
 272         char *focused_workspace_border;
 273         char *focused_workspace_bg;
 274         char *focused_workspace_text;
 275
 276         char *active_workspace_border;
 277         char *active_workspace_bg;
 278         char *active_workspace_text;
 279
 280         char *inactive_workspace_border;
 281         char *inactive_workspace_bg;
 282         char *inactive_workspace_text;
 283
 284         char *urgent_workspace_border;
 285         char *urgent_workspace_bg;
 286         char *urgent_workspace_text;
 287     } colors;
 288
 289     TAILQ_ENTRY(Barconfig) configs;
 290 };
 291
 292 /**
 293  * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
 294  *
 295  * If you specify override_configpath, only this path is used to look for a
 296  * configuration file.
 297  *
 298  */
 299 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
 300
 301 /**
 302  * Translates keysymbols to keycodes for all bindings which use keysyms.
 303  *
 304  */
 305 void translate_keysyms(void);
 306
 307 /**
 308  * Ungrabs all keys, to be called before re-grabbing the keys because of a
 309  * mapping_notify event or a configuration file reload
 310  *
 311  */
 312 void ungrab_all_keys(xcb_connection_t *conn);
 313
 314 /**
 315  * Grab the bound keys (tell X to send us keypress events for those keycodes)
 316  *
 317  */
 318 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch);
 319
 320 /**
 321  * Switches the key bindings to the given mode, if the mode exists
 322  *
 323  */
 324 void switch_mode(const char *new_mode);
 325
 326 /**
 327  * Returns a pointer to the Binding with the specified modifiers and keycode
 328  * or NULL if no such binding exists.
 329  *
 330  */
 331 Binding *get_binding(uint16_t modifiers, bool key_release, xcb_keycode_t keycode);
 332
 333 /**
 334  * Kills the configerror i3-nagbar process, if any.
 335  *
 336  * Called when reloading/restarting.
 337  *
 338  * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
 339  * ev is assumed to handle it (reloading).
 340  *
 341  */
 342 void kill_configerror_nagbar(bool wait_for_it);
 343
 344 #endif