font.h 36.1 KB
Newer Older
Kenichi Handa's avatar
Kenichi Handa committed
1
/* font.h -- Interface definition for font handling.
Paul Eggert's avatar
Paul Eggert committed
2
   Copyright (C) 2006-2020 Free Software Foundation, Inc.
3
   Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011
Kenichi Handa's avatar
Kenichi Handa committed
4 5 6 7 8
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H13PRO009

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
20
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.  */
Kenichi Handa's avatar
Kenichi Handa committed
21 22 23 24

#ifndef EMACS_FONT_H
#define EMACS_FONT_H

25 26 27 28
#ifdef HAVE_HARFBUZZ
#include <hb.h>
#endif	/* HAVE_HARFBUZZ */

29 30 31
struct composition_it;
struct face;
struct glyph_string;
Kenichi Handa's avatar
Kenichi Handa committed
32

33 34
INLINE_HEADER_BEGIN

Kenichi Handa's avatar
Kenichi Handa committed
35 36 37 38
/* We have three types of Lisp objects related to font.

   FONT-SPEC

39
	Pseudo vector (length FONT_SPEC_MAX) of font properties.  Some
Kenichi Handa's avatar
Kenichi Handa committed
40 41 42
	properties can be left unspecified (i.e. nil).  Emacs asks
	font-drivers to find a font by FONT-SPEC.  A fontset entry
	specifies requisite properties whereas a face specifies just
43
	preferable properties.
Kenichi Handa's avatar
Kenichi Handa committed
44 45 46

   FONT-ENTITY

47
	Pseudo vector (length FONT_ENTITY_MAX) of fully instantiated
48
	font properties that a font-driver returns upon a request of
Kenichi Handa's avatar
Kenichi Handa committed
49 50
	FONT-SPEC.

51
	Note: Only the method `list' and `match' of a font-driver can
52
	create this object, and it should never be modified by Lisp.
Kenichi Handa's avatar
Kenichi Handa committed
53 54 55

   FONT-OBJECT

56
	Pseudo vector (length FONT_OBJECT_MAX) of an opened font.
Kenichi Handa's avatar
Kenichi Handa committed
57

58 59 60
	Lisp object encapsulating "struct font".  This corresponds to
	an opened font.

61
	Note: Only the method `open_font' of a font-driver can create this
62
	object, and it should never be modified by Lisp.  */
63

Kenichi Handa's avatar
Kenichi Handa committed
64 65 66 67 68 69 70 71

/* An enumerator for each font property.  This is used as an index to
   the vector of FONT-SPEC and FONT-ENTITY.

   Note: The order is important and should not be changed.  */

enum font_property_index
  {
72 73
    /* FONT-TYPE is a symbol indicating a font backend; currently `x'
       and `xft' are available on X, `uniscribe' and `gdi' on
Juanma Barranquero's avatar
Juanma Barranquero committed
74
       Windows, and `ns' under Cocoa / GNUstep.  */
Kenichi Handa's avatar
Kenichi Handa committed
75 76 77 78 79 80 81 82 83 84 85 86
    FONT_TYPE_INDEX,

    /* FONT-FOUNDRY is a foundry name (symbol).  */
    FONT_FOUNDRY_INDEX,

    /* FONT-FAMILY is a family name (symbol).  */
    FONT_FAMILY_INDEX,

    /* FONT-ADSTYLE is an additional style name (symbol).  */
    FONT_ADSTYLE_INDEX,

    /* FONT-REGISTRY is a combination of a charset-registry and
87
       charset-encoding name (symbol).  */
Kenichi Handa's avatar
Kenichi Handa committed
88 89 90
    FONT_REGISTRY_INDEX,

    /* FONT-WEIGHT is a numeric value of weight (e.g. medium, bold) of
91
       the font.  The lowest 8 bits is an index determining the
92 93
       symbolic name, and the higher bits is the actual numeric value
       defined in `font-weight-table'. */
Kenichi Handa's avatar
Kenichi Handa committed
94 95 96
    FONT_WEIGHT_INDEX,

    /* FONT-SLANT is a numeric value of slant (e.g. r, i, o) of the
97
       font.  The lowest 8 bits is an index determining the symbolic
98 99
       name, and the higher bits is the actual numeric value defined
       in `font-slant-table'.  */
Kenichi Handa's avatar
Kenichi Handa committed
100 101
    FONT_SLANT_INDEX,

102
    /* FONT-WIDTH is a numeric value of setwidth (e.g. normal) of the
103
       font.  The lowest 8 bits is an index determining the symbolic
104 105
       name, and the higher bits is the actual numeric value defined
       `font-width-table'.  */
Kenichi Handa's avatar
Kenichi Handa committed
106 107 108
    FONT_WIDTH_INDEX,

    /* FONT-SIZE is a size of the font.  If integer, it is a pixel
109 110
       size.  For a font-spec, the value can be a float specifying
       the point size.  The value zero means that the font is
111
       scalable.  */
Kenichi Handa's avatar
Kenichi Handa committed
112 113
    FONT_SIZE_INDEX,

114 115 116 117 118 119 120 121 122 123 124 125
    /* FONT-DPI is a resolution (dot per inch) for which the font is
       designed. */
    FONT_DPI_INDEX,

    /* FONT-SPACING is a spacing (mono, proportional, charcell) of the
       font (integer; one of enum font_spacing).  */
    FONT_SPACING_INDEX,

    /* FONT-AVGWIDTH is an average width (1/10 pixel unit) of the
       font.  */
    FONT_AVGWIDTH_INDEX,

126
#if false
127 128 129 130 131 132 133
    /* The following two members are to substitute for the above 6
       members (FONT_WEIGHT_INDEX to FONT_AVGWIDTH_INDEX excluding
       FONT_SIZE_INDEX) if it is found that font-entities consumes too
       much memory.  */

    /* FONT-STYLE is a 24-bit integer containing indices for
       style-related properties WEIGHT, SLANT, and WIDTH.  The lowest
134 135 136 137
       8 bits is an index to the weight table AREF (font_style_table,
       0), the next 8 bits is an index to the slant table AREF
       (font_style_table, 1), the highest 8 bits is an index to the
       slant table AREF (font_style_table, 2).  The index 0 indicates
138 139 140 141 142 143
       that the corresponding style is not specified.  This way, we
       can represent at most 255 different names for each style, which
       is surely sufficient.  */
    FONT_STYLE_INDEX,

    /* FONT-METRICS is a 27-bit integer containing metrics-related
144 145
       properties DPI, AVGWIDTH, SPACING.  The lowest 12 bits is for
       DPI, the next 12 bits is for AVGWIDTH, the highest 3 bits is for
146 147 148 149 150 151 152 153
       SPACING.  In each bit field, the highest bit indicates that the
       corresponding value is set or not.  This way, we can represent
       DPI by 11-bit (0 to 2047), AVGWIDTH by 11-bit (0 to 2047),
       SPACING by 3-bit (0 for proportional, 1 for dual, 2 for mono, 3
       for charcell), which is surely sufficient.  */
    FONT_METRICS_INDEX,
#endif

Kenichi Handa's avatar
Kenichi Handa committed
154 155
    /* In a font-spec, the value is an alist of extra information of a
       font such as name, OpenType features, and language coverage.
156
       In addition, in a font-entity, the value may contain a pair
Adrian Robert's avatar
Adrian Robert committed
157
       (font-entity . INFO) where INFO is extra information to identify
Kenichi Handa's avatar
Kenichi Handa committed
158
       a font (font-driver dependent).  */
Kenichi Handa's avatar
Kenichi Handa committed
159 160 161 162 163
    FONT_EXTRA_INDEX,		/* alist		alist */

    /* This value is the length of font-spec vector.  */
    FONT_SPEC_MAX,

164
    /* The followings are used only for a font-entity and a font-object.  */
Kenichi Handa's avatar
Kenichi Handa committed
165

166 167
    /* List of font-objects opened from the font-entity.  */
    FONT_OBJLIST_INDEX = FONT_SPEC_MAX,
Kenichi Handa's avatar
Kenichi Handa committed
168 169

    /* This value is the length of font-entity vector.  */
170 171
    FONT_ENTITY_MAX,

172 173
    /* The followings are used only for a font-object.  */

174 175
    /* XLFD name of the font (string). */
    FONT_NAME_INDEX = FONT_ENTITY_MAX,
Juanma Barranquero's avatar
Juanma Barranquero committed
176

177
    /* Full name of the font (string).  It is the name extracted from
178
       the opened font, and may be different from the above.  It may be
179 180 181 182 183 184 185 186 187
       nil if the opened font doesn't give a name.  */
    FONT_FULLNAME_INDEX,

    /* File name of the font or nil if a file associated with the font
       is not available.  */
    FONT_FILE_INDEX,

    /* This value is the length of font-object vector.  */
    FONT_OBJECT_MAX
Kenichi Handa's avatar
Kenichi Handa committed
188 189
  };

190 191
/* Return the numeric weight value of FONT.  */
#define FONT_WEIGHT_NUMERIC(font)		\
192
  (FIXNUMP (AREF ((font), FONT_WEIGHT_INDEX))	\
Tom Tromey's avatar
Tom Tromey committed
193
   ? (XFIXNUM (AREF ((font), FONT_WEIGHT_INDEX)) >> 8) : -1)
194 195
/* Return the numeric slant value of FONT.  */
#define FONT_SLANT_NUMERIC(font)		\
196
  (FIXNUMP (AREF ((font), FONT_SLANT_INDEX))	\
Tom Tromey's avatar
Tom Tromey committed
197
   ? (XFIXNUM (AREF ((font), FONT_SLANT_INDEX)) >> 8) : -1)
198 199
/* Return the numeric width value of FONT.  */
#define FONT_WIDTH_NUMERIC(font)		\
200
  (FIXNUMP (AREF ((font), FONT_WIDTH_INDEX))	\
Tom Tromey's avatar
Tom Tromey committed
201
   ? (XFIXNUM (AREF ((font), FONT_WIDTH_INDEX)) >> 8) : -1)
202 203
/* Return the symbolic weight value of FONT.  */
#define FONT_WEIGHT_SYMBOLIC(font)	\
204
  font_style_symbolic (font, FONT_WEIGHT_INDEX, false)
205 206
/* Return the symbolic slant value of FONT.  */
#define FONT_SLANT_SYMBOLIC(font)	\
207
  font_style_symbolic (font, FONT_SLANT_INDEX, false)
208 209
/* Return the symbolic width value of FONT.  */
#define FONT_WIDTH_SYMBOLIC(font)	\
210
  font_style_symbolic (font, FONT_WIDTH_INDEX, false)
211 212
/* Return the face-weight corresponding to the weight of FONT.  */
#define FONT_WEIGHT_FOR_FACE(font)	\
213
  font_style_symbolic (font, FONT_WEIGHT_INDEX, true)
214 215
/* Return the face-slant corresponding to the slant of FONT.  */
#define FONT_SLANT_FOR_FACE(font)	\
216
  font_style_symbolic (font, FONT_SLANT_INDEX, true)
217 218
/* Return the face-swidth corresponding to the slant of FONT.  */
#define FONT_WIDTH_FOR_FACE(font)	\
219
  font_style_symbolic (font, FONT_WIDTH_INDEX, true)
220 221 222

/* Return the numeric weight value corresponding ot the symbol NAME.  */
#define FONT_WEIGHT_NAME_NUMERIC(name)	\
223
  (font_style_to_value (FONT_WEIGHT_INDEX, (name), false) >> 8)
224 225
/* Return the numeric slant value corresponding ot the symbol NAME.  */
#define FONT_SLANT_NAME_NUMERIC(name)	\
226
  (font_style_to_value (FONT_SLANT_INDEX, (name), false) >> 8)
227 228
/* Return the numeric width value corresponding ot the symbol NAME.  */
#define FONT_WIDTH_NAME_NUMERIC(name)	\
229
  (font_style_to_value (FONT_WIDTH_INDEX, (name), false) >> 8)
230 231 232 233 234

/* Set the font property PROP of FONT to VAL.  PROP is one of
   style-related font property index (FONT_WEIGHT/SLANT/WIDTH_INDEX).
   VAL (integer or symbol) is the numeric or symbolic style value.  */
#define FONT_SET_STYLE(font, prop, val)	\
235
  ASET ((font), prop, make_fixnum (font_style_to_value (prop, val, true)))
236

Eli Zaretskii's avatar
Eli Zaretskii committed
237
#ifndef MSDOS
238
#define FONT_WIDTH(f) ((f)->max_width)
Eli Zaretskii's avatar
Eli Zaretskii committed
239 240 241
#else
#define FONT_WIDTH(f) 1
#endif
242 243 244 245
#define FONT_HEIGHT(f) ((f)->height)
#define FONT_BASE(f) ((f)->ascent)
#define FONT_DESCENT(f) ((f)->descent)

246

247 248 249 250
/* Structure for a font-spec.  */

struct font_spec
{
251
  union vectorlike_header header;
252 253 254 255 256 257 258
  Lisp_Object props[FONT_SPEC_MAX];
};

/* Structure for a font-entity.  */

struct font_entity
{
259
  union vectorlike_header header;
260 261
  Lisp_Object props[FONT_ENTITY_MAX];
};
Kenichi Handa's avatar
Kenichi Handa committed
262

263 264 265 266 267 268
/* A value which may appear in the member `encoding' of struct font
   indicating that a font itself doesn't tell which encoding to be
   used.  */
#define FONT_ENCODING_NOT_DECIDED 255

/* Structure for a font-object.  */
Kenichi Handa's avatar
Kenichi Handa committed
269 270 271

struct font
{
272
  union vectorlike_header header;
273 274 275

  /* All Lisp_Object components must come first.
     That ensures they are all aligned normally.  */
Kenichi Handa's avatar
Kenichi Handa committed
276

277 278 279 280
  Lisp_Object props[FONT_OBJECT_MAX];

  /* Beyond here, there should be no more Lisp_Object components.  */

281 282 283 284 285
  /* Minimum and maximum glyph widths, in pixels.  Some font backends,
     such as xft, lack the information to easily compute minimum and
     maximum widths over all characters; in that case, these values
     are approximate.  */
  int min_width;
286
  int max_width;
Kenichi Handa's avatar
Kenichi Handa committed
287 288 289 290

  /* By which pixel size the font is opened.  */
  int pixel_size;

Eli Zaretskii's avatar
Eli Zaretskii committed
291
  /* Height of the font.  On X window system, this is the same as
292 293 294 295 296 297 298 299
     (font->ascent + font->descent).  */
  int height;

  /* Width of the space glyph of the font.  If the font doesn't have a
     SPACE glyph, the value is 0.  */
  int space_width;

  /* Average width of glyphs in the font.  If the font itself doesn't
Eli Zaretskii's avatar
Eli Zaretskii committed
300
     have that information, but has glyphs of ASCII characters, the
301
     value is the average width of those glyphs.  Otherwise, the value
302 303 304 305 306
     is 0.  */
  int average_width;

  /* Ascent and descent of the font (in pixels).  */
  int ascent, descent;
307

308 309 310 311
  /* The following members makes sense on graphic displays only.  */

#if defined (HAVE_WINDOW_SYSTEM)

312 313 314 315 316 317 318 319 320
  /* Vertical pixel width of the underline.  If is zero if that
     information is not in the font.  */
  int underline_thickness;

  /* Vertical pixel position (relative to the baseline) of the
     underline.  If it is positive, it is below the baseline.  It is
     negative if that information is not in the font.  */
  int underline_position;

321
  /* True if `vertical-centering-font-regexp' matches this font name.
322
     In this case, we render characters at vertical center positions
323
     of lines.  */
324
  bool vertical_centering;
325 326

  /* The baseline position of a font is normally `ascent' value of the
327
     font.  However, there exist many fonts which don't set `ascent' to
328 329 330 331 332
     an appropriate value to be used as baseline position.  This is
     typical in such ASCII fonts which are designed to be used with
     Chinese, Japanese, Korean characters.  When we use mixture of
     such fonts and normal fonts (having correct `ascent' value), a
     display line gets very ugly.  Since we have no way to fix it
333
     automatically, it is user's responsibility to supply well designed
334 335 336 337 338
     fonts or correct `ascent' value of fonts.  But, the latter
     requires heavy work (modifying all bitmap data in BDF files).
     So, Emacs accepts a private font property
     `_MULE_BASELINE_OFFSET'.  If a font has this property, we
     calculate the baseline position by subtracting the value from
339 340 341
     `ascent'.  In other words, the value indicates how many pixels
     higher than normal ASCII text we should draw a character of the
     font for better appearance.
342 343 344

     We also have to consider the fact that the concept of `baseline'
     differs among scripts to which each character belongs.  For
345
     instance, baseline should be at the bottom-most position of all
346
     glyphs for Chinese, Japanese, and Korean.  But, many of existing
347
     fonts for those characters don't have correct `ascent' values
348 349 350 351 352 353 354 355 356
     because they are designed to be used with ASCII fonts.  To
     display characters of different language on the same line, the
     best way will be to arrange them in the middle of the line.  So,
     in such a case, again, we utilize the font property
     `_MULE_BASELINE_OFFSET'.  If the value is larger than `ascent' we
     calculate baseline so that a character is arranged in the middle
     of a line.  */
  int baseline_offset;

357
  /* Non-zero means a character should be composed at a position
358 359 360 361 362
     relative to the height (or depth) of previous glyphs in the
     following cases:
	(1) The bottom of the character is higher than this value.  In
	this case, the character is drawn above the previous glyphs.
	(2) The top of the character is lower than 0 (i.e. baseline
363
	height).  In this case, the character is drawn below the
364 365 366 367 368 369
	previous glyphs.

     This value is taken from a private font property
     `_MULE_RELATIVE_COMPOSE' which is introduced by Emacs.  */
  int relative_compose;

370
  /* Non-zero means an ascent value to be used for a character
371 372 373
     registered in char-table `use-default-ascent'.  */
  int default_ascent;

374 375 376
  /* Charset to encode a character code into a glyph code of the font.
     -1 means that the font doesn't require this information to encode
     a character.  */
Kenichi Handa's avatar
Kenichi Handa committed
377 378 379 380
  int encoding_charset;

  /* Charset to check if a character code is supported by the font.
     -1 means that the contents of the font must be looked up to
381
     determine it.  */
382
  int repertory_charset;
Kenichi Handa's avatar
Kenichi Handa committed
383

384 385 386
#endif /* HAVE_WINDOW_SYSTEM */

  /* Font-driver for the font.  */
387
  struct font_driver const *driver;
388

389 390
  /* There are more members in this structure, but they are private
     to the font-driver.  */
Kenichi Handa's avatar
Kenichi Handa committed
391 392
};

393 394 395 396 397 398 399 400
enum font_spacing
  {
    FONT_SPACING_PROPORTIONAL = 0,
    FONT_SPACING_DUAL = 90,
    FONT_SPACING_MONO = 100,
    FONT_SPACING_CHARCELL = 110
  };

Kenichi Handa's avatar
Kenichi Handa committed
401 402 403 404 405 406 407
struct font_metrics
{
  short lbearing, rbearing, width, ascent, descent;
};

struct font_bitmap
{
408
  int bits_per_pixel;
Kenichi Handa's avatar
Kenichi Handa committed
409 410 411 412 413 414 415 416 417 418 419
  int rows;
  int width;
  int pitch;
  unsigned char *buffer;
  int left;
  int top;
  int advance;
};

/* Predicates to check various font-related objects.  */

420
/* True iff X is one of font-spec, font-entity, and font-object.  */
421 422 423 424 425 426
INLINE bool
FONTP (Lisp_Object x)
{
  return PSEUDOVECTORP (x, PVEC_FONT);
}

427
/* True iff X is font-spec.  */
428 429 430
INLINE bool
FONT_SPEC_P (Lisp_Object x)
{
431
  return FONTP (x) && PVSIZE (x) == FONT_SPEC_MAX;
432 433
}

434 435 436 437 438 439 440
/* Like FONT_SPEC_P, but can be used in the garbage collector.  */
INLINE bool
GC_FONT_SPEC_P (Lisp_Object x)
{
  return FONTP (x) && (gc_asize (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_SPEC_MAX;
}

441
/* True iff X is font-entity.  */
442 443 444
INLINE bool
FONT_ENTITY_P (Lisp_Object x)
{
445
  return FONTP (x) && PVSIZE (x) == FONT_ENTITY_MAX;
446 447
}

448 449 450 451 452 453 454
/* Like FONT_ENTITY_P, but can be used in the garbage collector.  */
INLINE bool
GC_FONT_ENTITY_P (Lisp_Object x)
{
  return FONTP (x) && (gc_asize (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_ENTITY_MAX;
}

455
/* True iff X is font-object.  */
456 457 458
INLINE bool
FONT_OBJECT_P (Lisp_Object x)
{
459
  return FONTP (x) && PVSIZE (x) == FONT_OBJECT_MAX;
460 461
}

462 463 464 465 466 467 468
/* Like FONT_OBJECT_P, but can be used in the garbage collector.  */
INLINE bool
GC_FONT_OBJECT_P (Lisp_Object x)
{
  return FONTP (x) && (gc_asize (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_OBJECT_MAX;
}

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 494 495 496 497 498 499 500
/* Type checking functions for various font-related objects.  */

INLINE void
CHECK_FONT (Lisp_Object x)
{
  CHECK_TYPE (FONTP (x), Qfont, x);
}

INLINE void
CHECK_FONT_SPEC (Lisp_Object x)
{
  CHECK_TYPE (FONT_SPEC_P (x), Qfont_spec, x);
}

INLINE void
CHECK_FONT_ENTITY (Lisp_Object x)
{
  CHECK_TYPE (FONT_ENTITY_P (x), Qfont_entity, x);
}

INLINE void
CHECK_FONT_OBJECT (Lisp_Object x)
{
  CHECK_TYPE (FONT_OBJECT_P (x), Qfont_object, x);
}

/* C pointer extraction functions for various font-related objects.  */

INLINE struct font_spec *
XFONT_SPEC (Lisp_Object p)
{
  eassert (FONT_SPEC_P (p));
501
  return XUNTAG (p, Lisp_Vectorlike, struct font_spec);
502 503
}

504 505 506 507
INLINE struct font_spec *
GC_XFONT_SPEC (Lisp_Object p)
{
  eassert (GC_FONT_SPEC_P (p));
508
  return XUNTAG (p, Lisp_Vectorlike, struct font_spec);
509 510
}

511 512 513 514
INLINE struct font_entity *
XFONT_ENTITY (Lisp_Object p)
{
  eassert (FONT_ENTITY_P (p));
515
  return XUNTAG (p, Lisp_Vectorlike, struct font_entity);
516 517
}

518 519 520 521
INLINE struct font_entity *
GC_XFONT_ENTITY (Lisp_Object p)
{
  eassert (GC_FONT_ENTITY_P (p));
522
  return XUNTAG (p, Lisp_Vectorlike, struct font_entity);
523 524
}

525 526 527 528
INLINE struct font *
XFONT_OBJECT (Lisp_Object p)
{
  eassert (FONT_OBJECT_P (p));
529
  return XUNTAG (p, Lisp_Vectorlike, struct font);
530 531
}

532 533 534 535
INLINE struct font *
GC_XFONT_OBJECT (Lisp_Object p)
{
  eassert (GC_FONT_OBJECT_P (p));
536
  return XUNTAG (p, Lisp_Vectorlike, struct font);
537 538
}

539 540
#define XSETFONT(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FONT))

541 542 543 544 545 546 547
INLINE struct font *
CHECK_FONT_GET_OBJECT (Lisp_Object x)
{
  CHECK_FONT_OBJECT (x);
  return XFONT_OBJECT (x);
}

548 549 550 551 552 553 554
/* Number of pt per inch (from the TeXbook).  */
#define PT_PER_INCH 72.27

/* Return a pixel size (integer) corresponding to POINT size (double)
   on resolution DPI.  */
#define POINT_TO_PIXEL(POINT, DPI) ((POINT) * (DPI) / PT_PER_INCH + 0.5)

555
/* Return a point size corresponding to POINT size (integer)
556 557
   on resolution DPI.  Note that though point size is a double, we expect
   it to be rounded to an int, so we add 0.5 here.  If the desired value
558 559
   is tenths of points (as in xfld specs), then the pixel size should
   be multiplied BEFORE the conversion to avoid magnifying the error.  */
560 561
#define PIXEL_TO_POINT(PIXEL, DPI) ((PIXEL) * PT_PER_INCH / (DPI) + 0.5)

562 563 564 565
/* Ignore the difference of font pixel sizes less than or equal to
   this value.  */
#define FONT_PIXEL_SIZE_QUANTUM 1

Kenichi Handa's avatar
Kenichi Handa committed
566 567
#define FONT_INVALID_CODE 0xFFFFFFFF

568 569
/* Font driver.  Members specified as "optional" can be NULL.  */

Kenichi Handa's avatar
Kenichi Handa committed
570 571 572 573 574
struct font_driver
{
  /* Symbol indicating the type of the font-driver.  */
  Lisp_Object type;

575
  /* True iff the font's foundry, family, and adstyle names are case
Paul Eggert's avatar
Paul Eggert committed
576
     sensitive.  */
577
  bool case_sensitive;
578

579
  /* Return a cache of font-entities on frame F.  The cache must be a
Kenichi Handa's avatar
Kenichi Handa committed
580
     cons whose cdr part is the actual cache area.  */
Dmitry Antipov's avatar
Dmitry Antipov committed
581
  Lisp_Object (*get_cache) (struct frame *f);
Kenichi Handa's avatar
Kenichi Handa committed
582

Eli Zaretskii's avatar
Eli Zaretskii committed
583 584
  /* List fonts exactly matching FONT_SPEC on FRAME.  The value is
     a list of font-entities.  The font properties to be considered
585
     are: :foundry, :family, :adstyle, :registry, :script, :lang, and
Kenichi Handa's avatar
Kenichi Handa committed
586 587 588 589 590 591 592 593 594 595 596
     :otf.  See the function `font-spec' for their meanings.  Note
     that the last three properties are stored in FONT_EXTRA_INDEX
     slot of FONT_SPEC.

     The returned value is a list of font-entities.  Each font-entity
     has :type property whose value is the same as the above `type'.
     It also has these properties if they are available from the
     corresponding font; :foundry, :family, :adstyle, :registry,
     :weight, :slant, :width, :size, :dpi, :spacing, :avgwidth.  If
     the font is scalable, :size and :avgwidth must be 0.

597
     The `open_font' method of the same font-backend is called with one of
Kenichi Handa's avatar
Kenichi Handa committed
598
     the returned font-entities.  If the backend needs additional
599
     information to be used in `open_font' method, this method can add any
Eli Zaretskii's avatar
Eli Zaretskii committed
600
     Lispy value using the property :font-entity to the entities.
Kenichi Handa's avatar
Kenichi Handa committed
601

602 603
     This and the following `match' are the only APIs that allocate
     font-entities.  */
604
  Lisp_Object (*list) (struct frame *frame, Lisp_Object font_spec);
Kenichi Handa's avatar
Kenichi Handa committed
605

Eli Zaretskii's avatar
Eli Zaretskii committed
606 607 608
  /* Return a font-entity most closely matching FONT_SPEC on FRAME.
     Which font property to consider, and how to calculate the
     closeness, is determined by the font backend, thus
Kenichi Handa's avatar
Kenichi Handa committed
609 610
     `face-font-selection-order' is ignored here.

Eli Zaretskii's avatar
Eli Zaretskii committed
611 612
     The properties that the font-entity has are the same as described
     for the `list' method above.  */
Paul Eggert's avatar
Paul Eggert committed
613
  Lisp_Object (*match) (struct frame *f, Lisp_Object font_spec);
614

615 616 617
  /* Optional.
     List available families.  The value is a list of family names
     (symbols).  */
618
  Lisp_Object (*list_family) (struct frame *f);
Kenichi Handa's avatar
Kenichi Handa committed
619

Paul Eggert's avatar
Paul Eggert committed
620
  /* Optional.
621
     Free FONT_EXTRA_INDEX field of FONT_ENTITY.  */
Jan D's avatar
Jan D committed
622
  void (*free_entity) (Lisp_Object font_entity);
Kenichi Handa's avatar
Kenichi Handa committed
623 624 625

  /* Open a font specified by FONT_ENTITY on frame F.  If the font is
     scalable, open it with PIXEL_SIZE.  */
626 627
  Lisp_Object (*open_font) (struct frame *f, Lisp_Object font_entity,
                            int pixel_size);
Kenichi Handa's avatar
Kenichi Handa committed
628

629
  /* Close FONT.  NOTE: this can be called by GC.  */
630
  void (*close_font) (struct font *font);
Kenichi Handa's avatar
Kenichi Handa committed
631

632 633 634
  /* Prepare FACE for displaying characters by FONT on frame F by
     storing some data in FACE->extra.  */
  void (*prepare_face) (struct frame *f, struct face *face);
Kenichi Handa's avatar
Kenichi Handa committed
635

636
  /* Optional.
Eli Zaretskii's avatar
Eli Zaretskii committed
637
     Done with FACE for displaying characters by FACE->font on frame F.  */
Dmitry Antipov's avatar
Dmitry Antipov committed
638
  void (*done_face) (struct frame *f, struct face *face);
Kenichi Handa's avatar
Kenichi Handa committed
639

640
  /* Optional.
641 642 643
     If FONT (FONT-ENTITY or FONT-OBJECT) has a glyph for character C
     (Unicode code point), return 1.  If not, return 0.  If FONT is
     FONT-ENTITY and it must be opened to check it, return -1.  */
Jan D's avatar
Jan D committed
644
  int (*has_char) (Lisp_Object font, int c);
Kenichi Handa's avatar
Kenichi Handa committed
645

646
  /* Return a glyph code of FONT for character C (Unicode code point).
647
     If FONT doesn't have such a glyph, return FONT_INVALID_CODE.  */
Jan D's avatar
Jan D committed
648
  unsigned (*encode_char) (struct font *font, int c);
Kenichi Handa's avatar
Kenichi Handa committed
649

650
  /* Compute the total metrics of the NGLYPHS glyphs specified by
651 652
     the font FONT and the sequence of glyph codes CODE, and store the
     result in METRICS.  */
653
  void (*text_extents) (struct font *font,
654
			const unsigned *code, int nglyphs,
655
			struct font_metrics *metrics);
Kenichi Handa's avatar
Kenichi Handa committed
656

657 658
#ifdef HAVE_WINDOW_SYSTEM

659 660
  /* Optional.
     Draw glyphs between FROM and TO of S->char2b at (X Y) pixel
661 662 663
     position of frame F with S->FACE and S->GC.  If WITH_BACKGROUND,
     fill the background in advance.  It is assured that WITH_BACKGROUND
     is false when (FROM > 0 || TO < S->nchars).  */
Jan D's avatar
Jan D committed
664
  int (*draw) (struct glyph_string *s, int from, int to,
665
               int x, int y, bool with_background);
Kenichi Handa's avatar
Kenichi Handa committed
666

667 668
  /* Optional.
     Store bitmap data for glyph-code CODE of FONT in BITMAP.  It is
Eli Zaretskii's avatar
Eli Zaretskii committed
669 670
     intended that this method is called from other font-driver
     methods for actual drawing.  */
Jan D's avatar
Jan D committed
671 672 673
  int (*get_bitmap) (struct font *font, unsigned code,
                     struct font_bitmap *bitmap,
                     int bits_per_pixel);
Kenichi Handa's avatar
Kenichi Handa committed
674

675 676
  /* Optional.
     Free bitmap data in BITMAP.  */
Jan D's avatar
Jan D committed
677
  void (*free_bitmap) (struct font *font, struct font_bitmap *bitmap);
Kenichi Handa's avatar
Kenichi Handa committed
678

679 680
#endif /* HAVE_WINDOW_SYSTEM */

681 682
  /* Optional.
     Get coordinates of the INDEXth anchor point of the glyph whose
Kenichi Handa's avatar
Kenichi Handa committed
683
     code is CODE.  Store the coordinates in *X and *Y.  Return 0 if
Eli Zaretskii's avatar
Eli Zaretskii committed
684
     the operation was successful.  Otherwise return -1.  */
Jan D's avatar
Jan D committed
685 686
  int (*anchor_point) (struct font *font, unsigned code, int index,
                       int *x, int *y);
Kenichi Handa's avatar
Kenichi Handa committed
687

688 689
  /* Optional.
     Return a list describing which scripts/languages FONT
Eli Zaretskii's avatar
Eli Zaretskii committed
690 691 692 693
     supports by which GSUB/GPOS features of OpenType tables.
     The list should be of the form (GSUB GPOS), where both
     GSUB and GPOS are lists of the form
     ((SCRIPT (LANGSYS FEATURE ...) ...) ...)  */
Jan D's avatar
Jan D committed
694
  Lisp_Object (*otf_capability) (struct font *font);
Kenichi Handa's avatar
Kenichi Handa committed
695

696
  /* Optional.
Kenichi Handa's avatar
Kenichi Handa committed
697 698 699 700
     Apply FONT's OTF-FEATURES to the glyph string.

     FEATURES specifies which OTF features to apply in this format:
	(SCRIPT LANGSYS GSUB-FEATURE GPOS-FEATURE)
701
     See the documentation of `font-drive-otf' for the details.
Kenichi Handa's avatar
Kenichi Handa committed
702 703 704 705 706 707 708 709

     This method applies the specified features to the codes in the
     elements of GSTRING-IN (between FROMth and TOth).  The output
     codes are stored in GSTRING-OUT at the IDXth element and the
     following elements.

     Return the number of output codes.  If none of the features are
     applicable to the input data, return 0.  If GSTRING-OUT is too
710 711 712 713 714
     short, return -1.

     Note: This method is currently not implemented by any font
     back-end, and is only called by 'font-drive-otf' and
     'font-otf-alternates', which are themselves ifdef'ed away. */
Jan D's avatar
Jan D committed
715 716
  int (*otf_drive) (struct font *font, Lisp_Object features,
                    Lisp_Object gstring_in, int from, int to,
717
                    Lisp_Object gstring_out, int idx, bool alternate_subst);
718 719 720

  /* Optional.
     Make the font driver ready for frame F.  Usually this function
Eli Zaretskii's avatar
Eli Zaretskii committed
721 722
     makes some data specific to F and stores it in F's font_data
     member by calling font_put_frame_data.  */
Dmitry Antipov's avatar
Dmitry Antipov committed
723
  int (*start_for_frame) (struct frame *f);
Juanma Barranquero's avatar
Juanma Barranquero committed
724

725
  /* Optional.
Eli Zaretskii's avatar
Eli Zaretskii committed
726 727
     End using the driver for frame F.  Usually this function frees
     some font data stored in frame F's font_data member.  */
Dmitry Antipov's avatar
Dmitry Antipov committed
728
  int (*end_for_frame) (struct frame *f);
Kenichi Handa's avatar
Kenichi Handa committed
729 730

  /* Optional.
731 732 733 734 735
     Shape text in GSTRING.  See the docstring of
     `composition-get-gstring' for the format of GSTRING.  If the
     (N+1)th element of GSTRING is nil, input of shaping is from the
     1st to (N)th elements.  In each input glyph, FROM, TO, CHAR, and
     CODE are already set.
736 737 738
     DIRECTION is either L2R or R2L, or nil if unknown.  During
     redisplay, this comes from applying the UBA, is passed from
     composition_reseat_it, and is used by the HarfBuzz shaper.
739 740 741

     This function updates all fields of the input glyphs.  If the
     output glyphs (M) are more than the input glyphs (N), (N+1)th
742 743
     through (M)th elements of GSTRING are updated possibly by making
     a new glyph object and storing it in GSTRING.  If (M) is greater
Eli Zaretskii's avatar
Eli Zaretskii committed
744 745
     than the length of GSTRING, this method should return nil.  In
     that case, the method is called again with a larger GSTRING.  */
746
  Lisp_Object (*shape) (Lisp_Object lgstring, Lisp_Object direction);
747 748 749

  /* Optional.
     If FONT is usable on frame F, return 0.  Otherwise return -1.
750 751
     This method is used only for debugging.  If this method is NULL,
     Emacs assumes that the font is usable on any frame.  */
Dmitry Antipov's avatar
Dmitry Antipov committed
752
  int (*check) (struct frame *f, struct font *font);
753 754 755 756 757 758

  /* Optional.
     Return the number of variation glyphs of character C supported by
     FONT.  VARIATIONS is an array of 256 elements.  If the variation
     selector N (1..256) defines a glyph, that glyph code is stored in
     the (N-1)th element of VARIATIONS.  */
Jan D's avatar
Jan D committed
759 760
  int (*get_variation_glyphs) (struct font *font,
                               int c, unsigned variations[256]);
761

Eli Zaretskii's avatar
Eli Zaretskii committed
762 763 764 765 766 767
  /* Optional.
     Set attributes of FONT according to PROPERTIES.
     PROPERTIES is an alist of pairs (KEY . VALUE) that specifies
     font properties.  This method should use font-put to set
     properties of FONT supported by the font driver.
     See font_filter_properties for more details.  */
Jan D's avatar
Jan D committed
768
  void (*filter_properties) (Lisp_Object font, Lisp_Object properties);
769 770 771 772

  /* Optional.
     Return non-zero if FONT_OBJECT can be used as a (cached) font
     for ENTITY on frame F.  */
773 774 775
  bool (*cached_font_ok) (struct frame *f,
                          Lisp_Object font_object,
                          Lisp_Object entity);
776

Eli Zaretskii's avatar
Eli Zaretskii committed
777 778
  /* Optional.
     Return non-nil if the driver supports rendering of combining
779 780
     characters for FONT according to Unicode combining class.  */
  Lisp_Object (*combining_capability) (struct font *font);
781

Eli Zaretskii's avatar
Eli Zaretskii committed
782
  /* Optional.
783 784 785 786
     Called when frame F is double-buffered and its size changes; Xft
     relies on this hook to throw away its old XftDraw (which won't
     work after the size change) and get a new one.  */
  void (*drop_xrender_surfaces) (struct frame *f);
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801

#ifdef HAVE_HARFBUZZ
  /* Optional.
     Return a HarfBuzz font object for FONT and store to
     *POSITION_UNIT the scale factor to convert a hb_position_t value
     to the number of pixels.  Return NULL if HarfBuzz font object is
     not available for FONT.  */
  hb_font_t *(*begin_hb_font) (struct font *font, double *position_unit);

  /* Optional.
     Called when the return value (passed as HB_FONT) of begin_hb_font
     above is no longer used.  Not called if the return value of
     begin_hb_font was NULL.  */
  void (*end_hb_font) (struct font *font, hb_font_t *hb_font);
#endif	/* HAVE_HARFBUZZ */
Kenichi Handa's avatar
Kenichi Handa committed
802 803 804
};


805
/* Chain of font drivers.  There's one global font driver list
Dmitry Antipov's avatar
Dmitry Antipov committed
806 807
   (font_driver_list in font.c).  In addition, each frame has
   its own font driver list at F->font_driver_list.  */
808

Kenichi Handa's avatar
Kenichi Handa committed
809 810
struct font_driver_list
{
811
  /* True iff this driver is currently used.  It is ignored in the global
812
     font driver list.*/
813
  bool on;
814
  /* Pointer to the font driver.  */
815
  struct font_driver const *driver;
816
  /* Pointer to the next element of the chain.  */
Kenichi Handa's avatar
Kenichi Handa committed
817 818 819
  struct font_driver_list *next;
};

820 821
extern Lisp_Object copy_font_spec (Lisp_Object);
extern Lisp_Object merge_font_spec (Lisp_Object, Lisp_Object);
Kenichi Handa's avatar
Kenichi Handa committed
822

Jan D's avatar
Jan D committed
823 824
extern Lisp_Object font_make_entity (void);
extern Lisp_Object font_make_object (int, Lisp_Object, int);
825 826 827
#if defined (HAVE_XFT) || defined (HAVE_FREETYPE) || defined (HAVE_NS)
extern Lisp_Object font_build_object (int, Lisp_Object, Lisp_Object, double);
#endif
Jan D's avatar
Jan D committed
828 829 830 831 832

extern Lisp_Object find_font_encoding (Lisp_Object);
extern int font_registry_charsets (Lisp_Object, struct charset **,
                                   struct charset **);
extern int font_style_to_value (enum font_property_index prop,
833
                                Lisp_Object name, bool noerror);
Jan D's avatar
Jan D committed
834 835
extern Lisp_Object font_style_symbolic (Lisp_Object font,
                                        enum font_property_index prop,
836
                                        bool for_face);
Jan D's avatar
Jan D committed
837

838
extern bool font_match_p (Lisp_Object spec, Lisp_Object font);
839
extern bool font_is_ignored (const char *name, ptrdiff_t namelen);
840
extern Lisp_Object font_list_entities (struct frame *, Lisp_Object);
Jan D's avatar
Jan D committed
841 842 843 844

extern Lisp_Object font_get_name (Lisp_Object font_object);
extern Lisp_Object font_spec_from_name (Lisp_Object font_name);
extern Lisp_Object font_get_frame (Lisp_Object font_object);
Dmitry Antipov's avatar
Dmitry Antipov committed
845
extern int font_has_char (struct frame *, Lisp_Object, int);
Jan D's avatar
Jan D committed
846 847 848

extern void font_clear_prop (Lisp_Object *attrs,
                             enum font_property_index prop);
Dmitry Antipov's avatar
Dmitry Antipov committed
849
extern Lisp_Object font_find_for_lface (struct frame *f, Lisp_Object *lface,
Jan D's avatar
Jan D committed
850
                                        Lisp_Object spec, int c);
Dmitry Antipov's avatar
Dmitry Antipov committed
851
extern Lisp_Object font_open_for_lface (struct frame *f, Lisp_Object entity,
Jan D's avatar
Jan D committed
852 853
                                        Lisp_Object *lface,
                                        Lisp_Object spec);
Dmitry Antipov's avatar
Dmitry Antipov committed
854
extern Lisp_Object font_load_for_lface (struct frame *f, Lisp_Object *lface,
Jan D's avatar
Jan D committed
855
                                        Lisp_Object spec);
Dmitry Antipov's avatar
Dmitry Antipov committed
856 857
extern void font_prepare_for_face (struct frame *f, struct face *face);
extern void font_done_for_face (struct frame *f, struct face *face);
858
extern void clear_font_cache (struct frame *);
Jan D's avatar
Jan D committed
859

Dmitry Antipov's avatar
Dmitry Antipov committed
860 861
extern Lisp_Object font_open_by_spec (struct frame *f, Lisp_Object spec);
extern Lisp_Object font_open_by_name (struct frame *f, Lisp_Object name);
Kenichi Handa's avatar
Kenichi Handa committed
862

863
extern Lisp_Object font_intern_prop (const char *str, ptrdiff_t len,
864
				     bool force_symbol);
Jan D's avatar
Jan D committed
865 866 867 868 869 870
extern void font_update_sort_order (int *order);

extern void font_parse_family_registry (Lisp_Object family,
                                        Lisp_Object registry,
                                        Lisp_Object spec);

871
extern int font_parse_xlfd (char *name, ptrdiff_t len, Lisp_Object font);
872 873
extern ptrdiff_t font_unparse_xlfd (Lisp_Object font, int pixel_size,
				    char *name, int bytes);
874
extern void register_font_driver (struct font_driver const *, struct frame *);
Dmitry Antipov's avatar
Dmitry Antipov committed
875
extern void free_font_driver_list (struct frame *f);
876
#ifdef ENABLE_CHECKING
877
extern bool valid_font_driver (struct font_driver const *);
878 879
#else
INLINE bool
880
valid_font_driver (struct font_driver const *d)
881 882 883
{
  return true;
}
884
#endif
Dmitry Antipov's avatar
Dmitry Antipov committed
885
extern Lisp_Object font_update_drivers (struct frame *f, Lisp_Object list);
886
extern Lisp_Object font_range (ptrdiff_t, ptrdiff_t, ptrdiff_t *,
Stefan Monnier's avatar
Stefan Monnier committed
887 888
			       struct window *, struct face *,
			       Lisp_Object);
889
extern void font_fill_lglyph_metrics (Lisp_Object, struct font *, unsigned int);
Kenichi Handa's avatar
Kenichi Handa committed
890

Jan D's avatar
Jan D committed
891 892
extern Lisp_Object font_put_extra (Lisp_Object font, Lisp_Object prop,
                                   Lisp_Object val);
Kenichi Handa's avatar
Kenichi Handa committed
893

894
#ifdef HAVE_HARFBUZZ
895
extern Lisp_Object hbfont_otf_capability (struct font *);
896 897 898 899
extern Lisp_Object hbfont_shape (Lisp_Object, Lisp_Object);
extern Lisp_Object hbfont_combining_capability (struct font *);
#endif

900 901 902 903
#if defined (HAVE_XFT) || defined (HAVE_FREETYPE)
extern void font_put_frame_data (struct frame *, Lisp_Object, void *);
extern void *font_get_frame_data (struct frame *f, Lisp_Object);
#endif /* HAVE_XFT || HAVE_FREETYPE */
904

905 906
extern void font_filter_properties (Lisp_Object font,
				    Lisp_Object alist,
907
				    const char *const boolean_properties[],
908 909 910
                                    const char *const non_boolean_properties[]);

extern void font_drop_xrender_surfaces (struct frame *f);
911

Kenichi Handa's avatar
Kenichi Handa committed
912
#ifdef HAVE_FREETYPE
913 914 915 916 917 918 919 920
extern int ftfont_anchor_point (struct font *, unsigned int, int,
				int *, int *);
extern int ftfont_get_bitmap (struct font *, unsigned int,
			      struct font_bitmap *, int);
extern int ftfont_has_char (Lisp_Object, int);
extern int ftfont_variation_glyphs (struct font *, int, unsigned[256]);
extern Lisp_Object ftfont_combining_capability (struct font *);
extern Lisp_Object ftfont_get_cache (struct frame *);
921
extern Lisp_Object ftfont_list2 (struct frame *, Lisp_Object, Lisp_Object);
922
extern Lisp_Object ftfont_list_family (struct frame *);
923
extern Lisp_Object ftfont_match2 (struct frame *, Lisp_Object, Lisp_Object);
924 925
extern Lisp_Object ftfont_open (struct frame *, Lisp_Object, int);
extern Lisp_Object ftfont_otf_capability (struct font *);
926
extern Lisp_Object ftfont_shape (Lisp_Object, Lisp_Object);
927 928 929
extern unsigned ftfont_encode_char (struct font *, int);
extern void ftfont_close (struct font *);
extern void ftfont_filter_properties (Lisp_Object, Lisp_Object);
930
extern void ftfont_text_extents (struct font *, const unsigned *, int,
931
				 struct font_metrics *);
932 933 934
#ifdef HAVE_HARFBUZZ
extern hb_font_t *fthbfont_begin_hb_font (struct font *, double *);
#endif	/* HAVE_HARFBUZZ */
935
extern void syms_of_ftfont (void);
Kenichi Handa's avatar
Kenichi Handa committed
936 937
#endif	/* HAVE_FREETYPE */
#ifdef HAVE_X_WINDOWS
938 939
extern struct font_driver const xfont_driver;
extern Lisp_Object xfont_get_cache (struct frame *);
940
extern void syms_of_xfont (void);
Kenichi Handa's avatar
Kenichi Handa committed
941
#ifdef HAVE_XFT
942
extern struct font_driver const xftfont_driver;
943 944 945
#ifdef HAVE_HARFBUZZ
extern struct font_driver xfthbfont_driver;
#endif	/* HAVE_HARFBUZZ */
946 947
#endif
#if defined HAVE_FREETYPE || defined HAVE_XFT
948
extern void syms_of_xftfont (void);
949
#endif
950 951 952
#ifdef HAVE_BDFFONT
extern void syms_of_bdffont (void);
#endif	/* HAVE_BDFFONT */
Kenichi Handa's avatar
Kenichi Handa committed
953
#endif	/* HAVE_X_WINDOWS */
Daniel Colascione's avatar
Daniel Colascione committed
954
#ifdef HAVE_NTGUI
Kenichi Handa's avatar
Kenichi Handa committed
955
extern struct font_driver w32font_driver;
956
extern struct font_driver uniscribe_font_driver;
957 958 959
#ifdef HAVE_HARFBUZZ
extern struct font_driver harfbuzz_font_driver;
#endif
960
extern void syms_of_w32font (void);
Daniel Colascione's avatar
Daniel Colascione committed
961
#endif	/* HAVE_NTGUI */
962
#ifdef HAVE_NS
963
extern struct font_driver const nsfont_driver;
964
extern void syms_of_nsfont (void);
965
extern void syms_of_macfont (void);
966
#endif	/* HAVE_NS */
Jan D's avatar
Jan D committed
967
#ifdef USE_CAIRO
968
extern struct font_driver const ftcrfont_driver;
969 970 971
#ifdef HAVE_HARFBUZZ
extern struct font_driver ftcrhbfont_driver;
#endif	/* HAVE_HARFBUZZ */
Jan D's avatar
Jan D committed
972 973
extern void syms_of_ftcrfont (void);
#endif
Kenichi Handa's avatar
Kenichi Handa committed
974

975 976 977 978
#ifndef FONT_DEBUG
#define FONT_DEBUG
#endif

979 980
extern void font_add_log (const char *, Lisp_Object, Lisp_Object);
extern void font_deferred_log (const char *, Lisp_Object, Lisp_Object);
981

Kenichi Handa's avatar
Kenichi Handa committed
982 983 984 985
#define FONT_ADD_LOG(ACTION, ARG, RESULT)	\
  do {						\
    if (! EQ (Vfont_log, Qt))			\
      font_add_log ((ACTION), (ARG), (RESULT));	\
986
  } while (false)
Kenichi Handa's avatar
Kenichi Handa committed
987 988 989 990 991

#define FONT_DEFERRED_LOG(ACTION, ARG, RESULT)		\
  do {							\
    if (! EQ (Vfont_log, Qt))				\
      font_deferred_log ((ACTION), (ARG), (RESULT));	\
992
  } while (false)
Kenichi Handa's avatar
Kenichi Handa committed
993

Paul Eggert's avatar
Paul Eggert committed
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
/* FIXME: This is for use in functions that can be called while
   garbage-collecting, but which assume that Lisp data structures are
   properly-formed.  This invalid assumption can lead to core dumps
   (Bug#20890).  */
INLINE bool
font_data_structures_may_be_ill_formed (void)
{
#ifdef USE_CAIRO
  /* Although this works around Bug#20890, it is probably not the
     right thing to do.  */
  return gc_in_progress;
#else
  return false;
#endif
}

1010 1011
INLINE_HEADER_END

Kenichi Handa's avatar
Kenichi Handa committed
1012
#endif	/* not EMACS_FONT_H */