font.h 32.3 KB
Newer Older
Kenichi Handa's avatar
Kenichi Handa committed
1
/* font.h -- Interface definition for font handling.
2
   Copyright (C) 2006-2014 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 <http://www.gnu.org/licenses/>.  */
Kenichi Handa's avatar
Kenichi Handa committed
21 22 23 24 25

#ifndef EMACS_FONT_H
#define EMACS_FONT_H

#include "ccl.h"
Daniel Colascione's avatar
Daniel Colascione committed
26
#include "frame.h"
Kenichi Handa's avatar
Kenichi Handa committed
27

28 29
INLINE_HEADER_BEGIN

Kenichi Handa's avatar
Kenichi Handa committed
30 31 32 33
/* We have three types of Lisp objects related to font.

   FONT-SPEC

34
	Pseudo vector (length FONT_SPEC_MAX) of font properties.  Some
Kenichi Handa's avatar
Kenichi Handa committed
35 36 37
	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
38
	preferable properties.
Kenichi Handa's avatar
Kenichi Handa committed
39 40 41

   FONT-ENTITY

42
	Pseudo vector (length FONT_ENTITY_MAX) of fully instantiated
43
	font properties that a font-driver returns upon a request of
Kenichi Handa's avatar
Kenichi Handa committed
44 45
	FONT-SPEC.

46
	Note: Only the method `list' and `match' of a font-driver can
47
	create this object, and it should never be modified by Lisp.
Kenichi Handa's avatar
Kenichi Handa committed
48 49 50

   FONT-OBJECT

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

53 54 55 56
	Lisp object encapsulating "struct font".  This corresponds to
	an opened font.

	Note: Only the method `open' of a font-driver can create this
57
	object, and it should never be modified by Lisp.  */
58 59

extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
Kenichi Handa's avatar
Kenichi Handa committed
60 61 62 63 64 65 66 67 68

/* 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
  {
    /* FONT-TYPE is a symbol indicating a font backend; currently `x',
69
       `xft', and `ftx' are available on X, `uniscribe' and `gdi' on
Juanma Barranquero's avatar
Juanma Barranquero committed
70
       Windows, and `ns' under Cocoa / GNUstep.  */
Kenichi Handa's avatar
Kenichi Handa committed
71 72 73 74 75 76 77 78 79 80 81 82
    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
83
       charset-encoding name (symbol).  */
Kenichi Handa's avatar
Kenichi Handa committed
84 85 86
    FONT_REGISTRY_INDEX,

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

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

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

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

110 111 112 113 114 115 116 117 118 119 120 121
    /* 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,

122
#if false
123 124 125 126 127 128 129
    /* 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
130 131 132 133
       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
134 135 136 137 138 139
       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
140 141
       properties DPI, AVGWIDTH, SPACING.  The lowest 12 bits is for
       DPI, the next 12 bits is for AVGWIDTH, the highest 3 bits is for
142 143 144 145 146 147 148 149
       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
150 151
    /* In a font-spec, the value is an alist of extra information of a
       font such as name, OpenType features, and language coverage.
152
       In addition, in a font-entity, the value may contain a pair
Adrian Robert's avatar
Adrian Robert committed
153
       (font-entity . INFO) where INFO is extra information to identify
Kenichi Handa's avatar
Kenichi Handa committed
154
       a font (font-driver dependent).  */
Kenichi Handa's avatar
Kenichi Handa committed
155 156 157 158 159
    FONT_EXTRA_INDEX,		/* alist		alist */

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

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

162 163
    /* List of font-objects opened from the font-entity.  */
    FONT_OBJLIST_INDEX = FONT_SPEC_MAX,
Kenichi Handa's avatar
Kenichi Handa committed
164

165 166 167
    /* Font-entity from which the font-object is opened.  */
    FONT_ENTITY_INDEX = FONT_SPEC_MAX,

Kenichi Handa's avatar
Kenichi Handa committed
168
    /* This value is the length of font-entity vector.  */
169 170
    FONT_ENTITY_MAX,

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

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

176
    /* Full name of the font (string).  It is the name extracted from
177
       the opened font, and may be different from the above.  It may be
178 179 180 181 182 183 184
       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,

Kenichi Handa's avatar
Kenichi Handa committed
185
    /* Format of the font (symbol) or nil if unknown.  */
186 187 188 189
    FONT_FORMAT_INDEX,

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

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

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

/* 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)	\
237
  ASET ((font), prop, make_number (font_style_to_value (prop, val, true)))
238

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

248
extern Lisp_Object QCspacing, QCdpi, QCscalable, QCotf, QClang, QCscript;
249
extern Lisp_Object QCavgwidth, QCantialias, QCfont_entity;
250 251
extern Lisp_Object Qp;

Kenichi Handa's avatar
Kenichi Handa committed
252

253
/* Important character set symbols.  */
Kenichi Handa's avatar
Kenichi Handa committed
254
extern Lisp_Object Qascii_0;
Kenichi Handa's avatar
Kenichi Handa committed
255
extern Lisp_Object Qiso8859_1, Qiso10646_1, Qunicode_bmp, Qunicode_sip;
256

257 258 259
/* Special ADSTYLE properties to avoid fonts used for Latin characters.  */
extern Lisp_Object Qja, Qko;

260 261 262 263
/* Structure for a font-spec.  */

struct font_spec
{
264
  struct vectorlike_header header;
265 266 267 268 269 270 271
  Lisp_Object props[FONT_SPEC_MAX];
};

/* Structure for a font-entity.  */

struct font_entity
{
272
  struct vectorlike_header header;
273 274
  Lisp_Object props[FONT_ENTITY_MAX];
};
Kenichi Handa's avatar
Kenichi Handa committed
275

276 277 278 279 280 281
/* 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
282 283 284

struct font
{
285
  struct vectorlike_header header;
286 287 288

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

290 291 292 293
  Lisp_Object props[FONT_OBJECT_MAX];

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

294 295 296 297 298
  /* 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;
299
  int max_width;
Kenichi Handa's avatar
Kenichi Handa committed
300 301 302 303

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

304 305 306 307 308 309 310 311 312
  /* Height of the font.  On X window, this is the same as
     (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
313
     have that information but has glyphs of ASCII characters, the
314
     value is the average width of those glyphs.  Otherwise, the value
315 316 317 318 319
     is 0.  */
  int average_width;

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

321 322 323 324
  /* The following members makes sense on graphic displays only.  */

#if defined (HAVE_WINDOW_SYSTEM)

325 326 327 328 329 330 331 332 333
  /* 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;

334
  /* True if `vertical-centering-font-regexp' matches this font name.
335
     In this case, we render characters at vertical center positions
336
     of lines.  */
337
  bool vertical_centering;
338 339

  /* The baseline position of a font is normally `ascent' value of the
340
     font.  However, there exist many fonts which don't set `ascent' to
341 342 343 344 345
     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
346
     automatically, it is user's responsibility to supply well designed
347 348 349 350 351
     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
352 353 354
     `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.
355 356 357

     We also have to consider the fact that the concept of `baseline'
     differs among scripts to which each character belongs.  For
358
     instance, baseline should be at the bottom-most position of all
359
     glyphs for Chinese, Japanese, and Korean.  But, many of existing
360
     fonts for those characters don't have correct `ascent' values
361 362 363 364 365 366 367 368 369
     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;

370
  /* Non-zero means a character should be composed at a position
371 372 373 374 375
     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
376
	height).  In this case, the character is drawn below the
377 378 379 380 381 382
	previous glyphs.

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

383
  /* Non-zero means an ascent value to be used for a character
384 385 386
     registered in char-table `use-default-ascent'.  */
  int default_ascent;

387 388 389
  /* 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
390 391 392 393
  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
394
     determine it.  */
395
  int repertory_charset;
Kenichi Handa's avatar
Kenichi Handa committed
396

397 398 399 400 401
#endif /* HAVE_WINDOW_SYSTEM */

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

402 403
  /* There are more members in this structure, but they are private
     to the font-driver.  */
Kenichi Handa's avatar
Kenichi Handa committed
404 405
};

406 407 408 409 410 411 412 413
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
414 415 416 417 418 419 420
struct font_metrics
{
  short lbearing, rbearing, width, ascent, descent;
};

struct font_bitmap
{
421
  int bits_per_pixel;
Kenichi Handa's avatar
Kenichi Handa committed
422 423 424 425 426 427 428 429 430 431 432
  int rows;
  int width;
  int pitch;
  unsigned char *buffer;
  int left;
  int top;
  int advance;
};

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

433
/* True iff X is one of font-spec, font-entity, and font-object.  */
434
#define FONTP(x) PSEUDOVECTORP (x, PVEC_FONT)
435
/* True iff X is font-spec.  */
Kenichi Handa's avatar
Kenichi Handa committed
436
#define FONT_SPEC_P(x)	\
437
  (FONTP (x) && (ASIZE (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_SPEC_MAX)
438
/* True iff X is font-entity.  */
Kenichi Handa's avatar
Kenichi Handa committed
439
#define FONT_ENTITY_P(x)	\
440
  (FONTP (x) && (ASIZE (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_ENTITY_MAX)
441
/* True iff X is font-object.  */
Kenichi Handa's avatar
Kenichi Handa committed
442
#define FONT_OBJECT_P(x)	\
443
  (FONTP (x) && (ASIZE (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_OBJECT_MAX)
Kenichi Handa's avatar
Kenichi Handa committed
444

445
/* True iff ENTITY can't be loaded.  */
Kenichi Handa's avatar
Kenichi Handa committed
446 447 448
#define FONT_ENTITY_NOT_LOADABLE(entity)	\
  EQ (AREF (entity, FONT_OBJLIST_INDEX), Qt)

449
/* Flag ENTITY not loadable.  */
Kenichi Handa's avatar
Kenichi Handa committed
450 451 452
#define FONT_ENTITY_SET_NOT_LOADABLE(entity)	\
  ASET (entity, FONT_OBJLIST_INDEX, Qt)

Kenichi Handa's avatar
Kenichi Handa committed
453 454 455 456

/* Check macros for various font-related objects.  */

#define CHECK_FONT(x)	\
457
  do { if (! FONTP (x)) wrong_type_argument (Qfont, x); } while (false)
Kenichi Handa's avatar
Kenichi Handa committed
458
#define CHECK_FONT_SPEC(x)	\
459 460
  do { if (! FONT_SPEC_P (x)) wrong_type_argument (Qfont_spec, x); } \
  while (false)
Kenichi Handa's avatar
Kenichi Handa committed
461
#define CHECK_FONT_ENTITY(x)	\
462 463
  do { if (! FONT_ENTITY_P (x)) wrong_type_argument (Qfont_entity, x); } \
  while (false)
Kenichi Handa's avatar
Kenichi Handa committed
464
#define CHECK_FONT_OBJECT(x)	\
465 466
  do { if (! FONT_OBJECT_P (x)) wrong_type_argument (Qfont_object, x); } \
  while (false)
Kenichi Handa's avatar
Kenichi Handa committed
467

468 469 470 471
#define CHECK_FONT_GET_OBJECT(x, font)	\
  do {					\
    CHECK_FONT_OBJECT (x);		\
    font = XFONT_OBJECT (x);		\
472
  } while (false)
Kenichi Handa's avatar
Kenichi Handa committed
473

474
#define XFONT_SPEC(p)	\
475
  (eassert (FONT_SPEC_P (p)), (struct font_spec *) XUNTAG (p, Lisp_Vectorlike))
476
#define XFONT_ENTITY(p)	\
477 478
  (eassert (FONT_ENTITY_P (p)), \
   (struct font_entity *) XUNTAG (p, Lisp_Vectorlike))
479
#define XFONT_OBJECT(p)	\
480
  (eassert (FONT_OBJECT_P (p)), (struct font *) XUNTAG (p, Lisp_Vectorlike))
481 482 483 484 485 486 487 488 489
#define XSETFONT(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FONT))

/* 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)

490
/* Return a point size corresponding to POINT size (integer)
491 492
   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
493 494
   is tenths of points (as in xfld specs), then the pixel size should
   be multiplied BEFORE the conversion to avoid magnifying the error.  */
495 496
#define PIXEL_TO_POINT(PIXEL, DPI) ((PIXEL) * PT_PER_INCH / (DPI) + 0.5)

497 498 499 500
/* 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
501 502
#define FONT_INVALID_CODE 0xFFFFFFFF

503 504
/* Font driver.  Members specified as "optional" can be NULL.  */

Kenichi Handa's avatar
Kenichi Handa committed
505 506 507 508 509
struct font_driver
{
  /* Symbol indicating the type of the font-driver.  */
  Lisp_Object type;

510
  /* True iff the font's foundry, family, and adstyle names are case
Paul Eggert's avatar
Paul Eggert committed
511
     sensitive.  */
512
  bool case_sensitive;
513

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

518
  /* List fonts exactly matching with FONT_SPEC on FRAME.  The value
Kenichi Handa's avatar
Kenichi Handa committed
519
     is a list of font-entities.  The font properties to be considered
520
     are: :foundry, :family, :adstyle, :registry, :script, :lang, and
Kenichi Handa's avatar
Kenichi Handa committed
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
     :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.

     The `open' method of the same font-backend is called with one of
     the returned font-entities.  If the backend needs additional
     information to be used in `open' method, this method can add any
     Lispy value by the property :font-entity to the entities.

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

541
  /* Return a font-entity most closely matching with FONT_SPEC on
Kenichi Handa's avatar
Kenichi Handa committed
542
     FRAME.  Which font property to consider, and how to calculate the
543
     closeness is determined by the font backend, thus
Kenichi Handa's avatar
Kenichi Handa committed
544 545 546 547
     `face-font-selection-order' is ignored here.

     The properties that the font-entity has is the same as `list'
     method.  */
548
  Lisp_Object (*match) (struct frame *f, Lisp_Object spec);
549

550 551 552
  /* Optional.
     List available families.  The value is a list of family names
     (symbols).  */
553
  Lisp_Object (*list_family) (struct frame *f);
Kenichi Handa's avatar
Kenichi Handa committed
554

555 556
  /* Optional (if FONT_EXTRA_INDEX is not Lisp_Save_Value).
     Free FONT_EXTRA_INDEX field of FONT_ENTITY.  */
Jan D's avatar
Jan D committed
557
  void (*free_entity) (Lisp_Object font_entity);
Kenichi Handa's avatar
Kenichi Handa committed
558 559 560

  /* Open a font specified by FONT_ENTITY on frame F.  If the font is
     scalable, open it with PIXEL_SIZE.  */
Dmitry Antipov's avatar
Dmitry Antipov committed
561
  Lisp_Object (*open) (struct frame *f, Lisp_Object font_entity,
Jan D's avatar
Jan D committed
562
                       int pixel_size);
Kenichi Handa's avatar
Kenichi Handa committed
563

564
  /* Close FONT.  NOTE: this can be called by GC.  */
565
  void (*close) (struct font *font);
Kenichi Handa's avatar
Kenichi Handa committed
566

567 568 569 570
  /* Optional (if FACE->extra is not used).
     Prepare FACE for displaying characters by FONT on frame F by
     storing some data in FACE->extra.  If successful, return 0.
     Otherwise, return -1.  */
Dmitry Antipov's avatar
Dmitry Antipov committed
571
  int (*prepare_face) (struct frame *f, struct face *face);
Kenichi Handa's avatar
Kenichi Handa committed
572

573 574
  /* Optional.
     Done FACE for displaying characters by FACE->font on frame F.  */
Dmitry Antipov's avatar
Dmitry Antipov committed
575
  void (*done_face) (struct frame *f, struct face *face);
Kenichi Handa's avatar
Kenichi Handa committed
576

577
  /* Optional.
578 579 580
     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
581
  int (*has_char) (Lisp_Object font, int c);
Kenichi Handa's avatar
Kenichi Handa committed
582

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

587
  /* Compute the total metrics of the NGLYPHS glyphs specified by
588 589
     the font FONT and the sequence of glyph codes CODE, and store the
     result in METRICS.  */
Jan D's avatar
Jan D committed
590 591 592
  int (*text_extents) (struct font *font,
                       unsigned *code, int nglyphs,
                       struct font_metrics *metrics);
Kenichi Handa's avatar
Kenichi Handa committed
593

594 595
#ifdef HAVE_WINDOW_SYSTEM

596 597
  /* Optional.
     Draw glyphs between FROM and TO of S->char2b at (X Y) pixel
598 599 600
     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
601
  int (*draw) (struct glyph_string *s, int from, int to,
602
               int x, int y, bool with_background);
Kenichi Handa's avatar
Kenichi Handa committed
603

604 605
  /* Optional.
     Store bitmap data for glyph-code CODE of FONT in BITMAP.  It is
Paul Eggert's avatar
Paul Eggert committed
606
     intended that this method is called from the other font-driver
607
     for actual drawing.  */
Jan D's avatar
Jan D committed
608 609 610
  int (*get_bitmap) (struct font *font, unsigned code,
                     struct font_bitmap *bitmap,
                     int bits_per_pixel);
Kenichi Handa's avatar
Kenichi Handa committed
611

612 613
  /* Optional.
     Free bitmap data in BITMAP.  */
Jan D's avatar
Jan D committed
614
  void (*free_bitmap) (struct font *font, struct font_bitmap *bitmap);
Kenichi Handa's avatar
Kenichi Handa committed
615

616 617
#endif /* HAVE_WINDOW_SYSTEM */

618 619 620
  /* Optional.
     Return an outline data for glyph-code CODE of FONT.  The format
     of the outline data depends on the font-driver.  */
Jan D's avatar
Jan D committed
621
  void *(*get_outline) (struct font *font, unsigned code);
Kenichi Handa's avatar
Kenichi Handa committed
622

623 624
  /* Optional.
     Free OUTLINE (that is obtained by the above method).  */
Jan D's avatar
Jan D committed
625
  void (*free_outline) (struct font *font, void *outline);
Kenichi Handa's avatar
Kenichi Handa committed
626

627 628
  /* Optional.
     Get coordinates of the INDEXth anchor point of the glyph whose
Kenichi Handa's avatar
Kenichi Handa committed
629
     code is CODE.  Store the coordinates in *X and *Y.  Return 0 if
Paul Eggert's avatar
Paul Eggert committed
630
     the operations was successful.  Otherwise return -1.  */
Jan D's avatar
Jan D committed
631 632
  int (*anchor_point) (struct font *font, unsigned code, int index,
                       int *x, int *y);
Kenichi Handa's avatar
Kenichi Handa committed
633

634 635
  /* Optional.
     Return a list describing which scripts/languages FONT
Kenichi Handa's avatar
Kenichi Handa committed
636
     supports by which GSUB/GPOS features of OpenType tables.  */
Jan D's avatar
Jan D committed
637
  Lisp_Object (*otf_capability) (struct font *font);
Kenichi Handa's avatar
Kenichi Handa committed
638

639
  /* Optional.
Kenichi Handa's avatar
Kenichi Handa committed
640 641 642 643
     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)
644
     See the documentation of `font-drive-otf' for the details.
Kenichi Handa's avatar
Kenichi Handa committed
645 646 647 648 649 650 651 652 653

     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
     short, return -1.  */
Jan D's avatar
Jan D committed
654 655
  int (*otf_drive) (struct font *font, Lisp_Object features,
                    Lisp_Object gstring_in, int from, int to,
656
                    Lisp_Object gstring_out, int idx, bool alternate_subst);
657 658 659

  /* Optional.
     Make the font driver ready for frame F.  Usually this function
660
     makes some data specific to F and stores it in F by calling
661
     font_put_frame_data ().  */
Dmitry Antipov's avatar
Dmitry Antipov committed
662
  int (*start_for_frame) (struct frame *f);
Juanma Barranquero's avatar
Juanma Barranquero committed
663

664 665 666
  /* Optional.
     End using the driver for frame F.  Usually this function free
     some data stored for F.  */
Dmitry Antipov's avatar
Dmitry Antipov committed
667
  int (*end_for_frame) (struct frame *f);
Kenichi Handa's avatar
Kenichi Handa committed
668 669

  /* Optional.
670

671 672 673 674 675
     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.
676 677 678

     This function updates all fields of the input glyphs.  If the
     output glyphs (M) are more than the input glyphs (N), (N+1)th
679 680 681 682
     through (M)th elements of GSTRING are updated possibly by making
     a new glyph object and storing it in GSTRING.  If (M) is greater
     than the length of GSTRING, nil should be return.  In that case,
     this function is called again with the larger GSTRING.  */
Jan D's avatar
Jan D committed
683
  Lisp_Object (*shape) (Lisp_Object lgstring);
684 685 686 687

  /* Optional.

     If FONT is usable on frame F, return 0.  Otherwise return -1.
688 689
     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
690
  int (*check) (struct frame *f, struct font *font);
691 692 693 694 695 696 697

  /* 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
698 699
  int (*get_variation_glyphs) (struct font *font,
                               int c, unsigned variations[256]);
700

Jan D's avatar
Jan D committed
701
  void (*filter_properties) (Lisp_Object font, Lisp_Object properties);
702 703 704 705 706

  /* Optional.

     Return non-zero if FONT_OBJECT can be used as a (cached) font
     for ENTITY on frame F.  */
707 708 709
  bool (*cached_font_ok) (struct frame *f,
                          Lisp_Object font_object,
                          Lisp_Object entity);
Kenichi Handa's avatar
Kenichi Handa committed
710 711 712
};


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

Kenichi Handa's avatar
Kenichi Handa committed
717 718
struct font_driver_list
{
719
  /* True iff this driver is currently used.  It is ignored in the global
720
     font driver list.*/
721
  bool on;
722
  /* Pointer to the font driver.  */
Kenichi Handa's avatar
Kenichi Handa committed
723
  struct font_driver *driver;
724
  /* Pointer to the next element of the chain.  */
Kenichi Handa's avatar
Kenichi Handa committed
725 726 727
  struct font_driver_list *next;
};

728

Dmitry Antipov's avatar
Dmitry Antipov committed
729 730
/* Chain of arbitrary data specific to each font driver.
   Each frame has its own font data list at F->font_data_list.  */
731 732 733 734 735 736 737 738 739 740 741

struct font_data_list
{
  /* Pointer to the font driver.  */
  struct font_driver *driver;
  /* Data specific to the font driver.  */
  void *data;
  /* Pointer to the next element of the chain.  */
  struct font_data_list *next;
};

742 743
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
744

Jan D's avatar
Jan D committed
745 746 747 748 749 750 751
extern Lisp_Object font_make_entity (void);
extern Lisp_Object font_make_object (int, Lisp_Object, int);

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,
752
                                Lisp_Object name, bool noerror);
Jan D's avatar
Jan D committed
753 754
extern Lisp_Object font_style_symbolic (Lisp_Object font,
                                        enum font_property_index prop,
755
                                        bool for_face);
Jan D's avatar
Jan D committed
756

757
extern bool font_match_p (Lisp_Object spec, Lisp_Object font);
758
extern Lisp_Object font_list_entities (struct frame *, Lisp_Object);
Jan D's avatar
Jan D committed
759 760 761 762

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
763
extern int font_has_char (struct frame *, Lisp_Object, int);
Jan D's avatar
Jan D committed
764 765 766

extern void font_clear_prop (Lisp_Object *attrs,
                             enum font_property_index prop);
Dmitry Antipov's avatar
Dmitry Antipov committed
767
extern Lisp_Object font_find_for_lface (struct frame *f, Lisp_Object *lface,
Jan D's avatar
Jan D committed
768
                                        Lisp_Object spec, int c);
Dmitry Antipov's avatar
Dmitry Antipov committed
769
extern Lisp_Object font_open_for_lface (struct frame *f, Lisp_Object entity,
Jan D's avatar
Jan D committed
770 771
                                        Lisp_Object *lface,
                                        Lisp_Object spec);
Dmitry Antipov's avatar
Dmitry Antipov committed
772
extern Lisp_Object font_load_for_lface (struct frame *f, Lisp_Object *lface,
Jan D's avatar
Jan D committed
773
                                        Lisp_Object spec);
Dmitry Antipov's avatar
Dmitry Antipov committed
774 775
extern void font_prepare_for_face (struct frame *f, struct face *face);
extern void font_done_for_face (struct frame *f, struct face *face);
776
extern void clear_font_cache (struct frame *);
Jan D's avatar
Jan D committed
777

Dmitry Antipov's avatar
Dmitry Antipov committed
778 779
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
780

781
extern Lisp_Object font_intern_prop (const char *str, ptrdiff_t len,
782
				     bool force_symbol);
Jan D's avatar
Jan D committed
783 784 785 786 787 788
extern void font_update_sort_order (int *order);

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

789
extern int font_parse_xlfd (char *name, ptrdiff_t len, Lisp_Object font);
790 791
extern ptrdiff_t font_unparse_xlfd (Lisp_Object font, int pixel_size,
				    char *name, int bytes);
Jan D's avatar
Jan D committed
792
extern int font_unparse_fcname (Lisp_Object font, int pixel_size,
Dan Nicolaescu's avatar
Dan Nicolaescu committed
793
                                char *name, int bytes);
Dmitry Antipov's avatar
Dmitry Antipov committed
794 795
extern void register_font_driver (struct font_driver *driver, struct frame *f);
extern void free_font_driver_list (struct frame *f);
796 797
#ifdef ENABLE_CHECKING
extern bool valid_font_driver (struct font_driver *);
798 799 800 801 802 803
#else
INLINE bool
valid_font_driver (struct font_driver *d)
{
  return true;
}
804
#endif
Dmitry Antipov's avatar
Dmitry Antipov committed
805
extern Lisp_Object font_update_drivers (struct frame *f, Lisp_Object list);
806
extern Lisp_Object font_range (ptrdiff_t, ptrdiff_t, ptrdiff_t *,
Stefan Monnier's avatar
Stefan Monnier committed
807 808
			       struct window *, struct face *,
			       Lisp_Object);
Jan D's avatar
Jan D committed
809
extern void font_fill_lglyph_metrics (Lisp_Object, Lisp_Object);
Kenichi Handa's avatar
Kenichi Handa committed
810

Jan D's avatar
Jan D committed
811 812
extern Lisp_Object font_put_extra (Lisp_Object font, Lisp_Object prop,
                                   Lisp_Object val);
Kenichi Handa's avatar
Kenichi Handa committed
813

Dmitry Antipov's avatar
Dmitry Antipov committed
814
extern int font_put_frame_data (struct frame *f,
Jan D's avatar
Jan D committed
815 816
                                struct font_driver *driver,
                                void *data);
Dmitry Antipov's avatar
Dmitry Antipov committed
817
extern void *font_get_frame_data (struct frame *f,
Jan D's avatar
Jan D committed
818
                                  struct font_driver *driver);
819

820 821
extern void font_filter_properties (Lisp_Object font,
				    Lisp_Object alist,
822 823
				    const char *const boolean_properties[],
				    const char *const non_boolean_properties[]);
824

Kenichi Handa's avatar
Kenichi Handa committed
825 826
#ifdef HAVE_FREETYPE
extern struct font_driver ftfont_driver;
827
extern void syms_of_ftfont (void);
Kenichi Handa's avatar
Kenichi Handa committed
828 829 830
#endif	/* HAVE_FREETYPE */
#ifdef HAVE_X_WINDOWS
extern struct font_driver xfont_driver;
831 832
extern void syms_of_xfont (void);
extern void syms_of_ftxfont (void);
Kenichi Handa's avatar
Kenichi Handa committed
833
#ifdef HAVE_XFT
Paul Eggert's avatar
Paul Eggert committed
834
extern Lisp_Object Qxft;
Kenichi Handa's avatar
Kenichi Handa committed
835
extern struct font_driver xftfont_driver;
836
extern void syms_of_xftfont (void);
837 838
#endif
#if defined HAVE_FREETYPE || defined HAVE_XFT
839 840
extern struct font_driver ftxfont_driver;
#endif
841 842 843
#ifdef HAVE_BDFFONT
extern void syms_of_bdffont (void);
#endif	/* HAVE_BDFFONT */
Kenichi Handa's avatar
Kenichi Handa committed
844
#endif	/* HAVE_X_WINDOWS */
Daniel Colascione's avatar
Daniel Colascione committed
845
#ifdef HAVE_NTGUI
Kenichi Handa's avatar
Kenichi Handa committed
846
extern struct font_driver w32font_driver;
847
extern struct font_driver uniscribe_font_driver;
848
extern void syms_of_w32font (void);
Daniel Colascione's avatar
Daniel Colascione committed
849
#endif	/* HAVE_NTGUI */
850
#ifdef HAVE_NS
851
extern Lisp_Object Qfontsize;
852
extern struct font_driver nsfont_driver;
853
extern void syms_of_nsfont (void);
854
extern void syms_of_macfont (void);
855
#endif	/* HAVE_NS */
Kenichi Handa's avatar
Kenichi Handa committed
856

857 858 859 860
#ifndef FONT_DEBUG
#define FONT_DEBUG
#endif

Andreas Schwab's avatar
Andreas Schwab committed
861
extern Lisp_Object QCfoundry;
862

863 864
extern void font_add_log (const char *, Lisp_Object, Lisp_Object);
extern void font_deferred_log (const char *, Lisp_Object, Lisp_Object);
865

Kenichi Handa's avatar
Kenichi Handa committed
866 867 868 869
#define FONT_ADD_LOG(ACTION, ARG, RESULT)	\
  do {						\
    if (! EQ (Vfont_log, Qt))			\
      font_add_log ((ACTION), (ARG), (RESULT));	\
870
  } while (false)
Kenichi Handa's avatar
Kenichi Handa committed
871 872 873 874 875

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

878 879
INLINE_HEADER_END

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