2 #define I3__FILE__ "manage.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009-2013 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 * The following function sends a new window event, which consists
80 * of fields "change" and "container", the latter containing a dump
81 * of the window's container.
84 static void ipc_send_window_new_event(Con *con) {
85 setlocale(LC_NUMERIC, "C");
86 yajl_gen gen = ygenalloc();
94 dump_node(gen, con, false);
98 const unsigned char *payload;
100 y(get_buf, &payload, &length);
102 ipc_send_event("window", I3_IPC_EVENT_WINDOW, (const char *)payload);
104 setlocale(LC_NUMERIC, "");
108 * Do some sanity checks and then reparent the window.
111 void manage_window(xcb_window_t window, xcb_get_window_attributes_cookie_t cookie,
112 bool needs_to_be_mapped) {
113 xcb_drawable_t d = { window };
114 xcb_get_geometry_cookie_t geomc;
115 xcb_get_geometry_reply_t *geom;
116 xcb_get_window_attributes_reply_t *attr = NULL;
118 xcb_get_property_cookie_t wm_type_cookie, strut_cookie, state_cookie,
119 utf8_title_cookie, title_cookie,
120 class_cookie, leader_cookie, transient_cookie,
121 role_cookie, startup_id_cookie, wm_hints_cookie,
122 motif_wm_hints_cookie;
125 geomc = xcb_get_geometry(conn, d);
127 /* Check if the window is mapped (it could be not mapped when intializing and
128 calling manage_window() for every window) */
129 if ((attr = xcb_get_window_attributes_reply(conn, cookie, 0)) == NULL) {
130 DLOG("Could not get attributes\n");
131 xcb_discard_reply(conn, geomc.sequence);
135 if (needs_to_be_mapped && attr->map_state != XCB_MAP_STATE_VIEWABLE) {
136 xcb_discard_reply(conn, geomc.sequence);
140 /* Don’t manage clients with the override_redirect flag */
141 if (attr->override_redirect) {
142 xcb_discard_reply(conn, geomc.sequence);
146 /* Check if the window is already managed */
147 if (con_by_window_id(window) != NULL) {
148 DLOG("already managed (by con %p)\n", con_by_window_id(window));
149 xcb_discard_reply(conn, geomc.sequence);
153 /* Get the initial geometry (position, size, …) */
154 if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL) {
155 DLOG("could not get geometry\n");
161 /* Set a temporary event mask for the new window, consisting only of
162 * PropertyChange and StructureNotify. We need to be notified of
163 * PropertyChanges because the client can change its properties *after* we
164 * requested them but *before* we actually reparented it and have set our
166 * We need StructureNotify because the client may unmap the window before
167 * we get to re-parent it.
168 * If this request fails, we assume the client has already unmapped the
169 * window between the MapRequest and our event mask change. */
170 values[0] = XCB_EVENT_MASK_PROPERTY_CHANGE |
171 XCB_EVENT_MASK_STRUCTURE_NOTIFY;
172 xcb_void_cookie_t event_mask_cookie =
173 xcb_change_window_attributes_checked(conn, window, XCB_CW_EVENT_MASK, values);
174 if (xcb_request_check(conn, event_mask_cookie) != NULL) {
175 LOG("Could not change event mask, the window probably already disappeared.\n");
179 #define GET_PROPERTY(atom, len) xcb_get_property(conn, false, window, atom, XCB_GET_PROPERTY_TYPE_ANY, 0, len)
181 wm_type_cookie = GET_PROPERTY(A__NET_WM_WINDOW_TYPE, UINT32_MAX);
182 strut_cookie = GET_PROPERTY(A__NET_WM_STRUT_PARTIAL, UINT32_MAX);
183 state_cookie = GET_PROPERTY(A__NET_WM_STATE, UINT32_MAX);
184 utf8_title_cookie = GET_PROPERTY(A__NET_WM_NAME, 128);
185 leader_cookie = GET_PROPERTY(A_WM_CLIENT_LEADER, UINT32_MAX);
186 transient_cookie = GET_PROPERTY(XCB_ATOM_WM_TRANSIENT_FOR, UINT32_MAX);
187 title_cookie = GET_PROPERTY(XCB_ATOM_WM_NAME, 128);
188 class_cookie = GET_PROPERTY(XCB_ATOM_WM_CLASS, 128);
189 role_cookie = GET_PROPERTY(A_WM_WINDOW_ROLE, 128);
190 startup_id_cookie = GET_PROPERTY(A__NET_STARTUP_ID, 512);
191 wm_hints_cookie = xcb_icccm_get_wm_hints(conn, window);
192 motif_wm_hints_cookie = GET_PROPERTY(A__MOTIF_WM_HINTS, 5 * sizeof(uint64_t));
193 /* TODO: also get wm_normal_hints here. implement after we got rid of xcb-event */
195 DLOG("Managing window 0x%08x\n", window);
197 i3Window *cwindow = scalloc(sizeof(i3Window));
198 cwindow->id = window;
199 cwindow->depth = get_visual_depth(attr->visual);
201 /* We need to grab the mouse buttons for click to focus */
202 xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
203 XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
204 1 /* left mouse button */,
205 XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
207 xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
208 XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
209 2 /* middle mouse button */,
210 XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
212 xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
213 XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
214 3 /* right mouse button */,
215 XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
217 /* update as much information as possible so far (some replies may be NULL) */
218 window_update_class(cwindow, xcb_get_property_reply(conn, class_cookie, NULL), true);
219 window_update_name_legacy(cwindow, xcb_get_property_reply(conn, title_cookie, NULL), true);
220 window_update_name(cwindow, xcb_get_property_reply(conn, utf8_title_cookie, NULL), true);
221 window_update_leader(cwindow, xcb_get_property_reply(conn, leader_cookie, NULL));
222 window_update_transient_for(cwindow, xcb_get_property_reply(conn, transient_cookie, NULL));
223 window_update_strut_partial(cwindow, xcb_get_property_reply(conn, strut_cookie, NULL));
224 window_update_role(cwindow, xcb_get_property_reply(conn, role_cookie, NULL), true);
226 window_update_hints(cwindow, xcb_get_property_reply(conn, wm_hints_cookie, NULL), &urgency_hint);
227 border_style_t motif_border_style = BS_NORMAL;
228 window_update_motif_hints(cwindow, xcb_get_property_reply(conn, motif_wm_hints_cookie, NULL), &motif_border_style);
230 xcb_get_property_reply_t *startup_id_reply;
231 startup_id_reply = xcb_get_property_reply(conn, startup_id_cookie, NULL);
232 char *startup_ws = startup_workspace_for_window(cwindow, startup_id_reply);
233 DLOG("startup workspace = %s\n", startup_ws);
235 /* check if the window needs WM_TAKE_FOCUS */
236 cwindow->needs_take_focus = window_supports_protocol(cwindow->id, A_WM_TAKE_FOCUS);
238 /* Where to start searching for a container that swallows the new one? */
239 Con *search_at = croot;
241 xcb_get_property_reply_t *reply = xcb_get_property_reply(conn, wm_type_cookie, NULL);
242 if (xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_DOCK)) {
243 LOG("This window is of type dock\n");
244 Output *output = get_output_containing(geom->x, geom->y);
245 if (output != NULL) {
246 DLOG("Starting search at output %s\n", output->name);
247 search_at = output->con;
250 /* find out the desired position of this dock window */
251 if (cwindow->reserved.top > 0 && cwindow->reserved.bottom == 0) {
252 DLOG("Top dock client\n");
253 cwindow->dock = W_DOCK_TOP;
254 } else if (cwindow->reserved.top == 0 && cwindow->reserved.bottom > 0) {
255 DLOG("Bottom dock client\n");
256 cwindow->dock = W_DOCK_BOTTOM;
258 DLOG("Ignoring invalid reserved edges (_NET_WM_STRUT_PARTIAL), using position as fallback:\n");
259 if (geom->y < (int16_t)(search_at->rect.height / 2)) {
260 DLOG("geom->y = %d < rect.height / 2 = %d, it is a top dock client\n",
261 geom->y, (search_at->rect.height / 2));
262 cwindow->dock = W_DOCK_TOP;
264 DLOG("geom->y = %d >= rect.height / 2 = %d, it is a bottom dock client\n",
265 geom->y, (search_at->rect.height / 2));
266 cwindow->dock = W_DOCK_BOTTOM;
271 DLOG("Initial geometry: (%d, %d, %d, %d)\n", geom->x, geom->y, geom->width, geom->height);
275 Assignment *assignment;
277 /* TODO: two matches for one container */
279 /* See if any container swallows this new window */
280 nc = con_for_window(search_at, cwindow, &match);
282 /* If not, check if it is assigned to a specific workspace / output */
283 if ((assignment = assignment_for(cwindow, A_TO_WORKSPACE | A_TO_OUTPUT))) {
284 DLOG("Assignment matches (%p)\n", match);
285 if (assignment->type == A_TO_WORKSPACE) {
286 Con *assigned_ws = workspace_get(assignment->dest.workspace, NULL);
287 nc = con_descend_tiling_focused(assigned_ws);
288 DLOG("focused on ws %s: %p / %s\n", assigned_ws->name, nc, nc->name);
289 if (nc->type == CT_WORKSPACE)
290 nc = tree_open_con(nc, cwindow);
292 nc = tree_open_con(nc->parent, cwindow);
294 /* set the urgency hint on the window if the workspace is not visible */
295 if (!workspace_is_visible(assigned_ws))
298 /* TODO: handle assignments with type == A_TO_OUTPUT */
299 } else if (startup_ws) {
300 /* If it’s not assigned, but was started on a specific workspace,
301 * we want to open it there */
302 DLOG("Using workspace on which this application was started (%s)\n", startup_ws);
303 nc = con_descend_tiling_focused(workspace_get(startup_ws, NULL));
304 DLOG("focused on ws %s: %p / %s\n", startup_ws, nc, nc->name);
305 if (nc->type == CT_WORKSPACE)
306 nc = tree_open_con(nc, cwindow);
307 else nc = tree_open_con(nc->parent, cwindow);
309 /* If not, insert it at the currently focused position */
310 if (focused->type == CT_CON && con_accepts_window(focused)) {
311 LOG("using current container, focused = %p, focused->name = %s\n",
312 focused, focused->name);
314 } else nc = tree_open_con(NULL, cwindow);
317 /* M_BELOW inserts the new window as a child of the one which was
318 * matched (e.g. dock areas) */
319 if (match != NULL && match->insert_where == M_BELOW) {
320 nc = tree_open_con(nc, cwindow);
323 /* If M_BELOW is not used, the container is replaced. This happens with
324 * "swallows" criteria that are used for stored layouts, in which case
325 * we need to remove that criterion, because they should only be valid
327 if (match != NULL && match->insert_where != M_BELOW) {
328 DLOG("Removing match %p from container %p\n", match, nc);
329 TAILQ_REMOVE(&(nc->swallow_head), match, matches);
333 DLOG("new container = %p\n", nc);
334 if (nc->window != NULL && nc->window != cwindow) {
335 if (!restore_kill_placeholder(nc->window->id)) {
336 DLOG("Uh?! Container without a placeholder, but with a window, has swallowed this to-be-managed window?!\n");
339 nc->window = cwindow;
342 nc->border_width = geom->border_width;
345 sasprintf(&name, "[i3 con] container around %p", cwindow);
346 x_set_name(nc, name);
349 /* handle fullscreen containers */
350 Con *ws = con_get_workspace(nc);
351 Con *fs = (ws ? con_get_fullscreen_con(ws, CF_OUTPUT) : NULL);
353 fs = con_get_fullscreen_con(croot, CF_GLOBAL);
355 xcb_get_property_reply_t *state_reply = xcb_get_property_reply(conn, state_cookie, NULL);
356 if (xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_FULLSCREEN)) {
358 con_toggle_fullscreen(nc, CF_OUTPUT);
364 DLOG("Not in fullscreen mode, focusing\n");
365 if (!cwindow->dock) {
366 /* Check that the workspace is visible and on the same output as
367 * the current focused container. If the window was assigned to an
368 * invisible workspace, we should not steal focus. */
369 Con *current_output = con_get_output(focused);
370 Con *target_output = con_get_output(ws);
372 if (workspace_is_visible(ws) && current_output == target_output) {
373 if (!match || !match->restart_mode) {
375 } else DLOG("not focusing, matched with restart_mode == true\n");
376 } else DLOG("workspace not visible, not focusing\n");
377 } else DLOG("dock, not focusing\n");
379 DLOG("fs = %p, ws = %p, not focusing\n", fs, ws);
380 /* Insert the new container in focus stack *after* the currently
381 * focused (fullscreen) con. This way, the new container will be
382 * focused after we return from fullscreen mode */
383 Con *first = TAILQ_FIRST(&(nc->parent->focus_head));
385 /* We only modify the focus stack if the container is not already
386 * the first one. This can happen when existing containers swallow
387 * new windows, for example when restarting. */
388 TAILQ_REMOVE(&(nc->parent->focus_head), nc, focused);
389 TAILQ_INSERT_AFTER(&(nc->parent->focus_head), first, nc, focused);
393 /* set floating if necessary */
394 bool want_floating = false;
395 if (xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_DIALOG) ||
396 xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_UTILITY) ||
397 xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_TOOLBAR) ||
398 xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_SPLASH)) {
399 LOG("This window is a dialog window, setting floating\n");
400 want_floating = true;
405 if (cwindow->transient_for != XCB_NONE ||
406 (cwindow->leader != XCB_NONE &&
407 cwindow->leader != cwindow->id &&
408 con_by_window_id(cwindow->leader) != NULL)) {
409 LOG("This window is transient for another window, setting floating\n");
410 want_floating = true;
412 if (config.popup_during_fullscreen == PDF_LEAVE_FULLSCREEN &&
414 LOG("There is a fullscreen window, leaving fullscreen mode\n");
415 con_toggle_fullscreen(fs, CF_OUTPUT);
416 } else if (config.popup_during_fullscreen == PDF_SMART &&
418 fs->window != NULL) {
419 i3Window *transient_win = cwindow;
420 while (transient_win != NULL &&
421 transient_win->transient_for != XCB_NONE) {
422 if (transient_win->transient_for == fs->window->id) {
423 LOG("This floating window belongs to the fullscreen window (popup_during_fullscreen == smart)\n");
427 Con *next_transient = con_by_window_id(transient_win->transient_for);
428 if (next_transient == NULL)
430 transient_win = next_transient->window;
435 /* dock clients cannot be floating, that makes no sense */
437 want_floating = false;
439 /* Store the requested geometry. The width/height gets raised to at least
440 * 75x50 when entering floating mode, which is the minimum size for a
441 * window to be useful (smaller windows are usually overlays/toolbars/…
442 * which are not managed by the wm anyways). We store the original geometry
443 * here because it’s used for dock clients. */
444 nc->geometry = (Rect){ geom->x, geom->y, geom->width, geom->height };
447 DLOG("geometry = %d x %d\n", nc->geometry.width, nc->geometry.height);
448 floating_enable(nc, true);
451 if (motif_border_style != BS_NORMAL) {
452 DLOG("MOTIF_WM_HINTS specifies decorations (border_style = %d)\n", motif_border_style);
453 con_set_border_style(nc, motif_border_style, config.default_border_width);
456 /* to avoid getting an UnmapNotify event due to reparenting, we temporarily
457 * declare no interest in any state change event of this window */
458 values[0] = XCB_NONE;
459 xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
461 xcb_void_cookie_t rcookie = xcb_reparent_window_checked(conn, window, nc->frame, 0, 0);
462 if (xcb_request_check(conn, rcookie) != NULL) {
463 LOG("Could not reparent the window, aborting\n");
467 values[0] = CHILD_EVENT_MASK & ~XCB_EVENT_MASK_ENTER_WINDOW;
468 xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
471 /* Put the client inside the save set. Upon termination (whether killed or
472 * normal exit does not matter) of the window manager, these clients will
473 * be correctly reparented to their most closest living ancestor (=
475 xcb_change_save_set(conn, XCB_SET_MODE_INSERT, window);
477 /* Check if any assignments match */
478 run_assignments(cwindow);
480 /* 'ws' may be invalid because of the assignments, e.g. when the user uses
481 * "move window to workspace 1", but had it assigned to workspace 2. */
482 ws = con_get_workspace(nc);
484 /* If this window was put onto an invisible workspace (via assignments), we
485 * render this workspace. It wouldn’t be rendered in our normal code path
486 * because only the visible workspaces get rendered.
488 * By rendering the workspace, we assign proper coordinates (read: not
489 * width=0, height=0) to the window, which is important for windows who
490 * actually use them to position their GUI elements, e.g. rhythmbox. */
491 if (ws && !workspace_is_visible(ws)) {
492 /* This is a bit hackish: we need to copy the content container’s rect
493 * to the workspace, because calling render_con() on the content
494 * container would also take the shortcut and not render the invisible
495 * workspace at all. However, just calling render_con() on the
496 * workspace isn’t enough either — it needs the rect. */
497 ws->rect = ws->parent->rect;
498 render_con(ws, true);
502 /* Send an event about window creation */
503 ipc_send_window_new_event(nc);
505 /* Windows might get managed with the urgency hint already set (Pidgin is
506 * known to do that), so check for that and handle the hint accordingly.
507 * This code needs to be in this part of manage_window() because the window
508 * needs to be on the final workspace first. */
509 con_set_urgency(nc, urgency_hint);