]> git.sur5r.net Git - i3/i3/blob - src/x.c
Add configuration option for disabling mouse warping
[i3/i3] / src / x.c
1 #undef I3__FILE__
2 #define I3__FILE__ "x.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  * x.c: Interface to X11, transfers our in-memory state to X11 (see also
10  *      render.c). Basically a big state machine.
11  *
12  */
13 #include "all.h"
14
15 /* Stores the X11 window ID of the currently focused window */
16 xcb_window_t focused_id = XCB_NONE;
17
18 /* Because 'focused_id' might be reset to force input focus (after click to
19  * raise), we separately keep track of the X11 window ID to be able to always
20  * tell whether the focused window actually changed. */
21 static xcb_window_t last_focused = XCB_NONE;
22
23 /* Stores coordinates to warp mouse pointer to if set */
24 static Rect *warp_to;
25
26 /*
27  * Describes the X11 state we may modify (map state, position, window stack).
28  * There is one entry per container. The state represents the current situation
29  * as X11 sees it (with the exception of the order in the state_head CIRCLEQ,
30  * which represents the order that will be pushed to X11, while old_state_head
31  * represents the current order). It will be updated in x_push_changes().
32  *
33  */
34 typedef struct con_state {
35     xcb_window_t id;
36     bool mapped;
37     bool unmap_now;
38     bool child_mapped;
39
40     /** The con for which this state is. */
41     Con *con;
42
43     /* For reparenting, we have a flag (need_reparent) and the X ID of the old
44      * frame this window was in. The latter is necessary because we need to
45      * ignore UnmapNotify events (by changing the window event mask). */
46     bool need_reparent;
47     xcb_window_t old_frame;
48
49     Rect rect;
50     Rect window_rect;
51
52     bool initial;
53
54     char *name;
55
56     CIRCLEQ_ENTRY(con_state) state;
57     CIRCLEQ_ENTRY(con_state) old_state;
58     TAILQ_ENTRY(con_state) initial_mapping_order;
59 } con_state;
60
61 CIRCLEQ_HEAD(state_head, con_state) state_head =
62     CIRCLEQ_HEAD_INITIALIZER(state_head);
63
64 CIRCLEQ_HEAD(old_state_head, con_state) old_state_head =
65     CIRCLEQ_HEAD_INITIALIZER(old_state_head);
66
67 TAILQ_HEAD(initial_mapping_head, con_state) initial_mapping_head =
68     TAILQ_HEAD_INITIALIZER(initial_mapping_head);
69
70 /*
71  * Returns the container state for the given frame. This function always
72  * returns a container state (otherwise, there is a bug in the code and the
73  * container state of a container for which x_con_init() was not called was
74  * requested).
75  *
76  */
77 static con_state *state_for_frame(xcb_window_t window) {
78     con_state *state;
79     CIRCLEQ_FOREACH(state, &state_head, state)
80         if (state->id == window)
81             return state;
82
83     /* TODO: better error handling? */
84     ELOG("No state found\n");
85     assert(false);
86     return NULL;
87 }
88
89 /*
90  * Initializes the X11 part for the given container. Called exactly once for
91  * every container from con_new().
92  *
93  */
94 void x_con_init(Con *con, uint16_t depth) {
95     /* TODO: maybe create the window when rendering first? we could then even
96      * get the initial geometry right */
97
98     uint32_t mask = 0;
99     uint32_t values[5];
100
101     xcb_visualid_t visual = XCB_COPY_FROM_PARENT;
102     xcb_colormap_t win_colormap = XCB_NONE;
103     if (depth != root_depth && depth != XCB_COPY_FROM_PARENT) {
104         /* For custom visuals, we need to create a colormap before creating
105          * this window. It will be freed directly after creating the window. */
106         visual = get_visualid_by_depth(depth);
107         win_colormap = xcb_generate_id(conn);
108         xcb_create_colormap_checked(conn, XCB_COLORMAP_ALLOC_NONE, win_colormap, root, visual);
109
110         /* We explicitly set a background color and border color (even though we
111          * don’t even have a border) because the X11 server requires us to when
112          * using 32 bit color depths, see
113          * http://stackoverflow.com/questions/3645632 */
114         mask |= XCB_CW_BACK_PIXEL;
115         values[0] = root_screen->black_pixel;
116
117         mask |= XCB_CW_BORDER_PIXEL;
118         values[1] = root_screen->black_pixel;
119
120         /* our own frames should not be managed */
121         mask |= XCB_CW_OVERRIDE_REDIRECT;
122         values[2] = 1;
123
124         /* see include/xcb.h for the FRAME_EVENT_MASK */
125         mask |= XCB_CW_EVENT_MASK;
126         values[3] = FRAME_EVENT_MASK & ~XCB_EVENT_MASK_ENTER_WINDOW;
127
128         mask |= XCB_CW_COLORMAP;
129         values[4] = win_colormap;
130     } else {
131         /* our own frames should not be managed */
132         mask = XCB_CW_OVERRIDE_REDIRECT;
133         values[0] = 1;
134
135         /* see include/xcb.h for the FRAME_EVENT_MASK */
136         mask |= XCB_CW_EVENT_MASK;
137         values[1] = FRAME_EVENT_MASK & ~XCB_EVENT_MASK_ENTER_WINDOW;
138
139         mask |= XCB_CW_COLORMAP;
140         values[2] = colormap;
141     }
142
143     Rect dims = { -15, -15, 10, 10 };
144     con->frame = create_window(conn, dims, depth, visual, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCURSOR_CURSOR_POINTER, false, mask, values);
145
146     if (win_colormap != XCB_NONE)
147         xcb_free_colormap(conn, win_colormap);
148
149     struct con_state *state = scalloc(sizeof(struct con_state));
150     state->id = con->frame;
151     state->mapped = false;
152     state->initial = true;
153     DLOG("Adding window 0x%08x to lists\n", state->id);
154     CIRCLEQ_INSERT_HEAD(&state_head, state, state);
155     CIRCLEQ_INSERT_HEAD(&old_state_head, state, old_state);
156     TAILQ_INSERT_TAIL(&initial_mapping_head, state, initial_mapping_order);
157     DLOG("adding new state for window id 0x%08x\n", state->id);
158 }
159
160 /*
161  * Re-initializes the associated X window state for this container. You have
162  * to call this when you assign a client to an empty container to ensure that
163  * its state gets updated correctly.
164  *
165  */
166 void x_reinit(Con *con) {
167     struct con_state *state;
168
169     if ((state = state_for_frame(con->frame)) == NULL) {
170         ELOG("window state not found\n");
171         return;
172     }
173
174     DLOG("resetting state %p to initial\n", state);
175     state->initial = true;
176     state->child_mapped = false;
177     state->con = con;
178     memset(&(state->window_rect), 0, sizeof(Rect));
179 }
180
181 /*
182  * Reparents the child window of the given container (necessary for sticky
183  * containers). The reparenting happens in the next call of x_push_changes().
184  *
185  */
186 void x_reparent_child(Con *con, Con *old) {
187     struct con_state *state;
188     if ((state = state_for_frame(con->frame)) == NULL) {
189         ELOG("window state for con not found\n");
190         return;
191     }
192
193     state->need_reparent = true;
194     state->old_frame = old->frame;
195 }
196
197 /*
198  * Moves a child window from Container src to Container dest.
199  *
200  */
201 void x_move_win(Con *src, Con *dest) {
202     struct con_state *state_src, *state_dest;
203
204     if ((state_src = state_for_frame(src->frame)) == NULL) {
205         ELOG("window state for src not found\n");
206         return;
207     }
208
209     if ((state_dest = state_for_frame(dest->frame)) == NULL) {
210         ELOG("window state for dest not found\n");
211         return;
212     }
213
214     state_dest->con = state_src->con;
215     state_src->con = NULL;
216
217     Rect zero = { 0, 0, 0, 0 };
218     if (memcmp(&(state_dest->window_rect), &(zero), sizeof(Rect)) == 0) {
219         memcpy(&(state_dest->window_rect), &(state_src->window_rect), sizeof(Rect));
220         DLOG("COPYING RECT\n");
221     }
222 }
223
224 /*
225  * Kills the window decoration associated with the given container.
226  *
227  */
228 void x_con_kill(Con *con) {
229     con_state *state;
230
231     xcb_destroy_window(conn, con->frame);
232     xcb_free_pixmap(conn, con->pixmap);
233     xcb_free_gc(conn, con->pm_gc);
234     state = state_for_frame(con->frame);
235     CIRCLEQ_REMOVE(&state_head, state, state);
236     CIRCLEQ_REMOVE(&old_state_head, state, old_state);
237     TAILQ_REMOVE(&initial_mapping_head, state, initial_mapping_order);
238     FREE(state->name);
239     free(state);
240
241     /* Invalidate focused_id to correctly focus new windows with the same ID */
242     focused_id = last_focused = XCB_NONE;
243 }
244
245 /*
246  * Returns true if the client supports the given protocol atom (like WM_DELETE_WINDOW)
247  *
248  */
249 bool window_supports_protocol(xcb_window_t window, xcb_atom_t atom) {
250     xcb_get_property_cookie_t cookie;
251     xcb_icccm_get_wm_protocols_reply_t protocols;
252     bool result = false;
253
254     cookie = xcb_icccm_get_wm_protocols(conn, window, A_WM_PROTOCOLS);
255     if (xcb_icccm_get_wm_protocols_reply(conn, cookie, &protocols, NULL) != 1)
256         return false;
257
258     /* Check if the client’s protocols have the requested atom set */
259     for (uint32_t i = 0; i < protocols.atoms_len; i++)
260         if (protocols.atoms[i] == atom)
261             result = true;
262
263     xcb_icccm_get_wm_protocols_reply_wipe(&protocols);
264
265     return result;
266 }
267
268 /*
269  * Kills the given X11 window using WM_DELETE_WINDOW (if supported).
270  *
271  */
272 void x_window_kill(xcb_window_t window, kill_window_t kill_window) {
273     /* if this window does not support WM_DELETE_WINDOW, we kill it the hard way */
274     if (!window_supports_protocol(window, A_WM_DELETE_WINDOW)) {
275         if (kill_window == KILL_WINDOW) {
276             LOG("Killing specific window 0x%08x\n", window);
277             xcb_destroy_window(conn, window);
278         } else {
279             LOG("Killing the X11 client which owns window 0x%08x\n", window);
280             xcb_kill_client(conn, window);
281         }
282         return;
283     }
284
285     /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
286      * In order to properly initialize these bytes, we allocate 32 bytes even
287      * though we only need less for an xcb_configure_notify_event_t */
288     void *event = scalloc(32);
289     xcb_client_message_event_t *ev = event;
290
291     ev->response_type = XCB_CLIENT_MESSAGE;
292     ev->window = window;
293     ev->type = A_WM_PROTOCOLS;
294     ev->format = 32;
295     ev->data.data32[0] = A_WM_DELETE_WINDOW;
296     ev->data.data32[1] = XCB_CURRENT_TIME;
297
298     LOG("Sending WM_DELETE to the client\n");
299     xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char*)ev);
300     xcb_flush(conn);
301     free(event);
302 }
303
304 /*
305  * Draws the decoration of the given container onto its parent.
306  *
307  */
308 void x_draw_decoration(Con *con) {
309     Con *parent = con->parent;
310     bool leaf = con_is_leaf(con);
311
312     /* This code needs to run for:
313      *  • leaf containers
314      *  • non-leaf containers which are in a stacked/tabbed container
315      *
316      * It does not need to run for:
317      *  • direct children of outputs or dockareas
318      *  • floating containers (they don’t have a decoration)
319      */
320     if ((!leaf &&
321          parent->layout != L_STACKED &&
322          parent->layout != L_TABBED) ||
323         parent->type == CT_OUTPUT ||
324         parent->type == CT_DOCKAREA ||
325         con->type == CT_FLOATING_CON)
326         return;
327
328     /* Skip containers whose height is 0 (for example empty dockareas) */
329     if (con->rect.height == 0)
330         return;
331
332     /* Skip containers whose pixmap has not yet been created (can happen when
333      * decoration rendering happens recursively for a window for which
334      * x_push_node() was not yet called) */
335     if (leaf && con->pixmap == XCB_NONE)
336         return;
337
338     /* 1: build deco_params and compare with cache */
339     struct deco_render_params *p = scalloc(sizeof(struct deco_render_params));
340
341     /* find out which colors to use */
342     if (con->urgent)
343         p->color = &config.client.urgent;
344     else if (con == focused || con_inside_focused(con))
345         p->color = &config.client.focused;
346     else if (con == TAILQ_FIRST(&(parent->focus_head)))
347         p->color = &config.client.focused_inactive;
348     else
349         p->color = &config.client.unfocused;
350
351     p->border_style = con_border_style(con);
352
353     Rect *r = &(con->rect);
354     Rect *w = &(con->window_rect);
355     p->con_rect = (struct width_height){ r->width, r->height };
356     p->con_window_rect = (struct width_height){ w->width, w->height };
357     p->con_deco_rect = con->deco_rect;
358     p->background = config.client.background;
359     p->con_is_leaf = con_is_leaf(con);
360     p->parent_layout = con->parent->layout;
361
362     if (con->deco_render_params != NULL &&
363         (con->window == NULL || !con->window->name_x_changed) &&
364         !parent->pixmap_recreated &&
365         !con->pixmap_recreated &&
366         memcmp(p, con->deco_render_params, sizeof(struct deco_render_params)) == 0) {
367         free(p);
368         goto copy_pixmaps;
369     }
370
371     Con *next = con;
372     while ((next = TAILQ_NEXT(next, nodes))) {
373         FREE(next->deco_render_params);
374     }
375
376     FREE(con->deco_render_params);
377     con->deco_render_params = p;
378
379     if (con->window != NULL && con->window->name_x_changed)
380         con->window->name_x_changed = false;
381
382     parent->pixmap_recreated = false;
383     con->pixmap_recreated = false;
384
385     /* 2: draw the client.background, but only for the parts around the client_rect */
386     if (con->window != NULL) {
387         xcb_rectangle_t background[] = {
388             /* top area */
389             { 0, 0, r->width, w->y },
390             /* bottom area */
391             { 0, (w->y + w->height), r->width, r->height - (w->y + w->height) },
392             /* left area */
393             { 0, 0, w->x, r->height },
394             /* right area */
395             { w->x + w->width, 0, r->width - (w->x + w->width), r->height }
396         };
397 #if 0
398         for (int i = 0; i < 4; i++)
399             DLOG("rect is (%d, %d) with %d x %d\n",
400                     background[i].x,
401                     background[i].y,
402                     background[i].width,
403                     background[i].height
404                 );
405 #endif
406
407         xcb_change_gc(conn, con->pm_gc, XCB_GC_FOREGROUND, (uint32_t[]) { config.client.background });
408         xcb_poly_fill_rectangle(conn, con->pixmap, con->pm_gc, sizeof(background) / sizeof(xcb_rectangle_t), background);
409     }
410
411     /* 3: draw a rectangle in border color around the client */
412     if (p->border_style != BS_NONE && p->con_is_leaf) {
413         /* We might hide some borders adjacent to the screen-edge */
414         adjacent_t borders_to_hide = ADJ_NONE;
415         borders_to_hide = con_adjacent_borders(con) & config.hide_edge_borders;
416
417         Rect br = con_border_style_rect(con);
418 #if 0
419         DLOG("con->rect spans %d x %d\n", con->rect.width, con->rect.height);
420         DLOG("border_rect spans (%d, %d) with %d x %d\n", br.x, br.y, br.width, br.height);
421         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);
422 #endif
423
424         /* These rectangles represents the border around the child window
425          * (left, bottom and right part). We don’t just fill the whole
426          * rectangle because some childs are not freely resizable and we want
427          * their background color to "shine through". */
428         xcb_change_gc(conn, con->pm_gc, XCB_GC_FOREGROUND, (uint32_t[]){ p->color->background });
429         if (!(borders_to_hide & ADJ_LEFT_SCREEN_EDGE)) {
430             xcb_rectangle_t leftline = { 0, 0, br.x, r->height };
431             xcb_poly_fill_rectangle(conn, con->pixmap, con->pm_gc, 1, &leftline);
432         }
433         if (!(borders_to_hide & ADJ_RIGHT_SCREEN_EDGE)) {
434             xcb_rectangle_t rightline = { r->width + br.width + br.x, 0, r->width, r->height };
435             xcb_poly_fill_rectangle(conn, con->pixmap, con->pm_gc, 1, &rightline);
436         }
437         if (!(borders_to_hide & ADJ_LOWER_SCREEN_EDGE)) {
438             xcb_rectangle_t bottomline = { 0, r->height + br.height + br.y, r->width, r->height };
439             xcb_poly_fill_rectangle(conn, con->pixmap, con->pm_gc, 1, &bottomline);
440         }
441         /* 1pixel border needs an additional line at the top */
442         if (p->border_style == BS_PIXEL && !(borders_to_hide & ADJ_UPPER_SCREEN_EDGE)) {
443             xcb_rectangle_t topline = { br.x, 0, con->rect.width + br.width + br.x, br.y };
444             xcb_poly_fill_rectangle(conn, con->pixmap, con->pm_gc, 1, &topline);
445         }
446
447         /* Highlight the side of the border at which the next window will be
448          * opened if we are rendering a single window within a split container
449          * (which is undistinguishable from a single window outside a split
450          * container otherwise. */
451         if (TAILQ_NEXT(con, nodes) == NULL &&
452             TAILQ_PREV(con, nodes_head, nodes) == NULL &&
453             con->parent->type != CT_FLOATING_CON) {
454             xcb_change_gc(conn, con->pm_gc, XCB_GC_FOREGROUND, (uint32_t[]){ p->color->indicator });
455             if (p->parent_layout == L_SPLITH)
456                 xcb_poly_fill_rectangle(conn, con->pixmap, con->pm_gc, 1, (xcb_rectangle_t[]){
457                         { r->width + br.width + br.x, br.y, r->width, r->height + br.height } });
458             else if (p->parent_layout == L_SPLITV)
459                 xcb_poly_fill_rectangle(conn, con->pixmap, con->pm_gc, 1, (xcb_rectangle_t[]){
460                         { br.x, r->height + br.height + br.y, r->width - (2 * br.x), r->height } });
461         }
462
463     }
464
465     /* if this is a borderless/1pixel window, we don’t need to render the
466      * decoration. */
467     if (p->border_style != BS_NORMAL)
468         goto copy_pixmaps;
469
470     /* 4: paint the bar */
471     xcb_change_gc(conn, parent->pm_gc, XCB_GC_FOREGROUND, (uint32_t[]){ p->color->background });
472     xcb_rectangle_t drect = { con->deco_rect.x, con->deco_rect.y, con->deco_rect.width, con->deco_rect.height };
473     xcb_poly_fill_rectangle(conn, parent->pixmap, parent->pm_gc, 1, &drect);
474
475     /* 5: draw two unconnected horizontal lines in border color */
476     xcb_change_gc(conn, parent->pm_gc, XCB_GC_FOREGROUND, (uint32_t[]){ p->color->border });
477     Rect *dr = &(con->deco_rect);
478     int deco_diff_l = 2;
479     int deco_diff_r = 2;
480     if (parent->layout == L_TABBED) {
481         if (TAILQ_PREV(con, nodes_head, nodes) != NULL)
482             deco_diff_l = 0;
483         if (TAILQ_NEXT(con, nodes) != NULL)
484             deco_diff_r = 0;
485     }
486     xcb_segment_t segments[] = {
487         { dr->x,                 dr->y,
488           dr->x + dr->width - 1, dr->y },
489
490         { dr->x + deco_diff_l,                 dr->y + dr->height - 1,
491           dr->x - deco_diff_r + dr->width - 1, dr->y + dr->height - 1 }
492     };
493     xcb_poly_segment(conn, parent->pixmap, parent->pm_gc, 2, segments);
494
495     /* 6: draw the title */
496     set_font_colors(parent->pm_gc, p->color->text, p->color->background);
497     int text_offset_y = (con->deco_rect.height - config.font.height) / 2;
498
499     struct Window *win = con->window;
500     if (win == NULL) {
501         /* we have a split container which gets a representation
502          * of its children as title
503          */
504         char *title;
505         char *tree = con_get_tree_representation(con);
506         sasprintf(&title, "i3: %s", tree);
507         free(tree);
508
509         draw_text_ascii(title,
510                 parent->pixmap, parent->pm_gc,
511                 con->deco_rect.x + 2, con->deco_rect.y + text_offset_y,
512                 con->deco_rect.width - 2);
513         free(title);
514
515         goto after_title;
516     }
517
518     if (win->name == NULL)
519         goto copy_pixmaps;
520
521     int indent_level = 0,
522         indent_mult = 0;
523     Con *il_parent = parent;
524     if (il_parent->layout != L_STACKED) {
525         while (1) {
526             //DLOG("il_parent = %p, layout = %d\n", il_parent, il_parent->layout);
527             if (il_parent->layout == L_STACKED)
528                 indent_level++;
529             if (il_parent->type == CT_WORKSPACE || il_parent->type == CT_DOCKAREA || il_parent->type == CT_OUTPUT)
530                 break;
531             il_parent = il_parent->parent;
532             indent_mult++;
533         }
534     }
535     //DLOG("indent_level = %d, indent_mult = %d\n", indent_level, indent_mult);
536     int indent_px = (indent_level * 5) * indent_mult;
537
538     draw_text(win->name,
539             parent->pixmap, parent->pm_gc,
540             con->deco_rect.x + 2 + indent_px, con->deco_rect.y + text_offset_y,
541             con->deco_rect.width - 2 - indent_px);
542
543 after_title:
544     /* Since we don’t clip the text at all, it might in some cases be painted
545      * on the border pixels on the right side of a window. Therefore, we draw
546      * the right border again after rendering the text (and the unconnected
547      * lines in border color). */
548
549     /* Draw a 1px separator line before and after every tab, so that tabs can
550      * be easily distinguished. */
551     if (parent->layout == L_TABBED) {
552         xcb_change_gc(conn, parent->pm_gc, XCB_GC_FOREGROUND, (uint32_t[]){ p->color->border });
553     } else {
554         xcb_change_gc(conn, parent->pm_gc, XCB_GC_FOREGROUND, (uint32_t[]){ p->color->background });
555     }
556     xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, parent->pixmap, parent->pm_gc, 6,
557                   (xcb_point_t[]){
558                       { dr->x + dr->width, dr->y },
559                       { dr->x + dr->width, dr->y + dr->height },
560                       { dr->x + dr->width - 1, dr->y },
561                       { dr->x + dr->width - 1, dr->y + dr->height },
562                       { dr->x, dr->y + dr->height },
563                       { dr->x, dr->y },
564                   });
565
566     xcb_change_gc(conn, parent->pm_gc, XCB_GC_FOREGROUND, (uint32_t[]){ p->color->border });
567     xcb_poly_segment(conn, parent->pixmap, parent->pm_gc, 2, segments);
568
569 copy_pixmaps:
570     xcb_copy_area(conn, con->pixmap, con->frame, con->pm_gc, 0, 0, 0, 0, con->rect.width, con->rect.height);
571 }
572
573 /*
574  * Recursively calls x_draw_decoration. This cannot be done in x_push_node
575  * because x_push_node uses focus order to recurse (see the comment above)
576  * while drawing the decoration needs to happen in the actual order.
577  *
578  */
579 void x_deco_recurse(Con *con) {
580     Con *current;
581     bool leaf = TAILQ_EMPTY(&(con->nodes_head)) &&
582                 TAILQ_EMPTY(&(con->floating_head));
583     con_state *state = state_for_frame(con->frame);
584
585     if (!leaf) {
586         TAILQ_FOREACH(current, &(con->nodes_head), nodes)
587             x_deco_recurse(current);
588
589         TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
590             x_deco_recurse(current);
591
592         if (state->mapped)
593             xcb_copy_area(conn, con->pixmap, con->frame, con->pm_gc, 0, 0, 0, 0, con->rect.width, con->rect.height);
594     }
595
596     if ((con->type != CT_ROOT && con->type != CT_OUTPUT) &&
597         (!leaf || con->mapped))
598         x_draw_decoration(con);
599 }
600
601 /*
602  * This function pushes the properties of each node of the layout tree to
603  * X11 if they have changed (like the map state, position of the window, …).
604  * It recursively traverses all children of the given node.
605  *
606  */
607 void x_push_node(Con *con) {
608     Con *current;
609     con_state *state;
610     Rect rect = con->rect;
611
612     //DLOG("Pushing changes for node %p / %s\n", con, con->name);
613     state = state_for_frame(con->frame);
614
615     if (state->name != NULL) {
616         DLOG("pushing name %s for con %p\n", state->name, con);
617
618         xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->frame,
619                             XCB_ATOM_WM_NAME, XCB_ATOM_STRING, 8, strlen(state->name), state->name);
620         FREE(state->name);
621     }
622
623     if (con->window == NULL) {
624         /* Calculate the height of all window decorations which will be drawn on to
625          * this frame. */
626         uint32_t max_y = 0, max_height = 0;
627         TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
628             Rect *dr = &(current->deco_rect);
629             if (dr->y >= max_y && dr->height >= max_height) {
630                 max_y = dr->y;
631                 max_height = dr->height;
632             }
633         }
634         rect.height = max_y + max_height;
635         if (rect.height == 0)
636             con->mapped = false;
637     }
638
639     /* reparent the child window (when the window was moved due to a sticky
640      * container) */
641     if (state->need_reparent && con->window != NULL) {
642         DLOG("Reparenting child window\n");
643
644         /* Temporarily set the event masks to XCB_NONE so that we won’t get
645          * UnmapNotify events (otherwise the handler would close the container).
646          * These events are generated automatically when reparenting. */
647         uint32_t values[] = { XCB_NONE };
648         xcb_change_window_attributes(conn, state->old_frame, XCB_CW_EVENT_MASK, values);
649         xcb_change_window_attributes(conn, con->window->id, XCB_CW_EVENT_MASK, values);
650
651         xcb_reparent_window(conn, con->window->id, con->frame, 0, 0);
652
653         values[0] = FRAME_EVENT_MASK;
654         xcb_change_window_attributes(conn, state->old_frame, XCB_CW_EVENT_MASK, values);
655         values[0] = CHILD_EVENT_MASK;
656         xcb_change_window_attributes(conn, con->window->id, XCB_CW_EVENT_MASK, values);
657
658         state->old_frame = XCB_NONE;
659         state->need_reparent = false;
660
661         con->ignore_unmap++;
662         DLOG("ignore_unmap for reparenting of con %p (win 0x%08x) is now %d\n",
663                 con, con->window->id, con->ignore_unmap);
664     }
665
666     bool fake_notify = false;
667     /* Set new position if rect changed (and if height > 0) */
668     if (memcmp(&(state->rect), &rect, sizeof(Rect)) != 0 &&
669         rect.height > 0) {
670         /* We first create the new pixmap, then render to it, set it as the
671          * background and only afterwards change the window size. This reduces
672          * flickering. */
673
674         /* As the pixmap only depends on the size and not on the position, it
675          * is enough to check if width/height have changed. Also, we don’t
676          * create a pixmap at all when the window is actually not visible
677          * (height == 0) or when it is not needed. */
678         bool has_rect_changed = (state->rect.width != rect.width || state->rect.height != rect.height);
679
680         /* The pixmap of a borderless leaf container will not be used except
681          * for the titlebar in a stack or tabs (issue #1013). */
682         bool is_pixmap_needed = (con->border_style != BS_NONE ||
683                 !con_is_leaf(con) ||
684                 con->parent->layout == L_STACKED ||
685                 con->parent->layout == L_TABBED);
686
687         /* Check if the container has an unneeded pixmap left over from
688          * previously having a border or titlebar. */
689         if (!is_pixmap_needed && con->pixmap != XCB_NONE) {
690             xcb_free_pixmap(conn, con->pixmap);
691             con->pixmap = XCB_NONE;
692         }
693
694         if (has_rect_changed && is_pixmap_needed) {
695             if (con->pixmap == 0) {
696                 con->pixmap = xcb_generate_id(conn);
697                 con->pm_gc = xcb_generate_id(conn);
698             } else {
699                 xcb_free_pixmap(conn, con->pixmap);
700                 xcb_free_gc(conn, con->pm_gc);
701             }
702
703             uint16_t win_depth = root_depth;
704             if (con->window)
705                 win_depth = con->window->depth;
706
707             xcb_create_pixmap(conn, win_depth, con->pixmap, con->frame, rect.width, rect.height);
708
709             /* For the graphics context, we disable GraphicsExposure events.
710              * Those will be sent when a CopyArea request cannot be fulfilled
711              * properly due to parts of the source being unmapped or otherwise
712              * unavailable. Since we always copy from pixmaps to windows, this
713              * is not a concern for us. */
714             uint32_t values[] = { 0 };
715             xcb_create_gc(conn, con->pm_gc, con->pixmap, XCB_GC_GRAPHICS_EXPOSURES, values);
716
717             con->pixmap_recreated = true;
718
719             /* Don’t render the decoration for windows inside a stack which are
720              * not visible right now */
721             if (!con->parent ||
722                 con->parent->layout != L_STACKED ||
723                 TAILQ_FIRST(&(con->parent->focus_head)) == con)
724                 /* Render the decoration now to make the correct decoration visible
725                  * from the very first moment. Later calls will be cached, so this
726                  * doesn’t hurt performance. */
727                 x_deco_recurse(con);
728         }
729
730         DLOG("setting rect (%d, %d, %d, %d)\n", rect.x, rect.y, rect.width, rect.height);
731         /* flush to ensure that the following commands are sent in a single
732          * buffer and will be processed directly afterwards (the contents of a
733          * window get lost when resizing it, therefore we want to provide it as
734          * fast as possible) */
735         xcb_flush(conn);
736         xcb_set_window_rect(conn, con->frame, rect);
737         if (con->pixmap != XCB_NONE)
738             xcb_copy_area(conn, con->pixmap, con->frame, con->pm_gc, 0, 0, 0, 0, con->rect.width, con->rect.height);
739         xcb_flush(conn);
740
741         memcpy(&(state->rect), &rect, sizeof(Rect));
742         fake_notify = true;
743     }
744
745     /* dito, but for child windows */
746     if (con->window != NULL &&
747         memcmp(&(state->window_rect), &(con->window_rect), sizeof(Rect)) != 0) {
748         DLOG("setting window rect (%d, %d, %d, %d)\n",
749             con->window_rect.x, con->window_rect.y, con->window_rect.width, con->window_rect.height);
750         xcb_set_window_rect(conn, con->window->id, con->window_rect);
751         memcpy(&(state->window_rect), &(con->window_rect), sizeof(Rect));
752         fake_notify = true;
753     }
754
755     /* Map if map state changed, also ensure that the child window
756      * is changed if we are mapped and there is a new, unmapped child window.
757      * Unmaps are handled in x_push_node_unmaps(). */
758     if ((state->mapped != con->mapped || (con->window != NULL && !state->child_mapped)) &&
759         con->mapped) {
760         xcb_void_cookie_t cookie;
761
762         if (con->window != NULL) {
763             /* Set WM_STATE_NORMAL because GTK applications don’t want to
764              * drag & drop if we don’t. Also, xprop(1) needs it. */
765             long data[] = { XCB_ICCCM_WM_STATE_NORMAL, XCB_NONE };
766             xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
767                                 A_WM_STATE, A_WM_STATE, 32, 2, data);
768         }
769
770         uint32_t values[1];
771         if (!state->child_mapped && con->window != NULL) {
772             cookie = xcb_map_window(conn, con->window->id);
773
774             /* We are interested in EnterNotifys as soon as the window is
775              * mapped */
776             values[0] = CHILD_EVENT_MASK;
777             xcb_change_window_attributes(conn, con->window->id, XCB_CW_EVENT_MASK, values);
778             DLOG("mapping child window (serial %d)\n", cookie.sequence);
779             state->child_mapped = true;
780         }
781
782         cookie = xcb_map_window(conn, con->frame);
783
784         values[0] = FRAME_EVENT_MASK;
785         xcb_change_window_attributes(conn, con->frame, XCB_CW_EVENT_MASK, values);
786
787         /* copy the pixmap contents to the frame window immediately after mapping */
788         if (con->pixmap != XCB_NONE)
789             xcb_copy_area(conn, con->pixmap, con->frame, con->pm_gc, 0, 0, 0, 0, con->rect.width, con->rect.height);
790         xcb_flush(conn);
791
792         DLOG("mapping container %08x (serial %d)\n", con->frame, cookie.sequence);
793         state->mapped = con->mapped;
794     }
795
796     state->unmap_now = (state->mapped != con->mapped) && !con->mapped;
797
798     if (fake_notify) {
799         DLOG("Sending fake configure notify\n");
800         fake_absolute_configure_notify(con);
801     }
802
803     /* Handle all children and floating windows of this node. We recurse
804      * in focus order to display the focused client in a stack first when
805      * switching workspaces (reduces flickering). */
806     TAILQ_FOREACH(current, &(con->focus_head), focused)
807         x_push_node(current);
808 }
809
810 /*
811  * Same idea as in x_push_node(), but this function only unmaps windows. It is
812  * necessary to split this up to handle new fullscreen clients properly: The
813  * new window needs to be mapped and focus needs to be set *before* the
814  * underlying windows are unmapped. Otherwise, focus will revert to the
815  * PointerRoot and will then be set to the new window, generating unnecessary
816  * FocusIn/FocusOut events.
817  *
818  */
819 static void x_push_node_unmaps(Con *con) {
820     Con *current;
821     con_state *state;
822
823     //DLOG("Pushing changes (with unmaps) for node %p / %s\n", con, con->name);
824     state = state_for_frame(con->frame);
825
826     /* map/unmap if map state changed, also ensure that the child window
827      * is changed if we are mapped *and* in initial state (meaning the
828      * container was empty before, but now got a child) */
829     if (state->unmap_now) {
830         xcb_void_cookie_t cookie;
831         if (con->window != NULL) {
832             /* Set WM_STATE_WITHDRAWN, it seems like Java apps need it */
833             long data[] = { XCB_ICCCM_WM_STATE_WITHDRAWN, XCB_NONE };
834             xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
835                                 A_WM_STATE, A_WM_STATE, 32, 2, data);
836         }
837
838         cookie = xcb_unmap_window(conn, con->frame);
839         DLOG("unmapping container %p / %s (serial %d)\n", con, con->name, cookie.sequence);
840         /* we need to increase ignore_unmap for this container (if it
841          * contains a window) and for every window "under" this one which
842          * contains a window */
843         if (con->window != NULL) {
844             con->ignore_unmap++;
845             DLOG("ignore_unmap for con %p (frame 0x%08x) now %d\n", con, con->frame, con->ignore_unmap);
846         }
847         state->mapped = con->mapped;
848     }
849
850     /* handle all children and floating windows of this node */
851     TAILQ_FOREACH(current, &(con->nodes_head), nodes)
852         x_push_node_unmaps(current);
853
854     TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
855         x_push_node_unmaps(current);
856 }
857
858 /*
859  * Returns true if the given container is currently attached to its parent.
860  *
861  * TODO: Remove once #1185 has been fixed
862  */
863 static bool is_con_attached(Con *con) {
864     if (con->parent == NULL)
865         return false;
866
867     Con *current;
868     TAILQ_FOREACH(current, &(con->parent->nodes_head), nodes) {
869         if (current == con)
870             return true;
871     }
872
873     return false;
874 }
875
876 /*
877  * Pushes all changes (state of each node, see x_push_node() and the window
878  * stack) to X11.
879  *
880  * NOTE: We need to push the stack first so that the windows have the correct
881  * stacking order. This is relevant for workspace switching where we map the
882  * windows because mapping may generate EnterNotify events. When they are
883  * generated in the wrong order, this will cause focus problems when switching
884  * workspaces.
885  *
886  */
887 void x_push_changes(Con *con) {
888     con_state *state;
889     xcb_query_pointer_cookie_t pointercookie;
890
891     /* If we need to warp later, we request the pointer position as soon as possible */
892     if (warp_to) {
893         pointercookie = xcb_query_pointer(conn, root);
894     }
895
896     DLOG("-- PUSHING WINDOW STACK --\n");
897     //DLOG("Disabling EnterNotify\n");
898     uint32_t values[1] = { XCB_NONE };
899     CIRCLEQ_FOREACH_REVERSE(state, &state_head, state) {
900         if (state->mapped)
901             xcb_change_window_attributes(conn, state->id, XCB_CW_EVENT_MASK, values);
902     }
903     //DLOG("Done, EnterNotify disabled\n");
904     bool order_changed = false;
905     bool stacking_changed = false;
906
907     /* count first, necessary to (re)allocate memory for the bottom-to-top
908      * stack afterwards */
909     int cnt = 0;
910     CIRCLEQ_FOREACH_REVERSE(state, &state_head, state)
911         if (con_has_managed_window(state->con))
912             cnt++;
913
914     /* The bottom-to-top window stack of all windows which are managed by i3.
915      * Used for x_get_window_stack(). */
916     static xcb_window_t *client_list_windows = NULL;
917     static int client_list_count = 0;
918
919     if (cnt != client_list_count) {
920         client_list_windows = srealloc(client_list_windows, sizeof(xcb_window_t) * cnt);
921         client_list_count = cnt;
922     }
923
924     xcb_window_t *walk = client_list_windows;
925
926     /* X11 correctly represents the stack if we push it from bottom to top */
927     CIRCLEQ_FOREACH_REVERSE(state, &state_head, state) {
928         if (con_has_managed_window(state->con))
929             memcpy(walk++, &(state->con->window->id), sizeof(xcb_window_t));
930
931         //DLOG("stack: 0x%08x\n", state->id);
932         con_state *prev = CIRCLEQ_PREV(state, state);
933         con_state *old_prev = CIRCLEQ_PREV(state, old_state);
934         if (prev != old_prev)
935             order_changed = true;
936         if ((state->initial || order_changed) && prev != CIRCLEQ_END(&state_head)) {
937             stacking_changed = true;
938             //DLOG("Stacking 0x%08x above 0x%08x\n", prev->id, state->id);
939             uint32_t mask = 0;
940             mask |= XCB_CONFIG_WINDOW_SIBLING;
941             mask |= XCB_CONFIG_WINDOW_STACK_MODE;
942             uint32_t values[] = {state->id, XCB_STACK_MODE_ABOVE};
943
944             xcb_configure_window(conn, prev->id, mask, values);
945         }
946         state->initial = false;
947     }
948
949     /* If we re-stacked something (or a new window appeared), we need to update
950      * the _NET_CLIENT_LIST and _NET_CLIENT_LIST_STACKING hints */
951     if (stacking_changed) {
952         DLOG("Client list changed (%i clients)\n", cnt);
953         ewmh_update_client_list_stacking(client_list_windows, client_list_count);
954
955         walk = client_list_windows;
956
957         /* reorder by initial mapping */
958         TAILQ_FOREACH(state, &initial_mapping_head, initial_mapping_order) {
959             if (con_has_managed_window(state->con))
960                 *walk++ = state->con->window->id;
961         }
962
963         ewmh_update_client_list(client_list_windows, client_list_count);
964     }
965
966     DLOG("PUSHING CHANGES\n");
967     x_push_node(con);
968
969     if (warp_to) {
970         xcb_query_pointer_reply_t *pointerreply = xcb_query_pointer_reply(conn, pointercookie, NULL);
971         if (!pointerreply) {
972             ELOG("Could not query pointer position, not warping pointer\n");
973         } else {
974             int mid_x = warp_to->x + (warp_to->width / 2);
975             int mid_y = warp_to->y + (warp_to->height / 2);
976
977             Output *current = get_output_containing(pointerreply->root_x, pointerreply->root_y);
978             Output *target = get_output_containing(mid_x, mid_y);
979             if (current != target) {
980                 /* Ignore MotionNotify events generated by warping */
981                 xcb_change_window_attributes(conn, root, XCB_CW_EVENT_MASK, (uint32_t[]){ XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT });
982                 xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0, mid_x, mid_y);
983                 xcb_change_window_attributes(conn, root, XCB_CW_EVENT_MASK, (uint32_t[]){ ROOT_EVENT_MASK });
984             }
985         }
986         warp_to = NULL;
987     }
988
989     //DLOG("Re-enabling EnterNotify\n");
990     values[0] = FRAME_EVENT_MASK;
991     CIRCLEQ_FOREACH_REVERSE(state, &state_head, state) {
992         if (state->mapped)
993             xcb_change_window_attributes(conn, state->id, XCB_CW_EVENT_MASK, values);
994     }
995     //DLOG("Done, EnterNotify re-enabled\n");
996
997     x_deco_recurse(con);
998
999     xcb_window_t to_focus = focused->frame;
1000     if (focused->window != NULL)
1001         to_focus = focused->window->id;
1002
1003     if (focused_id != to_focus) {
1004         if (!focused->mapped) {
1005             DLOG("Not updating focus (to %p / %s), focused window is not mapped.\n", focused, focused->name);
1006             /* Invalidate focused_id to correctly focus new windows with the same ID */
1007             focused_id = XCB_NONE;
1008         } else {
1009             if (focused->window != NULL &&
1010                 focused->window->needs_take_focus &&
1011                 focused->window->doesnt_accept_focus) {
1012                 DLOG("Updating focus by sending WM_TAKE_FOCUS to window 0x%08x (focused: %p / %s)\n",
1013                      to_focus, focused, focused->name);
1014                 send_take_focus(to_focus, last_timestamp);
1015
1016                 if (to_focus != last_focused && is_con_attached(focused))
1017                    ipc_send_window_event("focus", focused);
1018             } else {
1019                 DLOG("Updating focus (focused: %p / %s) to X11 window 0x%08x\n", focused, focused->name, to_focus);
1020                 /* We remove XCB_EVENT_MASK_FOCUS_CHANGE from the event mask to get
1021                  * no focus change events for our own focus changes. We only want
1022                  * these generated by the clients. */
1023                 if (focused->window != NULL) {
1024                     values[0] = CHILD_EVENT_MASK & ~(XCB_EVENT_MASK_FOCUS_CHANGE);
1025                     xcb_change_window_attributes(conn, focused->window->id, XCB_CW_EVENT_MASK, values);
1026                 }
1027                 xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, to_focus, XCB_CURRENT_TIME);
1028                 if (focused->window != NULL) {
1029                     values[0] = CHILD_EVENT_MASK;
1030                     xcb_change_window_attributes(conn, focused->window->id, XCB_CW_EVENT_MASK, values);
1031                 }
1032
1033                 ewmh_update_active_window(to_focus);
1034
1035                 if (to_focus != XCB_NONE && to_focus != last_focused && focused->window != NULL && is_con_attached(focused))
1036                    ipc_send_window_event("focus", focused);
1037             }
1038
1039             focused_id = last_focused = to_focus;
1040         }
1041     }
1042
1043     if (focused_id == XCB_NONE) {
1044         DLOG("Still no window focused, better set focus to the root window\n");
1045         xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, root, XCB_CURRENT_TIME);
1046         focused_id = root;
1047     }
1048
1049     xcb_flush(conn);
1050     DLOG("ENDING CHANGES\n");
1051
1052     /* Disable EnterWindow events for windows which will be unmapped in
1053      * x_push_node_unmaps() now. Unmapping windows happens when switching
1054      * workspaces. We want to avoid getting EnterNotifies during that phase
1055      * because they would screw up our focus. One of these cases is having a
1056      * stack with two windows. If the first window is focused and gets
1057      * unmapped, the second one appears under the cursor and therefore gets an
1058      * EnterNotify event. */
1059     values[0] = FRAME_EVENT_MASK & ~XCB_EVENT_MASK_ENTER_WINDOW;
1060     CIRCLEQ_FOREACH_REVERSE(state, &state_head, state) {
1061         if (!state->unmap_now)
1062             continue;
1063         xcb_change_window_attributes(conn, state->id, XCB_CW_EVENT_MASK, values);
1064     }
1065
1066     /* Push all pending unmaps */
1067     x_push_node_unmaps(con);
1068
1069     /* save the current stack as old stack */
1070     CIRCLEQ_FOREACH(state, &state_head, state) {
1071         CIRCLEQ_REMOVE(&old_state_head, state, old_state);
1072         CIRCLEQ_INSERT_TAIL(&old_state_head, state, old_state);
1073     }
1074     //CIRCLEQ_FOREACH(state, &old_state_head, old_state) {
1075     //    DLOG("old stack: 0x%08x\n", state->id);
1076     //}
1077
1078     xcb_flush(conn);
1079 }
1080
1081 /*
1082  * Raises the specified container in the internal stack of X windows. The
1083  * next call to x_push_changes() will make the change visible in X11.
1084  *
1085  */
1086 void x_raise_con(Con *con) {
1087     con_state *state;
1088     state = state_for_frame(con->frame);
1089     //DLOG("raising in new stack: %p / %s / %s / xid %08x\n", con, con->name, con->window ? con->window->name_json : "", state->id);
1090
1091     CIRCLEQ_REMOVE(&state_head, state, state);
1092     CIRCLEQ_INSERT_HEAD(&state_head, state, state);
1093 }
1094
1095 /*
1096  * Sets the WM_NAME property (so, no UTF8, but used only for debugging anyways)
1097  * of the given name. Used for properly tagging the windows for easily spotting
1098  * i3 windows in xwininfo -root -all.
1099  *
1100  */
1101 void x_set_name(Con *con, const char *name) {
1102     struct con_state *state;
1103
1104     if ((state = state_for_frame(con->frame)) == NULL) {
1105         ELOG("window state not found\n");
1106         return;
1107     }
1108
1109     FREE(state->name);
1110     state->name = sstrdup(name);
1111 }
1112
1113 /*
1114  * Set up the I3_SHMLOG_PATH atom.
1115  *
1116  */
1117 void update_shmlog_atom() {
1118     xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root,
1119             A_I3_SHMLOG_PATH, A_UTF8_STRING, 8,
1120             strlen(shmlogname), shmlogname);
1121 }
1122
1123 /*
1124  * Sets up i3 specific atoms (I3_SOCKET_PATH and I3_CONFIG_PATH)
1125  *
1126  */
1127 void x_set_i3_atoms(void) {
1128     pid_t pid = getpid();
1129     xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root, A_I3_SOCKET_PATH, A_UTF8_STRING, 8,
1130                         (current_socketpath == NULL ? 0 : strlen(current_socketpath)),
1131                         current_socketpath);
1132     xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root, A_I3_PID, XCB_ATOM_CARDINAL, 32, 1, &pid);
1133     xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root, A_I3_CONFIG_PATH, A_UTF8_STRING, 8,
1134                         strlen(current_configpath), current_configpath);
1135     update_shmlog_atom();
1136 }
1137
1138 /*
1139  * Set warp_to coordinates.  This will trigger on the next call to
1140  * x_push_changes().
1141  *
1142  */
1143 void x_set_warp_to(Rect *rect)
1144 {
1145     if (!config.disable_focus_follows_mouse &&
1146         config.mouse_warping != POINTER_WARPING_NONE)
1147         warp_to = rect;
1148 }
1149
1150 /*
1151  * Applies the given mask to the event mask of every i3 window decoration X11
1152  * window. This is useful to disable EnterNotify while resizing so that focus
1153  * is untouched.
1154  *
1155  */
1156 void x_mask_event_mask(uint32_t mask) {
1157     uint32_t values[] = { FRAME_EVENT_MASK & mask };
1158
1159     con_state *state;
1160     CIRCLEQ_FOREACH_REVERSE(state, &state_head, state) {
1161         if (state->mapped)
1162             xcb_change_window_attributes(conn, state->id, XCB_CW_EVENT_MASK, values);
1163     }
1164 }