git.sur5r.net Git - i3/i3/blob - i3bar/src/xcb.c

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3bar - an xcb-based status- and ws-bar for i3
   5  * © 2010-2012 Axel Wagner and contributors (see also: LICENSE)
   6  *
   7  * xcb.c: Communicating with X
   8  *
   9  */
  10 #include <xcb/xcb.h>
  11 #include <xcb/xproto.h>
  12 #include <xcb/xcb_aux.h>
  13
  14 #ifdef XCB_COMPAT
  15 #include "xcb_compat.h"
  16 #endif
  17
  18 #include <stdio.h>
  19 #include <stdlib.h>
  20 #include <unistd.h>
  21 #include <fcntl.h>
  22 #include <string.h>
  23 #include <i3/ipc.h>
  24 #include <ev.h>
  25 #include <errno.h>
  26 #include <limits.h>
  27 #include <err.h>
  28
  29 #include <X11/Xlib.h>
  30 #include <X11/XKBlib.h>
  31 #include <X11/extensions/XKB.h>
  32
  33 #include "common.h"
  34 #include "libi3.h"
  35
  36 /* We save the Atoms in an easy to access array, indexed by an enum */
  37 enum {
  38     #define ATOM_DO(name) name,
  39     #include "xcb_atoms.def"
  40     NUM_ATOMS
  41 };
  42
  43 xcb_intern_atom_cookie_t atom_cookies[NUM_ATOMS];
  44 xcb_atom_t               atoms[NUM_ATOMS];
  45
  46 /* Variables, that are the same for all functions at all times */
  47 xcb_connection_t *xcb_connection;
  48 int              screen;
  49 xcb_screen_t     *root_screen;
  50 xcb_window_t     xcb_root;
  51
  52 /* selection window for tray support */
  53 static xcb_window_t selwin = XCB_NONE;
  54 static xcb_intern_atom_reply_t *tray_reply = NULL;
  55
  56 /* This is needed for integration with libi3 */
  57 xcb_connection_t *conn;
  58
  59 /* The font we'll use */
  60 static i3Font font;
  61
  62 /* Overall height of the bar (based on font size) */
  63 int bar_height;
  64
  65 /* These are only relevant for XKB, which we only need for grabbing modifiers */
  66 Display          *xkb_dpy;
  67 int              xkb_event_base;
  68 int              mod_pressed = 0;
  69
  70 /* Because the statusline is the same on all outputs, we have
  71  * global buffer to render it on */
  72 xcb_gcontext_t   statusline_ctx;
  73 xcb_gcontext_t   statusline_clear;
  74 xcb_pixmap_t     statusline_pm;
  75 uint32_t         statusline_width;
  76
  77 /* Event-Watchers, to interact with the user */
  78 ev_prepare *xcb_prep;
  79 ev_check   *xcb_chk;
  80 ev_io      *xcb_io;
  81 ev_io      *xkb_io;
  82
  83 /* The name of current binding mode */
  84 static mode binding;
  85
  86 /* Indicates whether a new binding mode was recently activated */
  87 bool activated_mode = false;
  88
  89 /* The parsed colors */
  90 struct xcb_colors_t {
  91     uint32_t bar_fg;
  92     uint32_t bar_bg;
  93     uint32_t sep_fg;
  94     uint32_t active_ws_fg;
  95     uint32_t active_ws_bg;
  96     uint32_t active_ws_border;
  97     uint32_t inactive_ws_fg;
  98     uint32_t inactive_ws_bg;
  99     uint32_t inactive_ws_border;
 100     uint32_t urgent_ws_bg;
 101     uint32_t urgent_ws_fg;
 102     uint32_t urgent_ws_border;
 103     uint32_t focus_ws_bg;
 104     uint32_t focus_ws_fg;
 105     uint32_t focus_ws_border;
 106 };
 107 struct xcb_colors_t colors;
 108
 109 /* We define xcb_request_failed as a macro to include the relevant line-number */
 110 #define xcb_request_failed(cookie, err_msg) _xcb_request_failed(cookie, err_msg, __LINE__)
 111 int _xcb_request_failed(xcb_void_cookie_t cookie, char *err_msg, int line) {
 112     xcb_generic_error_t *err;
 113     if ((err = xcb_request_check(xcb_connection, cookie)) != NULL) {
 114         fprintf(stderr, "[%s:%d] ERROR: %s. X Error Code: %d\n", __FILE__, line, err_msg, err->error_code);
 115         return err->error_code;
 116     }
 117     return 0;
 118 }
 119
 120 /*
 121  * Redraws the statusline to the buffer
 122  *
 123  */
 124 void refresh_statusline(void) {
 125     struct status_block *block;
 126
 127     uint32_t old_statusline_width = statusline_width;
 128     statusline_width = 0;
 129
 130     /* Predict the text width of all blocks (in pixels). */
 131     TAILQ_FOREACH(block, &statusline_head, blocks) {
 132         if (i3string_get_num_bytes(block->full_text) == 0)
 133             continue;
 134
 135         block->width = predict_text_width(block->full_text);
 136
 137         /* Compute offset and append for text aligment in min_width. */
 138         if (block->min_width <= block->width) {
 139             block->x_offset = 0;
 140             block->x_append = 0;
 141         } else {
 142             uint32_t padding_width = block->min_width - block->width;
 143             switch (block->align) {
 144                 case ALIGN_LEFT:
 145                     block->x_append = padding_width;
 146                     break;
 147                 case ALIGN_RIGHT:
 148                     block->x_offset = padding_width;
 149                     break;
 150                 case ALIGN_CENTER:
 151                     block->x_offset = padding_width / 2;
 152                     block->x_append = padding_width / 2 + padding_width % 2;
 153                     break;
 154             }
 155         }
 156
 157         /* If this is not the last block, add some pixels for a separator. */
 158         if (TAILQ_NEXT(block, blocks) != NULL)
 159             block->width += block->sep_block_width;
 160
 161         statusline_width += block->width + block->x_offset + block->x_append;
 162     }
 163
 164     /* If the statusline is bigger than our screen we need to make sure that
 165      * the pixmap provides enough space, so re-allocate if the width grew */
 166     if (statusline_width > root_screen->width_in_pixels &&
 167         statusline_width > old_statusline_width)
 168         realloc_sl_buffer();
 169
 170     /* Clear the statusline pixmap. */
 171     xcb_rectangle_t rect = { 0, 0, root_screen->width_in_pixels, font.height + 2 };
 172     xcb_poly_fill_rectangle(xcb_connection, statusline_pm, statusline_clear, 1, &rect);
 173
 174     /* Draw the text of each block. */
 175     uint32_t x = 0;
 176     TAILQ_FOREACH(block, &statusline_head, blocks) {
 177         if (i3string_get_num_bytes(block->full_text) == 0)
 178             continue;
 179
 180         uint32_t colorpixel = (block->color ? get_colorpixel(block->color) : colors.bar_fg);
 181         set_font_colors(statusline_ctx, colorpixel, colors.bar_bg);
 182         draw_text(block->full_text, statusline_pm, statusline_ctx, x + block->x_offset, 1, block->width);
 183         x += block->width + block->x_offset + block->x_append;
 184
 185         if (TAILQ_NEXT(block, blocks) != NULL && !block->no_separator && block->sep_block_width > 0) {
 186             /* This is not the last block, draw a separator. */
 187             uint32_t sep_offset = block->sep_block_width/2 + block->sep_block_width % 2;
 188             uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND;
 189             uint32_t values[] = { colors.sep_fg, colors.bar_bg };
 190             xcb_change_gc(xcb_connection, statusline_ctx, mask, values);
 191             xcb_poly_line(xcb_connection, XCB_COORD_MODE_ORIGIN, statusline_pm,
 192                           statusline_ctx, 2,
 193                           (xcb_point_t[]){ { x - sep_offset, 2 },
 194                                            { x - sep_offset, font.height - 2 } });
 195         }
 196     }
 197 }
 198
 199 /*
 200  * Hides all bars (unmaps them)
 201  *
 202  */
 203 void hide_bars(void) {
 204     if ((config.hide_on_modifier == M_DOCK) || (config.hidden_state == S_SHOW && config.hide_on_modifier == M_HIDE)) {
 205         return;
 206     }
 207
 208     i3_output *walk;
 209     SLIST_FOREACH(walk, outputs, slist) {
 210         if (!walk->active) {
 211             continue;
 212         }
 213         xcb_unmap_window(xcb_connection, walk->bar);
 214     }
 215     stop_child();
 216 }
 217
 218 /*
 219  * Unhides all bars (maps them)
 220  *
 221  */
 222 void unhide_bars(void) {
 223     if (config.hide_on_modifier != M_HIDE) {
 224         return;
 225     }
 226
 227     i3_output           *walk;
 228     xcb_void_cookie_t   cookie;
 229     uint32_t            mask;
 230     uint32_t            values[5];
 231
 232     cont_child();
 233
 234     SLIST_FOREACH(walk, outputs, slist) {
 235         if (walk->bar == XCB_NONE) {
 236             continue;
 237         }
 238         mask = XCB_CONFIG_WINDOW_X |
 239                XCB_CONFIG_WINDOW_Y |
 240                XCB_CONFIG_WINDOW_WIDTH |
 241                XCB_CONFIG_WINDOW_HEIGHT |
 242                XCB_CONFIG_WINDOW_STACK_MODE;
 243         values[0] = walk->rect.x;
 244         if (config.position == POS_TOP)
 245             values[1] = walk->rect.y;
 246         else values[1] = walk->rect.y + walk->rect.h - bar_height;
 247         values[2] = walk->rect.w;
 248         values[3] = bar_height;
 249         values[4] = XCB_STACK_MODE_ABOVE;
 250         DLOG("Reconfiguring Window for output %s to %d,%d\n", walk->name, values[0], values[1]);
 251         cookie = xcb_configure_window_checked(xcb_connection,
 252                                               walk->bar,
 253                                               mask,
 254                                               values);
 255
 256         if (xcb_request_failed(cookie, "Could not reconfigure window")) {
 257             exit(EXIT_FAILURE);
 258         }
 259         xcb_map_window(xcb_connection, walk->bar);
 260     }
 261 }
 262
 263 /*
 264  * Parse the colors into a format that we can use
 265  *
 266  */
 267 void init_colors(const struct xcb_color_strings_t *new_colors) {
 268 #define PARSE_COLOR(name, def) \
 269     do { \
 270         colors.name = get_colorpixel(new_colors->name ? new_colors->name : def); \
 271     } while  (0)
 272     PARSE_COLOR(bar_fg, "#FFFFFF");
 273     PARSE_COLOR(bar_bg, "#000000");
 274     PARSE_COLOR(sep_fg, "#666666");
 275     PARSE_COLOR(active_ws_fg, "#FFFFFF");
 276     PARSE_COLOR(active_ws_bg, "#333333");
 277     PARSE_COLOR(active_ws_border, "#333333");
 278     PARSE_COLOR(inactive_ws_fg, "#888888");
 279     PARSE_COLOR(inactive_ws_bg, "#222222");
 280     PARSE_COLOR(inactive_ws_border, "#333333");
 281     PARSE_COLOR(urgent_ws_fg, "#FFFFFF");
 282     PARSE_COLOR(urgent_ws_bg, "#900000");
 283     PARSE_COLOR(urgent_ws_border, "#2f343a");
 284     PARSE_COLOR(focus_ws_fg, "#FFFFFF");
 285     PARSE_COLOR(focus_ws_bg, "#285577");
 286     PARSE_COLOR(focus_ws_border, "#4c7899");
 287 #undef PARSE_COLOR
 288
 289     init_tray_colors();
 290     xcb_flush(xcb_connection);
 291 }
 292
 293 /*
 294  * Handle a button-press-event (i.e. a mouse click on one of our bars).
 295  * We determine, whether the click occured on a ws-button or if the scroll-
 296  * wheel was used and change the workspace appropriately
 297  *
 298  */
 299 void handle_button(xcb_button_press_event_t *event) {
 300     i3_ws *cur_ws;
 301
 302     /* Determine, which bar was clicked */
 303     i3_output *walk;
 304     xcb_window_t bar = event->event;
 305     SLIST_FOREACH(walk, outputs, slist) {
 306         if (walk->bar == bar) {
 307             break;
 308         }
 309     }
 310
 311     if (walk == NULL) {
 312         DLOG("Unknown Bar klicked!\n");
 313         return;
 314     }
 315
 316     /* TODO: Move this to extern get_ws_for_output() */
 317     TAILQ_FOREACH(cur_ws, walk->workspaces, tailq) {
 318         if (cur_ws->visible) {
 319             break;
 320         }
 321     }
 322
 323     if (cur_ws == NULL) {
 324         DLOG("No Workspace active?\n");
 325         return;
 326     }
 327
 328     int32_t x = event->event_x >= 0 ? event->event_x : 0;
 329     int32_t original_x = x;
 330
 331     DLOG("Got Button %d\n", event->detail);
 332
 333     switch (event->detail) {
 334         case 4:
 335             /* Mouse wheel up. We select the previous ws, if any.
 336              * If there is no more workspace, don’t even send the workspace
 337              * command, otherwise (with workspace auto_back_and_forth) we’d end
 338              * up on the wrong workspace. */
 339             if (cur_ws == TAILQ_FIRST(walk->workspaces))
 340                 return;
 341
 342             cur_ws = TAILQ_PREV(cur_ws, ws_head, tailq);
 343             break;
 344         case 5:
 345             /* Mouse wheel down. We select the next ws, if any.
 346              * If there is no more workspace, don’t even send the workspace
 347              * command, otherwise (with workspace auto_back_and_forth) we’d end
 348              * up on the wrong workspace. */
 349             if (cur_ws == TAILQ_LAST(walk->workspaces, ws_head))
 350                 return;
 351
 352             cur_ws = TAILQ_NEXT(cur_ws, tailq);
 353             break;
 354         default:
 355             /* Check if this event regards a workspace button */
 356             TAILQ_FOREACH(cur_ws, walk->workspaces, tailq) {
 357                 DLOG("x = %d\n", x);
 358                 if (x >= 0 && x < cur_ws->name_width + 10) {
 359                     break;
 360                 }
 361                 x -= cur_ws->name_width + 11;
 362             }
 363             if (cur_ws == NULL) {
 364                 /* No workspace button was pressed.
 365                  * Check if a status block has been clicked.
 366                  * This of course only has an effect,
 367                  * if the child reported bidirectional protocol usage. */
 368
 369                 /* First calculate width of tray area */
 370                 trayclient *trayclient;
 371                 int tray_width = 0;
 372                 TAILQ_FOREACH_REVERSE(trayclient, walk->trayclients, tc_head, tailq) {
 373                     if (!trayclient->mapped)
 374                         continue;
 375                     tray_width += (font.height + 2);
 376                 }
 377
 378                 int block_x = 0, last_block_x;
 379                 int offset = (walk->rect.w - (statusline_width + tray_width)) - 10;
 380
 381                 x = original_x - offset;
 382                 if (x < 0)
 383                     return;
 384
 385                 struct status_block *block;
 386
 387                 TAILQ_FOREACH(block, &statusline_head, blocks) {
 388                     last_block_x = block_x;
 389                     block_x += block->width + block->x_offset + block->x_append;
 390
 391                     if (x <= block_x && x >= last_block_x) {
 392                         send_block_clicked(event->detail, block->name, block->instance, event->root_x, event->root_y);
 393                         return;
 394                     }
 395                 }
 396                 return;
 397             }
 398             if (event->detail != 1)
 399                 return;
 400     }
 401
 402     /* To properly handle workspace names with double quotes in them, we need
 403      * to escape the double quotes. Unfortunately, that’s rather ugly in C: We
 404      * first count the number of double quotes, then we allocate a large enough
 405      * buffer, then we copy character by character. */
 406     int num_quotes = 0;
 407     size_t namelen = 0;
 408     const char *utf8_name = i3string_as_utf8(cur_ws->name);
 409     for (const char *walk = utf8_name; *walk != '\0'; walk++) {
 410         if (*walk == '"')
 411             num_quotes++;
 412         /* While we’re looping through the name anyway, we can save one
 413          * strlen(). */
 414         namelen++;
 415     }
 416
 417     const size_t len = namelen + strlen("workspace \"\"") + 1;
 418     char *buffer = scalloc(len+num_quotes);
 419     strncpy(buffer, "workspace \"", strlen("workspace \""));
 420     int inpos, outpos;
 421     for (inpos = 0, outpos = strlen("workspace \"");
 422          inpos < namelen;
 423          inpos++, outpos++) {
 424         if (utf8_name[inpos] == '"') {
 425             buffer[outpos] = '\\';
 426             outpos++;
 427         }
 428         buffer[outpos] = utf8_name[inpos];
 429     }
 430     buffer[outpos] = '"';
 431     i3_send_msg(I3_IPC_MESSAGE_TYPE_COMMAND, buffer);
 432     free(buffer);
 433 }
 434
 435 /*
 436  * Configures the x coordinate of all trayclients. To be called after adding a
 437  * new tray client or removing an old one.
 438  *
 439  */
 440 static void configure_trayclients(void) {
 441     trayclient *trayclient;
 442     i3_output *output;
 443     SLIST_FOREACH(output, outputs, slist) {
 444         if (!output->active)
 445             continue;
 446
 447         int clients = 0;
 448         TAILQ_FOREACH_REVERSE(trayclient, output->trayclients, tc_head, tailq) {
 449             if (!trayclient->mapped)
 450                 continue;
 451             clients++;
 452
 453             DLOG("Configuring tray window %08x to x=%d\n",
 454                  trayclient->win, output->rect.w - (clients * (font.height + 2)));
 455             uint32_t x = output->rect.w - (clients * (font.height + 2));
 456             xcb_configure_window(xcb_connection,
 457                                  trayclient->win,
 458                                  XCB_CONFIG_WINDOW_X,
 459                                  &x);
 460         }
 461     }
 462 }
 463
 464 /*
 465  * Handles ClientMessages (messages sent from another client directly to us).
 466  *
 467  * At the moment, only the tray window will receive client messages. All
 468  * supported client messages currently are _NET_SYSTEM_TRAY_OPCODE.
 469  *
 470  */
 471 static void handle_client_message(xcb_client_message_event_t* event) {
 472     if (event->type == atoms[_NET_SYSTEM_TRAY_OPCODE] &&
 473         event->format == 32) {
 474         DLOG("_NET_SYSTEM_TRAY_OPCODE received\n");
 475         /* event->data.data32[0] is the timestamp */
 476         uint32_t op = event->data.data32[1];
 477         uint32_t mask;
 478         uint32_t values[2];
 479         if (op == SYSTEM_TRAY_REQUEST_DOCK) {
 480             xcb_window_t client = event->data.data32[2];
 481
 482             /* Listen for PropertyNotify events to get the most recent value of
 483              * the XEMBED_MAPPED atom, also listen for UnmapNotify events */
 484             mask = XCB_CW_EVENT_MASK;
 485             values[0] = XCB_EVENT_MASK_PROPERTY_CHANGE |
 486                         XCB_EVENT_MASK_STRUCTURE_NOTIFY;
 487             xcb_change_window_attributes(xcb_connection,
 488                                          client,
 489                                          mask,
 490                                          values);
 491
 492             /* Request the _XEMBED_INFO property. The XEMBED specification
 493              * (which is referred by the tray specification) says this *has* to
 494              * be set, but VLC does not set it… */
 495             bool map_it = true;
 496             int xe_version = 1;
 497             xcb_get_property_cookie_t xembedc;
 498             xcb_generic_error_t *error;
 499             xembedc = xcb_get_property(xcb_connection,
 500                                        0,
 501                                        client,
 502                                        atoms[_XEMBED_INFO],
 503                                        XCB_GET_PROPERTY_TYPE_ANY,
 504                                        0,
 505                                        2 * 32);
 506
 507             xcb_get_property_reply_t *xembedr = xcb_get_property_reply(xcb_connection,
 508                                                                        xembedc,
 509                                                                        &error);
 510             if (error != NULL) {
 511                 ELOG("Error getting _XEMBED_INFO property: error_code %d\n",
 512                      error->error_code);
 513                 free(error);
 514                 return;
 515             }
 516             if (xembedr != NULL && xembedr->length != 0) {
 517                 DLOG("xembed format = %d, len = %d\n", xembedr->format, xembedr->length);
 518                 uint32_t *xembed = xcb_get_property_value(xembedr);
 519                 DLOG("xembed version = %d\n", xembed[0]);
 520                 DLOG("xembed flags = %d\n", xembed[1]);
 521                 map_it = ((xembed[1] & XEMBED_MAPPED) == XEMBED_MAPPED);
 522                 xe_version = xembed[0];
 523                 if (xe_version > 1)
 524                     xe_version = 1;
 525                 free(xembedr);
 526             } else {
 527                 ELOG("Window %08x violates the XEMBED protocol, _XEMBED_INFO not set\n", client);
 528             }
 529
 530             DLOG("X window %08x requested docking\n", client);
 531             i3_output *walk, *output = NULL;
 532             SLIST_FOREACH(walk, outputs, slist) {
 533                 if (!walk->active)
 534                     continue;
 535                 if (config.tray_output) {
 536                     if ((strcasecmp(walk->name, config.tray_output) != 0) &&
 537                         (!walk->primary || strcasecmp("primary", config.tray_output) != 0))
 538                         continue;
 539                 }
 540
 541                 DLOG("using output %s\n", walk->name);
 542                 output = walk;
 543                 break;
 544             }
 545             /* In case of tray_output == primary and there is no primary output
 546              * configured, we fall back to the first available output. */
 547             if (output == NULL &&
 548                 config.tray_output &&
 549                 strcasecmp("primary", config.tray_output) == 0) {
 550                 SLIST_FOREACH(walk, outputs, slist) {
 551                     if (!walk->active)
 552                         continue;
 553                     DLOG("Falling back to output %s because no primary output is configured\n", walk->name);
 554                     output = walk;
 555                     break;
 556                 }
 557             }
 558             if (output == NULL) {
 559                 ELOG("No output found\n");
 560                 return;
 561             }
 562             xcb_reparent_window(xcb_connection,
 563                                 client,
 564                                 output->bar,
 565                                 output->rect.w - font.height - 2,
 566                                 2);
 567             /* We reconfigure the window to use a reasonable size. The systray
 568              * specification explicitly says:
 569              *   Tray icons may be assigned any size by the system tray, and
 570              *   should do their best to cope with any size effectively
 571              */
 572             mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
 573             values[0] = font.height;
 574             values[1] = font.height;
 575             xcb_configure_window(xcb_connection,
 576                                  client,
 577                                  mask,
 578                                  values);
 579
 580             /* send the XEMBED_EMBEDDED_NOTIFY message */
 581             void *event = scalloc(32);
 582             xcb_client_message_event_t *ev = event;
 583             ev->response_type = XCB_CLIENT_MESSAGE;
 584             ev->window = client;
 585             ev->type = atoms[_XEMBED];
 586             ev->format = 32;
 587             ev->data.data32[0] = XCB_CURRENT_TIME;
 588             ev->data.data32[1] = atoms[XEMBED_EMBEDDED_NOTIFY];
 589             ev->data.data32[2] = output->bar;
 590             ev->data.data32[3] = xe_version;
 591             xcb_send_event(xcb_connection,
 592                            0,
 593                            client,
 594                            XCB_EVENT_MASK_NO_EVENT,
 595                            (char*)ev);
 596             free(event);
 597
 598             /* Put the client inside the save set. Upon termination (whether
 599              * killed or normal exit does not matter) of i3bar, these clients
 600              * will be correctly reparented to their most closest living
 601              * ancestor. Without this, tray icons might die when i3bar
 602              * exits/crashes. */
 603             xcb_change_save_set(xcb_connection, XCB_SET_MODE_INSERT, client);
 604
 605             if (map_it) {
 606                 DLOG("Mapping dock client\n");
 607                 xcb_map_window(xcb_connection, client);
 608             } else {
 609                 DLOG("Not mapping dock client yet\n");
 610             }
 611             trayclient *tc = smalloc(sizeof(trayclient));
 612             tc->win = client;
 613             tc->mapped = map_it;
 614             tc->xe_version = xe_version;
 615             TAILQ_INSERT_TAIL(output->trayclients, tc, tailq);
 616
 617             /* Trigger an update to copy the statusline text to the appropriate
 618              * position */
 619             configure_trayclients();
 620             draw_bars(false);
 621         }
 622     }
 623 }
 624
 625 /*
 626  * Handles DestroyNotify events by removing the tray client from the data
 627  * structure. According to the XEmbed protocol, this is one way for a tray
 628  * client to finish the protocol. After this event is received, there is no
 629  * further interaction with the tray client.
 630  *
 631  * See: http://standards.freedesktop.org/xembed-spec/xembed-spec-latest.html
 632  *
 633  */
 634 static void handle_destroy_notify(xcb_destroy_notify_event_t* event) {
 635     DLOG("DestroyNotify for window = %08x, event = %08x\n", event->window, event->event);
 636
 637     i3_output *walk;
 638     SLIST_FOREACH(walk, outputs, slist) {
 639         if (!walk->active)
 640             continue;
 641         DLOG("checking output %s\n", walk->name);
 642         trayclient *trayclient;
 643         TAILQ_FOREACH(trayclient, walk->trayclients, tailq) {
 644             if (trayclient->win != event->window)
 645                 continue;
 646
 647             DLOG("Removing tray client with window ID %08x\n", event->window);
 648             TAILQ_REMOVE(walk->trayclients, trayclient, tailq);
 649
 650             /* Trigger an update, we now have more space for the statusline */
 651             configure_trayclients();
 652             draw_bars(false);
 653             return;
 654         }
 655     }
 656 }
 657
 658 /*
 659  * Handles UnmapNotify events. These events happen when a tray window unmaps
 660  * itself. We then update our data structure
 661  *
 662  */
 663 static void handle_unmap_notify(xcb_unmap_notify_event_t* event) {
 664     DLOG("UnmapNotify for window = %08x, event = %08x\n", event->window, event->event);
 665
 666     i3_output *walk;
 667     SLIST_FOREACH(walk, outputs, slist) {
 668         if (!walk->active)
 669             continue;
 670         DLOG("checking output %s\n", walk->name);
 671         trayclient *trayclient;
 672         TAILQ_FOREACH(trayclient, walk->trayclients, tailq) {
 673             if (trayclient->win != event->window)
 674                 continue;
 675
 676             DLOG("Removing tray client with window ID %08x\n", event->window);
 677             TAILQ_REMOVE(walk->trayclients, trayclient, tailq);
 678
 679             /* Trigger an update, we now have more space for the statusline */
 680             configure_trayclients();
 681             draw_bars(false);
 682             return;
 683         }
 684     }
 685 }
 686
 687 /*
 688  * Handle PropertyNotify messages. Currently only the _XEMBED_INFO property is
 689  * handled, which tells us whether a dock client should be mapped or unmapped.
 690  *
 691  */
 692 static void handle_property_notify(xcb_property_notify_event_t *event) {
 693     DLOG("PropertyNotify\n");
 694     if (event->atom == atoms[_XEMBED_INFO] &&
 695         event->state == XCB_PROPERTY_NEW_VALUE) {
 696         DLOG("xembed_info updated\n");
 697         trayclient *trayclient = NULL, *walk;
 698         i3_output *o_walk;
 699         SLIST_FOREACH(o_walk, outputs, slist) {
 700             if (!o_walk->active)
 701                 continue;
 702
 703             TAILQ_FOREACH(walk, o_walk->trayclients, tailq) {
 704                 if (walk->win != event->window)
 705                     continue;
 706                 trayclient = walk;
 707                 break;
 708             }
 709
 710             if (trayclient)
 711                 break;
 712         }
 713         if (!trayclient) {
 714             ELOG("PropertyNotify received for unknown window %08x\n",
 715                  event->window);
 716             return;
 717         }
 718         xcb_get_property_cookie_t xembedc;
 719         xembedc = xcb_get_property_unchecked(xcb_connection,
 720                                              0,
 721                                              trayclient->win,
 722                                              atoms[_XEMBED_INFO],
 723                                              XCB_GET_PROPERTY_TYPE_ANY,
 724                                              0,
 725                                              2 * 32);
 726
 727         xcb_get_property_reply_t *xembedr = xcb_get_property_reply(xcb_connection,
 728                                                                    xembedc,
 729                                                                    NULL);
 730         if (xembedr == NULL || xembedr->length == 0) {
 731             DLOG("xembed_info unset\n");
 732             return;
 733         }
 734
 735         DLOG("xembed format = %d, len = %d\n", xembedr->format, xembedr->length);
 736         uint32_t *xembed = xcb_get_property_value(xembedr);
 737         DLOG("xembed version = %d\n", xembed[0]);
 738         DLOG("xembed flags = %d\n", xembed[1]);
 739         bool map_it = ((xembed[1] & XEMBED_MAPPED) == XEMBED_MAPPED);
 740         DLOG("map-state now %d\n", map_it);
 741         if (trayclient->mapped && !map_it) {
 742             /* need to unmap the window */
 743             xcb_unmap_window(xcb_connection, trayclient->win);
 744             trayclient->mapped = map_it;
 745             configure_trayclients();
 746             draw_bars(false);
 747         } else if (!trayclient->mapped && map_it) {
 748             /* need to map the window */
 749             xcb_map_window(xcb_connection, trayclient->win);
 750             trayclient->mapped = map_it;
 751             configure_trayclients();
 752             draw_bars(false);
 753         }
 754         free(xembedr);
 755     }
 756 }
 757
 758 /*
 759  * Handle ConfigureRequests by denying them and sending the client a
 760  * ConfigureNotify with its actual size.
 761  *
 762  */
 763 static void handle_configure_request(xcb_configure_request_event_t *event) {
 764     DLOG("ConfigureRequest for window = %08x\n", event->window);
 765
 766     trayclient *trayclient;
 767     i3_output *output;
 768     SLIST_FOREACH(output, outputs, slist) {
 769         if (!output->active)
 770             continue;
 771
 772         int clients = 0;
 773         TAILQ_FOREACH_REVERSE(trayclient, output->trayclients, tc_head, tailq) {
 774             if (!trayclient->mapped)
 775                 continue;
 776             clients++;
 777
 778             if (trayclient->win != event->window)
 779                 continue;
 780
 781             xcb_rectangle_t rect;
 782             rect.x = output->rect.w - (clients * (font.height + 2));
 783             rect.y = 2;
 784             rect.width = font.height;
 785             rect.height = font.height;
 786
 787             DLOG("This is a tray window. x = %d\n", rect.x);
 788             fake_configure_notify(xcb_connection, rect, event->window, 0);
 789             return;
 790         }
 791     }
 792
 793     DLOG("WARNING: Could not find corresponding tray window.\n");
 794 }
 795
 796 /*
 797  * This function is called immediately before the main loop locks. We flush xcb
 798  * then (and only then)
 799  *
 800  */
 801 void xcb_prep_cb(struct ev_loop *loop, ev_prepare *watcher, int revents) {
 802     xcb_flush(xcb_connection);
 803 }
 804
 805 /*
 806  * This function is called immediately after the main loop locks, so when one
 807  * of the watchers registered an event.
 808  * We check whether an X-Event arrived and handle it.
 809  *
 810  */
 811 void xcb_chk_cb(struct ev_loop *loop, ev_check *watcher, int revents) {
 812     xcb_generic_event_t *event;
 813
 814     if (xcb_connection_has_error(xcb_connection)) {
 815         ELOG("X11 connection was closed unexpectedly - maybe your X server terminated / crashed?\n");
 816         exit(1);
 817     }
 818
 819     while ((event = xcb_poll_for_event(xcb_connection)) != NULL) {
 820         switch (event->response_type & ~0x80) {
 821             case XCB_EXPOSE:
 822                 /* Expose-events happen, when the window needs to be redrawn */
 823                 redraw_bars();
 824                 break;
 825             case XCB_BUTTON_PRESS:
 826                 /* Button-press-events are mouse-buttons clicked on one of our bars */
 827                 handle_button((xcb_button_press_event_t*) event);
 828                 break;
 829             case XCB_CLIENT_MESSAGE:
 830                 /* Client messages are used for client-to-client communication, for
 831                  * example system tray widgets talk to us directly via client messages. */
 832                 handle_client_message((xcb_client_message_event_t*) event);
 833                 break;
 834             case XCB_DESTROY_NOTIFY:
 835                 /* DestroyNotify signifies the end of the XEmbed protocol */
 836                 handle_destroy_notify((xcb_destroy_notify_event_t*) event);
 837                 break;
 838             case XCB_UNMAP_NOTIFY:
 839                 /* UnmapNotifies are received when a tray window unmaps itself */
 840                 handle_unmap_notify((xcb_unmap_notify_event_t*) event);
 841                 break;
 842             case XCB_PROPERTY_NOTIFY:
 843                 /* PropertyNotify */
 844                 handle_property_notify((xcb_property_notify_event_t*) event);
 845                 break;
 846             case XCB_CONFIGURE_REQUEST:
 847                 /* ConfigureRequest, sent by a tray child */
 848                 handle_configure_request((xcb_configure_request_event_t*) event);
 849                 break;
 850         }
 851         free(event);
 852     }
 853 }
 854
 855 /*
 856  * Dummy Callback. We only need this, so that the Prepare- and Check-Watchers
 857  * are triggered
 858  *
 859  */
 860 void xcb_io_cb(struct ev_loop *loop, ev_io *watcher, int revents) {
 861 }
 862
 863 /*
 864  * We need to bind to the modifier per XKB. Sadly, XCB does not implement this
 865  *
 866  */
 867 void xkb_io_cb(struct ev_loop *loop, ev_io *watcher, int revents) {
 868     XkbEvent ev;
 869     int modstate = 0;
 870
 871     DLOG("Got XKB-Event!\n");
 872
 873     while (XPending(xkb_dpy)) {
 874         XNextEvent(xkb_dpy, (XEvent*)&ev);
 875
 876         if (ev.type != xkb_event_base) {
 877             ELOG("No Xkb-Event!\n");
 878             continue;
 879         }
 880
 881         if (ev.any.xkb_type != XkbStateNotify) {
 882             ELOG("No State Notify!\n");
 883             continue;
 884         }
 885
 886         unsigned int mods = ev.state.mods;
 887         modstate = mods & config.modifier;
 888     }
 889
 890 #define DLOGMOD(modmask, status) \
 891     do { \
 892         switch (modmask) { \
 893             case ShiftMask: \
 894                 DLOG("ShiftMask got " #status "!\n"); \
 895                 break; \
 896             case ControlMask: \
 897                 DLOG("ControlMask got " #status "!\n"); \
 898                 break; \
 899             case Mod1Mask: \
 900                 DLOG("Mod1Mask got " #status "!\n"); \
 901                 break; \
 902             case Mod2Mask: \
 903                 DLOG("Mod2Mask got " #status "!\n"); \
 904                 break; \
 905             case Mod3Mask: \
 906                 DLOG("Mod3Mask got " #status "!\n"); \
 907                 break; \
 908             case Mod4Mask: \
 909                 DLOG("Mod4Mask got " #status "!\n"); \
 910                 break; \
 911             case Mod5Mask: \
 912                 DLOG("Mod5Mask got " #status "!\n"); \
 913                 break; \
 914         } \
 915     } while (0)
 916
 917     if (modstate != mod_pressed) {
 918         if (modstate == 0) {
 919             DLOGMOD(config.modifier, released);
 920             if (!activated_mode)
 921                 hide_bars();
 922         } else {
 923             DLOGMOD(config.modifier, pressed);
 924             activated_mode = false;
 925             unhide_bars();
 926         }
 927         mod_pressed = modstate;
 928     }
 929
 930 #undef DLOGMOD
 931 }
 932
 933 /*
 934  * Early initialization of the connection to X11: Everything which does not
 935  * depend on 'config'.
 936  *
 937  */
 938 char *init_xcb_early() {
 939     /* FIXME: xcb_connect leaks Memory */
 940     xcb_connection = xcb_connect(NULL, &screen);
 941     if (xcb_connection_has_error(xcb_connection)) {
 942         ELOG("Cannot open display\n");
 943         exit(EXIT_FAILURE);
 944     }
 945     conn = xcb_connection;
 946     DLOG("Connected to xcb\n");
 947
 948     /* We have to request the atoms we need */
 949     #define ATOM_DO(name) atom_cookies[name] = xcb_intern_atom(xcb_connection, 0, strlen(#name), #name);
 950     #include "xcb_atoms.def"
 951
 952     root_screen = xcb_aux_get_screen(xcb_connection, screen);
 953     xcb_root = root_screen->root;
 954
 955     /* We draw the statusline to a seperate pixmap, because it looks the same on all bars and
 956      * this way, we can choose to crop it */
 957     uint32_t mask = XCB_GC_FOREGROUND;
 958     uint32_t vals[] = { colors.bar_bg, colors.bar_bg };
 959
 960     statusline_clear = xcb_generate_id(xcb_connection);
 961     xcb_void_cookie_t clear_ctx_cookie = xcb_create_gc_checked(xcb_connection,
 962                                                                statusline_clear,
 963                                                                xcb_root,
 964                                                                mask,
 965                                                                vals);
 966
 967     statusline_ctx = xcb_generate_id(xcb_connection);
 968     xcb_void_cookie_t sl_ctx_cookie = xcb_create_gc_checked(xcb_connection,
 969                                                             statusline_ctx,
 970                                                             xcb_root,
 971                                                             0,
 972                                                             NULL);
 973
 974     statusline_pm = xcb_generate_id(xcb_connection);
 975     xcb_void_cookie_t sl_pm_cookie = xcb_create_pixmap_checked(xcb_connection,
 976                                                                root_screen->root_depth,
 977                                                                statusline_pm,
 978                                                                xcb_root,
 979                                                                root_screen->width_in_pixels,
 980                                                                root_screen->height_in_pixels);
 981
 982
 983     /* The various Watchers to communicate with xcb */
 984     xcb_io = smalloc(sizeof(ev_io));
 985     xcb_prep = smalloc(sizeof(ev_prepare));
 986     xcb_chk = smalloc(sizeof(ev_check));
 987
 988     ev_io_init(xcb_io, &xcb_io_cb, xcb_get_file_descriptor(xcb_connection), EV_READ);
 989     ev_prepare_init(xcb_prep, &xcb_prep_cb);
 990     ev_check_init(xcb_chk, &xcb_chk_cb);
 991
 992     ev_io_start(main_loop, xcb_io);
 993     ev_prepare_start(main_loop, xcb_prep);
 994     ev_check_start(main_loop, xcb_chk);
 995
 996     /* Now we get the atoms and save them in a nice data structure */
 997     get_atoms();
 998
 999     char *path = root_atom_contents("I3_SOCKET_PATH", xcb_connection, screen);
1000
1001     if (xcb_request_failed(sl_pm_cookie, "Could not allocate statusline-buffer") ||
1002         xcb_request_failed(clear_ctx_cookie, "Could not allocate statusline-buffer-clearcontext") ||
1003         xcb_request_failed(sl_ctx_cookie, "Could not allocate statusline-buffer-context")) {
1004         exit(EXIT_FAILURE);
1005     }
1006
1007     return path;
1008 }
1009
1010 /*
1011  * Register for xkb keyevents. To grab modifiers without blocking other applications from receiving key-events
1012  * involving that modifier, we sadly have to use xkb which is not yet fully supported
1013  * in xcb.
1014  *
1015  */
1016 void register_xkb_keyevents() {
1017     if (xkb_dpy == NULL) {
1018         int xkb_major, xkb_minor, xkb_errbase, xkb_err;
1019         xkb_major = XkbMajorVersion;
1020         xkb_minor = XkbMinorVersion;
1021
1022         xkb_dpy = XkbOpenDisplay(NULL,
1023                                  &xkb_event_base,
1024                                  &xkb_errbase,
1025                                  &xkb_major,
1026                                  &xkb_minor,
1027                                  &xkb_err);
1028
1029         if (xkb_dpy == NULL) {
1030             ELOG("No XKB!\n");
1031             exit(EXIT_FAILURE);
1032         }
1033
1034         if (fcntl(ConnectionNumber(xkb_dpy), F_SETFD, FD_CLOEXEC) == -1) {
1035             ELOG("Could not set FD_CLOEXEC on xkbdpy: %s\n", strerror(errno));
1036             exit(EXIT_FAILURE);
1037         }
1038
1039         int i1;
1040         if (!XkbQueryExtension(xkb_dpy, &i1, &xkb_event_base, &xkb_errbase, &xkb_major, &xkb_minor)) {
1041             ELOG("XKB not supported by X-server!\n");
1042             exit(EXIT_FAILURE);
1043         }
1044
1045         if (!XkbSelectEvents(xkb_dpy, XkbUseCoreKbd, XkbStateNotifyMask, XkbStateNotifyMask)) {
1046             ELOG("Could not grab Key!\n");
1047             exit(EXIT_FAILURE);
1048         }
1049
1050         xkb_io = smalloc(sizeof(ev_io));
1051         ev_io_init(xkb_io, &xkb_io_cb, ConnectionNumber(xkb_dpy), EV_READ);
1052         ev_io_start(main_loop, xkb_io);
1053         XFlush(xkb_dpy);
1054     }
1055 }
1056
1057 /*
1058  * Deregister from xkb keyevents.
1059  *
1060  */
1061 void deregister_xkb_keyevents() {
1062     if (xkb_dpy != NULL) {
1063         ev_io_stop (main_loop, xkb_io);
1064         XCloseDisplay(xkb_dpy);
1065         close(xkb_io->fd);
1066         FREE(xkb_io);
1067         xkb_dpy = NULL;
1068     }
1069 }
1070
1071 /*
1072  * Initialization which depends on 'config' being usable. Called after the
1073  * configuration has arrived.
1074  *
1075  */
1076 void init_xcb_late(char *fontname) {
1077     if (fontname == NULL)
1078         fontname = "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1";
1079
1080     /* Load the font */
1081     font = load_font(fontname, true);
1082     set_font(&font);
1083     DLOG("Calculated Font-height: %d\n", font.height);
1084     bar_height = font.height + 6;
1085
1086     xcb_flush(xcb_connection);
1087
1088     if (config.hide_on_modifier == M_HIDE)
1089         register_xkb_keyevents();
1090 }
1091
1092 /*
1093  * Inform clients waiting for a new _NET_SYSTEM_TRAY that we took the
1094  * selection.
1095  *
1096  */
1097 static void send_tray_clientmessage(void) {
1098     uint8_t buffer[32] = { 0 };
1099     xcb_client_message_event_t *ev = (xcb_client_message_event_t*)buffer;
1100
1101     ev->response_type = XCB_CLIENT_MESSAGE;
1102     ev->window = xcb_root;
1103     ev->type = atoms[MANAGER];
1104     ev->format = 32;
1105     ev->data.data32[0] = XCB_CURRENT_TIME;
1106     ev->data.data32[1] = tray_reply->atom;
1107     ev->data.data32[2] = selwin;
1108
1109     xcb_send_event(xcb_connection,
1110                    0,
1111                    xcb_root,
1112                    0xFFFFFF,
1113                    (char*)buffer);
1114 }
1115
1116
1117 /*
1118  * Initializes tray support by requesting the appropriate _NET_SYSTEM_TRAY atom
1119  * for the X11 display we are running on, then acquiring the selection for this
1120  * atom. Afterwards, tray clients will send ClientMessages to our window.
1121  *
1122  */
1123 void init_tray(void) {
1124     DLOG("Initializing system tray functionality\n");
1125     /* request the tray manager atom for the X11 display we are running on */
1126     char atomname[strlen("_NET_SYSTEM_TRAY_S") + 11];
1127     snprintf(atomname, strlen("_NET_SYSTEM_TRAY_S") + 11, "_NET_SYSTEM_TRAY_S%d", screen);
1128     xcb_intern_atom_cookie_t tray_cookie;
1129     if (tray_reply == NULL)
1130         tray_cookie = xcb_intern_atom(xcb_connection, 0, strlen(atomname), atomname);
1131
1132     /* tray support: we need a window to own the selection */
1133     selwin = xcb_generate_id(xcb_connection);
1134     uint32_t selmask = XCB_CW_OVERRIDE_REDIRECT;
1135     uint32_t selval[] = { 1 };
1136     xcb_create_window(xcb_connection,
1137                       root_screen->root_depth,
1138                       selwin,
1139                       xcb_root,
1140                       -1, -1,
1141                       1, 1,
1142                       0,
1143                       XCB_WINDOW_CLASS_INPUT_OUTPUT,
1144                       root_screen->root_visual,
1145                       selmask,
1146                       selval);
1147
1148     uint32_t orientation = _NET_SYSTEM_TRAY_ORIENTATION_HORZ;
1149     /* set the atoms */
1150     xcb_change_property(xcb_connection,
1151                         XCB_PROP_MODE_REPLACE,
1152                         selwin,
1153                         atoms[_NET_SYSTEM_TRAY_ORIENTATION],
1154                         XCB_ATOM_CARDINAL,
1155                         32,
1156                         1,
1157                         &orientation);
1158
1159     init_tray_colors();
1160
1161     if (tray_reply == NULL) {
1162         if (!(tray_reply = xcb_intern_atom_reply(xcb_connection, tray_cookie, NULL))) {
1163             ELOG("Could not get atom %s\n", atomname);
1164             exit(EXIT_FAILURE);
1165         }
1166     }
1167
1168     xcb_set_selection_owner(xcb_connection,
1169                             selwin,
1170                             tray_reply->atom,
1171                             XCB_CURRENT_TIME);
1172
1173     /* Verify that we have the selection */
1174     xcb_get_selection_owner_cookie_t selcookie;
1175     xcb_get_selection_owner_reply_t *selreply;
1176
1177     selcookie = xcb_get_selection_owner(xcb_connection, tray_reply->atom);
1178     if (!(selreply = xcb_get_selection_owner_reply(xcb_connection, selcookie, NULL))) {
1179         ELOG("Could not get selection owner for %s\n", atomname);
1180         exit(EXIT_FAILURE);
1181     }
1182
1183     if (selreply->owner != selwin) {
1184         ELOG("Could not set the %s selection. " \
1185              "Maybe another tray is already running?\n", atomname);
1186         /* NOTE that this error is not fatal. We just can’t provide tray
1187          * functionality */
1188         free(selreply);
1189         return;
1190     }
1191
1192     send_tray_clientmessage();
1193 }
1194
1195 /*
1196  * We need to set the _NET_SYSTEM_TRAY_COLORS atom on the tray selection window
1197  * to make GTK+ 3 applets with Symbolic Icons visible. If the colors are unset,
1198  * they assume a light background.
1199  * See also https://bugzilla.gnome.org/show_bug.cgi?id=679591
1200  *
1201  */
1202 void init_tray_colors(void) {
1203     /* Convert colors.bar_fg (#rrggbb) to 16-bit RGB */
1204     const char *bar_fg = (config.colors.bar_fg ? config.colors.bar_fg : "#FFFFFF");
1205
1206     DLOG("Setting bar_fg = %s as _NET_SYSTEM_TRAY_COLORS\n", bar_fg);
1207
1208     char strgroups[3][3] = {{bar_fg[1], bar_fg[2], '\0'},
1209                             {bar_fg[3], bar_fg[4], '\0'},
1210                             {bar_fg[5], bar_fg[6], '\0'}};
1211     const uint8_t r = strtol(strgroups[0], NULL, 16);
1212     const uint8_t g = strtol(strgroups[1], NULL, 16);
1213     const uint8_t b = strtol(strgroups[2], NULL, 16);
1214
1215     const uint16_t r16 = ((uint16_t)r << 8) | r;
1216     const uint16_t g16 = ((uint16_t)g << 8) | g;
1217     const uint16_t b16 = ((uint16_t)b << 8) | b;
1218
1219     const uint32_t tray_colors[12] = {
1220         r16, g16, b16, /* foreground color */
1221         r16, g16, b16, /* error color */
1222         r16, g16, b16, /* warning color */
1223         r16, g16, b16, /* success color */
1224     };
1225
1226     xcb_change_property(xcb_connection,
1227                         XCB_PROP_MODE_REPLACE,
1228                         selwin,
1229                         atoms[_NET_SYSTEM_TRAY_COLORS],
1230                         XCB_ATOM_CARDINAL,
1231                         32,
1232                         12,
1233                         tray_colors);
1234 }
1235
1236 /*
1237  * Cleanup the xcb-stuff.
1238  * Called once, before the program terminates.
1239  *
1240  */
1241 void clean_xcb(void) {
1242     i3_output *o_walk;
1243     free_workspaces();
1244     SLIST_FOREACH(o_walk, outputs, slist) {
1245         destroy_window(o_walk);
1246         FREE(o_walk->trayclients);
1247         FREE(o_walk->workspaces);
1248         FREE(o_walk->name);
1249     }
1250     FREE_SLIST(outputs, i3_output);
1251     FREE(outputs);
1252
1253     xcb_flush(xcb_connection);
1254     xcb_disconnect(xcb_connection);
1255
1256     ev_check_stop(main_loop, xcb_chk);
1257     ev_prepare_stop(main_loop, xcb_prep);
1258     ev_io_stop(main_loop, xcb_io);
1259
1260     FREE(xcb_chk);
1261     FREE(xcb_prep);
1262     FREE(xcb_io);
1263 }
1264
1265 /*
1266  * Get the earlier requested atoms and save them in the prepared data structure
1267  *
1268  */
1269 void get_atoms(void) {
1270     xcb_intern_atom_reply_t *reply;
1271     #define ATOM_DO(name) reply = xcb_intern_atom_reply(xcb_connection, atom_cookies[name], NULL); \
1272         if (reply == NULL) { \
1273             ELOG("Could not get atom %s\n", #name); \
1274             exit(EXIT_FAILURE); \
1275         } \
1276         atoms[name] = reply->atom; \
1277         free(reply);
1278
1279     #include "xcb_atoms.def"
1280     DLOG("Got Atoms\n");
1281 }
1282
1283 /*
1284  * Reparents all tray clients of the specified output to the root window. This
1285  * is either used when shutting down, when an output appears (xrandr --output
1286  * VGA1 --off) or when the primary output changes.
1287  *
1288  * Applications using the tray will start the protocol from the beginning again
1289  * afterwards.
1290  *
1291  */
1292 void kick_tray_clients(i3_output *output) {
1293     if (TAILQ_EMPTY(output->trayclients))
1294         return;
1295
1296     trayclient *trayclient;
1297     while (!TAILQ_EMPTY(output->trayclients)) {
1298         trayclient = TAILQ_FIRST(output->trayclients);
1299         /* Unmap, then reparent (to root) the tray client windows */
1300         xcb_unmap_window(xcb_connection, trayclient->win);
1301         xcb_reparent_window(xcb_connection,
1302                             trayclient->win,
1303                             xcb_root,
1304                             0,
1305                             0);
1306
1307         /* We remove the trayclient right here. We might receive an UnmapNotify
1308          * event afterwards, but better safe than sorry. */
1309         TAILQ_REMOVE(output->trayclients, trayclient, tailq);
1310     }
1311
1312     /* Fake a DestroyNotify so that Qt re-adds tray icons.
1313      * We cannot actually destroy the window because then Qt will not restore
1314      * its event mask on the new window. */
1315     uint8_t buffer[32] = { 0 };
1316     xcb_destroy_notify_event_t *event = (xcb_destroy_notify_event_t*)buffer;
1317
1318     event->response_type = XCB_DESTROY_NOTIFY;
1319     event->event = selwin;
1320     event->window = selwin;
1321
1322     xcb_send_event(conn, false, selwin, XCB_EVENT_MASK_STRUCTURE_NOTIFY, (char*)event);
1323
1324     send_tray_clientmessage();
1325 }
1326
1327 /*
1328  * Destroy the bar of the specified output
1329  *
1330  */
1331 void destroy_window(i3_output *output) {
1332     if (output == NULL) {
1333         return;
1334     }
1335     if (output->bar == XCB_NONE) {
1336         return;
1337     }
1338
1339     kick_tray_clients(output);
1340     xcb_destroy_window(xcb_connection, output->bar);
1341     output->bar = XCB_NONE;
1342 }
1343
1344 /*
1345  * Reallocate the statusline-buffer
1346  *
1347  */
1348 void realloc_sl_buffer(void) {
1349     DLOG("Re-allocating statusline-buffer, statusline_width = %d, root_screen->width_in_pixels = %d\n",
1350          statusline_width, root_screen->width_in_pixels);
1351     xcb_free_pixmap(xcb_connection, statusline_pm);
1352     statusline_pm = xcb_generate_id(xcb_connection);
1353     xcb_void_cookie_t sl_pm_cookie = xcb_create_pixmap_checked(xcb_connection,
1354                                                                root_screen->root_depth,
1355                                                                statusline_pm,
1356                                                                xcb_root,
1357                                                                MAX(root_screen->width_in_pixels, statusline_width),
1358                                                                bar_height);
1359
1360     uint32_t mask = XCB_GC_FOREGROUND;
1361     uint32_t vals[2] = { colors.bar_bg, colors.bar_bg };
1362     xcb_free_gc(xcb_connection, statusline_clear);
1363     statusline_clear = xcb_generate_id(xcb_connection);
1364     xcb_void_cookie_t clear_ctx_cookie = xcb_create_gc_checked(xcb_connection,
1365                                                                statusline_clear,
1366                                                                xcb_root,
1367                                                                mask,
1368                                                                vals);
1369
1370     mask |= XCB_GC_BACKGROUND;
1371     vals[0] = colors.bar_fg;
1372     statusline_ctx = xcb_generate_id(xcb_connection);
1373     xcb_free_gc(xcb_connection, statusline_ctx);
1374     xcb_void_cookie_t sl_ctx_cookie = xcb_create_gc_checked(xcb_connection,
1375                                                             statusline_ctx,
1376                                                             xcb_root,
1377                                                             mask,
1378                                                             vals);
1379
1380     if (xcb_request_failed(sl_pm_cookie, "Could not allocate statusline-buffer") ||
1381         xcb_request_failed(clear_ctx_cookie, "Could not allocate statusline-buffer-clearcontext") ||
1382         xcb_request_failed(sl_ctx_cookie, "Could not allocate statusline-buffer-context")) {
1383         exit(EXIT_FAILURE);
1384     }
1385
1386 }
1387
1388 /*
1389  * Reconfigure all bars and create new bars for recently activated outputs
1390  *
1391  */
1392 void reconfig_windows(bool redraw_bars) {
1393     uint32_t mask;
1394     uint32_t values[5];
1395     static bool tray_configured = false;
1396
1397     i3_output *walk;
1398     SLIST_FOREACH(walk, outputs, slist) {
1399         if (!walk->active) {
1400             /* If an output is not active, we destroy its bar */
1401             /* FIXME: Maybe we rather want to unmap? */
1402             DLOG("Destroying window for output %s\n", walk->name);
1403             destroy_window(walk);
1404             continue;
1405         }
1406         if (walk->bar == XCB_NONE) {
1407             DLOG("Creating Window for output %s\n", walk->name);
1408
1409             walk->bar = xcb_generate_id(xcb_connection);
1410             walk->buffer = xcb_generate_id(xcb_connection);
1411             mask = XCB_CW_BACK_PIXEL | XCB_CW_OVERRIDE_REDIRECT | XCB_CW_EVENT_MASK;
1412             /* Black background */
1413             values[0] = colors.bar_bg;
1414             /* If hide_on_modifier is set to hide or invisible mode, i3 is not supposed to manage our bar-windows */
1415             values[1] = (config.hide_on_modifier == M_DOCK ? 0 : 1);
1416             /* We enable the following EventMask fields:
1417              * EXPOSURE, to get expose events (we have to re-draw then)
1418              * SUBSTRUCTURE_REDIRECT, to get ConfigureRequests when the tray
1419              *                        child windows use ConfigureWindow
1420              * BUTTON_PRESS, to handle clicks on the workspace buttons
1421              * */
1422             values[2] = XCB_EVENT_MASK_EXPOSURE |
1423                         XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT;
1424             if (!config.disable_ws) {
1425                 values[2] |= XCB_EVENT_MASK_BUTTON_PRESS;
1426             }
1427             xcb_void_cookie_t win_cookie = xcb_create_window_checked(xcb_connection,
1428                                                                      root_screen->root_depth,
1429                                                                      walk->bar,
1430                                                                      xcb_root,
1431                                                                      walk->rect.x, walk->rect.y + walk->rect.h - bar_height,
1432                                                                      walk->rect.w, bar_height,
1433                                                                      0,
1434                                                                      XCB_WINDOW_CLASS_INPUT_OUTPUT,
1435                                                                      root_screen->root_visual,
1436                                                                      mask,
1437                                                                      values);
1438
1439             /* The double-buffer we use to render stuff off-screen */
1440             xcb_void_cookie_t pm_cookie = xcb_create_pixmap_checked(xcb_connection,
1441                                                                     root_screen->root_depth,
1442                                                                     walk->buffer,
1443                                                                     walk->bar,
1444                                                                     walk->rect.w,
1445                                                                     bar_height);
1446
1447             /* Set the WM_CLASS and WM_NAME (we don't need UTF-8) atoms */
1448             xcb_void_cookie_t class_cookie;
1449             class_cookie = xcb_change_property(xcb_connection,
1450                                                XCB_PROP_MODE_REPLACE,
1451                                                walk->bar,
1452                                                XCB_ATOM_WM_CLASS,
1453                                                XCB_ATOM_STRING,
1454                                                8,
1455                                                (strlen("i3bar") + 1) * 2,
1456                                                "i3bar\0i3bar\0");
1457
1458             char *name;
1459             if (asprintf(&name, "i3bar for output %s", walk->name) == -1)
1460                 err(EXIT_FAILURE, "asprintf()");
1461             xcb_void_cookie_t name_cookie;
1462             name_cookie = xcb_change_property(xcb_connection,
1463                                               XCB_PROP_MODE_REPLACE,
1464                                               walk->bar,
1465                                               XCB_ATOM_WM_NAME,
1466                                               XCB_ATOM_STRING,
1467                                               8,
1468                                               strlen(name),
1469                                               name);
1470             free(name);
1471
1472             /* We want dock-windows (for now). When override_redirect is set, i3 is ignoring
1473              * this one */
1474             xcb_void_cookie_t dock_cookie = xcb_change_property(xcb_connection,
1475                                                                 XCB_PROP_MODE_REPLACE,
1476                                                                 walk->bar,
1477                                                                 atoms[_NET_WM_WINDOW_TYPE],
1478                                                                 XCB_ATOM_ATOM,
1479                                                                 32,
1480                                                                 1,
1481                                                                 (unsigned char*) &atoms[_NET_WM_WINDOW_TYPE_DOCK]);
1482
1483             /* We need to tell i3, where to reserve space for i3bar */
1484             /* left, right, top, bottom, left_start_y, left_end_y,
1485              * right_start_y, right_end_y, top_start_x, top_end_x, bottom_start_x,
1486              * bottom_end_x */
1487             /* A local struct to save the strut_partial property */
1488             struct {
1489                 uint32_t left;
1490                 uint32_t right;
1491                 uint32_t top;
1492                 uint32_t bottom;
1493                 uint32_t left_start_y;
1494                 uint32_t left_end_y;
1495                 uint32_t right_start_y;
1496                 uint32_t right_end_y;
1497                 uint32_t top_start_x;
1498                 uint32_t top_end_x;
1499                 uint32_t bottom_start_x;
1500                 uint32_t bottom_end_x;
1501             } __attribute__((__packed__)) strut_partial = {0,};
1502             switch (config.position) {
1503                 case POS_NONE:
1504                     break;
1505                 case POS_TOP:
1506                     strut_partial.top = bar_height;
1507                     strut_partial.top_start_x = walk->rect.x;
1508                     strut_partial.top_end_x = walk->rect.x + walk->rect.w;
1509                     break;
1510                 case POS_BOT:
1511                     strut_partial.bottom = bar_height;
1512                     strut_partial.bottom_start_x = walk->rect.x;
1513                     strut_partial.bottom_end_x = walk->rect.x + walk->rect.w;
1514                     break;
1515             }
1516             xcb_void_cookie_t strut_cookie = xcb_change_property(xcb_connection,
1517                                                                  XCB_PROP_MODE_REPLACE,
1518                                                                  walk->bar,
1519                                                                  atoms[_NET_WM_STRUT_PARTIAL],
1520                                                                  XCB_ATOM_CARDINAL,
1521                                                                  32,
1522                                                                  12,
1523                                                                  &strut_partial);
1524
1525             /* We also want a graphics-context for the bars (it defines the properties
1526              * with which we draw to them) */
1527             walk->bargc = xcb_generate_id(xcb_connection);
1528             xcb_void_cookie_t gc_cookie = xcb_create_gc_checked(xcb_connection,
1529                                                                 walk->bargc,
1530                                                                 walk->bar,
1531                                                                 0,
1532                                                                 NULL);
1533
1534             /* We finally map the bar (display it on screen), unless the modifier-switch is on */
1535             xcb_void_cookie_t map_cookie;
1536             if (config.hide_on_modifier == M_DOCK) {
1537                 map_cookie = xcb_map_window_checked(xcb_connection, walk->bar);
1538             }
1539
1540             if (xcb_request_failed(win_cookie,   "Could not create window") ||
1541                 xcb_request_failed(pm_cookie,    "Could not create pixmap") ||
1542                 xcb_request_failed(dock_cookie,  "Could not set dock mode") ||
1543                 xcb_request_failed(class_cookie, "Could not set WM_CLASS")  ||
1544                 xcb_request_failed(name_cookie,  "Could not set WM_NAME")   ||
1545                 xcb_request_failed(strut_cookie, "Could not set strut")     ||
1546                 xcb_request_failed(gc_cookie,    "Could not create graphical context") ||
1547                 ((config.hide_on_modifier == M_DOCK) && xcb_request_failed(map_cookie, "Could not map window"))) {
1548                 exit(EXIT_FAILURE);
1549             }
1550
1551             const char *tray_output = (config.tray_output ? config.tray_output : SLIST_FIRST(outputs)->name);
1552             if (!tray_configured && strcasecmp(tray_output, "none") != 0) {
1553                 /* Configuration sanity check: ensure this i3bar instance handles the output on
1554                  * which the tray should appear (e.g. don’t initialize a tray if tray_output ==
1555                  * VGA-1 but output == [HDMI-1]).
1556                  */
1557                 i3_output *output;
1558                 SLIST_FOREACH(output, outputs, slist) {
1559                     if (strcasecmp(output->name, tray_output) == 0 ||
1560                             (strcasecmp(tray_output, "primary") == 0 && output->primary)) {
1561                         init_tray();
1562                         break;
1563                     }
1564                 }
1565                 tray_configured = true;
1566             }
1567         } else {
1568             /* We already have a bar, so we just reconfigure it */
1569             mask = XCB_CONFIG_WINDOW_X |
1570                    XCB_CONFIG_WINDOW_Y |
1571                    XCB_CONFIG_WINDOW_WIDTH |
1572                    XCB_CONFIG_WINDOW_HEIGHT |
1573                    XCB_CONFIG_WINDOW_STACK_MODE;
1574             values[0] = walk->rect.x;
1575             values[1] = walk->rect.y + walk->rect.h - bar_height;
1576             values[2] = walk->rect.w;
1577             values[3] = bar_height;
1578             values[4] = XCB_STACK_MODE_ABOVE;
1579
1580             DLOG("Destroying buffer for output %s\n", walk->name);
1581             xcb_free_pixmap(xcb_connection, walk->buffer);
1582
1583             DLOG("Reconfiguring Window for output %s to %d,%d\n", walk->name, values[0], values[1]);
1584             xcb_void_cookie_t cfg_cookie = xcb_configure_window_checked(xcb_connection,
1585                                                                         walk->bar,
1586                                                                         mask,
1587                                                                         values);
1588
1589             mask = XCB_CW_OVERRIDE_REDIRECT;
1590             values[0] = (config.hide_on_modifier == M_DOCK ? 0 : 1);
1591             DLOG("Changing Window attribute override_redirect for output %s to %d\n", walk->name, values[0]);
1592             xcb_void_cookie_t chg_cookie = xcb_change_window_attributes(xcb_connection,
1593                                                                         walk->bar,
1594                                                                         mask,
1595                                                                         values);
1596
1597             DLOG("Recreating buffer for output %s\n", walk->name);
1598             xcb_void_cookie_t pm_cookie = xcb_create_pixmap_checked(xcb_connection,
1599                                                                     root_screen->root_depth,
1600                                                                     walk->buffer,
1601                                                                     walk->bar,
1602                                                                     walk->rect.w,
1603                                                                     bar_height);
1604
1605             xcb_void_cookie_t map_cookie, umap_cookie;
1606             if (redraw_bars) {
1607                 /* Unmap the window, and draw it again when in dock mode */
1608                 umap_cookie = xcb_unmap_window_checked(xcb_connection, walk->bar);
1609                 if (config.hide_on_modifier == M_DOCK) {
1610                     cont_child();
1611                     map_cookie = xcb_map_window_checked(xcb_connection, walk->bar);
1612                 } else {
1613                     stop_child();
1614                 }
1615
1616                 if (config.hide_on_modifier == M_HIDE) {
1617                     /* Switching to hide mode, register for keyevents */
1618                     register_xkb_keyevents();
1619                 } else {
1620                     /* Switching to dock/invisible mode, deregister from keyevents */
1621                     deregister_xkb_keyevents();
1622                 }
1623             }
1624
1625             if (xcb_request_failed(cfg_cookie, "Could not reconfigure window") ||
1626                 xcb_request_failed(chg_cookie, "Could not change window") ||
1627                 xcb_request_failed(pm_cookie,  "Could not create pixmap") ||
1628                 (redraw_bars && (xcb_request_failed(umap_cookie,  "Could not unmap window") ||
1629                 (config.hide_on_modifier == M_DOCK && xcb_request_failed(map_cookie, "Could not map window"))))) {
1630                 exit(EXIT_FAILURE);
1631             }
1632         }
1633     }
1634 }
1635
1636 /*
1637  * Render the bars, with buttons and statusline
1638  *
1639  */
1640 void draw_bars(bool unhide) {
1641     DLOG("Drawing Bars...\n");
1642     int i = 0;
1643
1644     refresh_statusline();
1645
1646     i3_output *outputs_walk;
1647     SLIST_FOREACH(outputs_walk, outputs, slist) {
1648         if (!outputs_walk->active) {
1649             DLOG("Output %s inactive, skipping...\n", outputs_walk->name);
1650             continue;
1651         }
1652         if (outputs_walk->bar == XCB_NONE) {
1653             /* Oh shit, an active output without an own bar. Create it now! */
1654             reconfig_windows(false);
1655         }
1656         /* First things first: clear the backbuffer */
1657         uint32_t color = colors.bar_bg;
1658         xcb_change_gc(xcb_connection,
1659                       outputs_walk->bargc,
1660                       XCB_GC_FOREGROUND,
1661                       &color);
1662         xcb_rectangle_t rect = { 0, 0, outputs_walk->rect.w, bar_height };
1663         xcb_poly_fill_rectangle(xcb_connection,
1664                                 outputs_walk->buffer,
1665                                 outputs_walk->bargc,
1666                                 1,
1667                                 &rect);
1668
1669         if (!TAILQ_EMPTY(&statusline_head)) {
1670             DLOG("Printing statusline!\n");
1671
1672             /* Luckily we already prepared a seperate pixmap containing the rendered
1673              * statusline, we just have to copy the relevant parts to the relevant
1674              * position */
1675             trayclient *trayclient;
1676             int traypx = 0;
1677             TAILQ_FOREACH(trayclient, outputs_walk->trayclients, tailq) {
1678                 if (!trayclient->mapped)
1679                     continue;
1680                 /* We assume the tray icons are quadratic (we use the font
1681                  * *height* as *width* of the icons) because we configured them
1682                  * like this. */
1683                 traypx += font.height + 2;
1684             }
1685             /* Add 2px of padding if there are any tray icons */
1686             if (traypx > 0)
1687                 traypx += 2;
1688             xcb_copy_area(xcb_connection,
1689                           statusline_pm,
1690                           outputs_walk->buffer,
1691                           outputs_walk->bargc,
1692                           MAX(0, (int16_t)(statusline_width - outputs_walk->rect.w + 4)), 0,
1693                           MAX(0, (int16_t)(outputs_walk->rect.w - statusline_width - traypx - 4)), 3,
1694                           MIN(outputs_walk->rect.w - traypx - 4, statusline_width), font.height + 2);
1695         }
1696
1697         if (!config.disable_ws) {
1698             i3_ws *ws_walk;
1699             TAILQ_FOREACH(ws_walk, outputs_walk->workspaces, tailq) {
1700                 DLOG("Drawing Button for WS %s at x = %d, len = %d\n",
1701                      i3string_as_utf8(ws_walk->name), i, ws_walk->name_width);
1702                 uint32_t fg_color = colors.inactive_ws_fg;
1703                 uint32_t bg_color = colors.inactive_ws_bg;
1704                 uint32_t border_color = colors.inactive_ws_border;
1705                 if (ws_walk->visible) {
1706                     if (!ws_walk->focused) {
1707                         fg_color = colors.active_ws_fg;
1708                         bg_color = colors.active_ws_bg;
1709                         border_color = colors.active_ws_border;
1710                     } else {
1711                         fg_color = colors.focus_ws_fg;
1712                         bg_color = colors.focus_ws_bg;
1713                         border_color = colors.focus_ws_border;
1714                     }
1715                 }
1716                 if (ws_walk->urgent) {
1717                     DLOG("WS %s is urgent!\n", i3string_as_utf8(ws_walk->name));
1718                     fg_color = colors.urgent_ws_fg;
1719                     bg_color = colors.urgent_ws_bg;
1720                     border_color = colors.urgent_ws_border;
1721                     unhide = true;
1722                 }
1723                 uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND;
1724                 uint32_t vals_border[] = { border_color, border_color };
1725                 xcb_change_gc(xcb_connection,
1726                               outputs_walk->bargc,
1727                               mask,
1728                               vals_border);
1729                 xcb_rectangle_t rect_border = { i, 1, ws_walk->name_width + 10, font.height + 4 };
1730                 xcb_poly_fill_rectangle(xcb_connection,
1731                                         outputs_walk->buffer,
1732                                         outputs_walk->bargc,
1733                                         1,
1734                                         &rect_border);
1735                 uint32_t vals[] = { bg_color, bg_color };
1736                 xcb_change_gc(xcb_connection,
1737                               outputs_walk->bargc,
1738                               mask,
1739                               vals);
1740                 xcb_rectangle_t rect = { i + 1, 2, ws_walk->name_width + 8, font.height + 2 };
1741                 xcb_poly_fill_rectangle(xcb_connection,
1742                                         outputs_walk->buffer,
1743                                         outputs_walk->bargc,
1744                                         1,
1745                                         &rect);
1746                 set_font_colors(outputs_walk->bargc, fg_color, bg_color);
1747                 draw_text(ws_walk->name, outputs_walk->buffer, outputs_walk->bargc,
1748                           i + 5, 3, ws_walk->name_width);
1749                 i += 10 + ws_walk->name_width + 1;
1750
1751             }
1752         }
1753
1754         if (binding.name && !config.disable_binding_mode_indicator) {
1755             uint32_t fg_color = colors.urgent_ws_fg;
1756             uint32_t bg_color = colors.urgent_ws_bg;
1757             uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND;
1758
1759             uint32_t vals_border[] = { colors.urgent_ws_border, colors.urgent_ws_border };
1760             xcb_change_gc(xcb_connection,
1761                           outputs_walk->bargc,
1762                           mask,
1763                           vals_border);
1764             xcb_rectangle_t rect_border = { i, 1, binding.width + 10, font.height + 4 };
1765             xcb_poly_fill_rectangle(xcb_connection,
1766                                     outputs_walk->buffer,
1767                                     outputs_walk->bargc,
1768                                     1,
1769                                     &rect_border);
1770
1771             uint32_t vals[] = { bg_color, bg_color };
1772             xcb_change_gc(xcb_connection,
1773                           outputs_walk->bargc,
1774                           mask,
1775                           vals);
1776             xcb_rectangle_t rect = { i + 1, 2, binding.width + 8, font.height + 2 };
1777             xcb_poly_fill_rectangle(xcb_connection,
1778                                     outputs_walk->buffer,
1779                                     outputs_walk->bargc,
1780                                     1,
1781                                     &rect);
1782
1783             set_font_colors(outputs_walk->bargc, fg_color, bg_color);
1784             draw_text(binding.name, outputs_walk->buffer, outputs_walk->bargc, i + 5, 3, binding.width);
1785
1786             unhide = true;
1787         }
1788
1789         i = 0;
1790     }
1791
1792     /* Assure the bar is hidden/unhidden according to the specified hidden_state and mode */
1793     if (mod_pressed ||
1794             config.hidden_state == S_SHOW ||
1795             unhide) {
1796         unhide_bars();
1797     } else if (config.hide_on_modifier == M_HIDE) {
1798         hide_bars();
1799     }
1800
1801     redraw_bars();
1802 }
1803
1804 /*
1805  * Redraw the bars, i.e. simply copy the buffer to the barwindow
1806  *
1807  */
1808 void redraw_bars(void) {
1809     i3_output *outputs_walk;
1810     SLIST_FOREACH(outputs_walk, outputs, slist) {
1811         if (!outputs_walk->active) {
1812             continue;
1813         }
1814         xcb_copy_area(xcb_connection,
1815                       outputs_walk->buffer,
1816                       outputs_walk->bar,
1817                       outputs_walk->bargc,
1818                       0, 0,
1819                       0, 0,
1820                       outputs_walk->rect.w,
1821                       outputs_walk->rect.h);
1822         xcb_flush(xcb_connection);
1823     }
1824 }
1825
1826 /*
1827  * Set the current binding mode
1828  *
1829  */
1830 void set_current_mode(struct mode *current) {
1831     I3STRING_FREE(binding.name);
1832     binding = *current;
1833     activated_mode = binding.name != NULL;
1834     return;
1835 }