ftfont.c 71 KB
Newer Older
Kenichi Handa's avatar
Kenichi Handa committed
1
/* ftfont.c -- FreeType font driver.
2
   Copyright (C) 2006-2014 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 <http://www.gnu.org/licenses/>.  */
Kenichi Handa's avatar
Kenichi Handa committed
21 22 23 24 25 26 27 28 29 30 31 32 33

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

#include "lisp.h"
#include "dispextern.h"
#include "frame.h"
#include "blockinput.h"
#include "character.h"
#include "charset.h"
#include "coding.h"
Kenichi Handa's avatar
Kenichi Handa committed
34
#include "composite.h"
Kenichi Handa's avatar
Kenichi Handa committed
35 36
#include "fontset.h"
#include "font.h"
37
#include "ftfont.h"
Kenichi Handa's avatar
Kenichi Handa committed
38

39
/* Symbolic type of this font-driver.  */
40
static Lisp_Object Qfreetype;
Kenichi Handa's avatar
Kenichi Handa committed
41

42 43 44
/* Fontconfig's generic families and their aliases.  */
static Lisp_Object Qmonospace, Qsans_serif, Qserif, Qmono, Qsans, Qsans__serif;

Juanma Barranquero's avatar
Juanma Barranquero committed
45
/* Flag to tell if FcInit is already called or not.  */
46
static bool fc_initialized;
47 48

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

51
/* Cache for FreeType fonts.  */
Kenichi Handa's avatar
Kenichi Handa committed
52 53
static Lisp_Object freetype_font_cache;

54
/* Cache for FT_Face and FcCharSet. */
Kenichi Handa's avatar
Kenichi Handa committed
55
static Lisp_Object ft_face_cache;
Kenichi Handa's avatar
Kenichi Handa committed
56

Paul Eggert's avatar
Paul Eggert committed
57
/* The actual structure for FreeType font that can be cast to struct
Kenichi Handa's avatar
Kenichi Handa committed
58 59 60 61 62
   font.  */

struct ftfont_info
{
  struct font font;
63
#ifdef HAVE_LIBOTF
64
  /* The following four members must be here in this order to be
65
     compatible with struct xftfont_info (in xftfont.c).  */
66
  bool maybe_otf;	/* Flag to tell if this may be OTF or not.  */
67 68
  OTF *otf;
#endif	/* HAVE_LIBOTF */
69 70
  FT_Size ft_size;
  int index;
71
  FT_Matrix matrix;
Kenichi Handa's avatar
Kenichi Handa committed
72 73
};

74 75 76 77 78 79 80
enum ftfont_cache_for
  {
    FTFONT_CACHE_FOR_FACE,
    FTFONT_CACHE_FOR_CHARSET,
    FTFONT_CACHE_FOR_ENTITY
  };

81
static Lisp_Object ftfont_pattern_entity (FcPattern *, Lisp_Object);
Kenichi Handa's avatar
Kenichi Handa committed
82

83 84 85 86
static Lisp_Object ftfont_resolve_generic_family (Lisp_Object,
                                                  FcPattern *);
static Lisp_Object ftfont_lookup_cache (Lisp_Object,
                                        enum ftfont_cache_for);
87

88
static void ftfont_filter_properties (Lisp_Object font, Lisp_Object alist);
89

90 91
#define SYMBOL_FcChar8(SYM) (FcChar8 *) SDATA (SYMBOL_NAME (SYM))

Kenichi Handa's avatar
Kenichi Handa committed
92
static struct
Kenichi Handa's avatar
Kenichi Handa committed
93
{
94
  /* registry name */
95
  const char *name;
Kenichi Handa's avatar
Kenichi Handa committed
96 97
  /* characters to distinguish the charset from the others */
  int uniquifier[6];
98
  /* additional constraint by language */
99
  const char *lang;
Kenichi Handa's avatar
Kenichi Handa committed
100 101 102
  /* set on demand */
  FcCharSet *fc_charset;
} fc_charset_table[] =
103
  { { "iso8859-1", { 0x00A0, 0x00A1, 0x00B4, 0x00BC, 0x00D0 } },
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
    { "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"},
136 137
    { "windows-1251", { 0x0401, 0x0490 }, "ru"},
    { "koi8-r", { 0x0401, 0x2219 }, "ru"},
138
    { "mulelao-1", { 0x0E81 }, "lo"},
139
    { "unicode-sip", { 0x20000 }},
Kenichi Handa's avatar
Kenichi Handa committed
140 141
    { NULL }
  };
Kenichi Handa's avatar
Kenichi Handa committed
142

Kenichi Handa's avatar
Kenichi Handa committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
/* 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)
{
159 160
  FcChar8 *fcstr;
  char *str, *end;
Kenichi Handa's avatar
Kenichi Handa committed
161 162
  Lisp_Object adstyle;

163 164
#ifdef FC_FONTFORMAT
  if ((FcPatternGetString (p, FC_FONTFORMAT, 0, &fcstr) == FcResultMatch)
165 166
      && xstrcasecmp ((char *) fcstr, "bdf") != 0
      && xstrcasecmp ((char *) fcstr, "pcf") != 0)
167 168 169
    /* Not a BDF nor PCF font.  */
    return Qnil;
#endif
170
  if (FcPatternGetString (p, FC_STYLE, 0, &fcstr) != FcResultMatch)
Kenichi Handa's avatar
Kenichi Handa committed
171
    return Qnil;
172
  str = (char *) fcstr;
Kenichi Handa's avatar
Kenichi Handa committed
173 174 175
  for (end = str; *end && *end != ' '; end++);
  if (*end)
    {
176 177 178 179 180
      char *newstr = alloca (end - str + 1);
      memcpy (newstr, str, end - str);
      newstr[end - str] = '\0';
      end = newstr + (end - str);
      str = newstr;
Kenichi Handa's avatar
Kenichi Handa committed
181 182 183 184 185 186
    }
  if (xstrcasecmp (str, "Regular") == 0
      || xstrcasecmp (str, "Bold") == 0
      || xstrcasecmp (str, "Oblique") == 0
      || xstrcasecmp (str, "Italic") == 0)
    return Qnil;
187
  adstyle = font_intern_prop (str, end - str, 1);
Kenichi Handa's avatar
Kenichi Handa committed
188 189 190 191 192
  if (font_style_to_value (FONT_WIDTH_INDEX, adstyle, 0) >= 0)
    return Qnil;
  return adstyle;
}

193
static Lisp_Object
194
ftfont_pattern_entity (FcPattern *p, Lisp_Object extra)
195
{
196
  Lisp_Object key, cache, entity;
197 198
  FcChar8 *str;
  char *file;
199
  int idx;
200 201
  int numeric;
  double dbl;
202
  FcBool b;
203

204
  if (FcPatternGetString (p, FC_FILE, 0, &str) != FcResultMatch)
205
    return Qnil;
206
  if (FcPatternGetInteger (p, FC_INDEX, 0, &idx) != FcResultMatch)
207
    return Qnil;
208

209
  file = (char *) str;
210
  key = Fcons (build_unibyte_string (file), make_number (idx));
211 212 213
  cache = ftfont_lookup_cache (key, FTFONT_CACHE_FOR_ENTITY);
  entity = XCAR (cache);
  if (! NILP (entity))
214 215 216 217 218 219
    {
      Lisp_Object val = font_make_entity ();
      int i;

      for (i = 0; i < FONT_OBJLIST_INDEX; i++)
	ASET (val, i, AREF (entity, i));
220 221 222 223

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

224 225
      return val;
    }
226
  entity = font_make_entity ();
227
  XSETCAR (cache, entity);
228 229

  ASET (entity, FONT_TYPE_INDEX, Qfreetype);
230
  ASET (entity, FONT_REGISTRY_INDEX, Qiso10646_1);
231

232 233 234 235 236 237 238 239 240 241
  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));
    }
242
  if (FcPatternGetInteger (p, FC_WEIGHT, 0, &numeric) == FcResultMatch)
243
    {
244 245 246
      if (numeric >= FC_WEIGHT_REGULAR && numeric < FC_WEIGHT_MEDIUM)
	numeric = FC_WEIGHT_MEDIUM;
      FONT_SET_STYLE (entity, FONT_WEIGHT_INDEX, make_number (numeric));
247
    }
248
  if (FcPatternGetInteger (p, FC_SLANT, 0, &numeric) == FcResultMatch)
249 250 251 252
    {
      numeric += 100;
      FONT_SET_STYLE (entity, FONT_SLANT_INDEX, make_number (numeric));
    }
253
  if (FcPatternGetInteger (p, FC_WIDTH, 0, &numeric) == FcResultMatch)
254 255 256
    {
      FONT_SET_STYLE (entity, FONT_WIDTH_INDEX, make_number (numeric));
    }
257
  if (FcPatternGetDouble (p, FC_PIXEL_SIZE, 0, &dbl) == FcResultMatch)
Kenichi Handa's avatar
Kenichi Handa committed
258 259 260
    {
      ASET (entity, FONT_SIZE_INDEX, make_number (dbl));
    }
261 262
  else
    ASET (entity, FONT_SIZE_INDEX, make_number (0));
263 264 265 266 267 268 269 270 271
  if (FcPatternGetInteger (p, FC_SPACING, 0, &numeric) == FcResultMatch)
    ASET (entity, FONT_SPACING_INDEX, make_number (numeric));
  if (FcPatternGetDouble (p, FC_DPI, 0, &dbl) == FcResultMatch)
    {
      int dpi = dbl;
      ASET (entity, FONT_DPI_INDEX, make_number (dpi));
    }
  if (FcPatternGetBool (p, FC_SCALABLE, 0, &b) == FcResultMatch
      && b == FcTrue)
272 273 274 275 276 277
    {
      ASET (entity, FONT_SIZE_INDEX, make_number (0));
      ASET (entity, FONT_AVGWIDTH_INDEX, make_number (0));
    }
  else
    {
Paul Eggert's avatar
Paul Eggert committed
278
      /* As this font is not scalable, perhaps this is a BDF or PCF
279
	 font. */
280 281 282 283
      FT_Face ft_face;

      ASET (entity, FONT_ADSTYLE_INDEX, get_adstyle_property (p));
      if ((ft_library || FT_Init_FreeType (&ft_library) == 0)
284
	  && FT_New_Face (ft_library, file, idx, &ft_face) == 0)
285 286 287 288 289 290 291 292 293
	{
	  BDF_PropertyRec rec;

	  if (FT_Get_BDF_Property (ft_face, "AVERAGE_WIDTH", &rec) == 0
	      && rec.type == BDF_PROPERTY_TYPE_INTEGER)
	    ASET (entity, FONT_AVGWIDTH_INDEX, make_number (rec.u.integer));
	  FT_Done_Face (ft_face);
	}
    }
294

295
  ASET (entity, FONT_EXTRA_INDEX, Fcopy_sequence (extra));
296
  font_put_extra (entity, QCfont_entity, key);
297 298 299
  return entity;
}

300

301 302 303
static Lisp_Object ftfont_generic_family_list;

static Lisp_Object
304
ftfont_resolve_generic_family (Lisp_Object family, FcPattern *pattern)
305
{
306
  Lisp_Object slot;
307
  FcPattern *match;
308
  FcResult result;
Kenichi Handa's avatar
Kenichi Handa committed
309
  FcLangSet *langset;
310

311
  family = Fintern (Fdowncase (SYMBOL_NAME (family)), Qnil);
312 313 314 315 316 317
  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))
318
    return Qnil;
319 320
  if (! EQ (XCDR (slot), Qt))
    return XCDR (slot);
321
  pattern = FcPatternDuplicate (pattern);
322 323
  if (! pattern)
    goto err;
324
  FcPatternDel (pattern, FC_FOUNDRY);
325 326
  FcPatternDel (pattern, FC_FAMILY);
  FcPatternAddString (pattern, FC_FAMILY, SYMBOL_FcChar8 (family));
Kenichi Handa's avatar
Kenichi Handa committed
327 328 329
  if (FcPatternGetLangSet (pattern, FC_LANG, 0, &langset) != FcResultMatch)
    {
      /* This is to avoid the effect of locale.  */
330
      static const FcChar8 lang[] = "en";
Kenichi Handa's avatar
Kenichi Handa committed
331
      langset = FcLangSetCreate ();
332
      FcLangSetAdd (langset, lang);
Kenichi Handa's avatar
Kenichi Handa committed
333 334 335
      FcPatternAddLangSet (pattern, FC_LANG, langset);
      FcLangSetDestroy (langset);
    }
336
  FcConfigSubstitute (NULL, pattern, FcMatchPattern);
337 338 339
  FcDefaultSubstitute (pattern);
  match = FcFontMatch (NULL, pattern, &result);
  if (match)
340
    {
341 342 343 344
      FcChar8 *fam;

      if (FcPatternGetString (match, FC_FAMILY, 0, &fam) == FcResultMatch)
	family = intern ((char *) fam);
345
    }
346 347 348 349
  else
    family = Qnil;
  XSETCDR (slot, family);
  if (match) FcPatternDestroy (match);
350
 err:
351
  if (pattern) FcPatternDestroy (pattern);
352
  return family;
353 354
}

355 356 357 358 359 360 361
struct ftfont_cache_data
{
  FT_Face ft_face;
  FcCharSet *fc_charset;
};

static Lisp_Object
362
ftfont_lookup_cache (Lisp_Object key, enum ftfont_cache_for cache_for)
Kenichi Handa's avatar
Kenichi Handa committed
363
{
Kenichi Handa's avatar
Kenichi Handa committed
364
  Lisp_Object cache, val, entity;
365
  struct ftfont_cache_data *cache_data;
Kenichi Handa's avatar
Kenichi Handa committed
366

Kenichi Handa's avatar
Kenichi Handa committed
367 368 369 370
  if (FONT_ENTITY_P (key))
    {
      entity = key;
      val = assq_no_quit (QCfont_entity, AREF (entity, FONT_EXTRA_INDEX));
371
      eassert (CONSP (val));
Kenichi Handa's avatar
Kenichi Handa committed
372 373 374 375 376
      key = XCDR (val);
    }
  else
    entity = Qnil;

377 378 379 380
  if (NILP (ft_face_cache))
    cache = Qnil;
  else
    cache = Fgethash (key, ft_face_cache, Qnil);
Kenichi Handa's avatar
Kenichi Handa committed
381 382
  if (NILP (cache))
    {
383 384 385 386 387 388 389 390
      if (NILP (ft_face_cache))
	{
	  Lisp_Object args[2];

	  args[0] = QCtest;
	  args[1] = Qequal;
	  ft_face_cache = Fmake_hash_table (2, args);
	}
391
      cache_data = xmalloc (sizeof *cache_data);
392 393
      cache_data->ft_face = NULL;
      cache_data->fc_charset = NULL;
394
      val = make_save_ptr_int (cache_data, 0);
395 396
      cache = Fcons (Qnil, val);
      Fputhash (key, cache, ft_face_cache);
Kenichi Handa's avatar
Kenichi Handa committed
397 398 399
    }
  else
    {
400
      val = XCDR (cache);
401
      cache_data = XSAVE_POINTER (val, 0);
402
    }
403 404 405 406 407 408

  if (cache_for == FTFONT_CACHE_FOR_ENTITY)
    return cache;

  if (cache_for == FTFONT_CACHE_FOR_FACE
      ? ! cache_data->ft_face : ! cache_data->fc_charset)
409
    {
410
      char *filename = SSDATA (XCAR (key));
411
      int idx = XINT (XCDR (key));
Kenichi Handa's avatar
Kenichi Handa committed
412

413
      if (cache_for == FTFONT_CACHE_FOR_FACE)
414 415 416 417
	{
	  if (! ft_library
	      && FT_Init_FreeType (&ft_library) != 0)
	    return Qnil;
418
	  if (FT_New_Face (ft_library, filename, idx, &cache_data->ft_face)
419 420 421 422 423
	      != 0)
	    return Qnil;
	}
      else
	{
Kenichi Handa's avatar
Kenichi Handa committed
424 425 426 427
	  FcPattern *pat = NULL;
	  FcFontSet *fontset = NULL;
	  FcObjectSet *objset = NULL;
	  FcCharSet *charset = NULL;
428 429

	  pat = FcPatternBuild (0, FC_FILE, FcTypeString, (FcChar8 *) filename,
430
				FC_INDEX, FcTypeInteger, idx, NULL);
Kenichi Handa's avatar
Kenichi Handa committed
431 432 433 434 435
	  if (! pat)
	    goto finish;
	  objset = FcObjectSetBuild (FC_CHARSET, FC_STYLE, NULL);
	  if (! objset)
	    goto finish;
436
	  fontset = FcFontList (NULL, pat, objset);
Kenichi Handa's avatar
Kenichi Handa committed
437 438
	  if (! fontset)
	    goto finish;
439 440
	  if (fontset && fontset->nfont > 0
	      && (FcPatternGetCharSet (fontset->fonts[0], FC_CHARSET, 0,
441
				       &charset)
442 443
		  == FcResultMatch))
	    cache_data->fc_charset = FcCharSetCopy (charset);
444 445
	  else
	    cache_data->fc_charset = FcCharSetCreate ();
Kenichi Handa's avatar
Kenichi Handa committed
446 447 448 449 450 451 452 453

	finish:
	  if (fontset)
	    FcFontSetDestroy (fontset);
	  if (objset)
	    FcObjectSetDestroy (objset);
	  if (pat)
	    FcPatternDestroy (pat);
454
	}
Kenichi Handa's avatar
Kenichi Handa committed
455 456 457 458
    }
  return cache;
}

459
FcCharSet *
460
ftfont_get_fc_charset (Lisp_Object entity)
461 462 463 464
{
  Lisp_Object val, cache;
  struct ftfont_cache_data *cache_data;

465
  cache = ftfont_lookup_cache (entity, FTFONT_CACHE_FOR_CHARSET);
466
  val = XCDR (cache);
467
  cache_data = XSAVE_POINTER (val, 0);
468 469 470 471 472
  return cache_data->fc_charset;
}

#ifdef HAVE_LIBOTF
static OTF *
Andreas Schwab's avatar
Andreas Schwab committed
473
ftfont_get_otf (struct ftfont_info *ftfont_info)
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
{
  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;
}
#endif	/* HAVE_LIBOTF */

Dmitry Antipov's avatar
Dmitry Antipov committed
494
static Lisp_Object ftfont_get_cache (struct frame *);
495 496 497
static Lisp_Object ftfont_list (struct frame *, Lisp_Object);
static Lisp_Object ftfont_match (struct frame *, Lisp_Object);
static Lisp_Object ftfont_list_family (struct frame *);
Dmitry Antipov's avatar
Dmitry Antipov committed
498
static Lisp_Object ftfont_open (struct frame *, Lisp_Object, int);
499
static void ftfont_close (struct font *);
500 501 502 503 504 505 506 507
static int ftfont_has_char (Lisp_Object, int);
static unsigned ftfont_encode_char (struct font *, int);
static int ftfont_text_extents (struct font *, unsigned *, int,
                                struct font_metrics *);
static int ftfont_get_bitmap (struct font *, unsigned,
                              struct font_bitmap *, int);
static int ftfont_anchor_point (struct font *, unsigned, int,
                                int *, int *);
508
#ifdef HAVE_LIBOTF
509
static Lisp_Object ftfont_otf_capability (struct font *);
510
# ifdef HAVE_M17N_FLT
511
static Lisp_Object ftfont_shape (Lisp_Object);
512 513
# endif
#endif
514 515

#ifdef HAVE_OTF_GET_VARIATION_GLYPHS
516 517
static int ftfont_variation_glyphs (struct font *, int c,
                                    unsigned variations[256]);
518
#endif /* HAVE_OTF_GET_VARIATION_GLYPHS */
Kenichi Handa's avatar
Kenichi Handa committed
519 520 521

struct font_driver ftfont_driver =
  {
522
    LISP_INITIALLY_ZERO,	/* Qfreetype */
523
    0,				/* case insensitive */
Kenichi Handa's avatar
Kenichi Handa committed
524 525
    ftfont_get_cache,
    ftfont_list,
526
    ftfont_match,
Kenichi Handa's avatar
Kenichi Handa committed
527
    ftfont_list_family,
528
    NULL,			/* free_entity */
Kenichi Handa's avatar
Kenichi Handa committed
529 530 531
    ftfont_open,
    ftfont_close,
    /* We can't draw a text without device dependent functions.  */
532 533
    NULL,			/* prepare_face */
    NULL,			/* done_face */
Kenichi Handa's avatar
Kenichi Handa committed
534 535 536 537
    ftfont_has_char,
    ftfont_encode_char,
    ftfont_text_extents,
    /* We can't draw a text without device dependent functions.  */
538
    NULL,			/* draw */
Kenichi Handa's avatar
Kenichi Handa committed
539
    ftfont_get_bitmap,
540
    NULL,			/* free_bitmap */
Kenichi Handa's avatar
Kenichi Handa committed
541
    ftfont_anchor_point,
542 543 544
#ifdef HAVE_LIBOTF
    ftfont_otf_capability,
#else  /* not HAVE_LIBOTF */
Kenichi Handa's avatar
Kenichi Handa committed
545
    NULL,
546
#endif	/* not HAVE_LIBOTF */
547 548 549
    NULL,			/* otf_drive */
    NULL,			/* start_for_frame */
    NULL,			/* end_for_frame */
550
#if defined (HAVE_M17N_FLT) && defined (HAVE_LIBOTF)
551
    ftfont_shape,
552
#else  /* not (HAVE_M17N_FLT && HAVE_LIBOTF) */
553
    NULL,
554
#endif	/* not (HAVE_M17N_FLT && HAVE_LIBOTF) */
555
    NULL,			/* check */
556

557
#ifdef HAVE_OTF_GET_VARIATION_GLYPHS
558
    ftfont_variation_glyphs,
559
#else
560
    NULL,
561
#endif
562 563

    ftfont_filter_properties, /* filter_properties */
Kenichi Handa's avatar
Kenichi Handa committed
564 565 566
  };

static Lisp_Object
Dmitry Antipov's avatar
Dmitry Antipov committed
567
ftfont_get_cache (struct frame *f)
Kenichi Handa's avatar
Kenichi Handa committed
568 569 570 571
{
  return freetype_font_cache;
}

Kenichi Handa's avatar
Kenichi Handa committed
572
static int
573
ftfont_get_charset (Lisp_Object registry)
Kenichi Handa's avatar
Kenichi Handa committed
574
{
575
  char *str = SSDATA (SYMBOL_NAME (registry));
576 577
  char *re = alloca (SBYTES (SYMBOL_NAME (registry)) * 2 + 1);
  Lisp_Object regexp;
Kenichi Handa's avatar
Kenichi Handa committed
578 579
  int i, j;

580 581 582 583 584 585 586 587 588 589 590 591
  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';
  regexp = make_unibyte_string (re, j);
Kenichi Handa's avatar
Kenichi Handa committed
592
  for (i = 0; fc_charset_table[i].name; i++)
593 594 595
    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
596 597 598 599 600
      break;
  if (! fc_charset_table[i].name)
    return -1;
  if (! fc_charset_table[i].fc_charset)
    {
601 602
      FcCharSet *charset = FcCharSetCreate ();
      int *uniquifier = fc_charset_table[i].uniquifier;
Kenichi Handa's avatar
Kenichi Handa committed
603

604 605 606 607 608 609
      if (! charset)
	return -1;
      for (j = 0; uniquifier[j]; j++)
	if (! FcCharSetAddChar (charset, uniquifier[j]))
	  {
	    FcCharSetDestroy (charset);
Kenichi Handa's avatar
Kenichi Handa committed
610
	    return -1;
611 612
	  }
      fc_charset_table[i].fc_charset = charset;
Kenichi Handa's avatar
Kenichi Handa committed
613 614 615 616
    }
  return i;
}

617 618
struct OpenTypeSpec
{
619 620
  Lisp_Object script;
  unsigned int script_tag, langsys_tag;
621 622 623 624
  int nfeatures[2];
  unsigned int *features[2];
};

625
#define OTF_SYM_TAG(SYM, TAG)					\
626
  do {								\
627 628
    unsigned char *p = SDATA (SYMBOL_NAME (SYM));		\
    TAG = (p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3];	\
629 630
  } while (0)

631
#define OTF_TAG_STR(TAG, P)			\
632
  do {						\
633 634 635 636
    (P)[0] = (char) (TAG >> 24);		\
    (P)[1] = (char) ((TAG >> 16) & 0xFF);	\
    (P)[2] = (char) ((TAG >> 8) & 0xFF);	\
    (P)[3] = (char) (TAG & 0xFF);		\
637
    (P)[4] = '\0';				\
638 639
  } while (0)

640
#ifdef HAVE_LIBOTF
641 642 643 644 645 646 647
#define OTF_TAG_SYM(SYM, TAG)			\
  do {						\
    char str[5];				\
    						\
    OTF_TAG_STR (TAG, str);			\
    (SYM) = font_intern_prop (str, 4, 1);	\
  } while (0)
648
#endif
649 650


651 652 653
static struct OpenTypeSpec *
ftfont_get_open_type_spec (Lisp_Object otf_spec)
{
654
  struct OpenTypeSpec *spec = malloc (sizeof *spec);
655
  Lisp_Object val;
656 657
  int i, j;
  bool negative;
658 659 660

  if (! spec)
    return NULL;
661
  spec->script = XCAR (otf_spec);
662
  if (! NILP (spec->script))
663 664 665 666 667 668 669 670
    {
      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;
    }
671
  else
672
    spec->script_tag = 0x44464C54; 	/* "DFLT" */
673
  otf_spec = XCDR (otf_spec);
Kenichi Handa's avatar
Kenichi Handa committed
674 675 676 677 678 679 680 681
  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);
    }
682
  spec->nfeatures[0] = spec->nfeatures[1] = 0;
Kenichi Handa's avatar
Kenichi Handa committed
683
  for (i = 0; i < 2 && ! NILP (otf_spec); i++, otf_spec = XCDR (otf_spec))
684 685 686 687 688 689 690
    {
      Lisp_Object len;

      val = XCAR (otf_spec);
      if (NILP (val))
	continue;
      len = Flength (val);
691 692 693
      spec->features[i] =
	(min (PTRDIFF_MAX, SIZE_MAX) / sizeof (int) < XINT (len)
	 ? 0
694
	 : malloc (XINT (len) * sizeof *spec->features[i]));
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
      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;
}

719
static FcPattern *
720
ftfont_spec_pattern (Lisp_Object spec, char *otlayout, struct OpenTypeSpec **otspec, const char **langname)
Kenichi Handa's avatar
Kenichi Handa committed
721
{
Kenichi Handa's avatar
Kenichi Handa committed
722
  Lisp_Object tmp, extra;
Kenichi Handa's avatar
Kenichi Handa committed
723 724 725
  FcPattern *pattern = NULL;
  FcCharSet *charset = NULL;
  FcLangSet *langset = NULL;
726 727
  int n;
  int dpi = -1;
728
  int scalable = -1;
729
  Lisp_Object script = Qnil;
Kenichi Handa's avatar
Kenichi Handa committed
730
  Lisp_Object registry;
731
  int fc_charset_idx;
Kenichi Handa's avatar
Kenichi Handa committed
732

733 734
  if ((n = FONT_SLANT_NUMERIC (spec)) >= 0
      && n < 100)
Paul Eggert's avatar
Paul Eggert committed
735
    /* Fontconfig doesn't support reverse-italic/oblique.  */
736 737 738 739 740 741 742
    return NULL;

  if (INTEGERP (AREF (spec, FONT_DPI_INDEX)))
    dpi = XINT (AREF (spec, FONT_DPI_INDEX));
  if (INTEGERP (AREF (spec, FONT_AVGWIDTH_INDEX))
      && XINT (AREF (spec, FONT_AVGWIDTH_INDEX)) == 0)
    scalable = 1;
743

Kenichi Handa's avatar
Kenichi Handa committed
744 745
  registry = AREF (spec, FONT_REGISTRY_INDEX);
  if (NILP (registry)
746
      || EQ (registry, Qascii_0)
Kenichi Handa's avatar
Kenichi Handa committed
747
      || EQ (registry, Qiso10646_1)
748
      || EQ (registry, Qunicode_bmp))
749
    fc_charset_idx = -1;
Kenichi Handa's avatar
Kenichi Handa committed
750
  else
Kenichi Handa's avatar
Kenichi Handa committed
751
    {
752 753
      FcChar8 *lang;

754 755
      fc_charset_idx = ftfont_get_charset (registry);
      if (fc_charset_idx < 0)
756
	return NULL;
757
      charset = fc_charset_table[fc_charset_idx].fc_charset;
758 759
      *langname = fc_charset_table[fc_charset_idx].lang;
      lang = (FcChar8 *) *langname;
760 761 762 763 764 765 766
      if (lang)
	{
	  langset = FcLangSetCreate ();
	  if (! langset)
	    goto err;
	  FcLangSetAdd (langset, lang);
	}
Kenichi Handa's avatar
Kenichi Handa committed
767 768
    }

769
  otlayout[0] = '\0';
770 771
  for (extra = AREF (spec, FONT_EXTRA_INDEX);
       CONSP (extra); extra = XCDR (extra))
Kenichi Handa's avatar
Kenichi Handa committed
772
    {
773 774
      Lisp_Object key, val;

775 776
      key = XCAR (XCAR (extra)), val = XCDR (XCAR (extra));
      if (EQ (key, QCdpi))
777 778 779 780
	{
	  if (INTEGERP (val))
	    dpi = XINT (val);
	}
781
      else if (EQ (key, QClang))
Kenichi Handa's avatar
Kenichi Handa committed
782
	{
783 784
	  if (! langset)
	    langset = FcLangSetCreate ();
Kenichi Handa's avatar
Kenichi Handa committed
785 786
	  if (! langset)
	    goto err;
787
	  if (SYMBOLP (val))
Kenichi Handa's avatar
Kenichi Handa committed
788
	    {
789
	      if (! FcLangSetAdd (langset, SYMBOL_FcChar8 (val)))
Kenichi Handa's avatar
Kenichi Handa committed
790 791 792
		goto err;
	    }
	  else
793 794 795 796
	    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
797
	}
798 799
      else if (EQ (key, QCotf))
	{
800 801 802 803 804 805 806 807 808
	  if (CONSP (val))
	    {
	      *otspec = ftfont_get_open_type_spec (val);
	      if (! *otspec)
		return NULL;
	      strcat (otlayout, "otlayout:");
	      OTF_TAG_STR ((*otspec)->script_tag, otlayout + 9);
	      script = (*otspec)->script;
	    }
809
	}
810 811 812 813 814
      else if (EQ (key, QCscript))
	script = val;
      else if (EQ (key, QCscalable))
	scalable = ! NILP (val);
    }
Kenichi Handa's avatar
Kenichi Handa committed
815

816 817 818 819
  if (! NILP (script) && ! charset)
    {
      Lisp_Object chars = assq_no_quit (script, Vscript_representative_chars);

820
      if (CONSP (chars) && CONSP (CDR (chars)))
821 822 823 824 825 826
	{
	  charset = FcCharSetCreate ();
	  if (! charset)
	    goto err;
	  for (chars = XCDR (chars); CONSP (chars); chars = XCDR (chars))
	    if (CHARACTERP (XCAR (chars))
827
		&& ! FcCharSetAddChar (charset, XFASTINT (XCAR (chars))))
828
	      goto err;
Kenichi Handa's avatar
Kenichi Handa committed
829 830 831
	}
    }

832
  pattern = FcPatternCreate ();
833 834 835
  if (! pattern)
    goto err;
  tmp = AREF (spec, FONT_FOUNDRY_INDEX);
836
  if (! NILP (tmp)
837 838
      && ! FcPatternAddString (pattern, FC_FOUNDRY, SYMBOL_FcChar8 (tmp)))
    goto err;
839 840 841 842
  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
843 844 845 846 847 848
  if (charset
      && ! FcPatternAddCharSet (pattern, FC_CHARSET, charset))
    goto err;
  if (langset
      && ! FcPatternAddLangSet (pattern, FC_LANG, langset))
    goto err;
849 850 851 852
  if (dpi >= 0
      && ! FcPatternAddDouble (pattern, FC_DPI, dpi))
    goto err;
  if (scalable >= 0
Kenichi Handa's avatar
Kenichi Handa committed
853
      && ! FcPatternAddBool (pattern, FC_SCALABLE, scalable ? FcTrue : FcFalse))
854
    goto err;
855

856
  goto finish;
Kenichi Handa's avatar
Kenichi Handa committed
857

858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
 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);
878
  if (charset && fc_charset_idx < 0) FcCharSetDestroy (charset);
879 880 881 882
  return pattern;
}

static Lisp_Object
883
ftfont_list (struct frame *f, Lisp_Object spec)
884
{
Kenichi Handa's avatar
Kenichi Handa committed
885
  Lisp_Object val = Qnil, family, adstyle;
886 887 888 889
  int i;
  FcPattern *pattern;
  FcFontSet *fontset = NULL;
  FcObjectSet *objset = NULL;
890 891
  FcCharSet *charset;
  Lisp_Object chars = Qnil;
892 893
  char otlayout[15];		/* For "otlayout:XXXX" */
  struct OpenTypeSpec *otspec = NULL;
894
  int spacing = -1;
895
  const char *langname = NULL;
Juanma Barranquero's avatar
Juanma Barranquero committed
896

897 898 899 900 901 902
  if (! fc_initialized)
    {
      FcInit ();
      fc_initialized = 1;
    }