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"
48 Pango_font::Pango_font (PangoFT2FontMap *fontmap,
49 PangoFontDescription const *description,
52 // This line looks stupid, but if we don't initialize physical_font_tab_ before
53 // we allocate memory in scm_c_make_hash_table, then that could trigger a garbage
55 physical_font_tab_ = SCM_EOL;
56 physical_font_tab_ = scm_c_make_hash_table (11);
57 PangoDirection pango_dir = PANGO_DIRECTION_LTR;
58 context_ = pango_context_new ();
59 pango_context_set_font_map (context_, PANGO_FONT_MAP (fontmap));
61 pango_description_ = pango_font_description_copy (description);
62 attribute_list_ = pango_attr_list_new ();
64 // urgh. I don't understand this. Why isn't this 1/(scale *
65 // resolution * output_scale)
68 output_scale_ = output_scale;
70 / (Real (PANGO_SCALE) * Real (PANGO_RESOLUTION) * output_scale);
72 // ugh. Should make this configurable.
73 pango_context_set_language (context_, pango_language_from_string ("en_US"));
74 pango_context_set_base_dir (context_, pango_dir);
75 pango_context_set_font_description (context_, description);
78 Pango_font::~Pango_font ()
80 pango_font_description_free (pango_description_);
81 g_object_unref (context_);
82 pango_attr_list_unref (attribute_list_);
86 Pango_font::register_font_file (const string &filename,
87 const string &ps_name,
90 scm_hash_set_x (physical_font_tab_,
91 ly_string2scm (ps_name),
92 scm_list_2 (ly_string2scm (filename),
93 scm_from_int (face_index)));
97 Pango_font::name_to_index (string nm) const
99 PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
100 FT_Face face = pango_fc_font_lock_face (fcfont);
101 char *nm_str = (char *) nm.c_str ();
102 if (FT_UInt idx = FT_Get_Name_Index (face, nm_str))
104 pango_fc_font_unlock_face (fcfont);
108 pango_fc_font_unlock_face (fcfont);
113 Pango_font::derived_mark () const
115 scm_gc_mark (physical_font_tab_);
119 get_glyph_index_name (char *s,
122 sprintf (s, "glyphIndex%lX", code);
126 get_unicode_name (char *s,
130 sprintf (s, "u%lX", code);
132 sprintf (s, "uni%04lX", code);
136 Pango_font::get_unscaled_indexed_char_dimensions (size_t signed_idx) const
138 PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
139 FT_Face face = pango_fc_font_lock_face (fcfont);
140 Box b = ly_FT_get_unscaled_indexed_char_dimensions (face, signed_idx);
141 pango_fc_font_unlock_face (fcfont);
146 Pango_font::get_scaled_indexed_char_dimensions (size_t signed_idx) const
148 PangoFont *font = pango_context_load_font (context_, pango_description_);
149 PangoRectangle logical_rect;
150 PangoRectangle ink_rect;
151 pango_font_get_glyph_extents (font, signed_idx, &ink_rect, &logical_rect);
152 Box out (Interval (PANGO_LBEARING (ink_rect),
153 PANGO_RBEARING (ink_rect)),
154 Interval (-PANGO_DESCENT (ink_rect),
155 PANGO_ASCENT (ink_rect)));
161 Pango_font::get_glyph_outline_bbox (size_t signed_idx) const
163 PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
164 FT_Face face = pango_fc_font_lock_face (fcfont);
165 Box b = ly_FT_get_glyph_outline_bbox (face, signed_idx);
166 pango_fc_font_unlock_face (fcfont);
171 Pango_font::get_glyph_outline (size_t signed_idx) const
173 PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
174 FT_Face face = pango_fc_font_lock_face (fcfont);
175 SCM s = ly_FT_get_glyph_outline (face, signed_idx);
176 pango_fc_font_unlock_face (fcfont);
181 Pango_font::pango_item_string_stencil (PangoGlyphItem const *glyph_item) const
183 const int GLYPH_NAME_LEN = 256;
184 char glyph_name[GLYPH_NAME_LEN];
186 PangoAnalysis const *pa = &(glyph_item->item->analysis);
187 PangoGlyphString *pgs = glyph_item->glyphs;
189 PangoRectangle logical_rect;
190 PangoRectangle ink_rect;
191 pango_glyph_string_extents (pgs, pa->font, &ink_rect, &logical_rect);
193 PangoFcFont *fcfont = PANGO_FC_FONT (pa->font);
194 FT_Face ftface = pango_fc_font_lock_face (fcfont);
196 Box b (Interval (PANGO_LBEARING (logical_rect),
197 PANGO_RBEARING (logical_rect)),
198 Interval (-PANGO_DESCENT (ink_rect),
199 PANGO_ASCENT (ink_rect)));
203 char const *ps_name_str0 = FT_Get_Postscript_Name (ftface);
204 FcPattern *fcpat = fcfont->font_pattern;
206 FcChar8 *file_name_as_ptr = 0;
207 FcPatternGetString (fcpat, FC_FILE, 0, &file_name_as_ptr);
209 // due to a bug in FreeType 2.3.7 and earlier we can't use
210 // ftface->face_index; it is always zero for some font formats,
211 // in particular TTCs which we are interested in
213 FcPatternGetInteger (fcpat, FC_INDEX, 0, &face_index);
216 if (file_name_as_ptr)
217 // Normalize file name.
218 file_name = File_name ((char const *)file_name_as_ptr).to_string ();
220 SCM glyph_exprs = SCM_EOL;
221 SCM *tail = &glyph_exprs;
223 Index_to_charcode_map const *cmap = 0;
224 bool has_glyph_names = ftface->face_flags & FT_FACE_FLAG_GLYPH_NAMES;
225 if (!has_glyph_names)
226 cmap = all_fonts_global->get_index_to_charcode_map (file_name, face_index, ftface);
228 bool is_ttf = string (FT_Get_X11_Font_Format (ftface)) == "TrueType";
229 bool cid_keyed = false;
231 for (int i = 0; i < pgs->num_glyphs; i++)
233 PangoGlyphInfo *pgi = pgs->glyphs + i;
235 PangoGlyph pg = pgi->glyph;
236 PangoGlyphGeometry ggeo = pgi->geometry;
239 Zero-width characters are valid Unicode characters,
240 but glyph lookups need to be skipped.
242 if (!(pg ^ PANGO_GLYPH_EMPTY))
245 if (pg & PANGO_GLYPH_UNKNOWN_FLAG)
247 warning (_f ("no glyph for character U+%0X in font `%s'",
248 pg & ~PANGO_GLYPH_UNKNOWN_FLAG, file_name.c_str ()));
252 glyph_name[0] = '\0';
255 FT_Error errorcode = FT_Get_Glyph_Name (ftface, pg, glyph_name,
258 programming_error (_f ("FT_Get_Glyph_Name () error: %s",
259 freetype_error_string (errorcode).c_str ()));
262 SCM char_id = SCM_EOL;
263 if (glyph_name[0] == '\0'
266 && cmap->find (pg) != cmap->end ())
268 FT_ULong char_code = cmap->find (pg)->second;
269 get_unicode_name (glyph_name, char_code);
272 if (glyph_name[0] == '\0' && has_glyph_names)
274 programming_error (_f ("Glyph has no name, but font supports glyph naming.\n"
275 "Skipping glyph U+%0X, file %s",
276 pg, file_name.c_str ()));
280 if (glyph_name == string (".notdef") && is_ttf)
281 glyph_name[0] = '\0';
283 if (glyph_name[0] == '\0' && is_ttf)
284 // Access by glyph index directly.
285 get_glyph_index_name (glyph_name, pg);
287 if (glyph_name[0] == '\0')
291 char_id = scm_from_uint32 (pg);
294 char_id = scm_from_utf8_string (glyph_name);
296 PangoRectangle logical_sub_rect;
297 PangoRectangle ink_sub_rect;
299 pango_glyph_string_extents_range (pgs, i, i + 1, pa->font, &ink_sub_rect, &logical_sub_rect);
300 Box b_sub (Interval (PANGO_LBEARING (logical_sub_rect),
301 PANGO_RBEARING (logical_sub_rect)),
302 Interval (-PANGO_DESCENT (ink_sub_rect),
303 PANGO_ASCENT (ink_sub_rect)));
305 b_sub.scale (scale_);
307 *tail = scm_cons (scm_list_5 (scm_from_double (b_sub[X_AXIS][RIGHT] - b_sub[X_AXIS][LEFT]),
308 scm_cons (scm_from_double (b_sub[Y_AXIS][DOWN]),
309 scm_from_double (b_sub[Y_AXIS][UP])),
310 scm_from_double (ggeo.x_offset * scale_),
311 scm_from_double (- ggeo.y_offset * scale_),
314 tail = SCM_CDRLOC (*tail);
316 pango_fc_font_unlock_face (fcfont);
317 pango_glyph_string_free (pgs);
319 PangoFontDescription *descr = pango_font_describe (pa->font);
320 Real size = pango_font_description_get_size (descr)
321 / (Real (PANGO_SCALE));
324 warning (_f ("no PostScript font name for font `%s'", file_name));
329 && (file_name.find (".otf") != NPOS
330 || file_name.find (".cff") != NPOS))
332 // UGH: kludge a PS name for OTF/CFF fonts.
333 string name = file_name;
334 ssize idx = file_name.find (".otf");
336 idx = file_name.find (".cff");
338 name = name.substr (0, idx);
340 ssize slash_idx = name.rfind ('/');
341 if (slash_idx != NPOS)
344 name = name.substr (slash_idx,
345 name.length () - slash_idx);
348 string initial = name.substr (0, 1);
349 initial = String_convert::to_upper (initial);
350 name = name.substr (1, name.length () - 1);
351 name = String_convert::to_lower (name);
352 ps_name = initial + name;
354 else if (ps_name_str0)
355 ps_name = ps_name_str0;
357 if (ps_name.length ())
359 ((Pango_font *) this)->register_font_file (file_name,
363 SCM expr = scm_list_n (ly_symbol2scm ("glyph-string"),
365 ly_string2scm (ps_name),
366 scm_from_double (size),
367 scm_from_bool (cid_keyed),
368 ly_quote_scm (glyph_exprs),
371 return Stencil (b, expr);
374 warning (_ ("FreeType face has no PostScript font name"));
379 Pango_font::physical_font_tab () const
381 return physical_font_tab_;
384 extern bool music_strings_to_paths;
387 Pango_font::text_stencil (Output_def * /* state */,
388 const string &str, bool music_string) const
391 The text assigned to a PangoLayout is automatically divided
392 into sections and reordered according to the Unicode
393 Bidirectional Algorithm, if necessary.
395 PangoLayout *layout = pango_layout_new (context_);
396 pango_layout_set_text (layout, str.c_str (), -1);
397 GSList *lines = pango_layout_get_lines (layout);
402 for (GSList *l = lines; l; l = l->next)
404 PangoLayoutLine *line = (PangoLayoutLine *) l->data;
405 GSList *layout_runs = line->runs;
407 for (GSList *p = layout_runs; p; p = p->next)
409 PangoGlyphItem *item = (PangoGlyphItem *) p->data;
410 Stencil item_stencil = pango_item_string_stencil (item);
412 item_stencil.translate_axis (last_x, X_AXIS);
413 last_x = item_stencil.extent (X_AXIS)[RIGHT];
415 #if 0 // Check extents.
416 if (!item_stencil.extent_box ()[X_AXIS].is_empty ())
418 Stencil frame = Lookup::frame (item_stencil.extent_box (), 0.1, 0.1);
421 Stencil dimless_frame (empty, frame.expr ());
422 dest.add_stencil (frame);
426 dest.add_stencil (item_stencil);
430 string name = get_output_backend_name ();
431 string output_mod = "scm output-" + name;
432 SCM mod = scm_c_resolve_module (output_mod.c_str ());
434 bool has_utf8_string = false;
436 if (ly_is_module (mod))
438 SCM utf8_string = ly_module_lookup (mod, ly_symbol2scm ("utf-8-string"));
440 has_utf8_string should only be true when utf8_string is a
441 variable that is bound to a *named* procedure, i.e. not a
444 if (scm_is_true (utf8_string)
445 && scm_is_true (scm_procedure_name (SCM_VARIABLE_REF (utf8_string))))
446 has_utf8_string = true;
449 bool to_paths = music_strings_to_paths;
452 Backends with the utf-8-string expression use it when
453 1) the -dmusic-strings-to-paths option is set
454 and `str' is not a music string, or
455 2) the -dmusic-strings-to-paths option is not set.
457 if (has_utf8_string && ((to_paths && !music_string) || !to_paths))
459 // For Pango based backends, we take a shortcut.
460 SCM exp = scm_list_3 (ly_symbol2scm ("utf-8-string"),
461 ly_string2scm (description_string ()),
462 ly_string2scm (str));
464 Box b (Interval (0, 0), Interval (0, 0));
465 b.unite (dest.extent_box ());
466 return Stencil (b, exp);
473 Pango_font::description_string () const
475 char *descr_string = pango_font_description_to_string (pango_description_);
476 string s (descr_string);
477 g_free (descr_string);
482 Pango_font::font_file_name () const
487 #endif // HAVE_PANGO_FT2