2 * vim:ts=4:sw=4:expandtab
4 * i3bar - an xcb-based status- and ws-bar for i3
5 * © 2010 Axel Wagner and contributors (see also: LICENSE)
7 * xcb.c: Communicating with X
14 #include <xcb/xproto.h>
15 #include <xcb/xcb_aux.h>
16 #include <xcb/xcb_cursor.h>
30 #include <X11/XKBlib.h>
31 #include <X11/extensions/XKB.h>
33 #ifdef I3_ASAN_ENABLED
34 #include <sanitizer/lsan_interface.h>
39 /** This is the equivalent of XC_left_ptr. I’m not sure why xcb doesn’t have a
40 * constant for that. */
41 #define XCB_CURSOR_LEFT_PTR 68
43 /* We save the atoms in an easy to access array, indexed by an enum */
45 #define ATOM_DO(name) name,
46 #include "xcb_atoms.def"
50 xcb_intern_atom_cookie_t atom_cookies[NUM_ATOMS];
51 xcb_atom_t atoms[NUM_ATOMS];
53 /* Variables, that are the same for all functions at all times */
54 xcb_connection_t *xcb_connection;
56 xcb_screen_t *root_screen;
57 xcb_window_t xcb_root;
58 static xcb_cursor_t cursor;
60 /* selection window for tray support */
61 static xcb_window_t selwin = XCB_NONE;
62 static xcb_intern_atom_reply_t *tray_reply = NULL;
64 /* This is needed for integration with libi3 */
65 xcb_connection_t *conn;
67 /* The font we'll use */
70 /* Icon size (based on font size) */
73 xcb_visualtype_t *visual_type;
75 xcb_colormap_t colormap;
77 /* Overall height of the bar (based on font size) */
80 /* These are only relevant for XKB, which we only need for grabbing modifiers */
84 /* Event watchers, to interact with the user */
89 /* The name of current binding mode */
92 /* Indicates whether a new binding mode was recently activated */
93 bool activated_mode = false;
95 /* The parsed colors */
100 color_t focus_bar_fg;
101 color_t focus_bar_bg;
102 color_t focus_sep_fg;
103 color_t active_ws_fg;
104 color_t active_ws_bg;
105 color_t active_ws_border;
106 color_t inactive_ws_fg;
107 color_t inactive_ws_bg;
108 color_t inactive_ws_border;
109 color_t urgent_ws_bg;
110 color_t urgent_ws_fg;
111 color_t urgent_ws_border;
114 color_t focus_ws_border;
115 color_t binding_mode_bg;
116 color_t binding_mode_fg;
117 color_t binding_mode_border;
119 struct xcb_colors_t colors;
121 /* Horizontal offset between a workspace label and button borders */
122 static const int ws_hoff_px = 4;
124 /* Vertical offset between a workspace label and button borders */
125 static const int ws_voff_px = 3;
127 /* Offset between two workspace buttons */
128 static const int ws_spacing_px = 1;
130 /* Offset between the statusline and 1) workspace buttons on the left
131 * 2) the tray or screen edge on the right */
132 static const int sb_hoff_px = 4;
134 /* Additional offset between the tray and the statusline, if the tray is not empty */
135 static const int tray_loff_px = 2;
137 /* Vertical offset between the bar and a separator */
138 static const int sep_voff_px = 4;
140 int _xcb_request_failed(xcb_void_cookie_t cookie, char *err_msg, int line) {
141 xcb_generic_error_t *err;
142 if ((err = xcb_request_check(xcb_connection, cookie)) != NULL) {
143 fprintf(stderr, "[%s:%d] ERROR: %s. X Error Code: %d\n", __FILE__, line, err_msg, err->error_code);
144 return err->error_code;
149 uint32_t get_sep_offset(struct status_block *block) {
150 if (!block->no_separator && block->sep_block_width > 0)
151 return block->sep_block_width / 2 + block->sep_block_width % 2;
155 int get_tray_width(struct tc_head *trayclients) {
156 trayclient *trayclient;
158 TAILQ_FOREACH_REVERSE(trayclient, trayclients, tc_head, tailq) {
159 if (!trayclient->mapped)
161 tray_width += icon_size + logical_px(config.tray_padding);
164 tray_width += logical_px(tray_loff_px);
169 * Draws a separator for the given block if necessary.
172 static void draw_separator(i3_output *output, uint32_t x, struct status_block *block, bool use_focus_colors) {
173 color_t sep_fg = (use_focus_colors ? colors.focus_sep_fg : colors.sep_fg);
174 color_t bar_bg = (use_focus_colors ? colors.focus_bar_bg : colors.bar_bg);
176 uint32_t sep_offset = get_sep_offset(block);
177 if (TAILQ_NEXT(block, blocks) == NULL || sep_offset == 0)
180 uint32_t center_x = x - sep_offset;
181 if (config.separator_symbol == NULL) {
182 /* Draw a classic one pixel, vertical separator. */
183 draw_util_rectangle(&output->statusline_buffer, sep_fg,
185 logical_px(sep_voff_px),
187 bar_height - 2 * logical_px(sep_voff_px));
189 /* Draw a custom separator. */
190 uint32_t separator_x = MAX(x - block->sep_block_width, center_x - separator_symbol_width / 2);
191 draw_util_text(config.separator_symbol, &output->statusline_buffer, sep_fg, bar_bg,
192 separator_x, logical_px(ws_voff_px), x - separator_x);
196 uint32_t predict_statusline_length(bool use_short_text) {
198 struct status_block *block;
200 TAILQ_FOREACH(block, &statusline_head, blocks) {
201 i3String *text = block->full_text;
202 struct status_block_render_desc *render = &block->full_render;
203 if (use_short_text && block->short_text != NULL) {
204 text = block->short_text;
205 render = &block->short_render;
208 if (i3string_get_num_bytes(text) == 0)
211 render->width = predict_text_width(text);
213 render->width += logical_px(2);
215 /* Compute offset and append for text aligment in min_width. */
216 if (block->min_width <= render->width) {
217 render->x_offset = 0;
218 render->x_append = 0;
220 uint32_t padding_width = block->min_width - render->width;
221 switch (block->align) {
223 render->x_append = padding_width;
226 render->x_offset = padding_width;
229 render->x_offset = padding_width / 2;
230 render->x_append = padding_width / 2 + padding_width % 2;
235 width += render->width + render->x_offset + render->x_append;
237 /* If this is not the last block, add some pixels for a separator. */
238 if (TAILQ_NEXT(block, blocks) != NULL)
239 width += block->sep_block_width;
246 * Redraws the statusline to the output's statusline_buffer
248 void draw_statusline(i3_output *output, uint32_t clip_left, bool use_focus_colors, bool use_short_text) {
249 struct status_block *block;
251 color_t bar_color = (use_focus_colors ? colors.focus_bar_bg : colors.bar_bg);
252 draw_util_clear_surface(&output->statusline_buffer, bar_color);
254 /* Use unsigned integer wraparound to clip off the left side.
255 * For example, if clip_left is 75, then x will start at the very large
256 * number INT_MAX-75, which is way outside the surface dimensions. Drawing
257 * to that x position is a no-op which XCB and Cairo safely ignore. Once x moves
258 * up by 75 and goes past INT_MAX, it will wrap around again to 0, and we start
259 * actually rendering content to the surface. */
260 uint32_t x = 0 - clip_left;
262 /* Draw the text of each block */
263 TAILQ_FOREACH(block, &statusline_head, blocks) {
264 i3String *text = block->full_text;
265 struct status_block_render_desc *render = &block->full_render;
266 if (use_short_text && block->short_text != NULL) {
267 text = block->short_text;
268 render = &block->short_render;
271 if (i3string_get_num_bytes(text) == 0)
276 fg_color = colors.urgent_ws_fg;
277 } else if (block->color) {
278 fg_color = draw_util_hex_to_color(block->color);
279 } else if (use_focus_colors) {
280 fg_color = colors.focus_bar_fg;
282 fg_color = colors.bar_fg;
285 color_t bg_color = bar_color;
287 int border_width = (block->border) ? logical_px(1) : 0;
288 int full_render_width = render->width + render->x_offset + render->x_append;
289 if (block->border || block->background || block->urgent) {
290 /* Let's determine the colors first. */
291 color_t border_color = bar_color;
293 border_color = colors.urgent_ws_border;
294 bg_color = colors.urgent_ws_bg;
297 border_color = draw_util_hex_to_color(block->border);
298 if (block->background)
299 bg_color = draw_util_hex_to_color(block->background);
302 /* Draw the border. */
303 draw_util_rectangle(&output->statusline_buffer, border_color,
306 bar_height - logical_px(2));
308 /* Draw the background. */
309 draw_util_rectangle(&output->statusline_buffer, bg_color,
311 logical_px(1) + border_width,
312 full_render_width - 2 * border_width,
313 bar_height - 2 * border_width - logical_px(2));
316 draw_util_text(text, &output->statusline_buffer, fg_color, bg_color,
317 x + render->x_offset + border_width, logical_px(ws_voff_px),
318 render->width - 2 * border_width);
319 x += full_render_width;
321 /* If this is not the last block, draw a separator. */
322 if (TAILQ_NEXT(block, blocks) != NULL) {
323 x += block->sep_block_width;
324 draw_separator(output, x, block, use_focus_colors);
330 * Hides all bars (unmaps them)
333 void hide_bars(void) {
334 if ((config.hide_on_modifier == M_DOCK) || (config.hidden_state == S_SHOW && config.hide_on_modifier == M_HIDE)) {
339 SLIST_FOREACH(walk, outputs, slist) {
343 xcb_unmap_window(xcb_connection, walk->bar.id);
349 * Unhides all bars (maps them)
352 void unhide_bars(void) {
353 if (config.hide_on_modifier != M_HIDE) {
358 xcb_void_cookie_t cookie;
364 SLIST_FOREACH(walk, outputs, slist) {
365 if (walk->bar.id == XCB_NONE) {
368 mask = XCB_CONFIG_WINDOW_X |
369 XCB_CONFIG_WINDOW_Y |
370 XCB_CONFIG_WINDOW_WIDTH |
371 XCB_CONFIG_WINDOW_HEIGHT |
372 XCB_CONFIG_WINDOW_STACK_MODE;
373 values[0] = walk->rect.x;
374 if (config.position == POS_TOP)
375 values[1] = walk->rect.y;
377 values[1] = walk->rect.y + walk->rect.h - bar_height;
378 values[2] = walk->rect.w;
379 values[3] = bar_height;
380 values[4] = XCB_STACK_MODE_ABOVE;
381 DLOG("Reconfiguring window for output %s to %d,%d\n", walk->name, values[0], values[1]);
382 cookie = xcb_configure_window_checked(xcb_connection,
387 if (xcb_request_failed(cookie, "Could not reconfigure window")) {
390 xcb_map_window(xcb_connection, walk->bar.id);
395 * Parse the colors into a format that we can use
398 void init_colors(const struct xcb_color_strings_t *new_colors) {
399 #define PARSE_COLOR(name, def) \
401 colors.name = draw_util_hex_to_color(new_colors->name ? new_colors->name : def); \
403 PARSE_COLOR(bar_fg, "#FFFFFF");
404 PARSE_COLOR(bar_bg, "#000000");
405 PARSE_COLOR(sep_fg, "#666666");
406 PARSE_COLOR(active_ws_fg, "#FFFFFF");
407 PARSE_COLOR(active_ws_bg, "#333333");
408 PARSE_COLOR(active_ws_border, "#333333");
409 PARSE_COLOR(inactive_ws_fg, "#888888");
410 PARSE_COLOR(inactive_ws_bg, "#222222");
411 PARSE_COLOR(inactive_ws_border, "#333333");
412 PARSE_COLOR(urgent_ws_fg, "#FFFFFF");
413 PARSE_COLOR(urgent_ws_bg, "#900000");
414 PARSE_COLOR(urgent_ws_border, "#2f343a");
415 PARSE_COLOR(focus_ws_fg, "#FFFFFF");
416 PARSE_COLOR(focus_ws_bg, "#285577");
417 PARSE_COLOR(focus_ws_border, "#4c7899");
420 #define PARSE_COLOR_FALLBACK(name, fallback) \
422 colors.name = new_colors->name ? draw_util_hex_to_color(new_colors->name) : colors.fallback; \
425 /* For the binding mode indicator colors, we don't hardcode a default.
426 * Instead, we fall back to urgent_ws_* colors. */
427 PARSE_COLOR_FALLBACK(binding_mode_fg, urgent_ws_fg);
428 PARSE_COLOR_FALLBACK(binding_mode_bg, urgent_ws_bg);
429 PARSE_COLOR_FALLBACK(binding_mode_border, urgent_ws_border);
431 /* Similarly, for unspecified focused bar colors, we fall back to the
432 * regular bar colors. */
433 PARSE_COLOR_FALLBACK(focus_bar_fg, bar_fg);
434 PARSE_COLOR_FALLBACK(focus_bar_bg, bar_bg);
435 PARSE_COLOR_FALLBACK(focus_sep_fg, sep_fg);
436 #undef PARSE_COLOR_FALLBACK
439 xcb_flush(xcb_connection);
442 static bool execute_custom_command(xcb_keycode_t input_code, bool event_is_release) {
444 TAILQ_FOREACH(binding, &(config.bindings), bindings) {
445 if ((binding->input_code != input_code) || (binding->release != event_is_release))
448 i3_send_msg(I3_IPC_MESSAGE_TYPE_RUN_COMMAND, binding->command);
455 * Handle a button press event (i.e. a mouse click on one of our bars).
456 * We determine, whether the click occurred on a workspace button or if the scroll-
457 * wheel was used and change the workspace appropriately
460 void handle_button(xcb_button_press_event_t *event) {
461 /* Determine, which bar was clicked */
463 xcb_window_t bar = event->event;
464 SLIST_FOREACH(walk, outputs, slist) {
465 if (walk->bar.id == bar) {
471 DLOG("Unknown bar clicked!\n");
475 DLOG("Got button %d\n", event->detail);
477 /* During button release events, only check for custom commands. */
478 const bool event_is_release = (event->response_type & ~0x80) == XCB_BUTTON_RELEASE;
479 if (event_is_release) {
480 execute_custom_command(event->detail, event_is_release);
484 int32_t x = event->event_x >= 0 ? event->event_x : 0;
485 int workspace_width = 0;
486 i3_ws *cur_ws = NULL, *clicked_ws = NULL, *ws_walk;
488 TAILQ_FOREACH(ws_walk, walk->workspaces, tailq) {
489 int w = 2 * logical_px(ws_hoff_px) + 2 * logical_px(1) + ws_walk->name_width;
490 if (x >= workspace_width && x <= workspace_width + w)
491 clicked_ws = ws_walk;
492 if (ws_walk->visible)
494 workspace_width += w;
495 if (TAILQ_NEXT(ws_walk, tailq) != NULL)
496 workspace_width += logical_px(ws_spacing_px);
499 if (x > workspace_width && child_want_click_events()) {
500 /* If the child asked for click events,
501 * check if a status block has been clicked. */
502 int tray_width = get_tray_width(walk->trayclients);
503 int block_x = 0, last_block_x;
504 int offset = walk->rect.w - walk->statusline_width - tray_width - logical_px((tray_width > 0) * sb_hoff_px);
505 int32_t statusline_x = x - offset;
507 if (statusline_x >= 0 && statusline_x < walk->statusline_width) {
508 struct status_block *block;
509 int sep_offset_remainder = 0;
511 TAILQ_FOREACH(block, &statusline_head, blocks) {
512 i3String *text = block->full_text;
513 struct status_block_render_desc *render = &block->full_render;
514 if (walk->statusline_short_text && block->short_text != NULL) {
515 text = block->short_text;
516 render = &block->short_render;
519 if (i3string_get_num_bytes(text) == 0)
522 last_block_x = block_x;
523 block_x += render->width + render->x_offset + render->x_append + get_sep_offset(block) + sep_offset_remainder;
525 if (statusline_x <= block_x && statusline_x >= last_block_x) {
526 send_block_clicked(event->detail, block->name, block->instance,
527 event->root_x, event->root_y, statusline_x - last_block_x, event->event_y, block_x - last_block_x, bar_height);
531 sep_offset_remainder = block->sep_block_width - get_sep_offset(block);
536 /* If a custom command was specified for this mouse button, it overrides
537 * the default behavior. */
538 if (execute_custom_command(event->detail, event_is_release)) {
542 if (cur_ws == NULL) {
543 DLOG("No workspace active?\n");
546 switch (event->detail) {
547 case XCB_BUTTON_SCROLL_UP:
548 case XCB_BUTTON_SCROLL_LEFT:
549 /* Mouse wheel up. We select the previous ws, if any.
550 * If there is no more workspace, don’t even send the workspace
551 * command, otherwise (with workspace auto_back_and_forth) we’d end
552 * up on the wrong workspace. */
553 if (cur_ws == TAILQ_FIRST(walk->workspaces))
556 cur_ws = TAILQ_PREV(cur_ws, ws_head, tailq);
558 case XCB_BUTTON_SCROLL_DOWN:
559 case XCB_BUTTON_SCROLL_RIGHT:
560 /* Mouse wheel down. We select the next ws, if any.
561 * If there is no more workspace, don’t even send the workspace
562 * command, otherwise (with workspace auto_back_and_forth) we’d end
563 * up on the wrong workspace. */
564 if (cur_ws == TAILQ_LAST(walk->workspaces, ws_head))
567 cur_ws = TAILQ_NEXT(cur_ws, tailq);
572 /* if no workspace was clicked, focus our currently visible
573 * workspace if it is not already focused */
574 if (cur_ws == NULL) {
575 TAILQ_FOREACH(cur_ws, walk->workspaces, tailq) {
576 if (cur_ws->visible && !cur_ws->focused)
581 /* if there is nothing to focus, we are done */
590 /* To properly handle workspace names with double quotes in them, we need
591 * to escape the double quotes. Unfortunately, that’s rather ugly in C: We
592 * first count the number of double quotes, then we allocate a large enough
593 * buffer, then we copy character by character. */
596 const char *utf8_name = cur_ws->canonical_name;
597 for (const char *walk = utf8_name; *walk != '\0'; walk++) {
598 if (*walk == '"' || *walk == '\\')
600 /* While we’re looping through the name anyway, we can save one
605 const size_t len = namelen + strlen("workspace \"\"") + 1;
606 char *buffer = scalloc(len + num_quotes, 1);
607 memcpy(buffer, "workspace \"", strlen("workspace \""));
608 size_t inpos, outpos;
609 for (inpos = 0, outpos = strlen("workspace \"");
612 if (utf8_name[inpos] == '"' || utf8_name[inpos] == '\\') {
613 buffer[outpos] = '\\';
616 buffer[outpos] = utf8_name[inpos];
618 buffer[outpos] = '"';
619 i3_send_msg(I3_IPC_MESSAGE_TYPE_RUN_COMMAND, buffer);
624 * Handle visibility notifications: when none of the bars are visible, e.g.
625 * if windows are in fullscreen on each output, suspend the child process.
628 static void handle_visibility_notify(xcb_visibility_notify_event_t *event) {
629 bool visible = (event->state != XCB_VISIBILITY_FULLY_OBSCURED);
633 SLIST_FOREACH(output, outputs, slist) {
634 if (!output->active) {
637 if (output->bar.id == event->window) {
638 if (output->visible == visible) {
641 output->visible = visible;
643 num_visible += output->visible;
646 if (num_visible == 0) {
648 } else if (num_visible == visible) {
649 /* Wake the child only when transitioning from 0 to 1 visible bar.
650 * We cannot transition from 0 to 2 or more visible bars at once since
651 * visibility events are delivered to each window separately */
657 * Adjusts the size of the tray window and alignment of the tray clients by
658 * configuring their respective x coordinates. To be called when mapping or
659 * unmapping a tray client window.
662 static void configure_trayclients(void) {
663 trayclient *trayclient;
665 SLIST_FOREACH(output, outputs, slist) {
670 TAILQ_FOREACH_REVERSE(trayclient, output->trayclients, tc_head, tailq) {
671 if (!trayclient->mapped)
675 DLOG("Configuring tray window %08x to x=%d\n",
676 trayclient->win, output->rect.w - (clients * (icon_size + logical_px(config.tray_padding))));
677 uint32_t x = output->rect.w - (clients * (icon_size + logical_px(config.tray_padding)));
678 xcb_configure_window(xcb_connection,
687 * Handles ClientMessages (messages sent from another client directly to us).
689 * At the moment, only the tray window will receive client messages. All
690 * supported client messages currently are _NET_SYSTEM_TRAY_OPCODE.
693 static void handle_client_message(xcb_client_message_event_t *event) {
694 if (event->type == atoms[I3_SYNC]) {
695 xcb_window_t window = event->data.data32[0];
696 uint32_t rnd = event->data.data32[1];
697 /* Forward the request to i3 via the IPC interface so that all pending
698 * IPC messages are guaranteed to be handled. */
699 char *payload = NULL;
700 sasprintf(&payload, "{\"rnd\":%d, \"window\":%d}", rnd, window);
701 i3_send_msg(I3_IPC_MESSAGE_TYPE_SYNC, payload);
703 } else if (event->type == atoms[_NET_SYSTEM_TRAY_OPCODE] &&
704 event->format == 32) {
705 DLOG("_NET_SYSTEM_TRAY_OPCODE received\n");
706 /* event->data.data32[0] is the timestamp */
707 uint32_t op = event->data.data32[1];
710 if (op == SYSTEM_TRAY_REQUEST_DOCK) {
711 xcb_window_t client = event->data.data32[2];
713 mask = XCB_CW_EVENT_MASK;
715 /* Needed to get the most recent value of XEMBED_MAPPED. */
716 values[0] = XCB_EVENT_MASK_PROPERTY_CHANGE;
717 /* Needed for UnmapNotify events. */
718 values[0] |= XCB_EVENT_MASK_STRUCTURE_NOTIFY;
719 /* Needed because some tray applications (e.g., VLC) use
720 * override_redirect which causes no ConfigureRequest to be sent. */
721 values[0] |= XCB_EVENT_MASK_RESIZE_REDIRECT;
723 xcb_change_window_attributes(xcb_connection, client, mask, values);
725 /* Request the _XEMBED_INFO property. The XEMBED specification
726 * (which is referred by the tray specification) says this *has* to
727 * be set, but VLC does not set it… */
730 xcb_get_property_cookie_t xembedc;
731 xcb_generic_error_t *error;
732 xembedc = xcb_get_property(xcb_connection,
736 XCB_GET_PROPERTY_TYPE_ANY,
740 xcb_get_property_reply_t *xembedr = xcb_get_property_reply(xcb_connection,
744 ELOG("Error getting _XEMBED_INFO property: error_code %d\n",
749 if (xembedr != NULL && xembedr->length != 0) {
750 DLOG("xembed format = %d, len = %d\n", xembedr->format, xembedr->length);
751 uint32_t *xembed = xcb_get_property_value(xembedr);
752 DLOG("xembed version = %d\n", xembed[0]);
753 DLOG("xembed flags = %d\n", xembed[1]);
754 map_it = ((xembed[1] & XEMBED_MAPPED) == XEMBED_MAPPED);
755 xe_version = xembed[0];
760 ELOG("Window %08x violates the XEMBED protocol, _XEMBED_INFO not set\n", client);
763 DLOG("X window %08x requested docking\n", client);
764 i3_output *output = NULL;
765 i3_output *walk = NULL;
766 tray_output_t *tray_output = NULL;
767 /* We need to iterate through the tray_output assignments first in
768 * order to prioritize them. Otherwise, if this bar manages two
769 * outputs and both are assigned as tray_output as well, the first
770 * output in our list would receive the tray rather than the first
771 * one defined via tray_output. */
772 TAILQ_FOREACH(tray_output, &(config.tray_outputs), tray_outputs) {
773 SLIST_FOREACH(walk, outputs, slist) {
777 if (strcasecmp(walk->name, tray_output->output) == 0) {
778 DLOG("Found tray_output assignment for output %s.\n", walk->name);
783 if (walk->primary && strcasecmp("primary", tray_output->output) == 0) {
784 DLOG("Found tray_output assignment on primary output %s.\n", walk->name);
790 /* If we found an output, we're done. */
795 /* If no tray_output has been specified, we fall back to the first
796 * available output. */
797 if (output == NULL && TAILQ_EMPTY(&(config.tray_outputs))) {
798 SLIST_FOREACH(walk, outputs, slist) {
801 DLOG("Falling back to output %s because no primary output is configured\n", walk->name);
807 if (output == NULL) {
808 ELOG("No output found\n");
812 xcb_void_cookie_t rcookie = xcb_reparent_window(xcb_connection,
815 output->rect.w - icon_size - logical_px(config.tray_padding),
816 logical_px(config.tray_padding));
817 if (xcb_request_failed(rcookie, "Could not reparent window. Maybe it is using an incorrect depth/visual?"))
820 /* We reconfigure the window to use a reasonable size. The systray
821 * specification explicitly says:
822 * Tray icons may be assigned any size by the system tray, and
823 * should do their best to cope with any size effectively
825 mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
826 values[0] = icon_size;
827 values[1] = icon_size;
828 xcb_configure_window(xcb_connection,
833 /* send the XEMBED_EMBEDDED_NOTIFY message */
834 void *event = scalloc(32, 1);
835 xcb_client_message_event_t *ev = event;
836 ev->response_type = XCB_CLIENT_MESSAGE;
838 ev->type = atoms[_XEMBED];
840 ev->data.data32[0] = XCB_CURRENT_TIME;
841 ev->data.data32[1] = XEMBED_EMBEDDED_NOTIFY;
842 ev->data.data32[2] = output->bar.id;
843 ev->data.data32[3] = xe_version;
844 xcb_send_event(xcb_connection,
847 XCB_EVENT_MASK_NO_EVENT,
851 /* Put the client inside the save set. Upon termination (whether
852 * killed or normal exit does not matter) of i3bar, these clients
853 * will be correctly reparented to their most closest living
854 * ancestor. Without this, tray icons might die when i3bar
856 xcb_change_save_set(xcb_connection, XCB_SET_MODE_INSERT, client);
858 trayclient *tc = smalloc(sizeof(trayclient));
860 tc->xe_version = xe_version;
862 TAILQ_INSERT_TAIL(output->trayclients, tc, tailq);
865 DLOG("Mapping dock client\n");
866 xcb_map_window(xcb_connection, client);
868 DLOG("Not mapping dock client yet\n");
870 /* Trigger an update to copy the statusline text to the appropriate
872 configure_trayclients();
879 * Handles DestroyNotify events by removing the tray client from the data
880 * structure. According to the XEmbed protocol, this is one way for a tray
881 * client to finish the protocol. After this event is received, there is no
882 * further interaction with the tray client.
884 * See: https://standards.freedesktop.org/xembed-spec/xembed-spec-latest.html
887 static void handle_destroy_notify(xcb_destroy_notify_event_t *event) {
888 DLOG("DestroyNotify for window = %08x, event = %08x\n", event->window, event->event);
891 SLIST_FOREACH(walk, outputs, slist) {
894 DLOG("checking output %s\n", walk->name);
895 trayclient *trayclient;
896 TAILQ_FOREACH(trayclient, walk->trayclients, tailq) {
897 if (trayclient->win != event->window) {
901 DLOG("Removing tray client with window ID %08x\n", event->window);
902 TAILQ_REMOVE(walk->trayclients, trayclient, tailq);
905 /* Trigger an update, we now have more space for the statusline */
906 configure_trayclients();
914 * Handles MapNotify events. These events happen when a tray client shows its
915 * window. We respond by realigning the tray clients.
918 static void handle_map_notify(xcb_map_notify_event_t *event) {
919 DLOG("MapNotify for window = %08x, event = %08x\n", event->window, event->event);
922 SLIST_FOREACH(walk, outputs, slist) {
925 DLOG("checking output %s\n", walk->name);
926 trayclient *trayclient;
927 TAILQ_FOREACH(trayclient, walk->trayclients, tailq) {
928 if (trayclient->win != event->window)
931 DLOG("Tray client mapped (window ID %08x). Adjusting tray.\n", event->window);
932 trayclient->mapped = true;
934 /* Trigger an update, we now have more space for the statusline */
935 configure_trayclients();
942 * Handles UnmapNotify events. These events happen when a tray client hides its
943 * window. We respond by realigning the tray clients.
946 static void handle_unmap_notify(xcb_unmap_notify_event_t *event) {
947 DLOG("UnmapNotify for window = %08x, event = %08x\n", event->window, event->event);
950 SLIST_FOREACH(walk, outputs, slist) {
953 DLOG("checking output %s\n", walk->name);
954 trayclient *trayclient;
955 TAILQ_FOREACH(trayclient, walk->trayclients, tailq) {
956 if (trayclient->win != event->window)
959 DLOG("Tray client unmapped (window ID %08x). Adjusting tray.\n", event->window);
960 trayclient->mapped = false;
962 /* Trigger an update, we now have more space for the statusline */
963 configure_trayclients();
971 * Handle PropertyNotify messages. Currently only the _XEMBED_INFO property is
972 * handled, which tells us whether a dock client should be mapped or unmapped.
975 static void handle_property_notify(xcb_property_notify_event_t *event) {
976 DLOG("PropertyNotify\n");
977 if (event->atom == atoms[_XEMBED_INFO] &&
978 event->state == XCB_PROPERTY_NEW_VALUE) {
979 DLOG("xembed_info updated\n");
980 trayclient *trayclient = NULL, *walk;
982 SLIST_FOREACH(o_walk, outputs, slist) {
986 TAILQ_FOREACH(walk, o_walk->trayclients, tailq) {
987 if (walk->win != event->window)
997 ELOG("PropertyNotify received for unknown window %08x\n",
1001 xcb_get_property_cookie_t xembedc;
1002 xembedc = xcb_get_property_unchecked(xcb_connection,
1005 atoms[_XEMBED_INFO],
1006 XCB_GET_PROPERTY_TYPE_ANY,
1010 xcb_get_property_reply_t *xembedr = xcb_get_property_reply(xcb_connection,
1013 if (xembedr == NULL || xembedr->length == 0) {
1014 DLOG("xembed_info unset\n");
1018 DLOG("xembed format = %d, len = %d\n", xembedr->format, xembedr->length);
1019 uint32_t *xembed = xcb_get_property_value(xembedr);
1020 DLOG("xembed version = %d\n", xembed[0]);
1021 DLOG("xembed flags = %d\n", xembed[1]);
1022 bool map_it = ((xembed[1] & XEMBED_MAPPED) == XEMBED_MAPPED);
1023 DLOG("map state now %d\n", map_it);
1024 if (trayclient->mapped && !map_it) {
1025 /* need to unmap the window */
1026 xcb_unmap_window(xcb_connection, trayclient->win);
1027 } else if (!trayclient->mapped && map_it) {
1028 /* need to map the window */
1029 xcb_map_window(xcb_connection, trayclient->win);
1036 * If a tray client attempts to change its size we deny the request and respond
1037 * by telling it its actual size.
1040 static void handle_configuration_change(xcb_window_t window) {
1041 trayclient *trayclient;
1043 SLIST_FOREACH(output, outputs, slist) {
1044 if (!output->active)
1048 TAILQ_FOREACH_REVERSE(trayclient, output->trayclients, tc_head, tailq) {
1049 if (!trayclient->mapped)
1053 if (trayclient->win != window)
1056 xcb_rectangle_t rect;
1057 rect.x = output->rect.w - (clients * (icon_size + logical_px(config.tray_padding)));
1058 rect.y = logical_px(config.tray_padding);
1059 rect.width = icon_size;
1060 rect.height = icon_size;
1062 DLOG("This is a tray window. x = %d\n", rect.x);
1063 fake_configure_notify(xcb_connection, rect, window, 0);
1068 DLOG("WARNING: Could not find corresponding tray window.\n");
1071 static void handle_configure_request(xcb_configure_request_event_t *event) {
1072 DLOG("ConfigureRequest for window = %08x\n", event->window);
1073 handle_configuration_change(event->window);
1076 static void handle_resize_request(xcb_resize_request_event_t *event) {
1077 DLOG("ResizeRequest for window = %08x\n", event->window);
1078 handle_configuration_change(event->window);
1082 * This function is called immediately before the main loop locks. We check for
1083 * events from X11, handle them, then flush our outgoing queue.
1086 void xcb_prep_cb(struct ev_loop *loop, ev_prepare *watcher, int revents) {
1087 xcb_generic_event_t *event;
1089 if (xcb_connection_has_error(xcb_connection)) {
1090 ELOG("X11 connection was closed unexpectedly - maybe your X server terminated / crashed?\n");
1091 #ifdef I3_ASAN_ENABLED
1092 __lsan_do_leak_check();
1097 while ((event = xcb_poll_for_event(xcb_connection)) != NULL) {
1098 if (event->response_type == 0) {
1099 xcb_generic_error_t *error = (xcb_generic_error_t *)event;
1100 DLOG("Received X11 error, sequence 0x%x, error_code = %d\n", error->sequence, error->error_code);
1105 int type = (event->response_type & ~0x80);
1107 if (type == xkb_base && xkb_base > -1) {
1108 DLOG("received an xkb event\n");
1110 xcb_xkb_state_notify_event_t *state = (xcb_xkb_state_notify_event_t *)event;
1111 const uint32_t mod = (config.modifier & 0xFFFF);
1112 mod_pressed = (mod != 0 && (state->mods & mod) == mod);
1113 if (state->xkbType == XCB_XKB_STATE_NOTIFY && config.modifier != XCB_NONE) {
1115 activated_mode = false;
1117 } else if (!activated_mode) {
1127 case XCB_VISIBILITY_NOTIFY:
1128 /* Visibility change: a bar is [un]obscured by other window */
1129 handle_visibility_notify((xcb_visibility_notify_event_t *)event);
1132 if (((xcb_expose_event_t *)event)->count == 0) {
1133 /* Expose-events happen, when the window needs to be redrawn */
1138 case XCB_BUTTON_RELEASE:
1139 case XCB_BUTTON_PRESS:
1140 /* Button press events are mouse buttons clicked on one of our bars */
1141 handle_button((xcb_button_press_event_t *)event);
1143 case XCB_CLIENT_MESSAGE:
1144 /* Client messages are used for client-to-client communication, for
1145 * example system tray widgets talk to us directly via client messages. */
1146 handle_client_message((xcb_client_message_event_t *)event);
1148 case XCB_DESTROY_NOTIFY:
1149 /* DestroyNotify signifies the end of the XEmbed protocol */
1150 handle_destroy_notify((xcb_destroy_notify_event_t *)event);
1152 case XCB_UNMAP_NOTIFY:
1153 /* UnmapNotify is received when a tray client hides its window. */
1154 handle_unmap_notify((xcb_unmap_notify_event_t *)event);
1156 case XCB_MAP_NOTIFY:
1157 handle_map_notify((xcb_map_notify_event_t *)event);
1159 case XCB_PROPERTY_NOTIFY:
1160 /* PropertyNotify */
1161 handle_property_notify((xcb_property_notify_event_t *)event);
1163 case XCB_CONFIGURE_REQUEST:
1164 /* ConfigureRequest, sent by a tray child */
1165 handle_configure_request((xcb_configure_request_event_t *)event);
1167 case XCB_RESIZE_REQUEST:
1168 /* ResizeRequest sent by a tray child using override_redirect. */
1169 handle_resize_request((xcb_resize_request_event_t *)event);
1175 xcb_flush(xcb_connection);
1179 * Dummy callback. We only need this, so that the prepare and check watchers
1183 void xcb_io_cb(struct ev_loop *loop, ev_io *watcher, int revents) {
1187 * Early initialization of the connection to X11: Everything which does not
1188 * depend on 'config'.
1191 char *init_xcb_early() {
1192 /* FIXME: xcb_connect leaks memory */
1193 xcb_connection = xcb_connect(NULL, &screen);
1194 if (xcb_connection_has_error(xcb_connection)) {
1195 ELOG("Cannot open display\n");
1198 conn = xcb_connection;
1199 DLOG("Connected to xcb\n");
1201 /* We have to request the atoms we need */
1202 #define ATOM_DO(name) atom_cookies[name] = xcb_intern_atom(xcb_connection, 0, strlen(#name), #name);
1203 #include "xcb_atoms.def"
1205 root_screen = xcb_aux_get_screen(xcb_connection, screen);
1206 xcb_root = root_screen->root;
1208 depth = root_screen->root_depth;
1209 colormap = root_screen->default_colormap;
1210 visual_type = get_visualtype(root_screen);
1212 xcb_cursor_context_t *cursor_ctx;
1213 if (xcb_cursor_context_new(conn, root_screen, &cursor_ctx) == 0) {
1214 cursor = xcb_cursor_load_cursor(cursor_ctx, "left_ptr");
1215 xcb_cursor_context_free(cursor_ctx);
1217 cursor = xcb_generate_id(xcb_connection);
1218 i3Font cursor_font = load_font("cursor", false);
1219 xcb_create_glyph_cursor(
1222 cursor_font.specific.xcb.id,
1223 cursor_font.specific.xcb.id,
1224 XCB_CURSOR_LEFT_PTR,
1225 XCB_CURSOR_LEFT_PTR + 1,
1227 65535, 65535, 65535);
1230 /* The various watchers to communicate with xcb */
1231 xcb_io = smalloc(sizeof(ev_io));
1232 xcb_prep = smalloc(sizeof(ev_prepare));
1234 ev_io_init(xcb_io, &xcb_io_cb, xcb_get_file_descriptor(xcb_connection), EV_READ);
1235 ev_prepare_init(xcb_prep, &xcb_prep_cb);
1237 ev_io_start(main_loop, xcb_io);
1238 ev_prepare_start(main_loop, xcb_prep);
1240 /* Now we get the atoms and save them in a nice data structure */
1243 char *path = root_atom_contents("I3_SOCKET_PATH", xcb_connection, screen);
1249 * Register for xkb keyevents. To grab modifiers without blocking other applications from receiving key events
1250 * involving that modifier, we sadly have to use xkb which is not yet fully supported
1254 void register_xkb_keyevents() {
1255 const xcb_query_extension_reply_t *extreply;
1256 extreply = xcb_get_extension_data(conn, &xcb_xkb_id);
1257 if (!extreply->present) {
1258 ELOG("xkb is not present on this server\n");
1261 DLOG("initializing xcb-xkb\n");
1262 xcb_xkb_use_extension(conn, XCB_XKB_MAJOR_VERSION, XCB_XKB_MINOR_VERSION);
1263 xcb_xkb_select_events(conn,
1264 XCB_XKB_ID_USE_CORE_KBD,
1265 XCB_XKB_EVENT_TYPE_STATE_NOTIFY,
1267 XCB_XKB_EVENT_TYPE_STATE_NOTIFY,
1271 xkb_base = extreply->first_event;
1275 * Deregister from xkb keyevents.
1278 void deregister_xkb_keyevents() {
1279 xcb_xkb_select_events(conn,
1280 XCB_XKB_ID_USE_CORE_KBD,
1290 * Initialization which depends on 'config' being usable. Called after the
1291 * configuration has arrived.
1294 void init_xcb_late(char *fontname) {
1295 if (fontname == NULL)
1296 fontname = "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1";
1299 font = load_font(fontname, true);
1301 DLOG("Calculated font height: %d\n", font.height);
1302 bar_height = font.height + 2 * logical_px(ws_voff_px);
1303 icon_size = bar_height - 2 * logical_px(config.tray_padding);
1305 if (config.separator_symbol)
1306 separator_symbol_width = predict_text_width(config.separator_symbol);
1308 xcb_flush(xcb_connection);
1310 if (config.hide_on_modifier == M_HIDE)
1311 register_xkb_keyevents();
1315 * Inform clients waiting for a new _NET_SYSTEM_TRAY that we took the
1319 static void send_tray_clientmessage(void) {
1320 uint8_t buffer[32] = {0};
1321 xcb_client_message_event_t *ev = (xcb_client_message_event_t *)buffer;
1323 ev->response_type = XCB_CLIENT_MESSAGE;
1324 ev->window = xcb_root;
1325 ev->type = atoms[MANAGER];
1327 ev->data.data32[0] = XCB_CURRENT_TIME;
1328 ev->data.data32[1] = tray_reply->atom;
1329 ev->data.data32[2] = selwin;
1331 xcb_send_event(xcb_connection,
1339 * Initializes tray support by requesting the appropriate _NET_SYSTEM_TRAY atom
1340 * for the X11 display we are running on, then acquiring the selection for this
1341 * atom. Afterwards, tray clients will send ClientMessages to our window.
1344 void init_tray(void) {
1345 DLOG("Initializing system tray functionality\n");
1346 /* request the tray manager atom for the X11 display we are running on */
1347 char atomname[strlen("_NET_SYSTEM_TRAY_S") + 11];
1348 snprintf(atomname, strlen("_NET_SYSTEM_TRAY_S") + 11, "_NET_SYSTEM_TRAY_S%d", screen);
1349 xcb_intern_atom_cookie_t tray_cookie;
1350 if (tray_reply == NULL)
1351 tray_cookie = xcb_intern_atom(xcb_connection, 0, strlen(atomname), atomname);
1353 /* tray support: we need a window to own the selection */
1354 selwin = xcb_generate_id(xcb_connection);
1355 uint32_t selmask = XCB_CW_BACK_PIXEL | XCB_CW_BORDER_PIXEL | XCB_CW_OVERRIDE_REDIRECT | XCB_CW_COLORMAP;
1356 uint32_t selval[] = {root_screen->black_pixel, root_screen->black_pixel, 1, colormap};
1357 xcb_create_window(xcb_connection,
1364 XCB_WINDOW_CLASS_INPUT_OUTPUT,
1365 visual_type->visual_id,
1369 uint32_t orientation = _NET_SYSTEM_TRAY_ORIENTATION_HORZ;
1371 xcb_change_property(xcb_connection,
1372 XCB_PROP_MODE_REPLACE,
1374 atoms[_NET_SYSTEM_TRAY_ORIENTATION],
1379 xcb_change_property(xcb_connection,
1380 XCB_PROP_MODE_REPLACE,
1382 atoms[_NET_SYSTEM_TRAY_VISUAL],
1386 &visual_type->visual_id);
1390 if (tray_reply == NULL) {
1391 if (!(tray_reply = xcb_intern_atom_reply(xcb_connection, tray_cookie, NULL))) {
1392 ELOG("Could not get atom %s\n", atomname);
1397 xcb_set_selection_owner(xcb_connection,
1402 /* Verify that we have the selection */
1403 xcb_get_selection_owner_cookie_t selcookie;
1404 xcb_get_selection_owner_reply_t *selreply;
1406 selcookie = xcb_get_selection_owner(xcb_connection, tray_reply->atom);
1407 if (!(selreply = xcb_get_selection_owner_reply(xcb_connection, selcookie, NULL))) {
1408 ELOG("Could not get selection owner for %s\n", atomname);
1412 if (selreply->owner != selwin) {
1413 ELOG("Could not set the %s selection. "
1414 "Maybe another tray is already running?\n",
1416 /* NOTE that this error is not fatal. We just can’t provide tray
1424 send_tray_clientmessage();
1428 * We need to set the _NET_SYSTEM_TRAY_COLORS atom on the tray selection window
1429 * to make GTK+ 3 applets with symbolic icons visible. If the colors are unset,
1430 * they assume a light background.
1431 * See also https://bugzilla.gnome.org/show_bug.cgi?id=679591
1434 void init_tray_colors(void) {
1435 /* Convert colors.bar_fg (#rrggbb) to 16-bit RGB */
1436 const char *bar_fg = (config.colors.bar_fg ? config.colors.bar_fg : "#FFFFFF");
1438 DLOG("Setting bar_fg = %s as _NET_SYSTEM_TRAY_COLORS\n", bar_fg);
1440 char strgroups[3][3] = {{bar_fg[1], bar_fg[2], '\0'},
1441 {bar_fg[3], bar_fg[4], '\0'},
1442 {bar_fg[5], bar_fg[6], '\0'}};
1443 const uint8_t r = strtol(strgroups[0], NULL, 16);
1444 const uint8_t g = strtol(strgroups[1], NULL, 16);
1445 const uint8_t b = strtol(strgroups[2], NULL, 16);
1447 const uint16_t r16 = ((uint16_t)r << 8) | r;
1448 const uint16_t g16 = ((uint16_t)g << 8) | g;
1449 const uint16_t b16 = ((uint16_t)b << 8) | b;
1451 const uint32_t tray_colors[12] = {
1452 r16, g16, b16, /* foreground color */
1453 r16, g16, b16, /* error color */
1454 r16, g16, b16, /* warning color */
1455 r16, g16, b16, /* success color */
1458 xcb_change_property(xcb_connection,
1459 XCB_PROP_MODE_REPLACE,
1461 atoms[_NET_SYSTEM_TRAY_COLORS],
1469 * Cleanup the xcb stuff.
1470 * Called once, before the program terminates.
1473 void clean_xcb(void) {
1478 xcb_free_cursor(xcb_connection, cursor);
1479 xcb_flush(xcb_connection);
1480 xcb_aux_sync(xcb_connection);
1481 xcb_disconnect(xcb_connection);
1483 ev_prepare_stop(main_loop, xcb_prep);
1484 ev_io_stop(main_loop, xcb_io);
1491 * Get the earlier requested atoms and save them in the prepared data structure
1494 void get_atoms(void) {
1495 xcb_intern_atom_reply_t *reply;
1496 #define ATOM_DO(name) \
1497 reply = xcb_intern_atom_reply(xcb_connection, atom_cookies[name], NULL); \
1498 if (reply == NULL) { \
1499 ELOG("Could not get atom %s\n", #name); \
1500 exit(EXIT_FAILURE); \
1502 atoms[name] = reply->atom; \
1505 #include "xcb_atoms.def"
1506 DLOG("Got atoms\n");
1510 * Reparents all tray clients of the specified output to the root window. This
1511 * is either used when shutting down, when an output appears (xrandr --output
1512 * VGA1 --off) or when the primary output changes.
1514 * Applications using the tray will start the protocol from the beginning again
1518 void kick_tray_clients(i3_output *output) {
1519 if (TAILQ_EMPTY(output->trayclients))
1522 trayclient *trayclient;
1523 while (!TAILQ_EMPTY(output->trayclients)) {
1524 trayclient = TAILQ_FIRST(output->trayclients);
1525 /* Unmap, then reparent (to root) the tray client windows */
1526 xcb_unmap_window(xcb_connection, trayclient->win);
1527 xcb_reparent_window(xcb_connection,
1533 /* We remove the trayclient right here. We might receive an UnmapNotify
1534 * event afterwards, but better safe than sorry. */
1535 TAILQ_REMOVE(output->trayclients, trayclient, tailq);
1539 /* Fake a DestroyNotify so that Qt re-adds tray icons.
1540 * We cannot actually destroy the window because then Qt will not restore
1541 * its event mask on the new window. */
1542 uint8_t buffer[32] = {0};
1543 xcb_destroy_notify_event_t *event = (xcb_destroy_notify_event_t *)buffer;
1545 event->response_type = XCB_DESTROY_NOTIFY;
1546 event->event = selwin;
1547 event->window = selwin;
1549 xcb_send_event(conn, false, selwin, XCB_EVENT_MASK_STRUCTURE_NOTIFY, (char *)event);
1551 send_tray_clientmessage();
1555 * Destroy the bar of the specified output
1558 void destroy_window(i3_output *output) {
1559 if (output == NULL) {
1562 if (output->bar.id == XCB_NONE) {
1566 kick_tray_clients(output);
1567 xcb_destroy_window(xcb_connection, output->bar.id);
1568 output->bar.id = XCB_NONE;
1571 /* Strut partial tells i3 where to reserve space for i3bar. This is determined
1572 * by the `position` bar config directive. */
1573 xcb_void_cookie_t config_strut_partial(i3_output *output) {
1574 /* A local struct to save the strut_partial property */
1580 uint32_t left_start_y;
1581 uint32_t left_end_y;
1582 uint32_t right_start_y;
1583 uint32_t right_end_y;
1584 uint32_t top_start_x;
1586 uint32_t bottom_start_x;
1587 uint32_t bottom_end_x;
1588 } __attribute__((__packed__)) strut_partial;
1589 memset(&strut_partial, 0, sizeof(strut_partial));
1591 switch (config.position) {
1595 strut_partial.top = bar_height;
1596 strut_partial.top_start_x = output->rect.x;
1597 strut_partial.top_end_x = output->rect.x + output->rect.w;
1600 strut_partial.bottom = bar_height;
1601 strut_partial.bottom_start_x = output->rect.x;
1602 strut_partial.bottom_end_x = output->rect.x + output->rect.w;
1605 return xcb_change_property(xcb_connection,
1606 XCB_PROP_MODE_REPLACE,
1608 atoms[_NET_WM_STRUT_PARTIAL],
1616 * Reconfigure all bars and create new bars for recently activated outputs
1619 void reconfig_windows(bool redraw_bars) {
1622 static bool tray_configured = false;
1625 SLIST_FOREACH(walk, outputs, slist) {
1626 if (!walk->active) {
1627 /* If an output is not active, we destroy its bar */
1628 /* FIXME: Maybe we rather want to unmap? */
1629 DLOG("Destroying window for output %s\n", walk->name);
1630 destroy_window(walk);
1633 if (walk->bar.id == XCB_NONE) {
1634 DLOG("Creating window for output %s\n", walk->name);
1636 xcb_window_t bar_id = xcb_generate_id(xcb_connection);
1637 xcb_pixmap_t buffer_id = xcb_generate_id(xcb_connection);
1638 xcb_pixmap_t statusline_buffer_id = xcb_generate_id(xcb_connection);
1639 mask = XCB_CW_BACK_PIXEL | XCB_CW_BORDER_PIXEL | XCB_CW_OVERRIDE_REDIRECT | XCB_CW_EVENT_MASK | XCB_CW_COLORMAP | XCB_CW_CURSOR;
1641 values[0] = colors.bar_bg.colorpixel;
1642 values[1] = root_screen->black_pixel;
1643 /* If hide_on_modifier is set to hide or invisible mode, i3 is not supposed to manage our bar windows */
1644 values[2] = (config.hide_on_modifier == M_DOCK ? 0 : 1);
1645 /* We enable the following EventMask fields:
1646 * EXPOSURE, to get expose events (we have to re-draw then)
1647 * SUBSTRUCTURE_REDIRECT, to get ConfigureRequests when the tray
1648 * child windows use ConfigureWindow
1649 * BUTTON_PRESS, to handle clicks on the workspace buttons
1651 values[3] = XCB_EVENT_MASK_EXPOSURE |
1652 XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT |
1653 XCB_EVENT_MASK_BUTTON_PRESS |
1654 XCB_EVENT_MASK_BUTTON_RELEASE;
1655 if (config.hide_on_modifier == M_DOCK) {
1656 /* If the bar is normally visible, catch visibility change events to suspend
1657 * the status process when the bar is obscured by full-screened windows. */
1658 values[3] |= XCB_EVENT_MASK_VISIBILITY_CHANGE;
1659 walk->visible = true;
1661 values[4] = colormap;
1664 xcb_void_cookie_t win_cookie = xcb_create_window_checked(xcb_connection,
1668 walk->rect.x, walk->rect.y + walk->rect.h - bar_height,
1669 walk->rect.w, bar_height,
1671 XCB_WINDOW_CLASS_INPUT_OUTPUT,
1672 visual_type->visual_id,
1676 /* The double-buffer we use to render stuff off-screen */
1677 xcb_void_cookie_t pm_cookie = xcb_create_pixmap_checked(xcb_connection,
1684 /* The double-buffer we use to render the statusline before copying to buffer */
1685 xcb_void_cookie_t slpm_cookie = xcb_create_pixmap_checked(xcb_connection,
1687 statusline_buffer_id,
1692 /* Set the WM_CLASS and WM_NAME (we don't need UTF-8) atoms */
1693 xcb_void_cookie_t class_cookie;
1694 class_cookie = xcb_change_property(xcb_connection,
1695 XCB_PROP_MODE_REPLACE,
1700 (strlen("i3bar") + 1) * 2,
1704 sasprintf(&name, "i3bar for output %s", walk->name);
1705 xcb_void_cookie_t name_cookie;
1706 name_cookie = xcb_change_property(xcb_connection,
1707 XCB_PROP_MODE_REPLACE,
1716 /* We want dock windows (for now). When override_redirect is set, i3 is ignoring
1718 xcb_void_cookie_t dock_cookie = xcb_change_property(xcb_connection,
1719 XCB_PROP_MODE_REPLACE,
1721 atoms[_NET_WM_WINDOW_TYPE],
1725 (unsigned char *)&atoms[_NET_WM_WINDOW_TYPE_DOCK]);
1727 draw_util_surface_init(xcb_connection, &walk->bar, bar_id, NULL, walk->rect.w, bar_height);
1728 draw_util_surface_init(xcb_connection, &walk->buffer, buffer_id, NULL, walk->rect.w, bar_height);
1729 draw_util_surface_init(xcb_connection, &walk->statusline_buffer, statusline_buffer_id, NULL, walk->rect.w, bar_height);
1731 xcb_void_cookie_t strut_cookie = config_strut_partial(walk);
1733 /* We finally map the bar (display it on screen), unless the modifier-switch is on */
1734 xcb_void_cookie_t map_cookie;
1735 if (config.hide_on_modifier == M_DOCK) {
1736 map_cookie = xcb_map_window_checked(xcb_connection, bar_id);
1739 if (xcb_request_failed(win_cookie, "Could not create window") ||
1740 xcb_request_failed(pm_cookie, "Could not create pixmap") ||
1741 xcb_request_failed(slpm_cookie, "Could not create statusline pixmap") ||
1742 xcb_request_failed(dock_cookie, "Could not set dock mode") ||
1743 xcb_request_failed(class_cookie, "Could not set WM_CLASS") ||
1744 xcb_request_failed(name_cookie, "Could not set WM_NAME") ||
1745 xcb_request_failed(strut_cookie, "Could not set strut") ||
1746 ((config.hide_on_modifier == M_DOCK) && xcb_request_failed(map_cookie, "Could not map window"))) {
1750 /* Unless "tray_output none" was specified, we need to initialize the tray. */
1751 bool no_tray = false;
1752 if (!(TAILQ_EMPTY(&(config.tray_outputs)))) {
1753 no_tray = strcasecmp(TAILQ_FIRST(&(config.tray_outputs))->output, "none") == 0;
1757 * There are three scenarios in which we need to initialize the tray:
1758 * 1. A specific output was listed in tray_outputs which is also
1759 * in the list of outputs managed by this bar.
1760 * 2. No tray_output directive was specified. In this case, we
1761 * use the first available output.
1762 * 3. 'tray_output primary' was specified. In this case we use the
1765 * Three scenarios in which we specifically don't want to
1766 * initialize the tray are:
1767 * 1. 'tray_output none' was specified.
1768 * 2. A specific output was listed as a tray_output, but is not
1769 * one of the outputs managed by this bar. For example, consider
1770 * tray_outputs == [VGA-1], but outputs == [HDMI-1].
1771 * 3. 'tray_output primary' was specified and no output in the list
1774 if (!tray_configured && !no_tray) {
1775 /* If no tray_output was specified, we go ahead and initialize the tray as
1776 * we will be using the first available output. */
1777 if (TAILQ_EMPTY(&(config.tray_outputs))) {
1781 /* If one or more tray_output assignments were specified, we ensure that at least one of
1782 * them is actually an output managed by this instance. */
1783 tray_output_t *tray_output;
1784 TAILQ_FOREACH(tray_output, &(config.tray_outputs), tray_outputs) {
1787 SLIST_FOREACH(output, outputs, slist) {
1788 if (strcasecmp(output->name, tray_output->output) == 0 ||
1789 (strcasecmp(tray_output->output, "primary") == 0 && output->primary)) {
1800 tray_configured = true;
1803 /* We already have a bar, so we just reconfigure it */
1804 mask = XCB_CONFIG_WINDOW_X |
1805 XCB_CONFIG_WINDOW_Y |
1806 XCB_CONFIG_WINDOW_WIDTH |
1807 XCB_CONFIG_WINDOW_HEIGHT |
1808 XCB_CONFIG_WINDOW_STACK_MODE;
1809 values[0] = walk->rect.x;
1810 if (config.position == POS_TOP)
1811 values[1] = walk->rect.y;
1813 values[1] = walk->rect.y + walk->rect.h - bar_height;
1814 values[2] = walk->rect.w;
1815 values[3] = bar_height;
1816 values[4] = XCB_STACK_MODE_ABOVE;
1818 DLOG("Reconfiguring strut partial property for output %s\n", walk->name);
1819 xcb_void_cookie_t strut_cookie = config_strut_partial(walk);
1821 DLOG("Destroying buffer for output %s\n", walk->name);
1822 xcb_free_pixmap(xcb_connection, walk->buffer.id);
1824 DLOG("Destroying statusline buffer for output %s\n", walk->name);
1825 xcb_free_pixmap(xcb_connection, walk->statusline_buffer.id);
1827 DLOG("Reconfiguring window for output %s to %d,%d\n", walk->name, values[0], values[1]);
1828 xcb_void_cookie_t cfg_cookie = xcb_configure_window_checked(xcb_connection,
1833 mask = XCB_CW_OVERRIDE_REDIRECT;
1834 values[0] = (config.hide_on_modifier == M_DOCK ? 0 : 1);
1835 DLOG("Changing window attribute override_redirect for output %s to %d\n", walk->name, values[0]);
1836 xcb_void_cookie_t chg_cookie = xcb_change_window_attributes(xcb_connection,
1841 DLOG("Recreating buffer for output %s\n", walk->name);
1842 xcb_void_cookie_t pm_cookie = xcb_create_pixmap_checked(xcb_connection,
1849 DLOG("Recreating statusline buffer for output %s\n", walk->name);
1850 xcb_void_cookie_t slpm_cookie = xcb_create_pixmap_checked(xcb_connection,
1852 walk->statusline_buffer.id,
1857 draw_util_surface_free(xcb_connection, &(walk->bar));
1858 draw_util_surface_free(xcb_connection, &(walk->buffer));
1859 draw_util_surface_free(xcb_connection, &(walk->statusline_buffer));
1860 draw_util_surface_init(xcb_connection, &(walk->bar), walk->bar.id, NULL, walk->rect.w, bar_height);
1861 draw_util_surface_init(xcb_connection, &(walk->buffer), walk->buffer.id, NULL, walk->rect.w, bar_height);
1862 draw_util_surface_init(xcb_connection, &(walk->statusline_buffer), walk->statusline_buffer.id, NULL, walk->rect.w, bar_height);
1864 xcb_void_cookie_t map_cookie, umap_cookie;
1866 /* Unmap the window, and draw it again when in dock mode */
1867 umap_cookie = xcb_unmap_window_checked(xcb_connection, walk->bar.id);
1868 if (config.hide_on_modifier == M_DOCK) {
1870 map_cookie = xcb_map_window_checked(xcb_connection, walk->bar.id);
1875 if (config.hide_on_modifier == M_HIDE) {
1876 /* Switching to hide mode, register for keyevents */
1877 register_xkb_keyevents();
1879 /* Switching to dock/invisible mode, deregister from keyevents */
1880 deregister_xkb_keyevents();
1884 if (xcb_request_failed(cfg_cookie, "Could not reconfigure window") ||
1885 xcb_request_failed(chg_cookie, "Could not change window") ||
1886 xcb_request_failed(pm_cookie, "Could not create pixmap") ||
1887 xcb_request_failed(slpm_cookie, "Could not create statusline pixmap") ||
1888 xcb_request_failed(strut_cookie, "Could not set strut") ||
1889 (redraw_bars && (xcb_request_failed(umap_cookie, "Could not unmap window") ||
1890 (config.hide_on_modifier == M_DOCK && xcb_request_failed(map_cookie, "Could not map window"))))) {
1898 * Render the bars, with buttons and statusline
1901 void draw_bars(bool unhide) {
1902 DLOG("Drawing bars...\n");
1904 uint32_t full_statusline_width = predict_statusline_length(false);
1905 uint32_t short_statusline_width = predict_statusline_length(true);
1907 i3_output *outputs_walk;
1908 SLIST_FOREACH(outputs_walk, outputs, slist) {
1909 int workspace_width = 0;
1911 if (!outputs_walk->active) {
1912 DLOG("Output %s inactive, skipping...\n", outputs_walk->name);
1915 if (outputs_walk->bar.id == XCB_NONE) {
1916 /* Oh shit, an active output without an own bar. Create it now! */
1917 reconfig_windows(false);
1920 bool use_focus_colors = output_has_focus(outputs_walk);
1922 /* First things first: clear the backbuffer */
1923 draw_util_clear_surface(&(outputs_walk->buffer), (use_focus_colors ? colors.focus_bar_bg : colors.bar_bg));
1925 if (!config.disable_ws) {
1927 TAILQ_FOREACH(ws_walk, outputs_walk->workspaces, tailq) {
1928 DLOG("Drawing button for WS %s at x = %d, len = %d\n",
1929 i3string_as_utf8(ws_walk->name), workspace_width, ws_walk->name_width);
1930 color_t fg_color = colors.inactive_ws_fg;
1931 color_t bg_color = colors.inactive_ws_bg;
1932 color_t border_color = colors.inactive_ws_border;
1933 if (ws_walk->visible) {
1934 if (!ws_walk->focused) {
1935 fg_color = colors.active_ws_fg;
1936 bg_color = colors.active_ws_bg;
1937 border_color = colors.active_ws_border;
1939 fg_color = colors.focus_ws_fg;
1940 bg_color = colors.focus_ws_bg;
1941 border_color = colors.focus_ws_border;
1944 if (ws_walk->urgent) {
1945 DLOG("WS %s is urgent!\n", i3string_as_utf8(ws_walk->name));
1946 fg_color = colors.urgent_ws_fg;
1947 bg_color = colors.urgent_ws_bg;
1948 border_color = colors.urgent_ws_border;
1952 /* Draw the border of the button. */
1953 draw_util_rectangle(&(outputs_walk->buffer), border_color,
1956 ws_walk->name_width + 2 * logical_px(ws_hoff_px) + 2 * logical_px(1),
1957 font.height + 2 * logical_px(ws_voff_px) - 2 * logical_px(1));
1959 /* Draw the inside of the button. */
1960 draw_util_rectangle(&(outputs_walk->buffer), bg_color,
1961 workspace_width + logical_px(1),
1963 ws_walk->name_width + 2 * logical_px(ws_hoff_px),
1964 font.height + 2 * logical_px(ws_voff_px) - 4 * logical_px(1));
1966 draw_util_text(ws_walk->name, &(outputs_walk->buffer), fg_color, bg_color,
1967 workspace_width + logical_px(ws_hoff_px) + logical_px(1),
1968 logical_px(ws_voff_px),
1969 ws_walk->name_width);
1971 workspace_width += 2 * logical_px(ws_hoff_px) + 2 * logical_px(1) + ws_walk->name_width;
1972 if (TAILQ_NEXT(ws_walk, tailq) != NULL)
1973 workspace_width += logical_px(ws_spacing_px);
1977 if (binding.name && !config.disable_binding_mode_indicator) {
1978 workspace_width += logical_px(ws_spacing_px);
1980 color_t fg_color = colors.binding_mode_fg;
1981 color_t bg_color = colors.binding_mode_bg;
1983 draw_util_rectangle(&(outputs_walk->buffer), colors.binding_mode_border,
1986 binding.width + 2 * logical_px(ws_hoff_px) + 2 * logical_px(1),
1987 font.height + 2 * logical_px(ws_voff_px) - 2 * logical_px(1));
1989 draw_util_rectangle(&(outputs_walk->buffer), bg_color,
1990 workspace_width + logical_px(1),
1992 binding.width + 2 * logical_px(ws_hoff_px),
1993 font.height + 2 * logical_px(ws_voff_px) - 4 * logical_px(1));
1995 draw_util_text(binding.name, &(outputs_walk->buffer), fg_color, bg_color,
1996 workspace_width + logical_px(ws_hoff_px) + logical_px(1),
1997 logical_px(ws_voff_px),
2001 workspace_width += 2 * logical_px(ws_hoff_px) + 2 * logical_px(1) + binding.width;
2004 if (!TAILQ_EMPTY(&statusline_head)) {
2005 DLOG("Printing statusline!\n");
2007 int tray_width = get_tray_width(outputs_walk->trayclients);
2008 uint32_t hoff = logical_px(((workspace_width > 0) + (tray_width > 0)) * sb_hoff_px);
2009 uint32_t max_statusline_width = outputs_walk->rect.w - workspace_width - tray_width - hoff;
2010 uint32_t clip_left = 0;
2011 uint32_t statusline_width = full_statusline_width;
2012 bool use_short_text = false;
2014 if (statusline_width > max_statusline_width) {
2015 statusline_width = short_statusline_width;
2016 use_short_text = true;
2017 if (statusline_width > max_statusline_width) {
2018 clip_left = statusline_width - max_statusline_width;
2022 int16_t visible_statusline_width = MIN(statusline_width, max_statusline_width);
2023 int x_dest = outputs_walk->rect.w - tray_width - logical_px((tray_width > 0) * sb_hoff_px) - visible_statusline_width;
2025 draw_statusline(outputs_walk, clip_left, use_focus_colors, use_short_text);
2026 draw_util_copy_surface(&outputs_walk->statusline_buffer, &outputs_walk->buffer, 0, 0,
2027 x_dest, 0, visible_statusline_width, (int16_t)bar_height);
2029 outputs_walk->statusline_width = statusline_width;
2030 outputs_walk->statusline_short_text = use_short_text;
2034 /* Assure the bar is hidden/unhidden according to the specified hidden_state and mode */
2036 config.hidden_state == S_SHOW ||
2039 } else if (config.hide_on_modifier == M_HIDE) {
2047 * Redraw the bars, i.e. simply copy the buffer to the barwindow
2050 void redraw_bars(void) {
2051 i3_output *outputs_walk;
2052 SLIST_FOREACH(outputs_walk, outputs, slist) {
2053 if (!outputs_walk->active) {
2057 draw_util_copy_surface(&(outputs_walk->buffer), &(outputs_walk->bar), 0, 0,
2058 0, 0, outputs_walk->rect.w, outputs_walk->rect.h);
2059 xcb_flush(xcb_connection);
2064 * Set the current binding mode
2067 void set_current_mode(struct mode *current) {
2068 I3STRING_FREE(binding.name);
2070 activated_mode = binding.name != NULL;