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 * 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;
96 geomc = xcb_get_geometry(conn, d);
98 /* Check if the window is mapped (it could be not mapped when intializing and
99 calling manage_window() for every window) */
100 if ((attr = xcb_get_window_attributes_reply(conn, cookie, 0)) == NULL) {
101 DLOG("Could not get attributes\n");
102 xcb_discard_reply(conn, geomc.sequence);
106 if (needs_to_be_mapped && attr->map_state != XCB_MAP_STATE_VIEWABLE) {
107 xcb_discard_reply(conn, geomc.sequence);
111 /* Don’t manage clients with the override_redirect flag */
112 if (attr->override_redirect) {
113 xcb_discard_reply(conn, geomc.sequence);
117 /* Check if the window is already managed */
118 if (con_by_window_id(window) != NULL) {
119 DLOG("already managed (by con %p)\n", con_by_window_id(window));
120 xcb_discard_reply(conn, geomc.sequence);
124 /* Get the initial geometry (position, size, …) */
125 if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL) {
126 DLOG("could not get geometry\n");
132 /* Set a temporary event mask for the new window, consisting only of
133 * PropertyChange and StructureNotify. We need to be notified of
134 * PropertyChanges because the client can change its properties *after* we
135 * requested them but *before* we actually reparented it and have set our
137 * We need StructureNotify because the client may unmap the window before
138 * we get to re-parent it.
139 * If this request fails, we assume the client has already unmapped the
140 * window between the MapRequest and our event mask change. */
141 values[0] = XCB_EVENT_MASK_PROPERTY_CHANGE |
142 XCB_EVENT_MASK_STRUCTURE_NOTIFY;
143 xcb_void_cookie_t event_mask_cookie =
144 xcb_change_window_attributes_checked(conn, window, XCB_CW_EVENT_MASK, values);
145 if (xcb_request_check(conn, event_mask_cookie) != NULL) {
146 LOG("Could not change event mask, the window probably already disappeared.\n");
150 #define GET_PROPERTY(atom, len) xcb_get_property(conn, false, window, atom, XCB_GET_PROPERTY_TYPE_ANY, 0, len)
152 wm_type_cookie = GET_PROPERTY(A__NET_WM_WINDOW_TYPE, UINT32_MAX);
153 strut_cookie = GET_PROPERTY(A__NET_WM_STRUT_PARTIAL, UINT32_MAX);
154 state_cookie = GET_PROPERTY(A__NET_WM_STATE, UINT32_MAX);
155 utf8_title_cookie = GET_PROPERTY(A__NET_WM_NAME, 128);
156 leader_cookie = GET_PROPERTY(A_WM_CLIENT_LEADER, UINT32_MAX);
157 transient_cookie = GET_PROPERTY(XCB_ATOM_WM_TRANSIENT_FOR, UINT32_MAX);
158 title_cookie = GET_PROPERTY(XCB_ATOM_WM_NAME, 128);
159 class_cookie = GET_PROPERTY(XCB_ATOM_WM_CLASS, 128);
160 role_cookie = GET_PROPERTY(A_WM_WINDOW_ROLE, 128);
161 startup_id_cookie = GET_PROPERTY(A__NET_STARTUP_ID, 512);
162 wm_hints_cookie = xcb_icccm_get_wm_hints(conn, window);
163 wm_normal_hints_cookie = xcb_icccm_get_wm_normal_hints(conn, window);
164 motif_wm_hints_cookie = GET_PROPERTY(A__MOTIF_WM_HINTS, 5 * sizeof(uint64_t));
166 DLOG("Managing window 0x%08x\n", window);
168 i3Window *cwindow = scalloc(sizeof(i3Window));
169 cwindow->id = window;
170 cwindow->depth = get_visual_depth(attr->visual);
172 /* We need to grab the mouse buttons for click to focus */
173 xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
174 XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
175 1 /* left mouse button */,
176 XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
178 xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
179 XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
180 2 /* middle mouse button */,
181 XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
183 xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
184 XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
185 3 /* right mouse button */,
186 XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
188 /* update as much information as possible so far (some replies may be NULL) */
189 window_update_class(cwindow, xcb_get_property_reply(conn, class_cookie, NULL), true);
190 window_update_name_legacy(cwindow, xcb_get_property_reply(conn, title_cookie, NULL), true);
191 window_update_name(cwindow, xcb_get_property_reply(conn, utf8_title_cookie, NULL), true);
192 window_update_leader(cwindow, xcb_get_property_reply(conn, leader_cookie, NULL));
193 window_update_transient_for(cwindow, xcb_get_property_reply(conn, transient_cookie, NULL));
194 window_update_strut_partial(cwindow, xcb_get_property_reply(conn, strut_cookie, NULL));
195 window_update_role(cwindow, xcb_get_property_reply(conn, role_cookie, NULL), true);
197 window_update_hints(cwindow, xcb_get_property_reply(conn, wm_hints_cookie, NULL), &urgency_hint);
198 border_style_t motif_border_style = BS_NORMAL;
199 window_update_motif_hints(cwindow, xcb_get_property_reply(conn, motif_wm_hints_cookie, NULL), &motif_border_style);
200 xcb_size_hints_t wm_size_hints;
201 if (!xcb_icccm_get_wm_size_hints_reply(conn, wm_normal_hints_cookie, &wm_size_hints, NULL))
202 memset(&wm_size_hints, '\0', sizeof(xcb_size_hints_t));
203 xcb_get_property_reply_t *type_reply = xcb_get_property_reply(conn, wm_type_cookie, NULL);
204 xcb_get_property_reply_t *state_reply = xcb_get_property_reply(conn, state_cookie, NULL);
206 xcb_get_property_reply_t *startup_id_reply;
207 startup_id_reply = xcb_get_property_reply(conn, startup_id_cookie, NULL);
208 char *startup_ws = startup_workspace_for_window(cwindow, startup_id_reply);
209 DLOG("startup workspace = %s\n", startup_ws);
211 /* check if the window needs WM_TAKE_FOCUS */
212 cwindow->needs_take_focus = window_supports_protocol(cwindow->id, A_WM_TAKE_FOCUS);
214 /* Where to start searching for a container that swallows the new one? */
215 Con *search_at = croot;
217 if (xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_DOCK)) {
218 LOG("This window is of type dock\n");
219 Output *output = get_output_containing(geom->x, geom->y);
220 if (output != NULL) {
221 DLOG("Starting search at output %s\n", output->name);
222 search_at = output->con;
225 /* find out the desired position of this dock window */
226 if (cwindow->reserved.top > 0 && cwindow->reserved.bottom == 0) {
227 DLOG("Top dock client\n");
228 cwindow->dock = W_DOCK_TOP;
229 } else if (cwindow->reserved.top == 0 && cwindow->reserved.bottom > 0) {
230 DLOG("Bottom dock client\n");
231 cwindow->dock = W_DOCK_BOTTOM;
233 DLOG("Ignoring invalid reserved edges (_NET_WM_STRUT_PARTIAL), using position as fallback:\n");
234 if (geom->y < (int16_t)(search_at->rect.height / 2)) {
235 DLOG("geom->y = %d < rect.height / 2 = %d, it is a top dock client\n",
236 geom->y, (search_at->rect.height / 2));
237 cwindow->dock = W_DOCK_TOP;
239 DLOG("geom->y = %d >= rect.height / 2 = %d, it is a bottom dock client\n",
240 geom->y, (search_at->rect.height / 2));
241 cwindow->dock = W_DOCK_BOTTOM;
246 DLOG("Initial geometry: (%d, %d, %d, %d)\n", geom->x, geom->y, geom->width, geom->height);
250 Assignment *assignment;
252 /* TODO: two matches for one container */
254 /* See if any container swallows this new window */
255 nc = con_for_window(search_at, cwindow, &match);
257 /* If not, check if it is assigned to a specific workspace / output */
258 if ((assignment = assignment_for(cwindow, A_TO_WORKSPACE | A_TO_OUTPUT))) {
259 DLOG("Assignment matches (%p)\n", match);
260 if (assignment->type == A_TO_WORKSPACE) {
261 Con *assigned_ws = workspace_get(assignment->dest.workspace, NULL);
262 nc = con_descend_tiling_focused(assigned_ws);
263 DLOG("focused on ws %s: %p / %s\n", assigned_ws->name, nc, nc->name);
264 if (nc->type == CT_WORKSPACE)
265 nc = tree_open_con(nc, cwindow);
267 nc = tree_open_con(nc->parent, cwindow);
269 /* set the urgency hint on the window if the workspace is not visible */
270 if (!workspace_is_visible(assigned_ws))
273 /* TODO: handle assignments with type == A_TO_OUTPUT */
274 } else if (startup_ws) {
275 /* If it’s not assigned, but was started on a specific workspace,
276 * we want to open it there */
277 DLOG("Using workspace on which this application was started (%s)\n", startup_ws);
278 nc = con_descend_tiling_focused(workspace_get(startup_ws, NULL));
279 DLOG("focused on ws %s: %p / %s\n", startup_ws, nc, nc->name);
280 if (nc->type == CT_WORKSPACE)
281 nc = tree_open_con(nc, cwindow);
282 else nc = tree_open_con(nc->parent, cwindow);
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);
289 } else nc = tree_open_con(NULL, cwindow);
292 /* M_BELOW inserts the new window as a child of the one which was
293 * matched (e.g. dock areas) */
294 if (match != NULL && match->insert_where == M_BELOW) {
295 nc = tree_open_con(nc, cwindow);
298 /* If M_BELOW is not used, the container is replaced. This happens with
299 * "swallows" criteria that are used for stored layouts, in which case
300 * we need to remove that criterion, because they should only be valid
302 if (match != NULL && match->insert_where != M_BELOW) {
303 DLOG("Removing match %p from container %p\n", match, nc);
304 TAILQ_REMOVE(&(nc->swallow_head), match, matches);
308 DLOG("new container = %p\n", nc);
309 if (nc->window != NULL && nc->window != cwindow) {
310 if (!restore_kill_placeholder(nc->window->id)) {
311 DLOG("Uh?! Container without a placeholder, but with a window, has swallowed this to-be-managed window?!\n");
314 nc->window = cwindow;
317 nc->border_width = geom->border_width;
320 sasprintf(&name, "[i3 con] container around %p", cwindow);
321 x_set_name(nc, name);
324 /* handle fullscreen containers */
325 Con *ws = con_get_workspace(nc);
326 Con *fs = (ws ? con_get_fullscreen_con(ws, CF_OUTPUT) : NULL);
328 fs = con_get_fullscreen_con(croot, CF_GLOBAL);
330 if (xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_FULLSCREEN)) {
332 con_toggle_fullscreen(nc, CF_OUTPUT);
335 bool set_focus = false;
338 DLOG("Not in fullscreen mode, focusing\n");
339 if (!cwindow->dock) {
340 /* Check that the workspace is visible and on the same output as
341 * the current focused container. If the window was assigned to an
342 * invisible workspace, we should not steal focus. */
343 Con *current_output = con_get_output(focused);
344 Con *target_output = con_get_output(ws);
346 if (workspace_is_visible(ws) && current_output == target_output) {
347 if (!match || !match->restart_mode) {
349 } else DLOG("not focusing, matched with restart_mode == true\n");
350 } else DLOG("workspace not visible, not focusing\n");
351 } else DLOG("dock, not focusing\n");
353 DLOG("fs = %p, ws = %p, not focusing\n", fs, ws);
354 /* Insert the new container in focus stack *after* the currently
355 * focused (fullscreen) con. This way, the new container will be
356 * focused after we return from fullscreen mode */
357 Con *first = TAILQ_FIRST(&(nc->parent->focus_head));
359 /* We only modify the focus stack if the container is not already
360 * the first one. This can happen when existing containers swallow
361 * new windows, for example when restarting. */
362 TAILQ_REMOVE(&(nc->parent->focus_head), nc, focused);
363 TAILQ_INSERT_AFTER(&(nc->parent->focus_head), first, nc, focused);
367 /* set floating if necessary */
368 bool want_floating = false;
369 if (xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_DIALOG) ||
370 xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_UTILITY) ||
371 xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_TOOLBAR) ||
372 xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_SPLASH) ||
373 xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_MODAL) ||
374 (wm_size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MAX_SIZE &&
375 wm_size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MIN_SIZE &&
376 wm_size_hints.min_height == wm_size_hints.max_height &&
377 wm_size_hints.min_width == wm_size_hints.max_width)) {
378 LOG("This window is a dialog window, setting floating\n");
379 want_floating = true;
385 if (cwindow->transient_for != XCB_NONE ||
386 (cwindow->leader != XCB_NONE &&
387 cwindow->leader != cwindow->id &&
388 con_by_window_id(cwindow->leader) != NULL)) {
389 LOG("This window is transient for another window, setting floating\n");
390 want_floating = true;
392 if (config.popup_during_fullscreen == PDF_LEAVE_FULLSCREEN &&
394 LOG("There is a fullscreen window, leaving fullscreen mode\n");
395 con_toggle_fullscreen(fs, CF_OUTPUT);
396 } else if (config.popup_during_fullscreen == PDF_SMART &&
398 fs->window != NULL) {
399 i3Window *transient_win = cwindow;
400 while (transient_win != NULL &&
401 transient_win->transient_for != XCB_NONE) {
402 if (transient_win->transient_for == fs->window->id) {
403 LOG("This floating window belongs to the fullscreen window (popup_during_fullscreen == smart)\n");
407 Con *next_transient = con_by_window_id(transient_win->transient_for);
408 if (next_transient == NULL)
410 transient_win = next_transient->window;
415 /* dock clients cannot be floating, that makes no sense */
417 want_floating = false;
419 /* Store the requested geometry. The width/height gets raised to at least
420 * 75x50 when entering floating mode, which is the minimum size for a
421 * window to be useful (smaller windows are usually overlays/toolbars/…
422 * which are not managed by the wm anyways). We store the original geometry
423 * here because it’s used for dock clients. */
424 nc->geometry = (Rect){ geom->x, geom->y, geom->width, geom->height };
427 DLOG("geometry = %d x %d\n", nc->geometry.width, nc->geometry.height);
428 floating_enable(nc, true);
431 if (motif_border_style != BS_NORMAL) {
432 DLOG("MOTIF_WM_HINTS specifies decorations (border_style = %d)\n", motif_border_style);
433 con_set_border_style(nc, motif_border_style, config.default_border_width);
436 /* to avoid getting an UnmapNotify event due to reparenting, we temporarily
437 * declare no interest in any state change event of this window */
438 values[0] = XCB_NONE;
439 xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
441 xcb_void_cookie_t rcookie = xcb_reparent_window_checked(conn, window, nc->frame, 0, 0);
442 if (xcb_request_check(conn, rcookie) != NULL) {
443 LOG("Could not reparent the window, aborting\n");
447 values[0] = CHILD_EVENT_MASK & ~XCB_EVENT_MASK_ENTER_WINDOW;
448 xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
451 /* Put the client inside the save set. Upon termination (whether killed or
452 * normal exit does not matter) of the window manager, these clients will
453 * be correctly reparented to their most closest living ancestor (=
455 xcb_change_save_set(conn, XCB_SET_MODE_INSERT, window);
457 /* Check if any assignments match */
458 run_assignments(cwindow);
460 /* 'ws' may be invalid because of the assignments, e.g. when the user uses
461 * "move window to workspace 1", but had it assigned to workspace 2. */
462 ws = con_get_workspace(nc);
464 /* If this window was put onto an invisible workspace (via assignments), we
465 * render this workspace. It wouldn’t be rendered in our normal code path
466 * because only the visible workspaces get rendered.
468 * By rendering the workspace, we assign proper coordinates (read: not
469 * width=0, height=0) to the window, which is important for windows who
470 * actually use them to position their GUI elements, e.g. rhythmbox. */
471 if (ws && !workspace_is_visible(ws)) {
472 /* This is a bit hackish: we need to copy the content container’s rect
473 * to the workspace, because calling render_con() on the content
474 * container would also take the shortcut and not render the invisible
475 * workspace at all. However, just calling render_con() on the
476 * workspace isn’t enough either — it needs the rect. */
477 ws->rect = ws->parent->rect;
478 render_con(ws, true);
482 /* Send an event about window creation */
483 ipc_send_window_event("new", nc);
485 /* Defer setting focus after the 'new' event has been sent to ensure the
486 * proper window event sequence. */
492 /* Windows might get managed with the urgency hint already set (Pidgin is
493 * known to do that), so check for that and handle the hint accordingly.
494 * This code needs to be in this part of manage_window() because the window
495 * needs to be on the final workspace first. */
496 con_set_urgency(nc, urgency_hint);