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 Config config;
  26 extern SLIST_HEAD(modes_head, Mode) modes;
  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         int line_number;
  35         char *line_copy;
  36         const char *filename;
  37
  38         const char *compact_error;
  39
  40         /* These are the same as in YYLTYPE */
  41         int first_column;
  42         int last_column;
  43 };
  44
  45 /**
  46  * Part of the struct Config. It makes sense to group colors for background,
  47  * border and text as every element in i3 has them (window decorations, bar).
  48  *
  49  */
  50 struct Colortriple {
  51         uint32_t border;
  52         uint32_t background;
  53         uint32_t text;
  54 };
  55
  56 /**
  57  * Holds a user-assigned variable for parsing the configuration file. The key
  58  * is replaced by value in every following line of the file.
  59  *
  60  */
  61 struct Variable {
  62         char *key;
  63         char *value;
  64         char *next_match;
  65
  66         SLIST_ENTRY(Variable) variables;
  67 };
  68
  69 /**
  70  * The configuration file can contain multiple sets of bindings. Apart from the
  71  * default set (name == "default"), you can specify other sets and change the
  72  * currently active set of bindings by using the "mode <name>" command.
  73  *
  74  */
  75 struct Mode {
  76         char *name;
  77         struct bindings_head *bindings;
  78
  79         SLIST_ENTRY(Mode) modes;
  80 };
  81
  82 /**
  83  * Holds part of the configuration (the part which is not already in dedicated
  84  * structures in include/data.h).
  85  *
  86  */
  87 struct Config {
  88         const char *terminal;
  89         const char *font;
  90
  91         const char *ipc_socket_path;
  92
  93         int container_mode;
  94         int container_stack_limit;
  95         int container_stack_limit_value;
  96
  97         /** By default, focus follows mouse. If the user explicitly wants to
  98          * turn this off (and instead rely only on the keyboard for changing
  99          * focus), we allow him to do this with this relatively special option.
 100          * It is not planned to add any different focus models. */
 101         bool disable_focus_follows_mouse;
 102
 103         /** By default, a workspace bar is drawn at the bottom of the screen.
 104          * If you want to have a more fancy bar, it is recommended to replace
 105          * the whole bar by dzen2, for example using the i3-wsbar script which
 106          * comes with i3. Thus, you can turn it off entirely. */
 107         bool disable_workspace_bar;
 108
 109         const char *default_border;
 110
 111         /** The modifier which needs to be pressed in combination with your mouse
 112          * buttons to do things with floating windows (move, resize) */
 113         uint32_t floating_modifier;
 114
 115         /* Color codes are stored here */
 116         struct config_client {
 117                 uint32_t background;
 118                 struct Colortriple focused;
 119                 struct Colortriple focused_inactive;
 120                 struct Colortriple unfocused;
 121                 struct Colortriple urgent;
 122         } client;
 123         struct config_bar {
 124                 struct Colortriple focused;
 125                 struct Colortriple unfocused;
 126                 struct Colortriple urgent;
 127         } bar;
 128 };
 129
 130 char *glob_path(const char *path);
 131 bool path_exists(const char *path);
 132
 133 /**
 134  * Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
 135  *
 136  * If you specify override_configpath, only this path is used to look for a
 137  * configuration file.
 138  *
 139  */
 140 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
 141
 142 /**
 143  * Translates keysymbols to keycodes for all bindings which use keysyms.
 144  *
 145  */
 146 void translate_keysyms();
 147
 148 /**
 149  * Ungrabs all keys, to be called before re-grabbing the keys because of a
 150  * mapping_notify event or a configuration file reload
 151  *
 152  */
 153 void ungrab_all_keys(xcb_connection_t *conn);
 154
 155 /**
 156  * Grab the bound keys (tell X to send us keypress events for those keycodes)
 157  *
 158  */
 159 void grab_all_keys(xcb_connection_t *conn, bool bind_mode_switch);
 160
 161 /**
 162  * Switches the key bindings to the given mode, if the mode exists
 163  *
 164  */
 165 void switch_mode(xcb_connection_t *conn, const char *new_mode);
 166
 167 /**
 168  * Returns a pointer to the Binding with the specified modifiers and keycode
 169  * or NULL if no such binding exists.
 170  *
 171  */
 172 Binding *get_binding(uint16_t modifiers, xcb_keycode_t keycode);
 173
 174 /* prototype for src/cfgparse.y */
 175 void parse_file(const char *f);
 176
 177 #endif