2 #define I3__FILE__ "manage.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
9 * manage.c: Initially managing new windows (or existing ones on restart).
13 #include "yajl_utils.h"
15 #include <yajl/yajl_gen.h>
18 * Go through all existing windows (if the window manager is restarted) and manage them
21 void manage_existing_windows(xcb_window_t root) {
22 xcb_query_tree_reply_t *reply;
24 xcb_window_t *children;
25 xcb_get_window_attributes_cookie_t *cookies;
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)
31 len = xcb_query_tree_children_length(reply);
32 cookies = smalloc(len * sizeof(*cookies));
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]);
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);
48 * Restores the geometry of each window by reparenting it to the root window
49 * at the position of its frame.
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.
55 void restore_geometry(void) {
56 DLOG("Restoring geometry\n");
59 TAILQ_FOREACH(con, &all_cons, all_cons)
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);
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});
74 /* Make sure our changes reach the X server, we restart/exit now */
79 * Do some sanity checks and then reparent the window.
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;
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, wm_user_time_cookie;
95 geomc = xcb_get_geometry(conn, d);
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);
105 if (needs_to_be_mapped && attr->map_state != XCB_MAP_STATE_VIEWABLE) {
106 xcb_discard_reply(conn, geomc.sequence);
110 /* Don’t manage clients with the override_redirect flag */
111 if (attr->override_redirect) {
112 xcb_discard_reply(conn, geomc.sequence);
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);
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");
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
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");
149 #define GET_PROPERTY(atom, len) xcb_get_property(conn, false, window, atom, XCB_GET_PROPERTY_TYPE_ANY, 0, len)
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 wm_user_time_cookie = GET_PROPERTY(A__NET_WM_USER_TIME, UINT32_MAX);
166 DLOG("Managing window 0x%08x\n", window);
168 i3Window *cwindow = scalloc(1, sizeof(i3Window));
169 cwindow->id = window;
170 cwindow->depth = get_visual_depth(attr->visual);
172 xcb_grab_buttons(conn, window, bindings_should_grab_scrollwheel_buttons());
174 /* update as much information as possible so far (some replies may be NULL) */
175 window_update_class(cwindow, xcb_get_property_reply(conn, class_cookie, NULL), true);
176 window_update_name_legacy(cwindow, xcb_get_property_reply(conn, title_cookie, NULL), true);
177 window_update_name(cwindow, xcb_get_property_reply(conn, utf8_title_cookie, NULL), true);
178 window_update_leader(cwindow, xcb_get_property_reply(conn, leader_cookie, NULL));
179 window_update_transient_for(cwindow, xcb_get_property_reply(conn, transient_cookie, NULL));
180 window_update_strut_partial(cwindow, xcb_get_property_reply(conn, strut_cookie, NULL));
181 window_update_role(cwindow, xcb_get_property_reply(conn, role_cookie, NULL), true);
183 window_update_hints(cwindow, xcb_get_property_reply(conn, wm_hints_cookie, NULL), &urgency_hint);
184 border_style_t motif_border_style = BS_NORMAL;
185 window_update_motif_hints(cwindow, xcb_get_property_reply(conn, motif_wm_hints_cookie, NULL), &motif_border_style);
186 xcb_size_hints_t wm_size_hints;
187 if (!xcb_icccm_get_wm_size_hints_reply(conn, wm_normal_hints_cookie, &wm_size_hints, NULL))
188 memset(&wm_size_hints, '\0', sizeof(xcb_size_hints_t));
189 xcb_get_property_reply_t *type_reply = xcb_get_property_reply(conn, wm_type_cookie, NULL);
190 xcb_get_property_reply_t *state_reply = xcb_get_property_reply(conn, state_cookie, NULL);
192 xcb_get_property_reply_t *startup_id_reply;
193 startup_id_reply = xcb_get_property_reply(conn, startup_id_cookie, NULL);
194 char *startup_ws = startup_workspace_for_window(cwindow, startup_id_reply);
195 DLOG("startup workspace = %s\n", startup_ws);
197 /* check if the window needs WM_TAKE_FOCUS */
198 cwindow->needs_take_focus = window_supports_protocol(cwindow->id, A_WM_TAKE_FOCUS);
200 /* read the preferred _NET_WM_WINDOW_TYPE atom */
201 cwindow->window_type = xcb_get_preferred_window_type(type_reply);
203 /* Where to start searching for a container that swallows the new one? */
204 Con *search_at = croot;
206 if (xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_DOCK)) {
207 LOG("This window is of type dock\n");
208 Output *output = get_output_containing(geom->x, geom->y);
209 if (output != NULL) {
210 DLOG("Starting search at output %s\n", output->name);
211 search_at = output->con;
214 /* find out the desired position of this dock window */
215 if (cwindow->reserved.top > 0 && cwindow->reserved.bottom == 0) {
216 DLOG("Top dock client\n");
217 cwindow->dock = W_DOCK_TOP;
218 } else if (cwindow->reserved.top == 0 && cwindow->reserved.bottom > 0) {
219 DLOG("Bottom dock client\n");
220 cwindow->dock = W_DOCK_BOTTOM;
222 DLOG("Ignoring invalid reserved edges (_NET_WM_STRUT_PARTIAL), using position as fallback:\n");
223 if (geom->y < (int16_t)(search_at->rect.height / 2)) {
224 DLOG("geom->y = %d < rect.height / 2 = %d, it is a top dock client\n",
225 geom->y, (search_at->rect.height / 2));
226 cwindow->dock = W_DOCK_TOP;
228 DLOG("geom->y = %d >= rect.height / 2 = %d, it is a bottom dock client\n",
229 geom->y, (search_at->rect.height / 2));
230 cwindow->dock = W_DOCK_BOTTOM;
235 DLOG("Initial geometry: (%d, %d, %d, %d)\n", geom->x, geom->y, geom->width, geom->height);
239 Assignment *assignment;
241 /* TODO: two matches for one container */
243 /* See if any container swallows this new window */
244 nc = con_for_window(search_at, cwindow, &match);
245 const bool match_from_restart_mode = (match && match->restart_mode);
247 /* If not, check if it is assigned to a specific workspace */
248 if ((assignment = assignment_for(cwindow, A_TO_WORKSPACE))) {
249 DLOG("Assignment matches (%p)\n", match);
250 Con *assigned_ws = workspace_get(assignment->dest.workspace, NULL);
251 nc = con_descend_tiling_focused(assigned_ws);
252 DLOG("focused on ws %s: %p / %s\n", assigned_ws->name, nc, nc->name);
253 if (nc->type == CT_WORKSPACE)
254 nc = tree_open_con(nc, cwindow);
256 nc = tree_open_con(nc->parent, cwindow);
258 /* set the urgency hint on the window if the workspace is not visible */
259 if (!workspace_is_visible(assigned_ws))
261 } else if (startup_ws) {
262 /* If it’s not assigned, but was started on a specific workspace,
263 * we want to open it there */
264 DLOG("Using workspace on which this application was started (%s)\n", startup_ws);
265 nc = con_descend_tiling_focused(workspace_get(startup_ws, NULL));
266 DLOG("focused on ws %s: %p / %s\n", startup_ws, nc, nc->name);
267 if (nc->type == CT_WORKSPACE)
268 nc = tree_open_con(nc, cwindow);
270 nc = tree_open_con(nc->parent, cwindow);
272 /* If not, insert it at the currently focused position */
273 if (focused->type == CT_CON && con_accepts_window(focused)) {
274 LOG("using current container, focused = %p, focused->name = %s\n",
275 focused, focused->name);
278 nc = tree_open_con(NULL, cwindow);
281 /* M_BELOW inserts the new window as a child of the one which was
282 * matched (e.g. dock areas) */
283 if (match != NULL && match->insert_where == M_BELOW) {
284 nc = tree_open_con(nc, cwindow);
287 /* If M_BELOW is not used, the container is replaced. This happens with
288 * "swallows" criteria that are used for stored layouts, in which case
289 * we need to remove that criterion, because they should only be valid
291 if (match != NULL && match->insert_where != M_BELOW) {
292 DLOG("Removing match %p from container %p\n", match, nc);
293 TAILQ_REMOVE(&(nc->swallow_head), match, matches);
299 DLOG("new container = %p\n", nc);
300 if (nc->window != NULL && nc->window != cwindow) {
301 if (!restore_kill_placeholder(nc->window->id)) {
302 DLOG("Uh?! Container without a placeholder, but with a window, has swallowed this to-be-managed window?!\n");
304 /* Remove remaining criteria, the first swallowed window wins. */
305 while (!TAILQ_EMPTY(&(nc->swallow_head))) {
306 Match *first = TAILQ_FIRST(&(nc->swallow_head));
307 TAILQ_REMOVE(&(nc->swallow_head), first, matches);
313 if (nc->window != cwindow && nc->window != NULL) {
314 window_free(nc->window);
316 nc->window = cwindow;
319 nc->border_width = geom->border_width;
322 sasprintf(&name, "[i3 con] container around %p", cwindow);
323 x_set_name(nc, name);
326 /* handle fullscreen containers */
327 Con *ws = con_get_workspace(nc);
328 Con *fs = (ws ? con_get_fullscreen_con(ws, CF_OUTPUT) : NULL);
330 fs = con_get_fullscreen_con(croot, CF_GLOBAL);
332 if (xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_FULLSCREEN)) {
333 /* If this window is already fullscreen (after restarting!), skip
334 * toggling fullscreen, that would drop it out of fullscreen mode. */
336 con_toggle_fullscreen(nc, CF_OUTPUT);
340 bool set_focus = false;
343 DLOG("Not in fullscreen mode, focusing\n");
344 if (!cwindow->dock) {
345 /* Check that the workspace is visible and on the same output as
346 * the current focused container. If the window was assigned to an
347 * invisible workspace, we should not steal focus. */
348 Con *current_output = con_get_output(focused);
349 Con *target_output = con_get_output(ws);
351 if (workspace_is_visible(ws) && current_output == target_output) {
352 if (!match_from_restart_mode) {
355 DLOG("not focusing, matched with restart_mode == true\n");
358 DLOG("workspace not visible, not focusing\n");
361 DLOG("dock, not focusing\n");
364 DLOG("fs = %p, ws = %p, not focusing\n", fs, ws);
365 /* Insert the new container in focus stack *after* the currently
366 * focused (fullscreen) con. This way, the new container will be
367 * focused after we return from fullscreen mode */
368 Con *first = TAILQ_FIRST(&(nc->parent->focus_head));
370 /* We only modify the focus stack if the container is not already
371 * the first one. This can happen when existing containers swallow
372 * new windows, for example when restarting. */
373 TAILQ_REMOVE(&(nc->parent->focus_head), nc, focused);
374 TAILQ_INSERT_AFTER(&(nc->parent->focus_head), first, nc, focused);
378 /* set floating if necessary */
379 bool want_floating = false;
380 if (xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_DIALOG) ||
381 xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_UTILITY) ||
382 xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_TOOLBAR) ||
383 xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_SPLASH) ||
384 xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_MODAL) ||
385 (wm_size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MAX_SIZE &&
386 wm_size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MIN_SIZE &&
387 wm_size_hints.min_height == wm_size_hints.max_height &&
388 wm_size_hints.min_width == wm_size_hints.max_width)) {
389 LOG("This window is a dialog window, setting floating\n");
390 want_floating = true;
393 if (xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_STICKY))
399 if (cwindow->transient_for != XCB_NONE ||
400 (cwindow->leader != XCB_NONE &&
401 cwindow->leader != cwindow->id &&
402 con_by_window_id(cwindow->leader) != NULL)) {
403 LOG("This window is transient for another window, setting floating\n");
404 want_floating = true;
406 if (config.popup_during_fullscreen == PDF_LEAVE_FULLSCREEN &&
408 LOG("There is a fullscreen window, leaving fullscreen mode\n");
409 con_toggle_fullscreen(fs, CF_OUTPUT);
410 } else if (config.popup_during_fullscreen == PDF_SMART &&
412 fs->window != NULL) {
413 i3Window *transient_win = cwindow;
414 while (transient_win != NULL &&
415 transient_win->transient_for != XCB_NONE) {
416 if (transient_win->transient_for == fs->window->id) {
417 LOG("This floating window belongs to the fullscreen window (popup_during_fullscreen == smart)\n");
421 Con *next_transient = con_by_window_id(transient_win->transient_for);
422 if (next_transient == NULL)
424 /* Some clients (e.g. x11-ssh-askpass) actually set
425 * WM_TRANSIENT_FOR to their own window id, so break instead of
426 * looping endlessly. */
427 if (transient_win == next_transient->window)
429 transient_win = next_transient->window;
434 /* dock clients cannot be floating, that makes no sense */
436 want_floating = false;
438 /* Plasma windows set their geometry in WM_SIZE_HINTS. */
439 if ((wm_size_hints.flags & XCB_ICCCM_SIZE_HINT_US_POSITION || wm_size_hints.flags & XCB_ICCCM_SIZE_HINT_P_POSITION) &&
440 (wm_size_hints.flags & XCB_ICCCM_SIZE_HINT_US_SIZE || wm_size_hints.flags & XCB_ICCCM_SIZE_HINT_P_SIZE)) {
441 DLOG("We are setting geometry according to wm_size_hints x=%d y=%d w=%d h=%d\n",
442 wm_size_hints.x, wm_size_hints.y, wm_size_hints.width, wm_size_hints.height);
443 geom->x = wm_size_hints.x;
444 geom->y = wm_size_hints.y;
445 geom->width = wm_size_hints.width;
446 geom->height = wm_size_hints.height;
449 /* Store the requested geometry. The width/height gets raised to at least
450 * 75x50 when entering floating mode, which is the minimum size for a
451 * window to be useful (smaller windows are usually overlays/toolbars/…
452 * which are not managed by the wm anyways). We store the original geometry
453 * here because it’s used for dock clients. */
454 if (nc->geometry.width == 0)
455 nc->geometry = (Rect){geom->x, geom->y, geom->width, geom->height};
457 if (motif_border_style != BS_NORMAL) {
458 DLOG("MOTIF_WM_HINTS specifies decorations (border_style = %d)\n", motif_border_style);
460 con_set_border_style(nc, motif_border_style, config.default_floating_border_width);
462 con_set_border_style(nc, motif_border_style, config.default_border_width);
467 DLOG("geometry = %d x %d\n", nc->geometry.width, nc->geometry.height);
468 /* automatically set the border to the default value if a motif border
469 * was not specified */
470 bool automatic_border = (motif_border_style == BS_NORMAL);
472 floating_enable(nc, automatic_border);
475 /* explicitly set the border width to the default */
476 if (nc->current_border_width == -1) {
477 nc->current_border_width = (want_floating ? config.default_floating_border_width : config.default_border_width);
480 /* to avoid getting an UnmapNotify event due to reparenting, we temporarily
481 * declare no interest in any state change event of this window */
482 values[0] = XCB_NONE;
483 xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
485 xcb_void_cookie_t rcookie = xcb_reparent_window_checked(conn, window, nc->frame.id, 0, 0);
486 if (xcb_request_check(conn, rcookie) != NULL) {
487 LOG("Could not reparent the window, aborting\n");
491 values[0] = CHILD_EVENT_MASK & ~XCB_EVENT_MASK_ENTER_WINDOW;
492 xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
495 /* Put the client inside the save set. Upon termination (whether killed or
496 * normal exit does not matter) of the window manager, these clients will
497 * be correctly reparented to their most closest living ancestor (=
499 xcb_change_save_set(conn, XCB_SET_MODE_INSERT, window);
501 /* Check if any assignments match */
502 run_assignments(cwindow);
504 /* 'ws' may be invalid because of the assignments, e.g. when the user uses
505 * "move window to workspace 1", but had it assigned to workspace 2. */
506 ws = con_get_workspace(nc);
508 /* If this window was put onto an invisible workspace (via assignments), we
509 * render this workspace. It wouldn’t be rendered in our normal code path
510 * because only the visible workspaces get rendered.
512 * By rendering the workspace, we assign proper coordinates (read: not
513 * width=0, height=0) to the window, which is important for windows who
514 * actually use them to position their GUI elements, e.g. rhythmbox. */
515 if (ws && !workspace_is_visible(ws)) {
516 /* This is a bit hackish: we need to copy the content container’s rect
517 * to the workspace, because calling render_con() on the content
518 * container would also take the shortcut and not render the invisible
519 * workspace at all. However, just calling render_con() on the
520 * workspace isn’t enough either — it needs the rect. */
521 ws->rect = ws->parent->rect;
522 render_con(ws, true);
523 /* Disable setting focus, otherwise we’d move focus to an invisible
524 * workspace, which we generally prevent (e.g. in
525 * con_move_to_workspace). */
528 render_con(croot, false);
530 /* Send an event about window creation */
531 ipc_send_window_event("new", nc);
533 if (set_focus && assignment_for(cwindow, A_NO_FOCUS) != NULL) {
534 /* The first window on a workspace should always be focused. We have to
535 * compare with == 1 because the container has already been inserted at
537 if (con_num_children(ws) == 1) {
538 DLOG("This is the first window on this workspace, ignoring no_focus.\n");
540 DLOG("no_focus was set for con = %p, not setting focus.\n", nc);
546 DLOG("Checking con = %p for _NET_WM_USER_TIME.\n", nc);
548 uint32_t *wm_user_time;
549 xcb_get_property_reply_t *wm_user_time_reply = xcb_get_property_reply(conn, wm_user_time_cookie, NULL);
550 if (wm_user_time_reply != NULL && xcb_get_property_value_length(wm_user_time_reply) != 0 &&
551 (wm_user_time = xcb_get_property_value(wm_user_time_reply)) &&
552 wm_user_time[0] == 0) {
553 DLOG("_NET_WM_USER_TIME set to 0, not focusing con = %p.\n", nc);
557 FREE(wm_user_time_reply);
559 xcb_discard_reply(conn, wm_user_time_cookie.sequence);
562 /* Defer setting focus after the 'new' event has been sent to ensure the
563 * proper window event sequence. */
564 if (set_focus && !nc->window->doesnt_accept_focus && nc->mapped) {
565 DLOG("Now setting focus.\n");
571 /* Windows might get managed with the urgency hint already set (Pidgin is
572 * known to do that), so check for that and handle the hint accordingly.
573 * This code needs to be in this part of manage_window() because the window
574 * needs to be on the final workspace first. */
575 con_set_urgency(nc, urgency_hint);