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-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;
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);
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  * 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.
82  *
83  */
84 static void ipc_send_window_new_event(Con *con) {
85  setlocale(LC_NUMERIC, "C");
86  yajl_gen gen = ygenalloc();
87 
88  y(map_open);
89 
90  ystr("change");
91  ystr("new");
92 
93  ystr("container");
94  dump_node(gen, con, false);
95 
96  y(map_close);
97 
98  const unsigned char *payload;
99  ylength length;
100  y(get_buf, &payload, &length);
101 
102  ipc_send_event("window", I3_IPC_EVENT_WINDOW, (const char *)payload);
103  y(free);
104  setlocale(LC_NUMERIC, "");
105 }
106 
107 /*
108  * Do some sanity checks and then reparent the window.
109  *
110  */
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;
117 
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 
123 
124  geomc = xcb_get_geometry(conn, d);
125 
126  /* Check if the window is mapped (it could be not mapped when intializing and
127  calling manage_window() for every window) */
128  if ((attr = xcb_get_window_attributes_reply(conn, cookie, 0)) == NULL) {
129  DLOG("Could not get attributes\n");
130  xcb_discard_reply(conn, geomc.sequence);
131  return;
132  }
133 
134  if (needs_to_be_mapped && attr->map_state != XCB_MAP_STATE_VIEWABLE) {
135  xcb_discard_reply(conn, geomc.sequence);
136  goto out;
137  }
138 
139  /* Don’t manage clients with the override_redirect flag */
140  if (attr->override_redirect) {
141  xcb_discard_reply(conn, geomc.sequence);
142  goto out;
143  }
144 
145  /* Check if the window is already managed */
146  if (con_by_window_id(window) != NULL) {
147  DLOG("already managed (by con %p)\n", con_by_window_id(window));
148  xcb_discard_reply(conn, geomc.sequence);
149  goto out;
150  }
151 
152  /* Get the initial geometry (position, size, …) */
153  if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL) {
154  DLOG("could not get geometry\n");
155  goto out;
156  }
157 
158  uint32_t values[1];
159 
160  /* Set a temporary event mask for the new window, consisting only of
161  * PropertyChange and StructureNotify. We need to be notified of
162  * PropertyChanges because the client can change its properties *after* we
163  * requested them but *before* we actually reparented it and have set our
164  * final event mask.
165  * We need StructureNotify because the client may unmap the window before
166  * we get to re-parent it.
167  * If this request fails, we assume the client has already unmapped the
168  * window between the MapRequest and our event mask change. */
169  values[0] = XCB_EVENT_MASK_PROPERTY_CHANGE |
170  XCB_EVENT_MASK_STRUCTURE_NOTIFY;
171  xcb_void_cookie_t event_mask_cookie =
172  xcb_change_window_attributes_checked(conn, window, XCB_CW_EVENT_MASK, values);
173  if (xcb_request_check(conn, event_mask_cookie) != NULL) {
174  LOG("Could not change event mask, the window probably already disappeared.\n");
175  goto out;
176  }
177 
178 #define GET_PROPERTY(atom, len) xcb_get_property(conn, false, window, atom, XCB_GET_PROPERTY_TYPE_ANY, 0, len)
179 
180  wm_type_cookie = GET_PROPERTY(A__NET_WM_WINDOW_TYPE, UINT32_MAX);
181  strut_cookie = GET_PROPERTY(A__NET_WM_STRUT_PARTIAL, UINT32_MAX);
182  state_cookie = GET_PROPERTY(A__NET_WM_STATE, UINT32_MAX);
183  utf8_title_cookie = GET_PROPERTY(A__NET_WM_NAME, 128);
184  leader_cookie = GET_PROPERTY(A_WM_CLIENT_LEADER, UINT32_MAX);
185  transient_cookie = GET_PROPERTY(XCB_ATOM_WM_TRANSIENT_FOR, UINT32_MAX);
186  title_cookie = GET_PROPERTY(XCB_ATOM_WM_NAME, 128);
187  class_cookie = GET_PROPERTY(XCB_ATOM_WM_CLASS, 128);
188  role_cookie = GET_PROPERTY(A_WM_WINDOW_ROLE, 128);
189  startup_id_cookie = GET_PROPERTY(A__NET_STARTUP_ID, 512);
190  wm_hints_cookie = xcb_icccm_get_wm_hints(conn, window);
191  /* TODO: also get wm_normal_hints here. implement after we got rid of xcb-event */
192 
193  DLOG("Managing window 0x%08x\n", window);
194 
195  i3Window *cwindow = scalloc(sizeof(i3Window));
196  cwindow->id = window;
197  cwindow->depth = get_visual_depth(attr->visual);
198 
199  /* We need to grab the mouse buttons for click to focus */
200  xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
201  XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
202  1 /* left mouse button */,
203  XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
204 
205  xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
206  XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
207  2 /* middle mouse button */,
208  XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
209 
210  xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS,
211  XCB_GRAB_MODE_SYNC, XCB_GRAB_MODE_ASYNC, root, XCB_NONE,
212  3 /* right mouse button */,
213  XCB_BUTTON_MASK_ANY /* don’t filter for any modifiers */);
214 
215  /* update as much information as possible so far (some replies may be NULL) */
216  window_update_class(cwindow, xcb_get_property_reply(conn, class_cookie, NULL), true);
217  window_update_name_legacy(cwindow, xcb_get_property_reply(conn, title_cookie, NULL), true);
218  window_update_name(cwindow, xcb_get_property_reply(conn, utf8_title_cookie, NULL), true);
219  window_update_leader(cwindow, xcb_get_property_reply(conn, leader_cookie, NULL));
220  window_update_transient_for(cwindow, xcb_get_property_reply(conn, transient_cookie, NULL));
221  window_update_strut_partial(cwindow, xcb_get_property_reply(conn, strut_cookie, NULL));
222  window_update_role(cwindow, xcb_get_property_reply(conn, role_cookie, NULL), true);
223  bool urgency_hint;
224  window_update_hints(cwindow, xcb_get_property_reply(conn, wm_hints_cookie, NULL), &urgency_hint);
225 
226  xcb_get_property_reply_t *startup_id_reply;
227  startup_id_reply = xcb_get_property_reply(conn, startup_id_cookie, NULL);
228  char *startup_ws = startup_workspace_for_window(cwindow, startup_id_reply);
229  DLOG("startup workspace = %s\n", startup_ws);
230 
231  /* check if the window needs WM_TAKE_FOCUS */
232  cwindow->needs_take_focus = window_supports_protocol(cwindow->id, A_WM_TAKE_FOCUS);
233 
234  /* Where to start searching for a container that swallows the new one? */
235  Con *search_at = croot;
236 
237  xcb_get_property_reply_t *reply = xcb_get_property_reply(conn, wm_type_cookie, NULL);
238  if (xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_DOCK)) {
239  LOG("This window is of type dock\n");
240  Output *output = get_output_containing(geom->x, geom->y);
241  if (output != NULL) {
242  DLOG("Starting search at output %s\n", output->name);
243  search_at = output->con;
244  }
245 
246  /* find out the desired position of this dock window */
247  if (cwindow->reserved.top > 0 && cwindow->reserved.bottom == 0) {
248  DLOG("Top dock client\n");
249  cwindow->dock = W_DOCK_TOP;
250  } else if (cwindow->reserved.top == 0 && cwindow->reserved.bottom > 0) {
251  DLOG("Bottom dock client\n");
252  cwindow->dock = W_DOCK_BOTTOM;
253  } else {
254  DLOG("Ignoring invalid reserved edges (_NET_WM_STRUT_PARTIAL), using position as fallback:\n");
255  if (geom->y < (search_at->rect.height / 2)) {
256  DLOG("geom->y = %d < rect.height / 2 = %d, it is a top dock client\n",
257  geom->y, (search_at->rect.height / 2));
258  cwindow->dock = W_DOCK_TOP;
259  } else {
260  DLOG("geom->y = %d >= rect.height / 2 = %d, it is a bottom dock client\n",
261  geom->y, (search_at->rect.height / 2));
262  cwindow->dock = W_DOCK_BOTTOM;
263  }
264  }
265  }
266 
267  DLOG("Initial geometry: (%d, %d, %d, %d)\n", geom->x, geom->y, geom->width, geom->height);
268 
269  Con *nc = NULL;
270  Match *match = NULL;
271  Assignment *assignment;
272 
273  /* TODO: two matches for one container */
274 
275  /* See if any container swallows this new window */
276  nc = con_for_window(search_at, cwindow, &match);
277  if (nc == NULL) {
278  /* If not, check if it is assigned to a specific workspace / output */
279  if ((assignment = assignment_for(cwindow, A_TO_WORKSPACE | A_TO_OUTPUT))) {
280  DLOG("Assignment matches (%p)\n", match);
281  if (assignment->type == A_TO_WORKSPACE) {
282  Con *assigned_ws = workspace_get(assignment->dest.workspace, NULL);
283  nc = con_descend_tiling_focused(assigned_ws);
284  DLOG("focused on ws %s: %p / %s\n", assigned_ws->name, nc, nc->name);
285  if (nc->type == CT_WORKSPACE)
286  nc = tree_open_con(nc, cwindow);
287  else
288  nc = tree_open_con(nc->parent, cwindow);
289 
290  /* set the urgency hint on the window if the workspace is not visible */
291  if (!workspace_is_visible(assigned_ws))
292  urgency_hint = true;
293  }
294  /* TODO: handle assignments with type == A_TO_OUTPUT */
295  } else if (startup_ws) {
296  /* If it’s not assigned, but was started on a specific workspace,
297  * we want to open it there */
298  DLOG("Using workspace on which this application was started (%s)\n", startup_ws);
299  nc = con_descend_tiling_focused(workspace_get(startup_ws, NULL));
300  DLOG("focused on ws %s: %p / %s\n", startup_ws, nc, nc->name);
301  if (nc->type == CT_WORKSPACE)
302  nc = tree_open_con(nc, cwindow);
303  else nc = tree_open_con(nc->parent, cwindow);
304  } else {
305  /* If not, insert it at the currently focused position */
306  if (focused->type == CT_CON && con_accepts_window(focused)) {
307  LOG("using current container, focused = %p, focused->name = %s\n",
308  focused, focused->name);
309  nc = focused;
310  } else nc = tree_open_con(NULL, cwindow);
311  }
312  } else {
313  /* M_BELOW inserts the new window as a child of the one which was
314  * matched (e.g. dock areas) */
315  if (match != NULL && match->insert_where == M_BELOW) {
316  nc = tree_open_con(nc, cwindow);
317  }
318  }
319 
320  DLOG("new container = %p\n", nc);
321  nc->window = cwindow;
322  x_reinit(nc);
323 
324  nc->border_width = geom->border_width;
325 
326  char *name;
327  sasprintf(&name, "[i3 con] container around %p", cwindow);
328  x_set_name(nc, name);
329  free(name);
330 
331  /* handle fullscreen containers */
332  Con *ws = con_get_workspace(nc);
333  Con *fs = (ws ? con_get_fullscreen_con(ws, CF_OUTPUT) : NULL);
334  if (fs == NULL)
335  fs = con_get_fullscreen_con(croot, CF_GLOBAL);
336 
337  xcb_get_property_reply_t *state_reply = xcb_get_property_reply(conn, state_cookie, NULL);
338  if (xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_FULLSCREEN)) {
339  fs = NULL;
340  con_toggle_fullscreen(nc, CF_OUTPUT);
341  }
342 
343  FREE(state_reply);
344 
345  if (fs == NULL) {
346  DLOG("Not in fullscreen mode, focusing\n");
347  if (!cwindow->dock) {
348  /* Check that the workspace is visible and on the same output as
349  * the current focused container. If the window was assigned to an
350  * invisible workspace, we should not steal focus. */
351  Con *current_output = con_get_output(focused);
352  Con *target_output = con_get_output(ws);
353 
354  if (workspace_is_visible(ws) && current_output == target_output) {
355  if (!match || !match->restart_mode) {
356  con_focus(nc);
357  } else DLOG("not focusing, matched with restart_mode == true\n");
358  } else DLOG("workspace not visible, not focusing\n");
359  } else DLOG("dock, not focusing\n");
360  } else {
361  DLOG("fs = %p, ws = %p, not focusing\n", fs, ws);
362  /* Insert the new container in focus stack *after* the currently
363  * focused (fullscreen) con. This way, the new container will be
364  * focused after we return from fullscreen mode */
365  Con *first = TAILQ_FIRST(&(nc->parent->focus_head));
366  if (first != nc) {
367  /* We only modify the focus stack if the container is not already
368  * the first one. This can happen when existing containers swallow
369  * new windows, for example when restarting. */
370  TAILQ_REMOVE(&(nc->parent->focus_head), nc, focused);
371  TAILQ_INSERT_AFTER(&(nc->parent->focus_head), first, nc, focused);
372  }
373  }
374 
375  /* set floating if necessary */
376  bool want_floating = false;
377  if (xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_DIALOG) ||
378  xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_UTILITY) ||
379  xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_TOOLBAR) ||
380  xcb_reply_contains_atom(reply, A__NET_WM_WINDOW_TYPE_SPLASH)) {
381  LOG("This window is a dialog window, setting floating\n");
382  want_floating = true;
383  }
384 
385  FREE(reply);
386 
387  if (cwindow->transient_for != XCB_NONE ||
388  (cwindow->leader != XCB_NONE &&
389  cwindow->leader != cwindow->id &&
390  con_by_window_id(cwindow->leader) != NULL)) {
391  LOG("This window is transient for another window, setting floating\n");
392  want_floating = true;
393 
394  if (config.popup_during_fullscreen == PDF_LEAVE_FULLSCREEN &&
395  fs != NULL) {
396  LOG("There is a fullscreen window, leaving fullscreen mode\n");
397  con_toggle_fullscreen(fs, CF_OUTPUT);
398  } else if (config.popup_during_fullscreen == PDF_SMART &&
399  fs != NULL &&
400  fs->window != NULL) {
401  i3Window *transient_win = cwindow;
402  while (transient_win != NULL &&
403  transient_win->transient_for != XCB_NONE) {
404  if (transient_win->transient_for == fs->window->id) {
405  LOG("This floating window belongs to the fullscreen window (popup_during_fullscreen == smart)\n");
406  con_focus(nc);
407  break;
408  }
409  Con *next_transient = con_by_window_id(transient_win->transient_for);
410  if (next_transient == NULL)
411  break;
412  transient_win = next_transient->window;
413  }
414  }
415  }
416 
417  /* dock clients cannot be floating, that makes no sense */
418  if (cwindow->dock)
419  want_floating = false;
420 
421  /* Store the requested geometry. The width/height gets raised to at least
422  * 75x50 when entering floating mode, which is the minimum size for a
423  * window to be useful (smaller windows are usually overlays/toolbars/…
424  * which are not managed by the wm anyways). We store the original geometry
425  * here because it’s used for dock clients. */
426  nc->geometry = (Rect){ geom->x, geom->y, geom->width, geom->height };
427 
428  if (want_floating) {
429  DLOG("geometry = %d x %d\n", nc->geometry.width, nc->geometry.height);
430  floating_enable(nc, true);
431  }
432 
433  /* to avoid getting an UnmapNotify event due to reparenting, we temporarily
434  * declare no interest in any state change event of this window */
435  values[0] = XCB_NONE;
436  xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
437 
438  xcb_void_cookie_t rcookie = xcb_reparent_window_checked(conn, window, nc->frame, 0, 0);
439  if (xcb_request_check(conn, rcookie) != NULL) {
440  LOG("Could not reparent the window, aborting\n");
441  goto geom_out;
442  }
443 
444  values[0] = CHILD_EVENT_MASK & ~XCB_EVENT_MASK_ENTER_WINDOW;
445  xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
446  xcb_flush(conn);
447 
448  /* Put the client inside the save set. Upon termination (whether killed or
449  * normal exit does not matter) of the window manager, these clients will
450  * be correctly reparented to their most closest living ancestor (=
451  * cleanup) */
452  xcb_change_save_set(conn, XCB_SET_MODE_INSERT, window);
453 
454  /* Check if any assignments match */
455  run_assignments(cwindow);
456 
457  /* 'ws' may be invalid because of the assignments, e.g. when the user uses
458  * "move window to workspace 1", but had it assigned to workspace 2. */
459  ws = con_get_workspace(nc);
460 
461  /* If this window was put onto an invisible workspace (via assignments), we
462  * render this workspace. It wouldn’t be rendered in our normal code path
463  * because only the visible workspaces get rendered.
464  *
465  * By rendering the workspace, we assign proper coordinates (read: not
466  * width=0, height=0) to the window, which is important for windows who
467  * actually use them to position their GUI elements, e.g. rhythmbox. */
468  if (ws && !workspace_is_visible(ws)) {
469  /* This is a bit hackish: we need to copy the content container’s rect
470  * to the workspace, because calling render_con() on the content
471  * container would also take the shortcut and not render the invisible
472  * workspace at all. However, just calling render_con() on the
473  * workspace isn’t enough either — it needs the rect. */
474  ws->rect = ws->parent->rect;
475  render_con(ws, true);
476  }
477  tree_render();
478 
479  /* Send an event about window creation */
481 
482  /* Windows might get managed with the urgency hint already set (Pidgin is
483  * known to do that), so check for that and handle the hint accordingly.
484  * This code needs to be in this part of manage_window() because the window
485  * needs to be on the final workspace first. */
486  con_set_urgency(nc, urgency_hint);
487 
488 geom_out:
489  free(geom);
490 out:
491  free(attr);
492  return;
493 }