#include "all.h"
#include <xkbcommon/xkbcommon.h>
#include <xkbcommon/xkbcommon-x11.h>

Include dependency graph for bindings.c:

Data Structures
struct	resolve

Macros
#define	GRAB_KEY(modifier)

#define	ADD_TRANSLATED_KEY(mods)

#define	ADD_TRANSLATED_KEY(code, mods)

Functions
static struct Mode *	mode_from_name (const char *name, bool pango_markup)

Binding *	configure_binding (const char bindtype, const char modifiers, const char input_code, const char release, const char border, const char whole_window, const char exclude_titlebar, const char command, const char *modename, bool pango_markup)
	Adds a binding from config parameters given as strings and returns a pointer to the binding structure. More...

static bool	binding_in_current_group (const Binding *bind)

static void	grab_keycode_for_binding (xcb_connection_t conn, Binding bind, uint32_t keycode)

void	grab_all_keys (xcb_connection_t *conn)
	Grab the bound keys (tell X to send us keypress events for those keycodes) More...

void	regrab_all_buttons (xcb_connection_t *conn)
	Release the button grabs on all managed windows and regrab them, reevaluating which buttons need to be grabbed. More...

static Binding *	get_binding (i3_event_state_mask_t state_filtered, bool is_release, uint16_t input_code, input_type_t input_type)

Binding *	get_binding_from_xcb_event (xcb_generic_event_t *event)
	Returns a pointer to the Binding that matches the given xcb event or NULL if no such binding exists. More...

static void	add_keycode_if_matches (struct xkb_keymap keymap, xkb_keycode_t key, void data)

void	translate_keysyms (void)
	Translates keysymbols to keycodes for all bindings which use keysyms. More...

void	switch_mode (const char *new_mode)
	Switches the key bindings to the given mode, if the mode exists. More...

static int	reorder_binding_cmp (const void a, const void b)

static void	reorder_bindings_of_mode (struct Mode *mode)

void	reorder_bindings (void)
	Reorders bindings by event_state_mask descendingly so that get_binding() correctly matches more specific bindings before more generic bindings. More...

void	check_for_duplicate_bindings (struct context *context)
	Checks for duplicate key bindings (the same keycode or keysym is configured more than once). More...

static Binding *	binding_copy (Binding *bind)

void	binding_free (Binding *bind)
	Frees the binding. More...

CommandResult *	run_binding (Binding bind, Con con)
	Runs the given binding and handles parse errors. More...

static int	fill_rmlvo_from_root (struct xkb_rule_names *xkb_names)

bool	load_keymap (void)
	Loads the XKB keymap from the X11 server and feeds it to xkbcommon. More...

int *	bindings_get_buttons_to_grab (void)
	Returns a list of buttons that should be grabbed on a window. More...

Variables
static struct xkb_context *	xkb_context

static struct xkb_keymap *	xkb_keymap

pid_t	command_error_nagbar_pid = -1

const char *	DEFAULT_BINDING_MODE = "default"
	The name of the default mode. More...

Macro Definition Documentation

◆ ADD_TRANSLATED_KEY [1/2]

#define ADD_TRANSLATED_KEY ( mods )

Value:

do {                                                                                   \
        struct Binding_Keycode *binding_keycode = smalloc(sizeof(struct Binding_Keycode)); \
        binding_keycode->modifiers = (mods);                                               \
        binding_keycode->keycode = key;                                                    \
        TAILQ_INSERT_TAIL(&(bind->keycodes_head), binding_keycode, keycodes);              \
    } while (0)

Referenced by add_keycode_if_matches(), and translate_keysyms().

◆ ADD_TRANSLATED_KEY [2/2]

#define ADD_TRANSLATED_KEY	(	code,
		mods
	)

Value:

do {                                                                                   \
        struct Binding_Keycode *binding_keycode = smalloc(sizeof(struct Binding_Keycode)); \
        binding_keycode->modifiers = (mods);                                               \
        binding_keycode->keycode = (code);                                                 \
        TAILQ_INSERT_TAIL(&(bind->keycodes_head), binding_keycode, keycodes);              \
    } while (0)

◆ GRAB_KEY

#define GRAB_KEY ( modifier )

Value:

do {                                                                                         \
        xcb_grab_key(conn, 0, root, modifier, keycode, XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC); \
    } while (0)

Referenced by grab_keycode_for_binding().

Function Documentation

◆ add_keycode_if_matches()

static void add_keycode_if_matches	(	struct xkb_keymap *	keymap,
		xkb_keycode_t	key,
		void *	data
	)

static

Definition at line 370 of file bindings.c.

References ADD_TRANSLATED_KEY, resolve::bind, DLOG, Binding::event_state_mask, resolve::keysym, xcb_numlock_mask, resolve::xkb_state, resolve::xkb_state_no_shift, resolve::xkb_state_numlock, and resolve::xkb_state_numlock_no_shift.

Referenced by translate_keysyms().

◆ binding_copy()

static Binding* binding_copy ( Binding * bind )

static

Definition at line 782 of file bindings.c.

References resolve::bind, Binding::command, Binding_Keycode::keycodes, Binding::keycodes_head, smalloc(), sstrdup(), Binding::symbol, TAILQ_FOREACH, TAILQ_INIT, and TAILQ_INSERT_TAIL.

Referenced by run_binding().

Here is the call graph for this function:

◆ binding_free()

void binding_free ( Binding * bind )

Frees the binding.

If bind is null, it simply returns.

Definition at line 803 of file bindings.c.

References Binding::command, FREE, Binding_Keycode::keycodes, Binding::keycodes_head, Binding::symbol, TAILQ_EMPTY, TAILQ_FIRST, and TAILQ_REMOVE.

Referenced by load_configuration(), and run_binding().

◆ binding_in_current_group()

static bool binding_in_current_group ( const Binding * bind )

static

Definition at line 106 of file bindings.c.

References ELOG, Binding::event_state_mask, I3_XKB_GROUP_MASK_1, I3_XKB_GROUP_MASK_2, I3_XKB_GROUP_MASK_3, I3_XKB_GROUP_MASK_4, I3_XKB_GROUP_MASK_ANY, and xkb_current_group.

Referenced by grab_all_keys().

◆ bindings_get_buttons_to_grab()

int* bindings_get_buttons_to_grab ( void )

Returns a list of buttons that should be grabbed on a window.

This list will always contain 1–3, all higher buttons will only be returned if there is a whole-window binding for it on some window in the current config. The list is terminated by a 0.

Definition at line 1000 of file bindings.c.

References B_MOUSE, resolve::bind, bindings, ELOG, Binding::input_type, parse_long(), scalloc(), Binding::symbol, TAILQ_FOREACH, and Binding::whole_window.

Referenced by manage_window(), and regrab_all_buttons().

Here is the call graph for this function:

◆ check_for_duplicate_bindings()

void check_for_duplicate_bindings ( struct context * context )

Checks for duplicate key bindings (the same keycode or keysym is configured more than once).

If a duplicate binding is found, a message is printed to stderr and the has_errors variable is set to true, which will start i3-nagbar.

Definition at line 735 of file bindings.c.

References resolve::bind, bindings, Binding::command, ELOG, Binding::event_state_mask, context::has_errors, Binding::input_type, Binding::keycode, Binding::release, Binding::symbol, and TAILQ_FOREACH.

Referenced by parse_file().

◆ configure_binding()

Binding* configure_binding	(	const char *	bindtype,
		const char *	modifiers,
		const char *	input_code,
		const char *	release,
		const char *	border,
		const char *	whole_window,
		const char *	exclude_titlebar,
		const char *	command,
		const char *	mode,
		bool	pango_markup
	)

Adds a binding from config parameters given as strings and returns a pointer to the binding structure.

Returns NULL if the input code could not be parsed.

Definition at line 57 of file bindings.c.

References B_KEYBOARD, B_MOUSE, bindings, Mode::bindings, Binding::border, Binding::command, DLOG, ELOG, event_state_from_str(), Binding::event_state_mask, Binding::exclude_titlebar, FREE, I3_XKB_GROUP_MASK_1, I3_XKB_GROUP_MASK_2, I3_XKB_GROUP_MASK_3, I3_XKB_GROUP_MASK_4, Binding::input_type, Binding::keycode, Binding::keycodes_head, mode_from_name(), parse_long(), Binding::release, scalloc(), sstrdup(), Binding::symbol, TAILQ_INIT, TAILQ_INSERT_TAIL, and Binding::whole_window.

Referenced by CFGFUN().

Here is the call graph for this function:

◆ fill_rmlvo_from_root()

static int fill_rmlvo_from_root ( struct xkb_rule_names * xkb_names )

static

Definition at line 869 of file bindings.c.

References conn, DLOG, root, root_screen, and sasprintf().

Referenced by load_keymap().

Here is the call graph for this function:

◆ get_binding()

static Binding* get_binding	(	i3_event_state_mask_t	state_filtered,
		bool	is_release,
		uint16_t	input_code,
		input_type_t	input_type
	)

static

Definition at line 199 of file bindings.c.

References B_KEYBOARD, bindings, DLOG, Binding::event_state_mask, Binding::input_type, Binding_Keycode::keycode, Binding::keycode, Binding_Keycode::keycodes, Binding::keycodes_head, Binding_Keycode::modifiers, Binding::release, Binding::symbol, TAILQ_END, and TAILQ_FOREACH.

Referenced by get_binding_from_xcb_event().

◆ get_binding_from_xcb_event()

Binding* get_binding_from_xcb_event ( xcb_generic_event_t * event )

Returns a pointer to the Binding that matches the given xcb event or NULL if no such binding exists.

Definition at line 301 of file bindings.c.

References B_KEYBOARD, B_MOUSE, DLOG, get_binding(), I3_XKB_GROUP_MASK_1, I3_XKB_GROUP_MASK_2, I3_XKB_GROUP_MASK_3, and I3_XKB_GROUP_MASK_4.

Referenced by handle_button_press(), handle_key_press(), and route_click().

Here is the call graph for this function:

◆ grab_all_keys()

void grab_all_keys ( xcb_connection_t * conn )

Grab the bound keys (tell X to send us keypress events for those keycodes)

Definition at line 147 of file bindings.c.

References B_KEYBOARD, binding_in_current_group(), bindings, DLOG, grab_keycode_for_binding(), Binding::input_type, Binding_Keycode::keycode, Binding::keycode, Binding_Keycode::keycodes, Binding::keycodes_head, Binding_Keycode::modifiers, root, and TAILQ_FOREACH.

Referenced by handle_event(), handle_mapping_notify(), load_configuration(), main(), and switch_mode().

Here is the call graph for this function:

◆ grab_keycode_for_binding()

static void grab_keycode_for_binding	(	xcb_connection_t *	conn,
		Binding *	bind,
		uint32_t	keycode
	)

static

Definition at line 125 of file bindings.c.

References DLOG, Binding::event_state_mask, GRAB_KEY, and xcb_numlock_mask.

Referenced by grab_all_keys().

◆ load_keymap()

bool load_keymap ( void )

Loads the XKB keymap from the X11 server and feeds it to xkbcommon.

Definition at line 944 of file bindings.c.

References conn, ELOG, fill_rmlvo_from_root(), LOG, xkb_context, xkb_keymap, and xkb_supported.

Referenced by handle_event(), and main().

Here is the call graph for this function:

◆ mode_from_name()

static struct Mode* mode_from_name	(	const char *	name,
		bool	pango_markup
	)

static

Definition at line 30 of file bindings.c.

References Mode::bindings, modes, Mode::name, Mode::pango_markup, scalloc(), SLIST_FOREACH, SLIST_INSERT_HEAD, sstrdup(), and TAILQ_INIT.

Referenced by configure_binding().

Here is the call graph for this function:

◆ regrab_all_buttons()

void regrab_all_buttons ( xcb_connection_t * conn )

Release the button grabs on all managed windows and regrab them, reevaluating which buttons need to be grabbed.

Definition at line 177 of file bindings.c.

References all_cons, bindings_get_buttons_to_grab(), FREE, Window::id, TAILQ_FOREACH, Con::window, and xcb_grab_buttons().

Referenced by load_configuration().

Here is the call graph for this function:

◆ reorder_binding_cmp()

static int reorder_binding_cmp	(	const void *	a,
		const void *	b
	)

static

Definition at line 664 of file bindings.c.

References Binding::event_state_mask.

Referenced by reorder_bindings_of_mode().

◆ reorder_bindings()

void reorder_bindings ( void )

Reorders bindings by event_state_mask descendingly so that get_binding() correctly matches more specific bindings before more generic bindings.

Take the following binding configuration as an example:

bindsym n nop lower-case n pressed bindsym Shift+n nop upper-case n pressed

Without reordering, the first binding’s event_state_mask of 0x0 would match the actual event_stat_mask of 0x1 and hence trigger instead of the second keybinding.

Definition at line 718 of file bindings.c.

References bindings, Mode::bindings, current_mode, modes, reorder_bindings_of_mode(), and SLIST_FOREACH.

Referenced by parse_file().

Here is the call graph for this function:

◆ reorder_bindings_of_mode()

static void reorder_bindings_of_mode ( struct Mode * mode )

static

Definition at line 676 of file bindings.c.

References bindings, Mode::bindings, reorder_binding_cmp(), scalloc(), TAILQ_EMPTY, TAILQ_FOREACH, TAILQ_INIT, TAILQ_INSERT_TAIL, and TAILQ_REMOVE.

Referenced by reorder_bindings().

Here is the call graph for this function:

◆ run_binding()

CommandResult* run_binding	(	Binding *	bind,
		Con *	con
	)

Runs the given binding and handles parse errors.

If con is passed, it will execute the command binding with that container selected by criteria. Returns a CommandResult for running the binding's command. Caller should render tree if needs_tree_render is true. Free with command_result_free().

Definition at line 826 of file bindings.c.

References binding_copy(), binding_free(), Binding::command, command_error_nagbar_pid, config, errorfilename, Config::font, ipc_send_binding_event(), CommandResult::needs_tree_render, parse_command(), CommandResult::parse_error, Font::pattern, sasprintf(), sstrdup(), start_nagbar(), and tree_render().