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-2011 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 _CONFIG_H
  14 #define _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 };
  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     int default_layout;
  98     int container_stack_limit;
  99     int container_stack_limit_value;
 100
 101     /** Default orientation for new containers */
 102     int default_orientation;
 103
 104     /** By default, focus follows mouse. If the user explicitly wants to
 105      * turn this off (and instead rely only on the keyboard for changing
 106      * focus), we allow him to do this with this relatively special option.
 107      * It is not planned to add any different focus models. */
 108     bool disable_focus_follows_mouse;
 109
 110     /** By default, a workspace bar is drawn at the bottom of the screen.
 111      * If you want to have a more fancy bar, it is recommended to replace
 112      * the whole bar by dzen2, for example using the i3-wsbar script which
 113      * comes with i3. Thus, you can turn it off entirely. */
 114     bool disable_workspace_bar;
 115
 116     /** Think of the following layout: Horizontal workspace with a tabbed
 117      * con on the left of the screen and a terminal on the right of the
 118      * screen. You are in the second container in the tabbed container and
 119      * focus to the right. By default, i3 will set focus to the terminal on
 120      * the right. If you are in the first container in the tabbed container
 121      * however, focusing to the left will wrap. This option forces i3 to
 122      * always wrap, which will result in you having to use "focus parent"
 123      * more often. */
 124     bool force_focus_wrapping;
 125
 126     /** By default, use the RandR API for multi-monitor setups.
 127      * Unfortunately, the nVidia binary graphics driver doesn't support
 128      * this API. Instead, it only support the less powerful Xinerama API,
 129      * which can be enabled by this option.
 130      *
 131      * Note: this option takes only effect on the initial startup (eg.
 132      * reconfiguration is not possible). On startup, the list of screens
 133      * is fetched once and never updated. */
 134     bool force_xinerama;
 135
 136     /** Automatic workspace back and forth switching. If this is set, a
 137      * switch to the currently active workspace will switch to the
 138      * previously focused one instead, making it possible to fast toggle
 139      * between two workspaces. */
 140     bool workspace_auto_back_and_forth;
 141
 142     /** The default border style for new windows. */
 143     border_style_t default_border;
 144
 145     /** The default border style for new floating windows. */
 146     border_style_t default_floating_border;
 147
 148     /** The modifier which needs to be pressed in combination with your mouse
 149      * buttons to do things with floating windows (move, resize) */
 150     uint32_t floating_modifier;
 151
 152     /* Color codes are stored here */
 153     struct config_client {
 154         uint32_t background;
 155         struct Colortriple focused;
 156         struct Colortriple focused_inactive;
 157         struct Colortriple unfocused;
 158         struct Colortriple urgent;
 159     } client;
 160     struct config_bar {
 161         struct Colortriple focused;
 162         struct Colortriple unfocused;
 163         struct Colortriple urgent;
 164     } bar;
 165
 166     /** What should happen when a new popup is opened during fullscreen mode */
 167     enum {
 168         PDF_LEAVE_FULLSCREEN = 0,
 169         PDF_IGNORE = 1
 170     } popup_during_fullscreen;
 171 };
 172
 173 /**
 174  * Holds the status bar configuration (i3bar). One of these structures is
 175  * created for each 'bar' block in the config.
 176  *
 177  */
 178 struct Barconfig {
 179     /** Automatically generated ID for this bar config. Used by the bar process
 180      * to request a specific configuration. */
 181     char *id;
 182
 183     /** Number of outputs in the outputs array */
 184     int num_outputs;
 185     /** Outputs on which this bar should show up on. We use an array for
 186      * simplicity (since we store just strings). */
 187     char **outputs;
 188
 189     /** Output on which the tray should be shown. The special value of 'no'
 190      * disables the tray (it’s enabled by default). */
 191     char *tray_output;
 192
 193     /** Path to the i3 IPC socket. This option is discouraged since programs
 194      * can find out the path by looking for the I3_SOCKET_PATH property on the
 195      * root window! */
 196     char *socket_path;
 197
 198     /** Bar display mode (hide unless modifier is pressed or show in dock mode) */
 199     enum { M_DOCK = 0, M_HIDE = 1 } mode;
 200
 201     /** Bar modifier (to show bar when in hide mode). */
 202     enum {
 203         M_NONE = 0,
 204         M_CONTROL = 1,
 205         M_SHIFT = 2,
 206         M_MOD1 = 3,
 207         M_MOD2 = 4,
 208         M_MOD3 = 5,
 209         M_MOD4 = 6,
 210         M_MOD5 = 7
 211     } modifier;
 212
 213     /** Bar position (bottom by default). */
 214     enum { P_BOTTOM = 0, P_TOP = 1 } position;
 215
 216     /** Command that should be run to execute i3bar, give a full path if i3bar is not
 217      * in your $PATH.
 218      * By default just 'i3bar' is executed. */
 219     char *i3bar_command;
 220
 221     /** Command that should be run to get a statusline, for example 'i3status'.
 222      * Will be passed to the shell. */
 223     char *status_command;
 224
 225     /** Font specification for all text rendered on the bar. */
 226     char *font;
 227
 228     /** Hide workspace buttons? Configuration option is 'workspace_buttons no'
 229      * but we invert the bool to get the correct default when initializing with
 230      * zero. */
 231     bool hide_workspace_buttons;
 232
 233     /** Enable verbose mode? Useful for debugging purposes. */
 234     bool verbose;
 235
 236     struct bar_colors {
 237         char *background;
 238         char *statusline;
 239
 240         char *focused_workspace_text;
 241         char *focused_workspace_bg;
 242
 243         char *active_workspace_text;
 244         char *active_workspace_bg;
 245
 246         char *inactive_workspace_text;
 247         char *inactive_workspace_bg;
 248
 249         char *urgent_workspace_text;
 250         char *urgent_workspace_bg;
 251     } colors;
 252
 253     TAILQ_ENTRY(Barconfig) configs;
 254 };
 255
 256 /**
 257  * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
 258  *
 259  * If you specify override_configpath, only this path is used to look for a
 260  * configuration file.
 261  *
 262  */
 263 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
 264
 265 /**
 266  * Translates keysymbols to keycodes for all bindings which use keysyms.
 267  *
 268  */
 269 void translate_keysyms();
 270
 271 /**
 272  * Ungrabs all keys, to be called before re-grabbing the keys because of a
 273  * mapping_notify event or a configuration file reload
 274  *
 275  */
 276 void ungrab_all_keys(xcb_connection_t *conn);
 277
 278 /**
 279  * Grab the bound keys (tell X to send us keypress events for those keycodes)
 280  *
 281  */
 282 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch);
 283
 284 /**
 285  * Switches the key bindings to the given mode, if the mode exists
 286  *
 287  */
 288 void switch_mode(const char *new_mode);
 289
 290 /**
 291  * Returns a pointer to the Binding with the specified modifiers and keycode
 292  * or NULL if no such binding exists.
 293  *
 294  */
 295 Binding *get_binding(uint16_t modifiers, xcb_keycode_t keycode);
 296
 297 /**
 298  * Kills the configerror i3-nagbar process, if any.
 299  *
 300  * Called when reloading/restarting.
 301  *
 302  * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
 303  * ev is assumed to handle it (reloading).
 304  *
 305  */
 306 void kill_configerror_nagbar(bool wait_for_it);
 307
 308 /* prototype for src/cfgparse.y */
 309 void parse_file(const char *f);
 310
 311 #endif