ftfont.c 59 KB
Newer Older
Kenichi Handa's avatar
Kenichi Handa committed
1
/* ftfont.c -- FreeType font driver.
Glenn Morris's avatar
Glenn Morris committed
2 3
   Copyright (C) 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
   Copyright (C) 2006, 2007, 2008, 2009
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 34

#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
35
#include "composite.h"
Kenichi Handa's avatar
Kenichi Handa committed
36 37
#include "fontset.h"
#include "font.h"
38
#include "ftfont.h"
Kenichi Handa's avatar
Kenichi Handa committed
39

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

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

Kenichi Handa's avatar
Kenichi Handa committed
46 47 48
/* Special ADSTYLE properties to avoid fonts used for Latin characters.  */
static Lisp_Object Qja, Qko;

Juanma Barranquero's avatar
Juanma Barranquero committed
49
/* Flag to tell if FcInit is already called or not.  */
Kenichi Handa's avatar
Kenichi Handa committed
50
static int fc_initialized;
51 52

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

55
/* Cache for FreeType fonts.  */
Kenichi Handa's avatar
Kenichi Handa committed
56 57
static Lisp_Object freetype_font_cache;

58
/* Cache for FT_Face and FcCharSet. */
Kenichi Handa's avatar
Kenichi Handa committed
59
static Lisp_Object ft_face_cache;
Kenichi Handa's avatar
Kenichi Handa committed
60 61 62 63 64 65 66

/* The actual structure for FreeType font that can be casted to struct
   font.  */

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

77
static Lisp_Object ftfont_pattern_entity P_ ((FcPattern *, Lisp_Object));
Kenichi Handa's avatar
Kenichi Handa committed
78

79 80
static Lisp_Object ftfont_resolve_generic_family P_ ((Lisp_Object,
						      FcPattern *));
81 82
static Lisp_Object ftfont_lookup_cache P_ ((Lisp_Object, int));

83
Lisp_Object ftfont_font_format P_ ((FcPattern *, Lisp_Object));
84 85 86

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

Kenichi Handa's avatar
Kenichi Handa committed
87
static struct
Kenichi Handa's avatar
Kenichi Handa committed
88
{
89
  /* registry name */
Kenichi Handa's avatar
Kenichi Handa committed
90 91 92
  char *name;
  /* characters to distinguish the charset from the others */
  int uniquifier[6];
93 94
  /* additional constraint by language */
  char *lang;
Kenichi Handa's avatar
Kenichi Handa committed
95 96 97
  /* set on demand */
  FcCharSet *fc_charset;
} fc_charset_table[] =
Kenichi Handa's avatar
Kenichi Handa committed
98
  { { "iso8859-1", { } },	/* ftfont_get_latin1_charset handles it. */
99 100 101 102 103 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
    { "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"},
131 132
    { "windows-1251", { 0x0401, 0x0490 }, "ru"},
    { "koi8-r", { 0x0401, 0x2219 }, "ru"},
133
    { "mulelao-1", { 0x0E81 }, "lo"},
134
    { "unicode-sip", { 0x20000 }},
Kenichi Handa's avatar
Kenichi Handa committed
135 136
    { NULL }
  };
Kenichi Handa's avatar
Kenichi Handa committed
137

Kenichi Handa's avatar
Kenichi Handa committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
/* Return a FcCharSet for iso8859-1 from fc_charset_table[0].  If the
   charset is not yet ready, create it. */
static FcCharSet *
ftfont_get_latin1_charset ()
{
  FcCharSet *cs;
  FcChar32 c;

  if (fc_charset_table[0].fc_charset)
    return fc_charset_table[0].fc_charset;
  cs = FcCharSetCreate ();
  if (! cs)
    return NULL;
  for (c = 33; c <= 0xFF; c++)
    {
      FcCharSetAddChar (cs, c);
      if (c == 0x7E)
	c = 0xA0;
    }
  fc_charset_table[0].fc_charset = cs;
  return cs;
}

161 162
extern Lisp_Object Qc, Qm, Qp, Qd;

Kenichi Handa's avatar
Kenichi Handa committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
/* 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)
{
  char *str, *end;
  Lisp_Object adstyle;

  if (FcPatternGetString (p, FC_STYLE, 0, (FcChar8 **) &str) != FcResultMatch)
    return Qnil;
  for (end = str; *end && *end != ' '; end++);
  if (*end)
    {
      char *p = alloca (end - str + 1);
      memcpy (p, str, end - str);
      p[end - str] = '\0';
190
      end = p + (end - str);
Kenichi Handa's avatar
Kenichi Handa committed
191 192 193 194 195 196 197 198 199 200 201 202 203
      str = p;
    }
  if (xstrcasecmp (str, "Regular") == 0
      || xstrcasecmp (str, "Bold") == 0
      || xstrcasecmp (str, "Oblique") == 0
      || xstrcasecmp (str, "Italic") == 0)
    return Qnil;
  adstyle = font_intern_prop (str, end - str, 0);
  if (font_style_to_value (FONT_WIDTH_INDEX, adstyle, 0) >= 0)
    return Qnil;
  return adstyle;
}

204
static Lisp_Object
205
ftfont_pattern_entity (p, extra)
206
     FcPattern *p;
207
     Lisp_Object extra;
208 209
{
  Lisp_Object entity;
Kenichi Handa's avatar
Kenichi Handa committed
210
  char *file, *str;
211
  int index;
212 213
  int numeric;
  double dbl;
214
  FcBool b;
215

Kenichi Handa's avatar
Kenichi Handa committed
216
  if (FcPatternGetString (p, FC_FILE, 0, (FcChar8 **) &file) != FcResultMatch)
217
    return Qnil;
218 219
  if (FcPatternGetInteger (p, FC_INDEX, 0, &index) != FcResultMatch)
    return Qnil;
220

221
  entity = font_make_entity ();
222 223

  ASET (entity, FONT_TYPE_INDEX, Qfreetype);
224
  ASET (entity, FONT_REGISTRY_INDEX, Qiso10646_1);
225

Kenichi Handa's avatar
Kenichi Handa committed
226
  if (FcPatternGetString (p, FC_FOUNDRY, 0, (FcChar8 **) &str) == FcResultMatch)
227
    ASET (entity, FONT_FOUNDRY_INDEX, font_intern_prop (str, strlen (str), 1));
Kenichi Handa's avatar
Kenichi Handa committed
228
  if (FcPatternGetString (p, FC_FAMILY, 0, (FcChar8 **) &str) == FcResultMatch)
229
    ASET (entity, FONT_FAMILY_INDEX, font_intern_prop (str, strlen (str), 1));
230
  if (FcPatternGetInteger (p, FC_WEIGHT, 0, &numeric) == FcResultMatch)
231
    {
232 233 234
      if (numeric >= FC_WEIGHT_REGULAR && numeric < FC_WEIGHT_MEDIUM)
	numeric = FC_WEIGHT_MEDIUM;
      FONT_SET_STYLE (entity, FONT_WEIGHT_INDEX, make_number (numeric));
235
    }
236
  if (FcPatternGetInteger (p, FC_SLANT, 0, &numeric) == FcResultMatch)
237 238 239 240
    {
      numeric += 100;
      FONT_SET_STYLE (entity, FONT_SLANT_INDEX, make_number (numeric));
    }
241
  if (FcPatternGetInteger (p, FC_WIDTH, 0, &numeric) == FcResultMatch)
242 243 244
    {
      FONT_SET_STYLE (entity, FONT_WIDTH_INDEX, make_number (numeric));
    }
245
  if (FcPatternGetDouble (p, FC_PIXEL_SIZE, 0, &dbl) == FcResultMatch)
Kenichi Handa's avatar
Kenichi Handa committed
246 247 248 249 250 251 252 253
    {
      Lisp_Object adstyle;

      ASET (entity, FONT_SIZE_INDEX, make_number (dbl));
      /* As this font has PIXEL_SIZE property, parhaps this is a BDF
	 or PCF font. */ 
      ASET (entity, FONT_ADSTYLE_INDEX, get_adstyle_property (p));
    }
254 255
  else
    ASET (entity, FONT_SIZE_INDEX, make_number (0));
256 257 258 259 260 261 262 263 264 265
  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)
    ASET (entity, FONT_AVGWIDTH_INDEX, make_number (0));
266

267
  ASET (entity, FONT_EXTRA_INDEX, Fcopy_sequence (extra));
Kenichi Handa's avatar
Kenichi Handa committed
268 269 270
  font_put_extra (entity, QCfont_entity,
		  Fcons (make_unibyte_string ((char *) file,
					      strlen ((char *) file)),
271
			 make_number (index)));
272 273 274
  return entity;
}

275

276 277 278
static Lisp_Object ftfont_generic_family_list;

static Lisp_Object
279
ftfont_resolve_generic_family (family, pattern)
280
     Lisp_Object family;
281
     FcPattern *pattern;
282
{
283
  Lisp_Object slot;
284
  FcPattern *match;
285
  FcResult result;
Kenichi Handa's avatar
Kenichi Handa committed
286
  FcLangSet *langset;
287

288
  family = Fintern (Fdowncase (SYMBOL_NAME (family)), Qnil);
289 290 291 292 293 294
  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))
295
    return Qnil;
296 297
  if (! EQ (XCDR (slot), Qt))
    return XCDR (slot);
298
  pattern = FcPatternDuplicate (pattern);
299 300
  if (! pattern)
    goto err;
301
  FcPatternDel (pattern, FC_FOUNDRY);
302 303
  FcPatternDel (pattern, FC_FAMILY);
  FcPatternAddString (pattern, FC_FAMILY, SYMBOL_FcChar8 (family));
Kenichi Handa's avatar
Kenichi Handa committed
304 305 306 307 308 309 310 311
  if (FcPatternGetLangSet (pattern, FC_LANG, 0, &langset) != FcResultMatch)
    {
      /* This is to avoid the effect of locale.  */
      langset = FcLangSetCreate ();
      FcLangSetAdd (langset, "en");
      FcPatternAddLangSet (pattern, FC_LANG, langset);
      FcLangSetDestroy (langset);
    }
312
  FcConfigSubstitute (NULL, pattern, FcMatchPattern);
313 314 315
  FcDefaultSubstitute (pattern);
  match = FcFontMatch (NULL, pattern, &result);
  if (match)
316
    {
317 318 319 320
      FcChar8 *fam;

      if (FcPatternGetString (match, FC_FAMILY, 0, &fam) == FcResultMatch)
	family = intern ((char *) fam);
321
    }
322 323 324 325
  else
    family = Qnil;
  XSETCDR (slot, family);
  if (match) FcPatternDestroy (match);
326
 err:
327
  if (pattern) FcPatternDestroy (pattern);
328
  return family;
329 330
}

331 332 333 334 335 336 337 338 339 340
struct ftfont_cache_data
{
  FT_Face ft_face;
  FcCharSet *fc_charset;
};

static Lisp_Object
ftfont_lookup_cache (key, for_face)
     Lisp_Object key;
     int for_face;
Kenichi Handa's avatar
Kenichi Handa committed
341
{
Kenichi Handa's avatar
Kenichi Handa committed
342
  Lisp_Object cache, val, entity;
343
  struct ftfont_cache_data *cache_data;
Kenichi Handa's avatar
Kenichi Handa committed
344

Kenichi Handa's avatar
Kenichi Handa committed
345 346 347 348 349 350 351 352 353 354
  if (FONT_ENTITY_P (key))
    {
      entity = key;
      val = assq_no_quit (QCfont_entity, AREF (entity, FONT_EXTRA_INDEX));
      xassert (CONSP (val));
      key = XCDR (val);
    }
  else
    entity = Qnil;

355
  cache = assoc_no_quit (key, ft_face_cache);
Kenichi Handa's avatar
Kenichi Handa committed
356 357
  if (NILP (cache))
    {
358 359 360
      cache_data = xmalloc (sizeof (struct ftfont_cache_data));
      cache_data->ft_face = NULL;
      cache_data->fc_charset = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
361
      val = make_save_value (NULL, 0);
362 363 364
      XSAVE_VALUE (val)->integer = 0;
      XSAVE_VALUE (val)->pointer = cache_data;
      cache = Fcons (key, val);
Kenichi Handa's avatar
Kenichi Handa committed
365 366 367 368
      ft_face_cache = Fcons (cache, ft_face_cache);
    }
  else
    {
369 370 371 372 373 374 375
      val = XCDR (cache);
      cache_data = XSAVE_VALUE (val)->pointer;
    }
  if (for_face ? ! cache_data->ft_face : ! cache_data->fc_charset)
    {
      char *filename = (char *) SDATA (XCAR (key));
      int index = XINT (XCDR (key));
Kenichi Handa's avatar
Kenichi Handa committed
376

377 378 379 380 381 382 383 384 385 386 387
      if (for_face)
	{
	  if (! ft_library
	      && FT_Init_FreeType (&ft_library) != 0)
	    return Qnil;
	  if (FT_New_Face (ft_library, filename, index, &cache_data->ft_face)
	      != 0)
	    return Qnil;
	}
      else
	{
Kenichi Handa's avatar
Kenichi Handa committed
388 389 390 391
	  FcPattern *pat = NULL;
	  FcFontSet *fontset = NULL;
	  FcObjectSet *objset = NULL;
	  FcCharSet *charset = NULL;
392 393 394

	  pat = FcPatternBuild (0, FC_FILE, FcTypeString, (FcChar8 *) filename,
				FC_INDEX, FcTypeInteger, index, NULL);
Kenichi Handa's avatar
Kenichi Handa committed
395 396 397 398 399
	  if (! pat)
	    goto finish;
	  objset = FcObjectSetBuild (FC_CHARSET, FC_STYLE, NULL);
	  if (! objset)
	    goto finish;
400
	  fontset = FcFontList (NULL, pat, objset);
Kenichi Handa's avatar
Kenichi Handa committed
401 402 403 404 405
	  if (! fontset)
	    goto finish;
	  if (fontset && fontset->nfont > 0)
	    {
	      if (FcPatternGetCharSet (fontset->fonts[0], FC_CHARSET, 0,
406
				       &charset)
Kenichi Handa's avatar
Kenichi Handa committed
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
		  == FcResultMatch)
		{
		  /* Dirty hack.  Fonts of "ja" and "ko" adstyle are
		     not suitable for Latin characters.  */
		  if (! NILP (entity)
		      && (EQ (AREF (entity, FONT_ADSTYLE_INDEX), Qja)
			  || EQ (AREF (entity, FONT_ADSTYLE_INDEX), Qko)))
		    {
		      FcCharSet *latin1 = ftfont_get_latin1_charset ();

		      if (! latin1)
			goto finish;
		      cache_data->fc_charset = FcCharSetSubtract (charset,
								  latin1);
		    }
		  else
		    cache_data->fc_charset = FcCharSetCopy (charset);
		}
	      else
		cache_data->fc_charset = FcCharSetCreate ();
	    }
428 429
	  else
	    cache_data->fc_charset = FcCharSetCreate ();
Kenichi Handa's avatar
Kenichi Handa committed
430 431 432 433 434 435 436 437

	finish:
	  if (fontset)
	    FcFontSetDestroy (fontset);
	  if (objset)
	    FcObjectSetDestroy (objset);
	  if (pat)
	    FcPatternDestroy (pat);
438
	}
Kenichi Handa's avatar
Kenichi Handa committed
439 440 441 442
    }
  return cache;
}

443 444 445 446 447 448 449
FcCharSet *
ftfont_get_fc_charset (entity)
     Lisp_Object entity;
{
  Lisp_Object val, cache;
  struct ftfont_cache_data *cache_data;

Kenichi Handa's avatar
Kenichi Handa committed
450
  cache = ftfont_lookup_cache (entity, 0);
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
  val = XCDR (cache);
  cache_data = XSAVE_VALUE (val)->pointer;
  return cache_data->fc_charset;
}

#ifdef HAVE_LIBOTF
static OTF *
ftfont_get_otf (ftfont_info)
     struct ftfont_info *ftfont_info;
{
  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 */

480
static Lisp_Object ftfont_get_cache P_ ((FRAME_PTR));
Kenichi Handa's avatar
Kenichi Handa committed
481
static Lisp_Object ftfont_list P_ ((Lisp_Object, Lisp_Object));
482
static Lisp_Object ftfont_match P_ ((Lisp_Object, Lisp_Object));
Kenichi Handa's avatar
Kenichi Handa committed
483
static Lisp_Object ftfont_list_family P_ ((Lisp_Object));
484
static Lisp_Object ftfont_open P_ ((FRAME_PTR, Lisp_Object, int));
Kenichi Handa's avatar
Kenichi Handa committed
485 486 487 488 489 490 491 492 493
static void ftfont_close P_ ((FRAME_PTR, struct font *));
static int ftfont_has_char P_ ((Lisp_Object, int));
static unsigned ftfont_encode_char P_ ((struct font *, int));
static int ftfont_text_extents P_ ((struct font *, unsigned *, int,
				    struct font_metrics *));
static int ftfont_get_bitmap P_ ((struct font *, unsigned,
				  struct font_bitmap *, int));
static int ftfont_anchor_point P_ ((struct font *, unsigned, int,
				    int *, int *));
494
static Lisp_Object ftfont_otf_capability P_ ((struct font *));
495
static Lisp_Object ftfont_shape P_ ((Lisp_Object));
496 497

#ifdef HAVE_OTF_GET_VARIATION_GLYPHS
498 499
static int ftfont_variation_glyphs P_ ((struct font *, int c,
					unsigned variations[256]));
500
#endif /* HAVE_OTF_GET_VARIATION_GLYPHS */
Kenichi Handa's avatar
Kenichi Handa committed
501 502 503

struct font_driver ftfont_driver =
  {
504
    0,				/* Qfreetype */
505
    0,				/* case insensitive */
Kenichi Handa's avatar
Kenichi Handa committed
506 507
    ftfont_get_cache,
    ftfont_list,
508
    ftfont_match,
Kenichi Handa's avatar
Kenichi Handa committed
509
    ftfont_list_family,
510
    NULL,			/* free_entity */
Kenichi Handa's avatar
Kenichi Handa committed
511 512 513
    ftfont_open,
    ftfont_close,
    /* We can't draw a text without device dependent functions.  */
514 515
    NULL,			/* prepare_face */
    NULL,			/* done_face */
Kenichi Handa's avatar
Kenichi Handa committed
516 517 518 519
    ftfont_has_char,
    ftfont_encode_char,
    ftfont_text_extents,
    /* We can't draw a text without device dependent functions.  */
520
    NULL,			/* draw */
Kenichi Handa's avatar
Kenichi Handa committed
521
    ftfont_get_bitmap,
522 523 524
    NULL,			/* get_bitmap */
    NULL,			/* free_bitmap */
    NULL,			/* get_outline */
Kenichi Handa's avatar
Kenichi Handa committed
525
    ftfont_anchor_point,
526 527 528
#ifdef HAVE_LIBOTF
    ftfont_otf_capability,
#else  /* not HAVE_LIBOTF */
Kenichi Handa's avatar
Kenichi Handa committed
529
    NULL,
530
#endif	/* not HAVE_LIBOTF */
531 532 533
    NULL,			/* otf_drive */
    NULL,			/* start_for_frame */
    NULL,			/* end_for_frame */
534
#if defined (HAVE_M17N_FLT) && defined (HAVE_LIBOTF)
535
    ftfont_shape,
536
#else  /* not (HAVE_M17N_FLT && HAVE_LIBOTF) */
537
    NULL,
538
#endif	/* not (HAVE_M17N_FLT && HAVE_LIBOTF) */
539
    NULL,			/* check */
540

541
#ifdef HAVE_OTF_GET_VARIATION_GLYPHS
542 543 544 545
    ftfont_variation_glyphs
#else
    NULL
#endif
Kenichi Handa's avatar
Kenichi Handa committed
546 547 548 549 550
  };

extern Lisp_Object QCname;

static Lisp_Object
551 552
ftfont_get_cache (f)
     FRAME_PTR f;
Kenichi Handa's avatar
Kenichi Handa committed
553 554 555 556
{
  return freetype_font_cache;
}

Kenichi Handa's avatar
Kenichi Handa committed
557 558 559 560
static int
ftfont_get_charset (registry)
     Lisp_Object registry;
{
561 562 563
  char *str = (char *) SDATA (SYMBOL_NAME (registry));
  char *re = alloca (SBYTES (SYMBOL_NAME (registry)) * 2 + 1);
  Lisp_Object regexp;
Kenichi Handa's avatar
Kenichi Handa committed
564 565
  int i, j;

566 567 568 569 570 571 572 573 574 575 576 577
  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
578
  for (i = 0; fc_charset_table[i].name; i++)
579
    if (fast_c_string_match_ignore_case (regexp, fc_charset_table[i].name) >= 0)
Kenichi Handa's avatar
Kenichi Handa committed
580 581 582 583 584
      break;
  if (! fc_charset_table[i].name)
    return -1;
  if (! fc_charset_table[i].fc_charset)
    {
Kenichi Handa's avatar
Kenichi Handa committed
585 586 587 588 589 590
      if (i == 0)
	ftfont_get_latin1_charset ();
      else
	{
	  FcCharSet *charset = FcCharSetCreate ();
	  int *uniquifier = fc_charset_table[i].uniquifier;
Kenichi Handa's avatar
Kenichi Handa committed
591

Kenichi Handa's avatar
Kenichi Handa committed
592
	  if (! charset)
Kenichi Handa's avatar
Kenichi Handa committed
593
	    return -1;
Kenichi Handa's avatar
Kenichi Handa committed
594 595 596 597 598 599 600 601
	  for (j = 0; uniquifier[j]; j++)
	    if (! FcCharSetAddChar (charset, uniquifier[j]))
	      {
		FcCharSetDestroy (charset);
		return -1;
	      }
	  fc_charset_table[i].fc_charset = charset;
	}
Kenichi Handa's avatar
Kenichi Handa committed
602 603 604 605
    }
  return i;
}

606 607
struct OpenTypeSpec
{
608 609
  Lisp_Object script;
  unsigned int script_tag, langsys_tag;
610 611 612 613
  int nfeatures[2];
  unsigned int *features[2];
};

614
#define OTF_SYM_TAG(SYM, TAG)					\
615
  do {								\
616 617
    unsigned char *p = SDATA (SYMBOL_NAME (SYM));		\
    TAG = (p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3];	\
618 619
  } while (0)

620
#define OTF_TAG_STR(TAG, P)			\
621
  do {						\
622 623 624 625
    (P)[0] = (char) (TAG >> 24);		\
    (P)[1] = (char) ((TAG >> 16) & 0xFF);	\
    (P)[2] = (char) ((TAG >> 8) & 0xFF);	\
    (P)[3] = (char) (TAG & 0xFF);		\
626
    (P)[4] = '\0';				\
627 628
  } while (0)

629 630 631 632 633 634 635 636 637
#define OTF_TAG_SYM(SYM, TAG)			\
  do {						\
    char str[5];				\
    						\
    OTF_TAG_STR (TAG, str);			\
    (SYM) = font_intern_prop (str, 4, 1);	\
  } while (0)


638 639 640 641 642 643 644 645 646
static struct OpenTypeSpec *
ftfont_get_open_type_spec (Lisp_Object otf_spec)
{
  struct OpenTypeSpec *spec = malloc (sizeof (struct OpenTypeSpec));
  Lisp_Object val;
  int i, j, negative;

  if (! spec)
    return NULL;
647
  spec->script = XCAR (otf_spec);
648
  if (! NILP (spec->script))
649 650 651 652 653 654 655 656
    {
      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;
    }
657
  else
658
    spec->script_tag = 0x44464C54; 	/* "DFLT" */
659 660 661
  otf_spec = XCDR (otf_spec);
  val = XCAR (otf_spec);
  if (! NILP (val))
662
    OTF_SYM_TAG (val, spec->langsys_tag);
663
  else
664
    spec->langsys_tag = 0;
665 666 667 668 669
  spec->nfeatures[0] = spec->nfeatures[1] = 0;
  for (i = 0; i < 2; i++)
    {
      Lisp_Object len;

Juanma Barranquero's avatar
Juanma Barranquero committed
670
      otf_spec = XCDR (otf_spec);
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
      if (NILP (otf_spec))
	break;
      val = XCAR (otf_spec);
      if (NILP (val))
	continue;
      len = Flength (val);
      spec->features[i] = malloc (sizeof (int) * XINT (len));
      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;
}

702
static FcPattern *ftfont_spec_pattern P_ ((Lisp_Object, char *,
Kenichi Handa's avatar
Kenichi Handa committed
703 704
					   struct OpenTypeSpec **));

705
static FcPattern *
706
ftfont_spec_pattern (spec, otlayout, otspec)
707 708 709
     Lisp_Object spec;
     char *otlayout;
     struct OpenTypeSpec **otspec;
Kenichi Handa's avatar
Kenichi Handa committed
710
{
Kenichi Handa's avatar
Kenichi Handa committed
711
  Lisp_Object tmp, extra;
Kenichi Handa's avatar
Kenichi Handa committed
712 713 714
  FcPattern *pattern = NULL;
  FcCharSet *charset = NULL;
  FcLangSet *langset = NULL;
715 716
  int n;
  int dpi = -1;
717
  int scalable = -1;
718
  Lisp_Object script = Qnil;
Kenichi Handa's avatar
Kenichi Handa committed
719
  Lisp_Object registry;
720
  int fc_charset_idx;
Kenichi Handa's avatar
Kenichi Handa committed
721

722 723
  if ((n = FONT_SLANT_NUMERIC (spec)) >= 0
      && n < 100)
724
    /* Fontconfig doesn't support reverse-italic/obligue.  */
725 726 727 728 729 730 731
    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;
732

Kenichi Handa's avatar
Kenichi Handa committed
733 734
  registry = AREF (spec, FONT_REGISTRY_INDEX);
  if (NILP (registry)
735
      || EQ (registry, Qascii_0)
Kenichi Handa's avatar
Kenichi Handa committed
736
      || EQ (registry, Qiso10646_1)
737
      || EQ (registry, Qunicode_bmp))
738
    fc_charset_idx = -1;
Kenichi Handa's avatar
Kenichi Handa committed
739
  else
Kenichi Handa's avatar
Kenichi Handa committed
740
    {
741 742
      FcChar8 *lang;

743 744
      fc_charset_idx = ftfont_get_charset (registry);
      if (fc_charset_idx < 0)
745
	return NULL;
746 747
      charset = fc_charset_table[fc_charset_idx].fc_charset;
      lang = (FcChar8 *) fc_charset_table[fc_charset_idx].lang;
748 749 750 751 752 753 754
      if (lang)
	{
	  langset = FcLangSetCreate ();
	  if (! langset)
	    goto err;
	  FcLangSetAdd (langset, lang);
	}
Kenichi Handa's avatar
Kenichi Handa committed
755 756
    }

757
  otlayout[0] = '\0';
758 759
  for (extra = AREF (spec, FONT_EXTRA_INDEX);
       CONSP (extra); extra = XCDR (extra))
Kenichi Handa's avatar
Kenichi Handa committed
760
    {
761 762
      Lisp_Object key, val;

763 764 765 766
      key = XCAR (XCAR (extra)), val = XCDR (XCAR (extra));
      if (EQ (key, QCdpi))
	dpi = XINT (val);
      else if (EQ (key, QClang))
Kenichi Handa's avatar
Kenichi Handa committed
767
	{
768 769
	  if (! langset)
	    langset = FcLangSetCreate ();
Kenichi Handa's avatar
Kenichi Handa committed
770 771
	  if (! langset)
	    goto err;
772
	  if (SYMBOLP (val))
Kenichi Handa's avatar
Kenichi Handa committed
773
	    {
774
	      if (! FcLangSetAdd (langset, SYMBOL_FcChar8 (val)))
Kenichi Handa's avatar
Kenichi Handa committed
775 776 777
		goto err;
	    }
	  else
778 779 780 781
	    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
782
	}
783 784 785 786 787 788 789 790 791
      else if (EQ (key, QCotf))
	{
	  *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;
	}
792 793 794 795 796
      else if (EQ (key, QCscript))
	script = val;
      else if (EQ (key, QCscalable))
	scalable = ! NILP (val);
    }
Kenichi Handa's avatar
Kenichi Handa committed
797

798 799 800 801
  if (! NILP (script) && ! charset)
    {
      Lisp_Object chars = assq_no_quit (script, Vscript_representative_chars);

802
      if (CONSP (chars) && CONSP (CDR (chars)))
803 804 805 806 807 808 809 810
	{
	  charset = FcCharSetCreate ();
	  if (! charset)
	    goto err;
	  for (chars = XCDR (chars); CONSP (chars); chars = XCDR (chars))
	    if (CHARACTERP (XCAR (chars))
		&& ! FcCharSetAddChar (charset, XUINT (XCAR (chars))))
	      goto err;
Kenichi Handa's avatar
Kenichi Handa committed
811 812 813
	}
    }

814
  pattern = FcPatternCreate ();
815 816 817
  if (! pattern)
    goto err;
  tmp = AREF (spec, FONT_FOUNDRY_INDEX);
818
  if (! NILP (tmp)
819 820
      && ! FcPatternAddString (pattern, FC_FOUNDRY, SYMBOL_FcChar8 (tmp)))
    goto err;
821 822 823 824
  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
825 826 827 828 829 830
  if (charset
      && ! FcPatternAddCharSet (pattern, FC_CHARSET, charset))
    goto err;
  if (langset
      && ! FcPatternAddLangSet (pattern, FC_LANG, langset))
    goto err;
831 832 833 834
  if (dpi >= 0
      && ! FcPatternAddDouble (pattern, FC_DPI, dpi))
    goto err;
  if (scalable >= 0
Kenichi Handa's avatar
Kenichi Handa committed
835
      && ! FcPatternAddBool (pattern, FC_SCALABLE, scalable ? FcTrue : FcFalse))
836
    goto err;
837

838
  goto finish;
Kenichi Handa's avatar
Kenichi Handa committed
839

840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
 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);
860
  if (charset && fc_charset_idx < 0) FcCharSetDestroy (charset);
861 862 863 864 865 866 867
  return pattern;
}

static Lisp_Object
ftfont_list (frame, spec)
     Lisp_Object frame, spec;
{
Kenichi Handa's avatar
Kenichi Handa committed
868
  Lisp_Object val = Qnil, family, adstyle;
869 870 871 872
  int i;
  FcPattern *pattern;
  FcFontSet *fontset = NULL;
  FcObjectSet *objset = NULL;
873 874 875
  FcCharSet *charset;
  Lisp_Object chars = Qnil;
  FcResult result;
876 877
  char otlayout[15];		/* For "otlayout:XXXX" */
  struct OpenTypeSpec *otspec = NULL;
878
  int spacing = -1;
Juanma Barranquero's avatar
Juanma Barranquero committed
879

880 881 882 883 884 885
  if (! fc_initialized)
    {
      FcInit ();
      fc_initialized = 1;
    }

886
  pattern = ftfont_spec_pattern (spec, otlayout, &otspec);
887 888
  if (! pattern)
    return Qnil;
889 890 891 892 893 894 895 896 897 898 899
  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;
    }
900 901
  if (INTEGERP (AREF (spec, FONT_SPACING_INDEX)))
    spacing = XINT (AREF (spec, FONT_SPACING_INDEX));
902 903 904 905 906
  family = AREF (spec, FONT_FAMILY_INDEX);
  if (! NILP (family))
    {
      Lisp_Object resolved;

907
      resolved = ftfont_resolve_generic_family (family, pattern);
908 909 910 911 912 913 914 915
      if (! NILP (resolved))
	{
	  FcPatternDel (pattern, FC_FAMILY);
	  if (! FcPatternAddString (pattern, FC_FAMILY,
				    SYMBOL_FcChar8 (resolved)))
	    goto err;
	}
    }
Kenichi Handa's avatar
Kenichi Handa committed
916 917 918
  adstyle = AREF (spec, FONT_ADSTYLE_INDEX);
  if (! NILP (adstyle) && SBYTES (SYMBOL_NAME (adstyle)) == 0)
    adstyle = Qnil;
919
  objset = FcObjectSetBuild (FC_FOUNDRY, FC_FAMILY, FC_WEIGHT, FC_SLANT,
920
			     FC_WIDTH, FC_PIXEL_SIZE, FC_SPACING, FC_SCALABLE,
Kenichi Handa's avatar
Kenichi Handa committed
921
			     FC_STYLE, FC_FILE, FC_INDEX,
922 923 924
#ifdef FC_CAPABILITY
			     FC_CAPABILITY,
#endif	/* FC_CAPABILITY */
925 926 927
#ifdef FC_FONTFORMAT
			     FC_FONTFORMAT,
#endif
928
			     NULL);
929 930
  if (! objset)
    goto err;
931 932
  if (! NILP (chars))
    FcObjectSetAdd (objset, FC_CHARSET);
933

934
  fontset = FcFontList (NULL, pattern, objset);
935 936
  if (! fontset || fontset->nfont == 0)
    goto finish;
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
#if 0
  /* Need fix because this finds any fonts.  */
  if (fontset->nfont == 0 && ! NILP (family))
    {
      /* Try maching with configuration.  For instance, the
	 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);
958
	      if (fontset && fontset->nfont > 0)
959 960 961 962 963
		break;
	    }
	}
    }
#endif
964
  for (i = 0; i < fontset->nfont; i++)
965
    {
966
      Lisp_Object entity;
967

968 969 970 971 972 973 974 975 976 977
      if (spacing >= 0)
	{
	  int this;

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

978
#ifdef FC_CAPABILITY
979 980 981
      if (otlayout[0])
	{
	  FcChar8 *this;
982

983 984
	  if (FcPatternGetString (fontset->fonts[i], FC_CAPABILITY, 0, &this)
	      != FcResultMatch
985 986 987
	      || ! strstr ((char *) this, otlayout))
	    continue;
	}
988
#endif	/* FC_CAPABILITY */
989
#ifdef HAVE_LIBOTF
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
      if (otspec)
	{
	  FcChar8 *file;
	  OTF *otf;

	  if (FcPatternGetString (fontset->fonts[i], FC_FILE, 0, &file)
	      != FcResultMatch)
	    continue;
	  otf = OTF_open ((char *) file);
	  if (! otf)
	    continue;
	  if (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)
	    continue;
Kenichi Handa's avatar
Kenichi Handa committed
1010
	}
1011
#endif	/* HAVE_LIBOTF */
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
      if (VECTORP (chars))
	{
	  int j;

	  if (FcPatternGetCharSet (fontset->fonts[i], FC_CHARSET, 0, &charset)
	      != FcResultMatch)
	    continue;
	  for (j = 0; j < ASIZE (chars); j++)
	    if (NATNUMP (AREF (chars, j))
		&& FcCharSetHasChar (charset, XFASTINT (AREF (chars, j))))
	      break;
	  if (j == ASIZE (chars))
	    continue;
	}