4 * i3 - an improved dynamic tiling window manager
6 * © 2009-2010 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * src/floating.c: contains all functions for handling floating clients
17 extern xcb_connection_t *conn;
20 * Toggles floating mode for the given container.
22 * If the automatic flag is set to true, this was an automatic update by a change of the
23 * window class from the application which can be overwritten by the user.
26 void toggle_floating_mode(Con *con, bool automatic) {
27 //i3Font *font = load_font(conn, config.font);
29 /* see if the client is already floating */
30 if (con_is_floating(con)) {
31 LOG("already floating, re-setting to tiling\n");
32 assert(con->old_parent != NULL);
34 /* 1: detach from parent container */
35 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
36 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
38 /* 2: kill parent container */
39 TAILQ_REMOVE(&(con->parent->parent->floating_head), con->parent, floating_windows);
40 TAILQ_REMOVE(&(con->parent->parent->focus_head), con->parent, focused);
41 tree_close(con->parent, false);
43 /* 3: re-attach to previous parent */
44 con->parent = con->old_parent;
45 TAILQ_INSERT_TAIL(&(con->parent->nodes_head), con, nodes);
46 TAILQ_INSERT_TAIL(&(con->parent->focus_head), con, focused);
48 con->floating = FLOATING_USER_OFF;
53 /* 1: detach the container from its parent */
54 /* TODO: refactor this with tree_close() */
55 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
56 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
60 TAILQ_FOREACH(child, &(con->parent->nodes_head), nodes)
62 /* TODO: better document why this math works */
63 double fix = 1.0 / (1.0 - (1.0 / (children+1)));
64 TAILQ_FOREACH(child, &(con->parent->nodes_head), nodes) {
65 if (child->percent <= 0.0)
67 child->percent *= fix;
70 /* 2: create a new container to render the decoration on, add
71 * it as a floating window to the workspace */
72 Con *nc = con_new(NULL);
73 nc->parent = con_get_workspace(con);
75 nc->orientation = NO_ORIENTATION;
76 nc->type = CT_FLOATING_CON;
77 TAILQ_INSERT_TAIL(&(nc->parent->floating_head), nc, floating_windows);
78 TAILQ_INSERT_TAIL(&(nc->parent->focus_head), nc, focused);
80 /* 3: attach the child to the new parent container */
81 con->old_parent = con->parent;
83 con->floating = FLOATING_USER_ON;
86 TAILQ_INSERT_TAIL(&(nc->nodes_head), con, nodes);
87 TAILQ_INSERT_TAIL(&(nc->focus_head), con, focused);
93 DLOG("Not putting dock client into floating mode\n");
98 DLOG("This client is already in floating (container == NULL), re-inserting\n");
100 Workspace *ws = client->workspace;
101 SLIST_FOREACH(next_tiling, &(ws->focus_stack), focus_clients)
102 if (!client_is_floating(next_tiling))
104 /* If there are no tiling clients on this workspace, there can only be one
105 * container: the first one */
106 if (next_tiling == TAILQ_END(&(ws->focus_stack)))
107 con = ws->table[0][0];
108 else con = next_tiling->container;
110 /* Remove the client from the list of floating clients */
111 TAILQ_REMOVE(&(ws->floating_clients), client, floating_clients);
113 DLOG("destination container = %p\n", con);
114 Client *old_focused = con->currently_focused;
115 /* Preserve position/size */
116 memcpy(&(client->floating_rect), &(client->rect), sizeof(Rect));
118 client->floating = FLOATING_USER_OFF;
119 client->container = con;
121 if (old_focused != NULL && !old_focused->dock)
122 CIRCLEQ_INSERT_AFTER(&(con->clients), old_focused, client, clients);
123 else CIRCLEQ_INSERT_TAIL(&(con->clients), client, clients);
125 DLOG("Re-inserted the window.\n");
126 con->currently_focused = client;
128 client_set_below_floating(conn, client);
130 render_container(conn, con);
136 DLOG("Entering floating for client %08x\n", client->child);
138 /* Remove the client of its container */
139 client_remove_from_container(conn, client, con, false);
140 client->container = NULL;
142 /* Add the client to the list of floating clients for its workspace */
143 TAILQ_INSERT_TAIL(&(client->workspace->floating_clients), client, floating_clients);
145 if (con->currently_focused == client) {
146 DLOG("Need to re-adjust currently_focused\n");
147 /* Get the next client in the focus stack for this particular container */
148 con->currently_focused = get_last_focused_client(conn, con, NULL);
152 client->floating = FLOATING_AUTO_ON;
153 else client->floating = FLOATING_USER_ON;
155 /* Initialize the floating position from the position in tiling mode, if this
156 * client never was floating (x == -1) */
157 if (client->floating_rect.x == -1) {
158 /* Copy over the position */
159 client->floating_rect.x = client->rect.x;
160 client->floating_rect.y = client->rect.y;
162 /* Copy size the other direction */
163 client->child_rect.width = client->floating_rect.width;
164 client->child_rect.height = client->floating_rect.height;
166 client->rect.width = client->child_rect.width + 2 + 2;
167 client->rect.height = client->child_rect.height + (font->height + 2 + 2) + 2;
169 DLOG("copying size from tiling (%d, %d) size (%d, %d)\n", client->floating_rect.x, client->floating_rect.y,
170 client->floating_rect.width, client->floating_rect.height);
172 /* If the client was already in floating before we restore the old position / size */
173 DLOG("using: (%d, %d) size (%d, %d)\n", client->floating_rect.x, client->floating_rect.y,
174 client->floating_rect.width, client->floating_rect.height);
175 memcpy(&(client->rect), &(client->floating_rect), sizeof(Rect));
178 /* Raise the client */
179 xcb_raise_window(conn, client->frame);
180 reposition_client(conn, client);
181 resize_client(conn, client);
182 /* redecorate_window flushes */
183 redecorate_window(conn, client);
185 /* Re-render the tiling layout of this container */
186 render_container(conn, con);
193 * Removes the floating client from its workspace and attaches it to the new workspace.
194 * This is centralized here because it may happen if you move it via keyboard and
195 * if you move it using your mouse.
198 void floating_assign_to_workspace(Client *client, Workspace *new_workspace) {
199 /* Remove from focus stack and list of floating clients */
200 SLIST_REMOVE(&(client->workspace->focus_stack), client, Client, focus_clients);
201 TAILQ_REMOVE(&(client->workspace->floating_clients), client, floating_clients);
203 if (client->workspace->fullscreen_client == client)
204 client->workspace->fullscreen_client = NULL;
206 /* Insert into destination focus stack and list of floating clients */
207 client->workspace = new_workspace;
208 SLIST_INSERT_HEAD(&(client->workspace->focus_stack), client, focus_clients);
209 TAILQ_INSERT_TAIL(&(client->workspace->floating_clients), client, floating_clients);
210 if (client->fullscreen)
211 client->workspace->fullscreen_client = client;
215 * This is an ugly data structure which we need because there is no standard
216 * way of having nested functions (only available as a gcc extension at the
217 * moment, clang doesn’t support it) or blocks (only available as a clang
218 * extension and only on Mac OS X systems at the moment).
221 struct resize_callback_params {
223 xcb_button_press_event_t *event;
226 DRAGGING_CB(resize_callback) {
227 struct resize_callback_params *params = extra;
228 xcb_button_press_event_t *event = params->event;
229 switch (params->border) {
231 int new_width = old_rect->width + (new_x - event->root_x);
232 if ((new_width < 0) ||
233 (new_width < client_min_width(client) && client->rect.width >= new_width))
235 client->rect.width = new_width;
239 case BORDER_BOTTOM: {
240 int new_height = old_rect->height + (new_y - event->root_y);
241 if ((new_height < 0) ||
242 (new_height < client_min_height(client) && client->rect.height >= new_height))
244 client->rect.height = old_rect->height + (new_y - event->root_y);
249 int new_height = old_rect->height + (event->root_y - new_y);
250 if ((new_height < 0) ||
251 (new_height < client_min_height(client) && client->rect.height >= new_height))
254 client->rect.y = old_rect->y + (new_y - event->root_y);
255 client->rect.height = new_height;
260 int new_width = old_rect->width + (event->root_x - new_x);
261 if ((new_width < 0) ||
262 (new_width < client_min_width(client) && client->rect.width >= new_width))
264 client->rect.x = old_rect->x + (new_x - event->root_x);
265 client->rect.width = new_width;
270 /* Push the new position/size to X11 */
271 reposition_client(conn, client);
272 resize_client(conn, client);
278 * Called whenever the user clicks on a border (not the titlebar!) of a floating window.
279 * Determines on which border the user clicked and launches the drag_pointer function
280 * with the resize_callback.
283 int floating_border_click(xcb_connection_t *conn, Client *client, xcb_button_press_event_t *event) {
284 DLOG("floating border click\n");
288 if (event->event_y < 2)
290 else if (event->event_y >= (client->rect.height - 2))
291 border = BORDER_BOTTOM;
292 else if (event->event_x <= 2)
293 border = BORDER_LEFT;
294 else if (event->event_x >= (client->rect.width - 2))
295 border = BORDER_RIGHT;
297 DLOG("Not on any border, not doing anything.\n");
301 DLOG("border = %d\n", border);
303 struct resize_callback_params params = { border, event };
305 drag_pointer(conn, client, event, XCB_NONE, border, resize_callback, ¶ms);
311 DRAGGING_CB(drag_window_callback) {
312 struct xcb_button_press_event_t *event = extra;
314 /* Reposition the client correctly while moving */
315 con->rect.x = old_rect->x + (new_x - event->root_x);
316 con->rect.y = old_rect->y + (new_y - event->root_y);
317 /* TODO: don’t re-render the whole tree just because we change
318 * coordinates of a floating window */
320 x_push_changes(croot);
324 * Called when the user clicked on the titlebar of a floating window.
325 * Calls the drag_pointer function with the drag_window callback
328 void floating_drag_window(Con *con, xcb_button_press_event_t *event) {
329 DLOG("floating_drag_window\n");
331 drag_pointer(con, event, XCB_NONE, BORDER_TOP /* irrelevant */, drag_window_callback, event);
337 * This is an ugly data structure which we need because there is no standard
338 * way of having nested functions (only available as a gcc extension at the
339 * moment, clang doesn’t support it) or blocks (only available as a clang
340 * extension and only on Mac OS X systems at the moment).
343 struct resize_window_callback_params {
346 xcb_button_press_event_t *event;
349 DRAGGING_CB(resize_window_callback) {
350 struct resize_window_callback_params *params = extra;
351 xcb_button_press_event_t *event = params->event;
352 border_t corner = params->corner;
354 int32_t dest_x = client->rect.x;
355 int32_t dest_y = client->rect.y;
357 uint32_t dest_height;
359 double ratio = (double) old_rect->width / old_rect->height;
361 /* First guess: We resize by exactly the amount the mouse moved,
362 * taking into account in which corner the client was grabbed */
363 if (corner & BORDER_LEFT)
364 dest_width = old_rect->width - (new_x - event->root_x);
365 else dest_width = old_rect->width + (new_x - event->root_x);
367 if (corner & BORDER_TOP)
368 dest_height = old_rect->height - (new_y - event->root_y);
369 else dest_height = old_rect->height + (new_y - event->root_y);
371 /* Obey minimum window size */
372 dest_width = max(dest_width, client_min_width(client));
373 dest_height = max(dest_height, client_min_height(client));
375 /* User wants to keep proportions, so we may have to adjust our values */
376 if (params->proportional) {
377 dest_width = max(dest_width, (int) (dest_height * ratio));
378 dest_height = max(dest_height, (int) (dest_width / ratio));
381 /* If not the lower right corner is grabbed, we must also reposition
382 * the client by exactly the amount we resized it */
383 if (corner & BORDER_LEFT)
384 dest_x = old_rect->x + (old_rect->width - dest_width);
386 if (corner & BORDER_TOP)
387 dest_y = old_rect->y + (old_rect->height - dest_height);
389 client->rect = (Rect) { dest_x, dest_y, dest_width, dest_height };
391 /* resize_client flushes */
392 resize_client(conn, client);
396 * Called when the user clicked on a floating window while holding the
397 * floating_modifier and the right mouse button.
398 * Calls the drag_pointer function with the resize_window callback
401 void floating_resize_window(xcb_connection_t *conn, Client *client,
402 bool proportional, xcb_button_press_event_t *event) {
403 DLOG("floating_resize_window\n");
405 /* corner saves the nearest corner to the original click. It contains
406 * a bitmask of the nearest borders (BORDER_LEFT, BORDER_RIGHT, …) */
409 if (event->event_x <= (client->rect.width / 2))
410 corner |= BORDER_LEFT;
411 else corner |= BORDER_RIGHT;
413 if (event->event_y <= (client->rect.height / 2))
414 corner |= BORDER_TOP;
415 else corner |= BORDER_RIGHT;
417 struct resize_window_callback_params params = { corner, proportional, event };
419 drag_pointer(conn, client, event, XCB_NONE, BORDER_TOP /* irrelevant */, resize_window_callback, ¶ms);
424 * This function grabs your pointer and lets you drag stuff around (borders).
425 * Every time you move your mouse, an XCB_MOTION_NOTIFY event will be received
426 * and the given callback will be called with the parameters specified (client,
427 * border on which the click originally was), the original rect of the client,
428 * the event and the new coordinates (x, y).
431 void drag_pointer(Con *con, xcb_button_press_event_t *event, xcb_window_t
432 confine_to, border_t border, callback_t callback, void *extra)
434 xcb_window_t root = xcb_setup_roots_iterator(xcb_get_setup(conn)).data->root;
435 uint32_t new_x, new_y;
438 memcpy(&old_rect, &(con->rect), sizeof(Rect));
440 /* Grab the pointer */
441 /* TODO: returncode */
442 xcb_grab_pointer(conn,
443 false, /* get all pointer events specified by the following mask */
444 root, /* grab the root window */
445 XCB_EVENT_MASK_BUTTON_RELEASE | XCB_EVENT_MASK_POINTER_MOTION, /* which events to let through */
446 XCB_GRAB_MODE_ASYNC, /* pointer events should continue as normal */
447 XCB_GRAB_MODE_ASYNC, /* keyboard mode */
448 confine_to, /* confine_to = in which window should the cursor stay */
449 XCB_NONE, /* don’t display a special cursor */
452 /* Go into our own event loop */
455 xcb_generic_event_t *inside_event, *last_motion_notify = NULL;
456 /* I’ve always wanted to have my own eventhandler… */
457 while ((inside_event = xcb_wait_for_event(conn))) {
458 /* We now handle all events we can get using xcb_poll_for_event */
460 /* Same as get_event_handler in xcb */
461 int nr = inside_event->response_type;
463 /* An error occured */
464 //handle_event(NULL, conn, inside_event);
469 nr &= XCB_EVENT_RESPONSE_TYPE_MASK;
473 case XCB_BUTTON_RELEASE:
476 case XCB_MOTION_NOTIFY:
477 /* motion_notify events are saved for later */
478 FREE(last_motion_notify);
479 last_motion_notify = inside_event;
482 case XCB_UNMAP_NOTIFY:
483 DLOG("Unmap-notify, aborting\n");
484 xcb_event_handle(&evenths, inside_event);
488 DLOG("Passing to original handler\n");
489 /* Use original handler */
490 xcb_event_handle(&evenths, inside_event);
493 if (last_motion_notify != inside_event)
495 } while ((inside_event = xcb_poll_for_event(conn)) != NULL);
497 if (last_motion_notify == NULL)
500 new_x = ((xcb_motion_notify_event_t*)last_motion_notify)->root_x;
501 new_y = ((xcb_motion_notify_event_t*)last_motion_notify)->root_y;
503 callback(con, &old_rect, new_x, new_y, extra);
504 FREE(last_motion_notify);
507 xcb_ungrab_pointer(conn, XCB_CURRENT_TIME);
513 * Changes focus in the given direction for floating clients.
515 * Changing to the left/right means going to the previous/next floating client,
516 * changing to top/bottom means cycling through the Z-index.
519 void floating_focus_direction(xcb_connection_t *conn, Client *currently_focused, direction_t direction) {
520 DLOG("floating focus\n");
522 if (direction == D_LEFT || direction == D_RIGHT) {
523 /* Go to the next/previous floating client */
526 while ((client = (direction == D_LEFT ? TAILQ_PREV(currently_focused, floating_clients_head, floating_clients) :
527 TAILQ_NEXT(currently_focused, floating_clients))) !=
528 TAILQ_END(&(currently_focused->workspace->floating_clients))) {
529 if (!client->floating)
531 set_focus(conn, client, true);
538 * Moves the client 10px to the specified direction.
541 void floating_move(xcb_connection_t *conn, Client *currently_focused, direction_t direction) {
542 DLOG("floating move\n");
544 Rect destination = currently_focused->rect;
545 Rect *screen = &(currently_focused->workspace->output->rect);
560 /* to make static analyzers happy */
565 /* Prevent windows from vanishing completely */
566 if ((int32_t)(destination.x + destination.width - 5) <= (int32_t)screen->x ||
567 (int32_t)(destination.x + 5) >= (int32_t)(screen->x + screen->width) ||
568 (int32_t)(destination.y + destination.height - 5) <= (int32_t)screen->y ||
569 (int32_t)(destination.y + 5) >= (int32_t)(screen->y + screen->height)) {
570 DLOG("boundary check failed, not moving\n");
574 currently_focused->rect = destination;
575 reposition_client(conn, currently_focused);
577 /* Because reposition_client does not send a faked configure event (only resize does),
578 * we need to initiate that on our own */
579 fake_absolute_configure_notify(conn, currently_focused);
580 /* fake_absolute_configure_notify flushes */
584 * Hides all floating clients (or show them if they are currently hidden) on
585 * the specified workspace.
588 void floating_toggle_hide(xcb_connection_t *conn, Workspace *workspace) {
591 workspace->floating_hidden = !workspace->floating_hidden;
592 DLOG("floating_hidden is now: %d\n", workspace->floating_hidden);
593 TAILQ_FOREACH(client, &(workspace->floating_clients), floating_clients) {
594 if (workspace->floating_hidden)
595 client_unmap(conn, client);
596 else client_map(conn, client);
599 /* If we just unmapped all floating windows we should ensure that the focus
600 * is set correctly, that ist, to the first non-floating client in stack */
601 if (workspace->floating_hidden)
602 SLIST_FOREACH(client, &(workspace->focus_stack), focus_clients) {
603 if (client_is_floating(client))
605 set_focus(conn, client, true);