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