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