nixo
/
gri3-wm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
gri3-wm/include/config_directives.h

104 lines
4.6 KiB
C
Raw Normal View History

add first bits of a (custom) config parser
2012-10-07 16:32:50 +02:00
/*
* vim:ts=4:sw=4:expandtab
*
* i3 - an improved dynamic tiling window manager
Update copyright notices and get rid of ranges The script used to make these changes can be found at: https://gist.github.com/Deiz/32322020f76d23e2bf8f
2015-04-04 02:17:56 +02:00
* © 2009 Michael Stapelberg and contributors (see also: LICENSE)
add first bits of a (custom) config parser
2012-10-07 16:32:50 +02:00
*
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
* config_directives.h: all config storing functions (see config_parser.c)
add first bits of a (custom) config parser
2012-10-07 16:32:50 +02:00
*
*/
Use #pragma once #pragma once is safer and simpler. According to Wikipedia it's supported by all major compilers.
2013-12-29 03:11:50 +01:00
#pragma once
add first bits of a (custom) config parser
2012-10-07 16:32:50 +02:00
Ensure all *.[ch] files include config.h Including config.h is necessary to get e.g. the _GNU_SOURCE define and any other definitions that autoconf declares. Hence, config.h needs to be included as the first header in each file. This is done either via: 1. Including "common.h" (i3bar) 2. Including "libi3.h" 3. Including "all.h" (i3) 4. Including <config.h> directly Also remove now-unused I3__FILE__, add copyright/license statement where missing and switch include/all.h to #pragma once.
2016-10-11 09:13:35 +02:00
#include <config.h>
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
#include "config_parser.h"
add first bits of a (custom) config parser
2012-10-07 16:32:50 +02:00
Abstract binding configuration to bindings.[ch] Create files bindings.[ch] to contain functions for configuring, finding, and running bindings. Use the new function `configure_binding` for binding configuration. This function adds a binding from config parameters. Export the function `modifiers_from_str` from config_directives.h. This change is made in preparation for the new bindmouse functionality.
2014-01-28 04:45:01 +01:00
/**
Use libxkbcommon for translating keysyms, support all XKB groups. fixes #1835 This commit improves the translation of keysyms to keycodes by loading keymaps using libxkbcommon-x11 and using libxkbcommon for figuring out the keymap, depending on each keybinding’s modifiers. This way, the upper layers of complex layouts are now usable with i3’s bindsym directive, such as de_neo’s layer 3 and higher. Furthermore, the commit generalizes the handling of different XKB groups. We formerly had support only for two separate groups, the default group 1, and group 2. While Mode_switch is only one way to switch to group 2, we called the binding option Mode_switch. With this commit, the new names Group1, Group2 (an alias for Mode_switch), Group3 and Group4 are introduced for configuring bindings. This is only useful for advanced keyboard layouts, such as people loading two keyboard layouts and switching between them (us, ru seems to be a popular combination). When grabbing keys, one can only specify the modifier mask, but not an XKB state mask (or value), so we still dynamically unbind and re-bind keys whenever the XKB group changes. The commit was manually tested using the following i3 config: bindsym Group4+n nop heya from group 4 bindsym Group3+n nop heya from group 3 bindsym Group2+n nop heya from group 2 bindsym n nop heya bindsym shift+N nop explicit shift binding bindsym shift+r nop implicit shift binding bindcode Group2+38 nop fallback overwritten in group 2 only bindcode 38 nop fallback …with the following layout: setxkbmap -layout "us,ua,ru,de" -variant ",winkeys,,neo" \ -option "grp:shift_caps_toggle,grp_led:scroll" \ -model pc104 -rules evdev By default (xkb group 1, us layout), pressing “n” will result in the “heya” message appearing. Pressing “a” will result in the “fallback” message appearing. “j” is not triggered. By pressing Shift+CapsLock you switch to the next group (xkb group 2, ua layout). Pressing “a” will result in the “fallback overwritten in group 2 only” message, pressing “n” will still result in “heya”. “j” is not triggered. In the next group (xkb group 3, ru layout), pressing “a” will result in the “fallback” message again, pressing “n” will result in “heya”, “j” is not triggered. In the last group (xkb group 4, de_neo layout), pressing “a” will still result in “fallback”, pressing “n” will result in “heya”, pressing “j” will result in “heya from group 4”. Pressing shift+n results in “explicit shift binding”, pressing shift+r results in “implicit shift binding”. This ensures that keysym translation falls back to looking at non-shift keys (“r” can be used instead of ”R”) and that the order of keybindings doesn’t play a role (“bindsym n” does not override “bindsym shift+n”, even though it’s specified earlier in the config). The fallback behavior ensures use-cases such as ticket #1775 are still covered. Only binding keys when the X server is in the corresponding XKB group ensures use-cases such as ticket #585 are still covered.
2015-08-23 22:49:32 +02:00
* A utility function to convert a string containing the group and modifiers to
* the corresponding bit mask.
Abstract binding configuration to bindings.[ch] Create files bindings.[ch] to contain functions for configuring, finding, and running bindings. Use the new function `configure_binding` for binding configuration. This function adds a binding from config parameters. Export the function `modifiers_from_str` from config_directives.h. This change is made in preparation for the new bindmouse functionality.
2014-01-28 04:45:01 +01:00
*/
Use libxkbcommon for translating keysyms, support all XKB groups. fixes #1835 This commit improves the translation of keysyms to keycodes by loading keymaps using libxkbcommon-x11 and using libxkbcommon for figuring out the keymap, depending on each keybinding’s modifiers. This way, the upper layers of complex layouts are now usable with i3’s bindsym directive, such as de_neo’s layer 3 and higher. Furthermore, the commit generalizes the handling of different XKB groups. We formerly had support only for two separate groups, the default group 1, and group 2. While Mode_switch is only one way to switch to group 2, we called the binding option Mode_switch. With this commit, the new names Group1, Group2 (an alias for Mode_switch), Group3 and Group4 are introduced for configuring bindings. This is only useful for advanced keyboard layouts, such as people loading two keyboard layouts and switching between them (us, ru seems to be a popular combination). When grabbing keys, one can only specify the modifier mask, but not an XKB state mask (or value), so we still dynamically unbind and re-bind keys whenever the XKB group changes. The commit was manually tested using the following i3 config: bindsym Group4+n nop heya from group 4 bindsym Group3+n nop heya from group 3 bindsym Group2+n nop heya from group 2 bindsym n nop heya bindsym shift+N nop explicit shift binding bindsym shift+r nop implicit shift binding bindcode Group2+38 nop fallback overwritten in group 2 only bindcode 38 nop fallback …with the following layout: setxkbmap -layout "us,ua,ru,de" -variant ",winkeys,,neo" \ -option "grp:shift_caps_toggle,grp_led:scroll" \ -model pc104 -rules evdev By default (xkb group 1, us layout), pressing “n” will result in the “heya” message appearing. Pressing “a” will result in the “fallback” message appearing. “j” is not triggered. By pressing Shift+CapsLock you switch to the next group (xkb group 2, ua layout). Pressing “a” will result in the “fallback overwritten in group 2 only” message, pressing “n” will still result in “heya”. “j” is not triggered. In the next group (xkb group 3, ru layout), pressing “a” will result in the “fallback” message again, pressing “n” will result in “heya”, “j” is not triggered. In the last group (xkb group 4, de_neo layout), pressing “a” will still result in “fallback”, pressing “n” will result in “heya”, pressing “j” will result in “heya from group 4”. Pressing shift+n results in “explicit shift binding”, pressing shift+r results in “implicit shift binding”. This ensures that keysym translation falls back to looking at non-shift keys (“r” can be used instead of ”R”) and that the order of keybindings doesn’t play a role (“bindsym n” does not override “bindsym shift+n”, even though it’s specified earlier in the config). The fallback behavior ensures use-cases such as ticket #1775 are still covered. Only binding keys when the X server is in the corresponding XKB group ensures use-cases such as ticket #585 are still covered.
2015-08-23 22:49:32 +02:00
i3_event_state_mask_t event_state_from_str(const char *str);
Abstract binding configuration to bindings.[ch] Create files bindings.[ch] to contain functions for configuring, finding, and running bindings. Use the new function `configure_binding` for binding configuration. This function adds a binding from config parameters. Export the function `modifiers_from_str` from config_directives.h. This change is made in preparation for the new bindmouse functionality.
2014-01-28 04:45:01 +01:00
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
/** The beginning of the prototype for every cfg_ function. */
Change the names of parser result structs Change the name of structs CommandResult and ConfigResult to CommandResultIR and ConfigResultIR to show they are an intermediate representation used during parsing.
2014-05-18 06:44:19 +02:00
#define I3_CFG Match *current_match, struct ConfigResultIR *result
add first bits of a (custom) config parser
2012-10-07 16:32:50 +02:00
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
/* Defines a configuration function, that is, anything that can be called by
* using 'call cfg_foo()' in parser-specs/.*.spec. Useful so that we don’t need
* to repeat the definition all the time. */
#define CFGFUN(name, ...) \
clang-format-3.5 **/*.h **/*.c This should be the last commit that formats a big bunch of files. From here on, whenever I merge patches, I’ll run clang-format like described in the title.
2014-06-19 11:20:32 +02:00
void cfg_##name(I3_CFG, ##__VA_ARGS__)
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
/* The following functions are called by the config parser, see
* parser-specs/config.spec. They get the parsed parameters and store them in
* our data structures, e.g. cfg_font gets a font name and stores it in
* config.font.
add first bits of a (custom) config parser
2012-10-07 16:32:50 +02:00
*
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
* Since they are so similar, individual comments were omitted. */
CFGFUN(criteria_init, int _state);
CFGFUN(criteria_add, const char *ctype, const char *cvalue);
CFGFUN(criteria_pop_state);
add first bits of a (custom) config parser
2012-10-07 16:32:50 +02:00
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(font, const char *font);
CFGFUN(exec, const char *exectype, const char *no_startup_id, const char *command);
CFGFUN(for_window, const char *command);
CFGFUN(floating_minimum_size, const long width, const long height);
CFGFUN(floating_maximum_size, const long width, const long height);
CFGFUN(default_orientation, const char *orientation);
CFGFUN(workspace_layout, const char *layout);
CFGFUN(workspace_back_and_forth, const char *value);
CFGFUN(focus_follows_mouse, const char *value);
Add configuration option for disabling mouse warping This patch adds a new configuration option "mouse_warping [output|none]". When mouse warping is disabled, mouse cursor does not jump to middle of current screen when changing workspaces between multiple outputs. This introduces a "special" cursor state, where focus is in one window and cursor on another. Useful for eg. scrolling a web page with mouse wheel while typing into another window on keyboard.
2014-03-24 18:03:05 +01:00
CFGFUN(mouse_warping, const char *value);
Add "focus_wrapping" option Fixes #2352.
2017-09-15 04:57:55 +02:00
CFGFUN(focus_wrapping, const char *value);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(force_focus_wrapping, const char *value);
CFGFUN(force_xinerama, const char *value);
Implement RandR 1.5 support (#2580) This comes with the intentionally undocumented --disable-randr15 command line flag and disable-randr15 configuration directive. We will add documentation before the release if and only if it turns out that users actually need to use this flag in their setups. Ideally, nobody would need to use the flag and everything would just keep working, but it’s better to be safe than sorry. fixes #1799
2016-11-28 18:20:46 +01:00
CFGFUN(disable_randr15, const char *value);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(fake_outputs, const char *outputs);
CFGFUN(force_display_urgency_hint, const long duration_ms);
Added 'focus_on_window_activation' directive When a window receives a _NET_ACTIVE_WINDOW message, it can steal the focus. This may not be preferable to all users. With this directive, the user can choose from one of the following: 1) 'smart' - focus the container if its workspace is visible, otherwise set the urgency flag (default) 2) 'urgent' - always set the urgency flag, do not steal focus 3) 'focus' - always switch focus, never set the urgency hint 4) 'none' - ignore the request entirely (do not switch focus, nor set the urgency hint) fixes #1426
2015-03-30 22:07:48 +02:00
CFGFUN(focus_on_window_activation, const char *mode);
Add title_align config directive Controls the window titles alignment in title bars. Possible values are: - left - center - right Co-authored-by: Orestis Floros <orestisf1993@gmail.com> - Made title_align a config directive instead of a command. Helps with some tree_render() issues we had. - Made title_max_width the same for all 3 cases. - Modified title offset calculations and added explanations for each case. - Append title_padding to mark_width if a mark exists. Fixes #1750
2018-04-22 03:55:37 +02:00
CFGFUN(title_align, const char *alignment);
Make show_marks configurable Introduce a config directive "show_marks [yes|no]" to en- or disable drawing marks on window decorations. To not change the look & feel of existing configurations, the default is "no".
2015-03-29 00:26:49 +01:00
CFGFUN(show_marks, const char *value);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(hide_edge_borders, const char *borders);
Allow assign to output Implements the "assign" part of issue #2764.
2017-09-16 19:54:44 +02:00
CFGFUN(assign_output, const char *output);
Allow assign to workspace by number Makes "assign [<criteria>] workspace number <number>" work in the same manner as "move to workspace number <number>" instead of assigning the window to a workspace named "number <number>". config.spec is modified to expect a 'number' string and an extra argument is used in cfg_assign. For workspaces that don't exist yet, workspace_get is used as a fallback. This also allows the user to assign to "<number> <workspace>" eg "2: work" and the full name will be used if workspace number 2 doesn't exist yet. Fixes #2590.
2017-08-28 04:14:03 +02:00
CFGFUN(assign, const char *workspace, bool is_number);
Added config directive 'no_focus <criteria>' (#1416)
2015-03-29 17:30:14 +02:00
CFGFUN(no_focus);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(ipc_socket, const char *path);
Kill misbehaving subscribed clients instead of hanging This change only affects clients that are subscribed to events, which should be the main cause of our problems. In the common case (no buffered data) the behaviour doesn't change at all: the message is sent directly, no ev_io / ev_timeout callback is enabled. Once a write to a client's socket is not completed fully (returns with EAGAIN error), we put the message in the tail of a queue and init an ev_io callback and a corresponding timer. If the timer is triggered first, the socket is closed and the client connection is removed. If the socket becomes writeable before the timeout we either reset the timer if we couldn't push all the buffered data or completely remove it if everything was pushed. We could also replace ipc_send_message() for all client connections in i3, not just those subscribed to events. Furthermore, we could limit the amount of messages stored and increase the timeout (or use multiple timeouts): eg it's ok if a client is not reading for 10 seconds and we are only holding 5KB of messages for them but it is not ok if they are inactive for 5 seconds and we have 30MB of messages held. Closes #2999 Closes #2539
2018-04-23 11:20:05 +02:00
CFGFUN(ipc_kill_timeout, const long timeout_ms);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(restart_state, const char *path);
CFGFUN(popup_during_fullscreen, const char *value);
Rename decoration_border to child_border. fixes #2154
2016-01-09 22:47:33 +01:00
CFGFUN(color, const char *colorclass, const char *border, const char *background, const char *text, const char *indicator, const char *child_border);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(color_single, const char *colorclass, const char *color);
CFGFUN(floating_modifier, const char *modifiers);
Add default_{,floating_}border to config userguide: document default_{,floating_}border 201-config-parser.t: add new tokens to $expected_all_tokens 201-config-parser-t: fix whitespace closes i3/i3#2702
2018-02-12 15:11:19 +01:00
CFGFUN(default_border, const char *windowtype, const char *border, const long width);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(workspace, const char *workspace, const char *output);
Introduce --exclude-titlebar flag for mouse bindings. (#2703) This introduces the flag --exclude-titlebar for mouse bindings which allows bindings like bindsym --whole-window --border --exclude-titlebar button3 focus fixes #2347
2017-05-02 09:08:42 +02:00
CFGFUN(binding, const char *bindtype, const char *modifiers, const char *key, const char *release, const char *border, const char *whole_window, const char *exclude_titlebar, const char *command);
add first bits of a (custom) config parser
2012-10-07 16:32:50 +02:00
Make pango markup in mode names optional with a flag. This introduces the flag "--pango" on the mode config directive to explicitly enable pango markup for mode names. Not setting this will cause the mode name to be rendered as is. This fixes a regression in 4.11 where mode names containing characters such as '<' would break user's configs as they didn't escape these characters. fixes #1992
2015-10-12 23:43:47 +02:00
CFGFUN(enter_mode, const char *pango_markup, const char *mode);
Introduce --exclude-titlebar flag for mouse bindings. (#2703) This introduces the flag --exclude-titlebar for mouse bindings which allows bindings like bindsym --whole-window --border --exclude-titlebar button3 focus fixes #2347
2017-05-02 09:08:42 +02:00
CFGFUN(mode_binding, const char *bindtype, const char *modifiers, const char *key, const char *release, const char *border, const char *whole_window, const char *exclude_titlebar, const char *command);
add first bits of a (custom) config parser
2012-10-07 16:32:50 +02:00
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(bar_font, const char *font);
Add support for a custom separator symbol This introduces a "separator_symbol" property for the i3bar configuration. If set, the specified string will be used as a separator instead of a vertical line. Since it is an optional configuration, complete backwards compatibility is given. fixes #1472
2015-03-24 23:07:25 +01:00
CFGFUN(bar_separator_symbol, const char *separator);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(bar_mode, const char *mode);
introduced i3 command for changing the hidden state and the mode of i3bar The hidden_state and mode of each i3bar instance can now be controlled from within i3. Therefore, two new i3 command were introduced: _ bar hidden_state show|hide|toggle [<bar_id>] show: always show the bar hide: normal hide mode toggle: toggle between show and hide (individually for each bar) _ bar mode dock|hide|invisible|toggle [<bar_id>] hide,dock: like before invisible: always keep the bar hidden toggle: toggle between dock and hide (individually for each bar) This patch introduces a hidden_state ("hidden_state hide|show") in the barconfig, which indicates the current hidden_state of each i3bar instance. It only affects the bar when in hide mode. Additionally, a new invisible mode was introduced. In order to change the hidden_state or mode of the bar from i3, a barconfig-update event was introduced, for which a bar can subscribe and the bar then gets notified about the currently set hidden_state and mode in its barconfig. For convenience, an id field ("id <bar_id>") was added to the barconfig, where one can set the desired id for the corresponding bar. If the id is not specified, i3 will deterministically choose an id; otherwise, with the previous random approach for finding a new id, which is actually not shared with i3bar, as it would determine its id on startup, the event-subscription would be destroyed on reload. Still, this issue remains when manually changing the bar_id in the config and then reloading. fixes #833, #651
2013-05-25 14:30:00 +02:00
CFGFUN(bar_hidden_state, const char *hidden_state);
CFGFUN(bar_id, const char *bar_id);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(bar_output, const char *output);
CFGFUN(bar_verbose, const char *verbose);
i3bar: make modifier behave like floating_modifier Pressed modifiers are determined like in click.c:handle_button_press. Fixes #3234.
2018-04-16 20:10:10 +02:00
CFGFUN(bar_modifier, const char *modifiers);
i3bar: implement custom mouse wheel commands Users can specify a command to run when a button was pressed on i3bar to override the default behavior. Currently only the mouse wheel buttons are supported. This is useful for disabling the scroll wheel action or running scripts that implement custom behavior for these buttons. Example: bar { wheel_up_cmd nop wheel_down_cmd exec ~/.i3/scripts/custom_wheel_down } fixes #1104
2014-07-04 11:53:22 +02:00
CFGFUN(bar_wheel_up_cmd, const char *command);
CFGFUN(bar_wheel_down_cmd, const char *command);
Add '--release' flag for bindsym in the bar block i3bar's handle_button is modified to also handle XCB_BUTTON_RELEASE events. During these button release events, only custom commands are checked to avoid sending multiple workspace ipc messages. The way this patch is implemented will allow to assign a custom command for both the press and release of the same button: bar { ... bindsym buttonX exec command1 bindsym --release buttonX exec command2 } Fixes #3068.
2017-12-08 01:23:15 +01:00
CFGFUN(bar_bindsym, const char *button, const char *release, const char *command);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(bar_position, const char *position);
CFGFUN(bar_i3bar_command, const char *i3bar_command);
CFGFUN(bar_color, const char *colorclass, const char *border, const char *background, const char *text);
CFGFUN(bar_socket_path, const char *socket_path);
CFGFUN(bar_tray_output, const char *output);
Configurable tray padding.
2015-06-09 10:06:45 +02:00
CFGFUN(bar_tray_padding, const long spacing_px);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(bar_color_single, const char *colorclass, const char *color);
CFGFUN(bar_status_command, const char *command);
Add new bar.binding_mode_indicator configuration. i3 current behavior hides the binding mode indicator when workspace buttons are disabled. This patch adds a new configuration for i3bar called 'binding_mode_indicator' which acts like the workspace_buttons. It is now possible to configure i3bar to hide the workspace buttons and keep showing the binding mode indicator. This should make the hide workspace buttons configuration more convenient for those who are heavily using binding modes. Default value for binding_mode_indicator is true.
2013-08-09 05:30:14 +02:00
CFGFUN(bar_binding_mode_indicator, const char *value);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(bar_workspace_buttons, const char *value);
i3bar: implement custom workspace numbers config Implement the configuration option within the bar config directive for custom workspace numbers with the directive `strip_workspace_numbers yes`. This directive strips the workspace name of the number prefix and delimiter. When the workspace name consists only of the number, it will default to show the number. For example: * "2:5" -> "5" * "4:$" -> "$" * "8" -> "8" This allows customization of i3bar for alternate ordering of workspaces which has a legitimate use for alternate keyboard layouts such as Dvorak. fixes #1131
2014-05-05 19:56:47 +02:00
CFGFUN(bar_strip_workspace_numbers, const char *value);
Add strip_workspace_name See the issue #3163 (https://github.com/i3/i3/issues/3163). Add strip_workspace_name to strip off the workspace name.
2018-03-10 05:49:09 +01:00
CFGFUN(bar_strip_workspace_name, const char *value);
Add new command skeleton 'bindsym <button> <command>' for 'bar' block.
2015-05-02 21:53:23 +02:00
CFGFUN(bar_start);
port the entire old config parser to the new one
2012-10-08 13:23:48 +02:00
CFGFUN(bar_finish);