git.sur5r.net Git - i3/i3/blob - libi3/font.c

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  */
   8 #include <assert.h>
   9 #include <stdint.h>
  10 #include <stdlib.h>
  11 #include <string.h>
  12 #include <stdbool.h>
  13 #include <err.h>
  14
  15 #if PANGO_SUPPORT
  16 #include <cairo/cairo-xcb.h>
  17 #include <pango/pangocairo.h>
  18 #endif
  19
  20 #include "libi3.h"
  21
  22 extern xcb_connection_t *conn;
  23 extern xcb_screen_t *root_screen;
  24
  25 static const i3Font *savedFont = NULL;
  26
  27 #if PANGO_SUPPORT
  28 static xcb_visualtype_t *root_visual_type;
  29 static double pango_font_red;
  30 static double pango_font_green;
  31 static double pango_font_blue;
  32
  33 /*
  34  * Loads a Pango font description into an i3Font structure. Returns true
  35  * on success, false otherwise.
  36  *
  37  */
  38 static bool load_pango_font(i3Font *font, const char *desc) {
  39     /* Load the font description */
  40     font->specific.pango_desc = pango_font_description_from_string(desc);
  41     if (!font->specific.pango_desc) {
  42         ELOG("Could not open font %s with Pango, fallback to X font.\n", desc);
  43         return false;
  44     }
  45
  46     LOG("Using Pango font %s, size %d\n",
  47         pango_font_description_get_family(font->specific.pango_desc),
  48         pango_font_description_get_size(font->specific.pango_desc) / PANGO_SCALE
  49         );
  50
  51     /* We cache root_visual_type here, since you must call
  52      * load_pango_font before any other pango function
  53      * that would need root_visual_type */
  54     root_visual_type = get_visualtype(root_screen);
  55
  56     /* Create a dummy Pango layout to compute the font height */
  57     cairo_surface_t *surface = cairo_xcb_surface_create(conn, root_screen->root, root_visual_type, 1, 1);
  58     cairo_t *cr = cairo_create(surface);
  59     PangoLayout *layout = pango_cairo_create_layout(cr);
  60     pango_layout_set_font_description(layout, font->specific.pango_desc);
  61
  62     /* Get the font height */
  63     gint height;
  64     pango_layout_get_pixel_size(layout, NULL, &height);
  65     font->height = height;
  66
  67     /* Free resources */
  68     g_object_unref(layout);
  69     cairo_destroy(cr);
  70     cairo_surface_destroy(surface);
  71
  72     /* Set the font type and return successfully */
  73     font->type = FONT_TYPE_PANGO;
  74     return true;
  75 }
  76
  77 /*
  78  * Draws text using Pango rendering.
  79  *
  80  */
  81 static void draw_text_pango(const char *text, size_t text_len,
  82         xcb_drawable_t drawable, int x, int y, int max_width) {
  83     /* Create the Pango layout */
  84     /* root_visual_type is cached in load_pango_font */
  85     cairo_surface_t *surface = cairo_xcb_surface_create(conn, drawable,
  86             root_visual_type, x + max_width, y + savedFont->height);
  87     cairo_t *cr = cairo_create(surface);
  88     PangoLayout *layout = pango_cairo_create_layout(cr);
  89     pango_layout_set_font_description(layout, savedFont->specific.pango_desc);
  90     pango_layout_set_width(layout, max_width * PANGO_SCALE);
  91     pango_layout_set_wrap(layout, PANGO_WRAP_CHAR);
  92     pango_layout_set_ellipsize(layout, PANGO_ELLIPSIZE_END);
  93
  94     /* Do the drawing */
  95     cairo_set_source_rgb(cr, pango_font_red, pango_font_green, pango_font_blue);
  96     cairo_move_to(cr, x, y);
  97     pango_layout_set_text(layout, text, text_len);
  98     pango_cairo_update_layout(cr, layout);
  99     pango_cairo_show_layout(cr, layout);
 100
 101     /* Free resources */
 102     g_object_unref(layout);
 103     cairo_destroy(cr);
 104     cairo_surface_destroy(surface);
 105 }
 106
 107 /*
 108  * Calculate the text width using Pango rendering.
 109  *
 110  */
 111 static int predict_text_width_pango(const char *text, size_t text_len) {
 112     /* Create a dummy Pango layout */
 113     /* root_visual_type is cached in load_pango_font */
 114     cairo_surface_t *surface = cairo_xcb_surface_create(conn, root_screen->root, root_visual_type, 1, 1);
 115     cairo_t *cr = cairo_create(surface);
 116     PangoLayout *layout = pango_cairo_create_layout(cr);
 117
 118     /* Get the font width */
 119     gint width;
 120     pango_layout_set_font_description(layout, savedFont->specific.pango_desc);
 121     pango_layout_set_text(layout, text, text_len);
 122     pango_cairo_update_layout(cr, layout);
 123     pango_layout_get_pixel_size(layout, &width, NULL);
 124
 125     /* Free resources */
 126     g_object_unref(layout);
 127     cairo_destroy(cr);
 128     cairo_surface_destroy(surface);
 129
 130     return width;
 131 }
 132 #endif
 133
 134 /*
 135  * Loads a font for usage, also getting its metrics. If fallback is true,
 136  * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting.
 137  *
 138  */
 139 i3Font load_font(const char *pattern, const bool fallback) {
 140     i3Font font;
 141     font.type = FONT_TYPE_NONE;
 142
 143 #if PANGO_SUPPORT
 144     /* Try to load a pango font if specified */
 145     if (strlen(pattern) > strlen("pango:") && !strncmp(pattern, "pango:", strlen("pango:"))) {
 146         pattern += strlen("pango:");
 147         if (load_pango_font(&font, pattern))
 148             return font;
 149     } else if (strlen(pattern) > strlen("xft:") && !strncmp(pattern, "xft:", strlen("xft:"))) {
 150         pattern += strlen("xft:");
 151         if (load_pango_font(&font, pattern))
 152             return font;
 153     }
 154 #endif
 155
 156     /* Send all our requests first */
 157     font.specific.xcb.id = xcb_generate_id(conn);
 158     xcb_void_cookie_t font_cookie = xcb_open_font_checked(conn, font.specific.xcb.id,
 159             strlen(pattern), pattern);
 160     xcb_query_font_cookie_t info_cookie = xcb_query_font(conn, font.specific.xcb.id);
 161
 162     /* Check for errors. If errors, fall back to default font. */
 163     xcb_generic_error_t *error;
 164     error = xcb_request_check(conn, font_cookie);
 165
 166     /* If we fail to open font, fall back to 'fixed' */
 167     if (fallback && error != NULL) {
 168         ELOG("Could not open font %s (X error %d). Trying fallback to 'fixed'.\n",
 169              pattern, error->error_code);
 170         pattern = "fixed";
 171         font_cookie = xcb_open_font_checked(conn, font.specific.xcb.id,
 172                 strlen(pattern), pattern);
 173         info_cookie = xcb_query_font(conn, font.specific.xcb.id);
 174
 175         /* Check if we managed to open 'fixed' */
 176         error = xcb_request_check(conn, font_cookie);
 177
 178         /* Fall back to '-misc-*' if opening 'fixed' fails. */
 179         if (error != NULL) {
 180             ELOG("Could not open fallback font 'fixed', trying with '-misc-*'.\n");
 181             pattern = "-misc-*";
 182             font_cookie = xcb_open_font_checked(conn, font.specific.xcb.id,
 183                     strlen(pattern), pattern);
 184             info_cookie = xcb_query_font(conn, font.specific.xcb.id);
 185
 186             if ((error = xcb_request_check(conn, font_cookie)) != NULL)
 187                 errx(EXIT_FAILURE, "Could open neither requested font nor fallbacks "
 188                      "(fixed or -misc-*): X11 error %d", error->error_code);
 189         }
 190     }
 191
 192     LOG("Using X font %s\n", pattern);
 193
 194     /* Get information (height/name) for this font */
 195     if (!(font.specific.xcb.info = xcb_query_font_reply(conn, info_cookie, NULL)))
 196         errx(EXIT_FAILURE, "Could not load font \"%s\"", pattern);
 197
 198     /* Get the font table, if possible */
 199     if (xcb_query_font_char_infos_length(font.specific.xcb.info) == 0)
 200         font.specific.xcb.table = NULL;
 201     else
 202         font.specific.xcb.table = xcb_query_font_char_infos(font.specific.xcb.info);
 203
 204     /* Calculate the font height */
 205     font.height = font.specific.xcb.info->font_ascent + font.specific.xcb.info->font_descent;
 206
 207     /* Set the font type and return successfully */
 208     font.type = FONT_TYPE_XCB;
 209     return font;
 210 }
 211
 212 /*
 213  * Defines the font to be used for the forthcoming calls.
 214  *
 215  */
 216 void set_font(i3Font *font) {
 217     savedFont = font;
 218 }
 219
 220 /*
 221  * Frees the resources taken by the current font.
 222  *
 223  */
 224 void free_font(void) {
 225     switch (savedFont->type) {
 226         case FONT_TYPE_NONE:
 227             /* Nothing to do */
 228             break;
 229         case FONT_TYPE_XCB: {
 230             /* Close the font and free the info */
 231             xcb_close_font(conn, savedFont->specific.xcb.id);
 232             if (savedFont->specific.xcb.info)
 233                 free(savedFont->specific.xcb.info);
 234             break;
 235         }
 236 #if PANGO_SUPPORT
 237         case FONT_TYPE_PANGO:
 238             /* Free the font description */
 239             pango_font_description_free(savedFont->specific.pango_desc);
 240             break;
 241 #endif
 242         default:
 243             assert(false);
 244             break;
 245     }
 246 }
 247
 248 /*
 249  * Defines the colors to be used for the forthcoming draw_text calls.
 250  *
 251  */
 252 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background) {
 253     assert(savedFont != NULL);
 254
 255     switch (savedFont->type) {
 256         case FONT_TYPE_NONE:
 257             /* Nothing to do */
 258             break;
 259         case FONT_TYPE_XCB: {
 260             /* Change the font and colors in the GC */
 261             uint32_t mask = XCB_GC_FOREGROUND | XCB_GC_BACKGROUND | XCB_GC_FONT;
 262             uint32_t values[] = { foreground, background, savedFont->specific.xcb.id };
 263             xcb_change_gc(conn, gc, mask, values);
 264             break;
 265         }
 266 #if PANGO_SUPPORT
 267         case FONT_TYPE_PANGO:
 268             /* Save the foreground font */
 269             pango_font_red = ((foreground >> 16) & 0xff) / 255.0;
 270             pango_font_green = ((foreground >> 8) & 0xff) / 255.0;
 271             pango_font_blue = (foreground & 0xff) / 255.0;
 272             break;
 273 #endif
 274         default:
 275             assert(false);
 276             break;
 277     }
 278 }
 279
 280 static int predict_text_width_xcb(const xcb_char2b_t *text, size_t text_len);
 281
 282 static void draw_text_xcb(const xcb_char2b_t *text, size_t text_len, xcb_drawable_t drawable,
 283                xcb_gcontext_t gc, int x, int y, int max_width) {
 284     /* X11 coordinates for fonts start at the baseline */
 285     int pos_y = y + savedFont->specific.xcb.info->font_ascent;
 286
 287     /* The X11 protocol limits text drawing to 255 chars, so we may need
 288      * multiple calls */
 289     int offset = 0;
 290     for (;;) {
 291         /* Calculate the size of this chunk */
 292         int chunk_size = (text_len > 255 ? 255 : text_len);
 293         const xcb_char2b_t *chunk = text + offset;
 294
 295         /* Draw it */
 296         xcb_image_text_16(conn, chunk_size, drawable, gc, x, pos_y, chunk);
 297
 298         /* Advance the offset and length of the text to draw */
 299         offset += chunk_size;
 300         text_len -= chunk_size;
 301
 302         /* Check if we're done */
 303         if (text_len == 0)
 304             break;
 305
 306         /* Advance pos_x based on the predicted text width */
 307         x += predict_text_width_xcb(chunk, chunk_size);
 308     }
 309 }
 310
 311 /*
 312  * Draws text onto the specified X drawable (normally a pixmap) at the
 313  * specified coordinates (from the top left corner of the leftmost, uppermost
 314  * glyph) and using the provided gc.
 315  *
 316  * Text must be specified as an i3String.
 317  *
 318  */
 319 void draw_text(i3String *text, xcb_drawable_t drawable,
 320                xcb_gcontext_t gc, int x, int y, int max_width) {
 321     assert(savedFont != NULL);
 322
 323     switch (savedFont->type) {
 324         case FONT_TYPE_NONE:
 325             /* Nothing to do */
 326             return;
 327         case FONT_TYPE_XCB:
 328             draw_text_xcb(i3string_as_ucs2(text), i3string_get_num_glyphs(text),
 329                       drawable, gc, x, y, max_width);
 330             break;
 331 #if PANGO_SUPPORT
 332         case FONT_TYPE_PANGO:
 333             /* Render the text using Pango */
 334             draw_text_pango(i3string_as_utf8(text), i3string_get_num_bytes(text),
 335                             drawable, x, y, max_width);
 336             return;
 337 #endif
 338         default:
 339             assert(false);
 340     }
 341 }
 342
 343 /*
 344  * ASCII version of draw_text to print static strings.
 345  *
 346  */
 347 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
 348                xcb_gcontext_t gc, int x, int y, int max_width) {
 349     assert(savedFont != NULL);
 350
 351     switch (savedFont->type) {
 352         case FONT_TYPE_NONE:
 353             /* Nothing to do */
 354             return;
 355         case FONT_TYPE_XCB:
 356         {
 357             size_t text_len = strlen(text);
 358             if (text_len > 255) {
 359                 /* The text is too long to draw it directly to X */
 360                 i3String *str = i3string_from_utf8(text);
 361                 draw_text(str, drawable, gc, x, y, max_width);
 362                 i3string_free(str);
 363             } else {
 364                 /* X11 coordinates for fonts start at the baseline */
 365                 int pos_y = y + savedFont->specific.xcb.info->font_ascent;
 366
 367                 xcb_image_text_8(conn, text_len, drawable, gc, x, pos_y, text);
 368             }
 369             break;
 370         }
 371 #if PANGO_SUPPORT
 372         case FONT_TYPE_PANGO:
 373             /* Render the text using Pango */
 374             draw_text_pango(text, strlen(text),
 375                             drawable, x, y, max_width);
 376             return;
 377 #endif
 378         default:
 379             assert(false);
 380     }
 381 }
 382
 383 static int xcb_query_text_width(const xcb_char2b_t *text, size_t text_len) {
 384     /* Make the user know we’re using the slow path, but only once. */
 385     static bool first_invocation = true;
 386     if (first_invocation) {
 387         fprintf(stderr, "Using slow code path for text extents\n");
 388         first_invocation = false;
 389     }
 390
 391     /* Query the text width */
 392     xcb_generic_error_t *error;
 393     xcb_query_text_extents_cookie_t cookie = xcb_query_text_extents(conn,
 394             savedFont->specific.xcb.id, text_len, (xcb_char2b_t*)text);
 395     xcb_query_text_extents_reply_t *reply = xcb_query_text_extents_reply(conn,
 396             cookie, &error);
 397     if (reply == NULL) {
 398         /* We return a safe estimate because a rendering error is better than
 399          * a crash. Plus, the user will see the error in his log. */
 400         fprintf(stderr, "Could not get text extents (X error code %d)\n",
 401                 error->error_code);
 402         return savedFont->specific.xcb.info->max_bounds.character_width * text_len;
 403     }
 404
 405     int width = reply->overall_width;
 406     free(reply);
 407     return width;
 408 }
 409
 410 static int predict_text_width_xcb(const xcb_char2b_t *input, size_t text_len) {
 411     if (text_len == 0)
 412         return 0;
 413
 414     int width;
 415     if (savedFont->specific.xcb.table == NULL) {
 416         /* If we don't have a font table, fall back to querying the server */
 417         width = xcb_query_text_width(input, text_len);
 418     } else {
 419         /* Save some pointers for convenience */
 420         xcb_query_font_reply_t *font_info = savedFont->specific.xcb.info;
 421         xcb_charinfo_t *font_table = savedFont->specific.xcb.table;
 422
 423         /* Calculate the width using the font table */
 424         width = 0;
 425         for (size_t i = 0; i < text_len; i++) {
 426             xcb_charinfo_t *info;
 427             int row = input[i].byte1;
 428             int col = input[i].byte2;
 429
 430             if (row < font_info->min_byte1 ||
 431                 row > font_info->max_byte1 ||
 432                 col < font_info->min_char_or_byte2 ||
 433                 col > font_info->max_char_or_byte2)
 434                 continue;
 435
 436             /* Don't you ask me, how this one works… (Merovius) */
 437             info = &font_table[((row - font_info->min_byte1) *
 438                     (font_info->max_char_or_byte2 - font_info->min_char_or_byte2 + 1)) +
 439                 (col - font_info->min_char_or_byte2)];
 440
 441             if (info->character_width != 0 ||
 442                     (info->right_side_bearing |
 443                      info->left_side_bearing |
 444                      info->ascent |
 445                      info->descent) != 0) {
 446                 width += info->character_width;
 447             }
 448         }
 449     }
 450
 451     return width;
 452 }
 453
 454 /*
 455  * Predict the text width in pixels for the given text. Text must be
 456  * specified as an i3String.
 457  *
 458  */
 459 int predict_text_width(i3String *text) {
 460     assert(savedFont != NULL);
 461
 462     switch (savedFont->type) {
 463         case FONT_TYPE_NONE:
 464             /* Nothing to do */
 465             return 0;
 466         case FONT_TYPE_XCB:
 467             return predict_text_width_xcb(i3string_as_ucs2(text), i3string_get_num_glyphs(text));
 468 #if PANGO_SUPPORT
 469         case FONT_TYPE_PANGO:
 470             /* Calculate extents using Pango */
 471             return predict_text_width_pango(i3string_as_utf8(text), i3string_get_num_bytes(text));
 472 #endif
 473         default:
 474             assert(false);
 475             return 0;
 476     }
 477 }