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 tree_close(con->parent);
42 /* 3: re-attach to previous parent */
43 con->parent = con->old_parent;
44 TAILQ_INSERT_TAIL(&(con->parent->nodes_head), con, nodes);
45 TAILQ_INSERT_TAIL(&(con->parent->focus_head), con, focused);
50 /* 1: detach the container from its parent */
51 /* TODO: refactor this with tree_close() */
52 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
53 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
57 TAILQ_FOREACH(child, &(con->parent->nodes_head), nodes)
59 /* TODO: better document why this math works */
60 double fix = 1.0 / (1.0 - (1.0 / (children+1)));
61 TAILQ_FOREACH(child, &(con->parent->nodes_head), nodes) {
62 if (child->percent <= 0.0)
64 child->percent *= fix;
67 /* 2: create a new container to render the decoration on, add
68 * it as a floating window to the workspace */
69 Con *nc = con_new(NULL);
70 nc->parent = con_get_workspace(con);
72 nc->orientation = NO_ORIENTATION;
73 nc->type = CT_FLOATING_CON;
74 TAILQ_INSERT_TAIL(&(nc->parent->floating_head), nc, floating_windows);
76 /* 3: attach the child to the new parent container */
77 con->old_parent = con->parent;
79 con->floating = FLOATING_USER_ON;
82 TAILQ_INSERT_TAIL(&(nc->nodes_head), con, nodes);
83 TAILQ_INSERT_TAIL(&(nc->focus_head), con, focused);
89 DLOG("Not putting dock client into floating mode\n");
94 DLOG("This client is already in floating (container == NULL), re-inserting\n");
96 Workspace *ws = client->workspace;
97 SLIST_FOREACH(next_tiling, &(ws->focus_stack), focus_clients)
98 if (!client_is_floating(next_tiling))
100 /* If there are no tiling clients on this workspace, there can only be one
101 * container: the first one */
102 if (next_tiling == TAILQ_END(&(ws->focus_stack)))
103 con = ws->table[0][0];
104 else con = next_tiling->container;
106 /* Remove the client from the list of floating clients */
107 TAILQ_REMOVE(&(ws->floating_clients), client, floating_clients);
109 DLOG("destination container = %p\n", con);
110 Client *old_focused = con->currently_focused;
111 /* Preserve position/size */
112 memcpy(&(client->floating_rect), &(client->rect), sizeof(Rect));
114 client->floating = FLOATING_USER_OFF;
115 client->container = con;
117 if (old_focused != NULL && !old_focused->dock)
118 CIRCLEQ_INSERT_AFTER(&(con->clients), old_focused, client, clients);
119 else CIRCLEQ_INSERT_TAIL(&(con->clients), client, clients);
121 DLOG("Re-inserted the window.\n");
122 con->currently_focused = client;
124 client_set_below_floating(conn, client);
126 render_container(conn, con);
132 DLOG("Entering floating for client %08x\n", client->child);
134 /* Remove the client of its container */
135 client_remove_from_container(conn, client, con, false);
136 client->container = NULL;
138 /* Add the client to the list of floating clients for its workspace */
139 TAILQ_INSERT_TAIL(&(client->workspace->floating_clients), client, floating_clients);
141 if (con->currently_focused == client) {
142 DLOG("Need to re-adjust currently_focused\n");
143 /* Get the next client in the focus stack for this particular container */
144 con->currently_focused = get_last_focused_client(conn, con, NULL);
148 client->floating = FLOATING_AUTO_ON;
149 else client->floating = FLOATING_USER_ON;
151 /* Initialize the floating position from the position in tiling mode, if this
152 * client never was floating (x == -1) */
153 if (client->floating_rect.x == -1) {
154 /* Copy over the position */
155 client->floating_rect.x = client->rect.x;
156 client->floating_rect.y = client->rect.y;
158 /* Copy size the other direction */
159 client->child_rect.width = client->floating_rect.width;
160 client->child_rect.height = client->floating_rect.height;
162 client->rect.width = client->child_rect.width + 2 + 2;
163 client->rect.height = client->child_rect.height + (font->height + 2 + 2) + 2;
165 DLOG("copying size from tiling (%d, %d) size (%d, %d)\n", client->floating_rect.x, client->floating_rect.y,
166 client->floating_rect.width, client->floating_rect.height);
168 /* If the client was already in floating before we restore the old position / size */
169 DLOG("using: (%d, %d) size (%d, %d)\n", client->floating_rect.x, client->floating_rect.y,
170 client->floating_rect.width, client->floating_rect.height);
171 memcpy(&(client->rect), &(client->floating_rect), sizeof(Rect));
174 /* Raise the client */
175 xcb_raise_window(conn, client->frame);
176 reposition_client(conn, client);
177 resize_client(conn, client);
178 /* redecorate_window flushes */
179 redecorate_window(conn, client);
181 /* Re-render the tiling layout of this container */
182 render_container(conn, con);
189 * Removes the floating client from its workspace and attaches it to the new workspace.
190 * This is centralized here because it may happen if you move it via keyboard and
191 * if you move it using your mouse.
194 void floating_assign_to_workspace(Client *client, Workspace *new_workspace) {
195 /* Remove from focus stack and list of floating clients */
196 SLIST_REMOVE(&(client->workspace->focus_stack), client, Client, focus_clients);
197 TAILQ_REMOVE(&(client->workspace->floating_clients), client, floating_clients);
199 if (client->workspace->fullscreen_client == client)
200 client->workspace->fullscreen_client = NULL;
202 /* Insert into destination focus stack and list of floating clients */
203 client->workspace = new_workspace;
204 SLIST_INSERT_HEAD(&(client->workspace->focus_stack), client, focus_clients);
205 TAILQ_INSERT_TAIL(&(client->workspace->floating_clients), client, floating_clients);
206 if (client->fullscreen)
207 client->workspace->fullscreen_client = client;
211 * This is an ugly data structure which we need because there is no standard
212 * way of having nested functions (only available as a gcc extension at the
213 * moment, clang doesn’t support it) or blocks (only available as a clang
214 * extension and only on Mac OS X systems at the moment).
217 struct resize_callback_params {
219 xcb_button_press_event_t *event;
222 DRAGGING_CB(resize_callback) {
223 struct resize_callback_params *params = extra;
224 xcb_button_press_event_t *event = params->event;
225 switch (params->border) {
227 int new_width = old_rect->width + (new_x - event->root_x);
228 if ((new_width < 0) ||
229 (new_width < client_min_width(client) && client->rect.width >= new_width))
231 client->rect.width = new_width;
235 case BORDER_BOTTOM: {
236 int new_height = old_rect->height + (new_y - event->root_y);
237 if ((new_height < 0) ||
238 (new_height < client_min_height(client) && client->rect.height >= new_height))
240 client->rect.height = old_rect->height + (new_y - event->root_y);
245 int new_height = old_rect->height + (event->root_y - new_y);
246 if ((new_height < 0) ||
247 (new_height < client_min_height(client) && client->rect.height >= new_height))
250 client->rect.y = old_rect->y + (new_y - event->root_y);
251 client->rect.height = new_height;
256 int new_width = old_rect->width + (event->root_x - new_x);
257 if ((new_width < 0) ||
258 (new_width < client_min_width(client) && client->rect.width >= new_width))
260 client->rect.x = old_rect->x + (new_x - event->root_x);
261 client->rect.width = new_width;
266 /* Push the new position/size to X11 */
267 reposition_client(conn, client);
268 resize_client(conn, client);
274 * Called whenever the user clicks on a border (not the titlebar!) of a floating window.
275 * Determines on which border the user clicked and launches the drag_pointer function
276 * with the resize_callback.
279 int floating_border_click(xcb_connection_t *conn, Client *client, xcb_button_press_event_t *event) {
280 DLOG("floating border click\n");
284 if (event->event_y < 2)
286 else if (event->event_y >= (client->rect.height - 2))
287 border = BORDER_BOTTOM;
288 else if (event->event_x <= 2)
289 border = BORDER_LEFT;
290 else if (event->event_x >= (client->rect.width - 2))
291 border = BORDER_RIGHT;
293 DLOG("Not on any border, not doing anything.\n");
297 DLOG("border = %d\n", border);
299 struct resize_callback_params params = { border, event };
301 drag_pointer(conn, client, event, XCB_NONE, border, resize_callback, ¶ms);
307 DRAGGING_CB(drag_window_callback) {
308 struct xcb_button_press_event_t *event = extra;
310 /* Reposition the client correctly while moving */
311 con->rect.x = old_rect->x + (new_x - event->root_x);
312 con->rect.y = old_rect->y + (new_y - event->root_y);
313 //reposition_client(conn, con);
314 /* Because reposition_client does not send a faked configure event (only resize does),
315 * we need to initiate that on our own */
316 //fake_absolute_configure_notify(conn, client);
317 /* fake_absolute_configure_notify flushes */
321 * Called when the user clicked on the titlebar of a floating window.
322 * Calls the drag_pointer function with the drag_window callback
325 void floating_drag_window(Con *con, xcb_button_press_event_t *event) {
326 DLOG("floating_drag_window\n");
328 drag_pointer(con, event, XCB_NONE, BORDER_TOP /* irrelevant */, drag_window_callback, event);
334 * This is an ugly data structure which we need because there is no standard
335 * way of having nested functions (only available as a gcc extension at the
336 * moment, clang doesn’t support it) or blocks (only available as a clang
337 * extension and only on Mac OS X systems at the moment).
340 struct resize_window_callback_params {
343 xcb_button_press_event_t *event;
346 DRAGGING_CB(resize_window_callback) {
347 struct resize_window_callback_params *params = extra;
348 xcb_button_press_event_t *event = params->event;
349 border_t corner = params->corner;
351 int32_t dest_x = client->rect.x;
352 int32_t dest_y = client->rect.y;
354 uint32_t dest_height;
356 double ratio = (double) old_rect->width / old_rect->height;
358 /* First guess: We resize by exactly the amount the mouse moved,
359 * taking into account in which corner the client was grabbed */
360 if (corner & BORDER_LEFT)
361 dest_width = old_rect->width - (new_x - event->root_x);
362 else dest_width = old_rect->width + (new_x - event->root_x);
364 if (corner & BORDER_TOP)
365 dest_height = old_rect->height - (new_y - event->root_y);
366 else dest_height = old_rect->height + (new_y - event->root_y);
368 /* Obey minimum window size */
369 dest_width = max(dest_width, client_min_width(client));
370 dest_height = max(dest_height, client_min_height(client));
372 /* User wants to keep proportions, so we may have to adjust our values */
373 if (params->proportional) {
374 dest_width = max(dest_width, (int) (dest_height * ratio));
375 dest_height = max(dest_height, (int) (dest_width / ratio));
378 /* If not the lower right corner is grabbed, we must also reposition
379 * the client by exactly the amount we resized it */
380 if (corner & BORDER_LEFT)
381 dest_x = old_rect->x + (old_rect->width - dest_width);
383 if (corner & BORDER_TOP)
384 dest_y = old_rect->y + (old_rect->height - dest_height);
386 client->rect = (Rect) { dest_x, dest_y, dest_width, dest_height };
388 /* resize_client flushes */
389 resize_client(conn, client);
393 * Called when the user clicked on a floating window while holding the
394 * floating_modifier and the right mouse button.
395 * Calls the drag_pointer function with the resize_window callback
398 void floating_resize_window(xcb_connection_t *conn, Client *client,
399 bool proportional, xcb_button_press_event_t *event) {
400 DLOG("floating_resize_window\n");
402 /* corner saves the nearest corner to the original click. It contains
403 * a bitmask of the nearest borders (BORDER_LEFT, BORDER_RIGHT, …) */
406 if (event->event_x <= (client->rect.width / 2))
407 corner |= BORDER_LEFT;
408 else corner |= BORDER_RIGHT;
410 if (event->event_y <= (client->rect.height / 2))
411 corner |= BORDER_TOP;
412 else corner |= BORDER_RIGHT;
414 struct resize_window_callback_params params = { corner, proportional, event };
416 drag_pointer(conn, client, event, XCB_NONE, BORDER_TOP /* irrelevant */, resize_window_callback, ¶ms);
421 * This function grabs your pointer and lets you drag stuff around (borders).
422 * Every time you move your mouse, an XCB_MOTION_NOTIFY event will be received
423 * and the given callback will be called with the parameters specified (client,
424 * border on which the click originally was), the original rect of the client,
425 * the event and the new coordinates (x, y).
428 void drag_pointer(Con *con, xcb_button_press_event_t *event, xcb_window_t
429 confine_to, border_t border, callback_t callback, void *extra)
431 xcb_window_t root = xcb_setup_roots_iterator(xcb_get_setup(conn)).data->root;
432 uint32_t new_x, new_y;
435 memcpy(&old_rect, &(con->rect), sizeof(Rect));
437 /* Grab the pointer */
438 /* TODO: returncode */
439 xcb_grab_pointer(conn,
440 false, /* get all pointer events specified by the following mask */
441 root, /* grab the root window */
442 XCB_EVENT_MASK_BUTTON_RELEASE | XCB_EVENT_MASK_POINTER_MOTION, /* which events to let through */
443 XCB_GRAB_MODE_ASYNC, /* pointer events should continue as normal */
444 XCB_GRAB_MODE_ASYNC, /* keyboard mode */
445 confine_to, /* confine_to = in which window should the cursor stay */
446 XCB_NONE, /* don’t display a special cursor */
449 /* Go into our own event loop */
452 xcb_generic_event_t *inside_event, *last_motion_notify = NULL;
453 /* I’ve always wanted to have my own eventhandler… */
454 while ((inside_event = xcb_wait_for_event(conn))) {
455 /* We now handle all events we can get using xcb_poll_for_event */
457 /* Same as get_event_handler in xcb */
458 int nr = inside_event->response_type;
460 /* An error occured */
461 //handle_event(NULL, conn, inside_event);
466 nr &= XCB_EVENT_RESPONSE_TYPE_MASK;
470 case XCB_BUTTON_RELEASE:
473 case XCB_MOTION_NOTIFY:
474 /* motion_notify events are saved for later */
475 FREE(last_motion_notify);
476 last_motion_notify = inside_event;
479 case XCB_UNMAP_NOTIFY:
480 DLOG("Unmap-notify, aborting\n");
481 xcb_event_handle(&evenths, inside_event);
485 DLOG("Passing to original handler\n");
486 /* Use original handler */
487 xcb_event_handle(&evenths, inside_event);
490 if (last_motion_notify != inside_event)
492 } while ((inside_event = xcb_poll_for_event(conn)) != NULL);
494 if (last_motion_notify == NULL)
497 new_x = ((xcb_motion_notify_event_t*)last_motion_notify)->root_x;
498 new_y = ((xcb_motion_notify_event_t*)last_motion_notify)->root_y;
500 callback(con, &old_rect, new_x, new_y, extra);
501 FREE(last_motion_notify);
504 xcb_ungrab_pointer(conn, XCB_CURRENT_TIME);
510 * Changes focus in the given direction for floating clients.
512 * Changing to the left/right means going to the previous/next floating client,
513 * changing to top/bottom means cycling through the Z-index.
516 void floating_focus_direction(xcb_connection_t *conn, Client *currently_focused, direction_t direction) {
517 DLOG("floating focus\n");
519 if (direction == D_LEFT || direction == D_RIGHT) {
520 /* Go to the next/previous floating client */
523 while ((client = (direction == D_LEFT ? TAILQ_PREV(currently_focused, floating_clients_head, floating_clients) :
524 TAILQ_NEXT(currently_focused, floating_clients))) !=
525 TAILQ_END(&(currently_focused->workspace->floating_clients))) {
526 if (!client->floating)
528 set_focus(conn, client, true);
535 * Moves the client 10px to the specified direction.
538 void floating_move(xcb_connection_t *conn, Client *currently_focused, direction_t direction) {
539 DLOG("floating move\n");
541 Rect destination = currently_focused->rect;
542 Rect *screen = &(currently_focused->workspace->output->rect);
557 /* to make static analyzers happy */
562 /* Prevent windows from vanishing completely */
563 if ((int32_t)(destination.x + destination.width - 5) <= (int32_t)screen->x ||
564 (int32_t)(destination.x + 5) >= (int32_t)(screen->x + screen->width) ||
565 (int32_t)(destination.y + destination.height - 5) <= (int32_t)screen->y ||
566 (int32_t)(destination.y + 5) >= (int32_t)(screen->y + screen->height)) {
567 DLOG("boundary check failed, not moving\n");
571 currently_focused->rect = destination;
572 reposition_client(conn, currently_focused);
574 /* Because reposition_client does not send a faked configure event (only resize does),
575 * we need to initiate that on our own */
576 fake_absolute_configure_notify(conn, currently_focused);
577 /* fake_absolute_configure_notify flushes */
581 * Hides all floating clients (or show them if they are currently hidden) on
582 * the specified workspace.
585 void floating_toggle_hide(xcb_connection_t *conn, Workspace *workspace) {
588 workspace->floating_hidden = !workspace->floating_hidden;
589 DLOG("floating_hidden is now: %d\n", workspace->floating_hidden);
590 TAILQ_FOREACH(client, &(workspace->floating_clients), floating_clients) {
591 if (workspace->floating_hidden)
592 client_unmap(conn, client);
593 else client_map(conn, client);
596 /* If we just unmapped all floating windows we should ensure that the focus
597 * is set correctly, that ist, to the first non-floating client in stack */
598 if (workspace->floating_hidden)
599 SLIST_FOREACH(client, &(workspace->focus_stack), focus_clients) {
600 if (client_is_floating(client))
602 set_focus(conn, client, true);