]> git.sur5r.net Git - i3/i3/blob - src/x.c
libXcursor support (themed cursors).
[i3/i3] / 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, XCURSOR_CURSOR_POINTER, 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      * It does not need to run for:
232      *  • floating containers (they don’t have a decoration)
233      */
234     if ((!con_is_leaf(con) && con->parent->layout != L_STACKED) ||
235         con->type == CT_FLOATING_CON)
236         return;
237     DLOG("decoration should be rendered for con %p\n", con);
238
239     /* 1: find out which colors to use */
240     struct Colortriple *color;
241     if (con->urgent)
242         color = &config.client.urgent;
243     else if (con == focused)
244         color = &config.client.focused;
245     else if (con == TAILQ_FIRST(&(con->parent->focus_head)))
246         color = &config.client.focused_inactive;
247     else
248         color = &config.client.unfocused;
249
250     Con *parent = con->parent;
251     int border_style = con_border_style(con);
252
253     /* 2: draw a rectangle in border color around the client */
254     if (border_style != BS_NONE && con_is_leaf(con)) {
255         Rect br = con_border_style_rect(con);
256         Rect *r = &(con->rect);
257 #if 0
258         DLOG("con->rect spans %d x %d\n", con->rect.width, con->rect.height);
259         DLOG("border_rect spans (%d, %d) with %d x %d\n", border_rect.x, border_rect.y, border_rect.width, border_rect.height);
260         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);
261 #endif
262
263         /* These rectangles represents the border around the child window
264          * (left, bottom and right part). We don’t just fill the whole
265          * rectangle because some childs are not freely resizable and we want
266          * their background color to "shine through". */
267         xcb_change_gc_single(conn, con->gc, XCB_GC_FOREGROUND, color->background);
268         xcb_rectangle_t borders[] = {
269             { 0, 0, br.x, r->height },
270             { 0, r->height + br.height + br.y, r->width, r->height },
271             { r->width + br.width + br.x, 0, r->width, r->height }
272         };
273         xcb_poly_fill_rectangle(conn, con->frame, con->gc, 3, borders);
274         /* 1pixel border needs an additional line at the top */
275         if (border_style == BS_1PIXEL) {
276             xcb_rectangle_t topline = { br.x, 0, con->rect.width + br.width + br.x, br.y };
277             xcb_poly_fill_rectangle(conn, con->frame, con->gc, 1, &topline);
278         }
279     }
280
281     /* if this is a borderless/1pixel window, we don’t * need to render the
282      * decoration. */
283     if (border_style != BS_NORMAL) {
284         DLOG("border style not BS_NORMAL, aborting rendering of decoration\n");
285         return;
286     }
287
288     /* 3: paint the bar */
289     xcb_change_gc_single(conn, parent->gc, XCB_GC_FOREGROUND, color->background);
290     xcb_rectangle_t drect = { con->deco_rect.x, con->deco_rect.y, con->deco_rect.width, con->deco_rect.height };
291     xcb_poly_fill_rectangle(conn, parent->frame, parent->gc, 1, &drect);
292
293     /* 4: draw the two lines in border color */
294     xcb_draw_line(conn, parent->frame, parent->gc, color->border,
295             con->deco_rect.x, /* x */
296             con->deco_rect.y, /* y */
297             con->deco_rect.x + con->deco_rect.width, /* to_x */
298             con->deco_rect.y); /* to_y */
299     xcb_draw_line(conn, parent->frame, parent->gc, color->border,
300             con->deco_rect.x, /* x */
301             con->deco_rect.y + con->deco_rect.height - 1, /* y */
302             con->deco_rect.x + con->deco_rect.width, /* to_x */
303             con->deco_rect.y + con->deco_rect.height - 1); /* to_y */
304
305     /* 5: draw the title */
306     i3Font *font = load_font(conn, config.font);
307     uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
308     uint32_t values[] = { color->text, color->background, font->id };
309     xcb_change_gc(conn, parent->gc, mask, values);
310     int text_offset_y = font->height + (con->deco_rect.height - font->height) / 2 - 1;
311
312     struct Window *win = con->window;
313     if (win == NULL || win->name_x == NULL) {
314         /* this is a non-leaf container, we need to make up a good description */
315         // TODO: use a good description instead of just "another container"
316         xcb_image_text_8(
317             conn,
318             strlen("another container"),
319             parent->frame,
320             parent->gc,
321             con->deco_rect.x + 2,
322             con->deco_rect.y + text_offset_y,
323             "another container"
324         );
325         return;
326     }
327
328     int indent_level = 0,
329         indent_mult = 0;
330     Con *il_parent = con->parent;
331     if (il_parent->type != L_STACKED) {
332         while (1) {
333             DLOG("il_parent = %p, layout = %d\n", il_parent, il_parent->layout);
334             if (il_parent->layout == L_STACKED)
335                 indent_level++;
336             if (il_parent->type == CT_WORKSPACE)
337                 break;
338             il_parent = il_parent->parent;
339             indent_mult++;
340         }
341     }
342     DLOG("indent_level = %d, indent_mult = %d\n", indent_level, indent_mult);
343     int indent_px = (indent_level * 5) * indent_mult;
344
345     if (win->uses_net_wm_name)
346         xcb_image_text_16(
347             conn,
348             win->name_len,
349             parent->frame,
350             parent->gc,
351             con->deco_rect.x + 2 + indent_px,
352             con->deco_rect.y + text_offset_y,
353             (xcb_char2b_t*)win->name_x
354         );
355     else
356         xcb_image_text_8(
357             conn,
358             win->name_len,
359             parent->frame,
360             parent->gc,
361             con->deco_rect.x + 2 + indent_px,
362             con->deco_rect.y + text_offset_y,
363             win->name_x
364         );
365 }
366
367 /*
368  * This function pushes the properties of each node of the layout tree to
369  * X11 if they have changed (like the map state, position of the window, …).
370  * It recursively traverses all children of the given node.
371  *
372  */
373 static void x_push_node(Con *con) {
374     Con *current;
375     con_state *state;
376     Rect rect = con->rect;
377
378     LOG("Pushing changes for node %p / %s\n", con, con->name);
379     state = state_for_frame(con->frame);
380
381     if (state->name != NULL) {
382         DLOG("pushing name %s for con %p\n", state->name, con);
383
384         xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->frame,
385                             WM_NAME, STRING, 8, strlen(state->name), state->name);
386         FREE(state->name);
387     }
388
389     if (con->window == NULL) {
390         /* Calculate the height of all window decorations which will be drawn on to
391          * this frame. */
392         uint32_t max_y = 0, max_height = 0;
393         TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
394             Rect *dr = &(current->deco_rect);
395             if (dr->y >= max_y && dr->height >= max_height) {
396                 max_y = dr->y;
397                 max_height = dr->height;
398             }
399         }
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         con->ignore_unmap++;
430         DLOG("ignore_unmap for reparenting of con %p (win 0x%08x) is now %d\n",
431                 con, con->window->id, con->ignore_unmap);
432     }
433
434     bool fake_notify = false;
435     /* set new position if rect changed */
436     if (memcmp(&(state->rect), &rect, sizeof(Rect)) != 0) {
437         LOG("setting rect (%d, %d, %d, %d)\n", rect.x, rect.y, rect.width, rect.height);
438         xcb_set_window_rect(conn, con->frame, rect);
439         memcpy(&(state->rect), &rect, sizeof(Rect));
440         fake_notify = true;
441     }
442
443     /* dito, but for child windows */
444     if (con->window != NULL &&
445         memcmp(&(state->window_rect), &(con->window_rect), sizeof(Rect)) != 0) {
446         LOG("setting window rect (%d, %d, %d, %d)\n",
447             con->window_rect.x, con->window_rect.y, con->window_rect.width, con->window_rect.height);
448         xcb_set_window_rect(conn, con->window->id, con->window_rect);
449         memcpy(&(state->window_rect), &(con->window_rect), sizeof(Rect));
450         fake_notify = true;
451     }
452
453     /* Map if map state changed, also ensure that the child window
454      * is changed if we are mapped *and* in initial state (meaning the
455      * container was empty before, but now got a child). Unmaps are handled in
456      * x_push_node_unmaps(). */
457     if ((state->mapped != con->mapped || (con->mapped && state->initial)) &&
458         con->mapped) {
459         xcb_void_cookie_t cookie;
460
461         if (con->window != NULL) {
462             /* Set WM_STATE_NORMAL because GTK applications don’t want to
463              * drag & drop if we don’t. Also, xprop(1) needs it. */
464             long data[] = { XCB_WM_STATE_NORMAL, XCB_NONE };
465             xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
466                                 atoms[WM_STATE], atoms[WM_STATE], 32, 2, data);
467         }
468
469         if (state->initial && con->window != NULL) {
470             cookie = xcb_map_window(conn, con->window->id);
471             LOG("mapping child window (serial %d)\n", cookie.sequence);
472             /* Ignore enter_notifies which are generated when mapping */
473             add_ignore_event(cookie.sequence);
474         }
475
476         cookie = xcb_map_window(conn, con->frame);
477         LOG("mapping container (serial %d)\n", cookie.sequence);
478         /* Ignore enter_notifies which are generated when mapping */
479         add_ignore_event(cookie.sequence);
480         state->mapped = con->mapped;
481     }
482
483     if (fake_notify) {
484         LOG("Sending fake configure notify\n");
485         fake_absolute_configure_notify(con);
486     }
487
488     /* handle all children and floating windows of this node */
489     TAILQ_FOREACH(current, &(con->nodes_head), nodes)
490         x_push_node(current);
491
492     TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
493         x_push_node(current);
494
495     if (con->type != CT_ROOT && con->type != CT_OUTPUT)
496         x_draw_decoration(con);
497 }
498
499 /*
500  * Same idea as in x_push_node(), but this function only unmaps windows. It is
501  * necessary to split this up to handle new fullscreen clients properly: The
502  * new window needs to be mapped and focus needs to be set *before* the
503  * underlying windows are unmapped. Otherwise, focus will revert to the
504  * PointerRoot and will then be set to the new window, generating unnecessary
505  * FocusIn/FocusOut events.
506  *
507  */
508 static void x_push_node_unmaps(Con *con) {
509     Con *current;
510     con_state *state;
511
512     LOG("Pushing changes (with unmaps) for node %p / %s\n", con, con->name);
513     state = state_for_frame(con->frame);
514
515     /* map/unmap if map state changed, also ensure that the child window
516      * is changed if we are mapped *and* in initial state (meaning the
517      * container was empty before, but now got a child) */
518     if ((state->mapped != con->mapped || (con->mapped && state->initial)) &&
519         !con->mapped) {
520         xcb_void_cookie_t cookie;
521         if (con->window != NULL) {
522             /* Set WM_STATE_WITHDRAWN, it seems like Java apps need it */
523             long data[] = { XCB_WM_STATE_WITHDRAWN, XCB_NONE };
524             xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
525                                 atoms[WM_STATE], atoms[WM_STATE], 32, 2, data);
526         }
527
528         cookie = xcb_unmap_window(conn, con->frame);
529         LOG("unmapping container (serial %d)\n", cookie.sequence);
530         /* we need to increase ignore_unmap for this container (if it
531          * contains a window) and for every window "under" this one which
532          * contains a window */
533         if (con->window != NULL) {
534             con->ignore_unmap++;
535             DLOG("ignore_unmap for con %p (frame 0x%08x) now %d\n", con, con->frame, con->ignore_unmap);
536         }
537         /* Ignore enter_notifies which are generated when unmapping */
538         add_ignore_event(cookie.sequence);
539         state->mapped = con->mapped;
540     }
541
542     /* handle all children and floating windows of this node */
543     TAILQ_FOREACH(current, &(con->nodes_head), nodes)
544         x_push_node_unmaps(current);
545
546     TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
547         x_push_node_unmaps(current);
548 }
549
550 /*
551  * Pushes all changes (state of each node, see x_push_node() and the window
552  * stack) to X11.
553  *
554  */
555 void x_push_changes(Con *con) {
556     con_state *state;
557
558     LOG("\n\n PUSHING CHANGES\n\n");
559     x_push_node(con);
560
561     LOG("-- PUSHING WINDOW STACK --\n");
562     bool order_changed = false;
563     /* X11 correctly represents the stack if we push it from bottom to top */
564     CIRCLEQ_FOREACH_REVERSE(state, &state_head, state) {
565         LOG("stack: 0x%08x\n", state->id);
566         con_state *prev = CIRCLEQ_PREV(state, state);
567         con_state *old_prev = CIRCLEQ_PREV(state, old_state);
568         if (prev != old_prev)
569             order_changed = true;
570         if ((state->initial || order_changed) && prev != CIRCLEQ_END(&state_head)) {
571             LOG("Stacking 0x%08x above 0x%08x\n", prev->id, state->id);
572             uint32_t mask = 0;
573             mask |= XCB_CONFIG_WINDOW_SIBLING;
574             mask |= XCB_CONFIG_WINDOW_STACK_MODE;
575             uint32_t values[] = {state->id, XCB_STACK_MODE_ABOVE};
576
577             xcb_configure_window(conn, prev->id, mask, values);
578         }
579         state->initial = false;
580     }
581
582     xcb_window_t to_focus = focused->frame;
583     if (focused->window != NULL)
584         to_focus = focused->window->id;
585
586     if (focused_id != to_focus) {
587         LOG("Updating focus (focused: %p / %s)\n", focused, focused->name);
588         xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, to_focus, XCB_CURRENT_TIME);
589         focused_id = to_focus;
590     }
591
592     xcb_flush(conn);
593     LOG("\n\n ENDING CHANGES\n\n");
594
595     x_push_node_unmaps(con);
596
597     /* save the current stack as old stack */
598     CIRCLEQ_FOREACH(state, &state_head, state) {
599         CIRCLEQ_REMOVE(&old_state_head, state, old_state);
600         CIRCLEQ_INSERT_TAIL(&old_state_head, state, old_state);
601     }
602     CIRCLEQ_FOREACH(state, &old_state_head, old_state) {
603         LOG("old stack: 0x%08x\n", state->id);
604     }
605 }
606
607 /*
608  * Raises the specified container in the internal stack of X windows. The
609  * next call to x_push_changes() will make the change visible in X11.
610  *
611  */
612 void x_raise_con(Con *con) {
613     con_state *state;
614     LOG("raising in new stack: %p / %s\n", con, con->name);
615     state = state_for_frame(con->frame);
616
617     CIRCLEQ_REMOVE(&state_head, state, state);
618     CIRCLEQ_INSERT_HEAD(&state_head, state, state);
619 }
620
621 /*
622  * Sets the WM_NAME property (so, no UTF8, but used only for debugging anyways)
623  * of the given name. Used for properly tagging the windows for easily spotting
624  * i3 windows in xwininfo -root -all.
625  *
626  */
627 void x_set_name(Con *con, const char *name) {
628     struct con_state *state;
629
630     if ((state = state_for_frame(con->frame)) == NULL) {
631         ELOG("window state not found\n");
632         return;
633     }
634
635     FREE(state->name);
636     state->name = sstrdup(name);
637 }