1 /* xftfont.c -- XFT font driver.
2 Copyright (C) 2006, 2007, 2008 Free Software Foundation, Inc.
3 Copyright (C) 2006, 2007, 2008
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
;
42 /* The actual structure for Xft font that can be casted to struct
52 int maybe_otf
; /* Flag to tell if this may be OTF or not. */
54 #endif /* HAVE_LIBOTF */
57 /* Structure pointed by (struct face *)->extra */
61 XftColor xft_fg
; /* color for face->foreground */
62 XftColor xft_bg
; /* color for face->background */
65 static void xftfont_get_colors
P_ ((FRAME_PTR
, struct face
*, GC gc
,
66 struct xftface_info
*,
67 XftColor
*fg
, XftColor
*bg
));
70 /* Setup foreground and background colors of GC into FG and BG. If
71 XFTFACE_INFO is not NULL, reuse the colors in it if possible. BG
75 xftfont_get_colors (f
, face
, gc
, xftface_info
, fg
, bg
)
79 struct xftface_info
*xftface_info
;
82 if (xftface_info
&& face
->gc
== gc
)
84 *fg
= xftface_info
->xft_fg
;
86 *bg
= xftface_info
->xft_bg
;
91 int fg_done
= 0, bg_done
= 0;
94 XGetGCValues (FRAME_X_DISPLAY (f
), gc
,
95 GCForeground
| GCBackground
, &xgcv
);
98 if (xgcv
.foreground
== face
->foreground
)
99 *fg
= xftface_info
->xft_fg
, fg_done
= 1;
100 else if (xgcv
.foreground
== face
->background
)
101 *fg
= xftface_info
->xft_bg
, fg_done
= 1;
104 else if (xgcv
.background
== face
->background
)
105 *bg
= xftface_info
->xft_bg
, bg_done
= 1;
106 else if (xgcv
.background
== face
->foreground
)
107 *bg
= xftface_info
->xft_fg
, bg_done
= 1;
110 if (fg_done
+ bg_done
< 2)
114 colors
[0].pixel
= fg
->pixel
= xgcv
.foreground
;
116 colors
[1].pixel
= bg
->pixel
= xgcv
.background
;
117 XQueryColors (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
), colors
,
119 fg
->color
.alpha
= 0xFFFF;
120 fg
->color
.red
= colors
[0].red
;
121 fg
->color
.green
= colors
[0].green
;
122 fg
->color
.blue
= colors
[0].blue
;
125 bg
->color
.alpha
= 0xFFFF;
126 bg
->color
.red
= colors
[1].red
;
127 bg
->color
.green
= colors
[1].green
;
128 bg
->color
.blue
= colors
[1].blue
;
136 static Lisp_Object xftfont_list
P_ ((Lisp_Object
, Lisp_Object
));
137 static Lisp_Object xftfont_match
P_ ((Lisp_Object
, Lisp_Object
));
138 static Lisp_Object xftfont_open
P_ ((FRAME_PTR
, Lisp_Object
, int));
139 static void xftfont_close
P_ ((FRAME_PTR
, struct font
*));
140 static int xftfont_prepare_face
P_ ((FRAME_PTR
, struct face
*));
141 static void xftfont_done_face
P_ ((FRAME_PTR
, struct face
*));
142 static unsigned xftfont_encode_char
P_ ((struct font
*, int));
143 static int xftfont_text_extents
P_ ((struct font
*, unsigned *, int,
144 struct font_metrics
*));
145 static int xftfont_draw
P_ ((struct glyph_string
*, int, int, int, int, int));
147 static int xftfont_anchor_point
P_ ((struct font
*, unsigned, int,
149 static int xftfont_end_for_frame
P_ ((FRAME_PTR f
));
151 struct font_driver xftfont_driver
;
154 xftfont_list (frame
, spec
)
158 Lisp_Object list
= ftfont_driver
.list (frame
, spec
), tail
;
160 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
161 ASET (XCAR (tail
), FONT_TYPE_INDEX
, Qxft
);
166 xftfont_match (frame
, spec
)
170 Lisp_Object entity
= ftfont_driver
.match (frame
, spec
);
173 ASET (entity
, FONT_TYPE_INDEX
, Qxft
);
177 extern Lisp_Object ftfont_font_format
P_ ((FcPattern
*));
179 static FcChar8 ascii_printable
[95];
182 xftfont_open (f
, entity
, pixel_size
)
187 Display
*display
= FRAME_X_DISPLAY (f
);
188 Lisp_Object val
, filename
, cache
, font_object
;
189 FcPattern
*pat
= NULL
;
190 struct xftfont_info
*xftfont_info
= NULL
;
193 XftFont
*xftfont
= NULL
;
200 val
= assq_no_quit (QCfont_entity
, AREF (entity
, FONT_EXTRA_INDEX
));
204 filename
= XCAR (val
);
205 size
= XINT (AREF (entity
, FONT_SIZE_INDEX
));
208 pat
= FcPatternCreate ();
209 FcPatternAddString (pat
, FC_FILE
, (FcChar8
*) SDATA (filename
));
210 FcPatternAddDouble (pat
, FC_PIXEL_SIZE
, pixel_size
);
211 /*FcPatternAddBool (pat, FC_ANTIALIAS, FcTrue);*/
212 val
= AREF (entity
, FONT_FAMILY_INDEX
);
214 FcPatternAddString (pat
, FC_FAMILY
, (FcChar8
*) SDATA (SYMBOL_NAME (val
)));
215 FcConfigSubstitute (NULL
, pat
, FcMatchPattern
);
218 XftDefaultSubstitute (display
, FRAME_X_SCREEN_NUMBER (f
), pat
);
219 xftfont
= XftFontOpenPattern (display
, pat
);
223 /* We should not destroy PAT here because it is kept in XFTFONT and
224 destroyed automatically when XFTFONT is closed. */
225 font_object
= font_make_object (VECSIZE (struct xftfont_info
));
226 ASET (font_object
, FONT_TYPE_INDEX
, Qxft
);
227 for (i
= 1; i
< FONT_ENTITY_MAX
; i
++)
228 ASET (font_object
, i
, AREF (entity
, i
));
229 ASET (font_object
, FONT_SIZE_INDEX
, make_number (size
));
230 len
= font_unparse_xlfd (entity
, size
, name
, 256);
232 ASET (font_object
, FONT_NAME_INDEX
, make_unibyte_string (name
, len
));
233 len
= font_unparse_fcname (entity
, size
, name
, 256);
235 ASET (font_object
, FONT_FULLNAME_INDEX
, make_unibyte_string (name
, len
));
237 ASET (font_object
, FONT_FULLNAME_INDEX
,
238 AREF (font_object
, FONT_NAME_INDEX
));
239 ASET (font_object
, FONT_FILE_INDEX
, filename
);
240 ASET (font_object
, FONT_FORMAT_INDEX
,
241 ftfont_font_format (xftfont
->pattern
));
242 font
= XFONT_OBJECT (font_object
);
243 font
->pixel_size
= pixel_size
;
244 font
->driver
= &xftfont_driver
;
245 font
->encoding_charset
= font
->repertory_charset
= -1;
247 xftfont_info
= (struct xftfont_info
*) font
;
248 xftfont_info
->display
= display
;
249 xftfont_info
->screen
= FRAME_X_SCREEN_NUMBER (f
);
250 xftfont_info
->xftfont
= xftfont
;
251 font
->pixel_size
= size
;
252 font
->driver
= &xftfont_driver
;
253 if (INTEGERP (AREF (entity
, FONT_SPACING_INDEX
)))
254 spacing
= XINT (AREF (entity
, FONT_SPACING_INDEX
));
256 spacing
= FC_PROPORTIONAL
;
257 if (! ascii_printable
[0])
260 for (i
= 0; i
< 95; i
++)
261 ascii_printable
[i
] = ' ' + i
;
264 if (spacing
!= FC_PROPORTIONAL
)
266 font
->min_width
= font
->average_width
= font
->space_width
267 = xftfont
->max_advance_width
;
268 XftTextExtents8 (display
, xftfont
, ascii_printable
+ 1, 94, &extents
);
272 XftTextExtents8 (display
, xftfont
, ascii_printable
, 1, &extents
);
273 font
->space_width
= extents
.xOff
;
274 if (font
->space_width
<= 0)
275 /* dirty workaround */
276 font
->space_width
= pixel_size
;
277 XftTextExtents8 (display
, xftfont
, ascii_printable
+ 1, 94, &extents
);
278 font
->average_width
= (font
->space_width
+ extents
.xOff
) / 95;
282 font
->ascent
= xftfont
->ascent
;
283 if (font
->ascent
< extents
.y
)
284 font
->ascent
= extents
.y
;
285 font
->descent
= xftfont
->descent
;
286 if (font
->descent
< extents
.height
- extents
.y
)
287 font
->descent
= extents
.height
- extents
.y
;
288 font
->height
= font
->ascent
+ font
->descent
;
290 ft_face
= XftLockFace (xftfont
);
291 if (XINT (AREF (entity
, FONT_SIZE_INDEX
)) == 0)
293 int upEM
= ft_face
->units_per_EM
;
295 font
->underline_position
= -ft_face
->underline_position
* size
/ upEM
;
296 font
->underline_thickness
= -ft_face
->underline_thickness
* size
/ upEM
;
300 font
->underline_position
= -1;
301 font
->underline_thickness
= 0;
304 xftfont_info
->maybe_otf
= ft_face
->face_flags
& FT_FACE_FLAG_SFNT
;
305 xftfont_info
->otf
= NULL
;
306 #endif /* HAVE_LIBOTF */
307 XftUnlockFace (xftfont
);
309 /* Unfortunately Xft doesn't provide a way to get minimum char
310 width. So, we use space_width instead. */
311 font
->min_width
= font
->space_width
;
313 font
->baseline_offset
= 0;
314 font
->relative_compose
= 0;
315 font
->default_ascent
= 0;
316 font
->vertical_centering
= 0;
322 xftfont_close (f
, font
)
326 struct xftfont_info
*xftfont_info
= (struct xftfont_info
*) font
;
329 if (xftfont_info
->otf
)
330 OTF_close (xftfont_info
->otf
);
333 XftFontClose (xftfont_info
->display
, xftfont_info
->xftfont
);
338 xftfont_prepare_face (f
, face
)
342 struct xftface_info
*xftface_info
;
345 /* This doesn't work if face->ascii_face doesn't use an Xft font. */
346 if (face
!= face
->ascii_face
)
348 face
->extra
= face
->ascii_face
->extra
;
353 xftface_info
= malloc (sizeof (struct xftface_info
));
356 xftfont_get_colors (f
, face
, face
->gc
, NULL
,
357 &xftface_info
->xft_fg
, &xftface_info
->xft_bg
);
358 face
->extra
= xftface_info
;
363 xftfont_done_face (f
, face
)
367 struct xftface_info
*xftface_info
;
370 /* This doesn't work if face->ascii_face doesn't use an Xft font. */
371 if (face
!= face
->ascii_face
376 xftface_info
= (struct xftface_info
*) face
->extra
;
385 xftfont_encode_char (font
, c
)
389 struct xftfont_info
*xftfont_info
= (struct xftfont_info
*) font
;
390 unsigned code
= XftCharIndex (xftfont_info
->display
, xftfont_info
->xftfont
,
393 return (code
? code
: FONT_INVALID_CODE
);
397 xftfont_text_extents (font
, code
, nglyphs
, metrics
)
401 struct font_metrics
*metrics
;
403 struct xftfont_info
*xftfont_info
= (struct xftfont_info
*) font
;
407 XftGlyphExtents (xftfont_info
->display
, xftfont_info
->xftfont
, code
, nglyphs
,
412 metrics
->lbearing
= - extents
.x
;
413 metrics
->rbearing
= - extents
.x
+ extents
.width
;
414 metrics
->width
= extents
.xOff
;
415 metrics
->ascent
= extents
.y
;
416 metrics
->descent
= extents
.height
- extents
.y
;
422 xftfont_get_xft_draw (f
)
425 XftDraw
*xft_draw
= font_get_frame_data (f
, &xftfont_driver
);;
430 xft_draw
= XftDrawCreate (FRAME_X_DISPLAY (f
),
433 FRAME_X_COLORMAP (f
));
437 font_put_frame_data (f
, &xftfont_driver
, xft_draw
);
443 xftfont_draw (s
, from
, to
, x
, y
, with_background
)
444 struct glyph_string
*s
;
445 int from
, to
, x
, y
, with_background
;
448 struct face
*face
= s
->face
;
449 struct xftfont_info
*xftfont_info
= (struct xftfont_info
*) s
->font
;
450 struct xftface_info
*xftface_info
= NULL
;
451 XftDraw
*xft_draw
= xftfont_get_xft_draw (f
);
457 if (s
->font
== face
->font
)
458 xftface_info
= (struct xftface_info
*) face
->extra
;
459 xftfont_get_colors (f
, face
, s
->gc
, xftface_info
,
460 &fg
, with_background
? &bg
: NULL
);
462 if (s
->num_clips
> 0)
463 XftDrawSetClipRectangles (xft_draw
, 0, 0, s
->clip
, s
->num_clips
);
465 XftDrawSetClip (xft_draw
, NULL
);
468 XftDrawRect (xft_draw
, &bg
,
469 x
, y
- face
->font
->ascent
, s
->width
, face
->font
->height
);
470 code
= alloca (sizeof (FT_UInt
) * len
);
471 for (i
= 0; i
< len
; i
++)
472 code
[i
] = ((XCHAR2B_BYTE1 (s
->char2b
+ from
+ i
) << 8)
473 | XCHAR2B_BYTE2 (s
->char2b
+ from
+ i
));
476 for (i
= 0; i
< len
; i
++)
477 XftDrawGlyphs (xft_draw
, &fg
, xftfont_info
->xftfont
,
478 x
+ i
, y
, code
+ i
, 1);
480 XftDrawGlyphs (xft_draw
, &fg
, xftfont_info
->xftfont
,
488 xftfont_anchor_point (font
, code
, index
, x
, y
)
494 struct xftfont_info
*xftfont_info
= (struct xftfont_info
*) font
;
495 FT_Face ft_face
= XftLockFace (xftfont_info
->xftfont
);
498 if (FT_Load_Glyph (ft_face
, code
, FT_LOAD_DEFAULT
) != 0)
500 else if (ft_face
->glyph
->format
!= FT_GLYPH_FORMAT_OUTLINE
)
502 else if (index
>= ft_face
->glyph
->outline
.n_points
)
506 *x
= ft_face
->glyph
->outline
.points
[index
].x
;
507 *y
= ft_face
->glyph
->outline
.points
[index
].y
;
509 XftUnlockFace (xftfont_info
->xftfont
);
514 xftfont_end_for_frame (f
)
517 XftDraw
*xft_draw
= font_get_frame_data (f
, &xftfont_driver
);
522 XftDrawDestroy (xft_draw
);
524 font_put_frame_data (f
, &xftfont_driver
, NULL
);
532 xftfont_shape (lgstring
)
533 Lisp_Object lgstring
;
536 struct xftfont_info
*xftfont_info
;
540 CHECK_FONT_GET_OBJECT (LGSTRING_FONT (lgstring
), font
);
541 xftfont_info
= (struct xftfont_info
*) font
;
542 if (! xftfont_info
->maybe_otf
)
544 ft_face
= XftLockFace (xftfont_info
->xftfont
);
545 if (! xftfont_info
->otf
)
547 OTF
*otf
= OTF_open_ft_face (ft_face
);
549 if (! otf
|| OTF_get_table (otf
, "head") < 0)
553 xftfont_info
->maybe_otf
= 0;
554 XftUnlockFace (xftfont_info
->xftfont
);
557 xftfont_info
->otf
= otf
;
560 result
= ftfont_shape_by_flt (lgstring
, font
, ft_face
, xftfont_info
->otf
);
561 XftUnlockFace (xftfont_info
->xftfont
);
564 #endif /* HAVE_M17N_FLT */
565 #endif /* HAVE_LIBOTF */
570 DEFSYM (Qxft
, "xft");
572 xftfont_driver
= ftfont_driver
;
573 xftfont_driver
.type
= Qxft
;
574 xftfont_driver
.get_cache
= xfont_driver
.get_cache
;
575 xftfont_driver
.list
= xftfont_list
;
576 xftfont_driver
.match
= xftfont_match
;
577 xftfont_driver
.open
= xftfont_open
;
578 xftfont_driver
.close
= xftfont_close
;
579 xftfont_driver
.prepare_face
= xftfont_prepare_face
;
580 xftfont_driver
.done_face
= xftfont_done_face
;
581 xftfont_driver
.encode_char
= xftfont_encode_char
;
582 xftfont_driver
.text_extents
= xftfont_text_extents
;
583 xftfont_driver
.draw
= xftfont_draw
;
584 xftfont_driver
.anchor_point
= xftfont_anchor_point
;
585 xftfont_driver
.end_for_frame
= xftfont_end_for_frame
;
588 xftfont_driver
.shape
= xftfont_shape
;
589 #endif /* HAVE_M17N_FLT */
590 #endif /* HAVE_LIBOTF */
592 register_font_driver (&xftfont_driver
, NULL
);
595 /* arch-tag: 64ec61bf-7c8e-4fe6-b953-c6a85d5e1605
596 (do not change this comment) */