]> git.sur5r.net Git - i3/i3/blob - src/floating.c
Fix regression: Don’t add floating nodes twice when restoring layout (+testcase)
[i3/i3] / src / floating.c
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  *
6  * © 2009-2010 Michael Stapelberg and contributors
7  *
8  * See file LICENSE for license information.
9  *
10  * src/floating.c: contains all functions for handling floating clients
11  *
12  */
13
14
15 #include "all.h"
16
17 extern xcb_connection_t *conn;
18
19 void floating_enable(Con *con, bool automatic) {
20     bool set_focus = true;
21
22     if (con_is_floating(con)) {
23         LOG("Container is already in floating mode, not doing anything.\n");
24         return;
25     }
26
27     /* 1: If the container is a workspace container, we need to create a new
28      * split-container with the same orientation and make that one floating. We
29      * cannot touch the workspace container itself because floating containers
30      * are children of the workspace. */
31     if (con->type == CT_WORKSPACE) {
32         LOG("This is a workspace, creating new container around content\n");
33         /* TODO: refactor this with src/con.c:con_set_layout */
34         Con *new = con_new(NULL);
35         new->parent = con;
36         new->orientation = con->orientation;
37
38         /* since the new container will be set into floating mode directly
39          * afterwards, we need to copy the workspace rect. */
40         memcpy(&(new->rect), &(con->rect), sizeof(Rect));
41
42         Con *old_focused = TAILQ_FIRST(&(con->focus_head));
43         if (old_focused == TAILQ_END(&(con->focus_head)))
44             old_focused = NULL;
45
46         /* 4: move the existing cons of this workspace below the new con */
47         DLOG("Moving cons\n");
48         Con *child;
49         while (!TAILQ_EMPTY(&(con->nodes_head))) {
50             child = TAILQ_FIRST(&(con->nodes_head));
51             con_detach(child);
52             con_attach(child, new, true);
53         }
54
55         /* 4: attach the new split container to the workspace */
56         DLOG("Attaching new split to ws\n");
57         con_attach(new, con, false);
58
59         if (old_focused)
60             con_focus(old_focused);
61
62         con = new;
63         set_focus = false;
64     }
65
66     /* 1: detach the container from its parent */
67     /* TODO: refactor this with tree_close() */
68     TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
69     TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
70
71     con_fix_percent(con->parent);
72
73     /* 2: create a new container to render the decoration on, add
74      * it as a floating window to the workspace */
75     Con *nc = con_new(NULL);
76     /* we need to set the parent afterwards instead of passing it as an
77      * argument to con_new() because nc would be inserted into the tiling layer
78      * otherwise. */
79     nc->parent = con_get_workspace(con);
80
81     /* check if the parent container is empty and close it if so */
82     if ((con->parent->type == CT_CON || con->parent->type == CT_FLOATING_CON) && con_num_children(con->parent) == 0) {
83         DLOG("Old container empty after setting this child to floating, closing\n");
84         tree_close(con->parent, false, false);
85     }
86
87     char *name;
88     asprintf(&name, "[i3 con] floatingcon around %p", con);
89     x_set_name(nc, name);
90     free(name);
91
92     /* find the height for the decorations */
93     i3Font *font = load_font(conn, config.font);
94     int deco_height = font->height + 5;
95
96     DLOG("Original rect: (%d, %d) with %d x %d\n", con->rect.x, con->rect.y, con->rect.width, con->rect.height);
97     nc->rect = con->rect;
98     /* add pixels for the decoration */
99     /* TODO: don’t add them when the user automatically puts new windows into
100      * 1pixel/borderless mode */
101     nc->rect.height += deco_height + 4;
102     nc->rect.width += 4;
103     DLOG("Floating rect: (%d, %d) with %d x %d\n", nc->rect.x, nc->rect.y, nc->rect.width, nc->rect.height);
104     nc->orientation = NO_ORIENTATION;
105     nc->type = CT_FLOATING_CON;
106     TAILQ_INSERT_TAIL(&(nc->parent->floating_head), nc, floating_windows);
107     TAILQ_INSERT_TAIL(&(nc->parent->focus_head), nc, focused);
108
109     /* 3: attach the child to the new parent container */
110     con->parent = nc;
111     con->percent = 1.0;
112     con->floating = FLOATING_USER_ON;
113
114     /* Some clients (like GIMP’s color picker window) get mapped
115      * to (0, 0), so we push them to a reasonable position
116      * (centered over their leader) */
117     if (nc->rect.x == 0 && nc->rect.y == 0) {
118         Con *leader;
119         if (con->window && con->window->leader != XCB_NONE &&
120             (leader = con_by_window_id(con->window->leader)) != NULL) {
121             DLOG("Centering above leader\n");
122             nc->rect.x = leader->rect.x + (leader->rect.width / 2) - (nc->rect.width / 2);
123             nc->rect.y = leader->rect.y + (leader->rect.height / 2) - (nc->rect.height / 2);
124         } else {
125             /* center the window on workspace as fallback */
126             Con *ws = nc->parent;
127             nc->rect.x = ws->rect.x + (ws->rect.width / 2) - (nc->rect.width / 2);
128             nc->rect.y = ws->rect.y + (ws->rect.height / 2) - (nc->rect.height / 2);
129         }
130     }
131
132     /* render the cons to get initial window_rect correct */
133     render_con(nc, false);
134     render_con(con, false);
135
136     TAILQ_INSERT_TAIL(&(nc->nodes_head), con, nodes);
137     TAILQ_INSERT_TAIL(&(nc->focus_head), con, focused);
138     // TODO: don’t influence focus handling when Con was not focused before.
139     if (set_focus)
140         con_focus(con);
141 }
142
143 void floating_disable(Con *con, bool automatic) {
144     if (!con_is_floating(con)) {
145         LOG("Container isn't floating, not doing anything.\n");
146         return;
147     }
148
149     /* 1: detach from parent container */
150     TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
151     TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
152
153     /* 2: kill parent container */
154     TAILQ_REMOVE(&(con->parent->parent->floating_head), con->parent, floating_windows);
155     TAILQ_REMOVE(&(con->parent->parent->focus_head), con->parent, focused);
156     tree_close(con->parent, false, false);
157
158     /* 3: re-attach to the parent of the currently focused con on the workspace
159      * this floating con was on */
160     Con *focused = con_descend_focused(con_get_workspace(con));
161     /* if there is no other container on this workspace, focused will be the
162      * workspace itself */
163     if (focused->type == CT_WORKSPACE)
164         con->parent = focused;
165     else con->parent = focused->parent;
166
167     /* XXX: We adjust the percentage value to start with a fair value. Floating
168      * cons always have 1.0 as percent which doesn’t work so well when
169      * re-inserting (the formerly floating con would get 50% of the target
170      * con). */
171     con->percent = (1.0 / con_num_children(con->parent));
172
173     TAILQ_INSERT_TAIL(&(con->parent->nodes_head), con, nodes);
174     TAILQ_INSERT_TAIL(&(con->parent->focus_head), con, focused);
175
176     con->floating = FLOATING_USER_OFF;
177
178     con_fix_percent(con->parent);
179     // TODO: don’t influence focus handling when Con was not focused before.
180     con_focus(con);
181 }
182
183 /*
184  * Toggles floating mode for the given container.
185  *
186  * If the automatic flag is set to true, this was an automatic update by a change of the
187  * window class from the application which can be overwritten by the user.
188  *
189  */
190 void toggle_floating_mode(Con *con, bool automatic) {
191     /* see if the client is already floating */
192     if (con_is_floating(con)) {
193         LOG("already floating, re-setting to tiling\n");
194
195         floating_disable(con, automatic);
196         return;
197     }
198
199     floating_enable(con, automatic);
200 }
201
202 /*
203  * Raises the given container in the list of floating containers
204  *
205  */
206 void floating_raise_con(Con *con) {
207     DLOG("Raising floating con %p / %s\n", con, con->name);
208     TAILQ_REMOVE(&(con->parent->floating_head), con, floating_windows);
209     TAILQ_INSERT_TAIL(&(con->parent->floating_head), con, floating_windows);
210 }
211
212 DRAGGING_CB(drag_window_callback) {
213     struct xcb_button_press_event_t *event = extra;
214
215     /* Reposition the client correctly while moving */
216     con->rect.x = old_rect->x + (new_x - event->root_x);
217     con->rect.y = old_rect->y + (new_y - event->root_y);
218     /* TODO: don’t re-render the whole tree just because we change
219      * coordinates of a floating window */
220     tree_render();
221     x_push_changes(croot);
222 }
223
224 /*
225  * Called when the user clicked on the titlebar of a floating window.
226  * Calls the drag_pointer function with the drag_window callback
227  *
228  */
229 void floating_drag_window(Con *con, xcb_button_press_event_t *event) {
230     DLOG("floating_drag_window\n");
231
232     drag_pointer(con, event, XCB_NONE, BORDER_TOP /* irrelevant */, drag_window_callback, event);
233     tree_render();
234 }
235
236 /*
237  * This is an ugly data structure which we need because there is no standard
238  * way of having nested functions (only available as a gcc extension at the
239  * moment, clang doesn’t support it) or blocks (only available as a clang
240  * extension and only on Mac OS X systems at the moment).
241  *
242  */
243 struct resize_window_callback_params {
244     border_t corner;
245     bool proportional;
246     xcb_button_press_event_t *event;
247 };
248
249 DRAGGING_CB(resize_window_callback) {
250     struct resize_window_callback_params *params = extra;
251     xcb_button_press_event_t *event = params->event;
252     border_t corner = params->corner;
253
254     int32_t dest_x = con->rect.x;
255     int32_t dest_y = con->rect.y;
256     uint32_t dest_width;
257     uint32_t dest_height;
258
259     double ratio = (double) old_rect->width / old_rect->height;
260
261     /* First guess: We resize by exactly the amount the mouse moved,
262      * taking into account in which corner the client was grabbed */
263     if (corner & BORDER_LEFT)
264         dest_width = old_rect->width - (new_x - event->root_x);
265     else dest_width = old_rect->width + (new_x - event->root_x);
266
267     if (corner & BORDER_TOP)
268         dest_height = old_rect->height - (new_y - event->root_y);
269     else dest_height = old_rect->height + (new_y - event->root_y);
270
271     /* TODO: minimum window size */
272 #if 0
273     /* Obey minimum window size */
274     dest_width = max(dest_width, client_min_width(client));
275     dest_height = max(dest_height, client_min_height(client));
276 #endif
277
278     /* User wants to keep proportions, so we may have to adjust our values */
279     if (params->proportional) {
280         dest_width = max(dest_width, (int) (dest_height * ratio));
281         dest_height = max(dest_height, (int) (dest_width / ratio));
282     }
283
284     /* If not the lower right corner is grabbed, we must also reposition
285      * the client by exactly the amount we resized it */
286     if (corner & BORDER_LEFT)
287         dest_x = old_rect->x + (old_rect->width - dest_width);
288
289     if (corner & BORDER_TOP)
290         dest_y = old_rect->y + (old_rect->height - dest_height);
291
292     con->rect = (Rect) { dest_x, dest_y, dest_width, dest_height };
293
294     /* TODO: don’t re-render the whole tree just because we change
295      * coordinates of a floating window */
296     tree_render();
297     x_push_changes(croot);
298 }
299
300 /*
301  * Called when the user clicked on a floating window while holding the
302  * floating_modifier and the right mouse button.
303  * Calls the drag_pointer function with the resize_window callback
304  *
305  */
306 void floating_resize_window(Con *con, bool proportional,
307                             xcb_button_press_event_t *event) {
308     DLOG("floating_resize_window\n");
309
310     /* corner saves the nearest corner to the original click. It contains
311      * a bitmask of the nearest borders (BORDER_LEFT, BORDER_RIGHT, …) */
312     border_t corner = 0;
313
314     if (event->event_x <= (con->rect.width / 2))
315         corner |= BORDER_LEFT;
316     else corner |= BORDER_RIGHT;
317
318     if (event->event_y <= (con->rect.height / 2))
319         corner |= BORDER_TOP;
320     else corner |= BORDER_RIGHT;
321
322     struct resize_window_callback_params params = { corner, proportional, event };
323
324     drag_pointer(con, event, XCB_NONE, BORDER_TOP /* irrelevant */, resize_window_callback, &params);
325 }
326
327 /*
328  * This function grabs your pointer and lets you drag stuff around (borders).
329  * Every time you move your mouse, an XCB_MOTION_NOTIFY event will be received
330  * and the given callback will be called with the parameters specified (client,
331  * border on which the click originally was), the original rect of the client,
332  * the event and the new coordinates (x, y).
333  *
334  */
335 void drag_pointer(Con *con, xcb_button_press_event_t *event, xcb_window_t
336                 confine_to, border_t border, callback_t callback, void *extra)
337 {
338     uint32_t new_x, new_y;
339     Rect old_rect;
340     if (con != NULL)
341         memcpy(&old_rect, &(con->rect), sizeof(Rect));
342
343     /* Grab the pointer */
344     /* TODO: returncode */
345     xcb_grab_pointer(conn, 
346                      false,               /* get all pointer events specified by the following mask */
347                      root,                /* grab the root window */
348                      XCB_EVENT_MASK_BUTTON_RELEASE | XCB_EVENT_MASK_POINTER_MOTION, /* which events to let through */
349                      XCB_GRAB_MODE_ASYNC, /* pointer events should continue as normal */
350                      XCB_GRAB_MODE_ASYNC, /* keyboard mode */
351                      confine_to,          /* confine_to = in which window should the cursor stay */
352                      XCB_NONE,            /* don’t display a special cursor */
353                      XCB_CURRENT_TIME);
354
355     /* Go into our own event loop */
356     xcb_flush(conn);
357
358     xcb_generic_event_t *inside_event, *last_motion_notify = NULL;
359     /* I’ve always wanted to have my own eventhandler… */
360     while ((inside_event = xcb_wait_for_event(conn))) {
361         /* We now handle all events we can get using xcb_poll_for_event */
362         do {
363             /* Same as get_event_handler in xcb */
364             int nr = inside_event->response_type;
365             if (nr == 0) {
366                 /* An error occured */
367                 //handle_event(NULL, conn, inside_event);
368                 free(inside_event);
369                 continue;
370             }
371             assert(nr < 256);
372             nr &= XCB_EVENT_RESPONSE_TYPE_MASK;
373             assert(nr >= 2);
374
375             switch (nr) {
376                 case XCB_BUTTON_RELEASE:
377                     goto done;
378
379                 case XCB_MOTION_NOTIFY:
380                     /* motion_notify events are saved for later */
381                     FREE(last_motion_notify);
382                     last_motion_notify = inside_event;
383                     break;
384
385                 case XCB_UNMAP_NOTIFY:
386                     DLOG("Unmap-notify, aborting\n");
387                     xcb_event_handle(&evenths, inside_event);
388                     goto done;
389
390                 default:
391                     DLOG("Passing to original handler\n");
392                     /* Use original handler */
393                     xcb_event_handle(&evenths, inside_event);
394                     break;
395             }
396             if (last_motion_notify != inside_event)
397                 free(inside_event);
398         } while ((inside_event = xcb_poll_for_event(conn)) != NULL);
399
400         if (last_motion_notify == NULL)
401             continue;
402
403         new_x = ((xcb_motion_notify_event_t*)last_motion_notify)->root_x;
404         new_y = ((xcb_motion_notify_event_t*)last_motion_notify)->root_y;
405
406         callback(con, &old_rect, new_x, new_y, extra);
407         FREE(last_motion_notify);
408     }
409 done:
410     xcb_ungrab_pointer(conn, XCB_CURRENT_TIME);
411     xcb_flush(conn);
412 }
413
414 #if 0
415 /*
416  * Changes focus in the given direction for floating clients.
417  *
418  * Changing to the left/right means going to the previous/next floating client,
419  * changing to top/bottom means cycling through the Z-index.
420  *
421  */
422 void floating_focus_direction(xcb_connection_t *conn, Client *currently_focused, direction_t direction) {
423         DLOG("floating focus\n");
424
425         if (direction == D_LEFT || direction == D_RIGHT) {
426                 /* Go to the next/previous floating client */
427                 Client *client;
428
429                 while ((client = (direction == D_LEFT ? TAILQ_PREV(currently_focused, floating_clients_head, floating_clients) :
430                                                         TAILQ_NEXT(currently_focused, floating_clients))) !=
431                        TAILQ_END(&(currently_focused->workspace->floating_clients))) {
432                         if (!client->floating)
433                                 continue;
434                         set_focus(conn, client, true);
435                         return;
436                 }
437         }
438 }
439
440 /*
441  * Moves the client 10px to the specified direction.
442  *
443  */
444 void floating_move(xcb_connection_t *conn, Client *currently_focused, direction_t direction) {
445         DLOG("floating move\n");
446
447         Rect destination = currently_focused->rect;
448         Rect *screen = &(currently_focused->workspace->output->rect);
449
450         switch (direction) {
451                 case D_LEFT:
452                         destination.x -= 10;
453                         break;
454                 case D_RIGHT:
455                         destination.x += 10;
456                         break;
457                 case D_UP:
458                         destination.y -= 10;
459                         break;
460                 case D_DOWN:
461                         destination.y += 10;
462                         break;
463                 /* to make static analyzers happy */
464                 default:
465                         break;
466         }
467
468         /* Prevent windows from vanishing completely */
469         if ((int32_t)(destination.x + destination.width - 5) <= (int32_t)screen->x ||
470             (int32_t)(destination.x + 5) >= (int32_t)(screen->x + screen->width) ||
471             (int32_t)(destination.y + destination.height - 5) <= (int32_t)screen->y ||
472             (int32_t)(destination.y + 5) >= (int32_t)(screen->y + screen->height)) {
473                 DLOG("boundary check failed, not moving\n");
474                 return;
475         }
476
477         currently_focused->rect = destination;
478         reposition_client(conn, currently_focused);
479
480         /* Because reposition_client does not send a faked configure event (only resize does),
481          * we need to initiate that on our own */
482         fake_absolute_configure_notify(conn, currently_focused);
483         /* fake_absolute_configure_notify flushes */
484 }
485
486 /*
487  * Hides all floating clients (or show them if they are currently hidden) on
488  * the specified workspace.
489  *
490  */
491 void floating_toggle_hide(xcb_connection_t *conn, Workspace *workspace) {
492         Client *client;
493
494         workspace->floating_hidden = !workspace->floating_hidden;
495         DLOG("floating_hidden is now: %d\n", workspace->floating_hidden);
496         TAILQ_FOREACH(client, &(workspace->floating_clients), floating_clients) {
497                 if (workspace->floating_hidden)
498                         client_unmap(conn, client);
499                 else client_map(conn, client);
500         }
501
502         /* If we just unmapped all floating windows we should ensure that the focus
503          * is set correctly, that ist, to the first non-floating client in stack */
504         if (workspace->floating_hidden)
505                 SLIST_FOREACH(client, &(workspace->focus_stack), focus_clients) {
506                         if (client_is_floating(client))
507                                 continue;
508                         set_focus(conn, client, true);
509                         return;
510                 }
511
512         xcb_flush(conn);
513 }
514 #endif