ftfont.c 62 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

#include <config.h>
#include <stdio.h>
24
#include <setjmp.h>
Kenichi Handa's avatar
Kenichi Handa committed
25 26 27 28 29 30 31 32 33 34 35

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

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

44 45 46
/* 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
47
/* Flag to tell if FcInit is already called or not.  */
Kenichi Handa's avatar
Kenichi Handa committed
48
static int fc_initialized;
49 50

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

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

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

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

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

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

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

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

89 90
static void ftfont_filter_properties P_ ((Lisp_Object font, Lisp_Object alist));
                                                
91
Lisp_Object ftfont_font_format P_ ((FcPattern *, Lisp_Object));
92 93 94

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

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

146 147
extern Lisp_Object Qc, Qm, Qp, Qd;

Kenichi Handa's avatar
Kenichi Handa committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
/* 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';
175
      end = p + (end - str);
Kenichi Handa's avatar
Kenichi Handa committed
176 177 178 179 180 181 182
      str = p;
    }
  if (xstrcasecmp (str, "Regular") == 0
      || xstrcasecmp (str, "Bold") == 0
      || xstrcasecmp (str, "Oblique") == 0
      || xstrcasecmp (str, "Italic") == 0)
    return Qnil;
183
  adstyle = font_intern_prop (str, end - str, 1);
Kenichi Handa's avatar
Kenichi Handa committed
184 185 186 187 188
  if (font_style_to_value (FONT_WIDTH_INDEX, adstyle, 0) >= 0)
    return Qnil;
  return adstyle;
}

189
static Lisp_Object
190
ftfont_pattern_entity (p, extra)
191
     FcPattern *p;
192
     Lisp_Object extra;
193
{
194
  Lisp_Object key, cache, entity;
Kenichi Handa's avatar
Kenichi Handa committed
195
  char *file, *str;
196
  int index;
197 198
  int numeric;
  double dbl;
199
  FcBool b;
200

Kenichi Handa's avatar
Kenichi Handa committed
201
  if (FcPatternGetString (p, FC_FILE, 0, (FcChar8 **) &file) != FcResultMatch)
202
    return Qnil;
203 204
  if (FcPatternGetInteger (p, FC_INDEX, 0, &index) != FcResultMatch)
    return Qnil;
205

206 207 208 209 210
  key = Fcons (make_unibyte_string ((char *) file, strlen ((char *) file)),
	       make_number (index));
  cache = ftfont_lookup_cache (key, FTFONT_CACHE_FOR_ENTITY);
  entity = XCAR (cache);
  if (! NILP (entity))
211 212 213 214 215 216 217 218
    {
      Lisp_Object val = font_make_entity ();
      int i;

      for (i = 0; i < FONT_OBJLIST_INDEX; i++)
	ASET (val, i, AREF (entity, i));
      return val;
    }
219
  entity = font_make_entity ();
220
  XSETCAR (cache, entity);
221 222

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

Kenichi Handa's avatar
Kenichi Handa committed
225
  if (FcPatternGetString (p, FC_FOUNDRY, 0, (FcChar8 **) &str) == FcResultMatch)
226
    ASET (entity, FONT_FOUNDRY_INDEX, font_intern_prop (str, strlen (str), 1));
Kenichi Handa's avatar
Kenichi Handa committed
227
  if (FcPatternGetString (p, FC_FAMILY, 0, (FcChar8 **) &str) == FcResultMatch)
228
    ASET (entity, FONT_FAMILY_INDEX, font_intern_prop (str, strlen (str), 1));
229
  if (FcPatternGetInteger (p, FC_WEIGHT, 0, &numeric) == FcResultMatch)
230
    {
231 232 233
      if (numeric >= FC_WEIGHT_REGULAR && numeric < FC_WEIGHT_MEDIUM)
	numeric = FC_WEIGHT_MEDIUM;
      FONT_SET_STYLE (entity, FONT_WEIGHT_INDEX, make_number (numeric));
234
    }
235
  if (FcPatternGetInteger (p, FC_SLANT, 0, &numeric) == FcResultMatch)
236 237 238 239
    {
      numeric += 100;
      FONT_SET_STYLE (entity, FONT_SLANT_INDEX, make_number (numeric));
    }
240
  if (FcPatternGetInteger (p, FC_WIDTH, 0, &numeric) == FcResultMatch)
241 242 243
    {
      FONT_SET_STYLE (entity, FONT_WIDTH_INDEX, make_number (numeric));
    }
244
  if (FcPatternGetDouble (p, FC_PIXEL_SIZE, 0, &dbl) == FcResultMatch)
Kenichi Handa's avatar
Kenichi Handa committed
245 246 247
    {
      ASET (entity, FONT_SIZE_INDEX, make_number (dbl));
    }
248 249
  else
    ASET (entity, FONT_SIZE_INDEX, make_number (0));
250 251 252 253 254 255 256 257 258
  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)
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
    {
      ASET (entity, FONT_SIZE_INDEX, make_number (0));
      ASET (entity, FONT_AVGWIDTH_INDEX, make_number (0));
    }
  else
    {
      /* As this font is not scalable, parhaps this is a BDF or PCF
	 font. */ 
      FT_Face ft_face;

      ASET (entity, FONT_ADSTYLE_INDEX, get_adstyle_property (p));
      if ((ft_library || FT_Init_FreeType (&ft_library) == 0)
	  && FT_New_Face (ft_library, file, index, &ft_face) == 0)
	{
	  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);
	}
    }
281

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

287

288 289 290
static Lisp_Object ftfont_generic_family_list;

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

300
  family = Fintern (Fdowncase (SYMBOL_NAME (family)), Qnil);
301 302 303 304 305 306
  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))
307
    return Qnil;
308 309
  if (! EQ (XCDR (slot), Qt))
    return XCDR (slot);
310
  pattern = FcPatternDuplicate (pattern);
311 312
  if (! pattern)
    goto err;
313
  FcPatternDel (pattern, FC_FOUNDRY);
314 315
  FcPatternDel (pattern, FC_FAMILY);
  FcPatternAddString (pattern, FC_FAMILY, SYMBOL_FcChar8 (family));
Kenichi Handa's avatar
Kenichi Handa committed
316 317 318 319 320 321 322 323
  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);
    }
324
  FcConfigSubstitute (NULL, pattern, FcMatchPattern);
325 326 327
  FcDefaultSubstitute (pattern);
  match = FcFontMatch (NULL, pattern, &result);
  if (match)
328
    {
329 330 331 332
      FcChar8 *fam;

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

343 344 345 346 347 348 349
struct ftfont_cache_data
{
  FT_Face ft_face;
  FcCharSet *fc_charset;
};

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

Kenichi Handa's avatar
Kenichi Handa committed
357 358 359 360 361 362 363 364 365 366
  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;

367 368 369 370
  if (NILP (ft_face_cache))
    cache = Qnil;
  else
    cache = Fgethash (key, ft_face_cache, Qnil);
Kenichi Handa's avatar
Kenichi Handa committed
371 372
  if (NILP (cache))
    {
373 374 375 376 377 378 379 380
      if (NILP (ft_face_cache))
	{
	  Lisp_Object args[2];

	  args[0] = QCtest;
	  args[1] = Qequal;
	  ft_face_cache = Fmake_hash_table (2, args);
	}
381 382 383
      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
384
      val = make_save_value (NULL, 0);
385 386
      XSAVE_VALUE (val)->integer = 0;
      XSAVE_VALUE (val)->pointer = cache_data;
387 388
      cache = Fcons (Qnil, val);
      Fputhash (key, cache, ft_face_cache);
Kenichi Handa's avatar
Kenichi Handa committed
389 390 391
    }
  else
    {
392 393 394
      val = XCDR (cache);
      cache_data = XSAVE_VALUE (val)->pointer;
    }
395 396 397 398 399 400

  if (cache_for == FTFONT_CACHE_FOR_ENTITY)
    return cache;

  if (cache_for == FTFONT_CACHE_FOR_FACE
      ? ! cache_data->ft_face : ! cache_data->fc_charset)
401 402 403
    {
      char *filename = (char *) SDATA (XCAR (key));
      int index = XINT (XCDR (key));
Kenichi Handa's avatar
Kenichi Handa committed
404

405
      if (cache_for == FTFONT_CACHE_FOR_FACE)
406 407 408 409 410 411 412 413 414 415
	{
	  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
416 417 418 419
	  FcPattern *pat = NULL;
	  FcFontSet *fontset = NULL;
	  FcObjectSet *objset = NULL;
	  FcCharSet *charset = NULL;
420 421 422

	  pat = FcPatternBuild (0, FC_FILE, FcTypeString, (FcChar8 *) filename,
				FC_INDEX, FcTypeInteger, index, NULL);
Kenichi Handa's avatar
Kenichi Handa committed
423 424 425 426 427
	  if (! pat)
	    goto finish;
	  objset = FcObjectSetBuild (FC_CHARSET, FC_STYLE, NULL);
	  if (! objset)
	    goto finish;
428
	  fontset = FcFontList (NULL, pat, objset);
Kenichi Handa's avatar
Kenichi Handa committed
429 430
	  if (! fontset)
	    goto finish;
431 432
	  if (fontset && fontset->nfont > 0
	      && (FcPatternGetCharSet (fontset->fonts[0], FC_CHARSET, 0,
433
				       &charset)
434 435
		  == FcResultMatch))
	    cache_data->fc_charset = FcCharSetCopy (charset);
436 437
	  else
	    cache_data->fc_charset = FcCharSetCreate ();
Kenichi Handa's avatar
Kenichi Handa committed
438 439 440 441 442 443 444 445

	finish:
	  if (fontset)
	    FcFontSetDestroy (fontset);
	  if (objset)
	    FcObjectSetDestroy (objset);
	  if (pat)
	    FcPatternDestroy (pat);
446
	}
Kenichi Handa's avatar
Kenichi Handa committed
447 448 449 450
    }
  return cache;
}

451 452 453 454 455 456 457
FcCharSet *
ftfont_get_fc_charset (entity)
     Lisp_Object entity;
{
  Lisp_Object val, cache;
  struct ftfont_cache_data *cache_data;

458
  cache = ftfont_lookup_cache (entity, FTFONT_CACHE_FOR_CHARSET);
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
  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 */

488
static Lisp_Object ftfont_get_cache P_ ((FRAME_PTR));
Kenichi Handa's avatar
Kenichi Handa committed
489
static Lisp_Object ftfont_list P_ ((Lisp_Object, Lisp_Object));
490
static Lisp_Object ftfont_match P_ ((Lisp_Object, Lisp_Object));
Kenichi Handa's avatar
Kenichi Handa committed
491
static Lisp_Object ftfont_list_family P_ ((Lisp_Object));
492
static Lisp_Object ftfont_open P_ ((FRAME_PTR, Lisp_Object, int));
Kenichi Handa's avatar
Kenichi Handa committed
493 494 495 496 497 498 499 500 501
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 *));
502
static Lisp_Object ftfont_otf_capability P_ ((struct font *));
503
static Lisp_Object ftfont_shape P_ ((Lisp_Object));
504 505

#ifdef HAVE_OTF_GET_VARIATION_GLYPHS
506 507
static int ftfont_variation_glyphs P_ ((struct font *, int c,
					unsigned variations[256]));
508
#endif /* HAVE_OTF_GET_VARIATION_GLYPHS */
Kenichi Handa's avatar
Kenichi Handa committed
509 510 511

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

549
#ifdef HAVE_OTF_GET_VARIATION_GLYPHS
550
    ftfont_variation_glyphs,
551
#else
552
    NULL,
553
#endif
554 555

    ftfont_filter_properties, /* filter_properties */
Kenichi Handa's avatar
Kenichi Handa committed
556 557 558 559 560
  };

extern Lisp_Object QCname;

static Lisp_Object
561 562
ftfont_get_cache (f)
     FRAME_PTR f;
Kenichi Handa's avatar
Kenichi Handa committed
563 564 565 566
{
  return freetype_font_cache;
}

Kenichi Handa's avatar
Kenichi Handa committed
567 568 569 570
static int
ftfont_get_charset (registry)
     Lisp_Object registry;
{
571 572 573
  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
574 575
  int i, j;

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

598 599 600 601 602 603
      if (! charset)
	return -1;
      for (j = 0; uniquifier[j]; j++)
	if (! FcCharSetAddChar (charset, uniquifier[j]))
	  {
	    FcCharSetDestroy (charset);
Kenichi Handa's avatar
Kenichi Handa committed
604
	    return -1;
605 606
	  }
      fc_charset_table[i].fc_charset = charset;
Kenichi Handa's avatar
Kenichi Handa committed
607 608 609 610
    }
  return i;
}

611 612
struct OpenTypeSpec
{
613 614
  Lisp_Object script;
  unsigned int script_tag, langsys_tag;
615 616 617 618
  int nfeatures[2];
  unsigned int *features[2];
};

619
#define OTF_SYM_TAG(SYM, TAG)					\
620
  do {								\
621 622
    unsigned char *p = SDATA (SYMBOL_NAME (SYM));		\
    TAG = (p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3];	\
623 624
  } while (0)

625
#define OTF_TAG_STR(TAG, P)			\
626
  do {						\
627 628 629 630
    (P)[0] = (char) (TAG >> 24);		\
    (P)[1] = (char) ((TAG >> 16) & 0xFF);	\
    (P)[2] = (char) ((TAG >> 8) & 0xFF);	\
    (P)[3] = (char) (TAG & 0xFF);		\
631
    (P)[4] = '\0';				\
632 633
  } while (0)

634 635 636 637 638 639 640 641 642
#define OTF_TAG_SYM(SYM, TAG)			\
  do {						\
    char str[5];				\
    						\
    OTF_TAG_STR (TAG, str);			\
    (SYM) = font_intern_prop (str, 4, 1);	\
  } while (0)


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

Juanma Barranquero's avatar
Juanma Barranquero committed
675
      otf_spec = XCDR (otf_spec);
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 702 703 704 705 706
      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;
}

707
static FcPattern *ftfont_spec_pattern P_ ((Lisp_Object, char *,
708 709
					   struct OpenTypeSpec **,
					   char **langname));
Kenichi Handa's avatar
Kenichi Handa committed
710

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

729 730
  if ((n = FONT_SLANT_NUMERIC (spec)) >= 0
      && n < 100)
731
    /* Fontconfig doesn't support reverse-italic/obligue.  */
732 733 734 735 736 737 738
    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;
739

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

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

765
  otlayout[0] = '\0';
766 767
  for (extra = AREF (spec, FONT_EXTRA_INDEX);
       CONSP (extra); extra = XCDR (extra))
Kenichi Handa's avatar
Kenichi Handa committed
768
    {
769 770
      Lisp_Object key, val;

771 772 773 774
      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
775
	{
776 777
	  if (! langset)
	    langset = FcLangSetCreate ();
Kenichi Handa's avatar
Kenichi Handa committed
778 779
	  if (! langset)
	    goto err;
780
	  if (SYMBOLP (val))
Kenichi Handa's avatar
Kenichi Handa committed
781
	    {
782
	      if (! FcLangSetAdd (langset, SYMBOL_FcChar8 (val)))
Kenichi Handa's avatar
Kenichi Handa committed
783 784 785
		goto err;
	    }
	  else
786 787 788 789
	    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
790
	}
791 792 793 794 795 796 797 798 799
      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;
	}
800 801 802 803 804
      else if (EQ (key, QCscript))
	script = val;
      else if (EQ (key, QCscalable))
	scalable = ! NILP (val);
    }
Kenichi Handa's avatar
Kenichi Handa committed
805

806 807 808 809
  if (! NILP (script) && ! charset)
    {
      Lisp_Object chars = assq_no_quit (script, Vscript_representative_chars);

810
      if (CONSP (chars) && CONSP (CDR (chars)))
811 812 813 814 815 816 817 818
	{
	  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
819 820 821
	}
    }

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

846
  goto finish;
Kenichi Handa's avatar
Kenichi Handa committed
847

848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
 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);
868
  if (charset && fc_charset_idx < 0) FcCharSetDestroy (charset);
869 870 871 872 873 874 875
  return pattern;
}

static Lisp_Object
ftfont_list (frame, spec)
     Lisp_Object frame, spec;
{
Kenichi Handa's avatar
Kenichi Handa committed
876
  Lisp_Object val = Qnil, family, adstyle;
877 878 879 880
  int i;
  FcPattern *pattern;
  FcFontSet *fontset = NULL;
  FcObjectSet *objset = NULL;
881 882 883
  FcCharSet *charset;
  Lisp_Object chars = Qnil;
  FcResult result;
884 885
  char otlayout[15];		/* For "otlayout:XXXX" */
  struct OpenTypeSpec *otspec = NULL;
886
  int spacing = -1;
887
  char *langname = NULL;
Juanma Barranquero's avatar
Juanma Barranquero committed
888

889 890 891 892 893 894
  if (! fc_initialized)
    {
      FcInit ();
      fc_initialized = 1;
    }

895
  pattern = ftfont_spec_pattern (spec, otlayout, &otspec, &langname);
896 897
  if (! pattern)
    return Qnil;
898 899 900 901 902 903 904 905 906 907 908
  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;
    }
909 910
  if (INTEGERP (AREF (spec, FONT_SPACING_INDEX)))
    spacing = XINT (AREF (spec, FONT_SPACING_INDEX));
911 912 913 914 915
  family = AREF (spec, FONT_FAMILY_INDEX);
  if (! NILP (family))
    {
      Lisp_Object resolved;

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

943
  fontset = FcFontList (NULL, pattern, objset);
944 945
  if (! fontset || fontset->nfont == 0)
    goto finish;
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
#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);
967
	      if (fontset && fontset->nfont > 0)
968 969 970 971 972
		break;
	    }
	}
    }
#endif
973
  for (i = 0; i < fontset->nfont; i++)
974
    {
975
      Lisp_Object entity;
976

977