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