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

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 2006-2015 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 45

#define DEFAULT_ENCODING Qiso8859_1

46
/* Vector of Vfont_weight_table, Vfont_slant_table, and Vfont_width_table. */
Kenichi Handa's avatar
Kenichi Handa committed
47 48
static Lisp_Object font_style_table;

49 50 51 52 53 54 55 56
/* 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.  */
57
  const char *names[5];
58 59 60 61 62
};

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

63
static const struct table_entry weight_table[] =
64 65 66 67 68 69
{
  { 0, { "thin" }},
  { 20, { "ultra-light", "ultralight" }},
  { 40, { "extra-light", "extralight" }},
  { 50, { "light" }},
  { 75, { "semi-light", "semilight", "demilight", "book" }},
70
  { 100, { "normal", "medium", "regular", "unspecified" }},
71 72 73 74 75 76 77 78 79
  { 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.  */

80
static const struct table_entry slant_table[] =
81 82 83
{
  { 0, { "reverse-oblique", "ro" }},
  { 10, { "reverse-italic", "ri" }},
84
  { 100, { "normal", "r", "unspecified" }},
85 86 87 88 89 90 91
  { 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.  */

92
static const struct table_entry width_table[] =
93 94 95 96 97
{
  { 50, { "ultra-condensed", "ultracondensed" }},
  { 63, { "extra-condensed", "extracondensed" }},
  { 75, { "condensed", "compressed", "narrow" }},
  { 87, { "semi-condensed", "semicondensed", "demicondensed" }},
98
  { 100, { "normal", "medium", "regular", "unspecified" }},
99 100 101 102 103 104
  { 113, { "semi-expanded", "semiexpanded", "demiexpanded" }},
  { 125, { "expanded" }},
  { 150, { "extra-expanded", "extraexpanded" }},
  { 200, { "ultra-expanded", "ultraexpanded", "wide" }}
};

105
/* Alist of font registry symbols and the corresponding charset
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
   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;

123 124
/* 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
125 126 127
   here.  */
static struct font_driver_list *font_driver_list;

128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
#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
149

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

Andreas Schwab's avatar
Andreas Schwab committed
152
static Lisp_Object
153
font_make_spec (void)
Kenichi Handa's avatar
Kenichi Handa committed
154 155 156 157 158
{
  Lisp_Object font_spec;
  struct font_spec *spec
    = ((struct font_spec *)
       allocate_pseudovector (VECSIZE (struct font_spec),
159
			      FONT_SPEC_MAX, FONT_SPEC_MAX, PVEC_FONT));
Kenichi Handa's avatar
Kenichi Handa committed
160 161 162 163 164
  XSETFONT (font_spec, spec);
  return font_spec;
}

Lisp_Object
165
font_make_entity (void)
Kenichi Handa's avatar
Kenichi Handa committed
166 167 168 169 170
{
  Lisp_Object font_entity;
  struct font_entity *entity
    = ((struct font_entity *)
       allocate_pseudovector (VECSIZE (struct font_entity),
171
			      FONT_ENTITY_MAX, FONT_ENTITY_MAX, PVEC_FONT));
Kenichi Handa's avatar
Kenichi Handa committed
172 173 174 175
  XSETFONT (font_entity, entity);
  return font_entity;
}

176 177 178
/* 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
179
Lisp_Object
180
font_make_object (int size, Lisp_Object entity, int pixelsize)
Kenichi Handa's avatar
Kenichi Handa committed
181 182 183
{
  Lisp_Object font_object;
  struct font *font
184 185
    = (struct font *) allocate_pseudovector (size, FONT_OBJECT_MAX,
					     FONT_OBJECT_MAX, PVEC_FONT);
186 187
  int i;

188 189 190
  /* 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
191 192
  XSETFONT (font_object, font);

193 194 195 196 197 198
  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]
199
	  = Fcopy_alist (AREF (entity, FONT_EXTRA_INDEX));
200 201 202
    }
  if (size > 0)
    font->props[FONT_SIZE_INDEX] = make_number (pixelsize);
Kenichi Handa's avatar
Kenichi Handa committed
203 204 205
  return font_object;
}

206 207
#if defined (HAVE_XFT) || defined (HAVE_FREETYPE) || defined (HAVE_NS)

208 209
static int font_unparse_fcname (Lisp_Object, int, char *, int);

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
/* Like above, but also set `type', `name' and `fullname' properties
   of font-object.  */

Lisp_Object
font_build_object (int vectorsize, Lisp_Object type,
		   Lisp_Object entity, double pixelsize)
{
  int len;
  char name[256];
  Lisp_Object font_object = font_make_object (vectorsize, entity, pixelsize);

  ASET (font_object, FONT_TYPE_INDEX, type);
  len = font_unparse_xlfd (entity, pixelsize, name, sizeof name);
  if (len > 0)
    ASET (font_object, FONT_NAME_INDEX, make_string (name, len));
  len = font_unparse_fcname (entity, pixelsize, name, sizeof name);
  if (len > 0)
    ASET (font_object, FONT_FULLNAME_INDEX, make_string (name, len));
  else
    ASET (font_object, FONT_FULLNAME_INDEX,
	  AREF (font_object, FONT_NAME_INDEX));
  return font_object;
}

#endif /* HAVE_XFT || HAVE_FREETYPE || HAVE_NS */
Kenichi Handa's avatar
Kenichi Handa committed
235

Dmitry Antipov's avatar
Dmitry Antipov committed
236 237 238
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 *,
239
                                         Lisp_Object);
Andreas Schwab's avatar
Andreas Schwab committed
240
static unsigned font_encode_char (Lisp_Object, int);
Kenichi Handa's avatar
Kenichi Handa committed
241 242 243 244

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

Kenichi Handa's avatar
Kenichi Handa committed
245 246

/* Return a Lispy value of a font property value at STR and LEN bytes.
247 248 249
   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
250 251

Lisp_Object
252
font_intern_prop (const char *str, ptrdiff_t len, bool force_symbol)
Kenichi Handa's avatar
Kenichi Handa committed
253
{
254 255
  ptrdiff_t i, nbytes, nchars;
  Lisp_Object tem, name, obarray;
Kenichi Handa's avatar
Kenichi Handa committed
256 257 258

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

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

	  xsignal1 (Qoverflow_error, make_string (str, len));
278
	}
Kenichi Handa's avatar
Kenichi Handa committed
279 280
    }

281 282
  /* This code is similar to intern function from lread.c.  */
  obarray = check_obarray (Vobarray);
283
  parse_str_as_multibyte ((unsigned char *) str, len, &nchars, &nbytes);
284 285
  tem = oblookup (obarray, str,
		  (len == nchars || len != nbytes) ? len : nchars, len);
Kenichi Handa's avatar
Kenichi Handa committed
286 287
  if (SYMBOLP (tem))
    return tem;
288 289
  name = make_specified_string (str, nchars, len,
				len != nchars && len == nbytes);
290
  return intern_driver (name, obarray, tem);
Kenichi Handa's avatar
Kenichi Handa committed
291 292
}

293
/* Return a pixel size of font-spec SPEC on frame F.  */
294

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

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

Kenichi Handa's avatar
Kenichi Handa committed
322

Kenichi Handa's avatar
Kenichi Handa committed
323 324 325 326
/* 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
327
   font_style_table if VAL is a symbol, and return the closest index if
Kenichi Handa's avatar
Kenichi Handa committed
328
   VAL is an integer.  */
Kenichi Handa's avatar
Kenichi Handa committed
329

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

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

Kenichi Handa's avatar
Kenichi Handa committed
340
  if (SYMBOLP (val))
Kenichi Handa's avatar
Kenichi Handa committed
341
    {
342
      int i, j;
343
      char *s;
344
      Lisp_Object elt;
Kenichi Handa's avatar
Kenichi Handa committed
345 346 347

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

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

390 391 392
	  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
393
	  if (numeric == n)
394
	    return (n << 8) | (i << 4);
Kenichi Handa's avatar
Kenichi Handa committed
395 396 397 398
	  if (numeric < n)
	    {
	      if (! noerror)
		return -1;
399 400
	      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
401 402 403 404 405
	    }
	  last_n = n;
	}
      if (! noerror)
	return -1;
406
      return ((last_n << 8) | ((i - 1) << 4));
Kenichi Handa's avatar
Kenichi Handa committed
407 408
    }
}
Kenichi Handa's avatar
Kenichi Handa committed
409 410

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

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

432 433 434 435 436
/* 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
437
find_font_encoding (Lisp_Object fontname)
438 439 440 441 442 443 444 445 446 447 448 449 450 451
{
  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));
    }
452
  return Qnil;
453 454
}

455 456 457 458 459
/* 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
460
font_registry_charsets (Lisp_Object registry, struct charset **encoding, struct charset **repertory)
461 462 463 464
{
  Lisp_Object val;
  int encoding_id, repertory_id;

Kenichi Handa's avatar
Kenichi Handa committed
465
  val = Fassoc_string (registry, font_charset_alist, Qt);
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 491 492 493
  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)));
	    }
494
	}
495 496 497 498
      else
	goto invalid_entry;
      val = Fcons (make_number (encoding_id), make_number (repertory_id));
      font_charset_alist
499
	= nconc2 (font_charset_alist, list1 (Fcons (registry, val)));
500 501 502 503 504 505 506 507 508 509
    }

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

Kenichi Handa's avatar
Kenichi Handa committed
514

515
/* Font property value validators.  See the comment of
516 517
   font_property_table for the meaning of the arguments.  */

518 519 520 521 522 523
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
524 525

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

Kenichi Handa's avatar
Kenichi Handa committed
537

Kenichi Handa's avatar
Kenichi Handa committed
538
static Lisp_Object
539
font_prop_validate_style (Lisp_Object style, Lisp_Object val)
Kenichi Handa's avatar
Kenichi Handa committed
540
{
Kenichi Handa's avatar
Kenichi Handa committed
541 542 543 544
  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
545
    {
546
      EMACS_INT n = XINT (val);
547
      CHECK_VECTOR (AREF (font_style_table, prop - FONT_WEIGHT_INDEX));
548
      if (((n >> 4) & 0xF)
Kenichi Handa's avatar
Kenichi Handa committed
549
	  >= ASIZE (AREF (font_style_table, prop - FONT_WEIGHT_INDEX)))
Kenichi Handa's avatar
Kenichi Handa committed
550 551 552
	val = Qerror;
      else
	{
553 554
	  Lisp_Object elt = AREF (AREF (font_style_table, prop - FONT_WEIGHT_INDEX), (n >> 4) & 0xF);

555
	  CHECK_VECTOR (elt);
556 557
	  if ((n & 0xF) + 1 >= ASIZE (elt))
	    val = Qerror;
558 559 560 561 562 563
	  else
	    {
	      CHECK_NUMBER (AREF (elt, 0));
	      if (XINT (AREF (elt, 0)) != (n >> 8))
		val = Qerror;
	    }
Kenichi Handa's avatar
Kenichi Handa committed
564 565
	}
    }
Kenichi Handa's avatar
Kenichi Handa committed
566 567 568 569 570 571 572 573
  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
574 575 576 577
  return val;
}

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

static Lisp_Object
585
font_prop_validate_spacing (Lisp_Object prop, Lisp_Object val)
586 587 588
{
  if (NILP (val) || (NATNUMP (val) && XINT (val) <= FONT_SPACING_CHARCELL))
    return val;
589 590 591 592 593 594 595 596
  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);
597
      if (spacing == 'p' || spacing == 'P')
598 599 600 601
	return make_number (FONT_SPACING_PROPORTIONAL);
      if (spacing == 'd' || spacing == 'D')
	return make_number (FONT_SPACING_DUAL);
    }
602 603 604
  return Qerror;
}

605
static Lisp_Object
606
font_prop_validate_otf (Lisp_Object prop, Lisp_Object val)
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 636 637 638
{
  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;
}

639
/* Structure of known font property keys and validator of the
640
   values.  */
641
static const struct
Kenichi Handa's avatar
Kenichi Handa committed
642
{
Paul Eggert's avatar
Paul Eggert committed
643 644
  /* Index of the key symbol.  */
  int key;
645 646 647
  /* 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
648
  Lisp_Object (*validator) (Lisp_Object prop, Lisp_Object val);
649
} font_property_table[] =
Paul Eggert's avatar
Paul Eggert committed
650 651 652 653 654 655 656 657 658 659 660 661
  { { SYMBOL_INDEX (QCtype), font_prop_validate_symbol },
    { SYMBOL_INDEX (QCfoundry), font_prop_validate_symbol },
    { SYMBOL_INDEX (QCfamily), font_prop_validate_symbol },
    { SYMBOL_INDEX (QCadstyle), font_prop_validate_symbol },
    { SYMBOL_INDEX (QCregistry), font_prop_validate_symbol },
    { SYMBOL_INDEX (QCweight), font_prop_validate_style },
    { SYMBOL_INDEX (QCslant), font_prop_validate_style },
    { SYMBOL_INDEX (QCwidth), font_prop_validate_style },
    { SYMBOL_INDEX (QCsize), font_prop_validate_non_neg },
    { SYMBOL_INDEX (QCdpi), font_prop_validate_non_neg },
    { SYMBOL_INDEX (QCspacing), font_prop_validate_spacing },
    { SYMBOL_INDEX (QCavgwidth), font_prop_validate_non_neg },
Kenichi Handa's avatar
Kenichi Handa committed
662 663
    /* The order of the above entries must match with enum
       font_property_index.  */
Paul Eggert's avatar
Paul Eggert committed
664 665 666
    { SYMBOL_INDEX (QClang), font_prop_validate_symbol },
    { SYMBOL_INDEX (QCscript), font_prop_validate_symbol },
    { SYMBOL_INDEX (QCotf), font_prop_validate_otf }
Kenichi Handa's avatar
Kenichi Handa committed
667 668
  };

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

672
static int
673
get_font_prop_index (Lisp_Object key)
Kenichi Handa's avatar
Kenichi Handa committed
674
{
Kenichi Handa's avatar
Kenichi Handa committed
675 676
  int i;

677
  for (i = 0; i < ARRAYELTS (font_property_table); i++)
Paul Eggert's avatar
Paul Eggert committed
678
    if (EQ (key, builtin_lisp_symbol (font_property_table[i].key)))
Kenichi Handa's avatar
Kenichi Handa committed
679
      return i;
680
  return -1;
Kenichi Handa's avatar
Kenichi Handa committed
681 682
}

Kenichi Handa's avatar
Kenichi Handa committed
683 684 685
/* 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.  */
686

Kenichi Handa's avatar
Kenichi Handa committed
687
static Lisp_Object
688
font_prop_validate (int idx, Lisp_Object prop, Lisp_Object val)
Kenichi Handa's avatar
Kenichi Handa committed
689
{
Kenichi Handa's avatar
Kenichi Handa committed
690
  Lisp_Object validated;
Kenichi Handa's avatar
Kenichi Handa committed
691

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

Kenichi Handa's avatar
Kenichi Handa committed
708 709 710

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

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

  if (NILP (slot))
    {
Kenichi Handa's avatar
Kenichi Handa committed
720 721 722 723 724
      Lisp_Object prev = Qnil;

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

726
      if (NILP (prev))
727
        ASET (font, FONT_EXTRA_INDEX, Fcons (Fcons (prop, val), extra));
728
      else
729
        XSETCDR (prev, Fcons (Fcons (prop, val), extra));
730

731
      return val;
732 733
    }
  XSETCDR (slot, val);
734 735
  if (NILP (val))
    ASET (font, FONT_EXTRA_INDEX, Fdelq (slot, extra));
736
  return val;
737 738
}

Kenichi Handa's avatar
Kenichi Handa committed
739

740
/* Font name parser and unparser.  */
Kenichi Handa's avatar
Kenichi Handa committed
741

742
static int parse_matrix (const char *);
743
static int font_expand_wildcards (Lisp_Object *, int);
744
static int font_parse_name (char *, ptrdiff_t, Lisp_Object);
Kenichi Handa's avatar
Kenichi Handa committed
745

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

766
/* An enumerator for mask bit corresponding to each XLFD field.  */
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
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
};


786
/* Parse P pointing to the pixel/point size field of the form
Kenichi Handa's avatar
Kenichi Handa committed
787 788 789 790 791 792 793 794 795 796 797 798 799 800
   `[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
801
parse_matrix (const char *p)
Kenichi Handa's avatar
Kenichi Handa committed
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
{
  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);
}

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

822
static int
823
font_expand_wildcards (Lisp_Object *field, int n)
824 825 826 827 828 829 830 831
{
  /* 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
832
    /* Maximum possible field.  */
833 834 835 836 837
    int to;
    /* Bit mask of possible field.  Nth bit corresponds to Nth field.  */
    int mask;
  } range[XLFD_LAST_INDEX];
  int i, j;
838
  int range_from, range_to;
839 840 841 842 843 844
  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 \
845
			    | XLFD_AVGWIDTH_MASK)
846 847 848 849 850 851 852 853
#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;

854
  /* The triplet RANGE_FROM, RANGE_TO, and RANGE_MASK is a
Paul Eggert's avatar
Paul Eggert committed
855
     position-based restriction for FIELD[I].  */
856 857
  for (i = 0, range_from = 0, range_to = 14 - n; i < n;
       i++, range_from++, range_to++, range_mask <<= 1)
858 859 860 861 862 863 864 865 866 867 868 869 870 871
    {
      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
872
	     restriction for FIELD[I].  */
873 874 875 876 877
	  int from, to;
	  unsigned mask;

	  if (INTEGERP (val))
	    {
878
	      EMACS_INT numeric = XINT (val);
879

880 881 882
	      if (i + 1 == n)
		from = to = XLFD_ENCODING_INDEX,
		  mask = XLFD_ENCODING_MASK;
883 884 885
	      else if (numeric == 0)
		from = XLFD_PIXEL_INDEX, to = XLFD_AVGWIDTH_INDEX,
		  mask = XLFD_PIXEL_MASK | XLFD_LARGENUM_MASK;
886 887 888
	      else if (numeric <= 48)
		from = to = XLFD_PIXEL_INDEX,
		  mask = XLFD_PIXEL_MASK;
889
	      else
890
		from = XLFD_POINT_INDEX, to = XLFD_AVGWIDTH_INDEX,
891 892
		  mask = XLFD_LARGENUM_MASK;
	    }
Kenichi Handa's avatar
Kenichi Handa committed
893
	  else if (SBYTES (SYMBOL_NAME (val)) == 0)
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
	    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;
	    }
909 910
	  else if (range_from <= XLFD_WEIGHT_INDEX
		   && range_to >= XLFD_WEIGHT_INDEX
Kenichi Handa's avatar
Kenichi Handa committed
911
		   && FONT_WEIGHT_NAME_NUMERIC (val) >= 0)
912
	    from = to = XLFD_WEIGHT_INDEX, mask = XLFD_WEIGHT_MASK;
913 914
	  else if (range_from <= XLFD_SLANT_INDEX
		   && range_to >= XLFD_SLANT_INDEX
Kenichi Handa's avatar
Kenichi Handa committed
915
		   && FONT_SLANT_NAME_NUMERIC (val) >= 0)
916
	    from = to = XLFD_SLANT_INDEX, mask = XLFD_SLANT_MASK;
917 918
	  else if (range_from <= XLFD_SWIDTH_INDEX
		   && range_to >= XLFD_SWIDTH_INDEX
Kenichi Handa's avatar
Kenichi Handa committed
919
		   && FONT_WIDTH_NAME_NUMERIC (val) >= 0)
920 921 922
	    from = to = XLFD_SWIDTH_INDEX, mask = XLFD_SWIDTH_MASK;
	  else
	    {
923
	      if (EQ (val, Qc) || EQ (val, Qm) || EQ (val, Qp) || EQ (val, Qd))
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
		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)
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 978 979 980
	    {
	      /* 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;
		}
	    }
981 982 983
	}
    }

Paul Eggert's avatar
Paul Eggert committed
984
  /* Decide all fields from restrictions in RANGE.  */
Kenichi Handa's avatar
(