font.c 144 KB
Newer Older
Kenichi Handa's avatar
Kenichi Handa committed
1
/* font.c -- "Font" primitives.
Glenn Morris's avatar
Glenn Morris committed
2

3
Copyright (C) 2006-2014 Free Software Foundation, Inc.
4 5 6
Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011
  National Institute of Advanced Industrial Science and Technology (AIST)
  Registration Number H13PRO009
Kenichi Handa's avatar
Kenichi Handa committed
7 8 9

This file is part of GNU Emacs.

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

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

#include <config.h>
24
#include <float.h>
Kenichi Handa's avatar
Kenichi Handa committed
25 26
#include <stdio.h>

27 28
#include <c-ctype.h>

Kenichi Handa's avatar
Kenichi Handa committed
29
#include "lisp.h"
30
#include "character.h"
Kenichi Handa's avatar
Kenichi Handa committed
31 32
#include "buffer.h"
#include "frame.h"
Kenichi Handa's avatar
Kenichi Handa committed
33
#include "window.h"
Kenichi Handa's avatar
Kenichi Handa committed
34 35 36 37 38 39
#include "dispextern.h"
#include "charset.h"
#include "composite.h"
#include "fontset.h"
#include "font.h"

40 41 42
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
43

44
Lisp_Object Qopentype;
Kenichi Handa's avatar
Kenichi Handa committed
45

Kenichi Handa's avatar
Kenichi Handa committed
46
/* Important character set strings.  */
Kenichi Handa's avatar
Kenichi Handa committed
47
Lisp_Object Qascii_0, Qiso8859_1, Qiso10646_1, Qunicode_bmp, Qunicode_sip;
48

49 50
#define DEFAULT_ENCODING Qiso8859_1

Kenichi Handa's avatar
Kenichi Handa committed
51 52 53
/* Unicode category `Cf'.  */
static Lisp_Object QCf;

54
/* Vector of Vfont_weight_table, Vfont_slant_table, and Vfont_width_table. */
Kenichi Handa's avatar
Kenichi Handa committed
55 56
static Lisp_Object font_style_table;

57 58 59 60 61 62 63 64
/* Structure used for tables mapping weight, slant, and width numeric
   values and their names.  */

struct table_entry
{
  int numeric;
  /* The first one is a valid name as a face attribute.
     The second one (if any) is a typical name in XLFD field.  */
65
  const char *names[5];
66 67 68 69 70
};

/* Table of weight numeric values and their names.  This table must be
   sorted by numeric values in ascending order.  */

71
static const struct table_entry weight_table[] =
72 73 74 75 76 77
{
  { 0, { "thin" }},
  { 20, { "ultra-light", "ultralight" }},
  { 40, { "extra-light", "extralight" }},
  { 50, { "light" }},
  { 75, { "semi-light", "semilight", "demilight", "book" }},
78
  { 100, { "normal", "medium", "regular", "unspecified" }},
79 80 81 82 83 84 85 86 87
  { 180, { "semi-bold", "semibold", "demibold", "demi" }},
  { 200, { "bold" }},
  { 205, { "extra-bold", "extrabold" }},
  { 210, { "ultra-bold", "ultrabold", "black" }}
};

/* Table of slant numeric values and their names.  This table must be
   sorted by numeric values in ascending order.  */

88
static const struct table_entry slant_table[] =
89 90 91
{
  { 0, { "reverse-oblique", "ro" }},
  { 10, { "reverse-italic", "ri" }},
92
  { 100, { "normal", "r", "unspecified" }},
93 94 95 96 97 98 99
  { 200, { "italic" ,"i", "ot" }},
  { 210, { "oblique", "o" }}
};

/* Table of width numeric values and their names.  This table must be
   sorted by numeric values in ascending order.  */

100
static const struct table_entry width_table[] =
101 102 103 104 105
{
  { 50, { "ultra-condensed", "ultracondensed" }},
  { 63, { "extra-condensed", "extracondensed" }},
  { 75, { "condensed", "compressed", "narrow" }},
  { 87, { "semi-condensed", "semicondensed", "demicondensed" }},
106
  { 100, { "normal", "medium", "regular", "unspecified" }},
107 108 109 110 111 112
  { 113, { "semi-expanded", "semiexpanded", "demiexpanded" }},
  { 125, { "expanded" }},
  { 150, { "extra-expanded", "extraexpanded" }},
  { 200, { "ultra-expanded", "ultraexpanded", "wide" }}
};

Andreas Schwab's avatar
Andreas Schwab committed
113 114
Lisp_Object QCfoundry;
static Lisp_Object QCadstyle, QCregistry;
Kenichi Handa's avatar
Kenichi Handa committed
115
/* Symbols representing keys of font extra info.  */
Kenichi Handa's avatar
Kenichi Handa committed
116
Lisp_Object QCspacing, QCdpi, QCscalable, QCotf, QClang, QCscript, QCavgwidth;
117 118
Lisp_Object QCantialias, QCfont_entity;
static Lisp_Object QCfc_unknown_spec;
119
/* Symbols representing values of font spacing property.  */
120 121
static Lisp_Object Qc, Qm, Qd;
Lisp_Object Qp;
122 123 124
/* Special ADSTYLE properties to avoid fonts used for Latin
   characters; used in xfont.c and ftfont.c.  */
Lisp_Object Qja, Qko;
Kenichi Handa's avatar
Kenichi Handa committed
125

126
static Lisp_Object QCuser_spec;
127

128
/* Alist of font registry symbols and the corresponding charset
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
   information.  The information is retrieved from
   Vfont_encoding_alist on demand.

   Eash element has the form:
	(REGISTRY . (ENCODING-CHARSET-ID . REPERTORY-CHARSET-ID))
   or
	(REGISTRY . nil)

   In the former form, ENCODING-CHARSET-ID is an ID of a charset that
   encodes a character code to a glyph code of a font, and
   REPERTORY-CHARSET-ID is an ID of a charset that tells if a
   character is supported by a font.

   The latter form means that the information for REGISTRY couldn't be
   retrieved.  */
static Lisp_Object font_charset_alist;

146 147
/* List of all font drivers.  Each font-backend (XXXfont.c) calls
   register_font_driver in syms_of_XXXfont to register its font-driver
Kenichi Handa's avatar
Kenichi Handa committed
148 149 150
   here.  */
static struct font_driver_list *font_driver_list;

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
#ifdef ENABLE_CHECKING

/* Used to catch bogus pointers in font objects.  */

bool
valid_font_driver (struct font_driver *drv)
{
  Lisp_Object tail, frame;
  struct font_driver_list *fdl;

  for (fdl = font_driver_list; fdl; fdl = fdl->next)
    if (fdl->driver == drv)
      return true;
  FOR_EACH_FRAME (tail, frame)
    for (fdl = XFRAME (frame)->font_driver_list; fdl; fdl = fdl->next)
      if (fdl->driver == drv)
	return true;
  return false;
}

#endif /* ENABLE_CHECKING */
Kenichi Handa's avatar
Kenichi Handa committed
172

Paul Eggert's avatar
Paul Eggert committed
173
/* Creators of font-related Lisp object.  */
Kenichi Handa's avatar
Kenichi Handa committed
174

Andreas Schwab's avatar
Andreas Schwab committed
175
static Lisp_Object
176
font_make_spec (void)
Kenichi Handa's avatar
Kenichi Handa committed
177 178 179 180 181 182 183 184 185 186 187
{
  Lisp_Object font_spec;
  struct font_spec *spec
    = ((struct font_spec *)
       allocate_pseudovector (VECSIZE (struct font_spec),
			      FONT_SPEC_MAX, PVEC_FONT));
  XSETFONT (font_spec, spec);
  return font_spec;
}

Lisp_Object
188
font_make_entity (void)
Kenichi Handa's avatar
Kenichi Handa committed
189 190 191 192 193 194 195 196 197 198
{
  Lisp_Object font_entity;
  struct font_entity *entity
    = ((struct font_entity *)
       allocate_pseudovector (VECSIZE (struct font_entity),
			      FONT_ENTITY_MAX, PVEC_FONT));
  XSETFONT (font_entity, entity);
  return font_entity;
}

199 200 201
/* Create a font-object whose structure size is SIZE.  If ENTITY is
   not nil, copy properties from ENTITY to the font-object.  If
   PIXELSIZE is positive, set the `size' property to PIXELSIZE.  */
Kenichi Handa's avatar
Kenichi Handa committed
202
Lisp_Object
203
font_make_object (int size, Lisp_Object entity, int pixelsize)
Kenichi Handa's avatar
Kenichi Handa committed
204 205 206 207
{
  Lisp_Object font_object;
  struct font *font
    = (struct font *) allocate_pseudovector (size, FONT_OBJECT_MAX, PVEC_FONT);
208 209
  int i;

210 211 212
  /* GC can happen before the driver is set up,
     so avoid dangling pointer here (Bug#17771).  */
  font->driver = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
213 214
  XSETFONT (font_object, font);

215 216 217 218 219 220
  if (! NILP (entity))
    {
      for (i = 1; i < FONT_SPEC_MAX; i++)
	font->props[i] = AREF (entity, i);
      if (! NILP (AREF (entity, FONT_EXTRA_INDEX)))
	font->props[FONT_EXTRA_INDEX]
221
	  = Fcopy_alist (AREF (entity, FONT_EXTRA_INDEX));
222 223 224
    }
  if (size > 0)
    font->props[FONT_SIZE_INDEX] = make_number (pixelsize);
Kenichi Handa's avatar
Kenichi Handa committed
225 226 227 228 229
  return font_object;
}



Dmitry Antipov's avatar
Dmitry Antipov committed
230 231 232
static int font_pixel_size (struct frame *f, Lisp_Object);
static Lisp_Object font_open_entity (struct frame *, Lisp_Object, int);
static Lisp_Object font_matching_entity (struct frame *, Lisp_Object *,
233
                                         Lisp_Object);
Andreas Schwab's avatar
Andreas Schwab committed
234
static unsigned font_encode_char (Lisp_Object, int);
Kenichi Handa's avatar
Kenichi Handa committed
235 236 237 238

/* Number of registered font drivers.  */
static int num_font_drivers;

Kenichi Handa's avatar
Kenichi Handa committed
239 240

/* Return a Lispy value of a font property value at STR and LEN bytes.
241 242 243
   If STR is "*", return nil.  If FORCE_SYMBOL, or if STR does not
   consist entirely of one or more digits, return a symbol interned
   from STR.  Otherwise, return an integer.  */
Kenichi Handa's avatar
Kenichi Handa committed
244 245

Lisp_Object
246
font_intern_prop (const char *str, ptrdiff_t len, bool force_symbol)
Kenichi Handa's avatar
Kenichi Handa committed
247
{
248
  ptrdiff_t i;
249
  Lisp_Object tem;
Kenichi Handa's avatar
Kenichi Handa committed
250
  Lisp_Object obarray;
251
  ptrdiff_t nbytes, nchars;
Kenichi Handa's avatar
Kenichi Handa committed
252 253 254

  if (len == 1 && *str == '*')
    return Qnil;
255
  if (!force_symbol && 0 < len && '0' <= *str && *str <= '9')
Kenichi Handa's avatar
Kenichi Handa committed
256 257
    {
      for (i = 1; i < len; i++)
258
	if (! ('0' <= str[i] && str[i] <= '9'))
Kenichi Handa's avatar
Kenichi Handa committed
259 260
	  break;
      if (i == len)
261
	{
262 263 264 265 266 267 268
	  EMACS_INT n;

	  i = 0;
	  for (n = 0; (n += str[i++] - '0') <= MOST_POSITIVE_FIXNUM; n *= 10)
	    {
	      if (i == len)
		return make_number (n);
269
	      if (MOST_POSITIVE_FIXNUM / 10 < n)
270 271 272 273
		break;
	    }

	  xsignal1 (Qoverflow_error, make_string (str, len));
274
	}
Kenichi Handa's avatar
Kenichi Handa committed
275 276
    }

277 278
  /* This code is similar to intern function from lread.c.  */
  obarray = check_obarray (Vobarray);
279
  parse_str_as_multibyte ((unsigned char *) str, len, &nchars, &nbytes);
280 281 282
  tem = oblookup (obarray, str,
		  (len == nchars || len != nbytes) ? len : nchars, len);

Kenichi Handa's avatar
Kenichi Handa committed
283 284
  if (SYMBOLP (tem))
    return tem;
285 286
  tem = make_specified_string (str, nchars, len,
			       len != nchars && len == nbytes);
287
  return Fintern (tem, obarray);
Kenichi Handa's avatar
Kenichi Handa committed
288 289
}

290
/* Return a pixel size of font-spec SPEC on frame F.  */
291

292
static int
Dmitry Antipov's avatar
Dmitry Antipov committed
293
font_pixel_size (struct frame *f, Lisp_Object spec)
294
{
295
#ifdef HAVE_WINDOW_SYSTEM
296 297
  Lisp_Object size = AREF (spec, FONT_SIZE_INDEX);
  double point_size;
Kenichi Handa's avatar
Kenichi Handa committed
298
  int dpi, pixel_size;
299
  Lisp_Object val;
300

301 302 303
  if (INTEGERP (size))
    return XINT (size);
  if (NILP (size))
304
    return 0;
305
  eassert (FLOATP (size));
306
  point_size = XFLOAT_DATA (size);
Kenichi Handa's avatar
Kenichi Handa committed
307 308
  val = AREF (spec, FONT_DPI_INDEX);
  if (INTEGERP (val))
309
    dpi = XINT (val);
310
  else
311
    dpi = FRAME_RES_Y (f);
312 313
  pixel_size = POINT_TO_PIXEL (point_size, dpi);
  return pixel_size;
314 315 316
#else
  return 1;
#endif
317 318
}

Kenichi Handa's avatar
Kenichi Handa committed
319

Kenichi Handa's avatar
Kenichi Handa committed
320 321 322 323
/* Return a value of PROP's VAL (symbol or integer) to be stored in a
   font vector.  If VAL is not valid (i.e. not registered in
   font_style_table), return -1 if NOERROR is zero, and return a
   proper index if NOERROR is nonzero.  In that case, register VAL in
324
   font_style_table if VAL is a symbol, and return the closest index if
Kenichi Handa's avatar
Kenichi Handa committed
325
   VAL is an integer.  */
Kenichi Handa's avatar
Kenichi Handa committed
326

Kenichi Handa's avatar
Kenichi Handa committed
327
int
328 329
font_style_to_value (enum font_property_index prop, Lisp_Object val,
                     bool noerror)
Kenichi Handa's avatar
Kenichi Handa committed
330
{
Kenichi Handa's avatar
Kenichi Handa committed
331
  Lisp_Object table = AREF (font_style_table, prop - FONT_WEIGHT_INDEX);
332 333 334 335
  int len;

  CHECK_VECTOR (table);
  len = ASIZE (table);
Kenichi Handa's avatar
Kenichi Handa committed
336

Kenichi Handa's avatar
Kenichi Handa committed
337
  if (SYMBOLP (val))
Kenichi Handa's avatar
Kenichi Handa committed
338
    {
339
      int i, j;
340
      char *s;
Kenichi Handa's avatar
Kenichi Handa committed
341 342 343 344
      Lisp_Object args[2], elt;

      /* At first try exact match.  */
      for (i = 0; i < len; i++)
345 346 347 348 349 350 351 352 353 354
	{
	  CHECK_VECTOR (AREF (table, i));
	  for (j = 1; j < ASIZE (AREF (table, i)); j++)
	    if (EQ (val, AREF (AREF (table, i), j)))
	      {
		CHECK_NUMBER (AREF (AREF (table, i), 0));
		return ((XINT (AREF (AREF (table, i), 0)) << 8)
			| (i << 4) | (j - 1));
	      }
	}
Kenichi Handa's avatar
Kenichi Handa committed
355
      /* Try also with case-folding match.  */
356
      s = SSDATA (SYMBOL_NAME (val));
Kenichi Handa's avatar
Kenichi Handa committed
357
      for (i = 0; i < len; i++)
358 359 360
	for (j = 1; j < ASIZE (AREF (table, i)); j++)
	  {
	    elt = AREF (AREF (table, i), j);
361
	    if (xstrcasecmp (s, SSDATA (SYMBOL_NAME (elt))) == 0)
362 363 364 365 366
	      {
		CHECK_NUMBER (AREF (AREF (table, i), 0));
		return ((XINT (AREF (AREF (table, i), 0)) << 8)
			| (i << 4) | (j - 1));
	      }
367
	  }
Kenichi Handa's avatar
Kenichi Handa committed
368 369
      if (! noerror)
	return -1;
370
      eassert (len < 255);
371
      elt = Fmake_vector (make_number (2), make_number (100));
372
      ASET (elt, 1, val);
Kenichi Handa's avatar
Kenichi Handa committed
373
      args[0] = table;
374
      args[1] = Fmake_vector (make_number (1), elt);
Kenichi Handa's avatar
Kenichi Handa committed
375
      ASET (font_style_table, prop - FONT_WEIGHT_INDEX, Fvconcat (2, args));
376
      return (100 << 8) | (i << 4);
Kenichi Handa's avatar
Kenichi Handa committed
377
    }
Kenichi Handa's avatar
Kenichi Handa committed
378 379
  else
    {
380
      int i, last_n;
381
      EMACS_INT numeric = XINT (val);
Kenichi Handa's avatar
Kenichi Handa committed
382

383
      for (i = 0, last_n = -1; i < len; i++)
Kenichi Handa's avatar
Kenichi Handa committed
384
	{
385
	  int n;
Kenichi Handa's avatar
Kenichi Handa committed
386

387 388 389
	  CHECK_VECTOR (AREF (table, i));
	  CHECK_NUMBER (AREF (AREF (table, i), 0));
	  n = XINT (AREF (AREF (table, i), 0));
Kenichi Handa's avatar
Kenichi Handa committed
390
	  if (numeric == n)
391
	    return (n << 8) | (i << 4);
Kenichi Handa's avatar
Kenichi Handa committed
392 393 394 395
	  if (numeric < n)
	    {
	      if (! noerror)
		return -1;
396 397
	      return ((i == 0 || n - numeric < numeric - last_n)
		      ? (n << 8) | (i << 4): (last_n << 8 | ((i - 1) << 4)));
Kenichi Handa's avatar
Kenichi Handa committed
398 399 400 401 402
	    }
	  last_n = n;
	}
      if (! noerror)
	return -1;
403
      return ((last_n << 8) | ((i - 1) << 4));
Kenichi Handa's avatar
Kenichi Handa committed
404 405
    }
}
Kenichi Handa's avatar
Kenichi Handa committed
406 407

Lisp_Object
408 409
font_style_symbolic (Lisp_Object font, enum font_property_index prop,
                     bool for_face)
Kenichi Handa's avatar
Kenichi Handa committed
410
{
411
  Lisp_Object val = AREF (font, prop);
412 413
  Lisp_Object table, elt;
  int i;
Kenichi Handa's avatar
Kenichi Handa committed
414

Kenichi Handa's avatar
Kenichi Handa committed
415 416 417
  if (NILP (val))
    return Qnil;
  table = AREF (font_style_table, prop - FONT_WEIGHT_INDEX);
418
  CHECK_VECTOR (table);
419
  i = XINT (val) & 0xFF;
420
  eassert (((i >> 4) & 0xF) < ASIZE (table));
421
  elt = AREF (table, ((i >> 4) & 0xF));
422
  CHECK_VECTOR (elt);
423
  eassert ((i & 0xF) + 1 < ASIZE (elt));
424 425 426
  elt = (for_face ? AREF (elt, 1) : AREF (elt, (i & 0xF) + 1));
  CHECK_SYMBOL (elt);
  return elt;
427 428
}

429 430 431 432 433
/* Return ENCODING or a cons of ENCODING and REPERTORY of the font
   FONTNAME.  ENCODING is a charset symbol that specifies the encoding
   of the font.  REPERTORY is a charset symbol or nil.  */

Lisp_Object
434
find_font_encoding (Lisp_Object fontname)
435 436 437 438 439 440 441 442 443 444 445 446 447 448
{
  Lisp_Object tail, elt;

  for (tail = Vfont_encoding_alist; CONSP (tail); tail = XCDR (tail))
    {
      elt = XCAR (tail);
      if (CONSP (elt)
	  && STRINGP (XCAR (elt))
	  && fast_string_match_ignore_case (XCAR (elt), fontname) >= 0
	  && (SYMBOLP (XCDR (elt))
	      ? CHARSETP (XCDR (elt))
	      : CONSP (XCDR (elt)) && CHARSETP (XCAR (XCDR (elt)))))
	return (XCDR (elt));
    }
449
  return Qnil;
450 451
}

452 453 454 455 456
/* Return encoding charset and repertory charset for REGISTRY in
   ENCODING and REPERTORY correspondingly.  If correct information for
   REGISTRY is available, return 0.  Otherwise return -1.  */

int
457
font_registry_charsets (Lisp_Object registry, struct charset **encoding, struct charset **repertory)
458 459 460 461
{
  Lisp_Object val;
  int encoding_id, repertory_id;

Kenichi Handa's avatar
Kenichi Handa committed
462
  val = Fassoc_string (registry, font_charset_alist, Qt);
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 488 489 490
  if (! NILP (val))
    {
      val = XCDR (val);
      if (NILP (val))
	return -1;
      encoding_id = XINT (XCAR (val));
      repertory_id = XINT (XCDR (val));
    }
  else
    {
      val = find_font_encoding (SYMBOL_NAME (registry));
      if (SYMBOLP (val) && CHARSETP (val))
	{
	  encoding_id = repertory_id = XINT (CHARSET_SYMBOL_ID (val));
	}
      else if (CONSP (val))
	{
	  if (! CHARSETP (XCAR (val)))
	    goto invalid_entry;
	  encoding_id = XINT (CHARSET_SYMBOL_ID (XCAR (val)));
	  if (NILP (XCDR (val)))
	    repertory_id = -1;
	  else
	    {
	      if (! CHARSETP (XCDR (val)))
		goto invalid_entry;
	      repertory_id = XINT (CHARSET_SYMBOL_ID (XCDR (val)));
	    }
491
	}
492 493 494 495
      else
	goto invalid_entry;
      val = Fcons (make_number (encoding_id), make_number (repertory_id));
      font_charset_alist
496
	= nconc2 (font_charset_alist, list1 (Fcons (registry, val)));
497 498 499 500 501 502 503 504 505 506
    }

  if (encoding)
    *encoding = CHARSET_FROM_ID (encoding_id);
  if (repertory)
    *repertory = repertory_id >= 0 ? CHARSET_FROM_ID (repertory_id) : NULL;
  return 0;

 invalid_entry:
  font_charset_alist
507
    = nconc2 (font_charset_alist, list1 (Fcons (registry, Qnil)));
508 509 510
  return -1;
}

Kenichi Handa's avatar
Kenichi Handa committed
511

512
/* Font property value validators.  See the comment of
513 514
   font_property_table for the meaning of the arguments.  */

515 516 517 518 519 520
static Lisp_Object font_prop_validate (int, Lisp_Object, Lisp_Object);
static Lisp_Object font_prop_validate_symbol (Lisp_Object, Lisp_Object);
static Lisp_Object font_prop_validate_style (Lisp_Object, Lisp_Object);
static Lisp_Object font_prop_validate_non_neg (Lisp_Object, Lisp_Object);
static Lisp_Object font_prop_validate_spacing (Lisp_Object, Lisp_Object);
static int get_font_prop_index (Lisp_Object);
Kenichi Handa's avatar
Kenichi Handa committed
521 522

static Lisp_Object
523
font_prop_validate_symbol (Lisp_Object prop, Lisp_Object val)
Kenichi Handa's avatar
Kenichi Handa committed
524 525
{
  if (STRINGP (val))
Kenichi Handa's avatar
Kenichi Handa committed
526 527
    val = Fintern (val, Qnil);
  if (! SYMBOLP (val))
Kenichi Handa's avatar
Kenichi Handa committed
528
    val = Qerror;
Kenichi Handa's avatar
Kenichi Handa committed
529 530
  else if (EQ (prop, QCregistry))
    val = Fintern (Fdowncase (SYMBOL_NAME (val)), Qnil);
Kenichi Handa's avatar
Kenichi Handa committed
531 532 533
  return val;
}

Kenichi Handa's avatar
Kenichi Handa committed
534

Kenichi Handa's avatar
Kenichi Handa committed
535
static Lisp_Object
536
font_prop_validate_style (Lisp_Object style, Lisp_Object val)
Kenichi Handa's avatar
Kenichi Handa committed
537
{
Kenichi Handa's avatar
Kenichi Handa committed
538 539 540 541
  enum font_property_index prop = (EQ (style, QCweight) ? FONT_WEIGHT_INDEX
				   : EQ (style, QCslant) ? FONT_SLANT_INDEX
				   : FONT_WIDTH_INDEX);
  if (INTEGERP (val))
Kenichi Handa's avatar
Kenichi Handa committed
542
    {
543
      EMACS_INT n = XINT (val);
544
      CHECK_VECTOR (AREF (font_style_table, prop - FONT_WEIGHT_INDEX));
545
      if (((n >> 4) & 0xF)
Kenichi Handa's avatar
Kenichi Handa committed
546
	  >= ASIZE (AREF (font_style_table, prop - FONT_WEIGHT_INDEX)))
Kenichi Handa's avatar
Kenichi Handa committed
547 548 549
	val = Qerror;
      else
	{
550 551
	  Lisp_Object elt = AREF (AREF (font_style_table, prop - FONT_WEIGHT_INDEX), (n >> 4) & 0xF);

552
	  CHECK_VECTOR (elt);
553 554
	  if ((n & 0xF) + 1 >= ASIZE (elt))
	    val = Qerror;
555 556 557 558 559 560
	  else
	    {
	      CHECK_NUMBER (AREF (elt, 0));
	      if (XINT (AREF (elt, 0)) != (n >> 8))
		val = Qerror;
	    }
Kenichi Handa's avatar
Kenichi Handa committed
561 562
	}
    }
Kenichi Handa's avatar
Kenichi Handa committed
563 564 565 566 567 568 569 570
  else if (SYMBOLP (val))
    {
      int n = font_style_to_value (prop, val, 0);

      val = n >= 0 ? make_number (n) : Qerror;
    }
  else
    val = Qerror;
Kenichi Handa's avatar
Kenichi Handa committed
571 572 573 574
  return val;
}

static Lisp_Object
575
font_prop_validate_non_neg (Lisp_Object prop, Lisp_Object val)
Kenichi Handa's avatar
Kenichi Handa committed
576 577 578 579 580 581
{
  return (NATNUMP (val) || (FLOATP (val) && XFLOAT_DATA (val) >= 0)
	  ? val : Qerror);
}

static Lisp_Object
582
font_prop_validate_spacing (Lisp_Object prop, Lisp_Object val)
583 584 585
{
  if (NILP (val) || (NATNUMP (val) && XINT (val) <= FONT_SPACING_CHARCELL))
    return val;
586 587 588 589 590 591 592 593
  if (SYMBOLP (val) && SBYTES (SYMBOL_NAME (val)) == 1)
    {
      char spacing = SDATA (SYMBOL_NAME (val))[0];

      if (spacing == 'c' || spacing == 'C')
	return make_number (FONT_SPACING_CHARCELL);
      if (spacing == 'm' || spacing == 'M')
	return make_number (FONT_SPACING_MONO);
594
      if (spacing == 'p' || spacing == 'P')
595 596 597 598
	return make_number (FONT_SPACING_PROPORTIONAL);
      if (spacing == 'd' || spacing == 'D')
	return make_number (FONT_SPACING_DUAL);
    }
599 600 601
  return Qerror;
}

602
static Lisp_Object
603
font_prop_validate_otf (Lisp_Object prop, Lisp_Object val)
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
{
  Lisp_Object tail, tmp;
  int i;

  /* VAL = (SCRIPT [ LANGSYS [ GSUB-FEATURES [ GPOS-FEATURES ]]])
     GSUB-FEATURES = (FEATURE ... [ nil FEATURE ... ]) | nil
     GPOS-FEATURES = (FEATURE ... [ nil FEATURE ... ]) | nil  */
  if (! CONSP (val))
    return Qerror;
  if (! SYMBOLP (XCAR (val)))
    return Qerror;
  tail = XCDR (val);
  if (NILP (tail))
    return val;
  if (! CONSP (tail) || ! SYMBOLP (XCAR (val)))
    return Qerror;
  for (i = 0; i < 2; i++)
    {
      tail = XCDR (tail);
      if (NILP (tail))
	return val;
      if (! CONSP (tail))
	return Qerror;
      for (tmp = XCAR (tail); CONSP (tmp); tmp = XCDR (tmp))
	if (! SYMBOLP (XCAR (tmp)))
	  return Qerror;
      if (! NILP (tmp))
	return Qerror;
    }
  return val;
}

636
/* Structure of known font property keys and validator of the
637
   values.  */
638
static const struct
Kenichi Handa's avatar
Kenichi Handa committed
639
{
640
  /* Pointer to the key symbol.  */
Kenichi Handa's avatar
Kenichi Handa committed
641
  Lisp_Object *key;
642 643 644
  /* Function to validate PROP's value VAL, or NULL if any value is
     ok.  The value is VAL or its regularized value if VAL is valid,
     and Qerror if not.  */
Paul Eggert's avatar
Paul Eggert committed
645
  Lisp_Object (*validator) (Lisp_Object prop, Lisp_Object val);
646 647
} font_property_table[] =
  { { &QCtype, font_prop_validate_symbol },
Kenichi Handa's avatar
Kenichi Handa committed
648 649 650 651 652 653 654
    { &QCfoundry, font_prop_validate_symbol },
    { &QCfamily, font_prop_validate_symbol },
    { &QCadstyle, font_prop_validate_symbol },
    { &QCregistry, font_prop_validate_symbol },
    { &QCweight, font_prop_validate_style },
    { &QCslant, font_prop_validate_style },
    { &QCwidth, font_prop_validate_style },
655 656 657
    { &QCsize, font_prop_validate_non_neg },
    { &QCdpi, font_prop_validate_non_neg },
    { &QCspacing, font_prop_validate_spacing },
Kenichi Handa's avatar
Kenichi Handa committed
658 659 660 661 662 663
    { &QCavgwidth, font_prop_validate_non_neg },
    /* The order of the above entries must match with enum
       font_property_index.  */
    { &QClang, font_prop_validate_symbol },
    { &QCscript, font_prop_validate_symbol },
    { &QCotf, font_prop_validate_otf }
Kenichi Handa's avatar
Kenichi Handa committed
664 665
  };

666
/* Return an index number of font property KEY or -1 if KEY is not an
Kenichi Handa's avatar
Kenichi Handa committed
667
   already known property.  */
668

669
static int
670
get_font_prop_index (Lisp_Object key)
Kenichi Handa's avatar
Kenichi Handa committed
671
{
Kenichi Handa's avatar
Kenichi Handa committed
672 673
  int i;

674
  for (i = 0; i < ARRAYELTS (font_property_table); i++)
Kenichi Handa's avatar
Kenichi Handa committed
675 676
    if (EQ (key, *font_property_table[i].key))
      return i;
677
  return -1;
Kenichi Handa's avatar
Kenichi Handa committed
678 679
}

Kenichi Handa's avatar
Kenichi Handa committed
680 681 682
/* Validate the font property.  The property key is specified by the
   symbol PROP, or the index IDX (if PROP is nil).  If VAL is invalid,
   signal an error.  The value is VAL or the regularized one.  */
683

Kenichi Handa's avatar
Kenichi Handa committed
684
static Lisp_Object
685
font_prop_validate (int idx, Lisp_Object prop, Lisp_Object val)
Kenichi Handa's avatar
Kenichi Handa committed
686
{
Kenichi Handa's avatar
Kenichi Handa committed
687
  Lisp_Object validated;
Kenichi Handa's avatar
Kenichi Handa committed
688

689 690
  if (NILP (val))
    return val;
Kenichi Handa's avatar
Kenichi Handa committed
691 692 693
  if (NILP (prop))
    prop = *font_property_table[idx].key;
  else
694
    {
Kenichi Handa's avatar
Kenichi Handa committed
695 696 697
      idx = get_font_prop_index (prop);
      if (idx < 0)
	return val;
698
    }
Paul Eggert's avatar
Paul Eggert committed
699
  validated = (font_property_table[idx].validator) (prop, val);
Kenichi Handa's avatar
Kenichi Handa committed
700 701 702
  if (EQ (validated, Qerror))
    signal_error ("invalid font property", Fcons (prop, val));
  return validated;
Kenichi Handa's avatar
Kenichi Handa committed
703
}
704

Kenichi Handa's avatar
Kenichi Handa committed
705 706 707

/* Store VAL as a value of extra font property PROP in FONT while
   keeping the sorting order.  Don't check the validity of VAL.  */
708

709
Lisp_Object
710
font_put_extra (Lisp_Object font, Lisp_Object prop, Lisp_Object val)
711 712
{
  Lisp_Object extra = AREF (font, FONT_EXTRA_INDEX);
713
  Lisp_Object slot = (NILP (extra) ? Qnil : assq_no_quit (prop, extra));
714 715 716

  if (NILP (slot))
    {
Kenichi Handa's avatar
Kenichi Handa committed
717 718 719 720 721
      Lisp_Object prev = Qnil;

      while (CONSP (extra)
	     && NILP (Fstring_lessp (prop, XCAR (XCAR (extra)))))
	prev = extra, extra = XCDR (extra);
722

723
      if (NILP (prev))
724
        ASET (font, FONT_EXTRA_INDEX, Fcons (Fcons (prop, val), extra));
725
      else
726
        XSETCDR (prev, Fcons (Fcons (prop, val), extra));
727

728
      return val;
729 730
    }
  XSETCDR (slot, val);
731 732
  if (NILP (val))
    ASET (font, FONT_EXTRA_INDEX, Fdelq (slot, extra));
733
  return val;
734 735
}

Kenichi Handa's avatar
Kenichi Handa committed
736

737
/* Font name parser and unparser.  */
Kenichi Handa's avatar
Kenichi Handa committed
738

739
static int parse_matrix (const char *);
740
static int font_expand_wildcards (Lisp_Object *, int);
741
static int font_parse_name (char *, ptrdiff_t, Lisp_Object);
Kenichi Handa's avatar
Kenichi Handa committed
742

743
/* An enumerator for each field of an XLFD font name.  */
Kenichi Handa's avatar
Kenichi Handa committed
744 745 746 747 748 749 750 751
enum xlfd_field_index
{
  XLFD_FOUNDRY_INDEX,
  XLFD_FAMILY_INDEX,
  XLFD_WEIGHT_INDEX,
  XLFD_SLANT_INDEX,
  XLFD_SWIDTH_INDEX,
  XLFD_ADSTYLE_INDEX,
752 753
  XLFD_PIXEL_INDEX,
  XLFD_POINT_INDEX,
Kenichi Handa's avatar
Kenichi Handa committed
754 755 756 757 758 759 760 761 762
  XLFD_RESX_INDEX,
  XLFD_RESY_INDEX,
  XLFD_SPACING_INDEX,
  XLFD_AVGWIDTH_INDEX,
  XLFD_REGISTRY_INDEX,
  XLFD_ENCODING_INDEX,
  XLFD_LAST_INDEX
};

763
/* An enumerator for mask bit corresponding to each XLFD field.  */
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
enum xlfd_field_mask
{
  XLFD_FOUNDRY_MASK = 0x0001,
  XLFD_FAMILY_MASK = 0x0002,
  XLFD_WEIGHT_MASK = 0x0004,
  XLFD_SLANT_MASK = 0x0008,
  XLFD_SWIDTH_MASK = 0x0010,
  XLFD_ADSTYLE_MASK = 0x0020,
  XLFD_PIXEL_MASK = 0x0040,
  XLFD_POINT_MASK = 0x0080,
  XLFD_RESX_MASK = 0x0100,
  XLFD_RESY_MASK = 0x0200,
  XLFD_SPACING_MASK = 0x0400,
  XLFD_AVGWIDTH_MASK = 0x0800,
  XLFD_REGISTRY_MASK = 0x1000,
  XLFD_ENCODING_MASK = 0x2000
};


783
/* Parse P pointing to the pixel/point size field of the form
Kenichi Handa's avatar
Kenichi Handa committed
784 785 786 787 788 789 790 791 792 793 794 795 796 797
   `[A B C D]' which specifies a transformation matrix:

	A  B  0
	C  D  0
	0  0  1

   by which all glyphs of the font are transformed.  The spec says
   that scalar value N for the pixel/point size is equivalent to:
   A = N * resx/resy, B = C = 0, D = N.

   Return the scalar value N if the form is valid.  Otherwise return
   -1.  */

static int
798
parse_matrix (const char *p)
Kenichi Handa's avatar
Kenichi Handa committed
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
{
  double matrix[4];
  char *end;
  int i;

  for (i = 0, p++; i < 4 && *p && *p != ']'; i++)
    {
      if (*p == '~')
	matrix[i] = - strtod (p + 1, &end);
      else
	matrix[i] = strtod (p, &end);
      p = end;
    }
  return (i == 4 ? (int) matrix[3] : -1);
}

815
/* Expand a wildcard field in FIELD (the first N fields are filled) to
816
   multiple fields to fill in all 14 XLFD fields while restricting a
817 818
   field position by its contents.  */

819
static int
820
font_expand_wildcards (Lisp_Object *field, int n)
821 822 823 824 825 826 827 828
{
  /* Copy of FIELD.  */
  Lisp_Object tmp[XLFD_LAST_INDEX];
  /* Array of information about where this element can go.  Nth
     element is for Nth element of FIELD. */
  struct {
    /* Minimum possible field.  */
    int from;
Paul Eggert's avatar
Paul Eggert committed
829
    /* Maximum possible field.  */
830 831 832 833 834
    int to;
    /* Bit mask of possible field.  Nth bit corresponds to Nth field.  */
    int mask;
  } range[XLFD_LAST_INDEX];
  int i, j;
835
  int range_from, range_to;
836 837 838 839 840 841
  unsigned range_mask;

#define XLFD_SYMBOL_MASK (XLFD_FOUNDRY_MASK | XLFD_FAMILY_MASK \
			  | XLFD_ADSTYLE_MASK  | XLFD_REGISTRY_MASK)
#define XLFD_NULL_MASK (XLFD_FOUNDRY_MASK | XLFD_ADSTYLE_MASK)
#define XLFD_LARGENUM_MASK (XLFD_POINT_MASK | XLFD_RESX_MASK | XLFD_RESY_MASK \
842
			    | XLFD_AVGWIDTH_MASK)
843 844 845 846 847 848 849 850
#define XLFD_REGENC_MASK (XLFD_REGISTRY_MASK | XLFD_ENCODING_MASK)

  /* Initialize RANGE_MASK for FIELD[0] which can be 0th to (14 - N)th
     field.  The value is shifted to left one bit by one in the
     following loop.  */
  for (i = 0, range_mask = 0; i <= 14 - n; i++)
    range_mask = (range_mask << 1) | 1;

851
  /* The triplet RANGE_FROM, RANGE_TO, and RANGE_MASK is a
Paul Eggert's avatar
Paul Eggert committed
852
     position-based restriction for FIELD[I].  */
853 854
  for (i = 0, range_from = 0, range_to = 14 - n; i < n;
       i++, range_from++, range_to++, range_mask <<= 1)
855 856 857 858 859 860 861 862 863 864 865 866 867 868
    {
      Lisp_Object val = field[i];

      tmp[i] = val;
      if (NILP (val))
	{
	  /* Wildcard.  */
	  range[i].from = range_from;
	  range[i].to = range_to;
	  range[i].mask = range_mask;
	}
      else
	{
	  /* The triplet FROM, TO, and MASK is a value-based
Paul Eggert's avatar
Paul Eggert committed
869
	     restriction for FIELD[I].  */
870 871 872 873 874
	  int from, to;
	  unsigned mask;

	  if (INTEGERP (val))
	    {
875
	      EMACS_INT numeric = XINT (val);
876

877 878 879
	      if (i + 1 == n)
		from = to = XLFD_ENCODING_INDEX,
		  mask = XLFD_ENCODING_MASK;
880 881 882
	      else if (numeric == 0)
		from = XLFD_PIXEL_INDEX, to = XLFD_AVGWIDTH_INDEX,
		  mask = XLFD_PIXEL_MASK | XLFD_LARGENUM_MASK;
883 884 885
	      else if (numeric <= 48)
		from = to = XLFD_PIXEL_INDEX,
		  mask = XLFD_PIXEL_MASK;
886
	      else
887
		from = XLFD_POINT_INDEX, to = XLFD_AVGWIDTH_INDEX,
888 889
		  mask = XLFD_LARGENUM_MASK;
	    }
Kenichi Handa's avatar
Kenichi Handa committed
890
	  else if (SBYTES (SYMBOL_NAME (val)) == 0)
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
	    from = XLFD_FOUNDRY_INDEX, to = XLFD_ADSTYLE_INDEX,
	      mask = XLFD_NULL_MASK;
	  else if (i == 0)
	    from = to = XLFD_FOUNDRY_INDEX, mask = XLFD_FOUNDRY_MASK;
	  else if (i + 1 == n)
	    {
	      Lisp_Object name = SYMBOL_NAME (val);

	      if (SDATA (name)[SBYTES (name) - 1] == '*')
		from = XLFD_REGISTRY_INDEX, to = XLFD_ENCODING_INDEX,
		  mask = XLFD_REGENC_MASK;
	      else
		from = to = XLFD_ENCODING_INDEX,
		  mask = XLFD_ENCODING_MASK;
	    }
906 907
	  else if (range_from <= XLFD_WEIGHT_INDEX
		   && range_to >= XLFD_WEIGHT_INDEX
Kenichi Handa's avatar
Kenichi Handa committed
908
		   && FONT_WEIGHT_NAME_NUMERIC (val) >= 0)
909
	    from = to = XLFD_WEIGHT_INDEX, mask = XLFD_WEIGHT_MASK;
910 911
	  else if (range_from <= XLFD_SLANT_INDEX
		   && range_to >= XLFD_SLANT_INDEX
Kenichi Handa's avatar
Kenichi Handa committed
912
		   && FONT_SLANT_NAME_NUMERIC (val) >= 0)
913
	    from = to = XLFD_SLANT_INDEX, mask = XLFD_SLANT_MASK;
914 915
	  else if (range_from <= XLFD_SWIDTH_INDEX
		   && range_to >= XLFD_SWIDTH_INDEX
Kenichi Handa's avatar
Kenichi Handa committed
916
		   && FONT_WIDTH_NAME_NUMERIC (val) >= 0)
917 918 919
	    from = to = XLFD_SWIDTH_INDEX, mask = XLFD_SWIDTH_MASK;
	  else
	    {
920
	      if (EQ (val, Qc) || EQ (val, Qm) || EQ (val, Qp) || EQ (val, Qd))
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
		from = to = XLFD_SPACING_INDEX, mask = XLFD_SPACING_MASK;
	      else
		from = XLFD_FOUNDRY_INDEX, to = XLFD_ENCODING_INDEX,
		  mask = XLFD_SYMBOL_MASK;
	    }

	  /* Merge position-based and value-based restrictions.  */
	  mask &= range_mask;
	  while (from < range_from)
	    mask &= ~(1 << from++);
	  while (from < 14 && ! (mask & (1 << from)))
	    from++;
	  while (to > range_to)
	    mask &= ~(1 << to--);
	  while (to >= 0 && ! (mask & (1 << to)))
	    to--;
	  if (from > to)
	    return -1;
	  range[i].from = from;
	  range[i].to = to;
	  range[i].mask = mask;

	  if (from > range_from || to < range_to)
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
	    {
	      /* The range is narrowed by value-based restrictions.
		 Reflect it to the other fields.  */

	      /* Following fields should be after FROM.  */
	      range_from = from;
	      /* Preceding fields should be before TO.  */
	      for (j = i - 1, from--, to--; j >= 0; j--, from--, to--)
		{
		  /* Check FROM for non-wildcard field.  */
		  if (! NILP (tmp[j]) && range[j].from < from)
		    {