i3
manage.c
Go to the documentation of this file.
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
6  *
7  * manage.c: Initially managing new windows (or existing ones on restart).
8  *
9  */
10 #include "all.h"
11 
12 /*
13  * Match frame and window depth. This is needed because X will refuse to reparent a
14  * window whose background is ParentRelative under a window with a different depth.
15  *
16  */
17 static xcb_window_t _match_depth(i3Window *win, Con *con) {
18  xcb_window_t old_frame = XCB_NONE;
19  if (con->depth != win->depth) {
20  old_frame = con->frame.id;
21  con->depth = win->depth;
22  x_con_reframe(con);
23  }
24  return old_frame;
25 }
26 
27 /*
28  * Remove all match criteria, the first swallowed window wins.
29  *
30  */
31 static void _remove_matches(Con *con) {
32  while (!TAILQ_EMPTY(&(con->swallow_head))) {
33  Match *first = TAILQ_FIRST(&(con->swallow_head));
34  TAILQ_REMOVE(&(con->swallow_head), first, matches);
35  match_free(first);
36  free(first);
37  }
38 }
39 
40 /*
41  * Go through all existing windows (if the window manager is restarted) and manage them
42  *
43  */
44 void manage_existing_windows(xcb_window_t root) {
45  xcb_query_tree_reply_t *reply;
46  int i, len;
47  xcb_window_t *children;
48  xcb_get_window_attributes_cookie_t *cookies;
49 
50  /* Get the tree of windows whose parent is the root window (= all) */
51  if ((reply = xcb_query_tree_reply(conn, xcb_query_tree(conn, root), 0)) == NULL)
52  return;
53 
54  len = xcb_query_tree_children_length(reply);
55  cookies = smalloc(len * sizeof(*cookies));
56 
57  /* Request the window attributes for every window */
58  children = xcb_query_tree_children(reply);
59  for (i = 0; i < len; ++i)
60  cookies[i] = xcb_get_window_attributes(conn, children[i]);
61 
62  /* Call manage_window with the attributes for every window */
63  for (i = 0; i < len; ++i)
64  manage_window(children[i], cookies[i], true);
65 
66  free(reply);
67  free(cookies);
68 }
69 
70 /*
71  * Restores the geometry of each window by reparenting it to the root window
72  * at the position of its frame.
73  *
74  * This is to be called *only* before exiting/restarting i3 because of evil
75  * side-effects which are to be expected when continuing to run i3.
76  *
77  */
78 void restore_geometry(void) {
79  DLOG("Restoring geometry\n");
80 
81  Con *con;
83  if (con->window) {
84  DLOG("Re-adding X11 border of %d px\n", con->border_width);
85  con->window_rect.width += (2 * con->border_width);
86  con->window_rect.height += (2 * con->border_width);
88  DLOG("placing window %08x at %d %d\n", con->window->id, con->rect.x, con->rect.y);
89  xcb_reparent_window(conn, con->window->id, root,
90  con->rect.x, con->rect.y);
91  }
92  }
93 
94  /* Strictly speaking, this line doesn’t really belong here, but since we
95  * are syncing, let’s un-register as a window manager first */
96  xcb_change_window_attributes(conn, root, XCB_CW_EVENT_MASK, (uint32_t[]){XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT});
97 
98  /* Make sure our changes reach the X server, we restart/exit now */
99  xcb_aux_sync(conn);
100 }
101 
102 /*
103  * Do some sanity checks and then reparent the window.
104  *
105  */
106 void manage_window(xcb_window_t window, xcb_get_window_attributes_cookie_t cookie,
107  bool needs_to_be_mapped) {
108  DLOG("window 0x%08x\n", window);
109 
110  xcb_drawable_t d = {window};
111  xcb_get_geometry_cookie_t geomc;
112  xcb_get_geometry_reply_t *geom;
113  xcb_get_window_attributes_reply_t *attr = NULL;
114 
115  xcb_get_property_cookie_t wm_type_cookie, strut_cookie, state_cookie,
116  utf8_title_cookie, title_cookie,
117  class_cookie, leader_cookie, transient_cookie,
118  role_cookie, startup_id_cookie, wm_hints_cookie,
119  wm_normal_hints_cookie, motif_wm_hints_cookie, wm_user_time_cookie, wm_desktop_cookie;
120 
121  geomc = xcb_get_geometry(conn, d);
122 
123  /* Check if the window is mapped (it could be not mapped when intializing and
124  calling manage_window() for every window) */
125  if ((attr = xcb_get_window_attributes_reply(conn, cookie, 0)) == NULL) {
126  DLOG("Could not get attributes\n");
127  xcb_discard_reply(conn, geomc.sequence);
128  return;
129  }
130 
131  if (needs_to_be_mapped && attr->map_state != XCB_MAP_STATE_VIEWABLE) {
132  xcb_discard_reply(conn, geomc.sequence);
133  goto out;
134  }
135 
136  /* Don’t manage clients with the override_redirect flag */
137  if (attr->override_redirect) {
138  xcb_discard_reply(conn, geomc.sequence);
139  goto out;
140  }
141 
142  /* Check if the window is already managed */
143  if (con_by_window_id(window) != NULL) {
144  DLOG("already managed (by con %p)\n", con_by_window_id(window));
145  xcb_discard_reply(conn, geomc.sequence);
146  goto out;
147  }
148 
149  /* Get the initial geometry (position, size, …) */
150  if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL) {
151  DLOG("could not get geometry\n");
152  goto out;
153  }
154 
155  uint32_t values[1];
156 
157  /* Set a temporary event mask for the new window, consisting only of
158  * PropertyChange and StructureNotify. We need to be notified of
159  * PropertyChanges because the client can change its properties *after* we
160  * requested them but *before* we actually reparented it and have set our
161  * final event mask.
162  * We need StructureNotify because the client may unmap the window before
163  * we get to re-parent it.
164  * If this request fails, we assume the client has already unmapped the
165  * window between the MapRequest and our event mask change. */
166  values[0] = XCB_EVENT_MASK_PROPERTY_CHANGE |
167  XCB_EVENT_MASK_STRUCTURE_NOTIFY;
168  xcb_void_cookie_t event_mask_cookie =
169  xcb_change_window_attributes_checked(conn, window, XCB_CW_EVENT_MASK, values);
170  if (xcb_request_check(conn, event_mask_cookie) != NULL) {
171  LOG("Could not change event mask, the window probably already disappeared.\n");
172  goto out;
173  }
174 
175 #define GET_PROPERTY(atom, len) xcb_get_property(conn, false, window, atom, XCB_GET_PROPERTY_TYPE_ANY, 0, len)
176 
177  wm_type_cookie = GET_PROPERTY(A__NET_WM_WINDOW_TYPE, UINT32_MAX);
178  strut_cookie = GET_PROPERTY(A__NET_WM_STRUT_PARTIAL, UINT32_MAX);
179  state_cookie = GET_PROPERTY(A__NET_WM_STATE, UINT32_MAX);
180  utf8_title_cookie = GET_PROPERTY(A__NET_WM_NAME, 128);
181  leader_cookie = GET_PROPERTY(A_WM_CLIENT_LEADER, UINT32_MAX);
182  transient_cookie = GET_PROPERTY(XCB_ATOM_WM_TRANSIENT_FOR, UINT32_MAX);
183  title_cookie = GET_PROPERTY(XCB_ATOM_WM_NAME, 128);
184  class_cookie = GET_PROPERTY(XCB_ATOM_WM_CLASS, 128);
185  role_cookie = GET_PROPERTY(A_WM_WINDOW_ROLE, 128);
186  startup_id_cookie = GET_PROPERTY(A__NET_STARTUP_ID, 512);
187  wm_hints_cookie = xcb_icccm_get_wm_hints(conn, window);
188  wm_normal_hints_cookie = xcb_icccm_get_wm_normal_hints(conn, window);
189  motif_wm_hints_cookie = GET_PROPERTY(A__MOTIF_WM_HINTS, 5 * sizeof(uint64_t));
190  wm_user_time_cookie = GET_PROPERTY(A__NET_WM_USER_TIME, UINT32_MAX);
191  wm_desktop_cookie = GET_PROPERTY(A__NET_WM_DESKTOP, UINT32_MAX);
192 
193  i3Window *cwindow = scalloc(1, sizeof(i3Window));
194  cwindow->id = window;
195  cwindow->depth = get_visual_depth(attr->visual);
196 
197  int *buttons = bindings_get_buttons_to_grab();
198  xcb_grab_buttons(conn, window, buttons);
199  FREE(buttons);
200 
201  /* update as much information as possible so far (some replies may be NULL) */
202  window_update_class(cwindow, xcb_get_property_reply(conn, class_cookie, NULL));
203  window_update_name_legacy(cwindow, xcb_get_property_reply(conn, title_cookie, NULL));
204  window_update_name(cwindow, xcb_get_property_reply(conn, utf8_title_cookie, NULL));
205  window_update_leader(cwindow, xcb_get_property_reply(conn, leader_cookie, NULL));
206  window_update_transient_for(cwindow, xcb_get_property_reply(conn, transient_cookie, NULL));
207  window_update_strut_partial(cwindow, xcb_get_property_reply(conn, strut_cookie, NULL));
208  window_update_role(cwindow, xcb_get_property_reply(conn, role_cookie, NULL));
209  bool urgency_hint;
210  window_update_hints(cwindow, xcb_get_property_reply(conn, wm_hints_cookie, NULL), &urgency_hint);
211  border_style_t motif_border_style = BS_NORMAL;
212  window_update_motif_hints(cwindow, xcb_get_property_reply(conn, motif_wm_hints_cookie, NULL), &motif_border_style);
213  window_update_normal_hints(cwindow, xcb_get_property_reply(conn, wm_normal_hints_cookie, NULL), geom);
214  xcb_get_property_reply_t *type_reply = xcb_get_property_reply(conn, wm_type_cookie, NULL);
215  xcb_get_property_reply_t *state_reply = xcb_get_property_reply(conn, state_cookie, NULL);
216 
217  xcb_get_property_reply_t *startup_id_reply;
218  startup_id_reply = xcb_get_property_reply(conn, startup_id_cookie, NULL);
219  char *startup_ws = startup_workspace_for_window(cwindow, startup_id_reply);
220  DLOG("startup workspace = %s\n", startup_ws);
221 
222  /* Get _NET_WM_DESKTOP if it was set. */
223  xcb_get_property_reply_t *wm_desktop_reply;
224  wm_desktop_reply = xcb_get_property_reply(conn, wm_desktop_cookie, NULL);
225  cwindow->wm_desktop = NET_WM_DESKTOP_NONE;
226  if (wm_desktop_reply != NULL && xcb_get_property_value_length(wm_desktop_reply) != 0) {
227  uint32_t *wm_desktops = xcb_get_property_value(wm_desktop_reply);
228  cwindow->wm_desktop = (int32_t)wm_desktops[0];
229  }
230  FREE(wm_desktop_reply);
231 
232  /* check if the window needs WM_TAKE_FOCUS */
233  cwindow->needs_take_focus = window_supports_protocol(cwindow->id, A_WM_TAKE_FOCUS);
234 
235  /* read the preferred _NET_WM_WINDOW_TYPE atom */
236  cwindow->window_type = xcb_get_preferred_window_type(type_reply);
237 
238  /* Where to start searching for a container that swallows the new one? */
239  Con *search_at = croot;
240 
241  if (xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_DOCK)) {
242  LOG("This window is of type dock\n");
243  Output *output = get_output_containing(geom->x, geom->y);
244  if (output != NULL) {
245  DLOG("Starting search at output %s\n", output_primary_name(output));
246  search_at = output->con;
247  }
248 
249  /* find out the desired position of this dock window */
250  if (cwindow->reserved.top > 0 && cwindow->reserved.bottom == 0) {
251  DLOG("Top dock client\n");
252  cwindow->dock = W_DOCK_TOP;
253  } else if (cwindow->reserved.top == 0 && cwindow->reserved.bottom > 0) {
254  DLOG("Bottom dock client\n");
255  cwindow->dock = W_DOCK_BOTTOM;
256  } else {
257  DLOG("Ignoring invalid reserved edges (_NET_WM_STRUT_PARTIAL), using position as fallback:\n");
258  if (geom->y < (int16_t)(search_at->rect.height / 2)) {
259  DLOG("geom->y = %d < rect.height / 2 = %d, it is a top dock client\n",
260  geom->y, (search_at->rect.height / 2));
261  cwindow->dock = W_DOCK_TOP;
262  } else {
263  DLOG("geom->y = %d >= rect.height / 2 = %d, it is a bottom dock client\n",
264  geom->y, (search_at->rect.height / 2));
265  cwindow->dock = W_DOCK_BOTTOM;
266  }
267  }
268  }
269 
270  DLOG("Initial geometry: (%d, %d, %d, %d)\n", geom->x, geom->y, geom->width, geom->height);
271 
272  /* See if any container swallows this new window */
273  cwindow->swallowed = false;
274  Match *match = NULL;
275  Con *nc = con_for_window(search_at, cwindow, &match);
276  const bool match_from_restart_mode = (match && match->restart_mode);
277  if (nc == NULL) {
278  Con *wm_desktop_ws = NULL;
279  Assignment *assignment;
280 
281  /* If not, check if it is assigned to a specific workspace */
282  if ((assignment = assignment_for(cwindow, A_TO_WORKSPACE)) ||
283  (assignment = assignment_for(cwindow, A_TO_WORKSPACE_NUMBER))) {
284  DLOG("Assignment matches (%p)\n", match);
285 
286  Con *assigned_ws = NULL;
287  if (assignment->type == A_TO_WORKSPACE_NUMBER) {
288  long parsed_num = ws_name_to_number(assignment->dest.workspace);
289 
290  assigned_ws = get_existing_workspace_by_num(parsed_num);
291  }
292  /* A_TO_WORKSPACE type assignment or fallback from A_TO_WORKSPACE_NUMBER
293  * when the target workspace number does not exist yet. */
294  if (!assigned_ws) {
295  assigned_ws = workspace_get(assignment->dest.workspace);
296  }
297 
298  nc = con_descend_tiling_focused(assigned_ws);
299  DLOG("focused on ws %s: %p / %s\n", assigned_ws->name, nc, nc->name);
300  if (nc->type == CT_WORKSPACE)
301  nc = tree_open_con(nc, cwindow);
302  else
303  nc = tree_open_con(nc->parent, cwindow);
304 
305  /* set the urgency hint on the window if the workspace is not visible */
306  if (!workspace_is_visible(assigned_ws))
307  urgency_hint = true;
308  } else if (cwindow->wm_desktop != NET_WM_DESKTOP_NONE &&
309  cwindow->wm_desktop != NET_WM_DESKTOP_ALL &&
310  (wm_desktop_ws = ewmh_get_workspace_by_index(cwindow->wm_desktop)) != NULL) {
311  /* If _NET_WM_DESKTOP is set to a specific desktop, we open it
312  * there. Note that we ignore the special value 0xFFFFFFFF here
313  * since such a window will be made sticky anyway. */
314 
315  DLOG("Using workspace %p / %s because _NET_WM_DESKTOP = %d.\n",
316  wm_desktop_ws, wm_desktop_ws->name, cwindow->wm_desktop);
317 
318  nc = con_descend_tiling_focused(wm_desktop_ws);
319  if (nc->type == CT_WORKSPACE)
320  nc = tree_open_con(nc, cwindow);
321  else
322  nc = tree_open_con(nc->parent, cwindow);
323  } else if (startup_ws) {
324  /* If it was started on a specific workspace, we want to open it there. */
325  DLOG("Using workspace on which this application was started (%s)\n", startup_ws);
326  nc = con_descend_tiling_focused(workspace_get(startup_ws));
327  DLOG("focused on ws %s: %p / %s\n", startup_ws, nc, nc->name);
328  if (nc->type == CT_WORKSPACE)
329  nc = tree_open_con(nc, cwindow);
330  else
331  nc = tree_open_con(nc->parent, cwindow);
332  } else {
333  /* If not, insert it at the currently focused position */
334  if (focused->type == CT_CON && con_accepts_window(focused)) {
335  LOG("using current container, focused = %p, focused->name = %s\n",
336  focused, focused->name);
337  nc = focused;
338  } else
339  nc = tree_open_con(NULL, cwindow);
340  }
341 
342  if ((assignment = assignment_for(cwindow, A_TO_OUTPUT))) {
343  con_move_to_output_name(nc, assignment->dest.output, true);
344  }
345  } else {
346  /* M_BELOW inserts the new window as a child of the one which was
347  * matched (e.g. dock areas) */
348  if (match != NULL && match->insert_where == M_BELOW) {
349  nc = tree_open_con(nc, cwindow);
350  }
351 
352  /* If M_BELOW is not used, the container is replaced. This happens with
353  * "swallows" criteria that are used for stored layouts, in which case
354  * we need to remove that criterion, because they should only be valid
355  * once. */
356  if (match != NULL && match->insert_where != M_BELOW) {
357  DLOG("Removing match %p from container %p\n", match, nc);
358  TAILQ_REMOVE(&(nc->swallow_head), match, matches);
359  match_free(match);
360  FREE(match);
361  }
362 
363  cwindow->swallowed = true;
364  }
365 
366  DLOG("new container = %p\n", nc);
367  if (nc->window != NULL && nc->window != cwindow) {
368  if (!restore_kill_placeholder(nc->window->id)) {
369  DLOG("Uh?! Container without a placeholder, but with a window, has swallowed this to-be-managed window?!\n");
370  } else {
371  /* Remove remaining criteria, the first swallowed window wins. */
372  _remove_matches(nc);
373  }
374  }
375  xcb_window_t old_frame = XCB_NONE;
376  if (nc->window != cwindow && nc->window != NULL) {
377  window_free(nc->window);
378  old_frame = _match_depth(cwindow, nc);
379  }
380  nc->window = cwindow;
381  x_reinit(nc);
382 
383  nc->border_width = geom->border_width;
384 
385  char *name;
386  sasprintf(&name, "[i3 con] container around %p", cwindow);
387  x_set_name(nc, name);
388  free(name);
389 
390  /* handle fullscreen containers */
391  Con *ws = con_get_workspace(nc);
393 
394  if (xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_FULLSCREEN)) {
395  /* If this window is already fullscreen (after restarting!), skip
396  * toggling fullscreen, that would drop it out of fullscreen mode. */
397  if (fs != nc) {
398  Output *output = get_output_with_dimensions((Rect){geom->x, geom->y, geom->width, geom->height});
399  /* If the requested window geometry spans the whole area
400  * of an output, move the window to that output. This is
401  * needed e.g. for LibreOffice Impress multi-monitor
402  * presentations to work out of the box. */
403  if (output != NULL)
404  con_move_to_output(nc, output, false);
406  }
407  fs = NULL;
408  }
409 
410  bool set_focus = false;
411 
412  if (fs == NULL) {
413  DLOG("Not in fullscreen mode, focusing\n");
414  if (!cwindow->dock) {
415  /* Check that the workspace is visible and on the same output as
416  * the current focused container. If the window was assigned to an
417  * invisible workspace, we should not steal focus. */
418  Con *current_output = con_get_output(focused);
419  Con *target_output = con_get_output(ws);
420 
421  if (workspace_is_visible(ws) && current_output == target_output) {
422  if (!match_from_restart_mode) {
423  set_focus = true;
424  } else {
425  DLOG("not focusing, matched with restart_mode == true\n");
426  }
427  } else {
428  DLOG("workspace not visible, not focusing\n");
429  }
430  } else {
431  DLOG("dock, not focusing\n");
432  }
433  } else {
434  DLOG("fs = %p, ws = %p, not focusing\n", fs, ws);
435  /* Insert the new container in focus stack *after* the currently
436  * focused (fullscreen) con. This way, the new container will be
437  * focused after we return from fullscreen mode */
438  Con *first = TAILQ_FIRST(&(nc->parent->focus_head));
439  if (first != nc) {
440  /* We only modify the focus stack if the container is not already
441  * the first one. This can happen when existing containers swallow
442  * new windows, for example when restarting. */
443  TAILQ_REMOVE(&(nc->parent->focus_head), nc, focused);
444  TAILQ_INSERT_AFTER(&(nc->parent->focus_head), first, nc, focused);
445  }
446  }
447 
448  /* set floating if necessary */
449  bool want_floating = false;
450  if (xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_DIALOG) ||
451  xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_UTILITY) ||
452  xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_TOOLBAR) ||
453  xcb_reply_contains_atom(type_reply, A__NET_WM_WINDOW_TYPE_SPLASH) ||
454  xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_MODAL) ||
455  (cwindow->max_width > 0 && cwindow->max_height > 0 &&
456  cwindow->min_height == cwindow->max_height &&
457  cwindow->min_width == cwindow->max_width)) {
458  LOG("This window is a dialog window, setting floating\n");
459  want_floating = true;
460  }
461 
462  if (xcb_reply_contains_atom(state_reply, A__NET_WM_STATE_STICKY))
463  nc->sticky = true;
464 
465  /* We ignore the hint for an internal workspace because windows in the
466  * scratchpad also have this value, but upon restarting i3 we don't want
467  * them to become sticky windows. */
468  if (cwindow->wm_desktop == NET_WM_DESKTOP_ALL && (ws == NULL || !con_is_internal(ws))) {
469  DLOG("This window has _NET_WM_DESKTOP = 0xFFFFFFFF. Will float it and make it sticky.\n");
470  nc->sticky = true;
471  want_floating = true;
472  }
473 
474  FREE(state_reply);
475  FREE(type_reply);
476 
477  if (cwindow->transient_for != XCB_NONE ||
478  (cwindow->leader != XCB_NONE &&
479  cwindow->leader != cwindow->id &&
480  con_by_window_id(cwindow->leader) != NULL)) {
481  LOG("This window is transient for another window, setting floating\n");
482  want_floating = true;
483 
484  if (config.popup_during_fullscreen == PDF_LEAVE_FULLSCREEN &&
485  fs != NULL) {
486  LOG("There is a fullscreen window, leaving fullscreen mode\n");
488  } else if (config.popup_during_fullscreen == PDF_SMART &&
489  fs != NULL &&
490  fs->window != NULL) {
491  i3Window *transient_win = cwindow;
492  while (transient_win != NULL &&
493  transient_win->transient_for != XCB_NONE) {
494  if (transient_win->transient_for == fs->window->id) {
495  LOG("This floating window belongs to the fullscreen window (popup_during_fullscreen == smart)\n");
496  set_focus = true;
497  break;
498  }
499  Con *next_transient = con_by_window_id(transient_win->transient_for);
500  if (next_transient == NULL)
501  break;
502  /* Some clients (e.g. x11-ssh-askpass) actually set
503  * WM_TRANSIENT_FOR to their own window id, so break instead of
504  * looping endlessly. */
505  if (transient_win == next_transient->window)
506  break;
507  transient_win = next_transient->window;
508  }
509  }
510  }
511 
512  /* dock clients cannot be floating, that makes no sense */
513  if (cwindow->dock)
514  want_floating = false;
515 
516  /* Store the requested geometry. The width/height gets raised to at least
517  * 75x50 when entering floating mode, which is the minimum size for a
518  * window to be useful (smaller windows are usually overlays/toolbars/…
519  * which are not managed by the wm anyways). We store the original geometry
520  * here because it’s used for dock clients. */
521  if (nc->geometry.width == 0)
522  nc->geometry = (Rect){geom->x, geom->y, geom->width, geom->height};
523 
524  if (motif_border_style != BS_NORMAL) {
525  DLOG("MOTIF_WM_HINTS specifies decorations (border_style = %d)\n", motif_border_style);
526  if (want_floating) {
528  } else {
529  con_set_border_style(nc, motif_border_style, config.default_border_width);
530  }
531  }
532 
533  if (want_floating) {
534  DLOG("geometry = %d x %d\n", nc->geometry.width, nc->geometry.height);
535  /* automatically set the border to the default value if a motif border
536  * was not specified */
537  bool automatic_border = (motif_border_style == BS_NORMAL);
538 
539  if (floating_enable(nc, automatic_border)) {
540  nc->floating = FLOATING_AUTO_ON;
541  }
542  }
543 
544  /* explicitly set the border width to the default */
545  if (nc->current_border_width == -1) {
547  }
548 
549  /* to avoid getting an UnmapNotify event due to reparenting, we temporarily
550  * declare no interest in any state change event of this window */
551  values[0] = XCB_NONE;
552  xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
553 
554  xcb_void_cookie_t rcookie = xcb_reparent_window_checked(conn, window, nc->frame.id, 0, 0);
555  if (xcb_request_check(conn, rcookie) != NULL) {
556  LOG("Could not reparent the window, aborting\n");
557  goto geom_out;
558  }
559 
560  values[0] = CHILD_EVENT_MASK & ~XCB_EVENT_MASK_ENTER_WINDOW;
561  xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, values);
562  xcb_flush(conn);
563 
564  /* Put the client inside the save set. Upon termination (whether killed or
565  * normal exit does not matter) of the window manager, these clients will
566  * be correctly reparented to their most closest living ancestor (=
567  * cleanup) */
568  xcb_change_save_set(conn, XCB_SET_MODE_INSERT, window);
569 
570  if (shape_supported) {
571  /* Receive ShapeNotify events whenever the client altered its window
572  * shape. */
573  xcb_shape_select_input(conn, window, true);
574 
575  /* Check if the window is shaped. Sadly, we can check only for the
576  * bounding shape, not for the input shape. */
577  xcb_shape_query_extents_cookie_t cookie =
578  xcb_shape_query_extents(conn, window);
579  xcb_shape_query_extents_reply_t *reply =
580  xcb_shape_query_extents_reply(conn, cookie, NULL);
581  if (reply != NULL && reply->bounding_shaped) {
582  cwindow->shaped = true;
583  }
584  FREE(reply);
585  }
586 
587  /* Check if any assignments match */
588  run_assignments(cwindow);
589 
590  /* 'ws' may be invalid because of the assignments, e.g. when the user uses
591  * "move window to workspace 1", but had it assigned to workspace 2. */
592  ws = con_get_workspace(nc);
593 
594  /* If this window was put onto an invisible workspace (via assignments), we
595  * render this workspace. It wouldn’t be rendered in our normal code path
596  * because only the visible workspaces get rendered.
597  *
598  * By rendering the workspace, we assign proper coordinates (read: not
599  * width=0, height=0) to the window, which is important for windows who
600  * actually use them to position their GUI elements, e.g. rhythmbox. */
601  if (ws && !workspace_is_visible(ws)) {
602  /* This is a bit hackish: we need to copy the content container’s rect
603  * to the workspace, because calling render_con() on the content
604  * container would also take the shortcut and not render the invisible
605  * workspace at all. However, just calling render_con() on the
606  * workspace isn’t enough either — it needs the rect. */
607  ws->rect = ws->parent->rect;
608  render_con(ws);
609  /* Disable setting focus, otherwise we’d move focus to an invisible
610  * workspace, which we generally prevent (e.g. in
611  * con_move_to_workspace). */
612  set_focus = false;
613  }
614  render_con(croot);
615 
616  cwindow->managed_since = time(NULL);
617 
618  /* Send an event about window creation */
619  ipc_send_window_event("new", nc);
620 
621  if (set_focus && assignment_for(cwindow, A_NO_FOCUS) != NULL) {
622  /* The first window on a workspace should always be focused. We have to
623  * compare with == 1 because the container has already been inserted at
624  * this point. */
625  if (con_num_windows(ws) == 1) {
626  DLOG("This is the first window on this workspace, ignoring no_focus.\n");
627  } else {
628  DLOG("no_focus was set for con = %p, not setting focus.\n", nc);
629  set_focus = false;
630  }
631  }
632 
633  if (set_focus) {
634  DLOG("Checking con = %p for _NET_WM_USER_TIME.\n", nc);
635 
636  uint32_t *wm_user_time;
637  xcb_get_property_reply_t *wm_user_time_reply = xcb_get_property_reply(conn, wm_user_time_cookie, NULL);
638  if (wm_user_time_reply != NULL && xcb_get_property_value_length(wm_user_time_reply) != 0 &&
639  (wm_user_time = xcb_get_property_value(wm_user_time_reply)) &&
640  wm_user_time[0] == 0) {
641  DLOG("_NET_WM_USER_TIME set to 0, not focusing con = %p.\n", nc);
642  set_focus = false;
643  }
644 
645  FREE(wm_user_time_reply);
646  } else {
647  xcb_discard_reply(conn, wm_user_time_cookie.sequence);
648  }
649 
650  if (set_focus) {
651  /* Even if the client doesn't want focus, we still need to focus the
652  * container to not break focus workflows. Our handling towards X will
653  * take care of not setting the input focus. However, one exception to
654  * this are clients using the globally active input model which we
655  * don't want to focus at all. */
657  set_focus = false;
658  }
659  }
660 
661  /* Defer setting focus after the 'new' event has been sent to ensure the
662  * proper window event sequence. */
663  if (set_focus && nc->mapped) {
664  DLOG("Now setting focus.\n");
665  con_activate(nc);
666  }
667 
668  tree_render();
669 
670  /* Destroy the old frame if we had to reframe the container. This needs to be done
671  * after rendering in order to prevent the background from flickering in its place. */
672  if (old_frame != XCB_NONE) {
673  xcb_destroy_window(conn, old_frame);
674  }
675 
676  /* Windows might get managed with the urgency hint already set (Pidgin is
677  * known to do that), so check for that and handle the hint accordingly.
678  * This code needs to be in this part of manage_window() because the window
679  * needs to be on the final workspace first. */
680  con_set_urgency(nc, urgency_hint);
681 
682  /* Update _NET_WM_DESKTOP. We invalidate the cached value first to force an update. */
683  cwindow->wm_desktop = NET_WM_DESKTOP_NONE;
685 
686  /* If a sticky window was mapped onto another workspace, make sure to pop it to the front. */
688 
689 geom_out:
690  free(geom);
691 out:
692  free(attr);
693 }
694 
695 /*
696  * Remanages a window: performs a swallow check and runs assignments.
697  * Returns con for the window regardless if it updated.
698  *
699  */
701  /* Make sure this windows hasn't already been swallowed. */
702  if (con->window->swallowed) {
703  run_assignments(con->window);
704  return con;
705  }
706  Match *match;
707  Con *nc = con_for_window(croot, con->window, &match);
708  if (nc == NULL || nc->window == NULL || nc->window == con->window) {
709  run_assignments(con->window);
710  return con;
711  }
712  /* Make sure the placeholder that wants to swallow this window didn't spawn
713  * after the window to follow current behavior: adding a placeholder won't
714  * swallow windows currently managed. */
715  if (nc->window->managed_since > con->window->managed_since) {
716  run_assignments(con->window);
717  return con;
718  }
719 
720  if (!restore_kill_placeholder(nc->window->id)) {
721  DLOG("Uh?! Container without a placeholder, but with a window, has swallowed this managed window?!\n");
722  } else {
723  _remove_matches(nc);
724  }
725  window_free(nc->window);
726 
727  xcb_window_t old_frame = _match_depth(con->window, nc);
728 
729  x_reparent_child(nc, con);
730 
731  bool moved_workpaces = (con_get_workspace(nc) != con_get_workspace(con));
732 
733  con_merge_into(con, nc);
734 
735  /* Destroy the old frame if we had to reframe the container. This needs to be done
736  * after rendering in order to prevent the background from flickering in its place. */
737  if (old_frame != XCB_NONE) {
738  xcb_destroy_window(conn, old_frame);
739  }
740 
741  run_assignments(nc->window);
742 
743  if (moved_workpaces) {
744  /* If the window is associated with a startup sequence, delete it so
745  * child windows won't be created on the old workspace. */
747 
749  }
750 
751  nc->window->swallowed = true;
752  return nc;
753 }
void run_assignments(i3Window *window)
Checks the list of assignments for the given window and runs all matching ones (unless they have alre...
Definition: assignments.c:17
Assignment * assignment_for(i3Window *window, int type)
Returns the first matching assignment for the given window.
Definition: assignments.c:69
int * bindings_get_buttons_to_grab(void)
Returns a list of buttons that should be grabbed on a window.
Definition: bindings.c:987
Con * con_get_fullscreen_covering_ws(Con *ws)
Returns the fullscreen node that covers the given workspace if it exists.
Definition: con.c:572
bool con_move_to_output_name(Con *con, const char *name, bool fix_coordinates)
Moves the given container to the currently focused container on the visible workspace on the output s...
Definition: con.c:1458
void con_set_urgency(Con *con, bool urgent)
Set urgency flag to the container, all the parent containers and the workspace.
Definition: con.c:2191
Con * con_get_workspace(Con *con)
Gets the workspace container this node is on.
Definition: con.c:476
Con * con_by_window_id(xcb_window_t window)
Returns the container with the given client window ID or NULL if no such container exists.
Definition: con.c:667
Con * con_descend_tiling_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition: con.c:1564
bool con_accepts_window(Con *con)
Returns true if this node accepts a window (if the node swallows windows, it might already have swall...
Definition: con.c:443
bool con_is_internal(Con *con)
Returns true if the container is internal, such as __i3_scratch.
Definition: con.c:587
void con_move_to_output(Con *con, Output *output, bool fix_coordinates)
Moves the given container to the currently focused container on the visible workspace on the given ou...
Definition: con.c:1443
void con_toggle_fullscreen(Con *con, int fullscreen_mode)
Toggles fullscreen mode for the given container.
Definition: con.c:1058
Con * con_get_output(Con *con)
Gets the output container (first container with CT_OUTPUT in hierarchy) this node is on.
Definition: con.c:462
void con_set_border_style(Con *con, int border_style, int border_width)
Sets the given border style on con, correctly keeping the position/size of a floating window.
Definition: con.c:1759
void con_merge_into(Con *old, Con *new)
Merges container specific data that should move with the window (e.g.
Definition: con.c:2469
void con_activate(Con *con)
Sets input focus to the given container and raises it to the top.
Definition: con.c:286
int con_num_windows(Con *con)
Count the number of windows (i.e., leaf containers).
Definition: con.c:984
Con * con_for_window(Con *con, i3Window *window, Match **store_match)
Returns the first container below 'con' which wants to swallow this window TODO: priority.
Definition: con.c:851
Config config
Definition: config.c:17
Con * ewmh_get_workspace_by_index(uint32_t idx)
Returns the workspace container as enumerated by the EWMH desktop model.
Definition: ewmh.c:353
void ewmh_update_wm_desktop(void)
Updates _NET_WM_DESKTOP for all windows.
Definition: ewmh.c:184
bool floating_enable(Con *con, bool automatic)
Enables floating mode for the given container by detaching it from its parent, creating a new contain...
Definition: floating.c:226
void ipc_send_window_event(const char *property, Con *con)
For the window events we send, along the usual "change" field, also the window container,...
Definition: ipc.c:1630
xcb_connection_t * conn
XCB connection and root screen.
Definition: main.c:51
xcb_window_t root
Definition: main.c:64
bool shape_supported
Definition: main.c:99
void restore_geometry(void)
Restores the geometry of each window by reparenting it to the root window at the position of its fram...
Definition: manage.c:78
static void _remove_matches(Con *con)
Definition: manage.c:31
Con * remanage_window(Con *con)
Remanages a window: performs a swallow check and runs assignments.
Definition: manage.c:700
static xcb_window_t _match_depth(i3Window *win, Con *con)
Definition: manage.c:17
void manage_existing_windows(xcb_window_t root)
Go through all existing windows (if the window manager is restarted) and manage them.
Definition: manage.c:44
void manage_window(xcb_window_t window, xcb_get_window_attributes_cookie_t cookie, bool needs_to_be_mapped)
Do some sanity checks and then reparent the window.
Definition: manage.c:106
#define GET_PROPERTY(atom, len)
void match_free(Match *match)
Frees the given match.
Definition: match.c:267
char * output_primary_name(Output *output)
Retrieves the primary name of an output.
Definition: output.c:53
void output_push_sticky_windows(Con *old_focus)
Iterates over all outputs and pushes sticky windows to the currently visible workspace on that output...
Definition: output.c:77
Output * get_output_with_dimensions(Rect rect)
Returns the active output which spans exactly the area specified by rect or NULL if there is no outpu...
Definition: randr.c:150
Output * get_output_containing(unsigned int x, unsigned int y)
Returns the active (!) output which contains the coordinates x, y or NULL if there is no output which...
Definition: randr.c:116
void render_con(Con *con)
"Renders" the given container (and its children), meaning that all rects are updated correctly.
Definition: render.c:42
bool restore_kill_placeholder(xcb_window_t placeholder)
Kill the placeholder window, if placeholder refers to a placeholder window.
char * startup_workspace_for_window(i3Window *cwindow, xcb_get_property_reply_t *startup_id_reply)
Checks if the given window belongs to a startup notification by checking if the _NET_STARTUP_ID prope...
Definition: startup.c:347
void startup_sequence_delete_by_window(i3Window *win)
Deletes the startup sequence for a window if it exists.
Definition: startup.c:367
struct Con * focused
Definition: tree.c:13
struct Con * croot
Definition: tree.c:12
Con * tree_open_con(Con *con, i3Window *window)
Opens an empty container in the current container.
Definition: tree.c:149
struct all_cons_head all_cons
Definition: tree.c:15
void tree_render(void)
Renders the tree, that is rendering all outputs using render_con() and pushing the changes to X11 usi...
Definition: tree.c:451
int ws_name_to_number(const char *name)
Parses the workspace name as a number.
Definition: util.c:109
void window_update_motif_hints(i3Window *win, xcb_get_property_reply_t *prop, border_style_t *motif_border_style)
Updates the MOTIF_WM_HINTS.
Definition: window.c:415
void window_update_hints(i3Window *win, xcb_get_property_reply_t *prop, bool *urgency_hint)
Updates the WM_HINTS (we only care about the input focus handling part).
Definition: window.c:374
void window_update_strut_partial(i3Window *win, xcb_get_property_reply_t *prop)
Updates the _NET_WM_STRUT_PARTIAL (reserved pixels at the screen edges)
Definition: window.c:189
void window_update_role(i3Window *win, xcb_get_property_reply_t *prop)
Updates the WM_WINDOW_ROLE.
Definition: window.c:214
void window_update_name_legacy(i3Window *win, xcb_get_property_reply_t *prop)
Updates the name by using WM_NAME (encoded in COMPOUND_TEXT).
Definition: window.c:100
void window_free(i3Window *win)
Frees an i3Window and all its members.
Definition: window.c:18
void window_update_transient_for(i3Window *win, xcb_get_property_reply_t *prop)
Updates the TRANSIENT_FOR (logical parent window).
Definition: window.c:164
void window_update_leader(i3Window *win, xcb_get_property_reply_t *prop)
Updates the CLIENT_LEADER (logical parent window).
Definition: window.c:139
bool window_update_normal_hints(i3Window *win, xcb_get_property_reply_t *reply, xcb_get_geometry_reply_t *geom)
Updates the WM_NORMAL_HINTS.
Definition: window.c:253
void window_update_name(i3Window *win, xcb_get_property_reply_t *prop)
Updates the name by using _NET_WM_NAME (encoded in UTF-8) for the given window.
Definition: window.c:64
void window_update_class(i3Window *win, xcb_get_property_reply_t *prop)
Updates the WM_CLASS (consisting of the class and instance) for the given window.
Definition: window.c:31
Con * get_existing_workspace_by_num(int num)
Returns the workspace with the given number or NULL if such a workspace does not exist.
Definition: workspace.c:44
Con * workspace_get(const char *num)
Returns a pointer to the workspace with the given number (starting at 0), creating the workspace if n...
Definition: workspace.c:127
bool workspace_is_visible(Con *ws)
Returns true if the workspace is currently visible.
Definition: workspace.c:303
void x_reparent_child(Con *con, Con *old)
Reparents the child window of the given container (necessary for sticky containers).
Definition: x.c:217
void x_con_reframe(Con *con)
Definition: x.c:294
void x_reinit(Con *con)
Re-initializes the associated X window state for this container.
Definition: x.c:197
void x_set_name(Con *con, const char *name)
Sets the WM_NAME property (so, no UTF8, but used only for debugging anyways) of the given name.
Definition: x.c:1383
bool window_supports_protocol(xcb_window_t window, xcb_atom_t atom)
Returns true if the client supports the given protocol atom (like WM_DELETE_WINDOW)
Definition: x.c:303
xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply)
Returns the first supported _NET_WM_WINDOW_TYPE atom.
Definition: xcb.c:121
void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r)
Configures the given window to have the size/position specified by given rect.
Definition: xcb.c:105
uint16_t get_visual_depth(xcb_visualid_t visual_id)
Get depth of visual specified by visualid.
Definition: xcb.c:170
bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom)
Returns true if the given reply contains the given data.
Definition: xcb.c:151
void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons)
Grab the specified buttons on a window when managing it.
Definition: xcb.c:279
struct Rect Rect
Definition: data.h:41
@ CF_OUTPUT
Definition: data.h:591
border_style_t
Definition: data.h:61
@ BS_NORMAL
Definition: data.h:61
#define DLOG(fmt,...)
Definition: libi3.h:104
#define LOG(fmt,...)
Definition: libi3.h:94
void * smalloc(size_t size)
Safe-wrapper around malloc which exits if malloc returns NULL (meaning that there is no more memory a...
int sasprintf(char **strp, const char *fmt,...)
Safe-wrapper around asprintf which exits if it returns -1 (meaning that there is no more memory avail...
void * scalloc(size_t num, size_t size)
Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there is no more memory a...
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:347
#define TAILQ_FIRST(head)
Definition: queue.h:336
#define TAILQ_REMOVE(head, elm, field)
Definition: queue.h:402
#define TAILQ_EMPTY(head)
Definition: queue.h:344
#define TAILQ_INSERT_AFTER(head, listelm, elm, field)
Definition: queue.h:384
#define FREE(pointer)
Definition: util.h:47
#define NET_WM_DESKTOP_ALL
Definition: workspace.h:25
#define NET_WM_DESKTOP_NONE
Definition: workspace.h:24
#define CHILD_EVENT_MASK
The XCB_CW_EVENT_MASK for the child (= real window)
Definition: xcb.h:28
int default_border_width
int default_floating_border_width
enum Config::@8 popup_during_fullscreen
What should happen when a new popup is opened during fullscreen mode.
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:155
uint32_t height
Definition: data.h:159
uint32_t x
Definition: data.h:156
uint32_t y
Definition: data.h:157
uint32_t width
Definition: data.h:158
uint32_t top
Definition: data.h:170
uint32_t bottom
Definition: data.h:171
An Output is a physical output on your graphics driver.
Definition: data.h:360
Con * con
Pointer to the Con which represents this output.
Definition: data.h:380
A 'Window' is a type which contains an xcb_window_t and all the related information (hints like _NET_...
Definition: data.h:393
time_t managed_since
Definition: data.h:478
int max_height
Definition: data.h:465
int max_width
Definition: data.h:464
xcb_window_t id
Definition: data.h:394
int min_height
Definition: data.h:461
xcb_atom_t window_type
The _NET_WM_WINDOW_TYPE for this window.
Definition: data.h:431
bool doesnt_accept_focus
Whether this window accepts focus.
Definition: data.h:428
bool shaped
The window has a nonrectangular shape.
Definition: data.h:472
bool needs_take_focus
Whether the application needs to receive WM_TAKE_FOCUS.
Definition: data.h:424
enum Window::@13 dock
Whether the window says it is a dock window.
xcb_window_t transient_for
Definition: data.h:399
uint32_t wm_desktop
The _NET_WM_DESKTOP for this window.
Definition: data.h:434
struct reservedpx reserved
Pixels the window reserves.
Definition: data.h:445
xcb_window_t leader
Holds the xcb_window_t (just an ID) for the leader window (logical parent for toolwindows and similar...
Definition: data.h:398
uint16_t depth
Depth of the window.
Definition: data.h:448
int min_width
Definition: data.h:460
bool swallowed
Definition: data.h:481
A "match" is a data structure which acts like a mask or expression to match certain windows or not.
Definition: data.h:492
enum Match::@17 insert_where
bool restart_mode
Definition: data.h:544
An Assignment makes specific windows go to a specific workspace/output or run a command for that wind...
Definition: data.h:555
char * output
Definition: data.h:583
union Assignment::@19 dest
destination workspace/command/output, depending on the type
char * workspace
Definition: data.h:582
enum Assignment::@18 type
type of this assignment:
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition: data.h:604
struct Con * parent
Definition: data.h:636
int border_width
Definition: data.h:668
struct Rect rect
Definition: data.h:640
enum Con::@20 type
int current_border_width
Definition: data.h:669
bool sticky
Definition: data.h:692
enum Con::@21 floating
floating? (= not in tiling layout) This cannot be simply a bool because we want to keep track of whet...
bool mapped
Definition: data.h:605
struct Rect window_rect
Definition: data.h:643
struct Window * window
Definition: data.h:671
surface_t frame
Definition: data.h:619
char * name
Definition: data.h:650
struct Rect geometry
the geometry this window requested when getting mapped
Definition: data.h:648
uint16_t depth
Definition: data.h:748
xcb_drawable_t id
Definition: libi3.h:569