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