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