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