i3
click.c
Go to the documentation of this file.
1/*
2 * vim:ts=4:sw=4:expandtab
3 *
4 * i3 - an improved tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
6 *
7 * click.c: Button press (mouse click) events.
8 *
9 */
10#include "all.h"
11
12#include <time.h>
13
14typedef enum { CLICK_BORDER = 0,
17
18/*
19 * Finds the correct pair of first/second cons between the resize will take
20 * place according to the passed border position (top, left, right, bottom),
21 * then calls resize_graphical_handler().
22 *
23 */
24static bool tiling_resize_for_border(Con *con, border_t border, xcb_button_press_event_t *event, bool use_threshold) {
25 DLOG("border = %d, con = %p\n", border, con);
26 Con *second = NULL;
27 Con *first = con;
28 direction_t search_direction;
29 switch (border) {
30 case BORDER_LEFT:
31 search_direction = D_LEFT;
32 break;
33 case BORDER_RIGHT:
34 search_direction = D_RIGHT;
35 break;
36 case BORDER_TOP:
37 search_direction = D_UP;
38 break;
39 case BORDER_BOTTOM:
40 search_direction = D_DOWN;
41 break;
42 default:
43 ELOG("BUG: invalid border value %d\n", border);
44 return false;
45 }
46
47 bool res = resize_find_tiling_participants(&first, &second, search_direction, false);
48 if (!res) {
49 DLOG("No second container in this direction found.\n");
50 return false;
51 }
52 if (first->fullscreen_mode != second->fullscreen_mode) {
53 DLOG("Avoiding resize between containers with different fullscreen modes, %d != %d\n", first->fullscreen_mode, second->fullscreen_mode);
54 return false;
55 }
56
57 assert(first != second);
58 assert(first->parent == second->parent);
59
60 /* The first container should always be in front of the second container */
61 if (search_direction == D_UP || search_direction == D_LEFT) {
62 Con *tmp = first;
63 first = second;
64 second = tmp;
65 }
66
67 const orientation_t orientation = ((border == BORDER_LEFT || border == BORDER_RIGHT) ? HORIZ : VERT);
68
69 resize_graphical_handler(first, second, orientation, event, use_threshold);
70
71 DLOG("After resize handler, rendering\n");
73 return true;
74}
75
76/*
77 * Called when the user clicks using the floating_modifier, but the client is in
78 * tiling layout.
79 *
80 * Returns false if it does not do anything (that is, the click should be sent
81 * to the client).
82 *
83 */
84static bool floating_mod_on_tiled_client(Con *con, xcb_button_press_event_t *event) {
85 /* The client is in tiling layout. We can still initiate a resize with the
86 * right mouse button, by choosing the border which is the most near one to
87 * the position of the mouse pointer */
88 int to_right = con->rect.width - event->event_x,
89 to_left = event->event_x,
90 to_top = event->event_y,
91 to_bottom = con->rect.height - event->event_y;
92
93 DLOG("click was %d px to the right, %d px to the left, %d px to top, %d px to bottom\n",
94 to_right, to_left, to_top, to_bottom);
95
96 if (to_right < to_left &&
97 to_right < to_top &&
98 to_right < to_bottom) {
99 return tiling_resize_for_border(con, BORDER_RIGHT, event, false);
100 }
101
102 if (to_left < to_right &&
103 to_left < to_top &&
104 to_left < to_bottom) {
105 return tiling_resize_for_border(con, BORDER_LEFT, event, false);
106 }
107
108 if (to_top < to_right &&
109 to_top < to_left &&
110 to_top < to_bottom) {
111 return tiling_resize_for_border(con, BORDER_TOP, event, false);
112 }
113
114 if (to_bottom < to_right &&
115 to_bottom < to_left &&
116 to_bottom < to_top) {
117 return tiling_resize_for_border(con, BORDER_BOTTOM, event, false);
118 }
119
120 return false;
121}
122
123/*
124 * Finds out which border was clicked on and calls tiling_resize_for_border().
125 *
126 */
127static bool tiling_resize(Con *con, xcb_button_press_event_t *event, const click_destination_t dest, bool use_threshold) {
128 /* check if this was a click on the window border (and on which one) */
129 Rect bsr = con_border_style_rect(con);
130 DLOG("BORDER x = %d, y = %d for con %p, window 0x%08x\n",
131 event->event_x, event->event_y, con, event->event);
132 DLOG("checks for right >= %d\n", con->window_rect.x + con->window_rect.width);
133 if (dest == CLICK_DECORATION) {
134 return tiling_resize_for_border(con, BORDER_TOP, event, use_threshold);
135 } else if (dest == CLICK_BORDER) {
136 if (event->event_y >= 0 && event->event_y <= (int32_t)bsr.y &&
137 event->event_x >= (int32_t)bsr.x && event->event_x <= (int32_t)(con->rect.width + bsr.width)) {
138 return tiling_resize_for_border(con, BORDER_TOP, event, false);
139 }
140 }
141 if (event->event_x >= 0 && event->event_x <= (int32_t)bsr.x &&
142 event->event_y >= (int32_t)bsr.y && event->event_y <= (int32_t)(con->rect.height + bsr.height)) {
143 return tiling_resize_for_border(con, BORDER_LEFT, event, false);
144 }
145
146 if (event->event_x >= (int32_t)(con->window_rect.x + con->window_rect.width) &&
147 event->event_y >= (int32_t)bsr.y && event->event_y <= (int32_t)(con->rect.height + bsr.height)) {
148 return tiling_resize_for_border(con, BORDER_RIGHT, event, false);
149 }
150
151 if (event->event_y >= (int32_t)(con->window_rect.y + con->window_rect.height)) {
152 return tiling_resize_for_border(con, BORDER_BOTTOM, event, false);
153 }
154
155 return false;
156}
157
158static void allow_replay_pointer(xcb_timestamp_t time) {
159 xcb_allow_events(conn, XCB_ALLOW_REPLAY_POINTER, time);
160 xcb_flush(conn);
161 tree_render();
162}
163
164/*
165 * Being called by handle_button_press, this function calls the appropriate
166 * functions for resizing/dragging.
167 *
168 */
169static void route_click(Con *con, xcb_button_press_event_t *event, const click_destination_t dest) {
170 const uint32_t mod = (config.floating_modifier & 0xFFFF);
171 const bool mod_pressed = (mod != 0 && (event->state & mod) == mod);
172
173 DLOG("--> click properties: mod = %d, destination = %d\n", mod_pressed, dest);
174 DLOG("--> OUTCOME = %p\n", con);
175 DLOG("type = %d, name = %s\n", con->type, con->name);
176
177 /* don’t handle dockarea cons, they must not be focused */
178 if (con->parent->type == CT_DOCKAREA) {
179 allow_replay_pointer(event->time);
180 return;
181 }
182
183 /* if the user has bound an action to this click, it should override the
184 * default behavior. */
185 Binding *bind = get_binding_from_xcb_event((xcb_generic_event_t *)event);
186 if (bind && ((dest == CLICK_DECORATION && !bind->exclude_titlebar) ||
187 (dest == CLICK_INSIDE && bind->whole_window) ||
188 (dest == CLICK_BORDER && bind->border))) {
189 CommandResult *result = run_binding(bind, con);
190
191 /* ASYNC_POINTER eats the event */
192 xcb_allow_events(conn, XCB_ALLOW_ASYNC_POINTER, event->time);
193 xcb_flush(conn);
194
195 command_result_free(result);
196 return;
197 }
198
199 /* There is no default behavior for button release events so we are done. */
200 if (event->response_type == XCB_BUTTON_RELEASE) {
201 allow_replay_pointer(event->time);
202 return;
203 }
204
205 /* Any click in a workspace should focus that workspace. If the
206 * workspace is on another output we need to do a workspace_show in
207 * order for i3bar (and others) to notice the change in workspace. */
208 Con *ws = con_get_workspace(con);
209 Con *focused_workspace = con_get_workspace(focused);
210
211 if (!ws) {
212 ws = TAILQ_FIRST(&(output_get_content(con_get_output(con))->focus_head));
213 if (!ws) {
214 allow_replay_pointer(event->time);
215 return;
216 }
217 }
218
219 /* get the floating con */
220 Con *floatingcon = con_inside_floating(con);
221 const bool proportional = (event->state & XCB_KEY_BUT_MASK_SHIFT) == XCB_KEY_BUT_MASK_SHIFT;
222 const bool in_stacked = (con->parent->layout == L_STACKED || con->parent->layout == L_TABBED);
223 const bool was_focused = focused == con;
224 const bool is_left_click = (event->detail == XCB_BUTTON_CLICK_LEFT);
225 const bool is_right_click = (event->detail == XCB_BUTTON_CLICK_RIGHT);
226 const bool is_left_or_right_click = (is_left_click || is_right_click);
227 const bool is_scroll = (event->detail == XCB_BUTTON_SCROLL_UP ||
228 event->detail == XCB_BUTTON_SCROLL_DOWN ||
229 event->detail == XCB_BUTTON_SCROLL_LEFT ||
230 event->detail == XCB_BUTTON_SCROLL_RIGHT);
231
232 /* 1: see if the user scrolled on the decoration of a stacked/tabbed con */
233 if (in_stacked && dest == CLICK_DECORATION && is_scroll) {
234 DLOG("Scrolling on a window decoration\n");
235 /* Correctly move workspace focus first, see: #5472 */
236 workspace_show(ws);
237
238 /* Use the focused child of the tabbed / stacked container, not the
239 * container the user scrolled on. */
240 Con *current = TAILQ_FIRST(&(con->parent->focus_head));
241 const position_t direction =
242 (event->detail == XCB_BUTTON_SCROLL_UP || event->detail == XCB_BUTTON_SCROLL_LEFT) ? BEFORE : AFTER;
243 Con *next = get_tree_next_sibling(current, direction);
244 con_activate(con_descend_focused(next ? next : current));
245
246 allow_replay_pointer(event->time);
247 return;
248 }
249
250 /* 2: floating modifier pressed, initiate a drag */
251 if (mod_pressed && is_left_click && !floatingcon &&
255 const bool use_threshold = !mod_pressed;
256 tiling_drag(con, event, use_threshold);
257 allow_replay_pointer(event->time);
258 return;
259 }
260
261 /* 3: focus this con or one of its children. */
262 Con *con_to_focus = con;
263 if (in_stacked && dest == CLICK_DECORATION) {
264 /* If the container is a tab/stacked container and the click happened
265 * on a tab, switch to the tab. If the tab contents were already
266 * focused, focus the tab container itself. If the tab container was
267 * already focused, cycle back to focusing the tab contents. */
268 if (was_focused || !con_has_parent(focused, con)) {
269 while (!TAILQ_EMPTY(&(con_to_focus->focus_head))) {
270 con_to_focus = TAILQ_FIRST(&(con_to_focus->focus_head));
271 }
272 }
273 }
274 if (ws != focused_workspace) {
275 workspace_show(ws);
276 }
277 con_activate(con_to_focus);
278
279 /* 4: For floating containers, we also want to raise them on click.
280 * We will skip handling events on floating cons in fullscreen mode */
282 if (floatingcon != NULL && fs != con) {
283 /* 5: floating_modifier plus left mouse button drags */
284 if (mod_pressed && is_left_click) {
285 floating_drag_window(floatingcon, event, false);
286 return;
287 }
288
289 /* 6: resize (floating) if this was a (left or right) click on the
290 * left/right/bottom border, or a right click on the decoration.
291 * also try resizing (tiling) if possible */
292 if (mod_pressed && is_right_click) {
293 DLOG("floating resize due to floatingmodifier\n");
294 floating_resize_window(floatingcon, proportional, event);
295 return;
296 }
297
298 if ((dest == CLICK_BORDER || dest == CLICK_DECORATION) &&
299 is_left_or_right_click) {
300 /* try tiling resize, but continue if it doesn’t work */
301 DLOG("tiling resize with fallback\n");
302 if (tiling_resize(con, event, dest, dest == CLICK_DECORATION && !was_focused)) {
303 allow_replay_pointer(event->time);
304 return;
305 }
306 }
307
308 if (dest == CLICK_DECORATION && is_right_click) {
309 DLOG("floating resize due to decoration right click\n");
310 floating_resize_window(floatingcon, proportional, event);
311 return;
312 }
313
314 if (dest == CLICK_BORDER && is_left_or_right_click) {
315 DLOG("floating resize due to border click\n");
316 floating_resize_window(floatingcon, proportional, event);
317 return;
318 }
319
320 /* 7: dragging, if this was a click on a decoration (which did not lead
321 * to a resize) */
322 if (dest == CLICK_DECORATION && is_left_click) {
323 floating_drag_window(floatingcon, event, !was_focused);
324 return;
325 }
326
327 allow_replay_pointer(event->time);
328 return;
329 }
330
331 /* 8: floating modifier pressed, or click in titlebar, initiate a drag */
332 if (is_left_click &&
335 (mod_pressed || dest == CLICK_DECORATION))) &&
337 allow_replay_pointer(event->time);
338 const bool use_threshold = !mod_pressed;
339 tiling_drag(con, event, use_threshold);
340 return;
341 }
342
343 /* 9: floating modifier pressed, initiate a resize */
344 if (dest == CLICK_INSIDE && mod_pressed && is_right_click) {
345 if (floating_mod_on_tiled_client(con, event)) {
346 return;
347 }
348 /* Avoid propagating events to clients, since the user expects
349 * $mod+click to be handled by i3. */
350 xcb_allow_events(conn, XCB_ALLOW_ASYNC_POINTER, event->time);
351 xcb_flush(conn);
352 return;
353 }
354 /* 10: otherwise, check for border/decoration clicks and resize */
355 if ((dest == CLICK_BORDER || dest == CLICK_DECORATION) &&
356 is_left_or_right_click) {
357 DLOG("Trying to resize (tiling)\n");
358 tiling_resize(con, event, dest, dest == CLICK_DECORATION && !was_focused);
359 }
360
361 allow_replay_pointer(event->time);
362}
363
364/*
365 * The button press X callback. This function determines whether the floating
366 * modifier is pressed and where the user clicked (decoration, border, inside
367 * the window).
368 *
369 * Then, route_click is called on the appropriate con.
370 *
371 */
372void handle_button_press(xcb_button_press_event_t *event) {
373 Con *con;
374 DLOG("Button %d (state %d) %s on window 0x%08x (child 0x%08x) at (%d, %d) (root %d, %d)\n",
375 event->detail, event->state, (event->response_type == XCB_BUTTON_PRESS ? "press" : "release"),
376 event->event, event->child, event->event_x, event->event_y, event->root_x,
377 event->root_y);
378
379 last_timestamp = event->time;
380
381 if ((con = con_by_window_id(event->event))) {
382 route_click(con, event, CLICK_INSIDE);
383 return;
384 }
385
386 if (!(con = con_by_frame_id(event->event))) {
387 /* Run bindings on the root window as well, see #2097. We only run it
388 * if --whole-window was set as that's the equivalent for a normal
389 * window. */
390 if (event->event == root) {
391 Binding *bind = get_binding_from_xcb_event((xcb_generic_event_t *)event);
392 if (bind != NULL && bind->whole_window) {
393 CommandResult *result = run_binding(bind, NULL);
394 command_result_free(result);
395 }
396 }
397
398 /* If the root window is clicked, find the relevant output from the
399 * click coordinates and focus the output's active workspace. */
400 if (event->event == root && event->response_type == XCB_BUTTON_PRESS) {
401 Con *output, *ws;
402 TAILQ_FOREACH (output, &(croot->nodes_head), nodes) {
403 if (con_is_internal(output) ||
404 !rect_contains(output->rect, event->event_x, event->event_y)) {
405 continue;
406 }
407
408 ws = TAILQ_FIRST(&(output_get_content(output)->focus_head));
409 if (ws != con_get_workspace(focused)) {
410 workspace_show(ws);
411 tree_render();
412 }
413 return;
414 }
415 return;
416 }
417
418 ELOG("Clicked into unknown window?!\n");
419 xcb_allow_events(conn, XCB_ALLOW_REPLAY_POINTER, event->time);
420 xcb_flush(conn);
421 return;
422 }
423
424 /* Check if the click was on the decoration of a child */
425 if (con->window != NULL) {
426 if (rect_contains(con->deco_rect, event->event_x, event->event_y)) {
427 route_click(con, event, CLICK_DECORATION);
428 return;
429 }
430 } else {
431 Con *child;
432 TAILQ_FOREACH_REVERSE (child, &(con->nodes_head), nodes_head, nodes) {
433 if (!rect_contains(child->deco_rect, event->event_x, event->event_y)) {
434 continue;
435 }
436
437 route_click(child, event, CLICK_DECORATION);
438 return;
439 }
440 }
441
442 if (event->child != XCB_NONE) {
443 DLOG("event->child not XCB_NONE, so this is an event which originated from a click into the application, but the application did not handle it.\n");
444 route_click(con, event, CLICK_INSIDE);
445 return;
446 }
447
448 route_click(con, event, CLICK_BORDER);
449}
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 bindings.c:315
CommandResult * run_binding(Binding *bind, Con *con)
Runs the given binding and handles parse errors.
Definition bindings.c:859
static bool floating_mod_on_tiled_client(Con *con, xcb_button_press_event_t *event)
Definition click.c:84
static bool tiling_resize_for_border(Con *con, border_t border, xcb_button_press_event_t *event, bool use_threshold)
Definition click.c:24
void handle_button_press(xcb_button_press_event_t *event)
The button press X callback.
Definition click.c:372
static void allow_replay_pointer(xcb_timestamp_t time)
Definition click.c:158
static bool tiling_resize(Con *con, xcb_button_press_event_t *event, const click_destination_t dest, bool use_threshold)
Definition click.c:127
click_destination_t
Definition click.c:14
@ CLICK_INSIDE
Definition click.c:16
@ CLICK_BORDER
Definition click.c:14
@ CLICK_DECORATION
Definition click.c:15
static void route_click(Con *con, xcb_button_press_event_t *event, const click_destination_t dest)
Definition click.c:169
void command_result_free(CommandResult *result)
Frees a CommandResult.
Con * con_get_workspace(Con *con)
Gets the workspace container this node is on.
Definition con.c:547
Con * con_by_window_id(xcb_window_t window)
Returns the container with the given client window ID or NULL if no such container exists.
Definition con.c:752
Rect con_border_style_rect(Con *con)
Returns a "relative" Rect which contains the amount of pixels that need to be added to the original R...
Definition con.c:1887
Con * con_get_fullscreen_covering_ws(Con *ws)
Returns the fullscreen node that covers the given workspace if it exists.
Definition con.c:647
Con * con_inside_floating(Con *con)
Checks if the given container is either floating or inside some floating container.
Definition con.c:696
bool con_is_internal(Con *con)
Returns true if the container is internal, such as __i3_scratch.
Definition con.c:662
Con * con_by_frame_id(xcb_window_t frame)
Returns the container with the given frame ID or NULL if no such container exists.
Definition con.c:792
void con_activate(Con *con)
Sets input focus to the given container and raises it to the top.
Definition con.c:292
bool con_has_parent(Con *con, Con *parent)
Checks if the container has the given parent as an actual parent.
Definition con.c:734
Con * con_get_output(Con *con)
Gets the output container (first container with CT_OUTPUT in hierarchy) this node is on.
Definition con.c:532
Con * con_descend_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition con.c:1698
Config config
Definition config.c:19
void floating_resize_window(Con *con, const bool proportional, const xcb_button_press_event_t *event)
Called when the user clicked on a floating window while holding the floating_modifier and the right m...
Definition floating.c:698
void floating_drag_window(Con *con, const xcb_button_press_event_t *event, bool use_threshold)
Called when the user clicked on the titlebar of a floating window.
Definition floating.c:595
Con * output_get_content(Con *output)
Returns the output container below the given output container.
Definition output.c:16
bool resize_find_tiling_participants(Con **current, Con **other, direction_t direction, bool both_sides)
Definition resize.c:72
void resize_graphical_handler(Con *first, Con *second, orientation_t orientation, const xcb_button_press_event_t *event, bool use_threshold)
Definition resize.c:173
void tiling_drag(Con *con, xcb_button_press_event_t *event, bool use_threshold)
Initiates a mouse drag operation on a tiled window.
bool has_drop_targets(void)
Returns whether there currently are any drop targets.
Definition tiling_drag.c:42
struct Con * focused
Definition tree.c:13
struct Con * croot
Definition tree.c:12
void tree_render(void)
Renders the tree, that is rendering all outputs using render_con() and pushing the changes to X11 usi...
Definition tree.c:455
Con * get_tree_next_sibling(Con *con, position_t direction)
Get the previous / next sibling.
Definition tree.c:638
bool rect_contains(Rect rect, uint32_t x, uint32_t y)
Definition util.c:32
void workspace_show(Con *workspace)
Switches to the given workspace.
Definition workspace.c:438
xcb_timestamp_t last_timestamp
The last timestamp we got from X11 (timestamps are included in some events and are used for some thin...
Definition main.c:64
xcb_connection_t * conn
XCB connection and root screen.
Definition main.c:54
xcb_window_t root
Definition main.c:67
position_t
Definition data.h:63
@ AFTER
Definition data.h:64
@ BEFORE
Definition data.h:63
@ L_STACKED
Definition data.h:103
@ L_TABBED
Definition data.h:104
orientation_t
Definition data.h:60
@ VERT
Definition data.h:62
@ HORIZ
Definition data.h:61
direction_t
Definition data.h:56
@ D_RIGHT
Definition data.h:57
@ D_LEFT
Definition data.h:56
@ D_UP
Definition data.h:58
@ D_DOWN
Definition data.h:59
border_t
On which border was the dragging initiated?
Definition floating.h:17
@ BORDER_BOTTOM
Definition floating.h:20
@ BORDER_TOP
Definition floating.h:19
@ BORDER_RIGHT
Definition floating.h:18
@ BORDER_LEFT
Definition floating.h:17
#define XCB_BUTTON_CLICK_LEFT
Mouse buttons.
Definition libi3.h:29
#define XCB_BUTTON_SCROLL_UP
Definition libi3.h:32
#define DLOG(fmt,...)
Definition libi3.h:105
#define ELOG(fmt,...)
Definition libi3.h:100
#define XCB_BUTTON_SCROLL_LEFT
Definition libi3.h:35
#define XCB_BUTTON_SCROLL_RIGHT
Definition libi3.h:36
#define XCB_BUTTON_CLICK_RIGHT
Definition libi3.h:31
#define XCB_BUTTON_SCROLL_DOWN
Definition libi3.h:33
#define TAILQ_FOREACH(var, head, field)
Definition queue.h:347
#define TAILQ_FIRST(head)
Definition queue.h:336
#define TAILQ_FOREACH_REVERSE(var, head, headname, field)
Definition queue.h:352
#define TAILQ_EMPTY(head)
Definition queue.h:344
@ TILING_DRAG_MODIFIER_OR_TITLEBAR
Definition tiling_drag.h:21
@ TILING_DRAG_TITLEBAR
Definition tiling_drag.h:20
@ TILING_DRAG_MODIFIER
Definition tiling_drag.h:19
A struct that contains useful information about the result of a command as a whole (e....
tiling_drag_t tiling_drag
uint32_t floating_modifier
The modifier which needs to be pressed in combination with your mouse buttons to do things with float...
Stores a rectangle, for example the size of a window, the child window etc.
Definition data.h:185
uint32_t height
Definition data.h:189
uint32_t x
Definition data.h:186
uint32_t y
Definition data.h:187
uint32_t width
Definition data.h:188
Holds a keybinding, consisting of a keycode combined with modifiers and the command which is executed...
Definition data.h:306
bool whole_window
If this is true for a mouse binding, the binding should be executed when the button is pressed over a...
Definition data.h:332
bool border
If this is true for a mouse binding, the binding should be executed when the button is pressed over t...
Definition data.h:327
bool exclude_titlebar
If this is true for a mouse binding, the binding should only be executed if the button press was not ...
Definition data.h:336
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition data.h:643
struct Con * parent
Definition data.h:678
struct Rect deco_rect
Definition data.h:688
enum Con::@18 type
struct Rect rect
Definition data.h:682
layout_t layout
Definition data.h:755
struct Rect window_rect
Definition data.h:685
struct Window * window
Definition data.h:718
char * name
Definition data.h:692
fullscreen_mode_t fullscreen_mode
Definition data.h:734