git.sur5r.net Git - i3/i3/blob - src/manage.c

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