ftfont.c 80.7 KB
Newer Older
Kenichi Handa's avatar
Kenichi Handa committed
1
/* ftfont.c -- FreeType font driver.
Paul Eggert's avatar
Paul Eggert committed
2
   Copyright (C) 2006-2019 Free Software Foundation, Inc.
3
   Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011
Kenichi Handa's avatar
Kenichi Handa committed
4 5 6 7 8
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H13PRO009

This file is part of GNU Emacs.

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

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
20
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.  */
Kenichi Handa's avatar
Kenichi Handa committed
21 22 23 24 25 26

#include <config.h>
#include <stdio.h>
#include <fontconfig/fontconfig.h>
#include <fontconfig/fcfreetype.h>

27 28 29 30 31 32 33 34 35 36 37
/* These two blocks are here because this file is built when using XFT
   and when using Cairo, so struct font_info in ftfont.h needs access
   to the appropriate types.  */
#ifdef HAVE_XFT
# include <X11/Xlib.h>
# include <X11/Xft/Xft.h>
#endif
#ifdef USE_CAIRO
# include <cairo-ft.h>
#endif

38 39
#include <c-strcase.h>

Kenichi Handa's avatar
Kenichi Handa committed
40 41 42 43
#include "lisp.h"
#include "dispextern.h"
#include "character.h"
#include "charset.h"
44
#include "category.h"
Kenichi Handa's avatar
Kenichi Handa committed
45
#include "composite.h"
Kenichi Handa's avatar
Kenichi Handa committed
46
#include "font.h"
47
#include "ftfont.h"
Daniel Colascione's avatar
Daniel Colascione committed
48
#include "pdumper.h"
Kenichi Handa's avatar
Kenichi Handa committed
49

50
static struct font_driver const ftfont_driver;
51 52 53
#ifdef HAVE_HARFBUZZ
static struct font_driver fthbfont_driver;
#endif	/* HAVE_HARFBUZZ */
54

Juanma Barranquero's avatar
Juanma Barranquero committed
55
/* Flag to tell if FcInit is already called or not.  */
56
static bool fc_initialized;
57 58

/* Handle to a FreeType library instance.  */
Kenichi Handa's avatar
Kenichi Handa committed
59 60
static FT_Library ft_library;

61
/* Cache for FreeType fonts.  */
Kenichi Handa's avatar
Kenichi Handa committed
62 63
static Lisp_Object freetype_font_cache;

64
/* Cache for FT_Face and FcCharSet. */
Kenichi Handa's avatar
Kenichi Handa committed
65
static Lisp_Object ft_face_cache;
Kenichi Handa's avatar
Kenichi Handa committed
66

67 68 69 70 71 72 73
enum ftfont_cache_for
  {
    FTFONT_CACHE_FOR_FACE,
    FTFONT_CACHE_FOR_CHARSET,
    FTFONT_CACHE_FOR_ENTITY
  };

74 75
static Lisp_Object ftfont_lookup_cache (Lisp_Object,
                                        enum ftfont_cache_for);
76

77 78
#define SYMBOL_FcChar8(SYM) (FcChar8 *) SDATA (SYMBOL_NAME (SYM))

Kenichi Handa's avatar
Kenichi Handa committed
79
static struct
Kenichi Handa's avatar
Kenichi Handa committed
80
{
81
  /* registry name */
82
  const char *name;
Kenichi Handa's avatar
Kenichi Handa committed
83 84
  /* characters to distinguish the charset from the others */
  int uniquifier[6];
85
  /* additional constraint by language */
86
  const char *lang;
Kenichi Handa's avatar
Kenichi Handa committed
87 88 89
  /* set on demand */
  FcCharSet *fc_charset;
} fc_charset_table[] =
90
  { { "iso8859-1", { 0x00A0, 0x00A1, 0x00B4, 0x00BC, 0x00D0 } },
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
    { "iso8859-2", { 0x00A0, 0x010E }},
    { "iso8859-3", { 0x00A0, 0x0108 }},
    { "iso8859-4", { 0x00A0, 0x00AF, 0x0128, 0x0156, 0x02C7 }},
    { "iso8859-5", { 0x00A0, 0x0401 }},
    { "iso8859-6", { 0x00A0, 0x060C }},
    { "iso8859-7", { 0x00A0, 0x0384 }},
    { "iso8859-8", { 0x00A0, 0x05D0 }},
    { "iso8859-9", { 0x00A0, 0x00A1, 0x00BC, 0x011E }},
    { "iso8859-10", { 0x00A0, 0x00D0, 0x0128, 0x2015 }},
    { "iso8859-11", { 0x00A0, 0x0E01 }},
    { "iso8859-13", { 0x00A0, 0x201C }},
    { "iso8859-14", { 0x00A0, 0x0174 }},
    { "iso8859-15", { 0x00A0, 0x00A1, 0x00D0, 0x0152 }},
    { "iso8859-16", { 0x00A0, 0x0218}},
    { "gb2312.1980-0", { 0x4E13 }, "zh-cn"},
    { "big5-0", { 0xF6B1 }, "zh-tw" },
    { "jisx0208.1983-0", { 0x4E55 }, "ja"},
    { "ksc5601.1985-0", { 0xAC00 }, "ko"},
    { "cns11643.1992-1", { 0xFE32 }, "zh-tw"},
    { "cns11643.1992-2", { 0x4E33, 0x7934 }},
    { "cns11643.1992-3", { 0x201A9 }},
    { "cns11643.1992-4", { 0x20057 }},
    { "cns11643.1992-5", { 0x20000 }},
    { "cns11643.1992-6", { 0x20003 }},
    { "cns11643.1992-7", { 0x20055 }},
    { "gbk-0", { 0x4E06 }, "zh-cn"},
    { "jisx0212.1990-0", { 0x4E44 }},
    { "jisx0213.2000-1", { 0xFA10 }, "ja"},
    { "jisx0213.2000-2", { 0xFA49 }},
    { "jisx0213.2004-1", { 0x20B9F }},
    { "viscii1.1-1", { 0x1EA0, 0x1EAE, 0x1ED2 }, "vi"},
    { "tis620.2529-1", { 0x0E01 }, "th"},
123 124
    { "windows-1251", { 0x0401, 0x0490 }, "ru"},
    { "koi8-r", { 0x0401, 0x2219 }, "ru"},
125
    { "mulelao-1", { 0x0E81 }, "lo"},
126
    { "unicode-sip", { 0x20000 }},
Kenichi Handa's avatar
Kenichi Handa committed
127 128
    { NULL }
  };
Kenichi Handa's avatar
Kenichi Handa committed
129

130 131 132 133 134 135
static bool
matching_prefix (char const *str, ptrdiff_t len, char const *pat)
{
  return len == strlen (pat) && c_strncasecmp (str, pat, len) == 0;
}

Kenichi Handa's avatar
Kenichi Handa committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
/* Dirty hack for handing ADSTYLE property.

   Fontconfig (actually the underlying FreeType) gives such ADSTYLE
   font property of PCF/BDF fonts in FC_STYLE.  And, "Bold",
   "Oblique", "Italic", or any non-normal SWIDTH property names
   (e.g. SemiCondensed) are appended.  In addition, if there's no
   ADSTYLE property nor non-normal WEIGHT/SLANT/SWIDTH properties,
   "Regular" is used for FC_STYLE (see the function
   pcf_interpret_style in src/pcf/pcfread.c of FreeType).

   Unfortunately this behavior is not documented, so the following
   code may fail if FreeType changes the behavior in the future.  */

static Lisp_Object
get_adstyle_property (FcPattern *p)
{
152 153
  FcChar8 *fcstr;
  char *str, *end;
Kenichi Handa's avatar
Kenichi Handa committed
154 155
  Lisp_Object adstyle;

156 157
#ifdef FC_FONTFORMAT
  if ((FcPatternGetString (p, FC_FONTFORMAT, 0, &fcstr) == FcResultMatch)
158 159
      && xstrcasecmp ((char *) fcstr, "bdf") != 0
      && xstrcasecmp ((char *) fcstr, "pcf") != 0)
160 161 162
    /* Not a BDF nor PCF font.  */
    return Qnil;
#endif
163
  if (FcPatternGetString (p, FC_STYLE, 0, &fcstr) != FcResultMatch)
Kenichi Handa's avatar
Kenichi Handa committed
164
    return Qnil;
165
  str = (char *) fcstr;
Kenichi Handa's avatar
Kenichi Handa committed
166
  for (end = str; *end && *end != ' '; end++);
167 168 169 170
  if (matching_prefix (str, end - str, "Regular")
      || matching_prefix (str, end - str, "Bold")
      || matching_prefix (str, end - str, "Oblique")
      || matching_prefix (str, end - str, "Italic"))
Kenichi Handa's avatar
Kenichi Handa committed
171
    return Qnil;
172
  adstyle = font_intern_prop (str, end - str, 1);
Kenichi Handa's avatar
Kenichi Handa committed
173 174 175 176 177
  if (font_style_to_value (FONT_WIDTH_INDEX, adstyle, 0) >= 0)
    return Qnil;
  return adstyle;
}

178
static Lisp_Object
179
ftfont_pattern_entity (FcPattern *p, Lisp_Object extra)
180
{
181
  Lisp_Object key, cache, entity;
182 183
  FcChar8 *str;
  char *file;
184
  int idx;
185 186
  int numeric;
  double dbl;
187
  FcBool b;
188

189
  if (FcPatternGetString (p, FC_FILE, 0, &str) != FcResultMatch)
190
    return Qnil;
191
  if (FcPatternGetInteger (p, FC_INDEX, 0, &idx) != FcResultMatch)
192
    return Qnil;
193

194
  file = (char *) str;
195
  key = Fcons (build_unibyte_string (file), make_fixnum (idx));
196 197 198
  cache = ftfont_lookup_cache (key, FTFONT_CACHE_FOR_ENTITY);
  entity = XCAR (cache);
  if (! NILP (entity))
199 200 201 202 203 204
    {
      Lisp_Object val = font_make_entity ();
      int i;

      for (i = 0; i < FONT_OBJLIST_INDEX; i++)
	ASET (val, i, AREF (entity, i));
205 206 207 208

      ASET (val, FONT_EXTRA_INDEX, Fcopy_sequence (extra));
      font_put_extra (val, QCfont_entity, key);

209 210
      return val;
    }
211
  entity = font_make_entity ();
212
  XSETCAR (cache, entity);
213 214

  ASET (entity, FONT_TYPE_INDEX, Qfreetype);
215
  ASET (entity, FONT_REGISTRY_INDEX, Qiso10646_1);
216

217 218 219 220 221 222 223 224 225 226
  if (FcPatternGetString (p, FC_FOUNDRY, 0, &str) == FcResultMatch)
    {
      char *s = (char *) str;
      ASET (entity, FONT_FOUNDRY_INDEX, font_intern_prop (s, strlen (s), 1));
    }
  if (FcPatternGetString (p, FC_FAMILY, 0, &str) == FcResultMatch)
    {
      char *s = (char *) str;
      ASET (entity, FONT_FAMILY_INDEX, font_intern_prop (s, strlen (s), 1));
    }
227
  if (FcPatternGetInteger (p, FC_WEIGHT, 0, &numeric) == FcResultMatch)
228
    {
229 230
      if (numeric >= FC_WEIGHT_REGULAR && numeric < FC_WEIGHT_MEDIUM)
	numeric = FC_WEIGHT_MEDIUM;
231
      FONT_SET_STYLE (entity, FONT_WEIGHT_INDEX, make_fixnum (numeric));
232
    }
233
  if (FcPatternGetInteger (p, FC_SLANT, 0, &numeric) == FcResultMatch)
234 235
    {
      numeric += 100;
236
      FONT_SET_STYLE (entity, FONT_SLANT_INDEX, make_fixnum (numeric));
237
    }
238
  if (FcPatternGetInteger (p, FC_WIDTH, 0, &numeric) == FcResultMatch)
239
    {
240
      FONT_SET_STYLE (entity, FONT_WIDTH_INDEX, make_fixnum (numeric));
241
    }
242
  if (FcPatternGetDouble (p, FC_PIXEL_SIZE, 0, &dbl) == FcResultMatch)
Kenichi Handa's avatar
Kenichi Handa committed
243
    {
244
      ASET (entity, FONT_SIZE_INDEX, make_fixnum (dbl));
Kenichi Handa's avatar
Kenichi Handa committed
245
    }
246
  else
247
    ASET (entity, FONT_SIZE_INDEX, make_fixnum (0));
248
  if (FcPatternGetInteger (p, FC_SPACING, 0, &numeric) == FcResultMatch)
249
    ASET (entity, FONT_SPACING_INDEX, make_fixnum (numeric));
250 251 252
  if (FcPatternGetDouble (p, FC_DPI, 0, &dbl) == FcResultMatch)
    {
      int dpi = dbl;
253
      ASET (entity, FONT_DPI_INDEX, make_fixnum (dpi));
254 255 256
    }
  if (FcPatternGetBool (p, FC_SCALABLE, 0, &b) == FcResultMatch
      && b == FcTrue)
257
    {
258 259
      ASET (entity, FONT_SIZE_INDEX, make_fixnum (0));
      ASET (entity, FONT_AVGWIDTH_INDEX, make_fixnum (0));
260 261 262
    }
  else
    {
Paul Eggert's avatar
Paul Eggert committed
263
      /* As this font is not scalable, perhaps this is a BDF or PCF
264
	 font. */
265 266 267 268
      FT_Face ft_face;

      ASET (entity, FONT_ADSTYLE_INDEX, get_adstyle_property (p));
      if ((ft_library || FT_Init_FreeType (&ft_library) == 0)
269
	  && FT_New_Face (ft_library, file, idx, &ft_face) == 0)
270 271 272 273 274
	{
	  BDF_PropertyRec rec;

	  if (FT_Get_BDF_Property (ft_face, "AVERAGE_WIDTH", &rec) == 0
	      && rec.type == BDF_PROPERTY_TYPE_INTEGER)
275
	    ASET (entity, FONT_AVGWIDTH_INDEX, make_fixnum (rec.u.integer));
276 277 278
	  FT_Done_Face (ft_face);
	}
    }
279

280
  ASET (entity, FONT_EXTRA_INDEX, Fcopy_sequence (extra));
281
  font_put_extra (entity, QCfont_entity, key);
282 283 284
  return entity;
}

285

286 287 288
static Lisp_Object ftfont_generic_family_list;

static Lisp_Object
289
ftfont_resolve_generic_family (Lisp_Object family, FcPattern *pattern)
290
{
291
  Lisp_Object slot;
292
  FcPattern *match;
293
  FcResult result;
Kenichi Handa's avatar
Kenichi Handa committed
294
  FcLangSet *langset;
295

296
  family = Fintern (Fdowncase (SYMBOL_NAME (family)), Qnil);
297 298 299 300 301 302
  if (EQ (family, Qmono))
    family = Qmonospace;
  else if (EQ (family, Qsans) || EQ (family, Qsans__serif))
    family = Qsans_serif;
  slot = assq_no_quit (family, ftfont_generic_family_list);
  if (! CONSP (slot))
303
    return Qnil;
304 305
  if (! EQ (XCDR (slot), Qt))
    return XCDR (slot);
306
  pattern = FcPatternDuplicate (pattern);
307 308
  if (! pattern)
    goto err;
309
  FcPatternDel (pattern, FC_FOUNDRY);
310 311
  FcPatternDel (pattern, FC_FAMILY);
  FcPatternAddString (pattern, FC_FAMILY, SYMBOL_FcChar8 (family));
Kenichi Handa's avatar
Kenichi Handa committed
312 313 314
  if (FcPatternGetLangSet (pattern, FC_LANG, 0, &langset) != FcResultMatch)
    {
      /* This is to avoid the effect of locale.  */
315
      static const FcChar8 lang[] = "en";
Kenichi Handa's avatar
Kenichi Handa committed
316
      langset = FcLangSetCreate ();
317
      FcLangSetAdd (langset, lang);
Kenichi Handa's avatar
Kenichi Handa committed
318 319 320
      FcPatternAddLangSet (pattern, FC_LANG, langset);
      FcLangSetDestroy (langset);
    }
321
  FcConfigSubstitute (NULL, pattern, FcMatchPattern);
322 323 324
  FcDefaultSubstitute (pattern);
  match = FcFontMatch (NULL, pattern, &result);
  if (match)
325
    {
326 327 328 329
      FcChar8 *fam;

      if (FcPatternGetString (match, FC_FAMILY, 0, &fam) == FcResultMatch)
	family = intern ((char *) fam);
330
    }
331 332 333 334
  else
    family = Qnil;
  XSETCDR (slot, family);
  if (match) FcPatternDestroy (match);
335
 err:
336
  if (pattern) FcPatternDestroy (pattern);
337
  return family;
338 339
}

340 341 342 343
struct ftfont_cache_data
{
  FT_Face ft_face;
  FcCharSet *fc_charset;
344
  intptr_t face_refcount;
345 346 347
};

static Lisp_Object
348
ftfont_lookup_cache (Lisp_Object key, enum ftfont_cache_for cache_for)
Kenichi Handa's avatar
Kenichi Handa committed
349
{
Kenichi Handa's avatar
Kenichi Handa committed
350
  Lisp_Object cache, val, entity;
351
  struct ftfont_cache_data *cache_data;
Kenichi Handa's avatar
Kenichi Handa committed
352

Kenichi Handa's avatar
Kenichi Handa committed
353 354 355 356
  if (FONT_ENTITY_P (key))
    {
      entity = key;
      val = assq_no_quit (QCfont_entity, AREF (entity, FONT_EXTRA_INDEX));
357
      eassert (CONSP (val));
Kenichi Handa's avatar
Kenichi Handa committed
358 359 360 361 362
      key = XCDR (val);
    }
  else
    entity = Qnil;

363 364 365 366
  if (NILP (ft_face_cache))
    cache = Qnil;
  else
    cache = Fgethash (key, ft_face_cache, Qnil);
Kenichi Handa's avatar
Kenichi Handa committed
367 368
  if (NILP (cache))
    {
369
      if (NILP (ft_face_cache))
370
	ft_face_cache = CALLN (Fmake_hash_table, QCtest, Qequal);
371 372
      cache_data = xzalloc (sizeof *cache_data);
      val = make_mint_ptr (cache_data);
373 374
      cache = Fcons (Qnil, val);
      Fputhash (key, cache, ft_face_cache);
Kenichi Handa's avatar
Kenichi Handa committed
375 376 377
    }
  else
    {
378
      val = XCDR (cache);
379
      cache_data = xmint_pointer (val);
380
    }
381 382 383 384 385 386

  if (cache_for == FTFONT_CACHE_FOR_ENTITY)
    return cache;

  if (cache_for == FTFONT_CACHE_FOR_FACE
      ? ! cache_data->ft_face : ! cache_data->fc_charset)
387
    {
388
      char *filename = SSDATA (XCAR (key));
Tom Tromey's avatar
Tom Tromey committed
389
      int idx = XFIXNUM (XCDR (key));
Kenichi Handa's avatar
Kenichi Handa committed
390

391
      if (cache_for == FTFONT_CACHE_FOR_FACE)
392 393 394 395
	{
	  if (! ft_library
	      && FT_Init_FreeType (&ft_library) != 0)
	    return Qnil;
396
	  if (FT_New_Face (ft_library, filename, idx, &cache_data->ft_face)
397 398 399 400 401
	      != 0)
	    return Qnil;
	}
      else
	{
Kenichi Handa's avatar
Kenichi Handa committed
402 403 404 405
	  FcPattern *pat = NULL;
	  FcFontSet *fontset = NULL;
	  FcObjectSet *objset = NULL;
	  FcCharSet *charset = NULL;
406 407

	  pat = FcPatternBuild (0, FC_FILE, FcTypeString, (FcChar8 *) filename,
408
				FC_INDEX, FcTypeInteger, idx, NULL);
Kenichi Handa's avatar
Kenichi Handa committed
409 410 411 412 413
	  if (! pat)
	    goto finish;
	  objset = FcObjectSetBuild (FC_CHARSET, FC_STYLE, NULL);
	  if (! objset)
	    goto finish;
414
	  fontset = FcFontList (NULL, pat, objset);
Kenichi Handa's avatar
Kenichi Handa committed
415 416
	  if (! fontset)
	    goto finish;
417 418
	  if (fontset && fontset->nfont > 0
	      && (FcPatternGetCharSet (fontset->fonts[0], FC_CHARSET, 0,
419
				       &charset)
420 421
		  == FcResultMatch))
	    cache_data->fc_charset = FcCharSetCopy (charset);
422 423
	  else
	    cache_data->fc_charset = FcCharSetCreate ();
Kenichi Handa's avatar
Kenichi Handa committed
424 425 426 427 428 429 430 431

	finish:
	  if (fontset)
	    FcFontSetDestroy (fontset);
	  if (objset)
	    FcObjectSetDestroy (objset);
	  if (pat)
	    FcPatternDestroy (pat);
432
	}
Kenichi Handa's avatar
Kenichi Handa committed
433 434 435 436
    }
  return cache;
}

437
FcCharSet *
438
ftfont_get_fc_charset (Lisp_Object entity)
439 440 441 442
{
  Lisp_Object val, cache;
  struct ftfont_cache_data *cache_data;

443
  cache = ftfont_lookup_cache (entity, FTFONT_CACHE_FOR_CHARSET);
444
  val = XCDR (cache);
445
  cache_data = xmint_pointer (val);
446 447 448 449 450
  return cache_data->fc_charset;
}

#ifdef HAVE_LIBOTF
static OTF *
451
ftfont_get_otf (struct font_info *ftfont_info)
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
{
  OTF *otf;

  if (ftfont_info->otf)
    return ftfont_info->otf;
  if (! ftfont_info->maybe_otf)
    return NULL;
  otf = OTF_open_ft_face (ftfont_info->ft_size->face);
  if (! otf || OTF_get_table (otf, "head") < 0)
    {
      if (otf)
	OTF_close (otf);
      ftfont_info->maybe_otf = 0;
      return NULL;
    }
  ftfont_info->otf = otf;
  return otf;
}
470
#endif	/* HAVE_LIBOTF */
471

472
Lisp_Object
Dmitry Antipov's avatar
Dmitry Antipov committed
473
ftfont_get_cache (struct frame *f)
Kenichi Handa's avatar
Kenichi Handa committed
474 475 476 477
{
  return freetype_font_cache;
}

Kenichi Handa's avatar
Kenichi Handa committed
478
static int
479
ftfont_get_charset (Lisp_Object registry)
Kenichi Handa's avatar
Kenichi Handa committed
480
{
481
  char *str = SSDATA (SYMBOL_NAME (registry));
482 483
  USE_SAFE_ALLOCA;
  char *re = SAFE_ALLOCA (SBYTES (SYMBOL_NAME (registry)) * 2 + 1);
Kenichi Handa's avatar
Kenichi Handa committed
484 485
  int i, j;

486 487 488 489 490 491 492 493 494 495 496
  for (i = j = 0; i < SBYTES (SYMBOL_NAME (registry)); i++, j++)
    {
      if (str[i] == '.')
	re[j++] = '\\';
      else if (str[i] == '*')
	re[j++] = '.';
      re[j] = str[i];
      if (re[j] == '?')
	re[j] = '.';
    }
  re[j] = '\0';
497
  AUTO_STRING_WITH_LEN (regexp, re, j);
Kenichi Handa's avatar
Kenichi Handa committed
498
  for (i = 0; fc_charset_table[i].name; i++)
499 500 501
    if (fast_c_string_match_ignore_case
	(regexp, fc_charset_table[i].name,
	 strlen (fc_charset_table[i].name)) >= 0)
Kenichi Handa's avatar
Kenichi Handa committed
502
      break;
503
  SAFE_FREE ();
Kenichi Handa's avatar
Kenichi Handa committed
504 505 506 507
  if (! fc_charset_table[i].name)
    return -1;
  if (! fc_charset_table[i].fc_charset)
    {
508 509
      FcCharSet *charset = FcCharSetCreate ();
      int *uniquifier = fc_charset_table[i].uniquifier;
Kenichi Handa's avatar
Kenichi Handa committed
510

511 512 513 514 515 516
      if (! charset)
	return -1;
      for (j = 0; uniquifier[j]; j++)
	if (! FcCharSetAddChar (charset, uniquifier[j]))
	  {
	    FcCharSetDestroy (charset);
Kenichi Handa's avatar
Kenichi Handa committed
517
	    return -1;
518 519
	  }
      fc_charset_table[i].fc_charset = charset;
Kenichi Handa's avatar
Kenichi Handa committed
520 521 522 523
    }
  return i;
}

524 525
struct OpenTypeSpec
{
526 527
  Lisp_Object script;
  unsigned int script_tag, langsys_tag;
528 529 530 531
  int nfeatures[2];
  unsigned int *features[2];
};

532
#define OTF_SYM_TAG(SYM, TAG)					\
533
  do {								\
534 535
    unsigned char *p = SDATA (SYMBOL_NAME (SYM));		\
    TAG = (p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3];	\
536 537
  } while (0)

538
#define OTF_TAG_STR(TAG, P)			\
539
  do {						\
540 541 542 543
    (P)[0] = (char) (TAG >> 24);		\
    (P)[1] = (char) ((TAG >> 16) & 0xFF);	\
    (P)[2] = (char) ((TAG >> 8) & 0xFF);	\
    (P)[3] = (char) (TAG & 0xFF);		\
544
    (P)[4] = '\0';				\
545 546
  } while (0)

547
#ifdef HAVE_LIBOTF
548 549 550 551 552 553 554
#define OTF_TAG_SYM(SYM, TAG)			\
  do {						\
    char str[5];				\
    						\
    OTF_TAG_STR (TAG, str);			\
    (SYM) = font_intern_prop (str, 4, 1);	\
  } while (0)
555
#endif
556 557


558 559 560
static struct OpenTypeSpec *
ftfont_get_open_type_spec (Lisp_Object otf_spec)
{
561
  struct OpenTypeSpec *spec = malloc (sizeof *spec);
562
  Lisp_Object val;
563 564
  int i, j;
  bool negative;
565 566 567

  if (! spec)
    return NULL;
568
  spec->script = XCAR (otf_spec);
569
  if (! NILP (spec->script))
570 571 572 573 574 575 576 577
    {
      OTF_SYM_TAG (spec->script, spec->script_tag);
      val = assq_no_quit (spec->script, Votf_script_alist);
      if (CONSP (val) && SYMBOLP (XCDR (val)))
	spec->script = XCDR (val);
      else
	spec->script = Qnil;
    }
578
  else
579
    spec->script_tag = 0x44464C54; 	/* "DFLT" */
580
  otf_spec = XCDR (otf_spec);
Kenichi Handa's avatar
Kenichi Handa committed
581 582 583 584 585 586 587 588
  spec->langsys_tag = 0;
  if (! NILP (otf_spec))
    {
      val = XCAR (otf_spec);
      if (! NILP (val))
	OTF_SYM_TAG (val, spec->langsys_tag);
      otf_spec = XCDR (otf_spec);
    }
589
  spec->nfeatures[0] = spec->nfeatures[1] = 0;
Kenichi Handa's avatar
Kenichi Handa committed
590
  for (i = 0; i < 2 && ! NILP (otf_spec); i++, otf_spec = XCDR (otf_spec))
591 592 593 594
    {
      val = XCAR (otf_spec);
      if (NILP (val))
	continue;
Paul Eggert's avatar
Paul Eggert committed
595
      ptrdiff_t len = list_length (val);
596
      spec->features[i] =
Paul Eggert's avatar
Paul Eggert committed
597
	(min (PTRDIFF_MAX, SIZE_MAX) / sizeof (int) < len
598
	 ? 0
Paul Eggert's avatar
Paul Eggert committed
599
	 : malloc (len * sizeof *spec->features[i]));
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
      if (! spec->features[i])
	{
	  if (i > 0 && spec->features[0])
	    free (spec->features[0]);
	  free (spec);
	  return NULL;
	}
      for (j = 0, negative = 0; CONSP (val); val = XCDR (val))
	{
	  if (NILP (XCAR (val)))
	    negative = 1;
	  else
	    {
	      unsigned int tag;

	      OTF_SYM_TAG (XCAR (val), tag);
	      spec->features[i][j++] = negative ? tag & 0x80000000 : tag;
	    }
	}
      spec->nfeatures[i] = j;
    }
  return spec;
}

624
static FcPattern *
625
ftfont_spec_pattern (Lisp_Object spec, char *otlayout, struct OpenTypeSpec **otspec, const char **langname)
Kenichi Handa's avatar
Kenichi Handa committed
626
{
Kenichi Handa's avatar
Kenichi Handa committed
627
  Lisp_Object tmp, extra;
Kenichi Handa's avatar
Kenichi Handa committed
628 629 630
  FcPattern *pattern = NULL;
  FcCharSet *charset = NULL;
  FcLangSet *langset = NULL;
631 632
  int n;
  int dpi = -1;
633
  int scalable = -1;
634
  Lisp_Object script = Qnil;
Kenichi Handa's avatar
Kenichi Handa committed
635
  Lisp_Object registry;
636
  int fc_charset_idx;
Kenichi Handa's avatar
Kenichi Handa committed
637

638 639
  if ((n = FONT_SLANT_NUMERIC (spec)) >= 0
      && n < 100)
Paul Eggert's avatar
Paul Eggert committed
640
    /* Fontconfig doesn't support reverse-italic/oblique.  */
641 642
    return NULL;

643
  if (FIXNUMP (AREF (spec, FONT_DPI_INDEX)))
Tom Tromey's avatar
Tom Tromey committed
644
    dpi = XFIXNUM (AREF (spec, FONT_DPI_INDEX));
645
  if (FIXNUMP (AREF (spec, FONT_AVGWIDTH_INDEX))
Tom Tromey's avatar
Tom Tromey committed
646
      && XFIXNUM (AREF (spec, FONT_AVGWIDTH_INDEX)) == 0)
647
    scalable = 1;
648

Kenichi Handa's avatar
Kenichi Handa committed
649 650
  registry = AREF (spec, FONT_REGISTRY_INDEX);
  if (NILP (registry)
651
      || EQ (registry, Qascii_0)
Kenichi Handa's avatar
Kenichi Handa committed
652
      || EQ (registry, Qiso10646_1)
653
      || EQ (registry, Qunicode_bmp))
654
    fc_charset_idx = -1;
Kenichi Handa's avatar
Kenichi Handa committed
655
  else
Kenichi Handa's avatar
Kenichi Handa committed
656
    {
657 658
      FcChar8 *lang;

659 660
      fc_charset_idx = ftfont_get_charset (registry);
      if (fc_charset_idx < 0)
661
	return NULL;
662
      charset = fc_charset_table[fc_charset_idx].fc_charset;
663 664
      *langname = fc_charset_table[fc_charset_idx].lang;
      lang = (FcChar8 *) *langname;
665 666 667 668 669 670 671
      if (lang)
	{
	  langset = FcLangSetCreate ();
	  if (! langset)
	    goto err;
	  FcLangSetAdd (langset, lang);
	}
Kenichi Handa's avatar
Kenichi Handa committed
672 673
    }

674
  otlayout[0] = '\0';
675 676
  for (extra = AREF (spec, FONT_EXTRA_INDEX);
       CONSP (extra); extra = XCDR (extra))
Kenichi Handa's avatar
Kenichi Handa committed
677
    {
678 679
      Lisp_Object key, val;

680 681
      key = XCAR (XCAR (extra)), val = XCDR (XCAR (extra));
      if (EQ (key, QCdpi))
682
	{
683
	  if (FIXNUMP (val))
Tom Tromey's avatar
Tom Tromey committed
684
	    dpi = XFIXNUM (val);
685
	}
686
      else if (EQ (key, QClang))
Kenichi Handa's avatar
Kenichi Handa committed
687
	{
688 689
	  if (! langset)
	    langset = FcLangSetCreate ();
Kenichi Handa's avatar
Kenichi Handa committed
690 691
	  if (! langset)
	    goto err;
692
	  if (SYMBOLP (val))
Kenichi Handa's avatar
Kenichi Handa committed
693
	    {
694
	      if (! FcLangSetAdd (langset, SYMBOL_FcChar8 (val)))
Kenichi Handa's avatar
Kenichi Handa committed
695 696 697
		goto err;
	    }
	  else
698 699 700 701
	    for (; CONSP (val); val = XCDR (val))
	      if (SYMBOLP (XCAR (val))
		  && ! FcLangSetAdd (langset, SYMBOL_FcChar8 (XCAR (val))))
		goto err;
Kenichi Handa's avatar
Kenichi Handa committed
702
	}
703 704
      else if (EQ (key, QCotf))
	{
705 706 707 708 709
	  if (CONSP (val))
	    {
	      *otspec = ftfont_get_open_type_spec (val);
	      if (! *otspec)
		return NULL;
710
	      strcpy (otlayout, "otlayout:");
711 712 713
	      OTF_TAG_STR ((*otspec)->script_tag, otlayout + 9);
	      script = (*otspec)->script;
	    }
714
	}
715 716 717 718 719
      else if (EQ (key, QCscript))
	script = val;
      else if (EQ (key, QCscalable))
	scalable = ! NILP (val);
    }
Kenichi Handa's avatar
Kenichi Handa committed
720

721 722 723 724
  if (! NILP (script) && ! charset)
    {
      Lisp_Object chars = assq_no_quit (script, Vscript_representative_chars);

725
      if (CONSP (chars) && CONSP (CDR (chars)))
726 727 728 729 730 731
	{
	  charset = FcCharSetCreate ();
	  if (! charset)
	    goto err;
	  for (chars = XCDR (chars); CONSP (chars); chars = XCDR (chars))
	    if (CHARACTERP (XCAR (chars))
Tom Tromey's avatar
Tom Tromey committed
732
		&& ! FcCharSetAddChar (charset, XFIXNAT (XCAR (chars))))
733
	      goto err;
Kenichi Handa's avatar
Kenichi Handa committed
734 735 736
	}
    }

737
  pattern = FcPatternCreate ();
738 739 740
  if (! pattern)
    goto err;
  tmp = AREF (spec, FONT_FOUNDRY_INDEX);
741
  if (! NILP (tmp)
742 743
      && ! FcPatternAddString (pattern, FC_FOUNDRY, SYMBOL_FcChar8 (tmp)))
    goto err;
744 745 746 747
  tmp = AREF (spec, FONT_FAMILY_INDEX);
  if (! NILP (tmp)
      && ! FcPatternAddString (pattern, FC_FAMILY, SYMBOL_FcChar8 (tmp)))
    goto err;
Kenichi Handa's avatar
Kenichi Handa committed
748 749 750 751 752 753
  if (charset
      && ! FcPatternAddCharSet (pattern, FC_CHARSET, charset))
    goto err;
  if (langset
      && ! FcPatternAddLangSet (pattern, FC_LANG, langset))
    goto err;
754 755 756 757
  if (dpi >= 0
      && ! FcPatternAddDouble (pattern, FC_DPI, dpi))
    goto err;
  if (scalable >= 0
Kenichi Handa's avatar
Kenichi Handa committed
758
      && ! FcPatternAddBool (pattern, FC_SCALABLE, scalable ? FcTrue : FcFalse))
759
    goto err;
760
#if defined HAVE_XFT && defined FC_COLOR
761 762 763
  /* We really don't like color fonts, they cause Xft crashes.  See
     Bug#30874.  */
  if (Vxft_ignore_color_fonts
764
      && ! FcPatternAddBool (pattern, FC_COLOR, FcFalse))
765 766
    goto err;
#endif
767

768
  goto finish;
Kenichi Handa's avatar
Kenichi Handa committed
769

770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
 err:
  /* We come here because of unexpected error in fontconfig API call
     (usually insufficient memory).  */
  if (pattern)
    {
      FcPatternDestroy (pattern);
      pattern = NULL;
    }
  if (*otspec)
    {
      if ((*otspec)->nfeatures[0] > 0)
	free ((*otspec)->features[0]);
      if ((*otspec)->nfeatures[1] > 0)
	free ((*otspec)->features[1]);
      free (*otspec);
      *otspec = NULL;
    }

 finish:
  if (langset) FcLangSetDestroy (langset);
790
  if (charset && fc_charset_idx < 0) FcCharSetDestroy (charset);
791 792 793
  return pattern;
}

794
static Lisp_Object
795
ftfont_list (struct frame *f, Lisp_Object spec)
796
{
Kenichi Handa's avatar
Kenichi Handa committed
797
  Lisp_Object val = Qnil, family, adstyle;
798 799 800 801
  int i;
  FcPattern *pattern;
  FcFontSet *fontset = NULL;
  FcObjectSet *objset = NULL;
802 803
  FcCharSet *charset;
  Lisp_Object chars = Qnil;
804 805
  char otlayout[15];		/* For "otlayout:XXXX" */
  struct OpenTypeSpec *otspec = NULL;
806
  int spacing = -1;
807
  const char *langname = NULL;
Juanma Barranquero's avatar
Juanma Barranquero committed
808

809 810 811 812 813 814
  if (! fc_initialized)
    {
      FcInit ();
      fc_initialized = 1;
    }

815
  pattern = ftfont_spec_pattern (spec, otlayout, &otspec, &langname);
816 817
  if (! pattern)
    return Qnil;
818 819 820 821 822 823 824 825 826 827 828
  if (FcPatternGetCharSet (pattern, FC_CHARSET, 0, &charset) != FcResultMatch)
    {
      val = assq_no_quit (QCscript, AREF (spec, FONT_EXTRA_INDEX));
      if (! NILP (val))
	{
	  val = assq_no_quit (XCDR (val), Vscript_representative_chars);
	  if (CONSP (val) && VECTORP (XCDR (val)))
	    chars = XCDR (val);
	}
      val = Qnil;
    }
829
  if (FIXNUMP (AREF (spec, FONT_SPACING_INDEX)))
Tom Tromey's avatar
Tom Tromey committed
830
    spacing = XFIXNUM (AREF (spec, FONT_SPACING_INDEX));
831 832 833 834 835
  family = AREF (spec, FONT_FAMILY_INDEX);
  if (! NILP (family))
    {
      Lisp_Object resolved;

836
      resolved = ftfont_resolve_generic_family (family, pattern);
837 838 839 840 841 842 843 844
      if (! NILP (resolved))
	{
	  FcPatternDel (pattern, FC_FAMILY);
	  if (! FcPatternAddString (pattern, FC_FAMILY,
				    SYMBOL_FcChar8 (resolved)))
	    goto err;
	}
    }
Kenichi Handa's avatar
Kenichi Handa committed
845 846 847
  adstyle = AREF (spec, FONT_ADSTYLE_INDEX);
  if (! NILP (adstyle) && SBYTES (SYMBOL_NAME (adstyle)) == 0)
    adstyle = Qnil;
848
  objset = FcObjectSetBuild (FC_FOUNDRY, FC_FAMILY, FC_WEIGHT, FC_SLANT,
849
			     FC_WIDTH, FC_PIXEL_SIZE, FC_SPACING, FC_SCALABLE,
Kenichi Handa's avatar
Kenichi Handa committed
850
			     FC_STYLE, FC_FILE, FC_INDEX,
851 852 853
#ifdef FC_CAPABILITY
			     FC_CAPABILITY,
#endif	/* FC_CAPABILITY */
854 855 856
#ifdef FC_FONTFORMAT
			     FC_FONTFORMAT,
#endif
857
			     NULL);
858 859
  if (! objset)
    goto err;
860 861
  if (! NILP (chars))
    FcObjectSetAdd (objset, FC_CHARSET);
862

863
  fontset = FcFontList (NULL, pattern, objset);
864 865
  if (! fontset || fontset->nfont == 0)
    goto finish;
866 867 868 869
#if 0
  /* Need fix because this finds any fonts.  */
  if (fontset->nfont == 0 && ! NILP (family))
    {
Paul Eggert's avatar
Paul Eggert committed
870
      /* Try matching with configuration.  For instance, the
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
	 configuration may specify "Nimbus Mono L" as an alias of
	 "Courier".  */
      FcPattern *pat = FcPatternBuild (0, FC_FAMILY, FcTypeString,
				       SYMBOL_FcChar8 (family), NULL);
      FcChar8 *fam;

      if (FcConfigSubstitute (NULL, pat, FcMatchPattern) == FcTrue)
	{
	  for (i = 0;
	       FcPatternGetString (pat, FC_FAMILY, i, &fam) == FcResultMatch;
	       i++)
	    {
	      FcPatternDel (pattern, FC_FAMILY);
	      FcPatternAddString (pattern, FC_FAMILY, fam);
	      FcFontSetDestroy (fontset);
	      fontset = FcFontList (NULL, pattern, objset);
887
	      if (fontset && fontset->nfont > 0)
888 889 890 891 892
		break;
	    }
	}
    }
#endif
893
  for (i = 0; i < fontset->nfont; i++)
894
    {
895
      Lisp_Object entity;
896

897 898 899 900 901 902 903 904 905 906
      if (spacing >= 0)
	{
	  int this;

	  if ((FcPatternGetInteger (fontset->fonts[i], FC_SPACING, 0, &this)
	       == FcResultMatch)
	      && spacing != this)
	    continue;
	}

907
#ifdef FC_CAPABILITY
908 909 910
      if (otlayout[0])
	{
	  FcChar8 *this;
911

912 913
	  if (FcPatternGetString (fontset->fonts[i], FC_CAPABILITY, 0, &this)
	      != FcResultMatch
914 915 916
	      || ! strstr ((char *) this, otlayout))
	    continue;
	}
917
#endif	/* FC_CAPABILITY */
918
#ifdef HAVE_LIBOTF
919 920 921
      if (otspec)
	{
	  FcChar8 *file;
922
	  bool passed;
923 924 925 926 927 928 929 930
	  OTF *otf;

	  if (FcPatternGetString (fontset->fonts[i], FC_FILE, 0, &file)
	      != FcResultMatch)
	    continue;
	  otf = OTF_open ((char *) file);
	  if (! otf)
	    continue;
931 932 933 934 935 936 937 938 939 940
	  passed = (OTF_check_features (otf, 1, otspec->script_tag,
					otspec->langsys_tag,
					otspec->features[0],
					otspec->nfeatures[0]) == 1
		    && OTF_check_features (otf, 0, otspec->script_tag,
					   otspec->langsys_tag,
					   otspec->features[1],
					   otspec->nfeatures[1]) == 1);
	  OTF_close (otf);
	  if (!passed)
941
	    continue;
Kenichi Handa's avatar
Kenichi Handa committed
942
	}
943
#endif	/* HAVE_LIBOTF */
944 945
      if (VECTORP (chars))
	{
946
	  ptrdiff_t j;
947 948 949 950 951

	  if (FcPatternGetCharSet (fontset->fonts[i], FC_CHARSET, 0, &charset)
	      != FcResultMatch)
	    continue;
	  for (j = 0; j < ASIZE (chars); j++)
952
	    if (TYPE_RANGED_FIXNUMP (FcChar32, AREF (chars, j))
Tom Tromey's avatar
Tom Tromey committed
953
		&& FcCharSetHasChar (charset, XFIXNAT (AREF (chars, j))))
954 955 956 957
	      break;
	  if (j == ASIZE (chars))
	    continue;
	}
958
      if (! NILP (adstyle) || langname)
Kenichi Handa's avatar
Kenichi Handa committed
959 960 961
	{
	  Lisp_Object this_adstyle = get_adstyle_property (fontset->fonts[i]);

962 963
	  if (! NILP (adstyle)
	      && (NILP (this_adstyle)
964 965
		  || xstrcasecmp (SSDATA (SYMBOL_NAME (adstyle)),
				  SSDATA (SYMBOL_NAME (this_adstyle))) != 0))
966 967 968
	    continue;
	  if (langname
	      && ! NILP (this_adstyle)
969
	      && xstrcasecmp (langname, SSDATA (SYMBOL_NAME (this_adstyle))))
Kenichi Handa's avatar
Kenichi Handa committed
970 971
	    continue;
	}
972 973
      entity = ftfont_pattern_entity (fontset->fonts[i],
				      AREF (spec, FONT_EXTRA_INDEX));
974 975
      if (! NILP (entity))
	val = Fcons (entity, val);
Kenichi Handa's avatar
Kenichi Handa committed
976
    }
977
  val = Fnreverse (val);
Kenichi Handa's avatar
Kenichi Handa committed
978 979 980 981
  goto finish;

 err:
  /* We come here because of unexpected error in fontconfig API call
982
     (usually insufficient memory).  */
Kenichi Handa's avatar
Kenichi Handa committed
983 984 985
  val = Qnil;

 finish:
986
  FONT_ADD_LOG ("ftfont-list", spec, val);
Kenichi Handa's avatar
Kenichi Handa committed
987 988 989 990 991 992
  if (objset) FcObjectSetDestroy (objset);
  if (fontset) FcFontSetDestroy (fontset);
  if (pattern) FcPatternDestroy (pattern);
  return val;
}

993
Lisp_Object
994 995 996 997 998 999 1000 1001 1002 1003
ftfont_list2 (struct frame *f, Lisp_Object spec, Lisp_Object type)
{
  Lisp_Object list = ftfont_list (f, spec);

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

static Lisp_Object
1004
ftfont_match (struct frame *f, Lisp_Object spec)
1005
{
1006
  Lisp_Object entity = Qnil;
1007
  FcPattern *pattern, *match = NULL;
1008
  FcResult result;
1009 1010
  char otlayout[15];		/* For "otlayout:XXXX" */
  struct OpenTypeSpec *otspec = NULL;
1011
  const char *langname = NULL;
1012 1013 1014 1015 1016 1017 1018

  if (! fc_initialized)
    {
      FcInit ();
      fc_initialized = 1;
    }

1019
  pattern = ftfont_spec_pattern (spec, otlayout, &otspec, &langname);
1020
  if (! pattern)
1021 1022
    return Qnil;

1023
  if (FIXNUMP (AREF (spec, FONT_SIZE_INDEX)))
1024
    {
1025
      FcValue value;
1026

1027
      value.type = FcTypeDouble;
Tom Tromey's avatar
Tom Tromey committed
1028
      value.u.d = XFIXNUM (AREF (spec, FONT_SIZE_INDEX));
1029 1030 1031 1032 1033 1034 1035
      FcPatternAdd (pattern, FC_PIXEL_SIZE, value, FcFalse);
    }
  if (FcConfigSubstitute (NULL, pattern, FcMatchPattern) == FcTrue)
    {
      FcDefaultSubstitute (pattern);
      match = FcFontMatch (NULL, pattern, &result);
      if (match)
1036
	{
1037
	  entity = ftfont_pattern_entity (match, AREF (spec, FONT_EXTRA_INDEX));
1038 1039 1040 1041 1042 1043 1044
	  FcPatternDestroy (match);
	  if (! NILP (AREF (spec, FONT_FAMILY_INDEX))
	      && NILP (assq_no_quit (AREF (spec, FONT_FAMILY_INDEX),
				     ftfont_generic_family_list))
	      && NILP (Fstring_equal (AREF (spec, FONT_FAMILY_INDEX),
				      AREF (entity, FONT_FAMILY_INDEX))))
	    entity = Qnil;
1045 1046
	}
    }
1047
  FcPatternDestroy (pattern);
1048

1049
  FONT_ADD_LOG ("ftfont-match", spec, entity);
1050 1051 1052
  return entity;
}

1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
Lisp_Object
ftfont_match2 (struct frame *f, Lisp_Object spec, Lisp_Object type)
{
  Lisp_Object entity = ftfont_match (f, spec);

  if (! NILP (entity))
    ASET (entity, FONT_TYPE_INDEX, type);
  return entity;
}

1063
Lisp_Object
1064
ftfont_list_family (struct frame *f)
Kenichi Handa's avatar
Kenichi Handa committed
1065
{