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

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  */
   4
   5 #include "all.h"
   6
   7 /* Stores the X11 window ID of the currently focused window */
   8 static xcb_window_t focused_id = XCB_NONE;
   9
  10 /*
  11  * Describes the X11 state we may modify (map state, position, window stack).
  12  * There is one entry per container. The state represents the current situation
  13  * as X11 sees it (with the exception of the order in the state_head CIRCLEQ,
  14  * which represents the order that will be pushed to X11, while old_state_head
  15  * represents the current order). It will be updated in x_push_changes().
  16  *
  17  */
  18 typedef struct con_state {
  19     xcb_window_t id;
  20     bool mapped;
  21
  22     /* For reparenting, we have a flag (need_reparent) and the X ID of the old
  23      * frame this window was in. The latter is necessary because we need to
  24      * ignore UnmapNotify events (by changing the window event mask). */
  25     bool need_reparent;
  26     xcb_window_t old_frame;
  27
  28     Rect rect;
  29     Rect window_rect;
  30
  31     bool initial;
  32
  33     char *name;
  34
  35     CIRCLEQ_ENTRY(con_state) state;
  36     CIRCLEQ_ENTRY(con_state) old_state;
  37 } con_state;
  38
  39 CIRCLEQ_HEAD(state_head, con_state) state_head =
  40     CIRCLEQ_HEAD_INITIALIZER(state_head);
  41
  42 CIRCLEQ_HEAD(old_state_head, con_state) old_state_head =
  43     CIRCLEQ_HEAD_INITIALIZER(old_state_head);
  44
  45 /*
  46  * Returns the container state for the given frame. This function always
  47  * returns a container state (otherwise, there is a bug in the code and the
  48  * container state of a container for which x_con_init() was not called was
  49  * requested).
  50  *
  51  */
  52 static con_state *state_for_frame(xcb_window_t window) {
  53     con_state *state;
  54     CIRCLEQ_FOREACH(state, &state_head, state)
  55         if (state->id == window)
  56             return state;
  57
  58     /* TODO: better error handling? */
  59     ELOG("No state found\n");
  60     assert(false);
  61     return NULL;
  62 }
  63
  64 /*
  65  * Initializes the X11 part for the given container. Called exactly once for
  66  * every container from con_new().
  67  *
  68  */
  69 void x_con_init(Con *con) {
  70     /* TODO: maybe create the window when rendering first? we could then even
  71      * get the initial geometry right */
  72
  73     uint32_t mask = 0;
  74     uint32_t values[2];
  75
  76     /* our own frames should not be managed */
  77     mask |= XCB_CW_OVERRIDE_REDIRECT;
  78     values[0] = 1;
  79
  80     /* We want to know when… */
  81     mask |= XCB_CW_EVENT_MASK;
  82     values[1] = FRAME_EVENT_MASK;
  83
  84     Rect dims = { -15, -15, 10, 10 };
  85     con->frame = create_window(conn, dims, XCB_WINDOW_CLASS_INPUT_OUTPUT, -1, false, mask, values);
  86     con->gc = xcb_generate_id(conn);
  87     xcb_create_gc(conn, con->gc, con->frame, 0, 0);
  88
  89     struct con_state *state = scalloc(sizeof(struct con_state));
  90     state->id = con->frame;
  91     state->mapped = false;
  92     state->initial = true;
  93     CIRCLEQ_INSERT_HEAD(&state_head, state, state);
  94     CIRCLEQ_INSERT_HEAD(&old_state_head, state, old_state);
  95     LOG("adding new state for window id 0x%08x\n", state->id);
  96 }
  97
  98 /*
  99  * Re-initializes the associated X window state for this container. You have
 100  * to call this when you assign a client to an empty container to ensure that
 101  * its state gets updated correctly.
 102  *
 103  */
 104 void x_reinit(Con *con) {
 105     struct con_state *state;
 106
 107     if ((state = state_for_frame(con->frame)) == NULL) {
 108         ELOG("window state not found\n");
 109         return;
 110     }
 111
 112     LOG("resetting state %p to initial\n", state);
 113     state->initial = true;
 114     memset(&(state->window_rect), 0, sizeof(Rect));
 115 }
 116
 117 /*
 118  * Reparents the child window of the given container (necessary for sticky
 119  * containers). The reparenting happens in the next call of x_push_changes().
 120  *
 121  */
 122 void x_reparent_child(Con *con, Con *old) {
 123     struct con_state *state;
 124     if ((state = state_for_frame(con->frame)) == NULL) {
 125         ELOG("window state for con not found\n");
 126         return;
 127     }
 128
 129     state->need_reparent = true;
 130     state->old_frame = old->frame;
 131 }
 132
 133 /*
 134  * Moves a child window from Container src to Container dest.
 135  *
 136  */
 137 void x_move_win(Con *src, Con *dest) {
 138     struct con_state *state_src, *state_dest;
 139
 140     if ((state_src = state_for_frame(src->frame)) == NULL) {
 141         ELOG("window state for src not found\n");
 142         return;
 143     }
 144
 145     if ((state_dest = state_for_frame(dest->frame)) == NULL) {
 146         ELOG("window state for dest not found\n");
 147         return;
 148     }
 149
 150     Rect zero;
 151     memset(&zero, 0, sizeof(Rect));
 152     if (memcmp(&(state_dest->window_rect), &(zero), sizeof(Rect)) == 0) {
 153         memcpy(&(state_dest->window_rect), &(state_src->window_rect), sizeof(Rect));
 154         LOG("COPYING RECT\n");
 155     }
 156 }
 157
 158 /*
 159  * Kills the window decoration associated with the given container.
 160  *
 161  */
 162 void x_con_kill(Con *con) {
 163     con_state *state;
 164
 165     xcb_destroy_window(conn, con->frame);
 166     state = state_for_frame(con->frame);
 167     CIRCLEQ_REMOVE(&state_head, state, state);
 168     CIRCLEQ_REMOVE(&old_state_head, state, old_state);
 169 }
 170
 171 /*
 172  * Returns true if the client supports the given protocol atom (like WM_DELETE_WINDOW)
 173  *
 174  */
 175 static bool window_supports_protocol(xcb_window_t window, xcb_atom_t atom) {
 176     xcb_get_property_cookie_t cookie;
 177     xcb_get_wm_protocols_reply_t protocols;
 178     bool result = false;
 179
 180     cookie = xcb_get_wm_protocols_unchecked(conn, window, atoms[WM_PROTOCOLS]);
 181     if (xcb_get_wm_protocols_reply(conn, cookie, &protocols, NULL) != 1)
 182         return false;
 183
 184     /* Check if the client’s protocols have the requested atom set */
 185     for (uint32_t i = 0; i < protocols.atoms_len; i++)
 186         if (protocols.atoms[i] == atom)
 187             result = true;
 188
 189     xcb_get_wm_protocols_reply_wipe(&protocols);
 190
 191     return result;
 192 }
 193
 194 /*
 195  * Kills the given X11 window using WM_DELETE_WINDOW (if supported).
 196  *
 197  */
 198 void x_window_kill(xcb_window_t window) {
 199     /* if this window does not support WM_DELETE_WINDOW, we kill it the hard way */
 200     if (!window_supports_protocol(window, atoms[WM_DELETE_WINDOW])) {
 201         LOG("Killing window the hard way\n");
 202         xcb_kill_client(conn, window);
 203         return;
 204     }
 205
 206     xcb_client_message_event_t ev;
 207
 208     memset(&ev, 0, sizeof(xcb_client_message_event_t));
 209
 210     ev.response_type = XCB_CLIENT_MESSAGE;
 211     ev.window = window;
 212     ev.type = atoms[WM_PROTOCOLS];
 213     ev.format = 32;
 214     ev.data.data32[0] = atoms[WM_DELETE_WINDOW];
 215     ev.data.data32[1] = XCB_CURRENT_TIME;
 216
 217     LOG("Sending WM_DELETE to the client\n");
 218     xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char*)&ev);
 219     xcb_flush(conn);
 220 }
 221
 222 /*
 223  * Draws the decoration of the given container onto its parent.
 224  *
 225  */
 226 void x_draw_decoration(Con *con) {
 227     /* this code needs to run for:
 228      *  • leaf containers
 229      *  • non-leaf containers which are in a stacking container
 230      */
 231     if (!con_is_leaf(con) && con->parent->layout != L_STACKED)
 232         return;
 233     DLOG("decoration should be rendered for con %p\n", con);
 234
 235     /* 1: find out which colors to use */
 236     struct Colortriple *color;
 237     if (con->urgent)
 238         color = &config.client.urgent;
 239     else if (con == focused)
 240         color = &config.client.focused;
 241     else if (con == TAILQ_FIRST(&(con->parent->focus_head)))
 242         color = &config.client.focused_inactive;
 243     else
 244         color = &config.client.unfocused;
 245
 246     Con *parent = con->parent;
 247     int border_style = con_border_style(con);
 248
 249     /* 2: draw a rectangle in border color around the client */
 250     if (border_style != BS_NONE && con_is_leaf(con)) {
 251         Rect br = con_border_style_rect(con);
 252         Rect *r = &(con->rect);
 253 #if 0
 254         DLOG("con->rect spans %d x %d\n", con->rect.width, con->rect.height);
 255         DLOG("border_rect spans (%d, %d) with %d x %d\n", border_rect.x, border_rect.y, border_rect.width, border_rect.height);
 256         DLOG("window_rect spans (%d, %d) with %d x %d\n", con->window_rect.x, con->window_rect.y, con->window_rect.width, con->window_rect.height);
 257 #endif
 258
 259         /* These rectangles represents the border around the child window
 260          * (left, bottom and right part). We don’t just fill the whole
 261          * rectangle because some childs are not freely resizable and we want
 262          * their background color to "shine through". */
 263         xcb_change_gc_single(conn, con->gc, XCB_GC_FOREGROUND, color->background);
 264         xcb_rectangle_t borders[] = {
 265             { 0, 0, br.x, r->height },
 266             { 0, r->height + br.height + br.y, r->width, r->height },
 267             { r->width + br.width + br.x, 0, r->width, r->height }
 268         };
 269         xcb_poly_fill_rectangle(conn, con->frame, con->gc, 3, borders);
 270         /* 1pixel border needs an additional line at the top */
 271         if (border_style == BS_1PIXEL) {
 272             xcb_rectangle_t topline = { br.x, 0, con->rect.width + br.width + br.x, br.y };
 273             xcb_poly_fill_rectangle(conn, con->frame, con->gc, 1, &topline);
 274         }
 275     }
 276
 277     /* if this is a borderless/1pixel window, we don’t * need to render the
 278      * decoration. */
 279     if (border_style != BS_NORMAL) {
 280         DLOG("border style not BS_NORMAL, aborting rendering of decoration\n");
 281         return;
 282     }
 283
 284     /* 3: paint the bar */
 285     xcb_change_gc_single(conn, parent->gc, XCB_GC_FOREGROUND, color->background);
 286     xcb_rectangle_t drect = { con->deco_rect.x, con->deco_rect.y, con->deco_rect.width, con->deco_rect.height };
 287     xcb_poly_fill_rectangle(conn, parent->frame, parent->gc, 1, &drect);
 288
 289     /* 4: draw the two lines in border color */
 290     xcb_draw_line(conn, parent->frame, parent->gc, color->border,
 291             con->deco_rect.x, /* x */
 292             con->deco_rect.y, /* y */
 293             con->deco_rect.x + con->deco_rect.width, /* to_x */
 294             con->deco_rect.y); /* to_y */
 295     xcb_draw_line(conn, parent->frame, parent->gc, color->border,
 296             con->deco_rect.x, /* x */
 297             con->deco_rect.y + con->deco_rect.height - 1, /* y */
 298             con->deco_rect.x + con->deco_rect.width, /* to_x */
 299             con->deco_rect.y + con->deco_rect.height - 1); /* to_y */
 300
 301     /* 5: draw the title */
 302     i3Font *font = load_font(conn, config.font);
 303     uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
 304     uint32_t values[] = { color->text, color->background, font->id };
 305     xcb_change_gc(conn, parent->gc, mask, values);
 306     int text_offset_y = font->height + (con->deco_rect.height - font->height) / 2 - 1;
 307
 308     struct Window *win = con->window;
 309     if (win == NULL || win->name_x == NULL) {
 310         /* this is a non-leaf container, we need to make up a good description */
 311         // TODO: use a good description instead of just "another container"
 312         xcb_image_text_8(
 313             conn,
 314             strlen("another container"),
 315             parent->frame,
 316             parent->gc,
 317             con->deco_rect.x + 2,
 318             con->deco_rect.y + text_offset_y,
 319             "another container"
 320         );
 321         return;
 322     }
 323
 324     int indent_level = 0,
 325         indent_mult = 0;
 326     Con *il_parent = con->parent;
 327     if (il_parent->type != L_STACKED) {
 328         while (1) {
 329             DLOG("il_parent = %p, layout = %d\n", il_parent, il_parent->layout);
 330             if (il_parent->layout == L_STACKED)
 331                 indent_level++;
 332             if (il_parent->type == CT_WORKSPACE)
 333                 break;
 334             il_parent = il_parent->parent;
 335             indent_mult++;
 336         }
 337     }
 338     DLOG("indent_level = %d, indent_mult = %d\n", indent_level, indent_mult);
 339     int indent_px = (indent_level * 5) * indent_mult;
 340
 341     if (win->uses_net_wm_name)
 342         xcb_image_text_16(
 343             conn,
 344             win->name_len,
 345             parent->frame,
 346             parent->gc,
 347             con->deco_rect.x + 2 + indent_px,
 348             con->deco_rect.y + text_offset_y,
 349             (xcb_char2b_t*)win->name_x
 350         );
 351     else
 352         xcb_image_text_8(
 353             conn,
 354             win->name_len,
 355             parent->frame,
 356             parent->gc,
 357             con->deco_rect.x + 2 + indent_px,
 358             con->deco_rect.y + text_offset_y,
 359             win->name_x
 360         );
 361 }
 362
 363 /*
 364  * This function pushes the properties of each node of the layout tree to
 365  * X11 if they have changed (like the map state, position of the window, …).
 366  * It recursively traverses all children of the given node.
 367  *
 368  */
 369 static void x_push_node(Con *con) {
 370     Con *current;
 371     con_state *state;
 372     Rect rect = con->rect;
 373
 374     LOG("Pushing changes for node %p / %s\n", con, con->name);
 375     state = state_for_frame(con->frame);
 376
 377     if (state->name != NULL) {
 378         DLOG("pushing name %s for con %p\n", state->name, con);
 379
 380         xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->frame,
 381                             WM_NAME, STRING, 8, strlen(state->name), state->name);
 382         FREE(state->name);
 383     }
 384
 385     if (con->window == NULL) {
 386         /* Calculate the height of all window decorations which will be drawn on to
 387          * this frame. */
 388         uint32_t max_y = 0, max_height = 0;
 389         TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
 390             DLOG("Child's decoration is %d x %d, from (%d, %d)\n",
 391                     current->deco_rect.width, current->deco_rect.height,
 392                     current->deco_rect.x, current->deco_rect.y);
 393             Rect *dr = &(current->deco_rect);
 394             if (dr->y >= max_y && dr->height >= max_height) {
 395                 max_y = dr->y;
 396                 max_height = dr->height;
 397             }
 398         }
 399         DLOG("bottom of decorations is %d\n", max_y + max_height);
 400         rect.height = max_y + max_height;
 401         if (rect.height == 0) {
 402             DLOG("Unmapping container because it does not contain anything atm.\n");
 403             con->mapped = false;
 404         }
 405     }
 406
 407     /* reparent the child window (when the window was moved due to a sticky
 408      * container) */
 409     if (state->need_reparent && con->window != NULL) {
 410         LOG("Reparenting child window\n");
 411
 412         /* Temporarily set the event masks to XCB_NONE so that we won’t get
 413          * UnmapNotify events (otherwise the handler would close the container).
 414          * These events are generated automatically when reparenting. */
 415         uint32_t values[] = { XCB_NONE };
 416         xcb_change_window_attributes(conn, state->old_frame, XCB_CW_EVENT_MASK, values);
 417         xcb_change_window_attributes(conn, con->window->id, XCB_CW_EVENT_MASK, values);
 418
 419         xcb_reparent_window(conn, con->window->id, con->frame, 0, 0);
 420
 421         values[0] = FRAME_EVENT_MASK;
 422         xcb_change_window_attributes(conn, state->old_frame, XCB_CW_EVENT_MASK, values);
 423         values[0] = CHILD_EVENT_MASK;
 424         xcb_change_window_attributes(conn, con->window->id, XCB_CW_EVENT_MASK, values);
 425
 426         state->old_frame = XCB_NONE;
 427         state->need_reparent = false;
 428     }
 429
 430     /* map/unmap if map state changed, also ensure that the child window
 431      * is changed if we are mapped *and* in initial state (meaning the
 432      * container was empty before, but now got a child) */
 433     if (state->mapped != con->mapped || (con->mapped && state->initial)) {
 434         if (!con->mapped) {
 435             xcb_void_cookie_t cookie;
 436             if (con->window != NULL) {
 437                 /* Set WM_STATE_WITHDRAWN, it seems like Java apps need it */
 438                 long data[] = { XCB_WM_STATE_WITHDRAWN, XCB_NONE };
 439                 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
 440                                     atoms[WM_STATE], atoms[WM_STATE], 32, 2, data);
 441             }
 442
 443             cookie = xcb_unmap_window(conn, con->frame);
 444             LOG("unmapping container (serial %d)\n", cookie.sequence);
 445             /* Ignore enter_notifies which are generated when unmapping */
 446             add_ignore_event(cookie.sequence);
 447         } else {
 448             xcb_void_cookie_t cookie;
 449
 450             if (con->window != NULL) {
 451                 /* Set WM_STATE_NORMAL because GTK applications don’t want to
 452                  * drag & drop if we don’t. Also, xprop(1) needs it. */
 453                 long data[] = { XCB_WM_STATE_NORMAL, XCB_NONE };
 454                 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
 455                                     atoms[WM_STATE], atoms[WM_STATE], 32, 2, data);
 456             }
 457
 458             if (state->initial && con->window != NULL) {
 459                 cookie = xcb_map_window(conn, con->window->id);
 460                 LOG("mapping child window (serial %d)\n", cookie.sequence);
 461                 /* Ignore enter_notifies which are generated when mapping */
 462                 add_ignore_event(cookie.sequence);
 463             }
 464
 465             cookie = xcb_map_window(conn, con->frame);
 466             LOG("mapping container (serial %d)\n", cookie.sequence);
 467             /* Ignore enter_notifies which are generated when mapping */
 468             add_ignore_event(cookie.sequence);
 469         }
 470         state->mapped = con->mapped;
 471     }
 472
 473     bool fake_notify = false;
 474     /* set new position if rect changed */
 475     if (memcmp(&(state->rect), &rect, sizeof(Rect)) != 0) {
 476         LOG("setting rect (%d, %d, %d, %d)\n", rect.x, rect.y, rect.width, rect.height);
 477         xcb_set_window_rect(conn, con->frame, rect);
 478         memcpy(&(state->rect), &rect, sizeof(Rect));
 479         fake_notify = true;
 480     }
 481
 482     /* dito, but for child windows */
 483     if (con->window != NULL &&
 484         memcmp(&(state->window_rect), &(con->window_rect), sizeof(Rect)) != 0) {
 485         LOG("setting window rect (%d, %d, %d, %d)\n",
 486             con->window_rect.x, con->window_rect.y, con->window_rect.width, con->window_rect.height);
 487         xcb_set_window_rect(conn, con->window->id, con->window_rect);
 488         memcpy(&(state->rect), &(con->rect), sizeof(Rect));
 489         fake_notify = true;
 490     }
 491
 492     if (fake_notify) {
 493         LOG("Sending fake configure notify\n");
 494         fake_absolute_configure_notify(con);
 495     }
 496
 497     /* handle all children and floating windows of this node */
 498     TAILQ_FOREACH(current, &(con->nodes_head), nodes)
 499         x_push_node(current);
 500
 501     TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
 502         x_push_node(current);
 503
 504     if (con->type != CT_ROOT && con->type != CT_OUTPUT)
 505         x_draw_decoration(con);
 506 }
 507
 508 /*
 509  * Pushes all changes (state of each node, see x_push_node() and the window
 510  * stack) to X11.
 511  *
 512  */
 513 void x_push_changes(Con *con) {
 514     con_state *state;
 515
 516     LOG("\n\n PUSHING CHANGES\n\n");
 517     x_push_node(con);
 518
 519     LOG("-- PUSHING WINDOW STACK --\n");
 520     bool order_changed = false;
 521     /* X11 correctly represents the stack if we push it from bottom to top */
 522     CIRCLEQ_FOREACH_REVERSE(state, &state_head, state) {
 523         LOG("stack: 0x%08x\n", state->id);
 524         con_state *prev = CIRCLEQ_PREV(state, state);
 525         con_state *old_prev = CIRCLEQ_PREV(state, old_state);
 526         if (prev != old_prev)
 527             order_changed = true;
 528         if ((state->initial || order_changed) && prev != CIRCLEQ_END(&state_head)) {
 529             state->initial = false;
 530             LOG("Stacking 0x%08x above 0x%08x\n", prev->id, state->id);
 531             uint32_t mask = 0;
 532             mask |= XCB_CONFIG_WINDOW_SIBLING;
 533             mask |= XCB_CONFIG_WINDOW_STACK_MODE;
 534             uint32_t values[] = {state->id, XCB_STACK_MODE_ABOVE};
 535
 536             xcb_configure_window(conn, prev->id, mask, values);
 537         }
 538     }
 539
 540     xcb_window_t to_focus = focused->frame;
 541     if (focused->window != NULL)
 542         to_focus = focused->window->id;
 543
 544     if (focused_id != to_focus) {
 545         LOG("Updating focus (focused: %p / %s)\n", focused, focused->name);
 546         xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, to_focus, XCB_CURRENT_TIME);
 547     }
 548
 549     xcb_flush(conn);
 550     LOG("\n\n ENDING CHANGES\n\n");
 551
 552     /* save the current stack as old stack */
 553     CIRCLEQ_FOREACH(state, &state_head, state) {
 554         CIRCLEQ_REMOVE(&old_state_head, state, old_state);
 555         CIRCLEQ_INSERT_TAIL(&old_state_head, state, old_state);
 556     }
 557     CIRCLEQ_FOREACH(state, &old_state_head, old_state) {
 558         LOG("old stack: 0x%08x\n", state->id);
 559     }
 560 }
 561
 562 /*
 563  * Raises the specified container in the internal stack of X windows. The
 564  * next call to x_push_changes() will make the change visible in X11.
 565  *
 566  */
 567 void x_raise_con(Con *con) {
 568     con_state *state;
 569     LOG("raising in new stack: %p / %s\n", con, con->name);
 570     state = state_for_frame(con->frame);
 571
 572     LOG("found state entry, moving to top\n");
 573     CIRCLEQ_REMOVE(&state_head, state, state);
 574     CIRCLEQ_INSERT_HEAD(&state_head, state, state);
 575 }
 576
 577 /*
 578  * Sets the WM_NAME property (so, no UTF8, but used only for debugging anyways)
 579  * of the given name. Used for properly tagging the windows for easily spotting
 580  * i3 windows in xwininfo -root -all.
 581  *
 582  */
 583 void x_set_name(Con *con, const char *name) {
 584     struct con_state *state;
 585
 586     if ((state = state_for_frame(con->frame)) == NULL) {
 587         ELOG("window state not found\n");
 588         return;
 589     }
 590
 591     FREE(state->name);
 592     state->name = sstrdup(name);
 593 }