ftfont.c 72.7 KB
Newer Older
Kenichi Handa's avatar
Kenichi Handa committed
1
/* ftfont.c -- FreeType font driver.
2
   Copyright (C) 2006-2013 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 57 58 59 60 61 62

/* The actual structure for FreeType font that can be casted to struct
   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
Lisp_Object ftfont_font_format (FcPattern *, Lisp_Object);
91 92 93

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

Kenichi Handa's avatar
Kenichi Handa committed
94
static struct
Kenichi Handa's avatar
Kenichi Handa committed
95
{
96
  /* registry name */
97
  const char *name;
Kenichi Handa's avatar
Kenichi Handa committed
98 99
  /* characters to distinguish the charset from the others */
  int uniquifier[6];
100
  /* additional constraint by language */
101
  const char *lang;
Kenichi Handa's avatar
Kenichi Handa committed
102 103 104
  /* set on demand */
  FcCharSet *fc_charset;
} fc_charset_table[] =
105
  { { "iso8859-1", { 0x00A0, 0x00A1, 0x00B4, 0x00BC, 0x00D0 } },
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 136 137
    { "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"},
138 139
    { "windows-1251", { 0x0401, 0x0490 }, "ru"},
    { "koi8-r", { 0x0401, 0x2219 }, "ru"},
140
    { "mulelao-1", { 0x0E81 }, "lo"},
141
    { "unicode-sip", { 0x20000 }},
Kenichi Handa's avatar
Kenichi Handa committed
142 143
    { NULL }
  };
Kenichi Handa's avatar
Kenichi Handa committed
144

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

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

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

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

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

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

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

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

  ASET (entity, FONT_TYPE_INDEX, Qfreetype);
232
  ASET (entity, FONT_REGISTRY_INDEX, Qiso10646_1);
233

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

      ASET (entity, FONT_ADSTYLE_INDEX, get_adstyle_property (p));
      if ((ft_library || FT_Init_FreeType (&ft_library) == 0)
286
	  && FT_New_Face (ft_library, file, idx, &ft_face) == 0)
287 288 289 290 291 292 293 294 295
	{
	  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);
	}
    }
296

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

302

303 304 305
static Lisp_Object ftfont_generic_family_list;

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

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

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

357 358 359 360 361 362 363
struct ftfont_cache_data
{
  FT_Face ft_face;
  FcCharSet *fc_charset;
};

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

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

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

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

  if (cache_for == FTFONT_CACHE_FOR_ENTITY)
    return cache;

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

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

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

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

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

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

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

496 497 498 499 500 501 502 503 504 505 506 507 508 509
static Lisp_Object ftfont_get_cache (FRAME_PTR);
static Lisp_Object ftfont_list (Lisp_Object, Lisp_Object);
static Lisp_Object ftfont_match (Lisp_Object, Lisp_Object);
static Lisp_Object ftfont_list_family (Lisp_Object);
static Lisp_Object ftfont_open (FRAME_PTR, Lisp_Object, int);
static void ftfont_close (FRAME_PTR, struct font *);
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 *);
510
#ifdef HAVE_LIBOTF
511
static Lisp_Object ftfont_otf_capability (struct font *);
512
# ifdef HAVE_M17N_FLT
513
static Lisp_Object ftfont_shape (Lisp_Object);
514 515
# endif
#endif
516 517

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

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

561
#ifdef HAVE_OTF_GET_VARIATION_GLYPHS
562
    ftfont_variation_glyphs,
563
#else
564
    NULL,
565
#endif
566 567

    ftfont_filter_properties, /* filter_properties */
Kenichi Handa's avatar
Kenichi Handa committed
568 569 570
  };

static Lisp_Object
571
ftfont_get_cache (FRAME_PTR f)
Kenichi Handa's avatar
Kenichi Handa committed
572 573 574 575
{
  return freetype_font_cache;
}

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

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

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

621 622
struct OpenTypeSpec
{
623 624
  Lisp_Object script;
  unsigned int script_tag, langsys_tag;
625 626 627 628
  int nfeatures[2];
  unsigned int *features[2];
};

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

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

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


655 656 657
static struct OpenTypeSpec *
ftfont_get_open_type_spec (Lisp_Object otf_spec)
{
658
  struct OpenTypeSpec *spec = malloc (sizeof *spec);
659
  Lisp_Object val;
660 661
  int i, j;
  bool negative;
662 663 664

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

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

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

737 738
  if ((n = FONT_SLANT_NUMERIC (spec)) >= 0
      && n < 100)
Paul Eggert's avatar
Paul Eggert committed
739
    /* Fontconfig doesn't support reverse-italic/oblique.  */
740 741 742 743 744 745 746
    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;
747

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

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

773
  otlayout[0] = '\0';
774 775
  for (extra = AREF (spec, FONT_EXTRA_INDEX);
       CONSP (extra); extra = XCDR (extra))
Kenichi Handa's avatar
Kenichi Handa committed
776
    {
777 778
      Lisp_Object key, val;

779 780
      key = XCAR (XCAR (extra)), val = XCDR (XCAR (extra));
      if (EQ (key, QCdpi))
781 782 783 784
	{
	  if (INTEGERP (val))
	    dpi = XINT (val);
	}
785
      else if (EQ (key, QClang))
Kenichi Handa's avatar
Kenichi Handa committed
786
	{
787 788
	  if (! langset)
	    langset = FcLangSetCreate ();
Kenichi Handa's avatar
Kenichi Handa committed
789 790
	  if (! langset)
	    goto err;
791
	  if (SYMBOLP (val))
Kenichi Handa's avatar
Kenichi Handa committed
792
	    {
793
	      if (! FcLangSetAdd (langset, SYMBOL_FcChar8 (val)))
Kenichi Handa's avatar
Kenichi Handa committed
794 795 796
		goto err;
	    }
	  else
797 798 799 800
	    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
801
	}
802 803
      else if (EQ (key, QCotf))
	{
804 805 806 807 808 809 810 811 812
	  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;
	    }
813
	}
814 815 816 817 818
      else if (EQ (key, QCscript))
	script = val;
      else if (EQ (key, QCscalable))
	scalable = ! NILP (val);
    }
Kenichi Handa's avatar
Kenichi Handa committed
819

820 821 822 823
  if (! NILP (script) && ! charset)
    {
      Lisp_Object chars = assq_no_quit (script, Vscript_representative_chars);

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

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

860
  goto finish;
Kenichi Handa's avatar
Kenichi Handa committed
861

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

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

901 902 903 904 905 906
  if (! fc_initialized)
    {
      FcInit ();
      fc_initialized = 1;
    }

907
  pattern = ftfont_spec_pattern (spec, otlayout, &otspec, &langname);
908