ftcrfont.c 8.83 KB
Newer Older
Jan D's avatar
Jan D committed
1
/* ftcrfont.c -- FreeType font driver on cairo.
Paul Eggert's avatar
Paul Eggert committed
2
   Copyright (C) 2015-2019 Free Software Foundation, Inc.
Jan D's avatar
Jan D committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
8 9
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
Jan D's avatar
Jan D committed
10 11 12 13 14 15 16

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
17
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.  */
Jan D's avatar
Jan D committed
18 19 20 21


#include <config.h>
#include <stdio.h>
22
#include <math.h>
Jan D's avatar
Jan D committed
23 24 25 26 27 28 29
#include <cairo-ft.h>

#include "lisp.h"
#include "xterm.h"
#include "blockinput.h"
#include "font.h"
#include "ftfont.h"
Daniel Colascione's avatar
Daniel Colascione committed
30
#include "pdumper.h"
Jan D's avatar
Jan D committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

#define METRICS_NCOLS_PER_ROW	(128)

enum metrics_status
  {
    METRICS_INVALID = -1,    /* metrics entry is invalid */
  };

#define METRICS_STATUS(metrics)	((metrics)->ascent + (metrics)->descent)
#define METRICS_SET_STATUS(metrics, status) \
  ((metrics)->ascent = 0, (metrics)->descent = (status))

static int
ftcrfont_glyph_extents (struct font *font,
                        unsigned glyph,
                        struct font_metrics *metrics)
{
48
  struct font_info *ftcrfont_info = (struct font_info *) font;
Jan D's avatar
Jan D committed
49 50 51 52 53 54 55 56 57 58
  int row, col;
  struct font_metrics *cache;

  row = glyph / METRICS_NCOLS_PER_ROW;
  col = glyph % METRICS_NCOLS_PER_ROW;
  if (row >= ftcrfont_info->metrics_nrows)
    {
      ftcrfont_info->metrics =
	xrealloc (ftcrfont_info->metrics,
		  sizeof (struct font_metrics *) * (row + 1));
Paul Eggert's avatar
Paul Eggert committed
59 60 61
      memset (ftcrfont_info->metrics + ftcrfont_info->metrics_nrows, 0,
	      (sizeof (struct font_metrics *)
	       * (row + 1 - ftcrfont_info->metrics_nrows)));
Jan D's avatar
Jan D committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
      ftcrfont_info->metrics_nrows = row + 1;
    }
  if (ftcrfont_info->metrics[row] == NULL)
    {
      struct font_metrics *new;
      int i;

      new = xmalloc (sizeof (struct font_metrics) * METRICS_NCOLS_PER_ROW);
      for (i = 0; i < METRICS_NCOLS_PER_ROW; i++)
	METRICS_SET_STATUS (new + i, METRICS_INVALID);
      ftcrfont_info->metrics[row] = new;
    }
  cache = ftcrfont_info->metrics[row] + col;

  if (METRICS_STATUS (cache) == METRICS_INVALID)
77
    {
78
      cairo_glyph_t cr_glyph = {.index = glyph};
79 80 81 82 83 84 85
      cairo_text_extents_t extents;

      cairo_scaled_font_glyph_extents (ftcrfont_info->cr_scaled_font,
				       &cr_glyph, 1, &extents);
      cache->lbearing = floor (extents.x_bearing);
      cache->rbearing = ceil (extents.width + extents.x_bearing);
      cache->width = lround (extents.x_advance);
86 87
      cache->ascent = ceil (- extents.y_bearing);
      cache->descent = ceil (extents.height + extents.y_bearing);
88
    }
Jan D's avatar
Jan D committed
89 90 91 92 93 94 95 96 97 98

  if (metrics)
    *metrics = *cache;

  return cache->width;
}

static Lisp_Object
ftcrfont_list (struct frame *f, Lisp_Object spec)
{
99
  Lisp_Object list = ftfont_list (f, spec), tail;
Jan D's avatar
Jan D committed
100 101 102 103 104 105 106 107 108

  for (tail = list; CONSP (tail); tail = XCDR (tail))
    ASET (XCAR (tail), FONT_TYPE_INDEX, Qftcr);
  return list;
}

static Lisp_Object
ftcrfont_match (struct frame *f, Lisp_Object spec)
{
109
  Lisp_Object entity = ftfont_match (f, spec);
Jan D's avatar
Jan D committed
110 111 112 113 114 115 116 117 118 119 120

  if (VECTORP (entity))
    ASET (entity, FONT_TYPE_INDEX, Qftcr);
  return entity;
}

static Lisp_Object
ftcrfont_open (struct frame *f, Lisp_Object entity, int pixel_size)
{
  Lisp_Object font_object;

121
  FT_UInt size = XFIXNUM (AREF (entity, FONT_SIZE_INDEX));
Jan D's avatar
Jan D committed
122 123
  if (size == 0)
    size = pixel_size;
124
  font_object = font_build_object (VECSIZE (struct font_info),
Jan D's avatar
Jan D committed
125
				   Qftcr, entity, size);
126
  block_input ();
Jan D's avatar
Jan D committed
127
  font_object = ftfont_open2 (f, entity, pixel_size, font_object);
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
  if (FONT_OBJECT_P (font_object))
    {
      struct font *font = XFONT_OBJECT (font_object);
      struct font_info *ftcrfont_info = (struct font_info *) font;
      FT_Face ft_face = ftcrfont_info->ft_size->face;

      font->driver = &ftcrfont_driver;
      FT_New_Size (ft_face, &ftcrfont_info->ft_size_draw);
      FT_Activate_Size (ftcrfont_info->ft_size_draw);
      FT_Set_Pixel_Sizes (ft_face, 0, font->pixel_size);
      cairo_font_face_t *font_face =
	cairo_ft_font_face_create_for_ft_face (ft_face, 0);
      cairo_matrix_t font_matrix, ctm;
      cairo_matrix_init_scale (&font_matrix, pixel_size, pixel_size);
      cairo_matrix_init_identity (&ctm);
      cairo_font_options_t *options = cairo_font_options_create ();
      ftcrfont_info->cr_scaled_font =
	cairo_scaled_font_create (font_face, &font_matrix, &ctm, options);
      cairo_font_face_destroy (font_face);
      cairo_font_options_destroy (options);
      ftcrfont_info->metrics = NULL;
      ftcrfont_info->metrics_nrows = 0;
    }
Jan D's avatar
Jan D committed
151 152 153 154 155 156 157 158
  unblock_input ();

  return font_object;
}

static void
ftcrfont_close (struct font *font)
{
Paul Eggert's avatar
Paul Eggert committed
159 160 161
  if (font_data_structures_may_be_ill_formed ())
    return;

162
  struct font_info *ftcrfont_info = (struct font_info *) font;
Jan D's avatar
Jan D committed
163 164 165 166 167 168 169 170 171
  int i;

  block_input ();
  for (i = 0; i < ftcrfont_info->metrics_nrows; i++)
    if (ftcrfont_info->metrics[i])
      xfree (ftcrfont_info->metrics[i]);
  if (ftcrfont_info->metrics)
    xfree (ftcrfont_info->metrics);
  FT_Done_Size (ftcrfont_info->ft_size_draw);
172
  cairo_scaled_font_destroy (ftcrfont_info->cr_scaled_font);
Jan D's avatar
Jan D committed
173 174
  unblock_input ();

175
  ftfont_close (font);
Jan D's avatar
Jan D committed
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
}

static void
ftcrfont_text_extents (struct font *font,
                       unsigned *code,
                       int nglyphs,
                       struct font_metrics *metrics)
{
  int width, i;

  block_input ();
  width = ftcrfont_glyph_extents (font, code[0], metrics);
  for (i = 1; i < nglyphs; i++)
    {
      struct font_metrics m;
      int w = ftcrfont_glyph_extents (font, code[i], metrics ? &m : NULL);

      if (metrics)
	{
	  if (width + m.lbearing < metrics->lbearing)
	    metrics->lbearing = width + m.lbearing;
	  if (width + m.rbearing > metrics->rbearing)
	    metrics->rbearing = width + m.rbearing;
	  if (m.ascent > metrics->ascent)
	    metrics->ascent = m.ascent;
	  if (m.descent > metrics->descent)
	    metrics->descent = m.descent;
	}
      width += w;
    }
  unblock_input ();

  if (metrics)
    metrics->width = width;
}

static int
ftcrfont_draw (struct glyph_string *s,
               int from, int to, int x, int y, bool with_background)
{
  struct frame *f = s->f;
  struct face *face = s->face;
218
  struct font_info *ftcrfont_info = (struct font_info *) s->font;
Jan D's avatar
Jan D committed
219 220 221
  cairo_t *cr;
  cairo_glyph_t *glyphs;
  cairo_surface_t *surface;
222
  cairo_surface_type_t surface_type;
Jan D's avatar
Jan D committed
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
  int len = to - from;
  int i;

  block_input ();

  cr = x_begin_cr_clip (f, s->gc);

  if (with_background)
    {
      x_set_cr_source_with_gc_background (f, s->gc);
      cairo_rectangle (cr, x, y - FONT_BASE (face->font),
		       s->width, FONT_HEIGHT (face->font));
      cairo_fill (cr);
    }

  glyphs = alloca (sizeof (cairo_glyph_t) * len);
  for (i = 0; i < len; i++)
    {
      unsigned code = ((XCHAR2B_BYTE1 (s->char2b + from + i) << 8)
		       | XCHAR2B_BYTE2 (s->char2b + from + i));

      glyphs[i].index = code;
      glyphs[i].x = x;
      glyphs[i].y = y;
      x += (s->padding_p ? 1 : ftcrfont_glyph_extents (s->font, code, NULL));
    }

  x_set_cr_source_with_gc_foreground (f, s->gc);
251
  cairo_set_scaled_font (cr, ftcrfont_info->cr_scaled_font);
Jan D's avatar
Jan D committed
252 253 254 255

  FT_Activate_Size (ftcrfont_info->ft_size_draw);
  cairo_show_glyphs (cr, glyphs, len);
  surface = cairo_get_target (cr);
256 257 258 259 260 261
  /* XXX: It used to be necessary to flush when exporting.  It might
     be the case that this is no longer necessary.  */
  surface_type = cairo_surface_get_type (surface);
  if (surface_type != CAIRO_SURFACE_TYPE_XLIB
      && (surface_type != CAIRO_SURFACE_TYPE_IMAGE
	  || cairo_image_surface_get_format (surface) != CAIRO_FORMAT_ARGB32))
Jan D's avatar
Jan D committed
262 263 264 265 266 267 268 269 270 271 272
    cairo_surface_flush (surface);

  x_end_cr_clip (f);

  unblock_input ();

  return len;
}



Daniel Colascione's avatar
Daniel Colascione committed
273 274
static void syms_of_ftcrfont_for_pdumper (void);

275 276
struct font_driver const ftcrfont_driver =
  {
Paul Eggert's avatar
Paul Eggert committed
277 278 279 280 281 282 283 284 285 286 287 288 289
  .type = LISPSYM_INITIALLY (Qftcr),
  .get_cache = ftfont_get_cache,
  .list = ftcrfont_list,
  .match = ftcrfont_match,
  .list_family = ftfont_list_family,
  .open = ftcrfont_open,
  .close = ftcrfont_close,
  .has_char = ftfont_has_char,
  .encode_char = ftfont_encode_char,
  .text_extents = ftcrfont_text_extents,
  .draw = ftcrfont_draw,
  .get_bitmap = ftfont_get_bitmap,
  .anchor_point = ftfont_anchor_point,
290
#ifdef HAVE_LIBOTF
Paul Eggert's avatar
Paul Eggert committed
291
  .otf_capability = ftfont_otf_capability,
292 293
#endif
#if defined HAVE_M17N_FLT && defined HAVE_LIBOTF
Paul Eggert's avatar
Paul Eggert committed
294
  .shape = ftfont_shape,
295 296
#endif
#ifdef HAVE_OTF_GET_VARIATION_GLYPHS
Paul Eggert's avatar
Paul Eggert committed
297
  .get_variation_glyphs = ftfont_variation_glyphs,
298
#endif
Paul Eggert's avatar
Paul Eggert committed
299 300
  .filter_properties = ftfont_filter_properties,
  .combining_capability = ftfont_combining_capability,
301 302
  };

Jan D's avatar
Jan D committed
303 304 305 306
void
syms_of_ftcrfont (void)
{
  DEFSYM (Qftcr, "ftcr");
Daniel Colascione's avatar
Daniel Colascione committed
307 308 309 310 311 312
  pdumper_do_now_and_after_load (syms_of_ftcrfont_for_pdumper);
}

static void
syms_of_ftcrfont_for_pdumper (void)
{
Jan D's avatar
Jan D committed
313 314
  register_font_driver (&ftcrfont_driver, NULL);
}