git.sur5r.net Git - i3/i3/blob - include/config.h

   1 /*
   2  * vim:ts=8:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * © 2009-2010 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  * include/config.h: Contains all structs/variables for the configurable
  11  * part of i3 as well as functions handling the configuration file (calling
  12  * the parser (src/cfgparse.y) with the correct path, switching key bindings
  13  * mode).
  14  *
  15  */
  16
  17 #ifndef _CONFIG_H
  18 #define _CONFIG_H
  19
  20 #include <stdbool.h>
  21 #include "queue.h"
  22 #include "i3.h"
  23
  24 typedef struct Config Config;
  25 extern char *current_configpath;
  26 extern Config config;
  27 extern SLIST_HEAD(modes_head, Mode) modes;
  28
  29 /**
  30  * Used during the config file lexing/parsing to keep the state of the lexer
  31  * in order to provide useful error messages in yyerror().
  32  *
  33  */
  34 struct context {
  35         bool has_errors;
  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  * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
 175  *
 176  * If you specify override_configpath, only this path is used to look for a
 177  * configuration file.
 178  *
 179  */
 180 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
 181
 182 /**
 183  * Translates keysymbols to keycodes for all bindings which use keysyms.
 184  *
 185  */
 186 void translate_keysyms();
 187
 188 /**
 189  * Ungrabs all keys, to be called before re-grabbing the keys because of a
 190  * mapping_notify event or a configuration file reload
 191  *
 192  */
 193 void ungrab_all_keys(xcb_connection_t *conn);
 194
 195 /**
 196  * Grab the bound keys (tell X to send us keypress events for those keycodes)
 197  *
 198  */
 199 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch);
 200
 201 /**
 202  * Switches the key bindings to the given mode, if the mode exists
 203  *
 204  */
 205 void switch_mode(const char *new_mode);
 206
 207 /**
 208  * Returns a pointer to the Binding with the specified modifiers and keycode
 209  * or NULL if no such binding exists.
 210  *
 211  */
 212 Binding *get_binding(uint16_t modifiers, xcb_keycode_t keycode);
 213
 214 /**
 215  * Kills the configerror i3-nagbar process, if any.
 216  *
 217  * Called when reloading/restarting.
 218  *
 219  * If wait_for_it is set (restarting), this function will waitpid(), otherwise,
 220  * ev is assumed to handle it (reloading).
 221  *
 222  */
 223 void kill_configerror_nagbar(bool wait_for_it);
 224
 225 /* prototype for src/cfgparse.y */
 226 void parse_file(const char *f);
 227
 228 #endif