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