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 
73  variables;
74 };
75 
82 struct Mode {
83  char *name;
85  struct bindings_head *bindings;
86 
87  SLIST_ENTRY(Mode)
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 {
231  struct Colortriple focused_inactive;
232  struct Colortriple unfocused;
233  struct Colortriple urgent;
234  struct Colortriple placeholder;
235  } client[QUBE_NUM_LABELS];
236  struct config_bar {
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 
264 struct Barconfig {
267  char *id;
268 
273  char **outputs;
274 
275  /* List of outputs on which the tray is allowed to be shown, in order.
276  * The special value "none" disables it (per default, it will be shown) and
277  * the special value "primary" enabled it on the primary output. */
278  TAILQ_HEAD(tray_outputs_head, tray_output_t)
279  tray_outputs;
280 
281  /* Padding around the tray icons. */
282  int tray_padding;
283 
287  char *socket_path;
288 
290  enum { M_DOCK = 0,
291  M_HIDE = 1,
292  M_INVISIBLE = 2 } mode;
293 
294  /* The current hidden_state of the bar, which indicates whether it is hidden or shown */
295  enum { S_HIDE = 0,
296  S_SHOW = 1 } hidden_state;
297 
299  uint32_t modifier;
300 
301  TAILQ_HEAD(bar_bindings_head, Barbinding)
302  bar_bindings;
303 
305  enum { P_BOTTOM = 0,
306  P_TOP = 1 } position;
307 
312 
316 
318  char *font;
319 
322 
327 
331 
335 
339 
341  bool verbose;
342 
343  struct bar_colors {
344  char *background;
345  char *statusline;
346  char *separator;
347 
351 
355 
359 
363 
367 
371  } colors;
372 
374  configs;
375 };
376 
382 struct Barbinding {
385 
387  char *command;
388 
390  bool release;
391 
392  TAILQ_ENTRY(Barbinding)
393  bindings;
394 };
395 
397  char *output;
398 
399  TAILQ_ENTRY(tray_output_t)
400  tray_outputs;
401 };
402 
415 bool parse_configuration(const char *override_configpath, bool use_nagbar);
416 
424 void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload);
425 
431 void ungrab_all_keys(xcb_connection_t *conn);
432 
437 void update_barconfig(void);
438 
448 void kill_configerror_nagbar(bool wait_for_it);
border_style_t default_border
The default border style for new windows.
int num_outputs
Number of outputs in the outputs array.
char * i3bar_command
Command that should be run to execute i3bar, give a full path if i3bar is not in your $PATH...
int32_t floating_maximum_height
int number_barconfigs
color_t text
Definition: configuration.h:57
char * ipc_socket_path
color_t background
Definition: configuration.h:56
bool has_warnings
Definition: configuration.h:36
struct barconfig_head barconfigs
Definition: config.c:19
bool strip_workspace_name
Strip workspace name? Configuration option is &#39;strip_workspace_name yes&#39;.
i3Font font
Definition: configuration.h:98
border_style_t
Definition: data.h:62
bool disable_focus_follows_mouse
By default, focus follows mouse.
warping_t
Mouse pointer warping modes.
Definition: data.h:131
int32_t floating_maximum_width
Maximum and minimum dimensions of a floating window.
float workspace_urgency_timer
By default, urgency is cleared immediately when switching to another workspace leads to focusing the ...
xcb_connection_t * conn
XCB connection and root screen.
Definition: main.c:44
focus_wrapping_t focus_wrapping
When focus wrapping is enabled (the default), attempting to move focus past the edge of the screen (i...
int container_stack_limit_value
int default_floating_border_width
layout_t
Container layouts.
Definition: data.h:91
bool workspace_auto_back_and_forth
Automatic workspace back and forth switching.
int default_border_width
char * name
Definition: configuration.h:83
struct modes_head modes
Definition: config.c:18
The configuration file can contain multiple sets of bindings.
Definition: configuration.h:82
Used during the config file lexing/parsing to keep the state of the lexer in order to provide useful ...
Definition: configuration.h:34
Defines a mouse command to be executed instead of the default behavior when clicking on the non-statu...
void load_configuration(xcb_connection_t *conn, const char *override_configfile, bool reload)
Reads the configuration from ~/.i3/config or /etc/i3/config if not found.
Definition: config.c:73
bool parse_configuration(const char *override_configpath, bool use_nagbar)
Finds the configuration file to use (either the one specified by override_configpath), the user’s one or the system default) and calls parse_file().
Definition: config.c:48
Definition: libi3.h:415
int first_column
Definition: configuration.h:45
bool verbose
Enable verbose mode? Useful for debugging purposes.
hide_edge_borders_mode_t hide_edge_borders
Remove borders if they are adjacent to the screen edge.
int32_t floating_minimum_height
TAILQ_HEAD(barconfig_head, Barconfig) barconfigs
char * key
Definition: configuration.h:68
char * font
Font specification for all text rendered on the bar.
bool hide_binding_mode_indicator
Hide mode button? Configuration option is &#39;binding_mode_indicator no&#39; but we invert the bool for the ...
char ** outputs
Outputs on which this bar should show up on.
warping_t mouse_warping
By default, when switching focus to a window on a different output (e.g.
char * fake_outputs
Overwrites output detection (for testing), see src/fake_outputs.c.
char * status_command
Command that should be run to get a statusline, for example &#39;i3status&#39;.
color_t indicator
Definition: configuration.h:58
bool release
If true, the command will be executed after the button is released.
#define TAILQ_ENTRY(type)
Definition: queue.h:327
int default_orientation
Default orientation for new containers.
bool force_xinerama
By default, use the RandR API for multi-monitor setups.
char * compact_error
Definition: configuration.h:42
const char * terminal
Definition: configuration.h:97
SLIST_HEAD(modes_head, Mode) modes
Holds a user-assigned variable for parsing the configuration file.
Definition: configuration.h:67
char * next_match
Definition: configuration.h:70
char * current_configpath
Definition: config.c:15
void kill_configerror_nagbar(bool wait_for_it)
Kills the configerror i3-nagbar process, if any.
uint32_t modifier
Bar modifier (to show bar when in hide mode).
#define SLIST_ENTRY(type)
Definition: queue.h:101
bool strip_workspace_numbers
Strip workspace numbers? Configuration option is &#39;strip_workspace_numbers yes&#39;.
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
struct Con * focused
Definition: tree.c:13
char * command
The command which is to be executed for this button.
Holds the status bar configuration (i3bar).
color_t border
Definition: configuration.h:55
layout_t default_layout
Holds part of the configuration (the part which is not already in dedicated structures in include/dat...
Definition: configuration.h:96
bool hide_workspace_buttons
Hide workspace buttons? Configuration option is &#39;workspace_buttons no&#39; but we invert the bool to get ...
bool has_errors
Definition: configuration.h:35
Part of the struct Config.
Definition: configuration.h:54
int32_t floating_minimum_width
hide_edge_borders_mode_t
Definition: data.h:79
uint32_t floating_modifier
The modifier which needs to be pressed in combination with your mouse buttons to do things with float...
char * current_config
Definition: config.c:16
bool disable_randr15
Don’t use RandR 1.5 for querying outputs.
char * separator_symbol
A custom separator to use instead of a vertical line.
int input_code
The button to be used (e.g., 1 for "button1").
char * line_copy
Definition: configuration.h:39
color_t child_border
Definition: configuration.h:59
const char * filename
Definition: configuration.h:40
Data structure for cached font information:
Definition: libi3.h:58
int line_number
Definition: configuration.h:38
struct bindings_head * bindings
Definition: configuration.h:85
void update_barconfig(void)
Sends the current bar configuration as an event to all barconfig_update listeners.
Definition: config.c:35
bool show_marks
Specifies whether or not marks should be displayed in the window decoration.
int container_stack_limit
bool disable_workspace_bar
By default, a workspace bar is drawn at the bottom of the screen.
char * restart_state_path
char * value
Definition: configuration.h:69
focus_wrapping_t
Focus wrapping modes.
Definition: data.h:139
border_style_t default_floating_border
The default border style for new floating windows.
bool pango_markup
Definition: configuration.h:84
#define QUBE_NUM_LABELS
Definition: data.h:160
int last_column
Definition: configuration.h:46
Config config
Definition: config.c:17
char * id
Automatically generated ID for this bar config.