i3
manage.c
Go to the documentation of this file.
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-2012 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 
14 /*
15  * Go through all existing windows (if the window manager is restarted) and manage them
16  *
17  */
18 void manage_existing_windows(xcb_window_t root) {
19  xcb_query_tree_reply_t *reply;
20  int i, len;
21  xcb_window_t *children;
22  xcb_get_window_attributes_cookie_t *cookies;
23 
24  /* Get the tree of windows whose parent is the root window (= all) */
25  if ((reply = xcb_query_tree_reply(conn, xcb_query_tree(conn, root), 0)) == NULL)
26  return;
27 
28  len = xcb_query_tree_children_length(reply);
29  cookies = smalloc(len * sizeof(*cookies));
30 
31  /* Request the window attributes for every window */
32  children = xcb_query_tree_children(reply);
33  for (i = 0; i < len; ++i)
34  cookies[i] = xcb_get_window_attributes(conn, children[i]);
35 
36  /* Call manage_window with the attributes for every window */
37  for (i = 0; i < len; ++i)
38  manage_window(children[i], cookies[i], true);
39 
40  free(reply);
41  free(cookies);
42 }
43 
44 /*
45  * Restores the geometry of each window by reparenting it to the root window
46  * at the position of its frame.
47  *
48  * This is to be called *only* before exiting/restarting i3 because of evil
49  * side-effects which are to be expected when continuing to run i3.
50  *
51  */
52 void restore_geometry(void) {
53  DLOG("Restoring geometry\n");
54 
55  Con *con;
57  if (con->window) {
58  DLOG("Re-adding X11 border of %d px\n", con->border_width);
59  con->window_rect.width += (2 * con->border_width);
60  con->window_rect.height += (2 * con->border_width);
62  DLOG("placing window %08x at %d %d\n", con->window->id, con->rect.x, con->rect.y);
63  xcb_reparent_window(conn, con->window->id, root,
64  con->rect.x, con->rect.y);
65  }
66 
67  /* Make sure our changes reach the X server, we restart/exit now */
68  xcb_flush(conn);
69 }
70 
71 /*
72  * Do some sanity checks and then reparent the window.
73  *
74  */
75 void manage_window(xcb_window_t window, xcb_get_window_attributes_cookie_t cookie,
76  bool needs_to_be_mapped) {
77  xcb_drawable_t d = { window };
78  xcb_get_geometry_cookie_t geomc;
79  xcb_get_geometry_reply_t *geom;
80  xcb_get_window_attributes_reply_t *attr = NULL;
81 
82  xcb_get_property_cookie_t wm_type_cookie, strut_cookie, state_cookie,
83  utf8_title_cookie, title_cookie,
84  class_cookie, leader_cookie, transient_cookie,
85  role_cookie, startup_id_cookie, wm_hints_cookie;
86 
87 
88  geomc = xcb_get_geometry(conn, d);
89 #define FREE_GEOMETRY() do { \
90  if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) != NULL) \
91  free(geom); \
92 } while (0)
93 
94  /* Check if the window is mapped (it could be not mapped when intializing and
95  calling manage_window() for every window) */
96  if ((attr = xcb_get_window_attributes_reply(conn, cookie, 0)) == NULL) {
97  DLOG("Could not get attributes\n");
98  FREE_GEOMETRY();
99  return;
100  }
101 
102  if (needs_to_be_mapped && attr->map_state != XCB_MAP_STATE_VIEWABLE) {
103  FREE_GEOMETRY();
104  goto out;
105  }
106 
107  /* Don’t manage clients with the override_redirect flag */
108  if (attr->override_redirect) {
109  FREE_GEOMETRY();
110  goto out;
111  }
112 
113  /* Check if the window is already managed */
114  if (con_by_window_id(window) != NULL) {
115  DLOG("already managed (by con %p)\n", con_by_window_id(window));
116  FREE_GEOMETRY();
117  goto out;
118  }
119 
120  /* Get the initial geometry (position, size, …) */
121  if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL) {
122  DLOG("could not get geometry\n");
123  goto out;
124  }
125 
126  uint32_t values[1];
127 
128  /* Set a temporary event mask for the new window, consisting only of
129  * PropertyChange and StructureNotify. We need to be notified of
130  * PropertyChanges because the client can change its properties *after* we
131  * requested them but *before* we actually reparented it and have set our
132  * final event mask.
133  * We need StructureNotify because the client may unmap the window before
134  * we get to re-parent it.
135  * If this request fails, we assume the client has already unmapped the
136  * window between the MapRequest and our event mask change. */
137  values[0] = XCB_EVENT_MASK_PROPERTY_CHANGE |
138  XCB_EVENT_MASK_STRUCTURE_NOTIFY;
139  xcb_void_cookie_t event_mask_cookie =
140  xcb_change_window_attributes_checked(conn, window, XCB_CW_EVENT_MASK, values);
141  if (xcb_request_check(conn, event_mask_cookie) != NULL) {
142  LOG("Could not change event mask, the window probably already disappeared.\n");
143  goto out;
144  }
145 
146 #define GET_PROPERTY(atom, len) xcb_get_property(conn, false, window, atom, XCB_GET_PROPERTY_TYPE_ANY, 0, len)
147 
148  wm_type_cookie = GET_PROPERTY(A__NET_WM_WINDOW_TYPE, UINT32_MAX);
149  strut_cookie = GET_PROPERTY(A__NET_WM_STRUT_PARTIAL, UINT32_MAX);
150  state_cookie = GET_PROPERTY(A__NET_WM_STATE, UINT32_MAX);
151  utf8_title_cookie = GET_PROPERTY(A__NET_WM_NAME, 128);
152  leader_cookie = GET_PROPERTY(A_WM_CLIENT_LEADER, UINT32_MAX);
154  title_cookie = GET_PROPERTY(XCB_ATOM_WM_NAME, 128);
155  class_cookie = GET_PROPERTY(XCB_ATOM_WM_CLASS, 128);
156  role_cookie = GET_PROPERTY(A_WM_WINDOW_ROLE, 128);
157  startup_id_cookie = GET_PROPERTY(A__NET_STARTUP_ID, 512);
158  wm_hints_cookie = xcb_icccm_get_wm_hints(conn, window);
159  /* TODO: also get wm_normal_hints here. implement after we got rid of xcb-event */
160 
161  DLOG("Managing window 0x%08x\n", window);
162 
163  i3Window *cwindow = scalloc(sizeof(i3Window));
164  cwindow->id = window;
165  cwindow->depth = get_visual_depth(attr->visual);
166 
167  /* We need to grab the mouse buttons for click to focus */
168  xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
169  XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
170  1 /* left mouse button */,
171  XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
172 
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  2 /* middle mouse button */,
176  XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
177 
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  3 /* right mouse button */,
181  XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
182 
183  /* update as much information as possible so far (some replies may be NULL) */
184  window_update_class(cwindow, xcb_get_property_reply(conn, class_cookie, NULL), true);
185  window_update_name_legacy(cwindow, xcb_get_property_reply(conn, title_cookie, NULL), true);
186  window_update_name(cwindow, xcb_get_property_reply(conn, utf8_title_cookie, NULL), true);
187  window_update_leader(cwindow, xcb_get_property_reply(conn, leader_cookie, NULL));
188  window_update_transient_for(cwindow, xcb_get_property_reply(conn, transient_cookie, NULL));
189  window_update_strut_partial(cwindow, xcb_get_property_reply(conn, strut_cookie, NULL));
190  window_update_role(cwindow, xcb_get_property_reply(conn, role_cookie, NULL), true);
191  window_update_hints(cwindow, xcb_get_property_reply(conn, wm_hints_cookie, NULL));
192 
193  xcb_get_property_reply_t *startup_id_reply;
194  startup_id_reply = xcb_get_property_reply(conn, startup_id_cookie, NULL);
195  char *startup_ws = startup_workspace_for_window(cwindow, startup_id_reply);
196  DLOG("startup workspace = %s\n", startup_ws);
197 
198  /* check if the window needs WM_TAKE_FOCUS */
199  cwindow->needs_take_focus = window_supports_protocol(cwindow->id, A_WM_TAKE_FOCUS);
200 
201  /* Where to start searching for a container that swallows the new one? */
202  Con *search_at = croot;
203 
204  xcb_get_property_reply_t *reply = xcb_get_property_reply(conn, wm_type_cookie, NULL);
205  if (xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_DOCK)) {
206  LOG("This window is of type dock\n");
207  Output *output = get_output_containing(geom->x, geom->y);
208  if (output != NULL) {
209  DLOG("Starting search at output %s\n", output->name);
210  search_at = output->con;
211  }
212 
213  /* find out the desired position of this dock window */
214  if (cwindow->reserved.top > 0 && cwindow->reserved.bottom == 0) {
215  DLOG("Top dock client\n");
216  cwindow->dock = W_DOCK_TOP;
217  } else if (cwindow->reserved.top == 0 && cwindow->reserved.bottom > 0) {
218  DLOG("Bottom dock client\n");
219  cwindow->dock = W_DOCK_BOTTOM;
220  } else {
221  DLOG("Ignoring invalid reserved edges (_NET_WM_STRUT_PARTIAL), using position as fallback:\n");
222  if (geom->y < (search_at->rect.height / 2)) {
223  DLOG("geom->y = %d < rect.height / 2 = %d, it is a top dock client\n",
224  geom->y, (search_at->rect.height / 2));
225  cwindow->dock = W_DOCK_TOP;
226  } else {
227  DLOG("geom->y = %d >= rect.height / 2 = %d, it is a bottom dock client\n",
228  geom->y, (search_at->rect.height / 2));
229  cwindow->dock = W_DOCK_BOTTOM;
230  }
231  }
232  }
233 
234  DLOG("Initial geometry: (%d, %d, %d, %d)\n", geom->x, geom->y, geom->width, geom->height);
235 
236  Con *nc = NULL;
237  Match *match = NULL;
238  Assignment *assignment;
239 
240  /* TODO: two matches for one container */
241 
242  /* See if any container swallows this new window */
243  nc = con_for_window(search_at, cwindow, &match);
244  if (nc == NULL) {
245  /* If not, check if it is assigned to a specific workspace / output */
246  if ((assignment = assignment_for(cwindow, A_TO_WORKSPACE | A_TO_OUTPUT))) {
247  DLOG("Assignment matches (%p)\n", match);
248  if (assignment->type == A_TO_WORKSPACE) {
249  nc = con_descend_tiling_focused(workspace_get(assignment->dest.workspace, NULL));
250  DLOG("focused on ws %s: %p / %s\n", assignment->dest.workspace, nc, nc->name);
251  if (nc->type == CT_WORKSPACE)
252  nc = tree_open_con(nc, cwindow);
253  else nc = tree_open_con(nc->parent, cwindow);
254  }
255  /* TODO: handle assignments with type == A_TO_OUTPUT */
256  } else if (startup_ws) {
257  /* If it’s not assigned, but was started on a specific workspace,
258  * we want to open it there */
259  DLOG("Using workspace on which this application was started (%s)\n", startup_ws);
260  nc = con_descend_tiling_focused(workspace_get(startup_ws, NULL));
261  DLOG("focused on ws %s: %p / %s\n", startup_ws, nc, nc->name);
262  if (nc->type == CT_WORKSPACE)
263  nc = tree_open_con(nc, cwindow);
264  else nc = tree_open_con(nc->parent, cwindow);
265  } else {
266  /* If not, insert it at the currently focused position */
267  if (focused->type == CT_CON && con_accepts_window(focused)) {
268  LOG("using current container, focused = %p, focused->name = %s\n",
269  focused, focused->name);
270  nc = focused;
271  } else nc = tree_open_con(NULL, cwindow);
272  }
273  } else {
274  /* M_BELOW inserts the new window as a child of the one which was
275  * matched (e.g. dock areas) */
276  if (match != NULL && match->insert_where == M_BELOW) {
277  nc = tree_open_con(nc, cwindow);
278  }
279  }
280 
281  DLOG("new container = %p\n", nc);
282  nc->window = cwindow;
283  x_reinit(nc);
284 
285  nc->border_width = geom->border_width;
286 
287  char *name;
288  sasprintf(&name, "[i3 con] container around %p", cwindow);
289  x_set_name(nc, name);
290  free(name);
291 
292  Con *ws = con_get_workspace(nc);
293  Con *fs = (ws ? con_get_fullscreen_con(ws, CF_OUTPUT) : NULL);
294  if (fs == NULL)
295  fs = con_get_fullscreen_con(croot, CF_GLOBAL);
296 
297  if (fs == NULL) {
298  DLOG("Not in fullscreen mode, focusing\n");
299  if (!cwindow->dock) {
300  /* Check that the workspace is visible and on the same output as
301  * the current focused container. If the window was assigned to an
302  * invisible workspace, we should not steal focus. */
303  Con *current_output = con_get_output(focused);
304  Con *target_output = con_get_output(ws);
305 
306  if (workspace_is_visible(ws) && current_output == target_output) {
307  if (!match || !match->restart_mode) {
308  con_focus(nc);
309  } else DLOG("not focusing, matched with restart_mode == true\n");
310  } else DLOG("workspace not visible, not focusing\n");
311  } else DLOG("dock, not focusing\n");
312  } else {
313  DLOG("fs = %p, ws = %p, not focusing\n", fs, ws);
314  /* Insert the new container in focus stack *after* the currently
315  * focused (fullscreen) con. This way, the new container will be
316  * focused after we return from fullscreen mode */
317  Con *first = TAILQ_FIRST(&(nc->parent->focus_head));
318  if (first != nc) {
319  /* We only modify the focus stack if the container is not already
320  * the first one. This can happen when existing containers swallow
321  * new windows, for example when restarting. */
322  TAILQ_REMOVE(&(nc->parent->focus_head), nc, focused);
323  TAILQ_INSERT_AFTER(&(nc->parent->focus_head), first, nc, focused);
324  }
325  }
326 
327  /* set floating if necessary */
328  bool want_floating = false;
329  if (xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_DIALOG) ||
330  xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_UTILITY) ||
331  xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_TOOLBAR) ||
332  xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_SPLASH)) {
333  LOG("This window is a dialog window, setting floating\n");
334  want_floating = true;
335  }
336 
337  FREE(reply);
338 
339  if (cwindow->transient_for != XCB_NONE ||
340  (cwindow->leader != XCB_NONE &&
341  cwindow->leader != cwindow->id &&
342  con_by_window_id(cwindow->leader) != NULL)) {
343  LOG("This window is transient for another window, setting floating\n");
344  want_floating = true;
345 
346  if (config.popup_during_fullscreen == PDF_LEAVE_FULLSCREEN &&
347  fs != NULL) {
348  LOG("There is a fullscreen window, leaving fullscreen mode\n");
349  con_toggle_fullscreen(fs, CF_OUTPUT);
350  } else if (config.popup_during_fullscreen == PDF_SMART &&
351  fs != NULL &&
352  fs->window != NULL &&
353  fs->window->id == cwindow->transient_for) {
354  LOG("This floating window belongs to the fullscreen window (popup_during_fullscreen == smart)\n");
355  con_focus(nc);
356  }
357  }
358 
359  /* dock clients cannot be floating, that makes no sense */
360  if (cwindow->dock)
361  want_floating = false;
362 
363  /* Store the requested geometry. The width/height gets raised to at least
364  * 75x50 when entering floating mode, which is the minimum size for a
365  * window to be useful (smaller windows are usually overlays/toolbars/…
366  * which are not managed by the wm anyways). We store the original geometry
367  * here because it’s used for dock clients. */
368  nc->geometry = (Rect){ geom->x, geom->y, geom->width, geom->height };
369 
370  if (want_floating) {
371  DLOG("geometry = %d x %d\n", nc->geometry.width, nc->geometry.height);
372  floating_enable(nc, true);
373  }
374 
375  /* to avoid getting an UnmapNotify event due to reparenting, we temporarily
376  * declare no interest in any state change event of this window */
377  values[0] = XCB_NONE;
378  xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
379 
380  xcb_void_cookie_t rcookie = xcb_reparent_window_checked(conn, window, nc->frame, 0, 0);
381  if (xcb_request_check(conn, rcookie) != NULL) {
382  LOG("Could not reparent the window, aborting\n");
383  goto geom_out;
384  }
385 
386  values[0] = CHILD_EVENT_MASK & ~XCB_EVENT_MASK_ENTER_WINDOW;
387  xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
388  xcb_flush(conn);
389 
390  reply = xcb_get_property_reply(conn, state_cookie, NULL);
391  if (xcb_reply_contains_atom(reply, A__NET_WM_STATE_FULLSCREEN))
392  con_toggle_fullscreen(nc, CF_OUTPUT);
393 
394  FREE(reply);
395 
396  /* Put the client inside the save set. Upon termination (whether killed or
397  * normal exit does not matter) of the window manager, these clients will
398  * be correctly reparented to their most closest living ancestor (=
399  * cleanup) */
400  xcb_change_save_set(conn, XCB_SET_MODE_INSERT, window);
401 
402  /* Check if any assignments match */
403  run_assignments(cwindow);
404 
405  /* If this window was put onto an invisible workspace (via assignments), we
406  * render this workspace. It wouldn’t be rendered in our normal code path
407  * because only the visible workspaces get rendered.
408  *
409  * By rendering the workspace, we assign proper coordinates (read: not
410  * width=0, height=0) to the window, which is important for windows who
411  * actually use them to position their GUI elements, e.g. rhythmbox. */
412  if (ws && !workspace_is_visible(ws)) {
413  /* This is a bit hackish: we need to copy the content container’s rect
414  * to the workspace, because calling render_con() on the content
415  * container would also take the shortcut and not render the invisible
416  * workspace at all. However, just calling render_con() on the
417  * workspace isn’t enough either — it needs the rect. */
418  ws->rect = ws->parent->rect;
419  render_con(ws, true);
420  }
421  tree_render();
422 
423 geom_out:
424  free(geom);
425 out:
426  free(attr);
427  return;
428 }