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 "libi3.h"
16 
17 #include <stdbool.h>
18 #include "queue.h"
19 #include "i3.h"
20 
21 typedef struct Config Config;
22 typedef struct Barconfig Barconfig;
23 extern char *current_configpath;
24 extern char *current_config;
25 extern Config config;
26 extern SLIST_HEAD(modes_head, Mode) modes;
27 extern TAILQ_HEAD(barconfig_head, Barconfig) barconfigs;
28 
34 struct context {
35  bool has_errors;
37 
39  char *line_copy;
40  const char *filename;
41 
43 
44  /* These are the same as in YYLTYPE */
47 };
48 
54 struct Colortriple {
60 };
61 
67 struct Variable {
68  char *key;
69  char *value;
70  char *next_match;
71 
74 };
75 
82 struct Mode {
83  char *name;
85  struct bindings_head *bindings;
86 
89 };
90 
96 struct Config {
97  const char *terminal;
99 
102 
108 
111 
117 
127 
133 
139 
158 
168 
171 
174 
180 
187 
189  enum {
190  /* Focus if the target workspace is visible, set urgency hint otherwise. */
192  /* Always set the urgency hint. */
194  /* Always focus the window. */
196  /* Ignore the request (no focus, no urgency hint). */
197  FOWA_NONE
198  } focus_on_window_activation;
199 
203 
205  enum {
208  ALIGN_RIGHT
209  } title_align;
210 
213 
216 
220 
226 
227  /* Color codes are stored here */
228  struct config_client {
229  color_t background;
230  struct Colortriple focused;
231  struct Colortriple focused_inactive;
232  struct Colortriple unfocused;
233  struct Colortriple urgent;
234  struct Colortriple placeholder;
235  } client;
236  struct config_bar {
237  struct Colortriple focused;
238  struct Colortriple unfocused;
239  struct Colortriple urgent;
240  } bar;
241 
243  enum {
244  /* display (and focus) the popup when it belongs to the fullscreen
245  * window only. */
246  PDF_SMART = 0,
247 
248  /* leave fullscreen mode unconditionally */
249  PDF_LEAVE_FULLSCREEN = 1,
250 
251  /* just ignore the popup, that is, don’t map it */
252  PDF_IGNORE = 2,
253  } popup_during_fullscreen;
254 
255  /* The number of currently parsed barconfigs */
257 
258  /* Gap sizes */
260 
261  /* Should single containers on a workspace receive a border? */
263 
264  /* Disable gaps if there is only one container on the workspace */
266 };
267 
273 struct Barconfig {
276  char *id;
277 
282  char **outputs;
283 
284  /* List of outputs on which the tray is allowed to be shown, in order.
285  * The special value "none" disables it (per default, it will be shown) and
286  * the special value "primary" enabled it on the primary output. */
287  TAILQ_HEAD(tray_outputs_head, tray_output_t)
288  tray_outputs;
289 
290  /* Padding around the tray icons. */
291  int tray_padding;
292 
296  char *socket_path;
297 
299  enum { M_DOCK = 0,
300  M_HIDE = 1,
301  M_INVISIBLE = 2 } mode;
302 
303  /* The current hidden_state of the bar, which indicates whether it is hidden or shown */
304  enum { S_HIDE = 0,
305  S_SHOW = 1 } hidden_state;
306 
308  uint32_t modifier;
309 
310  TAILQ_HEAD(bar_bindings_head, Barbinding)
311  bar_bindings;
312 
314  enum { P_BOTTOM = 0,
315  P_TOP = 1 } position;
316 
321 
325 
327  char *font;
328 
331 
336 
339 
343 
347 
351 
353  bool verbose;
354 
356  uint32_t bar_height;
357 
358  struct bar_colors {
359  char *background;
360  char *statusline;
361  char *separator;
362 
366 
370 
374 
378 
382 
386  } colors;
387 
389  configs;
390 };
391 
397 struct Barbinding {
400 
402  char *command;
403 
405  bool release;
406 
409 };
410 
412  char *output;
413 
415  tray_outputs;
416 };
417 
418 typedef enum {
422 } config_load_t;
423 
435 bool load_configuration(const char *override_configfile, config_load_t load_type);
436 
442 void ungrab_all_keys(xcb_connection_t *conn);
443 
448 void update_barconfig(void);
Barbinding
Defines a mouse command to be executed instead of the default behavior when clicking on the non-statu...
Definition: configuration.h:397
Barconfig::bar_colors::urgent_workspace_bg
char * urgent_workspace_bg
Definition: configuration.h:380
Barconfig::bar_colors::binding_mode_bg
char * binding_mode_bg
Definition: configuration.h:384
Barconfig::bar_colors::active_workspace_text
char * active_workspace_text
Definition: configuration.h:373
Config::ALIGN_LEFT
@ ALIGN_LEFT
Definition: configuration.h:206
context::line_copy
char * line_copy
Definition: configuration.h:39
Barconfig::modifier
uint32_t modifier
Bar modifier (to show bar when in hide mode).
Definition: configuration.h:308
Barconfig::bar_colors::binding_mode_border
char * binding_mode_border
Definition: configuration.h:383
Barbinding::input_code
int input_code
The button to be used (e.g., 1 for "button1").
Definition: configuration.h:399
Barconfig::bar_colors::focused_workspace_border
char * focused_workspace_border
Definition: configuration.h:367
Barconfig
Holds the status bar configuration (i3bar).
Definition: configuration.h:273
Barconfig::bar_colors::inactive_workspace_bg
char * inactive_workspace_bg
Definition: configuration.h:376
Font
Data structure for cached font information:
Definition: libi3.h:58
Barconfig::bar_colors::binding_mode_text
char * binding_mode_text
Definition: configuration.h:385
focus_wrapping_t
focus_wrapping_t
Focus wrapping modes.
Definition: data.h:159
gaps_t
Definition: data.h:148
border_style_t
border_style_t
Definition: data.h:65
Config::show_marks
bool show_marks
Specifies whether or not marks should be displayed in the window decoration.
Definition: configuration.h:202
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
Barconfig::id
char * id
Automatically generated ID for this bar config.
Definition: configuration.h:276
Config::default_orientation
int default_orientation
Default orientation for new containers.
Definition: configuration.h:110
Config::restart_state_path
char * restart_state_path
Definition: configuration.h:101
warping_t
warping_t
Mouse pointer warping modes.
Definition: data.h:143
context
Used during the config file lexing/parsing to keep the state of the lexer in order to provide useful ...
Definition: configuration.h:34
Config::default_border
border_style_t default_border
The default border style for new windows.
Definition: configuration.h:212
Config::config_bar
Definition: configuration.h:236
Config::FOWA_URGENT
@ FOWA_URGENT
Definition: configuration.h:193
Config::container_stack_limit
int container_stack_limit
Definition: configuration.h:104
Barconfig::bar_colors::background
char * background
Definition: configuration.h:359
layout_t
layout_t
Container layouts.
Definition: data.h:103
Config::floating_maximum_width
int32_t floating_maximum_width
Maximum and minimum dimensions of a floating window.
Definition: configuration.h:222
Config::floating_minimum_height
int32_t floating_minimum_height
Definition: configuration.h:225
Barconfig::num_outputs
int num_outputs
Number of outputs in the outputs array.
Definition: configuration.h:279
Barconfig::bar_colors::urgent_workspace_text
char * urgent_workspace_text
Definition: configuration.h:381
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:219
config_load_t
config_load_t
Definition: configuration.h:418
Mode::pango_markup
bool pango_markup
Definition: configuration.h:84
Config::default_floating_border_width
int default_floating_border_width
Definition: configuration.h:107
Colortriple::border
color_t border
Definition: configuration.h:55
Config::number_barconfigs
int number_barconfigs
Definition: configuration.h:256
Barconfig::strip_workspace_name
bool strip_workspace_name
Strip workspace name? Configuration option is 'strip_workspace_name yes'.
Definition: configuration.h:346
TAILQ_HEAD
TAILQ_HEAD(barconfig_head, Barconfig) barconfigs
Barconfig::bar_colors::focused_background
char * focused_background
Definition: configuration.h:363
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:157
Config
Holds part of the configuration (the part which is not already in dedicated structures in include/dat...
Definition: configuration.h:96
Config::ipc_socket_path
char * ipc_socket_path
Definition: configuration.h:100
SLIST_ENTRY
#define SLIST_ENTRY(type)
Definition: queue.h:101
Barconfig::bar_colors::focused_separator
char * focused_separator
Definition: configuration.h:365
Config::smart_borders
smart_borders_t smart_borders
Definition: configuration.h:262
Config::default_border_width
int default_border_width
Definition: configuration.h:106
Config::FOWA_SMART
@ FOWA_SMART
Definition: configuration.h:191
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
queue.h
Barconfig::separator_symbol
char * separator_symbol
A custom separator to use instead of a vertical line.
Definition: configuration.h:330
Config::floating_maximum_height
int32_t floating_maximum_height
Definition: configuration.h:223
Variable::key
char * key
Definition: configuration.h:68
context::last_column
int last_column
Definition: configuration.h:46
Variable
Holds a user-assigned variable for parsing the configuration file.
Definition: configuration.h:67
Config::ALIGN_CENTER
@ ALIGN_CENTER
Definition: configuration.h:207
Config::font
i3Font font
Definition: configuration.h:98
Barconfig::bar_colors::focused_workspace_text
char * focused_workspace_text
Definition: configuration.h:369
Barconfig::bar_colors::urgent_workspace_border
char * urgent_workspace_border
Definition: configuration.h:379
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:186
Barconfig::status_command
char * status_command
Command that should be run to get a statusline, for example 'i3status'.
Definition: configuration.h:324
Barconfig::bar_colors::inactive_workspace_border
char * inactive_workspace_border
Definition: configuration.h:375
Config::fake_outputs
char * fake_outputs
Overwrites output detection (for testing), see src/fake_outputs.c.
Definition: configuration.h:173
current_configpath
char * current_configpath
Definition: config.c:15
context::has_warnings
bool has_warnings
Definition: configuration.h:36
Config::gaps
gaps_t gaps
Definition: configuration.h:259
Barbinding::command
char * command
The command which is to be executed for this button.
Definition: configuration.h:402
Barconfig::bar_colors::statusline
char * statusline
Definition: configuration.h:360
Config::disable_randr15
bool disable_randr15
Don’t use RandR 1.5 for querying outputs.
Definition: configuration.h:170
Config::smart_gaps
smart_gaps_t smart_gaps
Definition: configuration.h:265
Config::default_floating_border
border_style_t default_floating_border
The default border style for new floating windows.
Definition: configuration.h:215
Config::default_layout
layout_t default_layout
Definition: configuration.h:103
smart_gaps_t
smart_gaps_t
Definition: data.h:86
Barconfig::bar_colors
Definition: configuration.h:358
Barconfig::strip_workspace_numbers
bool strip_workspace_numbers
Strip workspace numbers? Configuration option is 'strip_workspace_numbers yes'.
Definition: configuration.h:342
Colortriple
Part of the struct Config.
Definition: configuration.h:54
Variable::value
char * value
Definition: configuration.h:69
Barconfig::bar_colors::active_workspace_bg
char * active_workspace_bg
Definition: configuration.h:372
Config::force_xinerama
bool force_xinerama
By default, use the RandR API for multi-monitor setups.
Definition: configuration.h:167
focused
struct Con * focused
Definition: tree.c:13
context::line_number
int line_number
Definition: configuration.h:38
Barconfig::bar_colors::inactive_workspace_text
char * inactive_workspace_text
Definition: configuration.h:377
C_LOAD
@ C_LOAD
Definition: configuration.h:420
Colortriple::text
color_t text
Definition: configuration.h:57
hide_edge_borders_mode_t
hide_edge_borders_mode_t
Definition: data.h:90
context::first_column
int first_column
Definition: configuration.h:45
Config::floating_minimum_width
int32_t floating_minimum_width
Definition: configuration.h:224
bindings
struct bindings_head * bindings
Definition: main.c:74
Barconfig::verbose
bool verbose
Enable verbose mode? Useful for debugging purposes.
Definition: configuration.h:353
Mode::name
char * name
Definition: configuration.h:83
context::has_errors
bool has_errors
Definition: configuration.h:35
update_barconfig
void update_barconfig(void)
Sends the current bar configuration as an event to all barconfig_update listeners.
Definition: config.c:35
Mode::bindings
struct bindings_head * bindings
Definition: configuration.h:85
tray_output_t
Definition: configuration.h:411
tray_output_t::output
char * output
Definition: configuration.h:412
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:174
color_t
Definition: libi3.h:413
Config::mouse_warping
warping_t mouse_warping
By default, when switching focus to a window on a different output (e.g.
Definition: configuration.h:126
Barconfig::font
char * font
Font specification for all text rendered on the bar.
Definition: configuration.h:327
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::container_stack_limit_value
int container_stack_limit_value
Definition: configuration.h:105
Barconfig::bar_colors::focused_statusline
char * focused_statusline
Definition: configuration.h:364
Colortriple::background
color_t background
Definition: configuration.h:56
TAILQ_ENTRY
#define TAILQ_ENTRY(type)
Definition: queue.h:327
Config::disable_focus_follows_mouse
bool disable_focus_follows_mouse
By default, focus follows mouse.
Definition: configuration.h:116
Barconfig::bar_colors::focused_workspace_bg
char * focused_workspace_bg
Definition: configuration.h:368
current_config
char * current_config
Definition: config.c:16
Colortriple::child_border
color_t child_border
Definition: configuration.h:59
context::compact_error
char * compact_error
Definition: configuration.h:42
C_RELOAD
@ C_RELOAD
Definition: configuration.h:421
Config::FOWA_FOCUS
@ FOWA_FOCUS
Definition: configuration.h:195
Config::config_client
Definition: configuration.h:228
i3.h
modes
struct modes_head modes
Definition: config.c:18
barconfigs
struct barconfig_head barconfigs
Definition: config.c:19
Variable::next_match
char * next_match
Definition: configuration.h:70
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:132
Config::disable_workspace_bar
bool disable_workspace_bar
By default, a workspace bar is drawn at the bottom of the screen.
Definition: configuration.h:138
Barconfig::bar_colors::active_workspace_border
char * active_workspace_border
Definition: configuration.h:371
SLIST_HEAD
SLIST_HEAD(modes_head, Mode) modes
Variable::variables
variables
Definition: configuration.h:73
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:44
Barconfig::outputs
char ** outputs
Outputs on which this bar should show up on.
Definition: configuration.h:282
Config::terminal
const char * terminal
Definition: configuration.h:97
Barconfig::bar_height
uint32_t bar_height
Defines the height of the bar in pixels.
Definition: configuration.h:356
Config::workspace_auto_back_and_forth
bool workspace_auto_back_and_forth
Automatic workspace back and forth switching.
Definition: configuration.h:179
smart_borders_t
smart_borders_t
Definition: data.h:82
C_VALIDATE
@ C_VALIDATE
Definition: configuration.h:419
Barbinding::release
bool release
If true, the command will be executed after the button is released.
Definition: configuration.h:405
Colortriple::indicator
color_t indicator
Definition: configuration.h:58
Barconfig::workspace_min_width
int workspace_min_width
The minimal width for workspace buttons.
Definition: configuration.h:338
libi3.h
context::filename
const char * filename
Definition: configuration.h:40
config
Config config
Definition: config.c:17
Mode
The configuration file can contain multiple sets of bindings.
Definition: configuration.h:82
Barconfig::bar_colors::separator
char * separator
Definition: configuration.h:361