src/font.h

   1 /* font.h -- Interface definition for font handling.
   2    Copyright (C) 2006-2012 Free Software Foundation, Inc.
   3    Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011
   4      National Institute of Advanced Industrial Science and Technology (AIST)
   5      Registration Number H13PRO009
   6
   7 This file is part of GNU Emacs.
   8
   9 GNU Emacs is free software: you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation, either version 3 of the License, or
  12 (at your option) any later version.
  13
  14 GNU Emacs is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 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/>.  */
  21
  22 #ifndef EMACS_FONT_H
  23 #define EMACS_FONT_H
  24
  25 #include "ccl.h"
  26
  27 /* We have three types of Lisp objects related to font.
  28
  29    FONT-SPEC
  30
  31         Pseudo vector (length FONT_SPEC_MAX) of font properties.  Some
  32         properties can be left unspecified (i.e. nil).  Emacs asks
  33         font-drivers to find a font by FONT-SPEC.  A fontset entry
  34         specifies requisite properties whereas a face specifies just
  35         preferable properties.
  36
  37    FONT-ENTITY
  38
  39         Pseudo vector (length FONT_ENTITY_MAX) of fully instantiated
  40         font properties that a font-driver returns upon a request of
  41         FONT-SPEC.
  42
  43         Note: Only the method `list' and `match' of a font-driver can
  44         create this object, and it should never be modified by Lisp.
  45
  46    FONT-OBJECT
  47
  48         Pseudo vector (length FONT_OBJECT_MAX) of an opened font.
  49
  50         Lisp object encapsulating "struct font".  This corresponds to
  51         an opened font.
  52
  53         Note: Only the method `open' of a font-driver can create this
  54         object, and it should never be modified by Lisp.  */
  55
  56 extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
  57
  58
  59 struct font_driver;
  60 struct font;
  61 struct glyph_string;
  62
  63 /* An enumerator for each font property.  This is used as an index to
  64    the vector of FONT-SPEC and FONT-ENTITY.
  65
  66    Note: The order is important and should not be changed.  */
  67
  68 enum font_property_index
  69   {
  70     /* FONT-TYPE is a symbol indicating a font backend; currently `x',
  71        `xft', and `ftx' are available on X, `uniscribe' and `gdi' on
  72        Windows, and `ns' under Cocoa / GNUstep.  */
  73     FONT_TYPE_INDEX,
  74
  75     /* FONT-FOUNDRY is a foundry name (symbol).  */
  76     FONT_FOUNDRY_INDEX,
  77
  78     /* FONT-FAMILY is a family name (symbol).  */
  79     FONT_FAMILY_INDEX,
  80
  81     /* FONT-ADSTYLE is an additional style name (symbol).  */
  82     FONT_ADSTYLE_INDEX,
  83
  84     /* FONT-REGISTRY is a combination of a charset-registry and
  85        charset-encoding name (symbol).  */
  86     FONT_REGISTRY_INDEX,
  87
  88     /* FONT-WEIGHT is a numeric value of weight (e.g. medium, bold) of
  89        the font.  The lowest 8 bits is an index determining the
  90        symbolic name, and the higher bits is the actual numeric value
  91        defined in `font-weight-table'. */
  92     FONT_WEIGHT_INDEX,
  93
  94     /* FONT-SLANT is a numeric value of slant (e.g. r, i, o) of the
  95        font.  The lowest 8 bits is an index determining the symbolic
  96        name, and the higher bits is the actual numeric value defined
  97        in `font-slant-table'.  */
  98     FONT_SLANT_INDEX,
  99
 100     /* FONT-WIDTH is a numeric value of setwidth (e.g. normal) of the
 101        font.  The lowest 8 bits is an index determining the symbolic
 102        name, and the higher bits is the actual numeric value defined
 103        `font-width-table'.  */
 104     FONT_WIDTH_INDEX,
 105
 106     /* FONT-SIZE is a size of the font.  If integer, it is a pixel
 107        size.  For a font-spec, the value can be a float specifying
 108        the point size.  The value zero means that the font is
 109        scalable.  */
 110     FONT_SIZE_INDEX,
 111
 112     /* FONT-DPI is a resolution (dot per inch) for which the font is
 113        designed. */
 114     FONT_DPI_INDEX,
 115
 116     /* FONT-SPACING is a spacing (mono, proportional, charcell) of the
 117        font (integer; one of enum font_spacing).  */
 118     FONT_SPACING_INDEX,
 119
 120     /* FONT-AVGWIDTH is an average width (1/10 pixel unit) of the
 121        font.  */
 122     FONT_AVGWIDTH_INDEX,
 123
 124 #if 0
 125     /* The following two members are to substitute for the above 6
 126        members (FONT_WEIGHT_INDEX to FONT_AVGWIDTH_INDEX excluding
 127        FONT_SIZE_INDEX) if it is found that font-entities consumes too
 128        much memory.  */
 129
 130     /* FONT-STYLE is a 24-bit integer containing indices for
 131        style-related properties WEIGHT, SLANT, and WIDTH.  The lowest
 132        8 bits is an index to the weight table AREF (font_style_table,
 133        0), the next 8 bits is an index to the slant table AREF
 134        (font_style_table, 1), the highest 8 bits is an index to the
 135        slant table AREF (font_style_table, 2).  The index 0 indicates
 136        that the corresponding style is not specified.  This way, we
 137        can represent at most 255 different names for each style, which
 138        is surely sufficient.  */
 139     FONT_STYLE_INDEX,
 140
 141     /* FONT-METRICS is a 27-bit integer containing metrics-related
 142        properties DPI, AVGWIDTH, SPACING.  The lowest 12 bits is for
 143        DPI, the next 12 bits is for AVGWIDTH, the highest 3 bits is for
 144        SPACING.  In each bit field, the highest bit indicates that the
 145        corresponding value is set or not.  This way, we can represent
 146        DPI by 11-bit (0 to 2047), AVGWIDTH by 11-bit (0 to 2047),
 147        SPACING by 3-bit (0 for proportional, 1 for dual, 2 for mono, 3
 148        for charcell), which is surely sufficient.  */
 149     FONT_METRICS_INDEX,
 150 #endif
 151
 152     /* In a font-spec, the value is an alist of extra information of a
 153        font such as name, OpenType features, and language coverage.
 154        In addition, in a font-entity, the value may contain a pair
 155        (font-entity . INFO) where INFO is extra information to identify
 156        a font (font-driver dependent).  */
 157     FONT_EXTRA_INDEX,           /* alist                alist */
 158
 159     /* This value is the length of font-spec vector.  */
 160     FONT_SPEC_MAX,
 161
 162     /* The followings are used only for a font-entity and a font-object.  */
 163
 164     /* List of font-objects opened from the font-entity.  */
 165     FONT_OBJLIST_INDEX = FONT_SPEC_MAX,
 166
 167     /* Font-entity from which the font-object is opened.  */
 168     FONT_ENTITY_INDEX = FONT_SPEC_MAX,
 169
 170     /* This value is the length of font-entity vector.  */
 171     FONT_ENTITY_MAX,
 172
 173     /* The followings are used only for a font-object.  */
 174
 175     /* XLFD name of the font (string). */
 176     FONT_NAME_INDEX = FONT_ENTITY_MAX,
 177
 178     /* Full name of the font (string).  It is the name extracted from
 179        the opened font, and may be different from the above.  It may be
 180        nil if the opened font doesn't give a name.  */
 181     FONT_FULLNAME_INDEX,
 182
 183     /* File name of the font or nil if a file associated with the font
 184        is not available.  */
 185     FONT_FILE_INDEX,
 186
 187     /* Format of the font (symbol) or nil if unknown.  */
 188     FONT_FORMAT_INDEX,
 189
 190     /* This value is the length of font-object vector.  */
 191     FONT_OBJECT_MAX
 192   };
 193
 194 /* Return the numeric weight value of FONT.  */
 195 #define FONT_WEIGHT_NUMERIC(font)               \
 196   (INTEGERP (AREF ((font), FONT_WEIGHT_INDEX))  \
 197    ? (XINT (AREF ((font), FONT_WEIGHT_INDEX)) >> 8) : -1)
 198 /* Return the numeric slant value of FONT.  */
 199 #define FONT_SLANT_NUMERIC(font)                \
 200   (INTEGERP (AREF ((font), FONT_SLANT_INDEX))   \
 201    ? (XINT (AREF ((font), FONT_SLANT_INDEX)) >> 8) : -1)
 202 /* Return the numeric width value of FONT.  */
 203 #define FONT_WIDTH_NUMERIC(font)                \
 204   (INTEGERP (AREF ((font), FONT_WIDTH_INDEX))   \
 205    ? (XINT (AREF ((font), FONT_WIDTH_INDEX)) >> 8) : -1)
 206 /* Return the symbolic weight value of FONT.  */
 207 #define FONT_WEIGHT_SYMBOLIC(font)      \
 208   font_style_symbolic (font, FONT_WEIGHT_INDEX, 0)
 209 /* Return the symbolic slant value of FONT.  */
 210 #define FONT_SLANT_SYMBOLIC(font)       \
 211   font_style_symbolic (font, FONT_SLANT_INDEX, 0)
 212 /* Return the symbolic width value of FONT.  */
 213 #define FONT_WIDTH_SYMBOLIC(font)       \
 214   font_style_symbolic (font, FONT_WIDTH_INDEX, 0)
 215 /* Return the face-weight corresponding to the weight of FONT.  */
 216 #define FONT_WEIGHT_FOR_FACE(font)      \
 217   font_style_symbolic (font, FONT_WEIGHT_INDEX, 1)
 218 /* Return the face-slant corresponding to the slant of FONT.  */
 219 #define FONT_SLANT_FOR_FACE(font)       \
 220   font_style_symbolic (font, FONT_SLANT_INDEX, 1)
 221 /* Return the face-swidth corresponding to the slant of FONT.  */
 222 #define FONT_WIDTH_FOR_FACE(font)       \
 223   font_style_symbolic (font, FONT_WIDTH_INDEX, 1)
 224
 225 /* Return the numeric weight value corresponding ot the symbol NAME.  */
 226 #define FONT_WEIGHT_NAME_NUMERIC(name)  \
 227   (font_style_to_value (FONT_WEIGHT_INDEX, (name), 0) >> 8)
 228 /* Return the numeric slant value corresponding ot the symbol NAME.  */
 229 #define FONT_SLANT_NAME_NUMERIC(name)   \
 230   (font_style_to_value (FONT_SLANT_INDEX, (name), 0) >> 8)
 231 /* Return the numeric width value corresponding ot the symbol NAME.  */
 232 #define FONT_WIDTH_NAME_NUMERIC(name)   \
 233   (font_style_to_value (FONT_WIDTH_INDEX, (name), 0) >> 8)
 234
 235 /* Set the font property PROP of FONT to VAL.  PROP is one of
 236    style-related font property index (FONT_WEIGHT/SLANT/WIDTH_INDEX).
 237    VAL (integer or symbol) is the numeric or symbolic style value.  */
 238 #define FONT_SET_STYLE(font, prop, val) \
 239   ASET ((font), prop, make_number (font_style_to_value (prop, val, 1)))
 240
 241 extern Lisp_Object QCspacing, QCdpi, QCscalable, QCotf, QClang, QCscript;
 242 extern Lisp_Object QCavgwidth, QCantialias, QCfont_entity;
 243 extern Lisp_Object Qp;
 244
 245
 246 /* Important character set symbols.  */
 247 extern Lisp_Object Qascii_0;
 248 extern Lisp_Object Qiso8859_1, Qiso10646_1, Qunicode_bmp, Qunicode_sip;
 249
 250 /* Special ADSTYLE properties to avoid fonts used for Latin characters.  */
 251 extern Lisp_Object Qja, Qko;
 252
 253 /* Structure for a font-spec.  */
 254
 255 struct font_spec
 256 {
 257   struct vectorlike_header header;
 258   Lisp_Object props[FONT_SPEC_MAX];
 259 };
 260
 261 /* Structure for a font-entity.  */
 262
 263 struct font_entity
 264 {
 265   struct vectorlike_header header;
 266   Lisp_Object props[FONT_ENTITY_MAX];
 267 };
 268
 269 /* A value which may appear in the member `encoding' of struct font
 270    indicating that a font itself doesn't tell which encoding to be
 271    used.  */
 272 #define FONT_ENCODING_NOT_DECIDED 255
 273
 274 /* Structure for a font-object.  */
 275
 276 struct font
 277 {
 278   struct vectorlike_header header;
 279
 280   /* All Lisp_Object components must come first.
 281      That ensures they are all aligned normally.  */
 282
 283   Lisp_Object props[FONT_OBJECT_MAX];
 284
 285   /* Beyond here, there should be no more Lisp_Object components.  */
 286
 287   /* Minimum and maximum glyph widths, in pixels.  Some font backends,
 288      such as xft, lack the information to easily compute minimum and
 289      maximum widths over all characters; in that case, these values
 290      are approximate.  */
 291   int min_width;
 292   int max_width;
 293
 294   /* By which pixel size the font is opened.  */
 295   int pixel_size;
 296
 297   /* Height of the font.  On X window, this is the same as
 298      (font->ascent + font->descent).  */
 299   int height;
 300
 301   /* Width of the space glyph of the font.  If the font doesn't have a
 302      SPACE glyph, the value is 0.  */
 303   int space_width;
 304
 305   /* Average width of glyphs in the font.  If the font itself doesn't
 306      have that information but has glyphs of ASCII characters, the
 307      value is the average width of those glyphs.  Otherwise, the value
 308      is 0.  */
 309   int average_width;
 310
 311   /* Ascent and descent of the font (in pixels).  */
 312   int ascent, descent;
 313
 314   /* Vertical pixel width of the underline.  If is zero if that
 315      information is not in the font.  */
 316   int underline_thickness;
 317
 318   /* Vertical pixel position (relative to the baseline) of the
 319      underline.  If it is positive, it is below the baseline.  It is
 320      negative if that information is not in the font.  */
 321   int underline_position;
 322
 323   /* 1 if `vertical-centering-font-regexp' matches this font name.
 324      In this case, we render characters at vertical center positions
 325      of lines.  */
 326   int vertical_centering;
 327
 328   /* Encoding type of the font.  The value is one of
 329      0, 1, 2, or 3:
 330         0: code points 0x20..0x7F or 0x2020..0x7F7F are used
 331         1: code points 0xA0..0xFF or 0xA0A0..0xFFFF are used
 332         2: code points 0x20A0..0x7FFF are used
 333         3: code points 0xA020..0xFF7F are used
 334      If the member `font_encoder' is not NULL, this member is ignored.  */
 335   unsigned char encoding_type;
 336
 337   /* The baseline position of a font is normally `ascent' value of the
 338      font.  However, there exist many fonts which don't set `ascent' to
 339      an appropriate value to be used as baseline position.  This is
 340      typical in such ASCII fonts which are designed to be used with
 341      Chinese, Japanese, Korean characters.  When we use mixture of
 342      such fonts and normal fonts (having correct `ascent' value), a
 343      display line gets very ugly.  Since we have no way to fix it
 344      automatically, it is user's responsibility to supply well designed
 345      fonts or correct `ascent' value of fonts.  But, the latter
 346      requires heavy work (modifying all bitmap data in BDF files).
 347      So, Emacs accepts a private font property
 348      `_MULE_BASELINE_OFFSET'.  If a font has this property, we
 349      calculate the baseline position by subtracting the value from
 350      `ascent'.  In other words, the value indicates how many pixels
 351      higher than normal ASCII text we should draw a character of the
 352      font for better appearance.
 353
 354      We also have to consider the fact that the concept of `baseline'
 355      differs among scripts to which each character belongs.  For
 356      instance, baseline should be at the bottom-most position of all
 357      glyphs for Chinese, Japanese, and Korean.  But, many of existing
 358      fonts for those characters don't have correct `ascent' values
 359      because they are designed to be used with ASCII fonts.  To
 360      display characters of different language on the same line, the
 361      best way will be to arrange them in the middle of the line.  So,
 362      in such a case, again, we utilize the font property
 363      `_MULE_BASELINE_OFFSET'.  If the value is larger than `ascent' we
 364      calculate baseline so that a character is arranged in the middle
 365      of a line.  */
 366   int baseline_offset;
 367
 368   /* Non-zero means a character should be composed at a position
 369      relative to the height (or depth) of previous glyphs in the
 370      following cases:
 371         (1) The bottom of the character is higher than this value.  In
 372         this case, the character is drawn above the previous glyphs.
 373         (2) The top of the character is lower than 0 (i.e. baseline
 374         height).  In this case, the character is drawn below the
 375         previous glyphs.
 376
 377      This value is taken from a private font property
 378      `_MULE_RELATIVE_COMPOSE' which is introduced by Emacs.  */
 379   int relative_compose;
 380
 381   /* Non-zero means an ascent value to be used for a character
 382      registered in char-table `use-default-ascent'.  */
 383   int default_ascent;
 384
 385   /* CCL program to calculate code points of the font.  */
 386   struct ccl_program *font_encoder;
 387
 388   /* Font-driver for the font.  */
 389   struct font_driver *driver;
 390
 391   /* Charset to encode a character code into a glyph code of the font.
 392      -1 means that the font doesn't require this information to encode
 393      a character.  */
 394   int encoding_charset;
 395
 396   /* Charset to check if a character code is supported by the font.
 397      -1 means that the contents of the font must be looked up to
 398      determine it.  */
 399   int repertory_charset;
 400
 401   /* There are more members in this structure, but they are private
 402      to the font-driver.  */
 403 };
 404
 405 enum font_spacing
 406   {
 407     FONT_SPACING_PROPORTIONAL = 0,
 408     FONT_SPACING_DUAL = 90,
 409     FONT_SPACING_MONO = 100,
 410     FONT_SPACING_CHARCELL = 110
 411   };
 412
 413 struct font_metrics
 414 {
 415   short lbearing, rbearing, width, ascent, descent;
 416 };
 417
 418 struct font_bitmap
 419 {
 420   int bits_per_pixel;
 421   int rows;
 422   int width;
 423   int pitch;
 424   unsigned char *buffer;
 425   int left;
 426   int top;
 427   int advance;
 428   void *extra;
 429 };
 430
 431 /* Predicates to check various font-related objects.  */
 432
 433 /* 1 iff X is one of font-spec, font-entity, and font-object.  */
 434 #define FONTP(x) PSEUDOVECTORP (x, PVEC_FONT)
 435 /* 1 iff X is font-spec.  */
 436 #define FONT_SPEC_P(x)  \
 437   (FONTP (x) && (ASIZE (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_SPEC_MAX)
 438 /* 1 iff X is font-entity.  */
 439 #define FONT_ENTITY_P(x)        \
 440   (FONTP (x) && (ASIZE (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_ENTITY_MAX)
 441 /* 1 iff X is font-object.  */
 442 #define FONT_OBJECT_P(x)        \
 443   (FONTP (x) && (ASIZE (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_OBJECT_MAX)
 444
 445 /* 1 iff ENTITY can't be loaded.  */
 446 #define FONT_ENTITY_NOT_LOADABLE(entity)        \
 447   EQ (AREF (entity, FONT_OBJLIST_INDEX), Qt)
 448
 449 /* Flag ENTITY not loadable.  */
 450 #define FONT_ENTITY_SET_NOT_LOADABLE(entity)    \
 451   ASET (entity, FONT_OBJLIST_INDEX, Qt)
 452
 453
 454 /* Check macros for various font-related objects.  */
 455
 456 #define CHECK_FONT(x)   \
 457   do { if (! FONTP (x)) wrong_type_argument (Qfont, x); } while (0)
 458 #define CHECK_FONT_SPEC(x)      \
 459   do { if (! FONT_SPEC_P (x)) wrong_type_argument (Qfont_spec, x); } while (0)
 460 #define CHECK_FONT_ENTITY(x)    \
 461   do { if (! FONT_ENTITY_P (x)) wrong_type_argument (Qfont_entity, x); } while (0)
 462 #define CHECK_FONT_OBJECT(x)    \
 463   do { if (! FONT_OBJECT_P (x)) wrong_type_argument (Qfont_object, x); } while (0)
 464
 465 #define CHECK_FONT_GET_OBJECT(x, font)  \
 466   do {                                  \
 467     CHECK_FONT_OBJECT (x);              \
 468     font = XFONT_OBJECT (x);            \
 469   } while (0)
 470
 471 #define XFONT_SPEC(p)   \
 472   (eassert (FONT_SPEC_P (p)), (struct font_spec *) XUNTAG (p, Lisp_Vectorlike))
 473 #define XFONT_ENTITY(p) \
 474   (eassert (FONT_ENTITY_P (p)), \
 475    (struct font_entity *) XUNTAG (p, Lisp_Vectorlike))
 476 #define XFONT_OBJECT(p) \
 477   (eassert (FONT_OBJECT_P (p)), (struct font *) XUNTAG (p, Lisp_Vectorlike))
 478 #define XSETFONT(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FONT))
 479
 480 /* Number of pt per inch (from the TeXbook).  */
 481 #define PT_PER_INCH 72.27
 482
 483 /* Return a pixel size (integer) corresponding to POINT size (double)
 484    on resolution DPI.  */
 485 #define POINT_TO_PIXEL(POINT, DPI) ((POINT) * (DPI) / PT_PER_INCH + 0.5)
 486
 487 /* Return a point size corresponding to POINT size (integer)
 488    on resolution DPI.  Note that though point size is a double, we expect
 489    it to be rounded to an int, so we add 0.5 here.  If the desired value
 490    is tenths of points (as in xfld specs), then the pixel size should
 491    be multiplied BEFORE the conversion to avoid magnifying the error.  */
 492 #define PIXEL_TO_POINT(PIXEL, DPI) ((PIXEL) * PT_PER_INCH / (DPI) + 0.5)
 493
 494 /* Ignore the difference of font pixel sizes less than or equal to
 495    this value.  */
 496 #define FONT_PIXEL_SIZE_QUANTUM 1
 497
 498 struct face;
 499
 500 #define FONT_INVALID_CODE 0xFFFFFFFF
 501
 502 /* Font driver.  Members specified as "optional" can be NULL.  */
 503
 504 struct font_driver
 505 {
 506   /* Symbol indicating the type of the font-driver.  */
 507   Lisp_Object type;
 508
 509   /* 1 iff the font's foundry, family, and adstyle names are case
 510      sensitive.  */
 511   int case_sensitive;
 512
 513   /* Return a cache of font-entities on frame F.  The cache must be a
 514      cons whose cdr part is the actual cache area.  */
 515   Lisp_Object (*get_cache) (FRAME_PTR F);
 516
 517   /* List fonts exactly matching with FONT_SPEC on FRAME.  The value
 518      is a list of font-entities.  The font properties to be considered
 519      are: :foundry, :family, :adstyle, :registry, :script, :lang, and
 520      :otf.  See the function `font-spec' for their meanings.  Note
 521      that the last three properties are stored in FONT_EXTRA_INDEX
 522      slot of FONT_SPEC.
 523
 524      The returned value is a list of font-entities.  Each font-entity
 525      has :type property whose value is the same as the above `type'.
 526      It also has these properties if they are available from the
 527      corresponding font; :foundry, :family, :adstyle, :registry,
 528      :weight, :slant, :width, :size, :dpi, :spacing, :avgwidth.  If
 529      the font is scalable, :size and :avgwidth must be 0.
 530
 531      The `open' method of the same font-backend is called with one of
 532      the returned font-entities.  If the backend needs additional
 533      information to be used in `open' method, this method can add any
 534      Lispy value by the property :font-entity to the entities.
 535
 536      This and the following `match' are the only APIs that allocate
 537      font-entities.  */
 538   Lisp_Object (*list) (Lisp_Object frame, Lisp_Object font_spec);
 539
 540   /* Return a font-entity most closely matching with FONT_SPEC on
 541      FRAME.  Which font property to consider, and how to calculate the
 542      closeness is determined by the font backend, thus
 543      `face-font-selection-order' is ignored here.
 544
 545      The properties that the font-entity has is the same as `list'
 546      method.  */
 547   Lisp_Object (*match) (Lisp_Object frame, Lisp_Object font_spec);
 548
 549   /* Optional.
 550      List available families.  The value is a list of family names
 551      (symbols).  */
 552   Lisp_Object (*list_family) (Lisp_Object frame);
 553
 554   /* Optional (if FONT_EXTRA_INDEX is not Lisp_Save_Value).
 555      Free FONT_EXTRA_INDEX field of FONT_ENTITY.  */
 556   void (*free_entity) (Lisp_Object font_entity);
 557
 558   /* Open a font specified by FONT_ENTITY on frame F.  If the font is
 559      scalable, open it with PIXEL_SIZE.  */
 560   Lisp_Object (*open) (FRAME_PTR f, Lisp_Object font_entity,
 561                        int pixel_size);
 562
 563   /* Close FONT on frame F.  */
 564   void (*close) (FRAME_PTR f, struct font *font);
 565
 566   /* Optional (if FACE->extra is not used).
 567      Prepare FACE for displaying characters by FONT on frame F by
 568      storing some data in FACE->extra.  If successful, return 0.
 569      Otherwise, return -1.  */
 570   int (*prepare_face) (FRAME_PTR f, struct face *face);
 571
 572   /* Optional.
 573      Done FACE for displaying characters by FACE->font on frame F.  */
 574   void (*done_face) (FRAME_PTR f, struct face *face);
 575
 576   /* Optional.
 577      If FONT (FONT-ENTITY or FONT-OBJECT) has a glyph for character C
 578      (Unicode code point), return 1.  If not, return 0.  If FONT is
 579      FONT-ENTITY and it must be opened to check it, return -1.  */
 580   int (*has_char) (Lisp_Object font, int c);
 581
 582   /* Return a glyph code of FONT for character C (Unicode code point).
 583      If FONT doesn't have such a glyph, return FONT_INVALID_CODE.  */
 584   unsigned (*encode_char) (struct font *font, int c);
 585
 586   /* Compute the total metrics of the NGLYPHS glyphs specified by
 587      the font FONT and the sequence of glyph codes CODE, and store the
 588      result in METRICS.  */
 589   int (*text_extents) (struct font *font,
 590                        unsigned *code, int nglyphs,
 591                        struct font_metrics *metrics);
 592
 593   /* Optional.
 594      Draw glyphs between FROM and TO of S->char2b at (X Y) pixel
 595      position of frame F with S->FACE and S->GC.  If WITH_BACKGROUND
 596      is nonzero, fill the background in advance.  It is assured that
 597      WITH_BACKGROUND is zero when (FROM > 0 || TO < S->nchars).  */
 598   int (*draw) (struct glyph_string *s, int from, int to,
 599                int x, int y, int with_background);
 600
 601   /* Optional.
 602      Store bitmap data for glyph-code CODE of FONT in BITMAP.  It is
 603      intended that this method is called from the other font-driver
 604      for actual drawing.  */
 605   int (*get_bitmap) (struct font *font, unsigned code,
 606                      struct font_bitmap *bitmap,
 607                      int bits_per_pixel);
 608
 609   /* Optional.
 610      Free bitmap data in BITMAP.  */
 611   void (*free_bitmap) (struct font *font, struct font_bitmap *bitmap);
 612
 613   /* Optional.
 614      Return an outline data for glyph-code CODE of FONT.  The format
 615      of the outline data depends on the font-driver.  */
 616   void *(*get_outline) (struct font *font, unsigned code);
 617
 618   /* Optional.
 619      Free OUTLINE (that is obtained by the above method).  */
 620   void (*free_outline) (struct font *font, void *outline);
 621
 622   /* Optional.
 623      Get coordinates of the INDEXth anchor point of the glyph whose
 624      code is CODE.  Store the coordinates in *X and *Y.  Return 0 if
 625      the operations was successful.  Otherwise return -1.  */
 626   int (*anchor_point) (struct font *font, unsigned code, int index,
 627                        int *x, int *y);
 628
 629   /* Optional.
 630      Return a list describing which scripts/languages FONT
 631      supports by which GSUB/GPOS features of OpenType tables.  */
 632   Lisp_Object (*otf_capability) (struct font *font);
 633
 634   /* Optional.
 635      Apply FONT's OTF-FEATURES to the glyph string.
 636
 637      FEATURES specifies which OTF features to apply in this format:
 638         (SCRIPT LANGSYS GSUB-FEATURE GPOS-FEATURE)
 639      See the documentation of `font-drive-otf' for the details.
 640
 641      This method applies the specified features to the codes in the
 642      elements of GSTRING-IN (between FROMth and TOth).  The output
 643      codes are stored in GSTRING-OUT at the IDXth element and the
 644      following elements.
 645
 646      Return the number of output codes.  If none of the features are
 647      applicable to the input data, return 0.  If GSTRING-OUT is too
 648      short, return -1.  */
 649   int (*otf_drive) (struct font *font, Lisp_Object features,
 650                     Lisp_Object gstring_in, int from, int to,
 651                     Lisp_Object gstring_out, int idx, int alternate_subst);
 652
 653   /* Optional.
 654      Make the font driver ready for frame F.  Usually this function
 655      makes some data specific to F and stores it in F by calling
 656      font_put_frame_data ().  */
 657   int (*start_for_frame) (FRAME_PTR f);
 658
 659   /* Optional.
 660      End using the driver for frame F.  Usually this function free
 661      some data stored for F.  */
 662   int (*end_for_frame) (FRAME_PTR f);
 663
 664   /* Optional.
 665
 666      Shape text in GSTRING.  See the docstring of
 667      `composition-get-gstring' for the format of GSTRING.  If the
 668      (N+1)th element of GSTRING is nil, input of shaping is from the
 669      1st to (N)th elements.  In each input glyph, FROM, TO, CHAR, and
 670      CODE are already set.
 671
 672      This function updates all fields of the input glyphs.  If the
 673      output glyphs (M) are more than the input glyphs (N), (N+1)th
 674      through (M)th elements of GSTRING are updated possibly by making
 675      a new glyph object and storing it in GSTRING.  If (M) is greater
 676      than the length of GSTRING, nil should be return.  In that case,
 677      this function is called again with the larger GSTRING.  */
 678   Lisp_Object (*shape) (Lisp_Object lgstring);
 679
 680   /* Optional.
 681
 682      If FONT is usable on frame F, return 0.  Otherwise return -1.
 683      This method is used only for debugging.  If this method is NULL,
 684      Emacs assumes that the font is usable on any frame.  */
 685   int (*check) (FRAME_PTR F, struct font *font);
 686
 687   /* Optional.
 688
 689      Return the number of variation glyphs of character C supported by
 690      FONT.  VARIATIONS is an array of 256 elements.  If the variation
 691      selector N (1..256) defines a glyph, that glyph code is stored in
 692      the (N-1)th element of VARIATIONS.  */
 693   int (*get_variation_glyphs) (struct font *font,
 694                                int c, unsigned variations[256]);
 695
 696   void (*filter_properties) (Lisp_Object font, Lisp_Object properties);
 697
 698   /* Optional.
 699
 700      Return non-zero if FONT_OBJECT can be used as a (cached) font
 701      for ENTITY on frame F.  */
 702   int (*cached_font_ok) (struct frame *f,
 703                          Lisp_Object font_object,
 704                          Lisp_Object entity);
 705 };
 706
 707
 708 /* Chain of font drivers.  There's one global font driver list
 709    (font_driver_list in font.c).  In addition, each frame has its own
 710    font driver list at FRAME_PTR->font_driver_list.  */
 711
 712 struct font_driver_list
 713 {
 714   /* 1 iff this driver is currently used.  It is ignored in the global
 715      font driver list.*/
 716   int on;
 717   /* Pointer to the font driver.  */
 718   struct font_driver *driver;
 719   /* Pointer to the next element of the chain.  */
 720   struct font_driver_list *next;
 721 };
 722
 723
 724 /* Chain of arbitrary data specific to each font driver.  Each frame
 725    has its own font data list at FRAME_PTR->font_data_list.  */
 726
 727 struct font_data_list
 728 {
 729   /* Pointer to the font driver.  */
 730   struct font_driver *driver;
 731   /* Data specific to the font driver.  */
 732   void *data;
 733   /* Pointer to the next element of the chain.  */
 734   struct font_data_list *next;
 735 };
 736
 737 extern Lisp_Object copy_font_spec (Lisp_Object);
 738 extern Lisp_Object merge_font_spec (Lisp_Object, Lisp_Object);
 739
 740 extern Lisp_Object font_make_entity (void);
 741 extern Lisp_Object font_make_object (int, Lisp_Object, int);
 742
 743 extern Lisp_Object find_font_encoding (Lisp_Object);
 744 extern int font_registry_charsets (Lisp_Object, struct charset **,
 745                                    struct charset **);
 746 extern int font_style_to_value (enum font_property_index prop,
 747                                 Lisp_Object name, int noerror);
 748 extern Lisp_Object font_style_symbolic (Lisp_Object font,
 749                                         enum font_property_index prop,
 750                                         int for_face);
 751
 752 extern int font_match_p (Lisp_Object spec, Lisp_Object font);
 753 extern Lisp_Object font_list_entities (Lisp_Object frame,
 754                                        Lisp_Object spec);
 755
 756 extern Lisp_Object font_get_name (Lisp_Object font_object);
 757 extern Lisp_Object font_spec_from_name (Lisp_Object font_name);
 758 extern Lisp_Object font_get_frame (Lisp_Object font_object);
 759 extern int font_has_char (FRAME_PTR, Lisp_Object, int);
 760
 761 extern void font_clear_prop (Lisp_Object *attrs,
 762                              enum font_property_index prop);
 763 extern Lisp_Object font_find_for_lface (FRAME_PTR f, Lisp_Object *lface,
 764                                         Lisp_Object spec, int c);
 765 extern Lisp_Object font_open_for_lface (FRAME_PTR f, Lisp_Object entity,
 766                                         Lisp_Object *lface,
 767                                         Lisp_Object spec);
 768 extern Lisp_Object font_load_for_lface (FRAME_PTR f, Lisp_Object *lface,
 769                                         Lisp_Object spec);
 770 extern void font_prepare_for_face (FRAME_PTR f, struct face *face);
 771 extern void font_done_for_face (FRAME_PTR f, struct face *face);
 772
 773 extern Lisp_Object font_open_by_spec (FRAME_PTR f, Lisp_Object spec);
 774 extern Lisp_Object font_open_by_name (FRAME_PTR f, Lisp_Object name);
 775
 776 extern Lisp_Object font_intern_prop (const char *str, ptrdiff_t len,
 777                                      int force_symbol);
 778 extern void font_update_sort_order (int *order);
 779
 780 extern void font_parse_family_registry (Lisp_Object family,
 781                                         Lisp_Object registry,
 782                                         Lisp_Object spec);
 783
 784 extern int font_parse_xlfd (char *name, ptrdiff_t len, Lisp_Object font);
 785 extern ptrdiff_t font_unparse_xlfd (Lisp_Object font, int pixel_size,
 786                                     char *name, int bytes);
 787 extern int font_unparse_fcname (Lisp_Object font, int pixel_size,
 788                                 char *name, int bytes);
 789 extern void register_font_driver (struct font_driver *driver, FRAME_PTR f);
 790 extern void free_font_driver_list (FRAME_PTR f);
 791 extern Lisp_Object font_update_drivers (FRAME_PTR f, Lisp_Object list);
 792 extern Lisp_Object font_range (ptrdiff_t, ptrdiff_t *,
 793                                struct window *, struct face *,
 794                                Lisp_Object);
 795 extern void font_fill_lglyph_metrics (Lisp_Object, Lisp_Object);
 796
 797 extern Lisp_Object font_put_extra (Lisp_Object font, Lisp_Object prop,
 798                                    Lisp_Object val);
 799
 800 extern int font_put_frame_data (FRAME_PTR f,
 801                                 struct font_driver *driver,
 802                                 void *data);
 803 extern void *font_get_frame_data (FRAME_PTR f,
 804                                   struct font_driver *driver);
 805
 806 extern void font_filter_properties (Lisp_Object font,
 807                                     Lisp_Object alist,
 808                                     const char *const boolean_properties[],
 809                                     const char *const non_boolean_properties[]);
 810
 811 #ifdef HAVE_FREETYPE
 812 extern struct font_driver ftfont_driver;
 813 extern void syms_of_ftfont (void);
 814 #endif  /* HAVE_FREETYPE */
 815 #ifdef HAVE_X_WINDOWS
 816 extern struct font_driver xfont_driver;
 817 extern void syms_of_xfont (void);
 818 extern void syms_of_ftxfont (void);
 819 #ifdef HAVE_XFT
 820 extern struct font_driver xftfont_driver;
 821 extern void syms_of_xftfont (void);
 822 #elif defined HAVE_FREETYPE
 823 extern struct font_driver ftxfont_driver;
 824 #endif
 825 #ifdef HAVE_BDFFONT
 826 extern void syms_of_bdffont (void);
 827 #endif  /* HAVE_BDFFONT */
 828 #endif  /* HAVE_X_WINDOWS */
 829 #ifdef WINDOWSNT
 830 extern struct font_driver w32font_driver;
 831 extern struct font_driver uniscribe_font_driver;
 832 extern void syms_of_w32font (void);
 833 #endif  /* WINDOWSNT */
 834 #ifdef HAVE_NS
 835 extern Lisp_Object Qfontsize;
 836 extern struct font_driver nsfont_driver;
 837 extern void syms_of_nsfont (void);
 838 #endif  /* HAVE_NS */
 839
 840 #ifndef FONT_DEBUG
 841 #define FONT_DEBUG
 842 #endif
 843
 844 extern Lisp_Object QCfoundry;
 845
 846 extern void font_add_log (const char *, Lisp_Object, Lisp_Object);
 847 extern void font_deferred_log (const char *, Lisp_Object, Lisp_Object);
 848
 849 #define FONT_ADD_LOG(ACTION, ARG, RESULT)       \
 850   do {                                          \
 851     if (! EQ (Vfont_log, Qt))                   \
 852       font_add_log ((ACTION), (ARG), (RESULT)); \
 853   } while (0)
 854
 855 #define FONT_DEFERRED_LOG(ACTION, ARG, RESULT)          \
 856   do {                                                  \
 857     if (! EQ (Vfont_log, Qt))                           \
 858       font_deferred_log ((ACTION), (ARG), (RESULT));    \
 859   } while (0)
 860
 861 #endif  /* not EMACS_FONT_H */