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 Config Config;
19 typedef struct Barconfig Barconfig;
20 extern char *current_configpath;
21 extern char *current_config;
22 extern Config config;
23 extern SLIST_HEAD(modes_head, Mode) modes;
24 extern TAILQ_HEAD(barconfig_head, Barconfig) barconfigs;
25 
31 struct context {
32  bool has_errors;
34 
36  char *line_copy;
37  const char *filename;
38 
40 
41  /* These are the same as in YYLTYPE */
44 };
45 
51 struct Colortriple {
57 };
58 
64 struct Variable {
65  char *key;
66  char *value;
67  char *next_match;
68 
69  SLIST_ENTRY(Variable) variables;
70 };
71 
78 struct Mode {
79  char *name;
81  struct bindings_head *bindings;
82 
84 };
85 
91 struct Config {
92  const char *terminal;
94 
97 
103 
106 
112 
122 
128 
134 
153 
163 
166 
169 
175 
182 
184  enum {
185  /* Focus if the target workspace is visible, set urgency hint otherwise. */
187  /* Always set the urgency hint. */
189  /* Always focus the window. */
191  /* Ignore the request (no focus, no urgency hint). */
192  FOWA_NONE
194 
198 
200  enum {
205 
208 
211 
215 
221 
222  /* Color codes are stored here */
223  struct config_client {
225  struct Colortriple focused;
227  struct Colortriple unfocused;
228  struct Colortriple urgent;
229  struct Colortriple placeholder;
231  struct config_bar {
232  struct Colortriple focused;
233  struct Colortriple unfocused;
234  struct Colortriple urgent;
235  } bar;
236 
238  enum {
239  /* display (and focus) the popup when it belongs to the fullscreen
240  * window only. */
242 
243  /* leave fullscreen mode unconditionally */
245 
246  /* just ignore the popup, that is, don’t map it */
249 
250  /* The number of currently parsed barconfigs */
252 };
253 
259 struct Barconfig {
262  char *id;
263 
268  char **outputs;
269 
270  /* List of outputs on which the tray is allowed to be shown, in order.
271  * The special value "none" disables it (per default, it will be shown) and
272  * the special value "primary" enabled it on the primary output. */
273  TAILQ_HEAD(tray_outputs_head, tray_output_t) tray_outputs;
274 
275  /* Padding around the tray icons. */
277 
281  char *socket_path;
282 
284  enum { M_DOCK = 0,
285  M_HIDE = 1,
287 
288  /* The current hidden_state of the bar, which indicates whether it is hidden or shown */
289  enum { S_HIDE = 0,
291 
293  uint32_t modifier;
294 
295  TAILQ_HEAD(bar_bindings_head, Barbinding) bar_bindings;
296 
298  enum { P_BOTTOM = 0,
300 
305 
309 
311  char *font;
312 
315 
320 
323 
327 
331 
335 
337  bool verbose;
338 
339  struct bar_colors {
340  char *background;
341  char *statusline;
342  char *separator;
343 
347 
351 
355 
359 
363 
368 
370 };
371 
377 struct Barbinding {
380 
382  char *command;
383 
385  bool release;
386 
388 };
389 
391  char *output;
392 
393  TAILQ_ENTRY(tray_output_t) tray_outputs;
394 };
395 
396 typedef enum {
400 } config_load_t;
401 
413 bool load_configuration(const char *override_configfile, config_load_t load_type);
414 
420 void ungrab_all_keys(xcb_connection_t *conn);
Barconfig::socket_path
char * socket_path
Path to the i3 IPC socket.
Definition: configuration.h:281
Config::PDF_SMART
@ PDF_SMART
Definition: configuration.h:241
Barconfig::S_SHOW
@ S_SHOW
Definition: configuration.h:290
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:127
Barconfig::mode
enum Barconfig::@3 mode
Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mo...
Variable
Holds a user-assigned variable for parsing the configuration file.
Definition: configuration.h:64
Config::default_border
border_style_t default_border
The default border style for new windows.
Definition: configuration.h:207
Config::container_stack_limit
int container_stack_limit
Definition: configuration.h:99
Config::bar
struct Config::config_bar bar
Barconfig::bar_colors::background
char * background
Definition: configuration.h:340
Config::config_client::focused_inactive
struct Colortriple focused_inactive
Definition: configuration.h:226
Config::floating_maximum_width
int32_t floating_maximum_width
Maximum and minimum dimensions of a floating window.
Definition: configuration.h:217
Variable::value
char * value
Definition: configuration.h:66
Barconfig::bar_colors::active_workspace_border
char * active_workspace_border
Definition: configuration.h:352
Barconfig::num_outputs
int num_outputs
Number of outputs in the outputs array.
Definition: configuration.h:265
Barconfig::outputs
char ** outputs
Outputs on which this bar should show up on.
Definition: configuration.h:268
Mode::pango_markup
bool pango_markup
Definition: configuration.h:80
Barconfig::position
enum Barconfig::@5 position
Bar position (bottom by default).
Config::default_floating_border_width
int default_floating_border_width
Definition: configuration.h:102
Config::workspace_auto_back_and_forth
bool workspace_auto_back_and_forth
Automatic workspace back and forth switching.
Definition: configuration.h:174
Config::number_barconfigs
int number_barconfigs
Definition: configuration.h:251
focus_wrapping_t
focus_wrapping_t
Focus wrapping modes.
Definition: data.h:138
Config::focus_on_window_activation
enum Config::@0 focus_on_window_activation
Behavior when a window sends a NET_ACTIVE_WINDOW message.
queue.h
border_style_t
border_style_t
Definition: data.h:61
Barconfig::strip_workspace_numbers
bool strip_workspace_numbers
Strip workspace numbers? Configuration option is 'strip_workspace_numbers yes'.
Definition: configuration.h:326
Barconfig::bar_colors
Definition: configuration.h:339
Config::ALIGN_CENTER
@ ALIGN_CENTER
Definition: configuration.h:202
warping_t
warping_t
Mouse pointer warping modes.
Definition: data.h:130
Config::config_bar::focused
struct Colortriple focused
Definition: configuration.h:232
Barconfig::font
char * font
Font specification for all text rendered on the bar.
Definition: configuration.h:311
Config::config_client::unfocused
struct Colortriple unfocused
Definition: configuration.h:227
Barconfig::bar_colors::binding_mode_bg
char * binding_mode_bg
Definition: configuration.h:365
Config::ipc_socket_path
char * ipc_socket_path
Definition: configuration.h:95
Barconfig::TAILQ_ENTRY
TAILQ_ENTRY(Barconfig) configs
Config::default_border_width
int default_border_width
Definition: configuration.h:101
Colortriple::indicator
color_t indicator
Definition: configuration.h:55
Colortriple::background
color_t background
Definition: configuration.h:53
layout_t
layout_t
Container layouts.
Definition: data.h:90
Barconfig::modifier
uint32_t modifier
Bar modifier (to show bar when in hide mode).
Definition: configuration.h:293
Barconfig::verbose
bool verbose
Enable verbose mode? Useful for debugging purposes.
Definition: configuration.h:337
Config::config_bar
Definition: configuration.h:231
context::filename
const char * filename
Definition: configuration.h:37
Font
Data structure for cached font information:
Definition: libi3.h:58
Barbinding::input_code
int input_code
The button to be used (e.g., 1 for "button1").
Definition: configuration.h:379
Config::title_align
enum Config::@1 title_align
Title alignment options.
Barconfig::bar_colors::focused_workspace_border
char * focused_workspace_border
Definition: configuration.h:348
config_load_t
config_load_t
Definition: configuration.h:396
Config::floating_maximum_height
int32_t floating_maximum_height
Definition: configuration.h:218
Variable::key
char * key
Definition: configuration.h:65
tray_output_t::output
char * output
Definition: configuration.h:391
Config::font
i3Font font
Definition: configuration.h:93
Config::show_marks
bool show_marks
Specifies whether or not marks should be displayed in the window decoration.
Definition: configuration.h:197
Barconfig::bar_colors::urgent_workspace_border
char * urgent_workspace_border
Definition: configuration.h:360
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:181
Config::fake_outputs
char * fake_outputs
Overwrites output detection (for testing), see src/fake_outputs.c.
Definition: configuration.h:168
Config::restart_state_path
char * restart_state_path
Definition: configuration.h:96
TAILQ_HEAD
TAILQ_HEAD(barconfig_head, Barconfig) barconfigs
Config::FOWA_SMART
@ FOWA_SMART
Definition: configuration.h:186
Config::disable_randr15
bool disable_randr15
Don’t use RandR 1.5 for querying outputs.
Definition: configuration.h:165
Config::default_floating_border
border_style_t default_floating_border
The default border style for new floating windows.
Definition: configuration.h:210
Barbinding::TAILQ_ENTRY
TAILQ_ENTRY(Barbinding) bindings
Barconfig::S_HIDE
@ S_HIDE
Definition: configuration.h:289
Config::popup_during_fullscreen
enum Config::@2 popup_during_fullscreen
What should happen when a new popup is opened during fullscreen mode.
context::line_copy
char * line_copy
Definition: configuration.h:36
Config::floating_minimum_height
int32_t floating_minimum_height
Definition: configuration.h:220
Barconfig::M_DOCK
@ M_DOCK
Definition: configuration.h:284
Config::config_client::placeholder
struct Colortriple placeholder
Definition: configuration.h:229
tray_output_t
Definition: configuration.h:390
Barconfig::bar_colors::urgent_workspace_text
char * urgent_workspace_text
Definition: configuration.h:362
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:214
context::line_number
int line_number
Definition: configuration.h:35
Config::FOWA_NONE
@ FOWA_NONE
Definition: configuration.h:192
Barconfig::workspace_min_width
int workspace_min_width
The minimal width for workspace buttons.
Definition: configuration.h:322
Config::floating_minimum_width
int32_t floating_minimum_width
Definition: configuration.h:219
Config::FOWA_FOCUS
@ FOWA_FOCUS
Definition: configuration.h:190
Mode::name
char * name
Definition: configuration.h:79
Barconfig::strip_workspace_name
bool strip_workspace_name
Strip workspace name? Configuration option is 'strip_workspace_name yes'.
Definition: configuration.h:330
Mode::bindings
struct bindings_head * bindings
Definition: configuration.h:81
Colortriple::child_border
color_t child_border
Definition: configuration.h:56
current_configpath
char * current_configpath
Definition: config.c:15
context::last_column
int last_column
Definition: configuration.h:43
Config::mouse_warping
warping_t mouse_warping
By default, when switching focus to a window on a different output (e.g.
Definition: configuration.h:121
Mode
The configuration file can contain multiple sets of bindings.
Definition: configuration.h:78
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:334
Barconfig::bar_colors::focused_background
char * focused_background
Definition: configuration.h:344
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:152
Config::container_stack_limit_value
int container_stack_limit_value
Definition: configuration.h:100
Config::config_bar::urgent
struct Colortriple urgent
Definition: configuration.h:234
Barbinding
Defines a mouse command to be executed instead of the default behavior when clicking on the non-statu...
Definition: configuration.h:377
Barconfig::bar_colors::focused_separator
char * focused_separator
Definition: configuration.h:346
color_t
Definition: libi3.h:419
Barconfig::colors
struct Barconfig::bar_colors colors
Barconfig::bar_colors::focused_statusline
char * focused_statusline
Definition: configuration.h:345
Barconfig::M_INVISIBLE
@ M_INVISIBLE
Definition: configuration.h:286
Config::client
struct Config::config_client client
Config::config_bar::unfocused
struct Colortriple unfocused
Definition: configuration.h:233
Config::disable_focus_follows_mouse
bool disable_focus_follows_mouse
By default, focus follows mouse.
Definition: configuration.h:111
Barconfig::bar_colors::focused_workspace_bg
char * focused_workspace_bg
Definition: configuration.h:349
Barconfig::tray_padding
int tray_padding
Definition: configuration.h:276
Config::config_client::background
color_t background
Definition: configuration.h:224
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:319
Barconfig::P_TOP
@ P_TOP
Definition: configuration.h:299
Colortriple
Part of the struct Config.
Definition: configuration.h:51
Config::PDF_IGNORE
@ PDF_IGNORE
Definition: configuration.h:247
Barconfig
Holds the status bar configuration (i3bar).
Definition: configuration.h:259
Config::config_client::urgent
struct Colortriple urgent
Definition: configuration.h:228
C_LOAD
@ C_LOAD
Definition: configuration.h:398
Variable::next_match
char * next_match
Definition: configuration.h:67
hide_edge_borders_mode_t
hide_edge_borders_mode_t
Definition: data.h:78
Config::disable_workspace_bar
bool disable_workspace_bar
By default, a workspace bar is drawn at the bottom of the screen.
Definition: configuration.h:133
Barconfig::TAILQ_HEAD
TAILQ_HEAD(tray_outputs_head, tray_output_t) tray_outputs
Barconfig::bar_colors::focused_workspace_text
char * focused_workspace_text
Definition: configuration.h:350
bindings
struct bindings_head * bindings
Definition: main.c:81
Config::ALIGN_RIGHT
@ ALIGN_RIGHT
Definition: configuration.h:203
Barconfig::bar_colors::inactive_workspace_border
char * inactive_workspace_border
Definition: configuration.h:356
Barconfig::P_BOTTOM
@ P_BOTTOM
Definition: configuration.h:298
Config::ALIGN_LEFT
@ ALIGN_LEFT
Definition: configuration.h:201
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:163
context::compact_error
char * compact_error
Definition: configuration.h:39
Config::config_client::focused
struct Colortriple focused
Definition: configuration.h:225
Config::terminal
const char * terminal
Definition: configuration.h:92
Barbinding::command
char * command
The command which is to be executed for this button.
Definition: configuration.h:382
Barconfig::bar_colors::statusline
char * statusline
Definition: configuration.h:341
context::first_column
int first_column
Definition: configuration.h:42
Colortriple::text
color_t text
Definition: configuration.h:54
Config::default_layout
layout_t default_layout
Definition: configuration.h:98
i3.h
Barbinding::release
bool release
If true, the command will be executed after the button is released.
Definition: configuration.h:385
Mode::SLIST_ENTRY
SLIST_ENTRY(Mode) modes
context::has_errors
bool has_errors
Definition: configuration.h:32
current_config
char * current_config
Definition: config.c:16
Barconfig::bar_colors::separator
char * separator
Definition: configuration.h:342
Barconfig::bar_colors::active_workspace_bg
char * active_workspace_bg
Definition: configuration.h:353
tray_output_t::TAILQ_ENTRY
TAILQ_ENTRY(tray_output_t) tray_outputs
C_RELOAD
@ C_RELOAD
Definition: configuration.h:399
Config::force_xinerama
bool force_xinerama
By default, use the RandR API for multi-monitor setups.
Definition: configuration.h:162
context::has_warnings
bool has_warnings
Definition: configuration.h:33
Config::config_client
Definition: configuration.h:223
modes
struct modes_head modes
Definition: config.c:18
Barconfig::bar_colors::inactive_workspace_text
char * inactive_workspace_text
Definition: configuration.h:358
Colortriple::border
color_t border
Definition: configuration.h:52
barconfigs
struct barconfig_head barconfigs
Definition: config.c:19
Barconfig::bar_colors::urgent_workspace_bg
char * urgent_workspace_bg
Definition: configuration.h:361
Barconfig::bar_colors::active_workspace_text
char * active_workspace_text
Definition: configuration.h:354
Barconfig::M_HIDE
@ M_HIDE
Definition: configuration.h:285
Barconfig::bar_colors::binding_mode_border
char * binding_mode_border
Definition: configuration.h:364
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:304
Config::PDF_LEAVE_FULLSCREEN
@ PDF_LEAVE_FULLSCREEN
Definition: configuration.h:244
SLIST_HEAD
SLIST_HEAD(modes_head, Mode) modes
Barconfig::separator_symbol
char * separator_symbol
A custom separator to use instead of a vertical line.
Definition: configuration.h:314
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:26
conn
xcb_connection_t * conn
XCB connection and root screen.
Definition: main.c:51
Barconfig::bar_colors::inactive_workspace_bg
char * inactive_workspace_bg
Definition: configuration.h:357
context
Used during the config file lexing/parsing to keep the state of the lexer in order to provide useful ...
Definition: configuration.h:31
Barconfig::bar_colors::binding_mode_text
char * binding_mode_text
Definition: configuration.h:366
Config::FOWA_URGENT
@ FOWA_URGENT
Definition: configuration.h:188
Barconfig::hidden_state
enum Barconfig::@4 hidden_state
C_VALIDATE
@ C_VALIDATE
Definition: configuration.h:397
Variable::SLIST_ENTRY
SLIST_ENTRY(Variable) variables
Config
Holds part of the configuration (the part which is not already in dedicated structures in include/dat...
Definition: configuration.h:91
Barconfig::TAILQ_HEAD
TAILQ_HEAD(bar_bindings_head, Barbinding) bar_bindings
config
Config config
Definition: config.c:17
Barconfig::id
char * id
Automatically generated ID for this bar config.
Definition: configuration.h:262
Barconfig::status_command
char * status_command
Command that should be run to get a statusline, for example 'i3status'.
Definition: configuration.h:308
Config::default_orientation
int default_orientation
Default orientation for new containers.
Definition: configuration.h:105