2 #define I3__FILE__ "floating.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
9 * floating.c: Floating windows.
14 extern xcb_connection_t *conn;
17 * Calculates sum of heights and sum of widths of all currently active outputs
20 static Rect total_outputs_dimensions(void) {
22 /* Use Rect to encapsulate dimensions, ignoring x/y */
23 Rect outputs_dimensions = {0, 0, 0, 0};
24 TAILQ_FOREACH(output, &outputs, outputs) {
25 outputs_dimensions.height += output->rect.height;
26 outputs_dimensions.width += output->rect.width;
28 return outputs_dimensions;
31 void floating_enable(Con *con, bool automatic) {
32 bool set_focus = (con == focused);
34 if (con->parent && con->parent->type == CT_DOCKAREA) {
35 LOG("Container is a dock window, not enabling floating mode.\n");
39 if (con_is_floating(con)) {
40 LOG("Container is already in floating mode, not doing anything.\n");
44 /* 1: If the container is a workspace container, we need to create a new
45 * split-container with the same layout and make that one floating. We
46 * cannot touch the workspace container itself because floating containers
47 * are children of the workspace. */
48 if (con->type == CT_WORKSPACE) {
49 LOG("This is a workspace, creating new container around content\n");
50 if (con_num_children(con) == 0) {
51 LOG("Workspace is empty, aborting\n");
54 /* TODO: refactor this with src/con.c:con_set_layout */
55 Con *new = con_new(NULL, NULL);
57 new->layout = con->layout;
59 /* since the new container will be set into floating mode directly
60 * afterwards, we need to copy the workspace rect. */
61 memcpy(&(new->rect), &(con->rect), sizeof(Rect));
63 Con *old_focused = TAILQ_FIRST(&(con->focus_head));
64 if (old_focused == TAILQ_END(&(con->focus_head)))
67 /* 4: move the existing cons of this workspace below the new con */
68 DLOG("Moving cons\n");
70 while (!TAILQ_EMPTY(&(con->nodes_head))) {
71 child = TAILQ_FIRST(&(con->nodes_head));
73 con_attach(child, new, true);
76 /* 4: attach the new split container to the workspace */
77 DLOG("Attaching new split to ws\n");
78 con_attach(new, con, false);
81 con_focus(old_focused);
87 /* 1: detach the container from its parent */
88 /* TODO: refactor this with tree_close() */
89 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
90 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
92 con_fix_percent(con->parent);
94 /* 2: create a new container to render the decoration on, add
95 * it as a floating window to the workspace */
96 Con *nc = con_new(NULL, NULL);
97 /* we need to set the parent afterwards instead of passing it as an
98 * argument to con_new() because nc would be inserted into the tiling layer
100 Con *ws = con_get_workspace(con);
103 nc->type = CT_FLOATING_CON;
104 nc->layout = L_SPLITH;
105 /* We insert nc already, even though its rect is not yet calculated. This
106 * is necessary because otherwise the workspace might be empty (and get
107 * closed in tree_close()) even though it’s not. */
108 TAILQ_INSERT_TAIL(&(ws->floating_head), nc, floating_windows);
109 TAILQ_INSERT_TAIL(&(ws->focus_head), nc, focused);
111 /* check if the parent container is empty and close it if so */
112 if ((con->parent->type == CT_CON || con->parent->type == CT_FLOATING_CON) &&
113 con_num_children(con->parent) == 0) {
114 DLOG("Old container empty after setting this child to floating, closing\n");
115 tree_close(con->parent, DONT_KILL_WINDOW, false, false);
119 sasprintf(&name, "[i3 con] floatingcon around %p", con);
120 x_set_name(nc, name);
123 /* find the height for the decorations */
124 int deco_height = config.font.height + 5;
126 DLOG("Original rect: (%d, %d) with %d x %d\n", con->rect.x, con->rect.y, con->rect.width, con->rect.height);
127 DLOG("Geometry = (%d, %d) with %d x %d\n", con->geometry.x, con->geometry.y, con->geometry.width, con->geometry.height);
128 Rect zero = { 0, 0, 0, 0 };
129 nc->rect = con->geometry;
130 /* If the geometry was not set (split containers), we need to determine a
131 * sensible one by combining the geometry of all children */
132 if (memcmp(&(nc->rect), &zero, sizeof(Rect)) == 0) {
133 DLOG("Geometry not set, combining children\n");
135 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
136 DLOG("child geometry: %d x %d\n", child->geometry.width, child->geometry.height);
137 nc->rect.width += child->geometry.width;
138 nc->rect.height = max(nc->rect.height, child->geometry.height);
142 /* Define reasonable minimal and maximal sizes for floating windows */
143 const int floating_sane_min_height = 50;
144 const int floating_sane_min_width = 75;
146 Rect floating_sane_max_dimensions;
147 floating_sane_max_dimensions = total_outputs_dimensions();
149 /* Unless user requests otherwise (-1), ensure width/height do not exceed
150 * configured maxima or, if unconfigured, limit to combined width of all
152 if (config.floating_maximum_height != -1) {
153 if (config.floating_maximum_height == 0)
154 nc->rect.height = min(nc->rect.height, floating_sane_max_dimensions.height);
156 nc->rect.height = min(nc->rect.height, config.floating_maximum_height);
158 if (config.floating_maximum_width != -1) {
159 if (config.floating_maximum_width == 0)
160 nc->rect.width = min(nc->rect.width, floating_sane_max_dimensions.width);
162 nc->rect.width = min(nc->rect.width, config.floating_maximum_width);
165 /* Unless user requests otherwise (-1), raise the width/height to
166 * reasonable minimum dimensions */
167 if (config.floating_minimum_height != -1) {
168 if (config.floating_minimum_height == 0)
169 nc->rect.height = max(nc->rect.height, floating_sane_min_height);
171 nc->rect.height = max(nc->rect.height, config.floating_minimum_height);
173 if (config.floating_minimum_width != -1) {
174 if (config.floating_minimum_width == 0)
175 nc->rect.width = max(nc->rect.width, floating_sane_min_width);
177 nc->rect.width = max(nc->rect.width, config.floating_minimum_width);
180 /* 3: attach the child to the new parent container. We need to do this
181 * because con_border_style_rect() needs to access con->parent. */
184 con->floating = FLOATING_USER_ON;
186 /* 4: set the border style as specified with new_float */
188 con->border_style = config.default_floating_border;
190 /* Add pixels for the decoration. */
191 Rect border_style_rect = con_border_style_rect(con);
193 nc->rect.height -= border_style_rect.height;
194 nc->rect.width -= border_style_rect.width;
196 /* Add some more pixels for the title bar */
197 if(con_border_style(con) == BS_NORMAL)
198 nc->rect.height += deco_height;
200 /* Honor the X11 border */
201 nc->rect.height += con->border_width * 2;
202 nc->rect.width += con->border_width * 2;
204 /* Some clients (like GIMP’s color picker window) get mapped
205 * to (0, 0), so we push them to a reasonable position
206 * (centered over their leader) */
207 if (nc->rect.x == 0 && nc->rect.y == 0) {
209 if (con->window && con->window->leader != XCB_NONE &&
210 (leader = con_by_window_id(con->window->leader)) != NULL) {
211 DLOG("Centering above leader\n");
212 nc->rect.x = leader->rect.x + (leader->rect.width / 2) - (nc->rect.width / 2);
213 nc->rect.y = leader->rect.y + (leader->rect.height / 2) - (nc->rect.height / 2);
215 /* center the window on workspace as fallback */
216 nc->rect.x = ws->rect.x + (ws->rect.width / 2) - (nc->rect.width / 2);
217 nc->rect.y = ws->rect.y + (ws->rect.height / 2) - (nc->rect.height / 2);
221 /* Sanity check: Are the coordinates on the appropriate output? If not, we
222 * need to change them */
223 Output *current_output = get_output_containing(nc->rect.x, nc->rect.y);
224 Con *correct_output = con_get_output(ws);
225 if (!current_output || current_output->con != correct_output) {
226 DLOG("This floating window is on the wrong output, fixing coordinates (currently (%d, %d))\n",
227 nc->rect.x, nc->rect.y);
228 /* Take the relative coordinates of the current output, then add them
229 * to the coordinate space of the correct output */
230 uint32_t rel_x = (nc->rect.x - (current_output ? current_output->con->rect.x : 0));
231 uint32_t rel_y = (nc->rect.y - (current_output ? current_output->con->rect.y : 0));
232 nc->rect.x = correct_output->rect.x + rel_x;
233 nc->rect.y = correct_output->rect.y + rel_y;
236 DLOG("Floating rect: (%d, %d) with %d x %d\n", nc->rect.x, nc->rect.y, nc->rect.width, nc->rect.height);
238 /* 5: Subtract the deco_height in order to make the floating window appear
239 * at precisely the position it specified in its original geometry (which
240 * is what applications might remember). */
241 deco_height = (con->border_style == BS_NORMAL ? config.font.height + 5 : 0);
242 nc->rect.y -= deco_height;
244 DLOG("Corrected y = %d (deco_height = %d)\n", nc->rect.y, deco_height);
246 TAILQ_INSERT_TAIL(&(nc->nodes_head), con, nodes);
247 TAILQ_INSERT_TAIL(&(nc->focus_head), con, focused);
249 /* render the cons to get initial window_rect correct */
250 render_con(nc, false);
251 render_con(con, false);
256 /* Check if we need to re-assign it to a different workspace because of its
257 * coordinates and exit if that was done successfully. */
258 if (floating_maybe_reassign_ws(nc))
261 /* Sanitize coordinates: Check if they are on any output */
262 if (get_output_containing(nc->rect.x, nc->rect.y) != NULL)
265 ELOG("No output found at destination coordinates, centering floating window on current ws\n");
266 nc->rect.x = ws->rect.x + (ws->rect.width / 2) - (nc->rect.width / 2);
267 nc->rect.y = ws->rect.y + (ws->rect.height / 2) - (nc->rect.height / 2);
270 void floating_disable(Con *con, bool automatic) {
271 if (!con_is_floating(con)) {
272 LOG("Container isn't floating, not doing anything.\n");
276 Con *ws = con_get_workspace(con);
278 /* 1: detach from parent container */
279 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
280 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
282 /* 2: kill parent container */
283 TAILQ_REMOVE(&(con->parent->parent->floating_head), con->parent, floating_windows);
284 TAILQ_REMOVE(&(con->parent->parent->focus_head), con->parent, focused);
285 tree_close(con->parent, DONT_KILL_WINDOW, true, false);
287 /* 3: re-attach to the parent of the currently focused con on the workspace
288 * this floating con was on */
289 Con *focused = con_descend_tiling_focused(ws);
291 /* if there is no other container on this workspace, focused will be the
292 * workspace itself */
293 if (focused->type == CT_WORKSPACE)
294 con->parent = focused;
295 else con->parent = focused->parent;
297 /* con_fix_percent will adjust the percent value */
300 con->floating = FLOATING_USER_OFF;
302 con_attach(con, con->parent, false);
304 con_fix_percent(con->parent);
305 // TODO: don’t influence focus handling when Con was not focused before.
310 * Toggles floating mode for the given container.
312 * If the automatic flag is set to true, this was an automatic update by a change of the
313 * window class from the application which can be overwritten by the user.
316 void toggle_floating_mode(Con *con, bool automatic) {
317 /* see if the client is already floating */
318 if (con_is_floating(con)) {
319 LOG("already floating, re-setting to tiling\n");
321 floating_disable(con, automatic);
325 floating_enable(con, automatic);
329 * Raises the given container in the list of floating containers
332 void floating_raise_con(Con *con) {
333 DLOG("Raising floating con %p / %s\n", con, con->name);
334 TAILQ_REMOVE(&(con->parent->floating_head), con, floating_windows);
335 TAILQ_INSERT_TAIL(&(con->parent->floating_head), con, floating_windows);
339 * Checks if con’s coordinates are within its workspace and re-assigns it to
340 * the actual workspace if not.
343 bool floating_maybe_reassign_ws(Con *con) {
344 Output *output = get_output_containing(
345 con->rect.x + (con->rect.width / 2),
346 con->rect.y + (con->rect.height / 2));
349 ELOG("No output found at destination coordinates?\n");
353 if (con_get_output(con) == output->con) {
354 DLOG("still the same ws\n");
358 DLOG("Need to re-assign!\n");
360 Con *content = output_get_content(output->con);
361 Con *ws = TAILQ_FIRST(&(content->focus_head));
362 DLOG("Moving con %p / %s to workspace %p / %s\n", con, con->name, ws, ws->name);
363 con_move_to_workspace(con, ws, false, true);
364 con_focus(con_descend_focused(con));
368 DRAGGING_CB(drag_window_callback) {
369 const struct xcb_button_press_event_t *event = extra;
371 /* Reposition the client correctly while moving */
372 con->rect.x = old_rect->x + (new_x - event->root_x);
373 con->rect.y = old_rect->y + (new_y - event->root_y);
375 render_con(con, false);
379 /* Check if we cross workspace boundaries while moving */
380 if (!floating_maybe_reassign_ws(con))
386 * Called when the user clicked on the titlebar of a floating window.
387 * Calls the drag_pointer function with the drag_window callback
390 void floating_drag_window(Con *con, const xcb_button_press_event_t *event) {
391 DLOG("floating_drag_window\n");
393 /* Push changes before dragging, so that the window gets raised now and not
394 * after the user releases the mouse button */
397 /* Drag the window */
398 drag_pointer(con, event, XCB_NONE, BORDER_TOP /* irrelevant */, drag_window_callback, event);
403 * This is an ugly data structure which we need because there is no standard
404 * way of having nested functions (only available as a gcc extension at the
405 * moment, clang doesn’t support it) or blocks (only available as a clang
406 * extension and only on Mac OS X systems at the moment).
409 struct resize_window_callback_params {
410 const border_t corner;
411 const bool proportional;
412 const xcb_button_press_event_t *event;
415 DRAGGING_CB(resize_window_callback) {
416 const struct resize_window_callback_params *params = extra;
417 const xcb_button_press_event_t *event = params->event;
418 border_t corner = params->corner;
420 int32_t dest_x = con->rect.x;
421 int32_t dest_y = con->rect.y;
423 uint32_t dest_height;
425 double ratio = (double) old_rect->width / old_rect->height;
427 /* First guess: We resize by exactly the amount the mouse moved,
428 * taking into account in which corner the client was grabbed */
429 if (corner & BORDER_LEFT)
430 dest_width = old_rect->width - (new_x - event->root_x);
431 else dest_width = old_rect->width + (new_x - event->root_x);
433 if (corner & BORDER_TOP)
434 dest_height = old_rect->height - (new_y - event->root_y);
435 else dest_height = old_rect->height + (new_y - event->root_y);
437 /* Obey minimum window size */
438 Rect minimum = con_minimum_size(con);
439 dest_width = max(dest_width, minimum.width);
440 dest_height = max(dest_height, minimum.height);
442 /* User wants to keep proportions, so we may have to adjust our values */
443 if (params->proportional) {
444 dest_width = max(dest_width, (int) (dest_height * ratio));
445 dest_height = max(dest_height, (int) (dest_width / ratio));
448 /* If not the lower right corner is grabbed, we must also reposition
449 * the client by exactly the amount we resized it */
450 if (corner & BORDER_LEFT)
451 dest_x = old_rect->x + (old_rect->width - dest_width);
453 if (corner & BORDER_TOP)
454 dest_y = old_rect->y + (old_rect->height - dest_height);
456 con->rect = (Rect) { dest_x, dest_y, dest_width, dest_height };
458 /* TODO: don’t re-render the whole tree just because we change
459 * coordinates of a floating window */
461 x_push_changes(croot);
465 * Called when the user clicked on a floating window while holding the
466 * floating_modifier and the right mouse button.
467 * Calls the drag_pointer function with the resize_window callback
470 void floating_resize_window(Con *con, const bool proportional,
471 const xcb_button_press_event_t *event) {
472 DLOG("floating_resize_window\n");
474 /* corner saves the nearest corner to the original click. It contains
475 * a bitmask of the nearest borders (BORDER_LEFT, BORDER_RIGHT, …) */
478 if (event->event_x <= (con->rect.width / 2))
479 corner |= BORDER_LEFT;
480 else corner |= BORDER_RIGHT;
482 if (event->event_y <= (con->rect.height / 2))
483 corner |= BORDER_TOP;
484 else corner |= BORDER_BOTTOM;
486 struct resize_window_callback_params params = { corner, proportional, event };
488 drag_pointer(con, event, XCB_NONE, BORDER_TOP /* irrelevant */, resize_window_callback, ¶ms);
492 * This function grabs your pointer and lets you drag stuff around (borders).
493 * Every time you move your mouse, an XCB_MOTION_NOTIFY event will be received
494 * and the given callback will be called with the parameters specified (client,
495 * border on which the click originally was), the original rect of the client,
496 * the event and the new coordinates (x, y).
499 void drag_pointer(Con *con, const xcb_button_press_event_t *event, xcb_window_t
500 confine_to, border_t border, callback_t callback, const void *extra)
502 uint32_t new_x, new_y;
503 Rect old_rect = { 0, 0, 0, 0 };
505 memcpy(&old_rect, &(con->rect), sizeof(Rect));
507 /* Grab the pointer */
508 xcb_grab_pointer_cookie_t cookie;
509 xcb_grab_pointer_reply_t *reply;
510 cookie = xcb_grab_pointer(conn,
511 false, /* get all pointer events specified by the following mask */
512 root, /* grab the root window */
513 XCB_EVENT_MASK_BUTTON_RELEASE | XCB_EVENT_MASK_POINTER_MOTION, /* which events to let through */
514 XCB_GRAB_MODE_ASYNC, /* pointer events should continue as normal */
515 XCB_GRAB_MODE_ASYNC, /* keyboard mode */
516 confine_to, /* confine_to = in which window should the cursor stay */
517 XCB_NONE, /* don’t display a special cursor */
520 if ((reply = xcb_grab_pointer_reply(conn, cookie, NULL)) == NULL) {
521 ELOG("Could not grab pointer\n");
527 /* Go into our own event loop */
530 xcb_generic_event_t *inside_event, *last_motion_notify = NULL;
531 bool loop_done = false;
532 /* I’ve always wanted to have my own eventhandler… */
533 while (!loop_done && (inside_event = xcb_wait_for_event(conn))) {
534 /* We now handle all events we can get using xcb_poll_for_event */
536 /* skip x11 errors */
537 if (inside_event->response_type == 0) {
541 /* Strip off the highest bit (set if the event is generated) */
542 int type = (inside_event->response_type & 0x7F);
545 case XCB_BUTTON_RELEASE:
549 case XCB_MOTION_NOTIFY:
550 /* motion_notify events are saved for later */
551 FREE(last_motion_notify);
552 last_motion_notify = inside_event;
555 case XCB_UNMAP_NOTIFY:
557 case XCB_KEY_RELEASE:
558 DLOG("Unmap-notify, aborting\n");
559 handle_event(type, inside_event);
564 DLOG("Passing to original handler\n");
565 /* Use original handler */
566 handle_event(type, inside_event);
569 if (last_motion_notify != inside_event)
571 } while ((inside_event = xcb_poll_for_event(conn)) != NULL);
573 if (last_motion_notify == NULL || loop_done)
576 new_x = ((xcb_motion_notify_event_t*)last_motion_notify)->root_x;
577 new_y = ((xcb_motion_notify_event_t*)last_motion_notify)->root_y;
579 callback(con, &old_rect, new_x, new_y, extra);
580 FREE(last_motion_notify);
583 xcb_ungrab_pointer(conn, XCB_CURRENT_TIME);
588 * Repositions the CT_FLOATING_CON to have the coordinates specified by
589 * newrect, but only if the coordinates are not out-of-bounds. Also reassigns
590 * the floating con to a different workspace if this move was across different
594 void floating_reposition(Con *con, Rect newrect) {
595 /* Sanity check: Are the new coordinates on any output? If not, we
596 * ignore that request. */
597 Output *output = get_output_containing(
598 newrect.x + (newrect.width / 2),
599 newrect.y + (newrect.height / 2));
602 ELOG("No output found at destination coordinates. Not repositioning.\n");
608 floating_maybe_reassign_ws(con);
613 * Fixes the coordinates of the floating window whenever the window gets
614 * reassigned to a different output (or when the output’s rect changes).
617 void floating_fix_coordinates(Con *con, Rect *old_rect, Rect *new_rect) {
618 DLOG("Fixing coordinates of floating window %p (rect (%d, %d), %d x %d)\n",
619 con, con->rect.x, con->rect.y, con->rect.width, con->rect.height);
620 DLOG("old_rect = (%d, %d), %d x %d\n",
621 old_rect->x, old_rect->y, old_rect->width, old_rect->height);
622 DLOG("new_rect = (%d, %d), %d x %d\n",
623 new_rect->x, new_rect->y, new_rect->width, new_rect->height);
624 /* First we get the x/y coordinates relative to the x/y coordinates
625 * of the output on which the window is on */
626 int32_t rel_x = (con->rect.x - old_rect->x);
627 int32_t rel_y = (con->rect.y - old_rect->y);
628 /* Then we calculate a fraction, for example 0.63 for a window
629 * which is at y = 1212 of a 1920 px high output */
630 DLOG("rel_x = %d, rel_y = %d, fraction_x = %f, fraction_y = %f, output->w = %d, output->h = %d\n",
631 rel_x, rel_y, (double)rel_x / old_rect->width, (double)rel_y / old_rect->height,
632 old_rect->width, old_rect->height);
633 /* Here we have to multiply at first. Or we will lose precision when not compiled with -msse2 */
634 con->rect.x = (int32_t)new_rect->x + (double)(rel_x * (int32_t)new_rect->width) / (int32_t)old_rect->width;
635 con->rect.y = (int32_t)new_rect->y + (double)(rel_y * (int32_t)new_rect->height) / (int32_t)old_rect->height;
636 DLOG("Resulting coordinates: x = %d, y = %d\n", con->rect.x, con->rect.y);
641 * Moves the client 10px to the specified direction.
644 void floating_move(xcb_connection_t *conn, Client *currently_focused, direction_t direction) {
645 DLOG("floating move\n");
647 Rect destination = currently_focused->rect;
648 Rect *screen = &(currently_focused->workspace->output->rect);
663 /* to make static analyzers happy */
668 /* Prevent windows from vanishing completely */
669 if ((int32_t)(destination.x + destination.width - 5) <= (int32_t)screen->x ||
670 (int32_t)(destination.x + 5) >= (int32_t)(screen->x + screen->width) ||
671 (int32_t)(destination.y + destination.height - 5) <= (int32_t)screen->y ||
672 (int32_t)(destination.y + 5) >= (int32_t)(screen->y + screen->height)) {
673 DLOG("boundary check failed, not moving\n");
677 currently_focused->rect = destination;
678 reposition_client(conn, currently_focused);
680 /* Because reposition_client does not send a faked configure event (only resize does),
681 * we need to initiate that on our own */
682 fake_absolute_configure_notify(conn, currently_focused);
683 /* fake_absolute_configure_notify flushes */
687 * Hides all floating clients (or show them if they are currently hidden) on
688 * the specified workspace.
691 void floating_toggle_hide(xcb_connection_t *conn, Workspace *workspace) {
694 workspace->floating_hidden = !workspace->floating_hidden;
695 DLOG("floating_hidden is now: %d\n", workspace->floating_hidden);
696 TAILQ_FOREACH(client, &(workspace->floating_clients), floating_clients) {
697 if (workspace->floating_hidden)
698 client_unmap(conn, client);
699 else client_map(conn, client);
702 /* If we just unmapped all floating windows we should ensure that the focus
703 * is set correctly, that ist, to the first non-floating client in stack */
704 if (workspace->floating_hidden)
705 SLIST_FOREACH(client, &(workspace->focus_stack), focus_clients) {
706 if (client_is_floating(client))
708 set_focus(conn, client, true);