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

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * © 2009-2010 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  * xcb.c: Helper functions for easier usage of XCB
  11  *
  12  */
  13
  14 #include "all.h"
  15
  16 TAILQ_HEAD(cached_fonts_head, Font) cached_fonts = TAILQ_HEAD_INITIALIZER(cached_fonts);
  17 unsigned int xcb_numlock_mask;
  18
  19 /*
  20  * Loads a font for usage, also getting its height. If fallback is true,
  21  * i3 loads 'fixed' or '-misc-*' if the font cannot be found instead of
  22  * exiting.
  23  *
  24  */
  25 i3Font load_font(const char *pattern, bool fallback) {
  26     i3Font new;
  27     xcb_void_cookie_t font_cookie;
  28     xcb_list_fonts_with_info_cookie_t info_cookie;
  29
  30     /* Send all our requests first */
  31     new.id = xcb_generate_id(conn);
  32     font_cookie = xcb_open_font_checked(conn, new.id, strlen(pattern), pattern);
  33     info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
  34
  35     /* Check for errors. If errors, fall back to default font. */
  36     xcb_generic_error_t *error = xcb_request_check(conn, font_cookie);
  37
  38     /* If we fail to open font, fall back to 'fixed'. If opening 'fixed' fails fall back to '-misc-*' */
  39     if (error != NULL) {
  40         ELOG("Could not open font %s (X error %d). Reverting to backup font.\n", pattern, error->error_code);
  41         pattern = "fixed";
  42         font_cookie = xcb_open_font_checked(conn, new.id, strlen(pattern), pattern);
  43         info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
  44
  45         /* Check if we managed to open 'fixed' */
  46         xcb_generic_error_t *error = xcb_request_check(conn, font_cookie);
  47
  48         /* Fall back to '-misc-*' if opening 'fixed' fails. */
  49         if (error != NULL) {
  50             ELOG("Could not open fallback font '%s', trying with '-misc-*'\n",pattern);
  51             pattern = "-misc-*";
  52             font_cookie = xcb_open_font_checked(conn, new.id, strlen(pattern), pattern);
  53             info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
  54
  55             check_error(conn, font_cookie, "Could open neither requested font nor fallback (fixed or -misc-*");
  56         }
  57     }
  58
  59     /* Get information (height/name) for this font */
  60     xcb_list_fonts_with_info_reply_t *reply = xcb_list_fonts_with_info_reply(conn, info_cookie, NULL);
  61     exit_if_null(reply, "Could not load font \"%s\"\n", pattern);
  62
  63     new.height = reply->font_ascent + reply->font_descent;
  64
  65     free(reply);
  66
  67     return new;
  68 }
  69
  70 /*
  71  * Returns the colorpixel to use for the given hex color (think of HTML).
  72  *
  73  * The hex_color has to start with #, for example #FF00FF.
  74  *
  75  * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
  76  * This has to be done by the caller.
  77  *
  78  */
  79 uint32_t get_colorpixel(char *hex) {
  80     char strgroups[3][3] = {{hex[1], hex[2], '\0'},
  81                             {hex[3], hex[4], '\0'},
  82                             {hex[5], hex[6], '\0'}};
  83     uint32_t rgb16[3] = {(strtol(strgroups[0], NULL, 16)),
  84                          (strtol(strgroups[1], NULL, 16)),
  85                          (strtol(strgroups[2], NULL, 16))};
  86
  87     return (rgb16[0] << 16) + (rgb16[1] << 8) + rgb16[2];
  88 }
  89
  90 /*
  91  * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
  92  * for errors.
  93  *
  94  */
  95 xcb_window_t create_window(xcb_connection_t *conn, Rect dims, uint16_t window_class,
  96         enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values) {
  97     xcb_window_t result = xcb_generate_id(conn);
  98
  99     /* If the window class is XCB_WINDOW_CLASS_INPUT_ONLY, depth has to be 0 */
 100     uint16_t depth = (window_class == XCB_WINDOW_CLASS_INPUT_ONLY ? 0 : XCB_COPY_FROM_PARENT);
 101
 102     xcb_create_window(conn,
 103             depth,
 104             result, /* the window id */
 105             root, /* parent == root */
 106             dims.x, dims.y, dims.width, dims.height, /* dimensions */
 107             0, /* border = 0, we draw our own */
 108             window_class,
 109             XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
 110             mask,
 111             values);
 112
 113     /* Set the cursor */
 114     if (xcursor_supported) {
 115         mask = XCB_CW_CURSOR;
 116         values[0] = xcursor_get_cursor(cursor);
 117         xcb_change_window_attributes(conn, result, mask, values);
 118     } else {
 119         xcb_cursor_t cursor_id = xcb_generate_id(conn);
 120         i3Font cursor_font = load_font("cursor", false);
 121         int xcb_cursor = xcursor_get_xcb_cursor(cursor);
 122         xcb_create_glyph_cursor(conn, cursor_id, cursor_font.id, cursor_font.id,
 123                 xcb_cursor, xcb_cursor + 1, 0, 0, 0, 65535, 65535, 65535);
 124         xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
 125         xcb_free_cursor(conn, cursor_id);
 126     }
 127
 128     /* Map the window (= make it visible) */
 129     if (map)
 130         xcb_map_window(conn, result);
 131
 132     return result;
 133 }
 134
 135 /*
 136  * Changes a single value in the graphic context (so one doesn’t have to define an array of values)
 137  *
 138  */
 139 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc, uint32_t mask, uint32_t value) {
 140     xcb_change_gc(conn, gc, mask, &value);
 141 }
 142
 143 /*
 144  * Draws a line from x,y to to_x,to_y using the given color
 145  *
 146  */
 147 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
 148                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
 149     xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
 150     xcb_point_t points[] = {{x, y}, {to_x, to_y}};
 151     xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2, points);
 152 }
 153
 154 /*
 155  * Draws a rectangle from x,y with width,height using the given color
 156  *
 157  */
 158 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
 159                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
 160     xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
 161     xcb_rectangle_t rect = {x, y, width, height};
 162     xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
 163 }
 164
 165 /*
 166  * Generates a configure_notify event and sends it to the given window
 167  * Applications need this to think they’ve configured themselves correctly.
 168  * The truth is, however, that we will manage them.
 169  *
 170  */
 171 void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window) {
 172     /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
 173      * In order to properly initialize these bytes, we allocate 32 bytes even
 174      * though we only need less for an xcb_configure_notify_event_t */
 175     void *event = scalloc(32);
 176     xcb_configure_notify_event_t *generated_event = event;
 177
 178     generated_event->event = window;
 179     generated_event->window = window;
 180     generated_event->response_type = XCB_CONFIGURE_NOTIFY;
 181
 182     generated_event->x = r.x;
 183     generated_event->y = r.y;
 184     generated_event->width = r.width;
 185     generated_event->height = r.height;
 186
 187     generated_event->border_width = 0;
 188     generated_event->above_sibling = XCB_NONE;
 189     generated_event->override_redirect = false;
 190
 191     xcb_send_event(conn, false, window, XCB_EVENT_MASK_STRUCTURE_NOTIFY, (char*)generated_event);
 192     xcb_flush(conn);
 193
 194     free(event);
 195 }
 196
 197 /*
 198  * Generates a configure_notify_event with absolute coordinates (relative to the X root
 199  * window, not to the client’s frame) for the given client.
 200  *
 201  */
 202 void fake_absolute_configure_notify(Con *con) {
 203     Rect absolute;
 204     if (con->window == NULL)
 205         return;
 206
 207     absolute.x = con->rect.x + con->window_rect.x;
 208     absolute.y = con->rect.y + con->window_rect.y;
 209     absolute.width = con->window_rect.width;
 210     absolute.height = con->window_rect.height;
 211
 212     DLOG("fake rect = (%d, %d, %d, %d)\n", absolute.x, absolute.y, absolute.width, absolute.height);
 213
 214     fake_configure_notify(conn, absolute, con->window->id);
 215 }
 216
 217 /*
 218  * Sends the WM_TAKE_FOCUS ClientMessage to the given window
 219  *
 220  */
 221 void send_take_focus(xcb_window_t window) {
 222     /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
 223      * In order to properly initialize these bytes, we allocate 32 bytes even
 224      * though we only need less for an xcb_configure_notify_event_t */
 225     void *event = scalloc(32);
 226     xcb_client_message_event_t *ev = event;
 227
 228     ev->response_type = XCB_CLIENT_MESSAGE;
 229     ev->window = window;
 230     ev->type = A_WM_PROTOCOLS;
 231     ev->format = 32;
 232     ev->data.data32[0] = A_WM_TAKE_FOCUS;
 233     ev->data.data32[1] = XCB_CURRENT_TIME;
 234
 235     DLOG("Sending WM_TAKE_FOCUS to the client\n");
 236     xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char*)ev);
 237     free(event);
 238 }
 239
 240 /*
 241  * Finds out which modifier mask is the one for numlock, as the user may change this.
 242  *
 243  */
 244 void xcb_get_numlock_mask(xcb_connection_t *conn) {
 245     xcb_key_symbols_t *keysyms;
 246     xcb_get_modifier_mapping_cookie_t cookie;
 247     xcb_get_modifier_mapping_reply_t *reply;
 248     xcb_keycode_t *modmap;
 249     int mask, i;
 250     const int masks[8] = { XCB_MOD_MASK_SHIFT,
 251                            XCB_MOD_MASK_LOCK,
 252                            XCB_MOD_MASK_CONTROL,
 253                            XCB_MOD_MASK_1,
 254                            XCB_MOD_MASK_2,
 255                            XCB_MOD_MASK_3,
 256                            XCB_MOD_MASK_4,
 257                            XCB_MOD_MASK_5 };
 258
 259     /* Request the modifier map */
 260     cookie = xcb_get_modifier_mapping(conn);
 261
 262     /* Get the keysymbols */
 263     keysyms = xcb_key_symbols_alloc(conn);
 264
 265     if ((reply = xcb_get_modifier_mapping_reply(conn, cookie, NULL)) == NULL) {
 266         xcb_key_symbols_free(keysyms);
 267         return;
 268     }
 269
 270     modmap = xcb_get_modifier_mapping_keycodes(reply);
 271
 272     /* Get the keycode for numlock */
 273 #ifdef OLD_XCB_KEYSYMS_API
 274     xcb_keycode_t numlock = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
 275 #else
 276     /* For now, we only use the first keysymbol. */
 277     xcb_keycode_t *numlock_syms = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
 278     if (numlock_syms == NULL)
 279         return;
 280     xcb_keycode_t numlock = *numlock_syms;
 281     free(numlock_syms);
 282 #endif
 283
 284     /* Check all modifiers (Mod1-Mod5, Shift, Control, Lock) */
 285     for (mask = 0; mask < 8; mask++)
 286         for (i = 0; i < reply->keycodes_per_modifier; i++)
 287             if (modmap[(mask * reply->keycodes_per_modifier) + i] == numlock)
 288                 xcb_numlock_mask = masks[mask];
 289
 290     xcb_key_symbols_free(keysyms);
 291     free(reply);
 292 }
 293
 294 /*
 295  * Raises the given window (typically client->frame) above all other windows
 296  *
 297  */
 298 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window) {
 299     uint32_t values[] = { XCB_STACK_MODE_ABOVE };
 300     xcb_configure_window(conn, window, XCB_CONFIG_WINDOW_STACK_MODE, values);
 301 }
 302
 303 /*
 304  * Query the width of the given text (16-bit characters, UCS) with given real
 305  * length (amount of glyphs) using the given font.
 306  *
 307  */
 308 int predict_text_width(char *text, int length) {
 309     xcb_query_text_extents_cookie_t cookie;
 310     xcb_query_text_extents_reply_t *reply;
 311     xcb_generic_error_t *error;
 312     int width;
 313
 314     cookie = xcb_query_text_extents(conn, config.font.id, length, (xcb_char2b_t*)text);
 315     if ((reply = xcb_query_text_extents_reply(conn, cookie, &error)) == NULL) {
 316         ELOG("Could not get text extents (X error code %d)\n",
 317              error->error_code);
 318         /* We return the rather safe guess of 7 pixels, because a
 319          * rendering error is better than a crash. Plus, the user will
 320          * see the error in his log. */
 321         return 7;
 322     }
 323
 324     width = reply->overall_width;
 325     free(reply);
 326     return width;
 327 }
 328
 329 /*
 330  * Configures the given window to have the size/position specified by given rect
 331  *
 332  */
 333 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
 334     xcb_void_cookie_t cookie;
 335     cookie = xcb_configure_window(conn, window,
 336                          XCB_CONFIG_WINDOW_X |
 337                          XCB_CONFIG_WINDOW_Y |
 338                          XCB_CONFIG_WINDOW_WIDTH |
 339                          XCB_CONFIG_WINDOW_HEIGHT,
 340                          &(r.x));
 341     /* ignore events which are generated because we configured a window */
 342     add_ignore_event(cookie.sequence, -1);
 343 }
 344
 345 /*
 346  * Returns true if the given reply contains the given atom.
 347  *
 348  */
 349 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
 350     if (prop == NULL || xcb_get_property_value_length(prop) == 0)
 351         return false;
 352
 353     xcb_atom_t *atoms;
 354     if ((atoms = xcb_get_property_value(prop)) == NULL)
 355         return false;
 356
 357     for (int i = 0; i < xcb_get_property_value_length(prop) / (prop->format / 8); i++)
 358         if (atoms[i] == atom)
 359             return true;
 360
 361     return false;
 362
 363 }