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 #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 #include "log.h"
  25
  26 TAILQ_HEAD(cached_fonts_head, Font) cached_fonts = TAILQ_HEAD_INITIALIZER(cached_fonts);
  27 unsigned int xcb_numlock_mask;
  28
  29 /*
  30  * Loads a font for usage, getting its height. This function is used very often, so it
  31  * maintains a cache.
  32  *
  33  */
  34 i3Font *load_font(xcb_connection_t *conn, const char *pattern) {
  35         /* Check if we got the font cached */
  36         i3Font *font;
  37         TAILQ_FOREACH(font, &cached_fonts, fonts)
  38                 if (strcmp(font->pattern, pattern) == 0)
  39                         return font;
  40
  41         i3Font *new = smalloc(sizeof(i3Font));
  42         xcb_void_cookie_t font_cookie;
  43         xcb_list_fonts_with_info_cookie_t info_cookie;
  44
  45         /* Send all our requests first */
  46         new->id = xcb_generate_id(conn);
  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_error(conn, font_cookie, "Could not open font");
  51
  52         /* Get information (height/name) for this font */
  53         xcb_list_fonts_with_info_reply_t *reply = xcb_list_fonts_with_info_reply(conn, info_cookie, NULL);
  54         exit_if_null(reply, "Could not load font \"%s\"\n", pattern);
  55
  56         if (asprintf(&(new->name), "%.*s", xcb_list_fonts_with_info_name_length(reply),
  57                                            xcb_list_fonts_with_info_name(reply)) == -1)
  58                 die("asprintf() failed\n");
  59         new->pattern = sstrdup(pattern);
  60         new->height = reply->font_ascent + reply->font_descent;
  61
  62         /* Insert into cache */
  63         TAILQ_INSERT_TAIL(&cached_fonts, new, fonts);
  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(xcb_connection_t *conn, 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, int cursor,
  94                            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         i3Font *cursor_font = load_font(conn, "cursor");
 114         xcb_create_glyph_cursor(conn, cursor_id, cursor_font->id, cursor_font->id,
 115                         (cursor == -1 ? XCB_CURSOR_LEFT_PTR : cursor),
 116                         (cursor == -1 ? XCB_CURSOR_LEFT_PTR : cursor) + 1,
 117                         0, 0, 0, 65535, 65535, 65535);
 118         xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
 119         xcb_free_cursor(conn, cursor_id);
 120
 121         /* Map the window (= make it visible) */
 122         if (map)
 123                 xcb_map_window(conn, result);
 124
 125         return result;
 126 }
 127
 128 /*
 129  * Changes a single value in the graphic context (so one doesn’t have to define an array of values)
 130  *
 131  */
 132 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc, uint32_t mask, uint32_t value) {
 133         xcb_change_gc(conn, gc, mask, &value);
 134 }
 135
 136 /*
 137  * Draws a line from x,y to to_x,to_y using the given color
 138  *
 139  */
 140 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
 141                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
 142         xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
 143         xcb_point_t points[] = {{x, y}, {to_x, to_y}};
 144         xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2, points);
 145 }
 146
 147 /*
 148  * Draws a rectangle from x,y with width,height using the given color
 149  *
 150  */
 151 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
 152                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
 153         xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
 154         xcb_rectangle_t rect = {x, y, width, height};
 155         xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
 156 }
 157
 158 /*
 159  * Generates a configure_notify event and sends it to the given window
 160  * Applications need this to think they’ve configured themselves correctly.
 161  * The truth is, however, that we will manage them.
 162  *
 163  */
 164 void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window) {
 165         xcb_configure_notify_event_t generated_event;
 166
 167         generated_event.event = window;
 168         generated_event.window = window;
 169         generated_event.response_type = XCB_CONFIGURE_NOTIFY;
 170
 171         generated_event.x = r.x;
 172         generated_event.y = r.y;
 173         generated_event.width = r.width;
 174         generated_event.height = r.height;
 175
 176         generated_event.border_width = 0;
 177         generated_event.above_sibling = XCB_NONE;
 178         generated_event.override_redirect = false;
 179
 180         xcb_send_event(conn, false, window, XCB_EVENT_MASK_STRUCTURE_NOTIFY, (char*)&generated_event);
 181         xcb_flush(conn);
 182 }
 183
 184 /*
 185  * Generates a configure_notify_event with absolute coordinates (relative to the X root
 186  * window, not to the client’s frame) for the given client.
 187  *
 188  */
 189 void fake_absolute_configure_notify(xcb_connection_t *conn, Client *client) {
 190         Rect absolute;
 191
 192         absolute.x = client->rect.x + client->child_rect.x;
 193         absolute.y = client->rect.y + client->child_rect.y;
 194         absolute.width = client->child_rect.width;
 195         absolute.height = client->child_rect.height;
 196
 197         fake_configure_notify(conn, absolute, client->child);
 198 }
 199
 200 /*
 201  * Finds out which modifier mask is the one for numlock, as the user may change this.
 202  *
 203  */
 204 void xcb_get_numlock_mask(xcb_connection_t *conn) {
 205         xcb_key_symbols_t *keysyms;
 206         xcb_get_modifier_mapping_cookie_t cookie;
 207         xcb_get_modifier_mapping_reply_t *reply;
 208         xcb_keycode_t *modmap;
 209         int mask, i;
 210         const int masks[8] = { XCB_MOD_MASK_SHIFT,
 211                                XCB_MOD_MASK_LOCK,
 212                                XCB_MOD_MASK_CONTROL,
 213                                XCB_MOD_MASK_1,
 214                                XCB_MOD_MASK_2,
 215                                XCB_MOD_MASK_3,
 216                                XCB_MOD_MASK_4,
 217                                XCB_MOD_MASK_5 };
 218
 219         /* Request the modifier map */
 220         cookie = xcb_get_modifier_mapping_unchecked(conn);
 221
 222         /* Get the keysymbols */
 223         keysyms = xcb_key_symbols_alloc(conn);
 224
 225         if ((reply = xcb_get_modifier_mapping_reply(conn, cookie, NULL)) == NULL) {
 226                 xcb_key_symbols_free(keysyms);
 227                 return;
 228         }
 229
 230         modmap = xcb_get_modifier_mapping_keycodes(reply);
 231
 232         /* Get the keycode for numlock */
 233 #ifdef OLD_XCB_KEYSYMS_API
 234         xcb_keycode_t numlock = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
 235 #else
 236         /* For now, we only use the first keysymbol. */
 237         xcb_keycode_t *numlock_syms = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
 238         if (numlock_syms == NULL)
 239                 return;
 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         DLOG("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                 DLOG("Creating new pixmap...\n");
 281                 pixmap->id = xcb_generate_id(conn);
 282                 pixmap->gc = xcb_generate_id(conn);
 283         } else {
 284                 DLOG("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  * Query the width of the given text (16-bit characters, UCS) with given real
 297  * length (amount of glyphs) using the given font.
 298  *
 299  */
 300 int predict_text_width(xcb_connection_t *conn, const char *font_pattern, char *text, int length) {
 301         i3Font *font = load_font(conn, font_pattern);
 302
 303         xcb_query_text_extents_cookie_t cookie;
 304         xcb_query_text_extents_reply_t *reply;
 305         xcb_generic_error_t *error;
 306         int width;
 307
 308         cookie = xcb_query_text_extents(conn, font->id, length, (xcb_char2b_t*)text);
 309         if ((reply = xcb_query_text_extents_reply(conn, cookie, &error)) == NULL) {
 310                 ELOG("Could not get text extents (X error code %d)\n",
 311                      error->error_code);
 312                 /* We return the rather safe guess of 7 pixels, because a
 313                  * rendering error is better than a crash. Plus, the user will
 314                  * see the error in his log. */
 315                 return 7;
 316         }
 317
 318         width = reply->overall_width;
 319         free(reply);
 320         return width;
 321 }
 322
 323 /*
 324  * Configures the given window to have the size/position specified by given rect
 325  *
 326  */
 327 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
 328         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 }