2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 // Necessary for supporting pango_context_new() and
21 // pango_context_set_font_map() in Pango < 1.22
22 #define PANGO_ENABLE_BACKEND
24 #include <pango/pangoft2.h>
25 #include "freetype.hh"
33 #include "pango-font.hh"
34 #include "dimensions.hh"
35 #include "file-name.hh"
36 #include "international.hh"
37 #include "lookup.hh" // debugging
38 #include "ly-module.hh"
40 #include "string-convert.hh"
42 #include "all-font-metrics.hh"
43 #include "program-option.hh"
44 #include "open-type-font.hh"
50 Pango_font::pre_init ()
52 physical_font_tab_ = SCM_EOL;
55 Pango_font::Pango_font (PangoFT2FontMap *fontmap,
56 PangoFontDescription const *description,
59 physical_font_tab_ = scm_c_make_hash_table (11);
60 PangoDirection pango_dir = PANGO_DIRECTION_LTR;
61 context_ = pango_context_new ();
62 pango_context_set_font_map (context_, PANGO_FONT_MAP (fontmap));
64 pango_description_ = pango_font_description_copy (description);
65 attribute_list_ = pango_attr_list_new ();
67 // urgh. I don't understand this. Why isn't this 1/(scale *
68 // resolution * output_scale)
71 output_scale_ = output_scale;
73 / (Real (PANGO_SCALE) * Real (PANGO_RESOLUTION) * output_scale);
75 // ugh. Should make this configurable.
76 pango_context_set_language (context_, pango_language_from_string ("en_US"));
77 pango_context_set_base_dir (context_, pango_dir);
78 pango_context_set_font_description (context_, description);
81 Pango_font::~Pango_font ()
83 pango_font_description_free (pango_description_);
84 g_object_unref (context_);
85 pango_attr_list_unref (attribute_list_);
89 Pango_font::register_font_file (const string &filename,
90 const string &ps_name,
93 scm_hash_set_x (physical_font_tab_,
94 ly_string2scm (ps_name),
95 scm_list_2 (ly_string2scm (filename),
96 scm_from_int (face_index)));
100 Pango_font::name_to_index (string nm) const
102 PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
103 FT_Face face = pango_fc_font_lock_face (fcfont);
104 char *nm_str = (char *) nm.c_str ();
105 if (FT_UInt idx = FT_Get_Name_Index (face, nm_str))
107 pango_fc_font_unlock_face (fcfont);
111 pango_fc_font_unlock_face (fcfont);
116 Pango_font::derived_mark () const
118 scm_gc_mark (physical_font_tab_);
122 get_glyph_index_name (char *s,
125 sprintf (s, "glyphIndex%lX", code);
129 get_unicode_name (char *s,
133 sprintf (s, "u%lX", code);
135 sprintf (s, "uni%04lX", code);
139 Pango_font::get_unscaled_indexed_char_dimensions (size_t signed_idx) const
141 PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
142 FT_Face face = pango_fc_font_lock_face (fcfont);
143 Box b = ly_FT_get_unscaled_indexed_char_dimensions (face, signed_idx);
144 pango_fc_font_unlock_face (fcfont);
149 Pango_font::get_scaled_indexed_char_dimensions (size_t signed_idx) const
151 PangoFont *font = pango_context_load_font (context_, pango_description_);
152 PangoRectangle logical_rect;
153 PangoRectangle ink_rect;
154 pango_font_get_glyph_extents (font, signed_idx, &ink_rect, &logical_rect);
155 Box out (Interval (PANGO_LBEARING (ink_rect),
156 PANGO_RBEARING (ink_rect)),
157 Interval (-PANGO_DESCENT (ink_rect),
158 PANGO_ASCENT (ink_rect)));
164 Pango_font::get_glyph_outline_bbox (size_t signed_idx) const
166 PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
167 FT_Face face = pango_fc_font_lock_face (fcfont);
168 Box b = ly_FT_get_glyph_outline_bbox (face, signed_idx);
169 pango_fc_font_unlock_face (fcfont);
174 Pango_font::get_glyph_outline (size_t signed_idx) const
176 PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
177 FT_Face face = pango_fc_font_lock_face (fcfont);
178 SCM s = ly_FT_get_glyph_outline (face, signed_idx);
179 pango_fc_font_unlock_face (fcfont);
184 Pango_font::pango_item_string_stencil (PangoGlyphItem const *glyph_item) const
186 const int GLYPH_NAME_LEN = 256;
187 char glyph_name[GLYPH_NAME_LEN];
189 PangoAnalysis const *pa = &(glyph_item->item->analysis);
190 PangoGlyphString *pgs = glyph_item->glyphs;
192 PangoRectangle logical_rect;
193 PangoRectangle ink_rect;
194 pango_glyph_string_extents (pgs, pa->font, &ink_rect, &logical_rect);
196 PangoFcFont *fcfont = PANGO_FC_FONT (pa->font);
197 FT_Face ftface = pango_fc_font_lock_face (fcfont);
199 Box b (Interval (PANGO_LBEARING (logical_rect),
200 PANGO_RBEARING (logical_rect)),
201 Interval (-PANGO_DESCENT (ink_rect),
202 PANGO_ASCENT (ink_rect)));
206 const string ps_name_str0 = get_postscript_name (ftface);
207 FcPattern *fcpat = fcfont->font_pattern;
209 FcChar8 *file_name_as_ptr = 0;
210 FcPatternGetString (fcpat, FC_FILE, 0, &file_name_as_ptr);
212 // due to a bug in FreeType 2.3.7 and earlier we can't use
213 // ftface->face_index; it is always zero for some font formats,
214 // in particular TTCs which we are interested in
216 FcPatternGetInteger (fcpat, FC_INDEX, 0, &face_index);
219 if (file_name_as_ptr)
220 // Normalize file name.
221 file_name = File_name ((char const *)file_name_as_ptr).to_string ();
223 SCM glyph_exprs = SCM_EOL;
224 SCM *tail = &glyph_exprs;
226 Index_to_charcode_map const *cmap = 0;
227 bool has_glyph_names = ftface->face_flags & FT_FACE_FLAG_GLYPH_NAMES;
228 if (!has_glyph_names)
229 cmap = all_fonts_global->get_index_to_charcode_map (file_name, face_index, ftface);
231 bool is_ttf = string (FT_Get_X11_Font_Format (ftface)) == "TrueType";
232 bool cid_keyed = false;
234 for (int i = 0; i < pgs->num_glyphs; i++)
236 PangoGlyphInfo *pgi = pgs->glyphs + i;
238 PangoGlyph pg = pgi->glyph;
239 PangoGlyphGeometry ggeo = pgi->geometry;
242 Zero-width characters are valid Unicode characters,
243 but glyph lookups need to be skipped.
245 if (!(pg ^ PANGO_GLYPH_EMPTY))
248 if (pg & PANGO_GLYPH_UNKNOWN_FLAG)
250 warning (_f ("no glyph for character U+%0X in font `%s'",
251 pg & ~PANGO_GLYPH_UNKNOWN_FLAG, file_name.c_str ()));
255 glyph_name[0] = '\0';
258 FT_Error errorcode = FT_Get_Glyph_Name (ftface, pg, glyph_name,
261 programming_error (_f ("FT_Get_Glyph_Name () error: %s",
262 freetype_error_string (errorcode).c_str ()));
265 SCM char_id = SCM_EOL;
266 if (glyph_name[0] == '\0'
269 && cmap->find (pg) != cmap->end ())
271 FT_ULong char_code = cmap->find (pg)->second;
272 get_unicode_name (glyph_name, char_code);
275 if (glyph_name[0] == '\0' && has_glyph_names)
277 programming_error (_f ("Glyph has no name, but font supports glyph naming.\n"
278 "Skipping glyph U+%0X, file %s",
279 pg, file_name.c_str ()));
283 if (glyph_name == string (".notdef") && is_ttf)
284 glyph_name[0] = '\0';
286 if (glyph_name[0] == '\0' && is_ttf)
287 // Access by glyph index directly.
288 get_glyph_index_name (glyph_name, pg);
290 if (glyph_name[0] == '\0')
294 char_id = scm_from_uint32 (pg);
297 char_id = scm_from_utf8_string (glyph_name);
299 PangoRectangle logical_sub_rect;
300 PangoRectangle ink_sub_rect;
302 pango_glyph_string_extents_range (pgs, i, i + 1, pa->font, &ink_sub_rect, &logical_sub_rect);
303 Box b_sub (Interval (PANGO_LBEARING (logical_sub_rect),
304 PANGO_RBEARING (logical_sub_rect)),
305 Interval (-PANGO_DESCENT (ink_sub_rect),
306 PANGO_ASCENT (ink_sub_rect)));
308 b_sub.scale (scale_);
310 *tail = scm_cons (scm_list_5 (scm_from_double (b_sub[X_AXIS][RIGHT] - b_sub[X_AXIS][LEFT]),
311 scm_cons (scm_from_double (b_sub[Y_AXIS][DOWN]),
312 scm_from_double (b_sub[Y_AXIS][UP])),
313 scm_from_double (ggeo.x_offset * scale_),
314 scm_from_double (- ggeo.y_offset * scale_),
317 tail = SCM_CDRLOC (*tail);
319 pango_fc_font_unlock_face (fcfont);
320 pango_glyph_string_free (pgs);
322 PangoFontDescription *descr = pango_font_describe (pa->font);
323 Real size = pango_font_description_get_size (descr)
324 / (Real (PANGO_SCALE));
326 if (ps_name_str0.empty ())
327 warning (_f ("no PostScript font name for font `%s'", file_name));
330 if (ps_name_str0.empty ()
332 && (file_name.find (".otf") != NPOS
333 || file_name.find (".cff") != NPOS))
335 // UGH: kludge a PS name for OTF/CFF fonts.
336 string name = file_name;
337 ssize idx = file_name.find (".otf");
339 idx = file_name.find (".cff");
341 name = name.substr (0, idx);
343 ssize slash_idx = name.rfind ('/');
344 if (slash_idx != NPOS)
347 name = name.substr (slash_idx,
348 name.length () - slash_idx);
351 string initial = name.substr (0, 1);
352 initial = String_convert::to_upper (initial);
353 name = name.substr (1, name.length () - 1);
354 name = String_convert::to_lower (name);
355 ps_name = initial + name;
357 else if (!ps_name_str0.empty ())
358 ps_name = ps_name_str0;
360 if (ps_name.length ())
362 ((Pango_font *) this)->register_font_file (file_name,
366 SCM expr = scm_list_n (ly_symbol2scm ("glyph-string"),
368 ly_string2scm (ps_name),
369 scm_from_double (size),
370 scm_from_bool (cid_keyed),
371 ly_quote_scm (glyph_exprs),
374 return Stencil (b, expr);
377 warning (_ ("FreeType face has no PostScript font name"));
382 Pango_font::physical_font_tab () const
384 return physical_font_tab_;
387 extern bool music_strings_to_paths;
390 Pango_font::text_stencil (Output_def * /* state */,
391 const string &str, bool music_string) const
394 The text assigned to a PangoLayout is automatically divided
395 into sections and reordered according to the Unicode
396 Bidirectional Algorithm, if necessary.
398 PangoLayout *layout = pango_layout_new (context_);
399 pango_layout_set_text (layout, str.c_str (), -1);
400 GSList *lines = pango_layout_get_lines (layout);
405 for (GSList *l = lines; l; l = l->next)
407 PangoLayoutLine *line = (PangoLayoutLine *) l->data;
408 GSList *layout_runs = line->runs;
410 for (GSList *p = layout_runs; p; p = p->next)
412 PangoGlyphItem *item = (PangoGlyphItem *) p->data;
413 Stencil item_stencil = pango_item_string_stencil (item);
415 item_stencil.translate_axis (last_x, X_AXIS);
416 last_x = item_stencil.extent (X_AXIS)[RIGHT];
418 #if 0 // Check extents.
419 if (!item_stencil.extent_box ()[X_AXIS].is_empty ())
421 Stencil frame = Lookup::frame (item_stencil.extent_box (), 0.1, 0.1);
424 Stencil dimless_frame (empty, frame.expr ());
425 dest.add_stencil (frame);
429 dest.add_stencil (item_stencil);
433 string name = get_output_backend_name ();
434 string output_mod = "scm output-" + name;
435 SCM mod = scm_c_resolve_module (output_mod.c_str ());
437 bool has_utf8_string = false;
439 if (ly_is_module (mod))
441 SCM utf8_string = ly_module_lookup (mod, ly_symbol2scm ("utf-8-string"));
443 has_utf8_string should only be true when utf8_string is a
444 variable that is bound to a *named* procedure, i.e. not a
447 if (scm_is_true (utf8_string)
448 && scm_is_true (scm_procedure_name (SCM_VARIABLE_REF (utf8_string))))
449 has_utf8_string = true;
452 bool to_paths = music_strings_to_paths;
455 Backends with the utf-8-string expression use it when
456 1) the -dmusic-strings-to-paths option is set
457 and `str' is not a music string, or
458 2) the -dmusic-strings-to-paths option is not set.
460 if (has_utf8_string && ((to_paths && !music_string) || !to_paths))
462 // For Pango based backends, we take a shortcut.
463 SCM exp = scm_list_3 (ly_symbol2scm ("utf-8-string"),
464 ly_string2scm (description_string ()),
465 ly_string2scm (str));
467 Box b (Interval (0, 0), Interval (0, 0));
468 b.unite (dest.extent_box ());
469 return Stencil (b, exp);
476 Pango_font::description_string () const
478 char *descr_string = pango_font_description_to_string (pango_description_);
479 string s (descr_string);
480 g_free (descr_string);
485 Pango_font::font_file_name () const
490 #endif // HAVE_PANGO_FT2