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