font.h 32 KB
Newer Older
Kenichi Handa's avatar
Kenichi Handa committed
1
/* font.h -- Interface definition for font handling.
Glenn Morris's avatar
Glenn Morris committed
2 3
   Copyright (C) 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   Copyright (C) 2006, 2007, 2008, 2009, 2010
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 26 27 28 29 30

#ifndef EMACS_FONT_H
#define EMACS_FONT_H

#include "ccl.h"

/* We have three types of Lisp objects related to font.

   FONT-SPEC

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

   FONT-ENTITY

39 40
	Pseudo vector (length FONT_ENTITY_MAX) of fully instanciated
	font properties that a font-driver returns upon a request of
Kenichi Handa's avatar
Kenichi Handa committed
41 42
	FONT-SPEC.

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

   FONT-OBJECT

48
	Pseudo vector (length FONT_OBJECT_MAX) of a opend font.
Kenichi Handa's avatar
Kenichi Handa committed
49

50 51 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
	object, and should never be modified by Lisp.  */

extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
Kenichi Handa's avatar
Kenichi Handa committed
57 58 59 60


struct font_driver;
struct font;
61
struct glyph_string;
Kenichi Handa's avatar
Kenichi Handa committed
62 63 64 65 66 67 68 69 70

/* 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',
Juanma Barranquero's avatar
Juanma Barranquero committed
71 72
       `xft', `ftx' are available on X, `uniscribe' and `gdi' on
       Windows, and `ns' under Cocoa / GNUstep.  */
Kenichi Handa's avatar
Kenichi Handa committed
73 74 75 76 77 78 79 80 81 82 83 84
    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
85
       charset-encoding name (symbol).  */
Kenichi Handa's avatar
Kenichi Handa committed
86 87 88
    FONT_REGISTRY_INDEX,

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

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

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

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

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
    /* 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,

#if 0
    /* 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
       8-bit is an indice to the weight table AREF (font_style_table,
       0), the next 8-bit is an indice to the slant table AREF
       (font_style_table, 1), the highest 8-bit is an indice to the
       slant table AREF (font_style_table, 2).  The indice 0 indicates
       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
       properties DPI, AVGWIDTH, SPACING.  The lowest 12-bit is for
       DPI, the next 12-bit is for AVGWIDTH, the highest 3-bit is for
       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
152 153
    /* In a font-spec, the value is an alist of extra information of a
       font such as name, OpenType features, and language coverage.
154
       In addition, in a font-entity, the value may contain a pair
Adrian Robert's avatar
Adrian Robert committed
155
       (font-entity . INFO) where INFO is extra information to identify
Kenichi Handa's avatar
Kenichi Handa committed
156
       a font (font-driver dependent).  */
Kenichi Handa's avatar
Kenichi Handa committed
157 158 159 160 161 162 163
    FONT_EXTRA_INDEX,		/* alist		alist */

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

    /* The followings are used only for a font-entity.  */

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

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

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

173 174 175 176 177 178 179 180 181
    /* Full name of the font (string).  It is the name extracted from
       the opend font, and may be different from the above.  It may be
       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
182
    /* Format of the font (symbol) or nil if unknown.  */
183 184 185 186
    FONT_FORMAT_INDEX,

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

189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 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 235 236 237
/* 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)	\
  font_style_symbolic (font, FONT_WEIGHT_INDEX, 0)
/* Return the symbolic slant value of FONT.  */
#define FONT_SLANT_SYMBOLIC(font)	\
  font_style_symbolic (font, FONT_SLANT_INDEX, 0)
/* Return the symbolic width value of FONT.  */
#define FONT_WIDTH_SYMBOLIC(font)	\
  font_style_symbolic (font, FONT_WIDTH_INDEX, 0)
/* Return the face-weight corresponding to the weight of FONT.  */
#define FONT_WEIGHT_FOR_FACE(font)	\
  font_style_symbolic (font, FONT_WEIGHT_INDEX, 1)
/* Return the face-slant corresponding to the slant of FONT.  */
#define FONT_SLANT_FOR_FACE(font)	\
  font_style_symbolic (font, FONT_SLANT_INDEX, 1)
/* Return the face-swidth corresponding to the slant of FONT.  */
#define FONT_WIDTH_FOR_FACE(font)	\
  font_style_symbolic (font, FONT_WIDTH_INDEX, 1)

/* Return the numeric weight value corresponding ot the symbol NAME.  */
#define FONT_WEIGHT_NAME_NUMERIC(name)	\
  (font_style_to_value (FONT_WEIGHT_INDEX, (name), 0) >> 8)
/* Return the numeric slant value corresponding ot the symbol NAME.  */
#define FONT_SLANT_NAME_NUMERIC(name)	\
  (font_style_to_value (FONT_SLANT_INDEX, (name), 0) >> 8)
/* Return the numeric width value corresponding ot the symbol NAME.  */
#define FONT_WIDTH_NAME_NUMERIC(name)	\
  (font_style_to_value (FONT_WIDTH_INDEX, (name), 0) >> 8)

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

extern Lisp_Object QCspacing, QCdpi, QCscalable, QCotf, QClang, QCscript;
extern Lisp_Object QCavgwidth, QCfont_entity, QCfc_unknown_spec;
Kenichi Handa's avatar
Kenichi Handa committed
238

239
/* Important character set symbols.  */
Kenichi Handa's avatar
Kenichi Handa committed
240
extern Lisp_Object Qascii_0;
Kenichi Handa's avatar
Kenichi Handa committed
241
extern Lisp_Object Qiso8859_1, Qiso10646_1, Qunicode_bmp, Qunicode_sip;
242

243 244 245
/* Special ADSTYLE properties to avoid fonts used for Latin characters.  */
extern Lisp_Object Qja, Qko;

246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
/* Structure for a font-spec.  */

struct font_spec
{
  EMACS_UINT size;
  struct Lisp_Vector *next;
  Lisp_Object props[FONT_SPEC_MAX];
};

/* Structure for a font-entity.  */

struct font_entity
{
  EMACS_UINT size;
  struct Lisp_Vector *next;
  Lisp_Object props[FONT_ENTITY_MAX];
};
Kenichi Handa's avatar
Kenichi Handa committed
263

264 265 266 267 268 269
/* 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
270 271 272

struct font
{
273 274 275 276 277
  EMACS_UINT size;
  struct Lisp_Vector *next;

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

279 280 281 282 283 284 285
  Lisp_Object props[FONT_OBJECT_MAX];

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

  /* Maximum bound width over all existing characters of the font.  On
     X window, this is same as (font->max_bounds.width).  */
  int max_width;
Kenichi Handa's avatar
Kenichi Handa committed
286 287 288 289

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

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
  /* 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
     have that information but has glyphs of ASCII character, the
     value is the average with of those glyphs.  Otherwise, the value
     is 0.  */
  int average_width;

  /* Minimum glyph width (in pixels).  */
  int min_width;
Kenichi Handa's avatar
Kenichi Handa committed
306

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

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
  /* 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;

  /* 1 if `vertical-centering-font-regexp' matches this font name.
     In this case, we render characters at vartical center positions
     of lines.  */
  int vertical_centering;

  /* Encoding type of the font.  The value is one of
     0, 1, 2, or 3:
	0: code points 0x20..0x7F or 0x2020..0x7F7F are used
	1: code points 0xA0..0xFF or 0xA0A0..0xFFFF are used
	2: code points 0x20A0..0x7FFF are used
	3: code points 0xA020..0xFF7F are used
     If the member `font_encoder' is not NULL, this member is ignored.  */
  unsigned char encoding_type;

  /* The baseline position of a font is normally `ascent' value of the
     font.  However, there exists many fonts which don't set `ascent'
     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
     automatically, it is users responsibility to supply well designed
     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
     `ascent'.  In other words, the value indicates how many bits
     higher we should draw a character of the font than normal ASCII
     text for a better looking.

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

  /* Non zero means a character should be composed at a position
     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
	height).  In this case, the character is drawn beneath the
	previous glyphs.

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

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

  /* CCL program to calculate code points of the font.  */
  struct ccl_program *font_encoder;

  /* Font-driver for the font.  */
  struct font_driver *driver;
Kenichi Handa's avatar
Kenichi Handa committed
386

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

  /* There will be more to this structure, but they are private to a
     font-driver.  */
};

401 402 403 404 405 406 407 408
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
409 410 411 412 413 414 415
struct font_metrics
{
  short lbearing, rbearing, width, ascent, descent;
};

struct font_bitmap
{
416
  int bits_per_pixel;
Kenichi Handa's avatar
Kenichi Handa committed
417 418 419 420 421 422 423 424 425 426 427 428
  int rows;
  int width;
  int pitch;
  unsigned char *buffer;
  int left;
  int top;
  int advance;
  void *extra;
};

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

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

441
/* 1 iff ENTITY can't be loaded.  */
Kenichi Handa's avatar
Kenichi Handa committed
442 443 444
#define FONT_ENTITY_NOT_LOADABLE(entity)	\
  EQ (AREF (entity, FONT_OBJLIST_INDEX), Qt)

445
/* Flag ENTITY not loadable.  */
Kenichi Handa's avatar
Kenichi Handa committed
446 447 448
#define FONT_ENTITY_SET_NOT_LOADABLE(entity)	\
  ASET (entity, FONT_OBJLIST_INDEX, Qt)

Kenichi Handa's avatar
Kenichi Handa committed
449 450 451 452

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

#define CHECK_FONT(x)	\
453
  do { if (! FONTP (x)) wrong_type_argument (Qfont, x); } while (0)
Kenichi Handa's avatar
Kenichi Handa committed
454
#define CHECK_FONT_SPEC(x)	\
455
  do { if (! FONT_SPEC_P (x)) wrong_type_argument (Qfont_spec, x); } while (0)
Kenichi Handa's avatar
Kenichi Handa committed
456
#define CHECK_FONT_ENTITY(x)	\
457
  do { if (! FONT_ENTITY_P (x)) wrong_type_argument (Qfont_entity, x); } while (0)
Kenichi Handa's avatar
Kenichi Handa committed
458
#define CHECK_FONT_OBJECT(x)	\
459
  do { if (! FONT_OBJECT_P (x)) wrong_type_argument (Qfont_object, x); } while (0)
Kenichi Handa's avatar
Kenichi Handa committed
460

461 462 463 464
#define CHECK_FONT_GET_OBJECT(x, font)	\
  do {					\
    CHECK_FONT_OBJECT (x);		\
    font = XFONT_OBJECT (x);		\
Kenichi Handa's avatar
Kenichi Handa committed
465 466
  } while (0)

467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
#define XFONT_SPEC(p)	\
  (eassert (FONT_SPEC_P(p)), (struct font_spec *) XPNTR (p))
#define XFONT_ENTITY(p)	\
  (eassert (FONT_ENTITY_P(p)), (struct font_entity *) XPNTR (p))
#define XFONT_OBJECT(p)	\
  (eassert (FONT_OBJECT_P(p)), (struct font *) XPNTR (p))
#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)

482 483 484 485 486
/* Return a point size corresponding to POINT size (integer)
   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
   is tenths of points (as in xfld specs), then the pixel size should
   be multiplied BEFORE the conversion to avoid magnifying the error.  */
487 488
#define PIXEL_TO_POINT(PIXEL, DPI) ((PIXEL) * PT_PER_INCH / (DPI) + 0.5)

489 490 491 492
/* 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
493 494 495 496
struct face;

#define FONT_INVALID_CODE 0xFFFFFFFF

497 498
/* Font driver.  Members specified as "optional" can be NULL.  */

Kenichi Handa's avatar
Kenichi Handa committed
499 500 501 502 503
struct font_driver
{
  /* Symbol indicating the type of the font-driver.  */
  Lisp_Object type;

Kenichi Handa's avatar
Kenichi Handa committed
504
  /* 1 iff the font's foundry, family, and adstyle names are case
505 506 507
     sensitve.  */
  int case_sensitive;

508
  /* Return a cache of font-entities on frame F.  The cache must be a
Kenichi Handa's avatar
Kenichi Handa committed
509
     cons whose cdr part is the actual cache area.  */
510
  Lisp_Object (*get_cache) P_ ((FRAME_PTR F));
Kenichi Handa's avatar
Kenichi Handa committed
511

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

531 532
     This and the following `match' are the only APIs that allocate
     font-entities.  */
Kenichi Handa's avatar
Kenichi Handa committed
533 534
  Lisp_Object (*list) P_ ((Lisp_Object frame, Lisp_Object font_spec));

535
  /* Return a font-entity most closely matching with FONT_SPEC on
Kenichi Handa's avatar
Kenichi Handa committed
536
     FRAME.  Which font property to consider, and how to calculate the
537
     closeness is determined by the font backend, thus
Kenichi Handa's avatar
Kenichi Handa committed
538 539 540 541
     `face-font-selection-order' is ignored here.

     The properties that the font-entity has is the same as `list'
     method.  */
542 543
  Lisp_Object (*match) P_ ((Lisp_Object frame, Lisp_Object font_spec));

544 545 546
  /* Optional.
     List available families.  The value is a list of family names
     (symbols).  */
Kenichi Handa's avatar
Kenichi Handa committed
547 548
  Lisp_Object (*list_family) P_ ((Lisp_Object frame));

549 550
  /* Optional (if FONT_EXTRA_INDEX is not Lisp_Save_Value).
     Free FONT_EXTRA_INDEX field of FONT_ENTITY.  */
Kenichi Handa's avatar
Kenichi Handa committed
551 552 553 554
  void (*free_entity) P_ ((Lisp_Object font_entity));

  /* Open a font specified by FONT_ENTITY on frame F.  If the font is
     scalable, open it with PIXEL_SIZE.  */
555 556
  Lisp_Object (*open) P_ ((FRAME_PTR f, Lisp_Object font_entity,
			   int pixel_size));
Kenichi Handa's avatar
Kenichi Handa committed
557 558 559 560

  /* Close FONT on frame F.  */
  void (*close) P_ ((FRAME_PTR f, struct font *font));

561 562 563 564
  /* 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.  */
Kenichi Handa's avatar
Kenichi Handa committed
565 566
  int (*prepare_face) P_ ((FRAME_PTR f, struct face *face));

567 568
  /* Optional.
     Done FACE for displaying characters by FACE->font on frame F.  */
Kenichi Handa's avatar
Kenichi Handa committed
569 570
  void (*done_face) P_ ((FRAME_PTR f, struct face *face));

571
  /* Optional.
572 573 574 575
     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.  */
  int (*has_char) P_ ((Lisp_Object font, int c));
Kenichi Handa's avatar
Kenichi Handa committed
576

577
  /* Return a glyph code of FONT for character C (Unicode code point).
578
     If FONT doesn't have such a glyph, return FONT_INVALID_CODE.  */
Kenichi Handa's avatar
Kenichi Handa committed
579 580
  unsigned (*encode_char) P_ ((struct font *font, int c));

581 582 583
  /* Computate the total metrics of the NGLYPHS glyphs specified by
     the font FONT and the sequence of glyph codes CODE, and store the
     result in METRICS.  */
Kenichi Handa's avatar
Kenichi Handa committed
584 585 586 587
  int (*text_extents) P_ ((struct font *font,
			   unsigned *code, int nglyphs,
			   struct font_metrics *metrics));

588 589
  /* Optional.
     Draw glyphs between FROM and TO of S->char2b at (X Y) pixel
Kenichi Handa's avatar
Kenichi Handa committed
590 591 592 593 594 595
     position of frame F with S->FACE and S->GC.  If WITH_BACKGROUND
     is nonzero, fill the background in advance.  It is assured that
     WITH_BACKGROUND is zero when (FROM > 0 || TO < S->nchars).  */
  int (*draw) P_ ((struct glyph_string *s, int from, int to,
		   int x, int y, int with_background));

596 597 598 599
  /* Optional.
     Store bitmap data for glyph-code CODE of FONT in BITMAP.  It is
     intended that this method is callled from the other font-driver
     for actual drawing.  */
Kenichi Handa's avatar
Kenichi Handa committed
600 601 602 603
  int (*get_bitmap) P_ ((struct font *font, unsigned code,
			 struct font_bitmap *bitmap,
			 int bits_per_pixel));

604 605
  /* Optional.
     Free bitmap data in BITMAP.  */
Kenichi Handa's avatar
Kenichi Handa committed
606 607
  void (*free_bitmap) P_ ((struct font *font, struct font_bitmap *bitmap));

608 609 610
  /* Optional.
     Return an outline data for glyph-code CODE of FONT.  The format
     of the outline data depends on the font-driver.  */
Kenichi Handa's avatar
Kenichi Handa committed
611 612
  void *(*get_outline) P_ ((struct font *font, unsigned code));

613 614
  /* Optional.
     Free OUTLINE (that is obtained by the above method).  */
Kenichi Handa's avatar
Kenichi Handa committed
615 616
  void (*free_outline) P_ ((struct font *font, void *outline));

617 618
  /* Optional.
     Get coordinates of the INDEXth anchor point of the glyph whose
Kenichi Handa's avatar
Kenichi Handa committed
619
     code is CODE.  Store the coordinates in *X and *Y.  Return 0 if
620
     the operations was successfull.  Otherwise return -1.  */
Kenichi Handa's avatar
Kenichi Handa committed
621 622 623
  int (*anchor_point) P_ ((struct font *font, unsigned code, int index,
			   int *x, int *y));

624 625
  /* Optional.
     Return a list describing which scripts/languages FONT
Kenichi Handa's avatar
Kenichi Handa committed
626 627 628
     supports by which GSUB/GPOS features of OpenType tables.  */
  Lisp_Object (*otf_capability) P_ ((struct font *font));

629
  /* Optional.
Kenichi Handa's avatar
Kenichi Handa committed
630 631 632 633 634
     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)
     See the documentation of `font-drive-otf' for the detail.
Kenichi Handa's avatar
Kenichi Handa committed
635 636 637 638 639 640 641 642 643

     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.  */
Kenichi Handa's avatar
Kenichi Handa committed
644
  int (*otf_drive) P_ ((struct font *font, Lisp_Object features,
Kenichi Handa's avatar
Kenichi Handa committed
645
		       Lisp_Object gstring_in, int from, int to,
646
		       Lisp_Object gstring_out, int idx, int alternate_subst));
647 648 649

  /* Optional.
     Make the font driver ready for frame F.  Usually this function
650
     makes some data specific to F and stores it in F by calling
651 652
     font_put_frame_data ().  */
  int (*start_for_frame) P_ ((FRAME_PTR f));
Juanma Barranquero's avatar
Juanma Barranquero committed
653

654 655 656 657
  /* Optional.
     End using the driver for frame F.  Usually this function free
     some data stored for F.  */
  int (*end_for_frame) P_ ((FRAME_PTR f));
Kenichi Handa's avatar
Kenichi Handa committed
658 659

  /* Optional.
660

661 662 663 664 665
     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.
666 667 668

     This function updates all fields of the input glyphs.  If the
     output glyphs (M) are more than the input glyphs (N), (N+1)th
669 670 671 672
     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.  */
Kenichi Handa's avatar
Kenichi Handa committed
673
  Lisp_Object (*shape) P_ ((Lisp_Object lgstring));
674 675 676 677

  /* Optional.

     If FONT is usable on frame F, return 0.  Otherwise return -1.
678 679
     This method is used only for debugging.  If this method is NULL,
     Emacs assumes that the font is usable on any frame.  */
680
  int (*check) P_ ((FRAME_PTR F, struct font *font));
681 682 683 684 685 686 687 688 689

  /* 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.  */
  int (*get_variation_glyphs) P_ ((struct font *font,
				   int c, unsigned variations[256]));
690 691

  void (*filter_properties) P_ ((Lisp_Object font, Lisp_Object properties));
692 693 694 695 696 697 698 699

  /* Optional.

     Return non-zero if FONT_OBJECT can be used as a (cached) font
     for ENTITY on frame F.  */
  int (*cached_font_ok) P_ ((struct frame *f,
                             Lisp_Object font_object,
                             Lisp_Object entity));
Kenichi Handa's avatar
Kenichi Handa committed
700 701 702
};


703 704 705 706
/* Chain of font drivers.  There's one global font driver list
   (font_driver_list in font.c).  In addition, each frame has it's own
   font driver list at FRAME_PTR->font_driver_list.  */

Kenichi Handa's avatar
Kenichi Handa committed
707 708
struct font_driver_list
{
709 710
  /* 1 iff this driver is currently used.  It is igonred in the global
     font driver list.*/
Kenichi Handa's avatar
Kenichi Handa committed
711
  int on;
712
  /* Pointer to the font driver.  */
Kenichi Handa's avatar
Kenichi Handa committed
713
  struct font_driver *driver;
714
  /* Pointer to the next element of the chain.  */
Kenichi Handa's avatar
Kenichi Handa committed
715 716 717
  struct font_driver_list *next;
};

718 719 720 721 722 723 724 725 726 727 728 729 730 731

/* Chain of arbitrary data specific to each font driver.  Each frame
   has it's own font data list at FRAME_PTR->font_data_list.  */

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;
};

Kenichi Handa's avatar
Kenichi Handa committed
732
EXFUN (Ffont_spec, MANY);
733 734
EXFUN (Fcopy_font_spec, 1);
EXFUN (Fmerge_font_spec, 2);
Kenichi Handa's avatar
Kenichi Handa committed
735
EXFUN (Ffont_get, 2);
736
EXFUN (Ffont_put, 3);
Kenichi Handa's avatar
Kenichi Handa committed
737
EXFUN (Flist_fonts, 4);
738
EXFUN (Ffont_family_list, 1);
Kenichi Handa's avatar
Kenichi Handa committed
739
EXFUN (Fclear_font_cache, 0);
740
EXFUN (Ffont_xlfd_name, 2);
Kenichi Handa's avatar
Kenichi Handa committed
741

742 743
extern Lisp_Object font_make_spec P_ ((void));
extern Lisp_Object font_make_entity P_ ((void));
744
extern Lisp_Object font_make_object P_ ((int, Lisp_Object, int));
745

746
extern Lisp_Object find_font_encoding P_ ((Lisp_Object));
Kenichi Handa's avatar
Kenichi Handa committed
747 748
extern int font_registry_charsets P_ ((Lisp_Object, struct charset **,
				       struct charset **));
749 750 751 752 753
extern int font_style_to_value P_ ((enum font_property_index prop,
				    Lisp_Object name, int noerror));
extern Lisp_Object font_style_symbolic P_ ((Lisp_Object font,
					    enum font_property_index prop,
					    int for_face));
Juanma Barranquero's avatar
Juanma Barranquero committed
754

755
extern int font_match_p P_ ((Lisp_Object spec, Lisp_Object font));
756 757
extern Lisp_Object font_list_entities P_ ((Lisp_Object frame,
					   Lisp_Object spec));
758 759

extern Lisp_Object font_get_name P_ ((Lisp_Object font_object));
760
extern Lisp_Object font_spec_from_name P_ ((Lisp_Object font_name));
761
extern Lisp_Object font_get_frame P_ ((Lisp_Object font_object));
Kenichi Handa's avatar
Kenichi Handa committed
762 763 764
extern int font_has_char P_ ((FRAME_PTR, Lisp_Object, int));
extern unsigned font_encode_char P_ ((Lisp_Object, int));

765 766 767
extern void font_clear_prop P_ ((Lisp_Object *attrs,
				 enum font_property_index prop));
extern void font_update_lface P_ ((FRAME_PTR f, Lisp_Object *attrs));
Kenichi Handa's avatar
Kenichi Handa committed
768
extern Lisp_Object font_find_for_lface P_ ((FRAME_PTR f, Lisp_Object *lface,
Kenichi Handa's avatar
Kenichi Handa committed
769
					    Lisp_Object spec, int c));
Kenichi Handa's avatar
Kenichi Handa committed
770 771 772
extern Lisp_Object font_open_for_lface P_ ((FRAME_PTR f, Lisp_Object entity,
					    Lisp_Object *lface,
					    Lisp_Object spec));
773 774
extern Lisp_Object font_load_for_lface P_ ((FRAME_PTR f, Lisp_Object *lface,
					    Lisp_Object spec));
Kenichi Handa's avatar
Kenichi Handa committed
775
extern void font_prepare_for_face P_ ((FRAME_PTR f, struct face *face));
776 777
extern void font_done_for_face P_ ((FRAME_PTR f, struct face *face));

778
extern Lisp_Object font_open_by_spec P_ ((FRAME_PTR f, Lisp_Object spec));
Kenichi Handa's avatar
Kenichi Handa committed
779
extern Lisp_Object font_open_by_name P_ ((FRAME_PTR f, char *name));
780
extern void font_close_object (FRAME_PTR f, Lisp_Object font_object);
Kenichi Handa's avatar
Kenichi Handa committed
781

782
extern Lisp_Object font_intern_prop P_ ((char *str, int len, int force_symbol));
Kenichi Handa's avatar
Kenichi Handa committed
783 784
extern void font_update_sort_order P_ ((int *order));

785 786 787 788 789
extern void font_parse_family_registry P_ ((Lisp_Object family,
					    Lisp_Object registry,
					    Lisp_Object spec));
extern Lisp_Object font_spec_from_family_registry P_ ((Lisp_Object family,
						       Lisp_Object registry));
Kenichi Handa's avatar
Kenichi Handa committed
790

Kenichi Handa's avatar
Kenichi Handa committed
791
extern int font_parse_xlfd P_ ((char *name, Lisp_Object font));
Kenichi Handa's avatar
Kenichi Handa committed
792 793
extern int font_unparse_xlfd P_ ((Lisp_Object font, int pixel_size,
				  char *name, int bytes));
Kenichi Handa's avatar
Kenichi Handa committed
794
extern int font_parse_fcname P_ ((char *name, Lisp_Object font));
795 796
extern int font_unparse_fcname P_ ((Lisp_Object font, int pixel_size,
				  char *name, int bytes));
797
extern int font_unparse_gtkname P_ ((Lisp_Object, struct frame *, char *, int));
Kenichi Handa's avatar
Kenichi Handa committed
798 799
extern void register_font_driver P_ ((struct font_driver *driver, FRAME_PTR f));
extern void free_font_driver_list P_ ((FRAME_PTR f));
800
extern Lisp_Object font_update_drivers P_ ((FRAME_PTR f, Lisp_Object list));
801 802
extern Lisp_Object font_at P_ ((int c, EMACS_INT pos, struct face *face,
				struct window *w, Lisp_Object object));
Stefan Monnier's avatar
Stefan Monnier committed
803 804 805
extern Lisp_Object font_range (EMACS_INT, EMACS_INT *,
			       struct window *, struct face *,
			       Lisp_Object);
806
extern void font_fill_lglyph_metrics P_ ((Lisp_Object, Lisp_Object));
Kenichi Handa's avatar
Kenichi Handa committed
807

808 809
extern Lisp_Object font_put_extra P_ ((Lisp_Object font, Lisp_Object prop,
                                       Lisp_Object val));
Kenichi Handa's avatar
Kenichi Handa committed
810

811 812 813 814 815 816
extern int font_put_frame_data P_ ((FRAME_PTR f,
				    struct font_driver *driver,
				    void *data));
extern void *font_get_frame_data P_ ((FRAME_PTR f,
				      struct font_driver *driver));

817 818 819 820 821
extern void font_filter_properties (Lisp_Object font,
				    Lisp_Object alist,
				    const char *boolean_properties[],
				    const char *non_boolean_properties[]);

Kenichi Handa's avatar
Kenichi Handa committed
822 823 824 825 826 827 828 829 830 831 832 833
#ifdef HAVE_FREETYPE
extern struct font_driver ftfont_driver;
#endif	/* HAVE_FREETYPE */
#ifdef HAVE_X_WINDOWS
extern struct font_driver xfont_driver;
extern struct font_driver ftxfont_driver;
#ifdef HAVE_XFT
extern struct font_driver xftfont_driver;
#endif	/* HAVE_XFT */
#endif	/* HAVE_X_WINDOWS */
#ifdef WINDOWSNT
extern struct font_driver w32font_driver;
834
extern struct font_driver uniscribe_font_driver;
Kenichi Handa's avatar
Kenichi Handa committed
835
#endif	/* WINDOWSNT */
836 837 838
#ifdef HAVE_NS
extern struct font_driver nsfont_driver;
#endif	/* HAVE_NS */
Kenichi Handa's avatar
Kenichi Handa committed
839

840 841 842 843
#ifndef FONT_DEBUG
#define FONT_DEBUG
#endif

Kenichi Handa's avatar
Kenichi Handa committed
844
extern Lisp_Object Vfont_log;
845
extern void font_add_log P_ ((char *, Lisp_Object, Lisp_Object));
846
extern void font_deferred_log P_ ((char *, Lisp_Object, Lisp_Object));
847

Kenichi Handa's avatar
Kenichi Handa committed
848 849 850 851 852 853 854 855 856 857 858 859
#define FONT_ADD_LOG(ACTION, ARG, RESULT)	\
  do {						\
    if (! EQ (Vfont_log, Qt))			\
      font_add_log ((ACTION), (ARG), (RESULT));	\
  } while (0)

#define FONT_DEFERRED_LOG(ACTION, ARG, RESULT)		\
  do {							\
    if (! EQ (Vfont_log, Qt))				\
      font_deferred_log ((ACTION), (ARG), (RESULT));	\
  } while (0)

860 861 862 863 864 865
#ifdef FONT_DEBUG
#define font_assert(X)	do {if (!(X)) abort ();} while (0)
#else  /* not FONT_DEBUG */
#define font_assert(X)	(void) 0
#endif	/* not FONT_DEBUG */

Kenichi Handa's avatar
Kenichi Handa committed
866
#endif	/* not EMACS_FONT_H */
Miles Bader's avatar
Miles Bader committed
867 868 869

/* arch-tag: 3b7260c3-5bec-4d6b-a0db-95c1b431b1a2
   (do not change this comment) */