]> git.sur5r.net Git - i3/i3/blob - src/manage.c
format **/*.c with clang-format-3.5
[i3/i3] / src / manage.c
1 #undef I3__FILE__
2 #define I3__FILE__ "manage.c"
3 /*
4  * vim:ts=4:sw=4:expandtab
5  *
6  * i3 - an improved dynamic tiling window manager
7  * © 2009-2013 Michael Stapelberg and contributors (see also: LICENSE)
8  *
9  * manage.c: Initially managing new windows (or existing ones on restart).
10  *
11  */
12 #include "all.h"
13 #include "yajl_utils.h"
14
15 #include <yajl/yajl_gen.h>
16
17 /*
18  * Go through all existing windows (if the window manager is restarted) and manage them
19  *
20  */
21 void manage_existing_windows(xcb_window_t root) {
22     xcb_query_tree_reply_t *reply;
23     int i, len;
24     xcb_window_t *children;
25     xcb_get_window_attributes_cookie_t *cookies;
26
27     /* Get the tree of windows whose parent is the root window (= all) */
28     if ((reply = xcb_query_tree_reply(conn, xcb_query_tree(conn, root), 0)) == NULL)
29         return;
30
31     len = xcb_query_tree_children_length(reply);
32     cookies = smalloc(len * sizeof(*cookies));
33
34     /* Request the window attributes for every window */
35     children = xcb_query_tree_children(reply);
36     for (i = 0; i < len; ++i)
37         cookies[i] = xcb_get_window_attributes(conn, children[i]);
38
39     /* Call manage_window with the attributes for every window */
40     for (i = 0; i < len; ++i)
41         manage_window(children[i], cookies[i], true);
42
43     free(reply);
44     free(cookies);
45 }
46
47 /*
48  * Restores the geometry of each window by reparenting it to the root window
49  * at the position of its frame.
50  *
51  * This is to be called *only* before exiting/restarting i3 because of evil
52  * side-effects which are to be expected when continuing to run i3.
53  *
54  */
55 void restore_geometry(void) {
56     DLOG("Restoring geometry\n");
57
58     Con *con;
59     TAILQ_FOREACH (con, &all_cons, all_cons)
60         if (con->window) {
61             DLOG("Re-adding X11 border of %d px\n", con->border_width);
62             con->window_rect.width += (2 * con->border_width);
63             con->window_rect.height += (2 * con->border_width);
64             xcb_set_window_rect(conn, con->window->id, con->window_rect);
65             DLOG("placing window %08x at %d %d\n", con->window->id, con->rect.x, con->rect.y);
66             xcb_reparent_window(conn, con->window->id, root,
67                                 con->rect.x, con->rect.y);
68         }
69
70     /* Strictly speaking, this line doesn’t really belong here, but since we
71      * are syncing, let’s un-register as a window manager first */
72     xcb_change_window_attributes(conn, root, XCB_CW_EVENT_MASK, (uint32_t[]) {XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT});
73
74     /* Make sure our changes reach the X server, we restart/exit now */
75     xcb_aux_sync(conn);
76 }
77
78 /*
79  * Do some sanity checks and then reparent the window.
80  *
81  */
82 void manage_window(xcb_window_t window, xcb_get_window_attributes_cookie_t cookie,
83                    bool needs_to_be_mapped) {
84     xcb_drawable_t d = {window};
85     xcb_get_geometry_cookie_t geomc;
86     xcb_get_geometry_reply_t *geom;
87     xcb_get_window_attributes_reply_t *attr = NULL;
88
89     xcb_get_property_cookie_t wm_type_cookie, strut_cookie, state_cookie,
90         utf8_title_cookie, title_cookie,
91         class_cookie, leader_cookie, transient_cookie,
92         role_cookie, startup_id_cookie, wm_hints_cookie,
93         wm_normal_hints_cookie, motif_wm_hints_cookie;
94
95     geomc = xcb_get_geometry(conn, d);
96
97     /* Check if the window is mapped (it could be not mapped when intializing and
98        calling manage_window() for every window) */
99     if ((attr = xcb_get_window_attributes_reply(conn, cookie, 0)) == NULL) {
100         DLOG("Could not get attributes\n");
101         xcb_discard_reply(conn, geomc.sequence);
102         return;
103     }
104
105     if (needs_to_be_mapped && attr->map_state != XCB_MAP_STATE_VIEWABLE) {
106         xcb_discard_reply(conn, geomc.sequence);
107         goto out;
108     }
109
110     /* Don’t manage clients with the override_redirect flag */
111     if (attr->override_redirect) {
112         xcb_discard_reply(conn, geomc.sequence);
113         goto out;
114     }
115
116     /* Check if the window is already managed */
117     if (con_by_window_id(window) != NULL) {
118         DLOG("already managed (by con %p)\n", con_by_window_id(window));
119         xcb_discard_reply(conn, geomc.sequence);
120         goto out;
121     }
122
123     /* Get the initial geometry (position, size, …) */
124     if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL) {
125         DLOG("could not get geometry\n");
126         goto out;
127     }
128
129     uint32_t values[1];
130
131     /* Set a temporary event mask for the new window, consisting only of
132      * PropertyChange and StructureNotify. We need to be notified of
133      * PropertyChanges because the client can change its properties *after* we
134      * requested them but *before* we actually reparented it and have set our
135      * final event mask.
136      * We need StructureNotify because the client may unmap the window before
137      * we get to re-parent it.
138      * If this request fails, we assume the client has already unmapped the
139      * window between the MapRequest and our event mask change. */
140     values[0] = XCB_EVENT_MASK_PROPERTY_CHANGE |
141                 XCB_EVENT_MASK_STRUCTURE_NOTIFY;
142     xcb_void_cookie_t event_mask_cookie =
143         xcb_change_window_attributes_checked(conn, window, XCB_CW_EVENT_MASK, values);
144     if (xcb_request_check(conn, event_mask_cookie) != NULL) {
145         LOG("Could not change event mask, the window probably already disappeared.\n");
146         goto out;
147     }
148
149 #define GET_PROPERTY(atom, len) xcb_get_property(conn, false, window, atom, XCB_GET_PROPERTY_TYPE_ANY, 0, len)
150
151     wm_type_cookie = GET_PROPERTY(A__NET_WM_WINDOW_TYPE, UINT32_MAX);
152     strut_cookie = GET_PROPERTY(A__NET_WM_STRUT_PARTIAL, UINT32_MAX);
153     state_cookie = GET_PROPERTY(A__NET_WM_STATE, UINT32_MAX);
154     utf8_title_cookie = GET_PROPERTY(A__NET_WM_NAME, 128);
155     leader_cookie = GET_PROPERTY(A_WM_CLIENT_LEADER, UINT32_MAX);
156     transient_cookie = GET_PROPERTY(XCB_ATOM_WM_TRANSIENT_FOR, UINT32_MAX);
157     title_cookie = GET_PROPERTY(XCB_ATOM_WM_NAME, 128);
158     class_cookie = GET_PROPERTY(XCB_ATOM_WM_CLASS, 128);
159     role_cookie = GET_PROPERTY(A_WM_WINDOW_ROLE, 128);
160     startup_id_cookie = GET_PROPERTY(A__NET_STARTUP_ID, 512);
161     wm_hints_cookie = xcb_icccm_get_wm_hints(conn, window);
162     wm_normal_hints_cookie = xcb_icccm_get_wm_normal_hints(conn, window);
163     motif_wm_hints_cookie = GET_PROPERTY(A__MOTIF_WM_HINTS, 5 * sizeof(uint64_t));
164
165     DLOG("Managing window 0x%08x\n", window);
166
167     i3Window *cwindow = scalloc(sizeof(i3Window));
168     cwindow->id = window;
169     cwindow->depth = get_visual_depth(attr->visual);
170
171     /* We need to grab the mouse buttons for click to focus */
172     xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
173                     XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
174                     1 /* left mouse button */,
175                     XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
176
177     xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
178                     XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
179                     2 /* middle mouse button */,
180                     XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
181
182     xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
183                     XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
184                     3 /* right mouse button */,
185                     XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
186
187     /* update as much information as possible so far (some replies may be NULL) */
188     window_update_class(cwindow, xcb_get_property_reply(conn, class_cookie, NULL), true);
189     window_update_name_legacy(cwindow, xcb_get_property_reply(conn, title_cookie, NULL), true);
190     window_update_name(cwindow, xcb_get_property_reply(conn, utf8_title_cookie, NULL), true);
191     window_update_leader(cwindow, xcb_get_property_reply(conn, leader_cookie, NULL));
192     window_update_transient_for(cwindow, xcb_get_property_reply(conn, transient_cookie, NULL));
193     window_update_strut_partial(cwindow, xcb_get_property_reply(conn, strut_cookie, NULL));
194     window_update_role(cwindow, xcb_get_property_reply(conn, role_cookie, NULL), true);
195     bool urgency_hint;
196     window_update_hints(cwindow, xcb_get_property_reply(conn, wm_hints_cookie, NULL), &urgency_hint);
197     border_style_t motif_border_style = BS_NORMAL;
198     window_update_motif_hints(cwindow, xcb_get_property_reply(conn, motif_wm_hints_cookie, NULL), &motif_border_style);
199     xcb_size_hints_t wm_size_hints;
200     if (!xcb_icccm_get_wm_size_hints_reply(conn, wm_normal_hints_cookie, &wm_size_hints, NULL))
201         memset(&wm_size_hints, '\0', sizeof(xcb_size_hints_t));
202     xcb_get_property_reply_t *type_reply = xcb_get_property_reply(conn, wm_type_cookie, NULL);
203     xcb_get_property_reply_t *state_reply = xcb_get_property_reply(conn, state_cookie, NULL);
204
205     xcb_get_property_reply_t *startup_id_reply;
206     startup_id_reply = xcb_get_property_reply(conn, startup_id_cookie, NULL);
207     char *startup_ws = startup_workspace_for_window(cwindow, startup_id_reply);
208     DLOG("startup workspace = %s\n", startup_ws);
209
210     /* check if the window needs WM_TAKE_FOCUS */
211     cwindow->needs_take_focus = window_supports_protocol(cwindow->id, A_WM_TAKE_FOCUS);
212
213     /* Where to start searching for a container that swallows the new one? */
214     Con *search_at = croot;
215
216     if (xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_DOCK)) {
217         LOG("This window is of type dock\n");
218         Output *output = get_output_containing(geom->x, geom->y);
219         if (output != NULL) {
220             DLOG("Starting search at output %s\n", output->name);
221             search_at = output->con;
222         }
223
224         /* find out the desired position of this dock window */
225         if (cwindow->reserved.top > 0 && cwindow->reserved.bottom == 0) {
226             DLOG("Top dock client\n");
227             cwindow->dock = W_DOCK_TOP;
228         } else if (cwindow->reserved.top == 0 && cwindow->reserved.bottom > 0) {
229             DLOG("Bottom dock client\n");
230             cwindow->dock = W_DOCK_BOTTOM;
231         } else {
232             DLOG("Ignoring invalid reserved edges (_NET_WM_STRUT_PARTIAL), using position as fallback:\n");
233             if (geom->y < (int16_t)(search_at->rect.height / 2)) {
234                 DLOG("geom->y = %d < rect.height / 2 = %d, it is a top dock client\n",
235                      geom->y, (search_at->rect.height / 2));
236                 cwindow->dock = W_DOCK_TOP;
237             } else {
238                 DLOG("geom->y = %d >= rect.height / 2 = %d, it is a bottom dock client\n",
239                      geom->y, (search_at->rect.height / 2));
240                 cwindow->dock = W_DOCK_BOTTOM;
241             }
242         }
243     }
244
245     DLOG("Initial geometry: (%d, %d, %d, %d)\n", geom->x, geom->y, geom->width, geom->height);
246
247     Con *nc = NULL;
248     Match *match = NULL;
249     Assignment *assignment;
250
251     /* TODO: two matches for one container */
252
253     /* See if any container swallows this new window */
254     nc = con_for_window(search_at, cwindow, &match);
255     if (nc == NULL) {
256         /* If not, check if it is assigned to a specific workspace / output */
257         if ((assignment = assignment_for(cwindow, A_TO_WORKSPACE | A_TO_OUTPUT))) {
258             DLOG("Assignment matches (%p)\n", match);
259             if (assignment->type == A_TO_WORKSPACE) {
260                 Con *assigned_ws = workspace_get(assignment->dest.workspace, NULL);
261                 nc = con_descend_tiling_focused(assigned_ws);
262                 DLOG("focused on ws %s: %p / %s\n", assigned_ws->name, nc, nc->name);
263                 if (nc->type == CT_WORKSPACE)
264                     nc = tree_open_con(nc, cwindow);
265                 else
266                     nc = tree_open_con(nc->parent, cwindow);
267
268                 /* set the urgency hint on the window if the workspace is not visible */
269                 if (!workspace_is_visible(assigned_ws))
270                     urgency_hint = true;
271             }
272             /* TODO: handle assignments with type == A_TO_OUTPUT */
273         } else if (startup_ws) {
274             /* If it’s not assigned, but was started on a specific workspace,
275              * we want to open it there */
276             DLOG("Using workspace on which this application was started (%s)\n", startup_ws);
277             nc = con_descend_tiling_focused(workspace_get(startup_ws, NULL));
278             DLOG("focused on ws %s: %p / %s\n", startup_ws, nc, nc->name);
279             if (nc->type == CT_WORKSPACE)
280                 nc = tree_open_con(nc, cwindow);
281             else
282                 nc = tree_open_con(nc->parent, cwindow);
283         } else {
284             /* If not, insert it at the currently focused position */
285             if (focused->type == CT_CON && con_accepts_window(focused)) {
286                 LOG("using current container, focused = %p, focused->name = %s\n",
287                     focused, focused->name);
288                 nc = focused;
289             } else
290                 nc = tree_open_con(NULL, cwindow);
291         }
292     } else {
293         /* M_BELOW inserts the new window as a child of the one which was
294          * matched (e.g. dock areas) */
295         if (match != NULL && match->insert_where == M_BELOW) {
296             nc = tree_open_con(nc, cwindow);
297         }
298
299         /* If M_BELOW is not used, the container is replaced. This happens with
300          * "swallows" criteria that are used for stored layouts, in which case
301          * we need to remove that criterion, because they should only be valid
302          * once. */
303         if (match != NULL && match->insert_where != M_BELOW) {
304             DLOG("Removing match %p from container %p\n", match, nc);
305             TAILQ_REMOVE(&(nc->swallow_head), match, matches);
306         }
307     }
308
309     DLOG("new container = %p\n", nc);
310     if (nc->window != NULL && nc->window != cwindow) {
311         if (!restore_kill_placeholder(nc->window->id)) {
312             DLOG("Uh?! Container without a placeholder, but with a window, has swallowed this to-be-managed window?!\n");
313         }
314     }
315     nc->window = cwindow;
316     x_reinit(nc);
317
318     nc->border_width = geom->border_width;
319
320     char *name;
321     sasprintf(&name, "[i3 con] container around %p", cwindow);
322     x_set_name(nc, name);
323     free(name);
324
325     /* handle fullscreen containers */
326     Con *ws = con_get_workspace(nc);
327     Con *fs = (ws ? con_get_fullscreen_con(ws, CF_OUTPUT) : NULL);
328     if (fs == NULL)
329         fs = con_get_fullscreen_con(croot, CF_GLOBAL);
330
331     if (xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_FULLSCREEN)) {
332         /* If this window is already fullscreen (after restarting!), skip
333          * toggling fullscreen, that would drop it out of fullscreen mode. */
334         if (fs != nc)
335             con_toggle_fullscreen(nc, CF_OUTPUT);
336         fs = NULL;
337     }
338
339     bool set_focus = false;
340
341     if (fs == NULL) {
342         DLOG("Not in fullscreen mode, focusing\n");
343         if (!cwindow->dock) {
344             /* Check that the workspace is visible and on the same output as
345              * the current focused container. If the window was assigned to an
346              * invisible workspace, we should not steal focus. */
347             Con *current_output = con_get_output(focused);
348             Con *target_output = con_get_output(ws);
349
350             if (workspace_is_visible(ws) && current_output == target_output) {
351                 if (!match || !match->restart_mode) {
352                     set_focus = true;
353                 } else
354                     DLOG("not focusing, matched with restart_mode == true\n");
355             } else
356                 DLOG("workspace not visible, not focusing\n");
357         } else
358             DLOG("dock, not focusing\n");
359     } else {
360         DLOG("fs = %p, ws = %p, not focusing\n", fs, ws);
361         /* Insert the new container in focus stack *after* the currently
362          * focused (fullscreen) con. This way, the new container will be
363          * focused after we return from fullscreen mode */
364         Con *first = TAILQ_FIRST(&(nc->parent->focus_head));
365         if (first != nc) {
366             /* We only modify the focus stack if the container is not already
367              * the first one. This can happen when existing containers swallow
368              * new windows, for example when restarting. */
369             TAILQ_REMOVE(&(nc->parent->focus_head), nc, focused);
370             TAILQ_INSERT_AFTER(&(nc->parent->focus_head), first, nc, focused);
371         }
372     }
373
374     /* set floating if necessary */
375     bool want_floating = false;
376     if (xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_DIALOG) ||
377         xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_UTILITY) ||
378         xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_TOOLBAR) ||
379         xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_SPLASH) ||
380         xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_MODAL) ||
381         (wm_size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MAX_SIZE &&
382          wm_size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MIN_SIZE &&
383          wm_size_hints.min_height == wm_size_hints.max_height &&
384          wm_size_hints.min_width == wm_size_hints.max_width)) {
385         LOG("This window is a dialog window, setting floating\n");
386         want_floating = true;
387     }
388
389     FREE(state_reply);
390     FREE(type_reply);
391
392     if (cwindow->transient_for != XCB_NONE ||
393         (cwindow->leader != XCB_NONE &&
394          cwindow->leader != cwindow->id &&
395          con_by_window_id(cwindow->leader) != NULL)) {
396         LOG("This window is transient for another window, setting floating\n");
397         want_floating = true;
398
399         if (config.popup_during_fullscreen == PDF_LEAVE_FULLSCREEN &&
400             fs != NULL) {
401             LOG("There is a fullscreen window, leaving fullscreen mode\n");
402             con_toggle_fullscreen(fs, CF_OUTPUT);
403         } else if (config.popup_during_fullscreen == PDF_SMART &&
404                    fs != NULL &&
405                    fs->window != NULL) {
406             i3Window *transient_win = cwindow;
407             while (transient_win != NULL &&
408                    transient_win->transient_for != XCB_NONE) {
409                 if (transient_win->transient_for == fs->window->id) {
410                     LOG("This floating window belongs to the fullscreen window (popup_during_fullscreen == smart)\n");
411                     set_focus = true;
412                     break;
413                 }
414                 Con *next_transient = con_by_window_id(transient_win->transient_for);
415                 if (next_transient == NULL)
416                     break;
417                 /* Some clients (e.g. x11-ssh-askpass) actually set
418                  * WM_TRANSIENT_FOR to their own window id, so break instead of
419                  * looping endlessly. */
420                 if (transient_win == next_transient->window)
421                     break;
422                 transient_win = next_transient->window;
423             }
424         }
425     }
426
427     /* dock clients cannot be floating, that makes no sense */
428     if (cwindow->dock)
429         want_floating = false;
430
431     /* Store the requested geometry. The width/height gets raised to at least
432      * 75x50 when entering floating mode, which is the minimum size for a
433      * window to be useful (smaller windows are usually overlays/toolbars/…
434      * which are not managed by the wm anyways). We store the original geometry
435      * here because it’s used for dock clients. */
436     if (nc->geometry.width == 0)
437         nc->geometry = (Rect) {geom->x, geom->y, geom->width, geom->height};
438
439     if (want_floating) {
440         DLOG("geometry = %d x %d\n", nc->geometry.width, nc->geometry.height);
441         floating_enable(nc, true);
442     }
443
444     if (motif_border_style != BS_NORMAL) {
445         DLOG("MOTIF_WM_HINTS specifies decorations (border_style = %d)\n", motif_border_style);
446         if (want_floating) {
447             con_set_border_style(nc, motif_border_style, config.default_floating_border_width);
448         } else {
449             con_set_border_style(nc, motif_border_style, config.default_border_width);
450         }
451     }
452
453     /* to avoid getting an UnmapNotify event due to reparenting, we temporarily
454      * declare no interest in any state change event of this window */
455     values[0] = XCB_NONE;
456     xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
457
458     xcb_void_cookie_t rcookie = xcb_reparent_window_checked(conn, window, nc->frame, 0, 0);
459     if (xcb_request_check(conn, rcookie) != NULL) {
460         LOG("Could not reparent the window, aborting\n");
461         goto geom_out;
462     }
463
464     values[0] = CHILD_EVENT_MASK & ~XCB_EVENT_MASK_ENTER_WINDOW;
465     xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
466     xcb_flush(conn);
467
468     /* Put the client inside the save set. Upon termination (whether killed or
469      * normal exit does not matter) of the window manager, these clients will
470      * be correctly reparented to their most closest living ancestor (=
471      * cleanup) */
472     xcb_change_save_set(conn, XCB_SET_MODE_INSERT, window);
473
474     /* Check if any assignments match */
475     run_assignments(cwindow);
476
477     /* 'ws' may be invalid because of the assignments, e.g. when the user uses
478      * "move window to workspace 1", but had it assigned to workspace 2. */
479     ws = con_get_workspace(nc);
480
481     /* If this window was put onto an invisible workspace (via assignments), we
482      * render this workspace. It wouldn’t be rendered in our normal code path
483      * because only the visible workspaces get rendered.
484      *
485      * By rendering the workspace, we assign proper coordinates (read: not
486      * width=0, height=0) to the window, which is important for windows who
487      * actually use them to position their GUI elements, e.g. rhythmbox. */
488     if (ws && !workspace_is_visible(ws)) {
489         /* This is a bit hackish: we need to copy the content container’s rect
490          * to the workspace, because calling render_con() on the content
491          * container would also take the shortcut and not render the invisible
492          * workspace at all. However, just calling render_con() on the
493          * workspace isn’t enough either — it needs the rect. */
494         ws->rect = ws->parent->rect;
495         render_con(ws, true);
496         /* Disable setting focus, otherwise we’d move focus to an invisible
497          * workspace, which we generally prevent (e.g. in
498          * con_move_to_workspace). */
499         set_focus = false;
500     }
501     render_con(croot, false);
502
503     /* Send an event about window creation */
504     ipc_send_window_event("new", nc);
505
506     /* Defer setting focus after the 'new' event has been sent to ensure the
507      * proper window event sequence. */
508     if (set_focus) {
509         DLOG("Now setting focus.\n");
510         con_focus(nc);
511     }
512
513     tree_render();
514
515     /* Windows might get managed with the urgency hint already set (Pidgin is
516      * known to do that), so check for that and handle the hint accordingly.
517      * This code needs to be in this part of manage_window() because the window
518      * needs to be on the final workspace first. */
519     con_set_urgency(nc, urgency_hint);
520
521 geom_out:
522     free(geom);
523 out:
524     free(attr);
525     return;
526 }