2 * vim:ts=4:sw=4:expandtab
7 /* Stores the X11 window ID of the currently focused window */
8 static xcb_window_t focused_id = XCB_NONE;
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().
18 typedef struct con_state {
23 /* For reparenting, we have a flag (need_reparent) and the X ID of the old
24 * frame this window was in. The latter is necessary because we need to
25 * ignore UnmapNotify events (by changing the window event mask). */
27 xcb_window_t old_frame;
36 CIRCLEQ_ENTRY(con_state) state;
37 CIRCLEQ_ENTRY(con_state) old_state;
40 CIRCLEQ_HEAD(state_head, con_state) state_head =
41 CIRCLEQ_HEAD_INITIALIZER(state_head);
43 CIRCLEQ_HEAD(old_state_head, con_state) old_state_head =
44 CIRCLEQ_HEAD_INITIALIZER(old_state_head);
47 * Returns the container state for the given frame. This function always
48 * returns a container state (otherwise, there is a bug in the code and the
49 * container state of a container for which x_con_init() was not called was
53 static con_state *state_for_frame(xcb_window_t window) {
55 CIRCLEQ_FOREACH(state, &state_head, state)
56 if (state->id == window)
59 /* TODO: better error handling? */
60 ELOG("No state found\n");
66 * Initializes the X11 part for the given container. Called exactly once for
67 * every container from con_new().
70 void x_con_init(Con *con) {
71 /* TODO: maybe create the window when rendering first? we could then even
72 * get the initial geometry right */
77 /* our own frames should not be managed */
78 mask |= XCB_CW_OVERRIDE_REDIRECT;
81 /* We want to know when… */
82 mask |= XCB_CW_EVENT_MASK;
83 values[1] = FRAME_EVENT_MASK;
85 Rect dims = { -15, -15, 10, 10 };
86 con->frame = create_window(conn, dims, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCURSOR_CURSOR_POINTER, false, mask, values);
87 con->gc = xcb_generate_id(conn);
88 xcb_create_gc(conn, con->gc, con->frame, 0, 0);
90 struct con_state *state = scalloc(sizeof(struct con_state));
91 state->id = con->frame;
92 state->mapped = false;
93 state->initial = true;
94 CIRCLEQ_INSERT_HEAD(&state_head, state, state);
95 CIRCLEQ_INSERT_HEAD(&old_state_head, state, old_state);
96 DLOG("adding new state for window id 0x%08x\n", state->id);
100 * Re-initializes the associated X window state for this container. You have
101 * to call this when you assign a client to an empty container to ensure that
102 * its state gets updated correctly.
105 void x_reinit(Con *con) {
106 struct con_state *state;
108 if ((state = state_for_frame(con->frame)) == NULL) {
109 ELOG("window state not found\n");
113 DLOG("resetting state %p to initial\n", state);
114 state->initial = true;
115 state->child_mapped = false;
116 memset(&(state->window_rect), 0, sizeof(Rect));
120 * Reparents the child window of the given container (necessary for sticky
121 * containers). The reparenting happens in the next call of x_push_changes().
124 void x_reparent_child(Con *con, Con *old) {
125 struct con_state *state;
126 if ((state = state_for_frame(con->frame)) == NULL) {
127 ELOG("window state for con not found\n");
131 state->need_reparent = true;
132 state->old_frame = old->frame;
136 * Moves a child window from Container src to Container dest.
139 void x_move_win(Con *src, Con *dest) {
140 struct con_state *state_src, *state_dest;
142 if ((state_src = state_for_frame(src->frame)) == NULL) {
143 ELOG("window state for src not found\n");
147 if ((state_dest = state_for_frame(dest->frame)) == NULL) {
148 ELOG("window state for dest not found\n");
152 Rect zero = { 0, 0, 0, 0 };
153 if (memcmp(&(state_dest->window_rect), &(zero), sizeof(Rect)) == 0) {
154 memcpy(&(state_dest->window_rect), &(state_src->window_rect), sizeof(Rect));
155 DLOG("COPYING RECT\n");
160 * Kills the window decoration associated with the given container.
163 void x_con_kill(Con *con) {
166 xcb_destroy_window(conn, con->frame);
167 state = state_for_frame(con->frame);
168 CIRCLEQ_REMOVE(&state_head, state, state);
169 CIRCLEQ_REMOVE(&old_state_head, state, old_state);
173 /* Invalidate focused_id to correctly focus new windows with the same ID */
174 focused_id = XCB_NONE;
178 * Returns true if the client supports the given protocol atom (like WM_DELETE_WINDOW)
181 static bool window_supports_protocol(xcb_window_t window, xcb_atom_t atom) {
182 xcb_get_property_cookie_t cookie;
183 xcb_get_wm_protocols_reply_t protocols;
186 cookie = xcb_get_wm_protocols_unchecked(conn, window, atoms[WM_PROTOCOLS]);
187 if (xcb_get_wm_protocols_reply(conn, cookie, &protocols, NULL) != 1)
190 /* Check if the client’s protocols have the requested atom set */
191 for (uint32_t i = 0; i < protocols.atoms_len; i++)
192 if (protocols.atoms[i] == atom)
195 xcb_get_wm_protocols_reply_wipe(&protocols);
201 * Kills the given X11 window using WM_DELETE_WINDOW (if supported).
204 void x_window_kill(xcb_window_t window) {
205 /* if this window does not support WM_DELETE_WINDOW, we kill it the hard way */
206 if (!window_supports_protocol(window, atoms[WM_DELETE_WINDOW])) {
207 LOG("Killing window the hard way\n");
208 xcb_kill_client(conn, window);
212 xcb_client_message_event_t ev;
214 memset(&ev, 0, sizeof(xcb_client_message_event_t));
216 ev.response_type = XCB_CLIENT_MESSAGE;
218 ev.type = atoms[WM_PROTOCOLS];
220 ev.data.data32[0] = atoms[WM_DELETE_WINDOW];
221 ev.data.data32[1] = XCB_CURRENT_TIME;
223 LOG("Sending WM_DELETE to the client\n");
224 xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char*)&ev);
229 * Draws the decoration of the given container onto its parent.
232 void x_draw_decoration(Con *con) {
233 /* This code needs to run for:
235 * • non-leaf containers which are in a stacked/tabbed container
237 * It does not need to run for:
238 * • floating containers (they don’t have a decoration)
240 if ((!con_is_leaf(con) &&
241 con->parent->layout != L_STACKED &&
242 con->parent->layout != L_TABBED) ||
243 con->type == CT_FLOATING_CON)
245 DLOG("decoration should be rendered for con %p\n", con);
247 /* 1: find out which colors to use */
248 struct Colortriple *color;
250 color = &config.client.urgent;
251 else if (con == focused)
252 color = &config.client.focused;
253 else if (con == TAILQ_FIRST(&(con->parent->focus_head)))
254 color = &config.client.focused_inactive;
256 color = &config.client.unfocused;
258 Con *parent = con->parent;
259 int border_style = con_border_style(con);
261 /* 2: draw a rectangle in border color around the client */
262 if (border_style != BS_NONE && con_is_leaf(con)) {
263 Rect br = con_border_style_rect(con);
264 Rect *r = &(con->rect);
266 DLOG("con->rect spans %d x %d\n", con->rect.width, con->rect.height);
267 DLOG("border_rect spans (%d, %d) with %d x %d\n", border_rect.x, border_rect.y, border_rect.width, border_rect.height);
268 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);
271 /* These rectangles represents the border around the child window
272 * (left, bottom and right part). We don’t just fill the whole
273 * rectangle because some childs are not freely resizable and we want
274 * their background color to "shine through". */
275 xcb_change_gc_single(conn, con->gc, XCB_GC_FOREGROUND, color->background);
276 xcb_rectangle_t borders[] = {
277 { 0, 0, br.x, r->height },
278 { 0, r->height + br.height + br.y, r->width, r->height },
279 { r->width + br.width + br.x, 0, r->width, r->height }
281 xcb_poly_fill_rectangle(conn, con->frame, con->gc, 3, borders);
282 /* 1pixel border needs an additional line at the top */
283 if (border_style == BS_1PIXEL) {
284 xcb_rectangle_t topline = { br.x, 0, con->rect.width + br.width + br.x, br.y };
285 xcb_poly_fill_rectangle(conn, con->frame, con->gc, 1, &topline);
289 /* if this is a borderless/1pixel window, we don’t * need to render the
291 if (border_style != BS_NORMAL) {
292 DLOG("border style not BS_NORMAL, aborting rendering of decoration\n");
296 /* 3: paint the bar */
297 xcb_change_gc_single(conn, parent->gc, XCB_GC_FOREGROUND, color->background);
298 xcb_rectangle_t drect = { con->deco_rect.x, con->deco_rect.y, con->deco_rect.width, con->deco_rect.height };
299 xcb_poly_fill_rectangle(conn, parent->frame, parent->gc, 1, &drect);
301 /* 4: draw the two lines in border color */
302 xcb_draw_line(conn, parent->frame, parent->gc, color->border,
303 con->deco_rect.x, /* x */
304 con->deco_rect.y, /* y */
305 con->deco_rect.x + con->deco_rect.width, /* to_x */
306 con->deco_rect.y); /* to_y */
307 xcb_draw_line(conn, parent->frame, parent->gc, color->border,
308 con->deco_rect.x, /* x */
309 con->deco_rect.y + con->deco_rect.height - 1, /* y */
310 con->deco_rect.x + con->deco_rect.width, /* to_x */
311 con->deco_rect.y + con->deco_rect.height - 1); /* to_y */
313 /* 5: draw the title */
314 i3Font *font = load_font(conn, config.font);
315 uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
316 uint32_t values[] = { color->text, color->background, font->id };
317 xcb_change_gc(conn, parent->gc, mask, values);
318 int text_offset_y = font->height + (con->deco_rect.height - font->height) / 2 - 1;
320 struct Window *win = con->window;
321 if (win == NULL || win->name_x == NULL) {
322 /* this is a non-leaf container, we need to make up a good description */
323 // TODO: use a good description instead of just "another container"
326 strlen("another container"),
329 con->deco_rect.x + 2,
330 con->deco_rect.y + text_offset_y,
336 int indent_level = 0,
338 Con *il_parent = con->parent;
339 if (il_parent->layout != L_STACKED) {
341 DLOG("il_parent = %p, layout = %d\n", il_parent, il_parent->layout);
342 if (il_parent->layout == L_STACKED)
344 if (il_parent->type == CT_WORKSPACE || il_parent->type == CT_DOCKAREA || il_parent->type == CT_OUTPUT)
346 il_parent = il_parent->parent;
350 DLOG("indent_level = %d, indent_mult = %d\n", indent_level, indent_mult);
351 int indent_px = (indent_level * 5) * indent_mult;
353 if (win->uses_net_wm_name)
359 con->deco_rect.x + 2 + indent_px,
360 con->deco_rect.y + text_offset_y,
361 (xcb_char2b_t*)win->name_x
369 con->deco_rect.x + 2 + indent_px,
370 con->deco_rect.y + text_offset_y,
376 * This function pushes the properties of each node of the layout tree to
377 * X11 if they have changed (like the map state, position of the window, …).
378 * It recursively traverses all children of the given node.
381 static void x_push_node(Con *con) {
384 Rect rect = con->rect;
386 DLOG("Pushing changes for node %p / %s\n", con, con->name);
387 state = state_for_frame(con->frame);
389 if (state->name != NULL) {
390 DLOG("pushing name %s for con %p\n", state->name, con);
392 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->frame,
393 WM_NAME, STRING, 8, strlen(state->name), state->name);
397 if (con->window == NULL) {
398 /* Calculate the height of all window decorations which will be drawn on to
400 uint32_t max_y = 0, max_height = 0;
401 TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
402 Rect *dr = &(current->deco_rect);
403 if (dr->y >= max_y && dr->height >= max_height) {
405 max_height = dr->height;
408 rect.height = max_y + max_height;
409 if (rect.height == 0) {
410 DLOG("Unmapping container because it does not contain anything atm.\n");
415 /* reparent the child window (when the window was moved due to a sticky
417 if (state->need_reparent && con->window != NULL) {
418 DLOG("Reparenting child window\n");
420 /* Temporarily set the event masks to XCB_NONE so that we won’t get
421 * UnmapNotify events (otherwise the handler would close the container).
422 * These events are generated automatically when reparenting. */
423 uint32_t values[] = { XCB_NONE };
424 xcb_change_window_attributes(conn, state->old_frame, XCB_CW_EVENT_MASK, values);
425 xcb_change_window_attributes(conn, con->window->id, XCB_CW_EVENT_MASK, values);
427 xcb_reparent_window(conn, con->window->id, con->frame, 0, 0);
429 values[0] = FRAME_EVENT_MASK;
430 xcb_change_window_attributes(conn, state->old_frame, XCB_CW_EVENT_MASK, values);
431 values[0] = CHILD_EVENT_MASK;
432 xcb_change_window_attributes(conn, con->window->id, XCB_CW_EVENT_MASK, values);
434 state->old_frame = XCB_NONE;
435 state->need_reparent = false;
438 DLOG("ignore_unmap for reparenting of con %p (win 0x%08x) is now %d\n",
439 con, con->window->id, con->ignore_unmap);
442 bool fake_notify = false;
443 /* set new position if rect changed */
444 if (memcmp(&(state->rect), &rect, sizeof(Rect)) != 0) {
445 DLOG("setting rect (%d, %d, %d, %d)\n", rect.x, rect.y, rect.width, rect.height);
446 xcb_set_window_rect(conn, con->frame, rect);
447 memcpy(&(state->rect), &rect, sizeof(Rect));
451 /* dito, but for child windows */
452 if (con->window != NULL &&
453 memcmp(&(state->window_rect), &(con->window_rect), sizeof(Rect)) != 0) {
454 DLOG("setting window rect (%d, %d, %d, %d)\n",
455 con->window_rect.x, con->window_rect.y, con->window_rect.width, con->window_rect.height);
456 xcb_set_window_rect(conn, con->window->id, con->window_rect);
457 memcpy(&(state->window_rect), &(con->window_rect), sizeof(Rect));
461 /* Map if map state changed, also ensure that the child window
462 * is changed if we are mapped *and* in initial state (meaning the
463 * container was empty before, but now got a child). Unmaps are handled in
464 * x_push_node_unmaps(). */
465 if ((state->mapped != con->mapped || (con->mapped && state->initial)) &&
467 xcb_void_cookie_t cookie;
469 if (con->window != NULL) {
470 /* Set WM_STATE_NORMAL because GTK applications don’t want to
471 * drag & drop if we don’t. Also, xprop(1) needs it. */
472 long data[] = { XCB_WM_STATE_NORMAL, XCB_NONE };
473 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
474 atoms[WM_STATE], atoms[WM_STATE], 32, 2, data);
477 if (!state->child_mapped && con->window != NULL) {
478 cookie = xcb_map_window(conn, con->window->id);
479 DLOG("mapping child window (serial %d)\n", cookie.sequence);
480 /* Ignore enter_notifies which are generated when mapping */
481 add_ignore_event(cookie.sequence);
482 state->child_mapped = true;
485 cookie = xcb_map_window(conn, con->frame);
486 DLOG("mapping container (serial %d)\n", cookie.sequence);
487 /* Ignore enter_notifies which are generated when mapping */
488 add_ignore_event(cookie.sequence);
489 state->mapped = con->mapped;
493 DLOG("Sending fake configure notify\n");
494 fake_absolute_configure_notify(con);
497 /* handle all children and floating windows of this node */
498 TAILQ_FOREACH(current, &(con->nodes_head), nodes)
499 x_push_node(current);
501 TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
502 x_push_node(current);
504 if (con->type != CT_ROOT && con->type != CT_OUTPUT)
505 x_draw_decoration(con);
509 * Same idea as in x_push_node(), but this function only unmaps windows. It is
510 * necessary to split this up to handle new fullscreen clients properly: The
511 * new window needs to be mapped and focus needs to be set *before* the
512 * underlying windows are unmapped. Otherwise, focus will revert to the
513 * PointerRoot and will then be set to the new window, generating unnecessary
514 * FocusIn/FocusOut events.
517 static void x_push_node_unmaps(Con *con) {
521 DLOG("Pushing changes (with unmaps) for node %p / %s\n", con, con->name);
522 state = state_for_frame(con->frame);
524 /* map/unmap if map state changed, also ensure that the child window
525 * is changed if we are mapped *and* in initial state (meaning the
526 * container was empty before, but now got a child) */
527 if ((state->mapped != con->mapped || (con->mapped && state->initial)) &&
529 xcb_void_cookie_t cookie;
530 if (con->window != NULL) {
531 /* Set WM_STATE_WITHDRAWN, it seems like Java apps need it */
532 long data[] = { XCB_WM_STATE_WITHDRAWN, XCB_NONE };
533 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
534 atoms[WM_STATE], atoms[WM_STATE], 32, 2, data);
537 cookie = xcb_unmap_window(conn, con->frame);
538 DLOG("unmapping container (serial %d)\n", cookie.sequence);
539 /* we need to increase ignore_unmap for this container (if it
540 * contains a window) and for every window "under" this one which
541 * contains a window */
542 if (con->window != NULL) {
544 DLOG("ignore_unmap for con %p (frame 0x%08x) now %d\n", con, con->frame, con->ignore_unmap);
546 /* Ignore enter_notifies which are generated when unmapping */
547 add_ignore_event(cookie.sequence);
548 state->mapped = con->mapped;
551 /* handle all children and floating windows of this node */
552 TAILQ_FOREACH(current, &(con->nodes_head), nodes)
553 x_push_node_unmaps(current);
555 TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
556 x_push_node_unmaps(current);
560 * Pushes all changes (state of each node, see x_push_node() and the window
563 * NOTE: We need to push the stack first so that the windows have the correct
564 * stacking order. This is relevant for workspace switching where we map the
565 * windows because mapping may generate EnterNotify events. When they are
566 * generated in the wrong order, this will cause focus problems when switching
570 void x_push_changes(Con *con) {
573 DLOG("-- PUSHING WINDOW STACK --\n");
574 DLOG("Disabling EnterNotify\n");
575 uint32_t values[1] = { XCB_NONE };
576 CIRCLEQ_FOREACH_REVERSE(state, &state_head, state) {
577 xcb_change_window_attributes(conn, state->id, XCB_CW_EVENT_MASK, values);
579 DLOG("Done, EnterNotify disabled\n");
580 bool order_changed = false;
581 /* X11 correctly represents the stack if we push it from bottom to top */
582 CIRCLEQ_FOREACH_REVERSE(state, &state_head, state) {
583 DLOG("stack: 0x%08x\n", state->id);
584 con_state *prev = CIRCLEQ_PREV(state, state);
585 con_state *old_prev = CIRCLEQ_PREV(state, old_state);
586 if (prev != old_prev)
587 order_changed = true;
588 if ((state->initial || order_changed) && prev != CIRCLEQ_END(&state_head)) {
589 DLOG("Stacking 0x%08x above 0x%08x\n", prev->id, state->id);
591 mask |= XCB_CONFIG_WINDOW_SIBLING;
592 mask |= XCB_CONFIG_WINDOW_STACK_MODE;
593 uint32_t values[] = {state->id, XCB_STACK_MODE_ABOVE};
595 xcb_configure_window(conn, prev->id, mask, values);
597 state->initial = false;
599 DLOG("Re-enabling EnterNotify\n");
600 values[0] = FRAME_EVENT_MASK;
601 CIRCLEQ_FOREACH_REVERSE(state, &state_head, state) {
602 xcb_change_window_attributes(conn, state->id, XCB_CW_EVENT_MASK, values);
604 DLOG("Done, EnterNotify re-enabled\n");
606 DLOG("\n\n PUSHING CHANGES\n\n");
609 xcb_window_t to_focus = focused->frame;
610 if (focused->window != NULL)
611 to_focus = focused->window->id;
613 DLOG("focused_id = 0x%08x, to_focus = 0x%08x\n", focused_id, to_focus);
614 if (focused_id != to_focus) {
615 if (!focused->mapped) {
616 DLOG("Not updating focus (to %p / %s), focused window is not mapped.\n", focused, focused->name);
618 DLOG("Updating focus (focused: %p / %s)\n", focused, focused->name);
619 xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, to_focus, XCB_CURRENT_TIME);
620 focused_id = to_focus;
625 DLOG("\n\n ENDING CHANGES\n\n");
627 x_push_node_unmaps(con);
629 /* save the current stack as old stack */
630 CIRCLEQ_FOREACH(state, &state_head, state) {
631 CIRCLEQ_REMOVE(&old_state_head, state, old_state);
632 CIRCLEQ_INSERT_TAIL(&old_state_head, state, old_state);
634 CIRCLEQ_FOREACH(state, &old_state_head, old_state) {
635 DLOG("old stack: 0x%08x\n", state->id);
640 * Raises the specified container in the internal stack of X windows. The
641 * next call to x_push_changes() will make the change visible in X11.
644 void x_raise_con(Con *con) {
646 state = state_for_frame(con->frame);
647 DLOG("raising in new stack: %p / %s / %s / xid %08x\n", con, con->name, con->window ? con->window->name_json : "", state->id);
649 CIRCLEQ_REMOVE(&state_head, state, state);
650 CIRCLEQ_INSERT_HEAD(&state_head, state, state);
654 * Sets the WM_NAME property (so, no UTF8, but used only for debugging anyways)
655 * of the given name. Used for properly tagging the windows for easily spotting
656 * i3 windows in xwininfo -root -all.
659 void x_set_name(Con *con, const char *name) {
660 struct con_state *state;
662 if ((state = state_for_frame(con->frame)) == NULL) {
663 ELOG("window state not found\n");
668 state->name = sstrdup(name);