2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2011 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/ftxf86.h>
32 #include "pango-font.hh"
33 #include "dimensions.hh"
34 #include "file-name.hh"
35 #include "international.hh"
36 #include "lookup.hh" // debugging
38 #include "string-convert.hh"
40 #include "all-font-metrics.hh"
41 #include "program-option.hh"
46 Pango_font::Pango_font (PangoFT2FontMap *fontmap,
47 PangoFontDescription const *description,
50 // This line looks stupid, but if we don't initialize physical_font_tab_ before
51 // we allocate memory in scm_c_make_hash_table, then that could trigger a garbage
53 physical_font_tab_ = SCM_EOL;
54 physical_font_tab_ = scm_c_make_hash_table (11);
55 PangoDirection pango_dir = PANGO_DIRECTION_LTR;
56 context_ = pango_context_new ();
57 pango_context_set_font_map (context_, PANGO_FONT_MAP (fontmap));
59 pango_description_ = pango_font_description_copy (description);
60 attribute_list_ = pango_attr_list_new ();
62 // urgh. I don't understand this. Why isn't this 1/(scale *
63 // resolution * output_scale)
66 output_scale_ = output_scale;
68 / (Real (PANGO_SCALE) * Real (PANGO_RESOLUTION) * output_scale);
70 // ugh. Should make this configurable.
71 pango_context_set_language (context_, pango_language_from_string ("en_US"));
72 pango_context_set_base_dir (context_, pango_dir);
73 pango_context_set_font_description (context_, description);
76 Pango_font::~Pango_font ()
78 pango_font_description_free (pango_description_);
79 g_object_unref (context_);
80 pango_attr_list_unref (attribute_list_);
84 Pango_font::register_font_file (string filename,
88 scm_hash_set_x (physical_font_tab_,
89 ly_string2scm (ps_name),
90 scm_list_2 (ly_string2scm (filename),
91 scm_from_int (face_index)));
95 Pango_font::derived_mark () const
97 scm_gc_mark (physical_font_tab_);
101 get_glyph_index_name (char *s,
104 sprintf (s, "glyphIndex%lX", code);
108 get_unicode_name (char *s,
112 sprintf (s, "u%lX", code);
114 sprintf (s, "uni%04lX", code);
118 Pango_font::pango_item_string_stencil (PangoGlyphItem const *glyph_item) const
120 const int GLYPH_NAME_LEN = 256;
121 char glyph_name[GLYPH_NAME_LEN];
123 PangoAnalysis const *pa = &(glyph_item->item->analysis);
124 PangoGlyphString *pgs = glyph_item->glyphs;
126 PangoRectangle logical_rect;
127 PangoRectangle ink_rect;
128 pango_glyph_string_extents (pgs, pa->font, &ink_rect, &logical_rect);
130 PangoFcFont *fcfont = PANGO_FC_FONT (pa->font);
132 FT_Face ftface = pango_fc_font_lock_face (fcfont);
134 Box b (Interval (PANGO_LBEARING (logical_rect),
135 PANGO_RBEARING (logical_rect)),
136 Interval (-PANGO_DESCENT (ink_rect),
137 PANGO_ASCENT (ink_rect)));
141 char const *ps_name_str0 = FT_Get_Postscript_Name (ftface);
142 FcPattern *fcpat = fcfont->font_pattern;
144 FcChar8 *file_name_as_ptr = 0;
145 FcPatternGetString (fcpat, FC_FILE, 0, &file_name_as_ptr);
147 // due to a bug in FreeType 2.3.7 and earlier we can't use
148 // ftface->face_index; it is always zero for some font formats,
149 // in particular TTCs which we are interested in
151 FcPatternGetInteger (fcpat, FC_INDEX, 0, &face_index);
154 if (file_name_as_ptr)
155 // Normalize file name.
156 file_name = File_name ((char const *)file_name_as_ptr).to_string ();
158 SCM glyph_exprs = SCM_EOL;
159 SCM *tail = &glyph_exprs;
161 Index_to_charcode_map const *cmap = 0;
162 bool has_glyph_names = ftface->face_flags & FT_FACE_FLAG_GLYPH_NAMES;
163 if (!has_glyph_names)
164 cmap = all_fonts_global->get_index_to_charcode_map (
165 file_name, face_index, ftface);
167 bool is_ttf = string (FT_Get_X11_Font_Format (ftface)) == "TrueType";
168 bool cid_keyed = false;
170 for (int i = 0; i < pgs->num_glyphs; i++)
172 PangoGlyphInfo *pgi = pgs->glyphs + i;
174 PangoGlyph pg = pgi->glyph;
175 PangoGlyphGeometry ggeo = pgi->geometry;
178 Zero-width characters are valid Unicode characters,
179 but glyph lookups need to be skipped.
181 if (!(pg ^ PANGO_GLYPH_EMPTY))
184 glyph_name[0] = '\0';
187 FT_Error errorcode = FT_Get_Glyph_Name (ftface, pg, glyph_name,
191 _f ("FT_Get_Glyph_Name () error: %s",
192 freetype_error_string (errorcode).c_str ()));
195 SCM char_id = SCM_EOL;
196 if (glyph_name[0] == '\0'
199 && cmap->find (pg) != cmap->end ())
201 FT_ULong char_code = cmap->find (pg)->second;
202 get_unicode_name (glyph_name, char_code);
205 if (glyph_name[0] == '\0' && has_glyph_names)
208 _f ("Glyph has no name, but font supports glyph naming.\n"
209 "Skipping glyph U+%0X, file %s",
210 pg, file_name.c_str ()));
214 if (glyph_name == string (".notdef") && is_ttf)
215 glyph_name[0] = '\0';
217 if (glyph_name[0] == '\0' && is_ttf)
218 // Access by glyph index directly.
219 get_glyph_index_name (glyph_name, pg);
221 if (glyph_name[0] == '\0')
225 char_id = scm_from_uint32 (pg);
228 char_id = scm_from_locale_string (glyph_name);
230 *tail = scm_cons (scm_list_4 (scm_from_double (ggeo.width * scale_),
231 scm_from_double (ggeo.x_offset * scale_),
232 scm_from_double (- ggeo.y_offset * scale_),
235 tail = SCM_CDRLOC (*tail);
238 pango_glyph_string_free (pgs);
240 PangoFontDescription *descr = pango_font_describe (pa->font);
241 Real size = pango_font_description_get_size (descr)
242 / (Real (PANGO_SCALE));
245 warning (_f ("no PostScript font name for font `%s'", file_name));
250 && (file_name.find (".otf") != NPOS
251 || file_name.find (".cff") != NPOS))
253 // UGH: kludge a PS name for OTF/CFF fonts.
254 string name = file_name;
255 ssize idx = file_name.find (".otf");
257 idx = file_name.find (".cff");
259 name = name.substr (0, idx);
261 ssize slash_idx = name.rfind ('/');
262 if (slash_idx != NPOS)
265 name = name.substr (slash_idx,
266 name.length () - slash_idx);
269 string initial = name.substr (0, 1);
270 initial = String_convert::to_upper (initial);
271 name = name.substr (1, name.length () - 1);
272 name = String_convert::to_lower (name);
273 ps_name = initial + name;
275 else if (ps_name_str0)
276 ps_name = ps_name_str0;
278 if (ps_name.length ())
280 ((Pango_font *) this)->register_font_file (file_name,
283 pango_fc_font_unlock_face (fcfont);
285 SCM expr = scm_list_5 (ly_symbol2scm ("glyph-string"),
286 ly_string2scm (ps_name),
287 scm_from_double (size),
288 scm_from_bool (cid_keyed),
289 ly_quote_scm (glyph_exprs));
291 return Stencil (b, expr);
294 warning (_ ("FreeType face has no PostScript font name"));
299 Pango_font::physical_font_tab () const
301 return physical_font_tab_;
304 extern bool music_strings_to_paths;
307 Pango_font::text_stencil (Output_def * /* state */,
308 string str, bool music_string) const
311 The text assigned to a PangoLayout is automatically divided
312 into sections and reordered according to the Unicode
313 Bidirectional Algorithm, if necessary.
315 PangoLayout *layout = pango_layout_new (context_);
316 pango_layout_set_text (layout, str.c_str (), -1);
317 GSList *lines = pango_layout_get_lines (layout);
322 for (GSList *l = lines; l; l = l->next)
324 PangoLayoutLine *line = (PangoLayoutLine *) l->data;
325 GSList *layout_runs = line->runs;
327 for (GSList *p = layout_runs; p; p = p->next)
329 PangoGlyphItem *item = (PangoGlyphItem *) p->data;
330 Stencil item_stencil = pango_item_string_stencil (item);
332 item_stencil.translate_axis (last_x, X_AXIS);
333 last_x = item_stencil.extent (X_AXIS)[RIGHT];
335 #if 0 // Check extents.
336 if (!item_stencil.extent_box ()[X_AXIS].is_empty ())
338 Stencil frame = Lookup::frame (item_stencil.extent_box (), 0.1, 0.1);
341 Stencil dimless_frame (empty, frame.expr ());
342 dest.add_stencil (frame);
346 dest.add_stencil (item_stencil);
350 string name = get_output_backend_name ();
351 string output_mod = "scm output-" + name;
352 SCM mod = scm_c_resolve_module (output_mod.c_str ());
354 bool has_utf8_string = false;
356 if (ly_is_module (mod))
358 SCM utf8_string = ly_module_lookup (mod, ly_symbol2scm ("utf-8-string"));
360 has_utf8_string should only be true when utf8_string is a
361 variable that is bound to a *named* procedure, i.e. not a
364 if (utf8_string != SCM_BOOL_F
365 && scm_procedure_name (SCM_VARIABLE_REF (utf8_string)) != SCM_BOOL_F)
366 has_utf8_string = true;
369 bool to_paths = music_strings_to_paths;
372 Backends with the utf-8-string expression use it when
373 1) the -dmusic-strings-to-paths option is set
374 and `str' is not a music string, or
375 2) the -dmusic-strings-to-paths option is not set.
377 if (has_utf8_string && ((to_paths && !music_string) || !to_paths))
379 // For Pango based backends, we take a shortcut.
380 SCM exp = scm_list_3 (ly_symbol2scm ("utf-8-string"),
381 ly_string2scm (description_string ()),
382 ly_string2scm (str));
384 Box b (Interval (0, 0), Interval (0, 0));
385 b.unite (dest.extent_box ());
386 return Stencil (b, exp);
393 Pango_font::description_string () const
395 char *descr_string = pango_font_description_to_string (pango_description_);
396 string s (descr_string);
397 g_free (descr_string);
402 Pango_font::font_file_name () const
407 #endif // HAVE_PANGO_FT2