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 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 #include <stdint.h>
  14 #include <stdio.h>
  15 #include <stdlib.h>
  16 #include <string.h>
  17
  18 #include <xcb/xcb.h>
  19 #include <xcb/xcb_keysyms.h>
  20
  21 #include "i3.h"
  22 #include "util.h"
  23 #include "xcb.h"
  24
  25 TAILQ_HEAD(cached_fonts_head, Font) cached_fonts = TAILQ_HEAD_INITIALIZER(cached_fonts);
  26 unsigned int xcb_numlock_mask;
  27
  28 /*
  29  * Loads a font for usage, getting its height. This function is used very often, so it
  30  * maintains a cache.
  31  *
  32  */
  33 i3Font *load_font(xcb_connection_t *conn, const char *pattern) {
  34         /* Check if we got the font cached */
  35         i3Font *font;
  36         TAILQ_FOREACH(font, &cached_fonts, fonts)
  37                 if (strcmp(font->pattern, pattern) == 0)
  38                         return font;
  39
  40         i3Font *new = smalloc(sizeof(i3Font));
  41         xcb_void_cookie_t font_cookie;
  42         xcb_list_fonts_with_info_cookie_t info_cookie;
  43
  44         /* Send all our requests first */
  45         new->id = xcb_generate_id(conn);
  46         font_cookie = xcb_open_font_checked(conn, new->id, strlen(pattern), pattern);
  47         info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
  48
  49         check_error(conn, font_cookie, "Could not open font");
  50
  51         /* Get information (height/name) for this font */
  52         xcb_list_fonts_with_info_reply_t *reply = xcb_list_fonts_with_info_reply(conn, info_cookie, NULL);
  53         exit_if_null(reply, "Could not load font \"%s\"\n", pattern);
  54
  55         if (asprintf(&(new->name), "%.*s", xcb_list_fonts_with_info_name_length(reply),
  56                                            xcb_list_fonts_with_info_name(reply)) == -1)
  57                 die("asprintf() failed\n");
  58         new->pattern = sstrdup(pattern);
  59         new->height = reply->font_ascent + reply->font_descent;
  60
  61         /* Insert into cache */
  62         TAILQ_INSERT_TAIL(&cached_fonts, new, fonts);
  63
  64         return new;
  65 }
  66
  67 /*
  68  * Returns the colorpixel to use for the given hex color (think of HTML).
  69  *
  70  * The hex_color has to start with #, for example #FF00FF.
  71  *
  72  * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
  73  * This has to be done by the caller.
  74  *
  75  */
  76 uint32_t get_colorpixel(xcb_connection_t *conn, char *hex) {
  77         char strgroups[3][3] = {{hex[1], hex[2], '\0'},
  78                                 {hex[3], hex[4], '\0'},
  79                                 {hex[5], hex[6], '\0'}};
  80         uint32_t rgb16[3] = {(strtol(strgroups[0], NULL, 16)),
  81                              (strtol(strgroups[1], NULL, 16)),
  82                              (strtol(strgroups[2], NULL, 16))};
  83
  84         return (rgb16[0] << 16) + (rgb16[1] << 8) + rgb16[2];
  85 }
  86
  87 /*
  88  * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
  89  * for errors.
  90  *
  91  */
  92 xcb_window_t create_window(xcb_connection_t *conn, Rect dims, uint16_t window_class, int cursor,
  93                            bool map, uint32_t mask, uint32_t *values) {
  94         xcb_window_t root = xcb_setup_roots_iterator(xcb_get_setup(conn)).data->root;
  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         /* Use the default cursor (left pointer) */
 102         if (cursor > -1) {
 103                 i3Font *cursor_font = load_font(conn, "cursor");
 104                 xcb_create_glyph_cursor(conn, cursor_id, cursor_font->id, cursor_font->id,
 105                                 XCB_CURSOR_LEFT_PTR, XCB_CURSOR_LEFT_PTR + 1,
 106                                 0, 0, 0, 65535, 65535, 65535);
 107         }
 108
 109         xcb_create_window(conn,
 110                           depth,
 111                           result, /* the window id */
 112                           root, /* parent == root */
 113                           dims.x, dims.y, dims.width, dims.height, /* dimensions */
 114                           0, /* border = 0, we draw our own */
 115                           window_class,
 116                           XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
 117                           mask,
 118                           values);
 119
 120         if (cursor > -1)
 121                 xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
 122
 123         /* Map the window (= make it visible) */
 124         if (map)
 125                 xcb_map_window(conn, result);
 126
 127         return result;
 128 }
 129
 130 /*
 131  * Changes a single value in the graphic context (so one doesn’t have to define an array of values)
 132  *
 133  */
 134 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc, uint32_t mask, uint32_t value) {
 135         xcb_change_gc(conn, gc, mask, &value);
 136 }
 137
 138 /*
 139  * Draws a line from x,y to to_x,to_y using the given color
 140  *
 141  */
 142 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
 143                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
 144         xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
 145         xcb_point_t points[] = {{x, y}, {to_x, to_y}};
 146         xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2, points);
 147 }
 148
 149 /*
 150  * Draws a rectangle from x,y with width,height using the given color
 151  *
 152  */
 153 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
 154                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
 155         xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
 156         xcb_rectangle_t rect = {x, y, width, height};
 157         xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
 158 }
 159
 160 /*
 161  * Generates a configure_notify event and sends it to the given window
 162  * Applications need this to think they’ve configured themselves correctly.
 163  * The truth is, however, that we will manage them.
 164  *
 165  */
 166 void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window) {
 167         xcb_configure_notify_event_t generated_event;
 168
 169         generated_event.event = window;
 170         generated_event.window = window;
 171         generated_event.response_type = XCB_CONFIGURE_NOTIFY;
 172
 173         generated_event.x = r.x;
 174         generated_event.y = r.y;
 175         generated_event.width = r.width;
 176         generated_event.height = r.height;
 177
 178         generated_event.border_width = 0;
 179         generated_event.above_sibling = XCB_NONE;
 180         generated_event.override_redirect = false;
 181
 182         xcb_send_event(conn, false, window, XCB_EVENT_MASK_STRUCTURE_NOTIFY, (char*)&generated_event);
 183         xcb_flush(conn);
 184 }
 185
 186 /*
 187  * Generates a configure_notify_event with absolute coordinates (relative to the X root
 188  * window, not to the client’s frame) for the given client.
 189  *
 190  */
 191 void fake_absolute_configure_notify(xcb_connection_t *conn, Client *client) {
 192         Rect absolute;
 193
 194         absolute.x = client->rect.x + client->child_rect.x;
 195         absolute.y = client->rect.y + client->child_rect.y;
 196         absolute.width = client->rect.width - (2 * client->child_rect.x);
 197         absolute.height = client->rect.height - client->child_rect.y - 1;
 198
 199         fake_configure_notify(conn, absolute, client->child);
 200 }
 201
 202 /*
 203  * Finds out which modifier mask is the one for numlock, as the user may change this.
 204  *
 205  */
 206 void xcb_get_numlock_mask(xcb_connection_t *conn) {
 207         xcb_key_symbols_t *keysyms;
 208         xcb_get_modifier_mapping_cookie_t cookie;
 209         xcb_get_modifier_mapping_reply_t *reply;
 210         xcb_keycode_t *modmap;
 211         int mask, i;
 212         const int masks[8] = { XCB_MOD_MASK_SHIFT,
 213                                XCB_MOD_MASK_LOCK,
 214                                XCB_MOD_MASK_CONTROL,
 215                                XCB_MOD_MASK_1,
 216                                XCB_MOD_MASK_2,
 217                                XCB_MOD_MASK_3,
 218                                XCB_MOD_MASK_4,
 219                                XCB_MOD_MASK_5 };
 220
 221         /* Request the modifier map */
 222         cookie = xcb_get_modifier_mapping_unchecked(conn);
 223
 224         /* Get the keysymbols */
 225         keysyms = xcb_key_symbols_alloc(conn);
 226
 227         if ((reply = xcb_get_modifier_mapping_reply(conn, cookie, NULL)) == NULL) {
 228                 xcb_key_symbols_free(keysyms);
 229                 return;
 230         }
 231
 232         modmap = xcb_get_modifier_mapping_keycodes(reply);
 233
 234         /* Get the keycode for numlock */
 235 #ifdef OLD_XCB_KEYSYMS_API
 236         xcb_keycode_t numlock = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
 237 #else
 238         /* For now, we only use the first keysymbol. */
 239         xcb_keycode_t *numlock_syms = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
 240         xcb_keycode_t numlock = *numlock_syms;
 241         free(numlock_syms);
 242 #endif
 243
 244         /* Check all modifiers (Mod1-Mod5, Shift, Control, Lock) */
 245         for (mask = 0; mask < 8; mask++)
 246                 for (i = 0; i < reply->keycodes_per_modifier; i++)
 247                         if (modmap[(mask * reply->keycodes_per_modifier) + i] == numlock)
 248                                 xcb_numlock_mask = masks[mask];
 249
 250         xcb_key_symbols_free(keysyms);
 251         free(reply);
 252 }
 253
 254 /*
 255  * Raises the given window (typically client->frame) above all other windows
 256  *
 257  */
 258 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window) {
 259         uint32_t values[] = { XCB_STACK_MODE_ABOVE };
 260         xcb_configure_window(conn, window, XCB_CONFIG_WINDOW_STACK_MODE, values);
 261 }
 262
 263 /*
 264  *
 265  * Prepares the given Cached_Pixmap for usage (checks whether the size of the
 266  * object this pixmap is related to (e.g. a window) has changed and re-creates
 267  * the pixmap if so).
 268  *
 269  */
 270 void cached_pixmap_prepare(xcb_connection_t *conn, struct Cached_Pixmap *pixmap) {
 271         LOG("preparing pixmap\n");
 272
 273         /* If the Rect did not change, the pixmap does not need to be recreated */
 274         if (memcmp(&(pixmap->rect), pixmap->referred_rect, sizeof(Rect)) == 0)
 275                 return;
 276
 277         memcpy(&(pixmap->rect), pixmap->referred_rect, sizeof(Rect));
 278
 279         if (pixmap->id == 0 || pixmap->gc == 0) {
 280                 LOG("Creating new pixmap...\n");
 281                 pixmap->id = xcb_generate_id(conn);
 282                 pixmap->gc = xcb_generate_id(conn);
 283         } else {
 284                 LOG("Re-creating this pixmap...\n");
 285                 xcb_free_gc(conn, pixmap->gc);
 286                 xcb_free_pixmap(conn, pixmap->id);
 287         }
 288
 289         xcb_create_pixmap(conn, root_depth, pixmap->id,
 290                           pixmap->referred_drawable, pixmap->rect.width, pixmap->rect.height);
 291
 292         xcb_create_gc(conn, pixmap->gc, pixmap->id, 0, 0);
 293 }
 294
 295 /*
 296  * Returns the xcb_charinfo_t for the given character (specified by row and
 297  * column in the lookup table) if existing, otherwise the minimum bounds.
 298  *
 299  */
 300 static xcb_charinfo_t *get_charinfo(int col, int row, xcb_query_font_reply_t *font_info,
 301                                     xcb_charinfo_t *table, bool dont_fallback) {
 302         xcb_charinfo_t *result;
 303
 304         /* Bounds checking */
 305         if (row < font_info->min_byte1 || row > font_info->max_byte1 ||
 306             col < font_info->min_char_or_byte2 || col > font_info->max_char_or_byte2)
 307                 return NULL;
 308
 309         /* If we don’t have a table to lookup the infos per character, return the
 310          * minimum bounds */
 311         if (table == NULL)
 312                 return &font_info->min_bounds;
 313
 314         result = &table[((row - font_info->min_byte1) *
 315                          (font_info->max_char_or_byte2 - font_info->min_char_or_byte2 + 1)) +
 316                         (col - font_info->min_char_or_byte2)];
 317
 318         /* If the character has an entry in the table, return it */
 319         if (result->character_width != 0 ||
 320             (result->right_side_bearing |
 321              result->left_side_bearing |
 322              result->ascent |
 323              result->descent) != 0)
 324                 return result;
 325
 326         /* Otherwise, get the default character and return its charinfo */
 327         if (dont_fallback)
 328                 return NULL;
 329
 330         return get_charinfo((font_info->default_char >> 8),
 331                             (font_info->default_char & 0xFF),
 332                             font_info,
 333                             table,
 334                             true);
 335 }
 336
 337 /*
 338  * Calculate the width of the given text (16-bit characters, UCS) with given
 339  * real length (amount of glyphs) using the given font.
 340  *
 341  */
 342 int predict_text_width(xcb_connection_t *conn, const char *font_pattern, char *text, int length) {
 343         xcb_query_font_reply_t *font_info;
 344         xcb_charinfo_t *table;
 345         int i, width = 0;
 346         i3Font *font = load_font(conn, font_pattern);
 347
 348         font_info = xcb_query_font_reply(conn, xcb_query_font_unchecked(conn, font->id), NULL);
 349         table = xcb_query_font_char_infos(font_info);
 350
 351         for (i = 0; i < 2 * length; i += 2) {
 352                 xcb_charinfo_t *info = get_charinfo(text[i+1], text[i], font_info, table, false);
 353                 if (info == NULL)
 354                         continue;
 355                 width += info->character_width;
 356         }
 357
 358         free(font_info);
 359
 360         return width;
 361 }