2 * i3bar - an xcb-based status- and ws-bar for i3
4 * © 2010 Axel Wagner and contributors
6 * See file LICNSE for license information
8 * src/xcb.c: Communicating with X
12 #include <xcb/xproto.h>
23 #include <X11/XKBlib.h>
24 #include <X11/extensions/XKB.h>
28 /* We save the Atoms in an easy to access array, indexed by an enum */
32 #define ATOM_DO(name) name,
33 #include "xcb_atoms.def"
36 xcb_intern_atom_cookie_t atom_cookies[NUM_ATOMS];
37 xcb_atom_t atoms[NUM_ATOMS];
39 /* Variables, that are the same for all functions at all times */
40 xcb_connection_t *xcb_connection;
41 xcb_screen_t *xcb_screen;
42 xcb_window_t xcb_root;
45 /* We need to cache some data to speed up text-width-prediction */
46 xcb_query_font_reply_t *font_info;
48 xcb_charinfo_t *font_table;
50 /* These are only relevant for XKB, which we only need for grabbing modifiers */
55 /* Because the statusline is the same on all outputs, we have
56 * global buffer to render it on */
57 xcb_gcontext_t statusline_ctx;
58 xcb_pixmap_t statusline_pm;
59 uint32_t statusline_width;
61 /* Event-Watchers, to interact with the user */
67 /* The parsed colors */
71 uint32_t active_ws_fg;
72 uint32_t active_ws_bg;
73 uint32_t inactive_ws_fg;
74 uint32_t inactive_ws_bg;
75 uint32_t urgent_ws_bg;
76 uint32_t urgent_ws_fg;
78 struct xcb_colors_t colors;
80 /* We define xcb_request_failed as a macro to include the relevant line-number */
81 #define xcb_request_failed(cookie, err_msg) _xcb_request_failed(cookie, err_msg, __LINE__)
82 int _xcb_request_failed(xcb_void_cookie_t cookie, char *err_msg, int line) {
83 xcb_generic_error_t *err;
84 if ((err = xcb_request_check(xcb_connection, cookie)) != NULL) {
85 ELOG("%s. X Error Code: %d\n", err_msg, err->error_code);
86 return err->error_code;
92 * Predicts the length of text based on cached data.
93 * The string has to be encoded in ucs2 and glyph_len has to be the length
94 * of the string (in glyphs).
97 uint32_t predict_text_extents(xcb_char2b_t *text, uint32_t length) {
98 /* If we don't have per-character data, return the maximum width */
99 if (font_table == NULL) {
100 return (font_info->max_bounds.character_width * length);
106 for (i = 0; i < length; i++) {
107 xcb_charinfo_t *info;
108 int row = text[i].byte1;
109 int col = text[i].byte2;
111 if (row < font_info->min_byte1 || row > font_info->max_byte1 ||
112 col < font_info->min_char_or_byte2 || col > font_info->max_char_or_byte2) {
116 /* Don't you ask me, how this one works… */
117 info = &font_table[((row - font_info->min_byte1) *
118 (font_info->max_char_or_byte2 - font_info->min_char_or_byte2 + 1)) +
119 (col - font_info->min_char_or_byte2)];
121 if (info->character_width != 0 ||
122 (info->right_side_bearing |
123 info->left_side_bearing |
125 info->descent) != 0) {
126 width += info->character_width;
134 * Draws text given in UCS-2-encoding to a given drawable and position
137 void draw_text(xcb_drawable_t drawable, xcb_gcontext_t ctx, int16_t x, int16_t y,
138 xcb_char2b_t *text, uint32_t glyph_count) {
141 int16_t font_ascent = font_info->font_ascent;
143 while (glyph_count > 0) {
144 uint8_t chunk_size = MIN(255, glyph_count);
145 uint32_t chunk_width = predict_text_extents(text + offset, chunk_size);
147 xcb_image_text_16(xcb_connection,
151 pos_x, y + font_ascent,
154 offset += chunk_size;
155 pos_x += chunk_width;
156 glyph_count -= chunk_size;
161 * Converts a colorstring to a colorpixel as expected from xcb_change_gc.
162 * s is assumed to be in the format "rrggbb"
165 uint32_t get_colorpixel(const char *s) {
166 char strings[3][3] = { { s[0], s[1], '\0'} ,
167 { s[2], s[3], '\0'} ,
168 { s[4], s[5], '\0'} };
169 uint8_t r = strtol(strings[0], NULL, 16);
170 uint8_t g = strtol(strings[1], NULL, 16);
171 uint8_t b = strtol(strings[2], NULL, 16);
172 return (r << 16 | g << 8 | b);
176 * Redraws the statusline to the buffer
179 void refresh_statusline() {
182 if (statusline == NULL) {
186 xcb_char2b_t *text = (xcb_char2b_t*) convert_utf8_to_ucs2(statusline, &glyph_count);
187 statusline_width = predict_text_extents(text, glyph_count);
189 xcb_free_pixmap(xcb_connection, statusline_pm);
190 statusline_pm = xcb_generate_id(xcb_connection);
191 xcb_void_cookie_t sl_pm_cookie = xcb_create_pixmap_checked(xcb_connection,
192 xcb_screen->root_depth,
198 draw_text(statusline_pm, statusline_ctx, 0, 0, text, glyph_count);
202 if (xcb_request_failed(sl_pm_cookie, "Could not allocate statusline-buffer")) {
208 * Hides all bars (unmaps them)
212 if (!config.hide_on_modifier) {
217 SLIST_FOREACH(walk, outputs, slist) {
218 xcb_unmap_window(xcb_connection, walk->bar);
224 * Unhides all bars (maps them)
228 if (!config.hide_on_modifier) {
233 xcb_void_cookie_t cookie;
239 SLIST_FOREACH(walk, outputs, slist) {
240 if (walk->bar == XCB_NONE) {
243 mask = XCB_CONFIG_WINDOW_X |
244 XCB_CONFIG_WINDOW_Y |
245 XCB_CONFIG_WINDOW_WIDTH |
246 XCB_CONFIG_WINDOW_HEIGHT |
247 XCB_CONFIG_WINDOW_STACK_MODE;
248 values[0] = walk->rect.x;
249 values[1] = walk->rect.y + walk->rect.h - font_height - 6;
250 values[2] = walk->rect.w;
251 values[3] = font_height + 6;
252 values[4] = XCB_STACK_MODE_ABOVE;
253 DLOG("Reconfiguring Window for output %s to %d,%d\n", walk->name, values[0], values[1]);
254 cookie = xcb_configure_window_checked(xcb_connection,
259 if (xcb_request_failed(cookie, "Could not reconfigure window")) {
262 xcb_map_window(xcb_connection, walk->bar);
267 * Parse the colors into a format that we can use
270 void init_colors(const struct xcb_color_strings_t *new_colors) {
271 #define PARSE_COLOR(name, def) \
273 colors.name = get_colorpixel(new_colors->name ? new_colors->name : def); \
275 PARSE_COLOR(bar_fg, "FFFFFF");
276 PARSE_COLOR(bar_bg, "000000");
277 PARSE_COLOR(active_ws_fg, "FFFFFF");
278 PARSE_COLOR(active_ws_bg, "480000");
279 PARSE_COLOR(inactive_ws_fg, "FFFFFF");
280 PARSE_COLOR(inactive_ws_bg, "240000");
281 PARSE_COLOR(urgent_ws_fg, "FFFFFF");
282 PARSE_COLOR(urgent_ws_bg, "002400");
287 * Handle a button-press-event (i.c. a mouse click on one of our bars).
288 * We determine, wether the click occured on a ws-button or if the scroll-
289 * wheel was used and change the workspace appropriately
292 void handle_button(xcb_button_press_event_t *event) {
295 /* Determine, which bar was clicked */
297 xcb_window_t bar = event->event;
298 SLIST_FOREACH(walk, outputs, slist) {
299 if (walk->bar == bar) {
305 DLOG("Unknown Bar klicked!\n");
309 /* TODO: Move this to extern get_ws_for_output() */
310 TAILQ_FOREACH(cur_ws, walk->workspaces, tailq) {
311 if (cur_ws->visible) {
316 if (cur_ws == NULL) {
317 DLOG("No Workspace active?\n");
321 int32_t x = event->event_x;
323 DLOG("Got Button %d\n", event->detail);
325 switch (event->detail) {
327 /* Left Mousbutton. We determine, which button was clicked
328 * and set cur_ws accordingly */
329 TAILQ_FOREACH(cur_ws, walk->workspaces, tailq) {
331 if (x < cur_ws->name_width + 10) {
334 x -= cur_ws->name_width + 10;
336 if (cur_ws == NULL) {
341 /* Mouse wheel down. We select the next ws */
342 if (cur_ws == TAILQ_FIRST(walk->workspaces)) {
343 cur_ws = TAILQ_LAST(walk->workspaces, ws_head);
345 cur_ws = TAILQ_PREV(cur_ws, ws_head, tailq);
349 /* Mouse wheel up. We select the previos ws */
350 if (cur_ws == TAILQ_LAST(walk->workspaces, ws_head)) {
351 cur_ws = TAILQ_FIRST(walk->workspaces);
353 cur_ws = TAILQ_NEXT(cur_ws, tailq);
359 snprintf(buffer, 50, "%d", cur_ws->num);
360 i3_send_msg(I3_IPC_MESSAGE_TYPE_COMMAND, buffer);
364 * This function is called immediately bevor the main loop locks. We flush xcb
365 * then (and only then)
368 void xcb_prep_cb(struct ev_loop *loop, ev_prepare *watcher, int revenst) {
369 xcb_flush(xcb_connection);
373 * This function is called immediately after the main loop locks, so when one
374 * of the watchers registered an event.
375 * We check wether an X-Event arrived and handle it.
378 void xcb_chk_cb(struct ev_loop *loop, ev_check *watcher, int revents) {
379 xcb_generic_event_t *event;
380 while ((event = xcb_poll_for_event(xcb_connection)) == NULL) {
384 switch (event->response_type & ~0x80) {
386 /* Expose-events happen, when the window needs to be redrawn */
389 case XCB_BUTTON_PRESS:
390 /* Button-press-events are mouse-buttons clicked on one of our bars */
391 handle_button((xcb_button_press_event_t*) event);
398 * Dummy Callback. We only need this, so that the Prepare- and Check-Watchers
402 void xcb_io_cb(struct ev_loop *loop, ev_io *watcher, int revents) {
406 * We need to bind to the modifier per XKB. Sadly, XCB does not implement this
409 void xkb_io_cb(struct ev_loop *loop, ev_io *watcher, int revents) {
413 DLOG("Got XKB-Event!\n");
415 while (XPending(xkb_dpy)) {
416 XNextEvent(xkb_dpy, (XEvent*)&ev);
418 if (ev.type != xkb_event_base) {
419 ELOG("No Xkb-Event!\n");
423 if (ev.any.xkb_type != XkbStateNotify) {
424 ELOG("No State Notify!\n");
428 unsigned int mods = ev.state.mods;
429 modstate = mods & Mod4Mask;
432 if (modstate != mod_pressed) {
434 DLOG("Mod4 got released!\n");
437 DLOG("Mod4 got pressed!\n");
440 mod_pressed = modstate;
445 * Initialize xcb and use the specified fontname for text-rendering
448 void init_xcb(char *fontname) {
449 /* FIXME: xcb_connect leaks Memory */
450 xcb_connection = xcb_connect(NULL, NULL);
451 if (xcb_connection_has_error(xcb_connection)) {
452 ELOG("Cannot open display\n");
455 DLOG("Connected to xcb\n");
457 /* We have to request the atoms we need */
458 #define ATOM_DO(name) atom_cookies[name] = xcb_intern_atom(xcb_connection, 0, strlen(#name), #name);
459 #include "xcb_atoms.def"
461 xcb_screen = xcb_setup_roots_iterator(xcb_get_setup(xcb_connection)).data;
462 xcb_root = xcb_screen->root;
464 /* We load and allocate the font */
465 xcb_font = xcb_generate_id(xcb_connection);
466 xcb_void_cookie_t open_font_cookie;
467 open_font_cookie = xcb_open_font_checked(xcb_connection,
472 /* We need to save info about the font, because we need the fonts height and
473 * information about the width of characters */
474 xcb_query_font_cookie_t query_font_cookie;
475 query_font_cookie = xcb_query_font(xcb_connection,
478 /* To grab modifiers without blocking other applications from receiving key-events
479 * involving that modifier, we sadly have to use xkb which is not yet fully supported
481 if (config.hide_on_modifier) {
482 int xkb_major, xkb_minor, xkb_errbase, xkb_err;
483 xkb_major = XkbMajorVersion;
484 xkb_minor = XkbMinorVersion;
486 xkb_dpy = XkbOpenDisplay(":0",
493 if (xkb_dpy == NULL) {
498 if (fcntl(ConnectionNumber(xkb_dpy), F_SETFD, FD_CLOEXEC) == -1) {
499 ELOG("Could not set FD_CLOEXEC on xkbdpy: %s\n", strerror(errno));
504 if (!XkbQueryExtension(xkb_dpy, &i1, &xkb_event_base, &xkb_errbase, &xkb_major, &xkb_minor)) {
505 ELOG("XKB not supported by X-server!\n");
509 if (!XkbSelectEvents(xkb_dpy, XkbUseCoreKbd, XkbStateNotifyMask, XkbStateNotifyMask)) {
510 ELOG("Could not grab Key!\n");
514 xkb_io = malloc(sizeof(ev_io));
515 ev_io_init(xkb_io, &xkb_io_cb, ConnectionNumber(xkb_dpy), EV_READ);
516 ev_io_start(main_loop, xkb_io);
520 /* We draw the statusline to a seperate pixmap, because it looks the same on all bars and
521 * this way, we can choose to crop it */
522 statusline_ctx = xcb_generate_id(xcb_connection);
523 uint32_t mask = XCB_GC_FOREGROUND |
526 uint32_t vals[3] = { colors.bar_fg, colors.bar_bg, xcb_font };
528 xcb_void_cookie_t sl_ctx_cookie = xcb_create_gc_checked(xcb_connection,
534 /* We only generate an id for the pixmap, because the width of it is dependent on the
536 statusline_pm = xcb_generate_id(xcb_connection);
538 /* The varios Watchers to communicate with xcb */
539 xcb_io = malloc(sizeof(ev_io));
540 xcb_prep = malloc(sizeof(ev_prepare));
541 xcb_chk = malloc(sizeof(ev_check));
543 ev_io_init(xcb_io, &xcb_io_cb, xcb_get_file_descriptor(xcb_connection), EV_READ);
544 ev_prepare_init(xcb_prep, &xcb_prep_cb);
545 ev_check_init(xcb_chk, &xcb_chk_cb);
547 ev_io_start(main_loop, xcb_io);
548 ev_prepare_start(main_loop, xcb_prep);
549 ev_check_start(main_loop, xcb_chk);
551 /* Now we get the atoms and save them in a nice data-structure */
554 /* Now we save the font-infos */
555 font_info = xcb_query_font_reply(xcb_connection,
559 if (xcb_request_failed(open_font_cookie, "Could not open font")) {
563 font_height = font_info->font_ascent + font_info->font_descent;
565 if (xcb_query_font_char_infos_length(font_info) == 0) {
568 font_table = xcb_query_font_char_infos(font_info);
571 DLOG("Calculated Font-height: %d\n", font_height);
573 if (xcb_request_failed(sl_ctx_cookie, "Could not create context for statusline")) {
579 * Cleanup the xcb-stuff.
580 * Called once, before the program terminates.
585 SLIST_FOREACH(o_walk, outputs, slist) {
586 destroy_window(o_walk);
587 FREE_TAILQ(o_walk->workspaces, i3_ws);
588 FREE(o_walk->workspaces);
591 FREE_SLIST(outputs, i3_output);
594 xcb_disconnect(xcb_connection);
596 ev_check_stop(main_loop, xcb_chk);
597 ev_prepare_stop(main_loop, xcb_prep);
598 ev_io_stop(main_loop, xcb_io);
607 * Get the earlier requested atoms and save them in the prepared data-structure
611 xcb_intern_atom_reply_t *reply;
612 #define ATOM_DO(name) reply = xcb_intern_atom_reply(xcb_connection, atom_cookies[name], NULL); \
613 if (reply == NULL) { \
614 ELOG("Could not get atom %s\n", #name); \
615 exit(EXIT_FAILURE); \
617 atoms[name] = reply->atom; \
620 #include "xcb_atoms.def"
625 * Destroy the bar of the specified output
628 void destroy_window(i3_output *output) {
629 if (output == NULL) {
632 if (output->bar == XCB_NONE) {
635 xcb_destroy_window(xcb_connection, output->bar);
636 output->bar = XCB_NONE;
640 * Reconfigure all bars and create new for newly activated outputs
643 void reconfig_windows() {
648 SLIST_FOREACH(walk, outputs, slist) {
650 /* If an output is not active, we destroy it's bar */
651 /* FIXME: Maybe we rather want to unmap? */
652 DLOG("Destroying window for output %s\n", walk->name);
653 destroy_window(walk);
656 if (walk->bar == XCB_NONE) {
657 DLOG("Creating Window for output %s\n", walk->name);
659 walk->bar = xcb_generate_id(xcb_connection);
660 walk->buffer = xcb_generate_id(xcb_connection);
661 mask = XCB_CW_BACK_PIXEL | XCB_CW_OVERRIDE_REDIRECT | XCB_CW_EVENT_MASK;
662 /* Black background */
663 values[0] = colors.bar_bg;
664 /* If hide_on_modifier is set, i3 is not supposed to manage our bar-windows */
665 values[1] = config.hide_on_modifier;
666 /* The events we want to receive */
667 values[2] = XCB_EVENT_MASK_EXPOSURE |
668 XCB_EVENT_MASK_BUTTON_PRESS;
669 xcb_void_cookie_t win_cookie = xcb_create_window_checked(xcb_connection,
670 xcb_screen->root_depth,
673 walk->rect.x, walk->rect.y + walk->rect.h - font_height - 6,
674 walk->rect.w, font_height + 6,
676 XCB_WINDOW_CLASS_INPUT_OUTPUT,
677 xcb_screen->root_visual,
681 /* The double-buffer we use to render stuff off-screen */
682 xcb_void_cookie_t pm_cookie = xcb_create_pixmap_checked(xcb_connection,
683 xcb_screen->root_depth,
689 /* We want dock-windows (for now). When override_redirect is set, i3 is ignoring
691 xcb_void_cookie_t prop_cookie = xcb_change_property(xcb_connection,
692 XCB_PROP_MODE_REPLACE,
694 atoms[_NET_WM_WINDOW_TYPE],
698 (unsigned char*) &atoms[_NET_WM_WINDOW_TYPE_DOCK]);
700 /* We also want a graphics-context for the bars (it defines the properties
701 * with which we draw to them) */
702 walk->bargc = xcb_generate_id(xcb_connection);
704 values[0] = xcb_font;
705 xcb_void_cookie_t gc_cookie = xcb_create_gc_checked(xcb_connection,
711 /* We finally map the bar (display it on screen), unless the modifier-switch is on */
712 xcb_void_cookie_t map_cookie;
713 if (!config.hide_on_modifier) {
714 map_cookie = xcb_map_window_checked(xcb_connection, walk->bar);
717 if (xcb_request_failed(win_cookie, "Could not create window") ||
718 xcb_request_failed(pm_cookie, "Could not create pixmap") ||
719 xcb_request_failed(prop_cookie, "Could not set dock mode") ||
720 xcb_request_failed(gc_cookie, "Could not create graphical context") ||
721 (!config.hide_on_modifier && xcb_request_failed(map_cookie, "Could not map window"))) {
725 /* We already have a bar, so we just reconfigure it */
726 mask = XCB_CONFIG_WINDOW_X |
727 XCB_CONFIG_WINDOW_Y |
728 XCB_CONFIG_WINDOW_WIDTH |
729 XCB_CONFIG_WINDOW_HEIGHT |
730 XCB_CONFIG_WINDOW_STACK_MODE;
731 values[0] = walk->rect.x;
732 values[1] = walk->rect.y + walk->rect.h - font_height - 6;
733 values[2] = walk->rect.w;
734 values[3] = font_height + 6;
735 values[4] = XCB_STACK_MODE_ABOVE;
737 DLOG("Destroying buffer for output %s", walk->name);
738 xcb_free_pixmap(xcb_connection, walk->buffer);
740 DLOG("Reconfiguring Window for output %s to %d,%d\n", walk->name, values[0], values[1]);
741 xcb_void_cookie_t cfg_cookie = xcb_configure_window_checked(xcb_connection,
746 DLOG("Recreating buffer for output %s", walk->name);
747 xcb_void_cookie_t pm_cookie = xcb_create_pixmap_checked(xcb_connection,
748 xcb_screen->root_depth,
754 if (xcb_request_failed(cfg_cookie, "Could not reconfigure window")) {
757 if (xcb_request_failed(pm_cookie, "Could not create pixmap")) {
765 * Render the bars, with buttons and statusline
769 DLOG("Drawing Bars...\n");
772 refresh_statusline();
774 i3_output *outputs_walk;
775 SLIST_FOREACH(outputs_walk, outputs, slist) {
776 if (!outputs_walk->active) {
777 DLOG("Output %s inactive, skipping...\n", outputs_walk->name);
780 if (outputs_walk->bar == XCB_NONE) {
781 /* Oh shit, an active output without an own bar. Create it now! */
784 /* First things first: clear the backbuffer */
785 uint32_t color = colors.bar_bg;
786 xcb_change_gc(xcb_connection,
790 xcb_rectangle_t rect = { 0, 0, outputs_walk->rect.w, font_height + 6 };
791 xcb_poly_fill_rectangle(xcb_connection,
792 outputs_walk->buffer,
797 if (statusline != NULL) {
798 DLOG("Printing statusline!\n");
800 /* Luckily we already prepared a seperate pixmap containing the rendered
801 * statusline, we just have to copy the relevant parts to the relevant
803 xcb_copy_area(xcb_connection,
805 outputs_walk->buffer,
807 MAX(0, (int16_t)(statusline_width - outputs_walk->rect.w + 4)), 0,
808 MAX(0, (int16_t)(outputs_walk->rect.w - statusline_width - 4)), 3,
809 MIN(outputs_walk->rect.w - 4, statusline_width), font_height);
813 TAILQ_FOREACH(ws_walk, outputs_walk->workspaces, tailq) {
814 DLOG("Drawing Button for WS %s at x = %d\n", ws_walk->name, i);
815 uint32_t fg_color = colors.inactive_ws_fg;
816 uint32_t bg_color = colors.inactive_ws_bg;
817 if (ws_walk->visible) {
818 fg_color = colors.active_ws_fg;
819 bg_color = colors.active_ws_bg;
821 if (ws_walk->urgent) {
822 DLOG("WS %s is urgent!\n", ws_walk->name);
823 fg_color = colors.urgent_ws_fg;
824 bg_color = colors.urgent_ws_bg;
825 /* The urgent-hint should get noticed, so we unhide the bars shortly */
828 xcb_change_gc(xcb_connection,
832 xcb_change_gc(xcb_connection,
836 xcb_rectangle_t rect = { i + 1, 1, ws_walk->name_width + 8, font_height + 4 };
837 xcb_poly_fill_rectangle(xcb_connection,
838 outputs_walk->buffer,
842 xcb_change_gc(xcb_connection,
846 xcb_image_text_16(xcb_connection,
847 ws_walk->name_glyphs,
848 outputs_walk->buffer,
850 i + 5, font_info->font_ascent + 2,
852 i += 10 + ws_walk->name_width;
862 * Redraw the bars, i.e. simply copy the buffer to the barwindow
866 i3_output *outputs_walk;
867 SLIST_FOREACH(outputs_walk, outputs, slist) {
868 xcb_copy_area(xcb_connection,
869 outputs_walk->buffer,
874 outputs_walk->rect.w,
875 outputs_walk->rect.h);
876 xcb_flush(xcb_connection);