1 /* xftfont.c -- XFT font driver.
2 Copyright (C) 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
3 Copyright (C) 2006, 2007, 2008, 2009
4 National Institute of Advanced Industrial Science and Technology (AIST)
5 Registration Number H13PRO009
7 This file is part of GNU Emacs.
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.
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.
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/>. */
25 #include <X11/Xft/Xft.h>
28 #include "dispextern.h"
31 #include "blockinput.h"
32 #include "character.h"
38 /* Xft font driver. */
40 static Lisp_Object Qxft
;
41 static Lisp_Object QChinting
, QCautohint
, QChintstyle
, QCrgba
, QCembolden
;
43 /* The actual structure for Xft font that can be casted to struct
49 /* The following four members must be here in this order to be
50 compatible with struct ftfont_info (in ftfont.c). */
52 int maybe_otf
; /* Flag to tell if this may be OTF or not. */
54 #endif /* HAVE_LIBOTF */
62 /* Structure pointed by (struct face *)->extra */
66 XftColor xft_fg
; /* color for face->foreground */
67 XftColor xft_bg
; /* color for face->background */
70 static void xftfont_get_colors
P_ ((FRAME_PTR
, struct face
*, GC gc
,
71 struct xftface_info
*,
72 XftColor
*fg
, XftColor
*bg
));
75 /* Setup foreground and background colors of GC into FG and BG. If
76 XFTFACE_INFO is not NULL, reuse the colors in it if possible. BG
80 xftfont_get_colors (f
, face
, gc
, xftface_info
, fg
, bg
)
84 struct xftface_info
*xftface_info
;
87 if (xftface_info
&& face
->gc
== gc
)
89 *fg
= xftface_info
->xft_fg
;
91 *bg
= xftface_info
->xft_bg
;
96 int fg_done
= 0, bg_done
= 0;
99 XGetGCValues (FRAME_X_DISPLAY (f
), gc
,
100 GCForeground
| GCBackground
, &xgcv
);
103 if (xgcv
.foreground
== face
->foreground
)
104 *fg
= xftface_info
->xft_fg
, fg_done
= 1;
105 else if (xgcv
.foreground
== face
->background
)
106 *fg
= xftface_info
->xft_bg
, fg_done
= 1;
109 else if (xgcv
.background
== face
->background
)
110 *bg
= xftface_info
->xft_bg
, bg_done
= 1;
111 else if (xgcv
.background
== face
->foreground
)
112 *bg
= xftface_info
->xft_fg
, bg_done
= 1;
115 if (fg_done
+ bg_done
< 2)
119 colors
[0].pixel
= fg
->pixel
= xgcv
.foreground
;
121 colors
[1].pixel
= bg
->pixel
= xgcv
.background
;
122 XQueryColors (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
), colors
,
124 fg
->color
.alpha
= 0xFFFF;
125 fg
->color
.red
= colors
[0].red
;
126 fg
->color
.green
= colors
[0].green
;
127 fg
->color
.blue
= colors
[0].blue
;
130 bg
->color
.alpha
= 0xFFFF;
131 bg
->color
.red
= colors
[1].red
;
132 bg
->color
.green
= colors
[1].green
;
133 bg
->color
.blue
= colors
[1].blue
;
141 static Lisp_Object xftfont_list
P_ ((Lisp_Object
, Lisp_Object
));
142 static Lisp_Object xftfont_match
P_ ((Lisp_Object
, Lisp_Object
));
143 static Lisp_Object xftfont_open
P_ ((FRAME_PTR
, Lisp_Object
, int));
144 static void xftfont_close
P_ ((FRAME_PTR
, struct font
*));
145 static int xftfont_prepare_face
P_ ((FRAME_PTR
, struct face
*));
146 static void xftfont_done_face
P_ ((FRAME_PTR
, struct face
*));
147 static int xftfont_has_char
P_ ((Lisp_Object
, int));
148 static unsigned xftfont_encode_char
P_ ((struct font
*, int));
149 static int xftfont_text_extents
P_ ((struct font
*, unsigned *, int,
150 struct font_metrics
*));
151 static int xftfont_draw
P_ ((struct glyph_string
*, int, int, int, int, int));
152 static int xftfont_end_for_frame
P_ ((FRAME_PTR f
));
154 struct font_driver xftfont_driver
;
157 xftfont_list (frame
, spec
)
161 Lisp_Object list
= ftfont_driver
.list (frame
, spec
), tail
;
163 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
164 ASET (XCAR (tail
), FONT_TYPE_INDEX
, Qxft
);
169 xftfont_match (frame
, spec
)
173 Lisp_Object entity
= ftfont_driver
.match (frame
, spec
);
176 ASET (entity
, FONT_TYPE_INDEX
, Qxft
);
180 extern Lisp_Object ftfont_font_format
P_ ((FcPattern
*, Lisp_Object
));
181 extern FcCharSet
*ftfont_get_fc_charset
P_ ((Lisp_Object
));
182 extern Lisp_Object QCantialias
;
184 static FcChar8 ascii_printable
[95];
187 xftfont_open (f
, entity
, pixel_size
)
193 Display
*display
= FRAME_X_DISPLAY (f
);
194 Lisp_Object val
, filename
, index
, tail
, font_object
;
195 FcPattern
*pat
= NULL
, *match
;
196 struct xftfont_info
*xftfont_info
= NULL
;
199 XftFont
*xftfont
= NULL
;
206 val
= assq_no_quit (QCfont_entity
, AREF (entity
, FONT_EXTRA_INDEX
));
210 filename
= XCAR (val
);
212 size
= XINT (AREF (entity
, FONT_SIZE_INDEX
));
215 pat
= FcPatternCreate ();
216 FcPatternAddInteger (pat
, FC_WEIGHT
, FONT_WEIGHT_NUMERIC (entity
));
217 i
= FONT_SLANT_NUMERIC (entity
) - 100;
219 FcPatternAddInteger (pat
, FC_SLANT
, i
);
220 FcPatternAddInteger (pat
, FC_WIDTH
, FONT_WIDTH_NUMERIC (entity
));
221 FcPatternAddDouble (pat
, FC_PIXEL_SIZE
, pixel_size
);
222 val
= AREF (entity
, FONT_FAMILY_INDEX
);
224 FcPatternAddString (pat
, FC_FAMILY
, (FcChar8
*) SDATA (SYMBOL_NAME (val
)));
225 val
= AREF (entity
, FONT_FOUNDRY_INDEX
);
227 FcPatternAddString (pat
, FC_FOUNDRY
, (FcChar8
*) SDATA (SYMBOL_NAME (val
)));
228 val
= AREF (entity
, FONT_SPACING_INDEX
);
230 FcPatternAddInteger (pat
, FC_SPACING
, XINT (val
));
231 val
= AREF (entity
, FONT_DPI_INDEX
);
234 double dbl
= XINT (val
);
236 FcPatternAddDouble (pat
, FC_DPI
, dbl
);
238 val
= AREF (entity
, FONT_AVGWIDTH_INDEX
);
239 if (INTEGERP (val
) && XINT (val
) == 0)
240 FcPatternAddBool (pat
, FC_SCALABLE
, FcTrue
);
241 /* This is necessary to identify the exact font (e.g. 10x20.pcf.gz
242 over 10x20-ISO8859-1.pcf.gz). */
243 FcPatternAddCharSet (pat
, FC_CHARSET
, ftfont_get_fc_charset (entity
));
245 for (tail
= AREF (entity
, FONT_EXTRA_INDEX
); CONSP (tail
); tail
= XCDR (tail
))
247 Lisp_Object key
, val
;
249 key
= XCAR (XCAR (tail
)), val
= XCDR (XCAR (tail
));
250 if (EQ (key
, QCantialias
))
251 FcPatternAddBool (pat
, FC_ANTIALIAS
, NILP (val
) ? FcFalse
: FcTrue
);
252 else if (EQ (key
, QChinting
))
253 FcPatternAddBool (pat
, FC_HINTING
, NILP (val
) ? FcFalse
: FcTrue
);
254 else if (EQ (key
, QCautohint
))
255 FcPatternAddBool (pat
, FC_AUTOHINT
, NILP (val
) ? FcFalse
: FcTrue
);
256 else if (EQ (key
, QChintstyle
))
259 FcPatternAddInteger (pat
, FC_RGBA
, XINT (val
));
261 else if (EQ (key
, QCrgba
))
264 FcPatternAddInteger (pat
, FC_RGBA
, XINT (val
));
267 else if (EQ (key
, QCembolden
))
268 FcPatternAddBool (pat
, FC_EMBOLDEN
, NILP (val
) ? FcFalse
: FcTrue
);
272 FcPatternAddString (pat
, FC_FILE
, (FcChar8
*) SDATA (filename
));
273 FcPatternAddInteger (pat
, FC_INDEX
, XINT (index
));
277 match
= XftFontMatch (display
, FRAME_X_SCREEN_NUMBER (f
), pat
, &result
);
278 FcPatternDestroy (pat
);
279 xftfont
= XftFontOpenPattern (display
, match
);
280 ft_face
= XftLockFace (xftfont
);
285 XftPatternDestroy (match
);
288 /* We should not destroy PAT here because it is kept in XFTFONT and
289 destroyed automatically when XFTFONT is closed. */
290 font_object
= font_make_object (VECSIZE (struct xftfont_info
), entity
, size
);
291 ASET (font_object
, FONT_TYPE_INDEX
, Qxft
);
292 len
= font_unparse_xlfd (entity
, size
, name
, 256);
294 ASET (font_object
, FONT_NAME_INDEX
, make_string (name
, len
));
295 len
= font_unparse_fcname (entity
, size
, name
, 256);
297 ASET (font_object
, FONT_FULLNAME_INDEX
, make_string (name
, len
));
299 ASET (font_object
, FONT_FULLNAME_INDEX
,
300 AREF (font_object
, FONT_NAME_INDEX
));
301 ASET (font_object
, FONT_FILE_INDEX
, filename
);
302 ASET (font_object
, FONT_FORMAT_INDEX
,
303 ftfont_font_format (xftfont
->pattern
, filename
));
304 font
= XFONT_OBJECT (font_object
);
305 font
->pixel_size
= pixel_size
;
306 font
->driver
= &xftfont_driver
;
307 font
->encoding_charset
= font
->repertory_charset
= -1;
309 xftfont_info
= (struct xftfont_info
*) font
;
310 xftfont_info
->display
= display
;
311 xftfont_info
->screen
= FRAME_X_SCREEN_NUMBER (f
);
312 xftfont_info
->xftfont
= xftfont
;
313 font
->pixel_size
= size
;
314 font
->driver
= &xftfont_driver
;
315 if (INTEGERP (AREF (entity
, FONT_SPACING_INDEX
)))
316 spacing
= XINT (AREF (entity
, FONT_SPACING_INDEX
));
318 spacing
= FC_PROPORTIONAL
;
319 if (! ascii_printable
[0])
322 for (i
= 0; i
< 95; i
++)
323 ascii_printable
[i
] = ' ' + i
;
326 if (spacing
!= FC_PROPORTIONAL
)
328 font
->min_width
= font
->average_width
= font
->space_width
329 = xftfont
->max_advance_width
;
330 XftTextExtents8 (display
, xftfont
, ascii_printable
+ 1, 94, &extents
);
334 XftTextExtents8 (display
, xftfont
, ascii_printable
, 1, &extents
);
335 font
->space_width
= extents
.xOff
;
336 if (font
->space_width
<= 0)
337 /* dirty workaround */
338 font
->space_width
= pixel_size
;
339 XftTextExtents8 (display
, xftfont
, ascii_printable
+ 1, 94, &extents
);
340 font
->average_width
= (font
->space_width
+ extents
.xOff
) / 95;
344 font
->ascent
= xftfont
->ascent
;
345 font
->descent
= xftfont
->descent
;
348 /* The above condition is a dirty workaround because
349 XftTextExtents8 behaves strangely for some fonts
350 (e.g. "Dejavu Sans Mono") when pixel_size is less than 5. */
351 if (font
->ascent
< extents
.y
)
352 font
->ascent
= extents
.y
;
353 if (font
->descent
< extents
.height
- extents
.y
)
354 font
->descent
= extents
.height
- extents
.y
;
356 font
->height
= font
->ascent
+ font
->descent
;
358 if (XINT (AREF (entity
, FONT_SIZE_INDEX
)) == 0)
360 int upEM
= ft_face
->units_per_EM
;
362 font
->underline_position
= -ft_face
->underline_position
* size
/ upEM
;
363 font
->underline_thickness
= ft_face
->underline_thickness
* size
/ upEM
;
364 if (font
->underline_thickness
> 2)
365 font
->underline_position
-= font
->underline_thickness
/ 2;
369 font
->underline_position
= -1;
370 font
->underline_thickness
= 0;
373 xftfont_info
->maybe_otf
= ft_face
->face_flags
& FT_FACE_FLAG_SFNT
;
374 xftfont_info
->otf
= NULL
;
375 #endif /* HAVE_LIBOTF */
376 xftfont_info
->ft_size
= ft_face
->size
;
378 /* Unfortunately Xft doesn't provide a way to get minimum char
379 width. So, we use space_width instead. */
380 font
->min_width
= font
->space_width
;
382 font
->baseline_offset
= 0;
383 font
->relative_compose
= 0;
384 font
->default_ascent
= 0;
385 font
->vertical_centering
= 0;
387 if (! (ft_face
->face_flags
& FT_FACE_FLAG_SFNT
))
391 if (FT_Get_BDF_Property (ft_face
, "_MULE_BASELINE_OFFSET", &rec
) == 0
392 && rec
.type
== BDF_PROPERTY_TYPE_INTEGER
)
393 font
->baseline_offset
= rec
.u
.integer
;
394 if (FT_Get_BDF_Property (ft_face
, "_MULE_RELATIVE_COMPOSE", &rec
) == 0
395 && rec
.type
== BDF_PROPERTY_TYPE_INTEGER
)
396 font
->relative_compose
= rec
.u
.integer
;
397 if (FT_Get_BDF_Property (ft_face
, "_MULE_DEFAULT_ASCENT", &rec
) == 0
398 && rec
.type
== BDF_PROPERTY_TYPE_INTEGER
)
399 font
->default_ascent
= rec
.u
.integer
;
407 xftfont_close (f
, font
)
411 struct xftfont_info
*xftfont_info
= (struct xftfont_info
*) font
;
414 if (xftfont_info
->otf
)
415 OTF_close (xftfont_info
->otf
);
418 XftUnlockFace (xftfont_info
->xftfont
);
419 XftFontClose (xftfont_info
->display
, xftfont_info
->xftfont
);
424 xftfont_prepare_face (f
, face
)
428 struct xftface_info
*xftface_info
;
431 /* This doesn't work if face->ascii_face doesn't use an Xft font. */
432 if (face
!= face
->ascii_face
)
434 face
->extra
= face
->ascii_face
->extra
;
439 xftface_info
= malloc (sizeof (struct xftface_info
));
442 xftfont_get_colors (f
, face
, face
->gc
, NULL
,
443 &xftface_info
->xft_fg
, &xftface_info
->xft_bg
);
444 face
->extra
= xftface_info
;
449 xftfont_done_face (f
, face
)
453 struct xftface_info
*xftface_info
;
456 /* This doesn't work if face->ascii_face doesn't use an Xft font. */
457 if (face
!= face
->ascii_face
462 xftface_info
= (struct xftface_info
*) face
->extra
;
470 extern Lisp_Object Qja
, Qko
;
473 xftfont_has_char (font
, c
)
477 struct xftfont_info
*xftfont_info
;
478 struct charset
*cs
= NULL
;
480 if (FONT_ENTITY_P (font
))
481 return ftfont_driver
.has_char (font
, c
);
483 if (EQ (AREF (font
, FONT_ADSTYLE_INDEX
), Qja
)
484 && charset_jisx0208
>= 0)
485 cs
= CHARSET_FROM_ID (charset_jisx0208
);
486 else if (EQ (AREF (font
, FONT_ADSTYLE_INDEX
), Qko
)
487 && charset_ksc5601
>= 0)
488 cs
= CHARSET_FROM_ID (charset_ksc5601
);
490 return (ENCODE_CHAR (cs
, c
) != CHARSET_INVALID_CODE (cs
));
492 xftfont_info
= (struct xftfont_info
*) XFONT_OBJECT (font
);
493 return (XftCharExists (xftfont_info
->display
, xftfont_info
->xftfont
,
494 (FcChar32
) c
) == FcTrue
);
498 xftfont_encode_char (font
, c
)
502 struct xftfont_info
*xftfont_info
= (struct xftfont_info
*) font
;
503 unsigned code
= XftCharIndex (xftfont_info
->display
, xftfont_info
->xftfont
,
506 return (code
? code
: FONT_INVALID_CODE
);
510 xftfont_text_extents (font
, code
, nglyphs
, metrics
)
514 struct font_metrics
*metrics
;
516 struct xftfont_info
*xftfont_info
= (struct xftfont_info
*) font
;
520 XftGlyphExtents (xftfont_info
->display
, xftfont_info
->xftfont
, code
, nglyphs
,
525 metrics
->lbearing
= - extents
.x
;
526 metrics
->rbearing
= - extents
.x
+ extents
.width
;
527 metrics
->width
= extents
.xOff
;
528 metrics
->ascent
= extents
.y
;
529 metrics
->descent
= extents
.height
- extents
.y
;
535 xftfont_get_xft_draw (f
)
538 XftDraw
*xft_draw
= font_get_frame_data (f
, &xftfont_driver
);
543 xft_draw
= XftDrawCreate (FRAME_X_DISPLAY (f
),
546 FRAME_X_COLORMAP (f
));
550 font_put_frame_data (f
, &xftfont_driver
, xft_draw
);
556 xftfont_draw (s
, from
, to
, x
, y
, with_background
)
557 struct glyph_string
*s
;
558 int from
, to
, x
, y
, with_background
;
561 struct face
*face
= s
->face
;
562 struct xftfont_info
*xftfont_info
= (struct xftfont_info
*) s
->font
;
563 struct xftface_info
*xftface_info
= NULL
;
564 XftDraw
*xft_draw
= xftfont_get_xft_draw (f
);
570 if (s
->font
== face
->font
)
571 xftface_info
= (struct xftface_info
*) face
->extra
;
572 xftfont_get_colors (f
, face
, s
->gc
, xftface_info
,
573 &fg
, with_background
? &bg
: NULL
);
575 if (s
->num_clips
> 0)
576 XftDrawSetClipRectangles (xft_draw
, 0, 0, s
->clip
, s
->num_clips
);
578 XftDrawSetClip (xft_draw
, NULL
);
581 XftDrawRect (xft_draw
, &bg
,
582 x
, y
- face
->font
->ascent
, s
->width
, face
->font
->height
);
583 code
= alloca (sizeof (FT_UInt
) * len
);
584 for (i
= 0; i
< len
; i
++)
585 code
[i
] = ((XCHAR2B_BYTE1 (s
->char2b
+ from
+ i
) << 8)
586 | XCHAR2B_BYTE2 (s
->char2b
+ from
+ i
));
589 for (i
= 0; i
< len
; i
++)
590 XftDrawGlyphs (xft_draw
, &fg
, xftfont_info
->xftfont
,
591 x
+ i
, y
, code
+ i
, 1);
593 XftDrawGlyphs (xft_draw
, &fg
, xftfont_info
->xftfont
,
601 xftfont_end_for_frame (f
)
604 XftDraw
*xft_draw
= font_get_frame_data (f
, &xftfont_driver
);
609 XftDrawDestroy (xft_draw
);
611 font_put_frame_data (f
, &xftfont_driver
, NULL
);
619 DEFSYM (Qxft
, "xft");
620 DEFSYM (QChinting
, ":hinting");
621 DEFSYM (QCautohint
, ":autohint");
622 DEFSYM (QChintstyle
, ":hintstyle");
623 DEFSYM (QCrgba
, ":rgba");
624 DEFSYM (QCembolden
, ":embolden");
626 xftfont_driver
= ftfont_driver
;
627 xftfont_driver
.type
= Qxft
;
628 xftfont_driver
.get_cache
= xfont_driver
.get_cache
;
629 xftfont_driver
.list
= xftfont_list
;
630 xftfont_driver
.match
= xftfont_match
;
631 xftfont_driver
.open
= xftfont_open
;
632 xftfont_driver
.close
= xftfont_close
;
633 xftfont_driver
.prepare_face
= xftfont_prepare_face
;
634 xftfont_driver
.done_face
= xftfont_done_face
;
635 xftfont_driver
.has_char
= xftfont_has_char
;
636 xftfont_driver
.encode_char
= xftfont_encode_char
;
637 xftfont_driver
.text_extents
= xftfont_text_extents
;
638 xftfont_driver
.draw
= xftfont_draw
;
639 xftfont_driver
.end_for_frame
= xftfont_end_for_frame
;
641 register_font_driver (&xftfont_driver
, NULL
);
644 /* arch-tag: 64ec61bf-7c8e-4fe6-b953-c6a85d5e1605
645 (do not change this comment) */