i3
configuration.h
Go to the documentation of this file.
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
6  *
7  * include/configuration.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/config_parse.c) with the correct path, switching key
10  * bindings mode).
11  *
12  */
13 #pragma once
14 
15 #include "queue.h"
16 #include "i3.h"
17 
18 typedef struct IncludedFile IncludedFile;
19 typedef struct Config Config;
20 typedef struct Barconfig Barconfig;
21 extern char *current_configpath;
22 extern char *current_config;
23 extern Config config;
24 extern SLIST_HEAD(modes_head, Mode) modes;
25 extern TAILQ_HEAD(barconfig_head, Barconfig) barconfigs;
26 extern TAILQ_HEAD(includedfiles_head, IncludedFile) included_files;
27 
33 struct context {
34  bool has_errors;
36 
38  char *line_copy;
39  const char *filename;
40 
42 
43  /* These are the same as in YYLTYPE */
46 };
47 
53 struct Colortriple {
59 };
60 
66 struct Variable {
67  char *key;
68  char *value;
69  char *next_match;
70 
71  SLIST_ENTRY(Variable) variables;
72 };
73 
78 struct IncludedFile {
79  char *path;
80  char *raw_contents;
82 
84 };
85 
92 struct Mode {
93  char *name;
95  struct bindings_head *bindings;
96 
98 };
99 
105 struct Config {
106  const char *terminal;
108 
111 
117 
120 
126 
136 
142 
148 
167 
177 
180 
183 
189 
196 
198  enum {
199  /* Focus if the target workspace is visible, set urgency hint otherwise. */
201  /* Always set the urgency hint. */
203  /* Always focus the window. */
205  /* Ignore the request (no focus, no urgency hint). */
206  FOWA_NONE
208 
212 
214  enum {
219 
222 
225 
229 
235 
236  /* Color codes are stored here */
237  struct config_client {
239  struct Colortriple focused;
242  struct Colortriple unfocused;
243  struct Colortriple urgent;
244  struct Colortriple placeholder;
247  struct config_bar {
248  struct Colortriple focused;
249  struct Colortriple unfocused;
250  struct Colortriple urgent;
251  } bar;
252 
254  enum {
255  /* display (and focus) the popup when it belongs to the fullscreen
256  * window only. */
258 
259  /* leave fullscreen mode unconditionally */
261 
262  /* just ignore the popup, that is, don’t map it */
265 
266  /* The number of currently parsed barconfigs */
268 };
269 
275 struct Barconfig {
278  char *id;
279 
284  char **outputs;
285 
286  /* List of outputs on which the tray is allowed to be shown, in order.
287  * The special value "none" disables it (per default, it will be shown) and
288  * the special value "primary" enabled it on the primary output. */
289  TAILQ_HEAD(tray_outputs_head, tray_output_t) tray_outputs;
290 
291  /* Padding around the tray icons. */
293 
297  char *socket_path;
298 
300  enum { M_DOCK = 0,
301  M_HIDE = 1,
303 
304  /* The current hidden_state of the bar, which indicates whether it is hidden or shown */
305  enum { S_HIDE = 0,
307 
309  uint32_t modifier;
310 
311  TAILQ_HEAD(bar_bindings_head, Barbinding) bar_bindings;
312 
314  enum { P_BOTTOM = 0,
316 
321 
325 
327  char *font;
328 
331 
336 
339 
343 
347 
351 
353  bool verbose;
354 
355  struct bar_colors {
356  char *background;
357  char *statusline;
358  char *separator;
359 
363 
367 
371 
375 
379 
384 
386 };
387 
393 struct Barbinding {
396 
398  char *command;
399 
401  bool release;
402 
404 };
405 
407  char *output;
408 
409  TAILQ_ENTRY(tray_output_t) tray_outputs;
410 };
411 
412 typedef enum {
416 } config_load_t;
417 
429 bool load_configuration(const char *override_configfile, config_load_t load_type);
430 
436 void ungrab_all_keys(xcb_connection_t *conn);
Mode::bindings
struct bindings_head * bindings
Definition: configuration.h:95
Config::config_client::got_focused_tab_title
bool got_focused_tab_title
Definition: configuration.h:245
Barconfig::status_command
char * status_command
Command that should be run to get a statusline, for example 'i3status'.
Definition: configuration.h:324
Barconfig::workspace_min_width
int workspace_min_width
The minimal width for workspace buttons.
Definition: configuration.h:338
context
Used during the config file lexing/parsing to keep the state of the lexer in order to provide useful ...
Definition: configuration.h:33
Config::restart_state_path
char * restart_state_path
Definition: configuration.h:110
Barconfig::bar_colors::binding_mode_border
char * binding_mode_border
Definition: configuration.h:380
Barconfig::hidden_state
enum Barconfig::@8 hidden_state
IncludedFile::TAILQ_ENTRY
TAILQ_ENTRY(IncludedFile) files
Barconfig::bar_colors::urgent_workspace_text
char * urgent_workspace_text
Definition: configuration.h:378
Barconfig::TAILQ_ENTRY
TAILQ_ENTRY(Barconfig) configs
Variable::next_match
char * next_match
Definition: configuration.h:69
Config::focus_on_window_activation
enum Config::@4 focus_on_window_activation
Behavior when a window sends a NET_ACTIVE_WINDOW message.
Config::disable_workspace_bar
bool disable_workspace_bar
By default, a workspace bar is drawn at the bottom of the screen.
Definition: configuration.h:147
context::has_warnings
bool has_warnings
Definition: configuration.h:35
Barconfig::hide_workspace_buttons
bool hide_workspace_buttons
Hide workspace buttons? Configuration option is 'workspace_buttons no' but we invert the bool to get ...
Definition: configuration.h:335
Config::config_client::focused_inactive
struct Colortriple focused_inactive
Definition: configuration.h:240
Config::font
i3Font font
Definition: configuration.h:107
focus_wrapping_t
focus_wrapping_t
Focus wrapping modes.
Definition: data.h:141
Config::default_layout
layout_t default_layout
Definition: configuration.h:112
Barconfig::bar_colors
Definition: configuration.h:355
queue.h
Config::ALIGN_LEFT
@ ALIGN_LEFT
Definition: configuration.h:215
border_style_t
border_style_t
Definition: data.h:64
Config::show_marks
bool show_marks
Specifies whether or not marks should be displayed in the window decoration.
Definition: configuration.h:211
Barconfig::bar_colors::focused_separator
char * focused_separator
Definition: configuration.h:362
Barbinding::command
char * command
The command which is to be executed for this button.
Definition: configuration.h:398
warping_t
warping_t
Mouse pointer warping modes.
Definition: data.h:133
included_files
struct includedfiles_head included_files
Definition: config.c:22
Config::config_bar::unfocused
struct Colortriple unfocused
Definition: configuration.h:249
Barconfig::mode
enum Barconfig::@7 mode
Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mo...
Variable::value
char * value
Definition: configuration.h:68
Config::config_bar
Definition: configuration.h:247
Font
Data structure for cached font information:
Definition: libi3.h:59
Mode
The configuration file can contain multiple sets of bindings.
Definition: configuration.h:92
Config::config_client::unfocused
struct Colortriple unfocused
Definition: configuration.h:242
Barconfig::bar_colors::focused_background
char * focused_background
Definition: configuration.h:360
layout_t
layout_t
Container layouts.
Definition: data.h:93
tray_output_t
Definition: configuration.h:406
Config::title_align
enum Config::@5 title_align
Title alignment options.
Barconfig
Holds the status bar configuration (i3bar).
Definition: configuration.h:275
Barconfig::S_HIDE
@ S_HIDE
Definition: configuration.h:305
config_load_t
config_load_t
Definition: configuration.h:412
Config::FOWA_SMART
@ FOWA_SMART
Definition: configuration.h:200
Barbinding::input_code
int input_code
The button to be used (e.g., 1 for "button1").
Definition: configuration.h:395
context::line_copy
char * line_copy
Definition: configuration.h:38
Barconfig::bar_colors::focused_workspace_text
char * focused_workspace_text
Definition: configuration.h:366
Barconfig::bar_colors::active_workspace_border
char * active_workspace_border
Definition: configuration.h:368
Barconfig::bar_colors::urgent_workspace_border
char * urgent_workspace_border
Definition: configuration.h:376
Variable
Holds a user-assigned variable for parsing the configuration file.
Definition: configuration.h:66
Barconfig::strip_workspace_numbers
bool strip_workspace_numbers
Strip workspace numbers? Configuration option is 'strip_workspace_numbers yes'.
Definition: configuration.h:342
Config::PDF_SMART
@ PDF_SMART
Definition: configuration.h:257
Config::workspace_auto_back_and_forth
bool workspace_auto_back_and_forth
Automatic workspace back and forth switching.
Definition: configuration.h:188
Barconfig::bar_colors::inactive_workspace_bg
char * inactive_workspace_bg
Definition: configuration.h:373
tray_output_t::output
char * output
Definition: configuration.h:407
Barbinding::TAILQ_ENTRY
TAILQ_ENTRY(Barbinding) bindings
Colortriple::background
color_t background
Definition: configuration.h:55
Config::config_client
Definition: configuration.h:237
IncludedFile
List entry struct for an included file.
Definition: configuration.h:78
TAILQ_HEAD
TAILQ_HEAD(barconfig_head, Barconfig) barconfigs
Barconfig::tray_padding
int tray_padding
Definition: configuration.h:292
Barconfig::bar_colors::focused_statusline
char * focused_statusline
Definition: configuration.h:361
Config::ipc_socket_path
char * ipc_socket_path
Definition: configuration.h:109
Barconfig::num_outputs
int num_outputs
Number of outputs in the outputs array.
Definition: configuration.h:281
Barconfig::bar_colors::focused_workspace_bg
char * focused_workspace_bg
Definition: configuration.h:365
Barconfig::TAILQ_HEAD
TAILQ_HEAD(bar_bindings_head, Barbinding) bar_bindings
Barconfig::bar_colors::separator
char * separator
Definition: configuration.h:358
Config::popup_during_fullscreen
enum Config::@6 popup_during_fullscreen
What should happen when a new popup is opened during fullscreen mode.
Barconfig::id
char * id
Automatically generated ID for this bar config.
Definition: configuration.h:278
Barconfig::hide_binding_mode_indicator
bool hide_binding_mode_indicator
Hide mode button? Configuration option is 'binding_mode_indicator no' but we invert the bool for the ...
Definition: configuration.h:350
Config::focus_wrapping
focus_wrapping_t focus_wrapping
When focus wrapping is enabled (the default), attempting to move focus past the edge of the screen (i...
Definition: configuration.h:166
Barconfig::bar_colors::focused_workspace_border
char * focused_workspace_border
Definition: configuration.h:364
Config::config_bar::urgent
struct Colortriple urgent
Definition: configuration.h:250
Colortriple
Part of the struct Config.
Definition: configuration.h:53
context::last_column
int last_column
Definition: configuration.h:45
Barconfig::M_DOCK
@ M_DOCK
Definition: configuration.h:300
Colortriple::border
color_t border
Definition: configuration.h:54
Config::floating_minimum_width
int32_t floating_minimum_width
Definition: configuration.h:233
Barconfig::font
char * font
Font specification for all text rendered on the bar.
Definition: configuration.h:327
Config::container_stack_limit
int container_stack_limit
Definition: configuration.h:113
Barconfig::bar_colors::active_workspace_text
char * active_workspace_text
Definition: configuration.h:370
Config::default_border
border_style_t default_border
The default border style for new windows.
Definition: configuration.h:221
Config::FOWA_FOCUS
@ FOWA_FOCUS
Definition: configuration.h:204
Config::config_client::focused
struct Colortriple focused
Definition: configuration.h:239
current_configpath
char * current_configpath
Definition: config.c:18
Config::disable_focus_follows_mouse
bool disable_focus_follows_mouse
By default, focus follows mouse.
Definition: configuration.h:125
Barconfig::colors
struct Barconfig::bar_colors colors
Config::mouse_warping
warping_t mouse_warping
By default, when switching focus to a window on a different output (e.g.
Definition: configuration.h:135
Barconfig::bar_colors::inactive_workspace_border
char * inactive_workspace_border
Definition: configuration.h:372
Barconfig::TAILQ_HEAD
TAILQ_HEAD(tray_outputs_head, tray_output_t) tray_outputs
Colortriple::child_border
color_t child_border
Definition: configuration.h:58
Config::config_client::urgent
struct Colortriple urgent
Definition: configuration.h:243
Config::bar
struct Config::config_bar bar
Colortriple::indicator
color_t indicator
Definition: configuration.h:57
Barconfig::bar_colors::active_workspace_bg
char * active_workspace_bg
Definition: configuration.h:369
tray_output_t::TAILQ_ENTRY
TAILQ_ENTRY(tray_output_t) tray_outputs
Barconfig::bar_colors::urgent_workspace_bg
char * urgent_workspace_bg
Definition: configuration.h:377
Mode::name
char * name
Definition: configuration.h:93
Config::PDF_LEAVE_FULLSCREEN
@ PDF_LEAVE_FULLSCREEN
Definition: configuration.h:260
Barconfig::bar_colors::binding_mode_bg
char * binding_mode_bg
Definition: configuration.h:381
Config::container_stack_limit_value
int container_stack_limit_value
Definition: configuration.h:114
Config::client
struct Config::config_client client[QUBE_NUM_LABELS]
Barconfig::position
enum Barconfig::@9 position
Bar position (bottom by default).
Config::force_xinerama
bool force_xinerama
By default, use the RandR API for multi-monitor setups.
Definition: configuration.h:176
Config::ALIGN_RIGHT
@ ALIGN_RIGHT
Definition: configuration.h:217
Barconfig::bar_colors::background
char * background
Definition: configuration.h:356
Config::default_floating_border_width
int default_floating_border_width
Definition: configuration.h:116
C_LOAD
@ C_LOAD
Definition: configuration.h:414
Barconfig::M_HIDE
@ M_HIDE
Definition: configuration.h:301
Barconfig::P_TOP
@ P_TOP
Definition: configuration.h:315
hide_edge_borders_mode_t
hide_edge_borders_mode_t
Definition: data.h:81
Config::disable_randr15
bool disable_randr15
Don’t use RandR 1.5 for querying outputs.
Definition: configuration.h:179
Barconfig::S_SHOW
@ S_SHOW
Definition: configuration.h:306
Barconfig::socket_path
char * socket_path
Path to the i3 IPC socket.
Definition: configuration.h:297
bindings
struct bindings_head * bindings
Definition: main.c:87
Config::config_client::placeholder
struct Colortriple placeholder
Definition: configuration.h:244
Mode::pango_markup
bool pango_markup
Definition: configuration.h:94
context::has_errors
bool has_errors
Definition: configuration.h:34
Barconfig::bar_colors::binding_mode_text
char * binding_mode_text
Definition: configuration.h:382
load_configuration
bool load_configuration(const char *override_configfile, config_load_t load_type)
(Re-)loads the configuration file (sets useful defaults before).
Definition: config.c:166
Config::floating_maximum_height
int32_t floating_maximum_height
Definition: configuration.h:232
Barconfig::i3bar_command
char * i3bar_command
Command that should be run to execute i3bar, give a full path if i3bar is not in your $PATH.
Definition: configuration.h:320
Barconfig::separator_symbol
char * separator_symbol
A custom separator to use instead of a vertical line.
Definition: configuration.h:330
Config::fake_outputs
char * fake_outputs
Overwrites output detection (for testing), see src/fake_outputs.c.
Definition: configuration.h:182
Barconfig::bar_colors::statusline
char * statusline
Definition: configuration.h:357
QUBE_NUM_LABELS
#define QUBE_NUM_LABELS
Definition: data.h:163
Barconfig::M_INVISIBLE
@ M_INVISIBLE
Definition: configuration.h:302
Config::terminal
const char * terminal
Definition: configuration.h:106
i3.h
Variable::SLIST_ENTRY
SLIST_ENTRY(Variable) variables
IncludedFile::variable_replaced_contents
char * variable_replaced_contents
Definition: configuration.h:81
Config::ALIGN_CENTER
@ ALIGN_CENTER
Definition: configuration.h:216
Config::FOWA_NONE
@ FOWA_NONE
Definition: configuration.h:206
Config::workspace_urgency_timer
float workspace_urgency_timer
By default, urgency is cleared immediately when switching to another workspace leads to focusing the ...
Definition: configuration.h:195
Variable::key
char * key
Definition: configuration.h:67
current_config
char * current_config
Config::default_orientation
int default_orientation
Default orientation for new containers.
Definition: configuration.h:119
Barbinding::release
bool release
If true, the command will be executed after the button is released.
Definition: configuration.h:401
Mode::SLIST_ENTRY
SLIST_ENTRY(Mode) modes
C_RELOAD
@ C_RELOAD
Definition: configuration.h:415
context::filename
const char * filename
Definition: configuration.h:39
Config::PDF_IGNORE
@ PDF_IGNORE
Definition: configuration.h:263
modes
struct modes_head modes
Definition: config.c:20
Barconfig::strip_workspace_name
bool strip_workspace_name
Strip workspace name? Configuration option is 'strip_workspace_name yes'.
Definition: configuration.h:346
barconfigs
struct barconfig_head barconfigs
Definition: config.c:21
Barbinding
Defines a mouse command to be executed instead of the default behavior when clicking on the non-statu...
Definition: configuration.h:393
color_t
Definition: libi3.h:426
Barconfig::outputs
char ** outputs
Outputs on which this bar should show up on.
Definition: configuration.h:284
IncludedFile::raw_contents
char * raw_contents
Definition: configuration.h:80
Colortriple::text
color_t text
Definition: configuration.h:56
Config::floating_modifier
uint32_t floating_modifier
The modifier which needs to be pressed in combination with your mouse buttons to do things with float...
Definition: configuration.h:228
Config::FOWA_URGENT
@ FOWA_URGENT
Definition: configuration.h:202
Config::config_client::background
color_t background
Definition: configuration.h:238
Config::default_border_width
int default_border_width
Definition: configuration.h:115
Config::hide_edge_borders
hide_edge_borders_mode_t hide_edge_borders
Remove borders if they are adjacent to the screen edge.
Definition: configuration.h:141
SLIST_HEAD
SLIST_HEAD(modes_head, Mode) modes
Config::config_client::focused_tab_title
struct Colortriple focused_tab_title
Definition: configuration.h:241
ungrab_all_keys
void ungrab_all_keys(xcb_connection_t *conn)
Ungrabs all keys, to be called before re-grabbing the keys because of a mapping_notify event or a con...
Definition: config.c:29
context::first_column
int first_column
Definition: configuration.h:44
conn
xcb_connection_t * conn
XCB connection and root screen.
Definition: main.c:54
Config::floating_minimum_height
int32_t floating_minimum_height
Definition: configuration.h:234
Config::default_floating_border
border_style_t default_floating_border
The default border style for new floating windows.
Definition: configuration.h:224
Config
Holds part of the configuration (the part which is not already in dedicated structures in include/dat...
Definition: configuration.h:105
Barconfig::modifier
uint32_t modifier
Bar modifier (to show bar when in hide mode).
Definition: configuration.h:309
Barconfig::verbose
bool verbose
Enable verbose mode? Useful for debugging purposes.
Definition: configuration.h:353
C_VALIDATE
@ C_VALIDATE
Definition: configuration.h:413
Config::config_bar::focused
struct Colortriple focused
Definition: configuration.h:248
Config::floating_maximum_width
int32_t floating_maximum_width
Maximum and minimum dimensions of a floating window.
Definition: configuration.h:231
context::compact_error
char * compact_error
Definition: configuration.h:41
Barconfig::P_BOTTOM
@ P_BOTTOM
Definition: configuration.h:314
Config::number_barconfigs
int number_barconfigs
Definition: configuration.h:267
context::line_number
int line_number
Definition: configuration.h:37
Barconfig::bar_colors::inactive_workspace_text
char * inactive_workspace_text
Definition: configuration.h:374
config
Config config
Definition: config.c:19
IncludedFile::path
char * path
Definition: configuration.h:79