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

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