font.c 143 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-2012  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>
#include <ctype.h>
27
#include <setjmp.h>
Kenichi Handa's avatar
Kenichi Handa committed
28 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"

Kenichi Handa's avatar
Kenichi Handa committed
40 41 42 43 44 45 46 47
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
#endif /* HAVE_X_WINDOWS */

#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

48 49 50 51
#ifdef HAVE_NS
#include "nsterm.h"
#endif /* HAVE_NS */

52
Lisp_Object Qopentype;
Kenichi Handa's avatar
Kenichi Handa committed
53

Kenichi Handa's avatar
Kenichi Handa committed
54
/* Important character set strings.  */
Kenichi Handa's avatar
Kenichi Handa committed
55
Lisp_Object Qascii_0, Qiso8859_1, Qiso10646_1, Qunicode_bmp, Qunicode_sip;
56

57 58
#define DEFAULT_ENCODING Qiso8859_1

Kenichi Handa's avatar
Kenichi Handa committed
59 60 61
/* Unicode category `Cf'.  */
static Lisp_Object QCf;

62
/* Vector of Vfont_weight_table, Vfont_slant_table, and Vfont_width_table. */
Kenichi Handa's avatar
Kenichi Handa committed
63 64
static Lisp_Object font_style_table;

65 66 67 68 69 70 71 72
/* 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.  */
73
  const char *names[5];
74 75 76 77 78
};

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

79
static const struct table_entry weight_table[] =
80 81 82 83 84 85
{
  { 0, { "thin" }},
  { 20, { "ultra-light", "ultralight" }},
  { 40, { "extra-light", "extralight" }},
  { 50, { "light" }},
  { 75, { "semi-light", "semilight", "demilight", "book" }},
86
  { 100, { "normal", "medium", "regular", "unspecified" }},
87 88 89 90 91 92 93 94 95
  { 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.  */

96
static const struct table_entry slant_table[] =
97 98 99
{
  { 0, { "reverse-oblique", "ro" }},
  { 10, { "reverse-italic", "ri" }},
100
  { 100, { "normal", "r", "unspecified" }},
101 102 103 104 105 106 107
  { 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.  */

108
static const struct table_entry width_table[] =
109 110 111 112 113
{
  { 50, { "ultra-condensed", "ultracondensed" }},
  { 63, { "extra-condensed", "extracondensed" }},
  { 75, { "condensed", "compressed", "narrow" }},
  { 87, { "semi-condensed", "semicondensed", "demicondensed" }},
114
  { 100, { "normal", "medium", "regular", "unspecified" }},
115 116 117 118 119 120
  { 113, { "semi-expanded", "semiexpanded", "demiexpanded" }},
  { 125, { "expanded" }},
  { 150, { "extra-expanded", "extraexpanded" }},
  { 200, { "ultra-expanded", "ultraexpanded", "wide" }}
};

Andreas Schwab's avatar
Andreas Schwab committed
121 122
Lisp_Object QCfoundry;
static Lisp_Object QCadstyle, QCregistry;
Kenichi Handa's avatar
Kenichi Handa committed
123
/* Symbols representing keys of font extra info.  */
Kenichi Handa's avatar
Kenichi Handa committed
124
Lisp_Object QCspacing, QCdpi, QCscalable, QCotf, QClang, QCscript, QCavgwidth;
125 126
Lisp_Object QCantialias, QCfont_entity;
static Lisp_Object QCfc_unknown_spec;
127
/* Symbols representing values of font spacing property.  */
128 129
static Lisp_Object Qc, Qm, Qd;
Lisp_Object Qp;
130 131 132
/* 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
133

134
static Lisp_Object QCuser_spec;
135

136
/* Alist of font registry symbols and the corresponding charset
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
   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;

154 155
/* 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
156 157 158
   here.  */
static struct font_driver_list *font_driver_list;

Kenichi Handa's avatar
Kenichi Handa committed
159 160


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

Andreas Schwab's avatar
Andreas Schwab committed
163
static Lisp_Object
164
font_make_spec (void)
Kenichi Handa's avatar
Kenichi Handa committed
165 166 167 168 169 170 171 172 173 174 175
{
  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
176
font_make_entity (void)
Kenichi Handa's avatar
Kenichi Handa committed
177 178 179 180 181 182 183 184 185 186
{
  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;
}

187 188 189
/* 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
190
Lisp_Object
191
font_make_object (int size, Lisp_Object entity, int pixelsize)
Kenichi Handa's avatar
Kenichi Handa committed
192 193 194 195
{
  Lisp_Object font_object;
  struct font *font
    = (struct font *) allocate_pseudovector (size, FONT_OBJECT_MAX, PVEC_FONT);
196 197
  int i;

Kenichi Handa's avatar
Kenichi Handa committed
198 199
  XSETFONT (font_object, font);

200 201 202 203 204 205
  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]
206
	  = Fcopy_alist (AREF (entity, FONT_EXTRA_INDEX));
207 208 209
    }
  if (size > 0)
    font->props[FONT_SIZE_INDEX] = make_number (pixelsize);
Kenichi Handa's avatar
Kenichi Handa committed
210 211 212 213 214
  return font_object;
}



215 216 217 218
static int font_pixel_size (FRAME_PTR f, Lisp_Object);
static Lisp_Object font_open_entity (FRAME_PTR, Lisp_Object, int);
static Lisp_Object font_matching_entity (FRAME_PTR, Lisp_Object *,
                                         Lisp_Object);
Andreas Schwab's avatar
Andreas Schwab committed
219
static unsigned font_encode_char (Lisp_Object, int);
Kenichi Handa's avatar
Kenichi Handa committed
220 221 222 223

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

Kenichi Handa's avatar
Kenichi Handa committed
224 225

/* Return a Lispy value of a font property value at STR and LEN bytes.
226 227 228
   If STR is "*", return nil.
   If FORCE_SYMBOL is zero and all characters in STR are digits,
   return an integer.  Otherwise, return a symbol interned from
229
   STR.  */
Kenichi Handa's avatar
Kenichi Handa committed
230 231

Lisp_Object
232
font_intern_prop (const char *str, ptrdiff_t len, int force_symbol)
Kenichi Handa's avatar
Kenichi Handa committed
233
{
234
  ptrdiff_t i;
235
  Lisp_Object tem;
Kenichi Handa's avatar
Kenichi Handa committed
236
  Lisp_Object obarray;
237
  ptrdiff_t nbytes, nchars;
Kenichi Handa's avatar
Kenichi Handa committed
238 239 240

  if (len == 1 && *str == '*')
    return Qnil;
241
  if (!force_symbol && 0 < len && '0' <= *str && *str <= '9')
Kenichi Handa's avatar
Kenichi Handa committed
242 243
    {
      for (i = 1; i < len; i++)
244
	if (! ('0' <= str[i] && str[i] <= '9'))
Kenichi Handa's avatar
Kenichi Handa committed
245 246
	  break;
      if (i == len)
247
	{
248 249 250 251 252 253 254 255 256 257 258 259
	  EMACS_INT n;

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

	  xsignal1 (Qoverflow_error, make_string (str, len));
260
	}
Kenichi Handa's avatar
Kenichi Handa committed
261 262
    }

263 264
  /* This code is similar to intern function from lread.c.  */
  obarray = check_obarray (Vobarray);
265
  parse_str_as_multibyte ((unsigned char *) str, len, &nchars, &nbytes);
266 267 268
  tem = oblookup (obarray, str,
		  (len == nchars || len != nbytes) ? len : nchars, len);

Kenichi Handa's avatar
Kenichi Handa committed
269 270
  if (SYMBOLP (tem))
    return tem;
271 272 273 274 275
  if (len == nchars || len != nbytes)
    tem = make_unibyte_string (str, len);
  else
    tem = make_multibyte_string (str, nchars, len);
  return Fintern (tem, obarray);
Kenichi Handa's avatar
Kenichi Handa committed
276 277
}

278
/* Return a pixel size of font-spec SPEC on frame F.  */
279

280
static int
281
font_pixel_size (FRAME_PTR f, Lisp_Object spec)
282
{
283
#ifdef HAVE_WINDOW_SYSTEM
284 285
  Lisp_Object size = AREF (spec, FONT_SIZE_INDEX);
  double point_size;
Kenichi Handa's avatar
Kenichi Handa committed
286
  int dpi, pixel_size;
287
  Lisp_Object val;
288

289 290 291
  if (INTEGERP (size))
    return XINT (size);
  if (NILP (size))
292
    return 0;
293
  eassert (FLOATP (size));
294
  point_size = XFLOAT_DATA (size);
Kenichi Handa's avatar
Kenichi Handa committed
295 296
  val = AREF (spec, FONT_DPI_INDEX);
  if (INTEGERP (val))
297
    dpi = XINT (val);
298 299 300 301
  else
    dpi = f->resy;
  pixel_size = POINT_TO_PIXEL (point_size, dpi);
  return pixel_size;
302 303 304
#else
  return 1;
#endif
305 306
}

Kenichi Handa's avatar
Kenichi Handa committed
307

Kenichi Handa's avatar
Kenichi Handa committed
308 309 310 311
/* 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
312
   font_style_table if VAL is a symbol, and return the closest index if
Kenichi Handa's avatar
Kenichi Handa committed
313
   VAL is an integer.  */
Kenichi Handa's avatar
Kenichi Handa committed
314

Kenichi Handa's avatar
Kenichi Handa committed
315
int
316
font_style_to_value (enum font_property_index prop, Lisp_Object val, int noerror)
Kenichi Handa's avatar
Kenichi Handa committed
317
{
Kenichi Handa's avatar
Kenichi Handa committed
318
  Lisp_Object table = AREF (font_style_table, prop - FONT_WEIGHT_INDEX);
319 320 321 322
  int len;

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

Kenichi Handa's avatar
Kenichi Handa committed
324
  if (SYMBOLP (val))
Kenichi Handa's avatar
Kenichi Handa committed
325
    {
326
      int i, j;
327
      char *s;
Kenichi Handa's avatar
Kenichi Handa committed
328 329 330 331
      Lisp_Object args[2], elt;

      /* At first try exact match.  */
      for (i = 0; i < len; i++)
332 333 334 335 336 337 338 339 340 341
	{
	  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
342
      /* Try also with case-folding match.  */
343
      s = SSDATA (SYMBOL_NAME (val));
Kenichi Handa's avatar
Kenichi Handa committed
344
      for (i = 0; i < len; i++)
345 346 347
	for (j = 1; j < ASIZE (AREF (table, i)); j++)
	  {
	    elt = AREF (AREF (table, i), j);
348
	    if (xstrcasecmp (s, SSDATA (SYMBOL_NAME (elt))) == 0)
349 350 351 352 353
	      {
		CHECK_NUMBER (AREF (AREF (table, i), 0));
		return ((XINT (AREF (AREF (table, i), 0)) << 8)
			| (i << 4) | (j - 1));
	      }
354
	  }
Kenichi Handa's avatar
Kenichi Handa committed
355 356
      if (! noerror)
	return -1;
357
      eassert (len < 255);
358
      elt = Fmake_vector (make_number (2), make_number (100));
359
      ASET (elt, 1, val);
Kenichi Handa's avatar
Kenichi Handa committed
360
      args[0] = table;
361
      args[1] = Fmake_vector (make_number (1), elt);
Kenichi Handa's avatar
Kenichi Handa committed
362
      ASET (font_style_table, prop - FONT_WEIGHT_INDEX, Fvconcat (2, args));
363
      return (100 << 8) | (i << 4);
Kenichi Handa's avatar
Kenichi Handa committed
364
    }
Kenichi Handa's avatar
Kenichi Handa committed
365 366
  else
    {
367
      int i, last_n;
368
      EMACS_INT numeric = XINT (val);
Kenichi Handa's avatar
Kenichi Handa committed
369

370
      for (i = 0, last_n = -1; i < len; i++)
Kenichi Handa's avatar
Kenichi Handa committed
371
	{
372
	  int n;
Kenichi Handa's avatar
Kenichi Handa committed
373

374 375 376
	  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
377
	  if (numeric == n)
378
	    return (n << 8) | (i << 4);
Kenichi Handa's avatar
Kenichi Handa committed
379 380 381 382
	  if (numeric < n)
	    {
	      if (! noerror)
		return -1;
383 384
	      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
385 386 387 388 389
	    }
	  last_n = n;
	}
      if (! noerror)
	return -1;
390
      return ((last_n << 8) | ((i - 1) << 4));
Kenichi Handa's avatar
Kenichi Handa committed
391 392
    }
}
Kenichi Handa's avatar
Kenichi Handa committed
393 394

Lisp_Object
395
font_style_symbolic (Lisp_Object font, enum font_property_index prop, int for_face)
Kenichi Handa's avatar
Kenichi Handa committed
396
{
397
  Lisp_Object val = AREF (font, prop);
398 399
  Lisp_Object table, elt;
  int i;
Kenichi Handa's avatar
Kenichi Handa committed
400

Kenichi Handa's avatar
Kenichi Handa committed
401 402 403
  if (NILP (val))
    return Qnil;
  table = AREF (font_style_table, prop - FONT_WEIGHT_INDEX);
404
  CHECK_VECTOR (table);
405
  i = XINT (val) & 0xFF;
406
  eassert (((i >> 4) & 0xF) < ASIZE (table));
407
  elt = AREF (table, ((i >> 4) & 0xF));
408
  CHECK_VECTOR (elt);
409
  eassert ((i & 0xF) + 1 < ASIZE (elt));
410 411 412
  elt = (for_face ? AREF (elt, 1) : AREF (elt, (i & 0xF) + 1));
  CHECK_SYMBOL (elt);
  return elt;
413 414
}

415 416 417 418 419
/* 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
420
find_font_encoding (Lisp_Object fontname)
421 422 423 424 425 426 427 428 429 430 431 432 433 434
{
  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));
    }
435
  return Qnil;
436 437
}

438 439 440 441 442
/* 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
443
font_registry_charsets (Lisp_Object registry, struct charset **encoding, struct charset **repertory)
444 445 446 447
{
  Lisp_Object val;
  int encoding_id, repertory_id;

Kenichi Handa's avatar
Kenichi Handa committed
448
  val = Fassoc_string (registry, font_charset_alist, Qt);
449 450 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
  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)));
	    }
477
	}
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
      else
	goto invalid_entry;
      val = Fcons (make_number (encoding_id), make_number (repertory_id));
      font_charset_alist
	= nconc2 (font_charset_alist, Fcons (Fcons (registry, val), Qnil));
    }

  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
    = nconc2 (font_charset_alist, Fcons (Fcons (registry, Qnil), Qnil));
  return -1;
}

Kenichi Handa's avatar
Kenichi Handa committed
497

498
/* Font property value validators.  See the comment of
499 500
   font_property_table for the meaning of the arguments.  */

501 502 503 504 505 506
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
507 508

static Lisp_Object
509
font_prop_validate_symbol (Lisp_Object prop, Lisp_Object val)
Kenichi Handa's avatar
Kenichi Handa committed
510 511
{
  if (STRINGP (val))
Kenichi Handa's avatar
Kenichi Handa committed
512 513
    val = Fintern (val, Qnil);
  if (! SYMBOLP (val))
Kenichi Handa's avatar
Kenichi Handa committed
514
    val = Qerror;
Kenichi Handa's avatar
Kenichi Handa committed
515 516
  else if (EQ (prop, QCregistry))
    val = Fintern (Fdowncase (SYMBOL_NAME (val)), Qnil);
Kenichi Handa's avatar
Kenichi Handa committed
517 518 519
  return val;
}

Kenichi Handa's avatar
Kenichi Handa committed
520

Kenichi Handa's avatar
Kenichi Handa committed
521
static Lisp_Object
522
font_prop_validate_style (Lisp_Object style, Lisp_Object val)
Kenichi Handa's avatar
Kenichi Handa committed
523
{
Kenichi Handa's avatar
Kenichi Handa committed
524 525 526 527
  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
528
    {
529
      EMACS_INT n = XINT (val);
530
      CHECK_VECTOR (AREF (font_style_table, prop - FONT_WEIGHT_INDEX));
531
      if (((n >> 4) & 0xF)
Kenichi Handa's avatar
Kenichi Handa committed
532
	  >= ASIZE (AREF (font_style_table, prop - FONT_WEIGHT_INDEX)))
Kenichi Handa's avatar
Kenichi Handa committed
533 534 535
	val = Qerror;
      else
	{
536 537
	  Lisp_Object elt = AREF (AREF (font_style_table, prop - FONT_WEIGHT_INDEX), (n >> 4) & 0xF);

538
	  CHECK_VECTOR (elt);
539 540
	  if ((n & 0xF) + 1 >= ASIZE (elt))
	    val = Qerror;
541 542 543 544 545 546
	  else
	    {
	      CHECK_NUMBER (AREF (elt, 0));
	      if (XINT (AREF (elt, 0)) != (n >> 8))
		val = Qerror;
	    }
Kenichi Handa's avatar
Kenichi Handa committed
547 548
	}
    }
Kenichi Handa's avatar
Kenichi Handa committed
549 550 551 552 553 554 555 556
  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
557 558 559 560
  return val;
}

static Lisp_Object
561
font_prop_validate_non_neg (Lisp_Object prop, Lisp_Object val)
Kenichi Handa's avatar
Kenichi Handa committed
562 563 564 565 566 567
{
  return (NATNUMP (val) || (FLOATP (val) && XFLOAT_DATA (val) >= 0)
	  ? val : Qerror);
}

static Lisp_Object
568
font_prop_validate_spacing (Lisp_Object prop, Lisp_Object val)
569 570 571
{
  if (NILP (val) || (NATNUMP (val) && XINT (val) <= FONT_SPACING_CHARCELL))
    return val;
572 573 574 575 576 577 578 579
  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);
580
      if (spacing == 'p' || spacing == 'P')
581 582 583 584
	return make_number (FONT_SPACING_PROPORTIONAL);
      if (spacing == 'd' || spacing == 'D')
	return make_number (FONT_SPACING_DUAL);
    }
585 586 587
  return Qerror;
}

588
static Lisp_Object
589
font_prop_validate_otf (Lisp_Object prop, Lisp_Object val)
590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
{
  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;
}

622
/* Structure of known font property keys and validator of the
623
   values.  */
624
static const struct
Kenichi Handa's avatar
Kenichi Handa committed
625
{
626
  /* Pointer to the key symbol.  */
Kenichi Handa's avatar
Kenichi Handa committed
627
  Lisp_Object *key;
628 629 630
  /* 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
631
  Lisp_Object (*validator) (Lisp_Object prop, Lisp_Object val);
632 633
} font_property_table[] =
  { { &QCtype, font_prop_validate_symbol },
Kenichi Handa's avatar
Kenichi Handa committed
634 635 636 637 638 639 640
    { &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 },
641 642 643
    { &QCsize, font_prop_validate_non_neg },
    { &QCdpi, font_prop_validate_non_neg },
    { &QCspacing, font_prop_validate_spacing },
Kenichi Handa's avatar
Kenichi Handa committed
644 645 646 647 648 649
    { &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
650 651
  };

652
/* Size (number of elements) of the above table.  */
653 654 655
#define FONT_PROPERTY_TABLE_SIZE \
  ((sizeof font_property_table) / (sizeof *font_property_table))

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

659
static int
660
get_font_prop_index (Lisp_Object key)
Kenichi Handa's avatar
Kenichi Handa committed
661
{
Kenichi Handa's avatar
Kenichi Handa committed
662 663 664 665 666
  int i;

  for (i = 0; i < FONT_PROPERTY_TABLE_SIZE; i++)
    if (EQ (key, *font_property_table[i].key))
      return i;
667
  return -1;
Kenichi Handa's avatar
Kenichi Handa committed
668 669
}

Kenichi Handa's avatar
Kenichi Handa committed
670 671 672
/* 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.  */
673

Kenichi Handa's avatar
Kenichi Handa committed
674
static Lisp_Object
675
font_prop_validate (int idx, Lisp_Object prop, Lisp_Object val)
Kenichi Handa's avatar
Kenichi Handa committed
676
{
Kenichi Handa's avatar
Kenichi Handa committed
677
  Lisp_Object validated;
Kenichi Handa's avatar
Kenichi Handa committed
678

679 680
  if (NILP (val))
    return val;
Kenichi Handa's avatar
Kenichi Handa committed
681 682 683
  if (NILP (prop))
    prop = *font_property_table[idx].key;
  else
684
    {
Kenichi Handa's avatar
Kenichi Handa committed
685 686 687
      idx = get_font_prop_index (prop);
      if (idx < 0)
	return val;
688
    }
Paul Eggert's avatar
Paul Eggert committed
689
  validated = (font_property_table[idx].validator) (prop, val);
Kenichi Handa's avatar
Kenichi Handa committed
690 691 692
  if (EQ (validated, Qerror))
    signal_error ("invalid font property", Fcons (prop, val));
  return validated;
Kenichi Handa's avatar
Kenichi Handa committed
693
}
694

Kenichi Handa's avatar
Kenichi Handa committed
695 696 697

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

699
Lisp_Object
700
font_put_extra (Lisp_Object font, Lisp_Object prop, Lisp_Object val)
701 702
{
  Lisp_Object extra = AREF (font, FONT_EXTRA_INDEX);
703
  Lisp_Object slot = (NILP (extra) ? Qnil : assq_no_quit (prop, extra));
704 705 706

  if (NILP (slot))
    {
Kenichi Handa's avatar
Kenichi Handa committed
707 708 709 710 711
      Lisp_Object prev = Qnil;

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

713
      if (NILP (prev))
714
        ASET (font, FONT_EXTRA_INDEX, Fcons (Fcons (prop, val), extra));
715
      else
716
        XSETCDR (prev, Fcons (Fcons (prop, val), extra));
717

718
      return val;
719 720
    }
  XSETCDR (slot, val);
721 722
  if (NILP (val))
    ASET (font, FONT_EXTRA_INDEX, Fdelq (slot, extra));
723
  return val;
724 725
}

Kenichi Handa's avatar
Kenichi Handa committed
726 727 728

/* Font name parser and unparser */

729
static int parse_matrix (const char *);
730
static int font_expand_wildcards (Lisp_Object *, int);
731
static int font_parse_name (char *, ptrdiff_t, Lisp_Object);
Kenichi Handa's avatar
Kenichi Handa committed
732

733
/* An enumerator for each field of an XLFD font name.  */
Kenichi Handa's avatar
Kenichi Handa committed
734 735 736 737 738 739 740 741
enum xlfd_field_index
{
  XLFD_FOUNDRY_INDEX,
  XLFD_FAMILY_INDEX,
  XLFD_WEIGHT_INDEX,
  XLFD_SLANT_INDEX,
  XLFD_SWIDTH_INDEX,
  XLFD_ADSTYLE_INDEX,
742 743
  XLFD_PIXEL_INDEX,
  XLFD_POINT_INDEX,
Kenichi Handa's avatar
Kenichi Handa committed
744 745 746 747 748 749 750 751 752
  XLFD_RESX_INDEX,
  XLFD_RESY_INDEX,
  XLFD_SPACING_INDEX,
  XLFD_AVGWIDTH_INDEX,
  XLFD_REGISTRY_INDEX,
  XLFD_ENCODING_INDEX,
  XLFD_LAST_INDEX
};

753
/* An enumerator for mask bit corresponding to each XLFD field.  */
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
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
};


773
/* Parse P pointing to the pixel/point size field of the form
Kenichi Handa's avatar
Kenichi Handa committed
774 775 776 777 778 779 780 781 782 783 784 785 786 787
   `[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
788
parse_matrix (const char *p)
Kenichi Handa's avatar
Kenichi Handa committed
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
{
  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);
}

805
/* Expand a wildcard field in FIELD (the first N fields are filled) to
806
   multiple fields to fill in all 14 XLFD fields while restricting a
807 808
   field position by its contents.  */

809
static int
810
font_expand_wildcards (Lisp_Object *field, int n)
811 812 813 814 815 816 817 818
{
  /* 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
819
    /* Maximum possible field.  */
820 821 822 823 824
    int to;
    /* Bit mask of possible field.  Nth bit corresponds to Nth field.  */
    int mask;
  } range[XLFD_LAST_INDEX];
  int i, j;
825
  int range_from, range_to;
826 827 828 829 830 831
  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 \
832
			    | XLFD_AVGWIDTH_MASK)
833 834 835 836 837 838 839 840
#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;

841
  /* The triplet RANGE_FROM, RANGE_TO, and RANGE_MASK is a
Paul Eggert's avatar
Paul Eggert committed
842
     position-based restriction for FIELD[I].  */
843 844
  for (i = 0, range_from = 0, range_to = 14 - n; i < n;
       i++, range_from++, range_to++, range_mask <<= 1)
845 846 847 848 849 850 851 852 853 854 855 856 857 858
    {
      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
859
	     restriction for FIELD[I].  */
860 861 862 863 864
	  int from, to;
	  unsigned mask;

	  if (INTEGERP (val))
	    {
865
	      EMACS_INT numeric = XINT (val);
866

867 868 869
	      if (i + 1 == n)
		from = to = XLFD_ENCODING_INDEX,
		  mask = XLFD_ENCODING_MASK;
870 871 872
	      else if (numeric == 0)
		from = XLFD_PIXEL_INDEX, to = XLFD_AVGWIDTH_INDEX,
		  mask = XLFD_PIXEL_MASK | XLFD_LARGENUM_MASK;
873 874 875
	      else if (numeric <= 48)
		from = to = XLFD_PIXEL_INDEX,
		  mask = XLFD_PIXEL_MASK;
876
	      else
877
		from = XLFD_POINT_INDEX, to = XLFD_AVGWIDTH_INDEX,
878 879
		  mask = XLFD_LARGENUM_MASK;
	    }
Kenichi Handa's avatar
Kenichi Handa committed
880
	  else if (SBYTES (SYMBOL_NAME (val)) == 0)
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
	    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;
	    }
896 897
	  else if (range_from <= XLFD_WEIGHT_INDEX
		   && range_to >= XLFD_WEIGHT_INDEX
Kenichi Handa's avatar
Kenichi Handa committed
898
		   && FONT_WEIGHT_NAME_NUMERIC (val) >= 0)
899
	    from = to = XLFD_WEIGHT_INDEX, mask = XLFD_WEIGHT_MASK;
900 901
	  else if (range_from <= XLFD_SLANT_INDEX
		   && range_to >= XLFD_SLANT_INDEX
Kenichi Handa's avatar
Kenichi Handa committed
902
		   && FONT_SLANT_NAME_NUMERIC (val) >= 0)
903
	    from = to = XLFD_SLANT_INDEX, mask = XLFD_SLANT_MASK;
904 905
	  else if (range_from <= XLFD_SWIDTH_INDEX
		   && range_to >= XLFD_SWIDTH_INDEX
Kenichi Handa's avatar
Kenichi Handa committed
906
		   && FONT_WIDTH_NAME_NUMERIC (val) >= 0)
907 908 909
	    from = to = XLFD_SWIDTH_INDEX, mask = XLFD_SWIDTH_MASK;
	  else
	    {
910
	      if (EQ (val, Qc) || EQ (val, Qm) || EQ (val, Qp) || EQ (val, Qd))
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
		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)
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
	    {
	      /* 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)
		    {
		      while (range[j].from < from)
			range[j].mask &= ~(1 << range[j].from++);
		      while (from < 14 && ! (range[j].mask & (1 << from)))
			from++;
		      range[j].from = from;
		    }
		  else
		    from = range[j].from;
		  if (range[j].to > to)
		    {
		      while (range[j].to > to)
			range[j].mask &= ~(1 << range[j].to--);
		      while (to >= 0 && ! (range[j].mask & (1 << to)))
			to--;
		      range[j].to = to;
		    }
		  else
		    to = range[j].to;
		  if (from > to)
		    return -1;
		}
	    }
968 969 970
	}
    }

Paul Eggert's avatar
Paul Eggert committed
971
  /* Decide all fields from restrictions in RANGE.  */
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
  for (i = j = 0; i < n ; i++)
    {
      if (j < range[i].from)
	{
	  if (i == 0 || ! NILP (tmp[i - 1]))
	    /* None of TMP[X] corresponds to Jth field.  */
	    return -1;
	  for (; j < range[i].from; j++)
	    field[j] = Qnil;
	}
      field[j++] = tmp[i];
    }
  if (! NILP (tmp[n - 1]) && j < XLFD_REGISTRY_INDEX)
    return -1;
  for (; j < XLFD_LAST_INDEX; j++)
    field[j] = Qnil;
  if (INTEGERP (field[XLFD_ENCODING_INDEX]))
    field[XLFD_ENCODING_INDEX]
      = Fintern (Fnumber_to_string (field[XLFD_ENCODING_INDEX]), Qnil);
  return 0;
}

994