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