]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/pango-font.cc
Issue 5147: Add whether to use OTF feature depending on Pango version
[lilypond.git] / lily / pango-font.cc
index 26f2e53fb4b5fce47b0294c5626cd3f9018cb733..6578f1c2389e215ce04a038b9e62f9cac603eee9 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2004--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 2004--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -22,7 +22,8 @@
 #define PANGO_ENABLE_BACKEND
 
 #include <pango/pangoft2.h>
-#include <freetype/ftxf86.h>
+#include "freetype.hh"
+#include FT_XFREE86_H
 
 #include <map>
 #include <cstdio>
 #include "dimensions.hh"
 #include "file-name.hh"
 #include "international.hh"
-#include "lookup.hh"           // debugging
+#include "lookup.hh"            // debugging
+#include "ly-module.hh"
 #include "main.hh"
 #include "string-convert.hh"
 #include "warn.hh"
 #include "all-font-metrics.hh"
 #include "program-option.hh"
+#include "open-type-font.hh"
 
 #if HAVE_PANGO_FT2
 #include "stencil.hh"
 
-Pango_font::Pango_font (PangoFT2FontMap *fontmap,
-                       PangoFontDescription const *description,
-                       Real output_scale)
+Preinit_Pango_font::Preinit_Pango_font ()
 {
-  // This line looks stupid, but if we don't initialize physical_font_tab_ before
-  // we allocate memory in scm_c_make_hash_table, then that could trigger a garbage
-  // collection.
   physical_font_tab_ = SCM_EOL;
+}
+
+Pango_font::Pango_font (PangoFT2FontMap *fontmap,
+                        PangoFontDescription const *description,
+                        Real output_scale)
+{
   physical_font_tab_ = scm_c_make_hash_table (11);
   PangoDirection pango_dir = PANGO_DIRECTION_LTR;
   context_ = pango_context_new ();
@@ -65,7 +69,7 @@ Pango_font::Pango_font (PangoFT2FontMap *fontmap,
   //  --hwn
   output_scale_ = output_scale;
   scale_ = INCH_TO_BP
-          / (Real (PANGO_SCALE) * Real (PANGO_RESOLUTION) * output_scale);
+           / (Real (PANGO_SCALE) * Real (PANGO_RESOLUTION) * output_scale);
 
   // ugh. Should make this configurable.
   pango_context_set_language (context_, pango_language_from_string ("en_US"));
@@ -81,14 +85,30 @@ Pango_font::~Pango_font ()
 }
 
 void
-Pango_font::register_font_file (string filename,
-                               string ps_name,
-                               int face_index)
+Pango_font::register_font_file (const string &filename,
+                                const string &ps_name,
+                                int face_index)
 {
   scm_hash_set_x (physical_font_tab_,
-                 ly_string2scm (ps_name),
-                 scm_list_2 (ly_string2scm (filename),
-                             scm_from_int (face_index)));
+                  ly_string2scm (ps_name),
+                  scm_list_2 (ly_string2scm (filename),
+                              scm_from_int (face_index)));
+}
+
+size_t
+Pango_font::name_to_index (string nm) const
+{
+  PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
+  FT_Face face = pango_fc_font_lock_face (fcfont);
+  char *nm_str = (char *) nm.c_str ();
+  if (FT_UInt idx = FT_Get_Name_Index (face, nm_str))
+    {
+      pango_fc_font_unlock_face (fcfont);
+      return (size_t) idx;
+    }
+
+  pango_fc_font_unlock_face (fcfont);
+  return (size_t) - 1;
 }
 
 void
@@ -99,14 +119,14 @@ Pango_font::derived_mark () const
 
 void
 get_glyph_index_name (char *s,
-                     FT_ULong code)
+                      FT_ULong code)
 {
   sprintf (s, "glyphIndex%lX", code);
 }
 
 void
 get_unicode_name (char *s,
-                 FT_ULong code)
+                  FT_ULong code)
 {
   if (code > 0xFFFF)
     sprintf (s, "u%lX", code);
@@ -114,6 +134,51 @@ get_unicode_name (char *s,
     sprintf (s, "uni%04lX", code);
 }
 
+Box
+Pango_font::get_unscaled_indexed_char_dimensions (size_t signed_idx) const
+{
+  PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
+  FT_Face face = pango_fc_font_lock_face (fcfont);
+  Box b = ly_FT_get_unscaled_indexed_char_dimensions (face, signed_idx);
+  pango_fc_font_unlock_face (fcfont);
+  return b;
+}
+
+Box
+Pango_font::get_scaled_indexed_char_dimensions (size_t signed_idx) const
+{
+  PangoFont *font = pango_context_load_font (context_, pango_description_);
+  PangoRectangle logical_rect;
+  PangoRectangle ink_rect;
+  pango_font_get_glyph_extents (font, signed_idx, &ink_rect, &logical_rect);
+  Box out (Interval (PANGO_LBEARING (ink_rect),
+                     PANGO_RBEARING (ink_rect)),
+           Interval (-PANGO_DESCENT (ink_rect),
+                     PANGO_ASCENT (ink_rect)));
+  out.scale (scale_);
+  return out;
+}
+
+Box
+Pango_font::get_glyph_outline_bbox (size_t signed_idx) const
+{
+  PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
+  FT_Face face = pango_fc_font_lock_face (fcfont);
+  Box b = ly_FT_get_glyph_outline_bbox (face, signed_idx);
+  pango_fc_font_unlock_face (fcfont);
+  return b;
+}
+
+SCM
+Pango_font::get_glyph_outline (size_t signed_idx) const
+{
+  PangoFcFont *fcfont = PANGO_FC_FONT (pango_context_load_font (context_, pango_description_));
+  FT_Face face = pango_fc_font_lock_face (fcfont);
+  SCM s = ly_FT_get_glyph_outline (face, signed_idx);
+  pango_fc_font_unlock_face (fcfont);
+  return s;
+}
+
 Stencil
 Pango_font::pango_item_string_stencil (PangoGlyphItem const *glyph_item) const
 {
@@ -128,17 +193,16 @@ Pango_font::pango_item_string_stencil (PangoGlyphItem const *glyph_item) const
   pango_glyph_string_extents (pgs, pa->font, &ink_rect, &logical_rect);
 
   PangoFcFont *fcfont = PANGO_FC_FONT (pa->font);
-
   FT_Face ftface = pango_fc_font_lock_face (fcfont);
 
   Box b (Interval (PANGO_LBEARING (logical_rect),
-                  PANGO_RBEARING (logical_rect)),
-        Interval (-PANGO_DESCENT (ink_rect),
-                  PANGO_ASCENT (ink_rect)));
+                   PANGO_RBEARING (logical_rect)),
+         Interval (-PANGO_DESCENT (ink_rect),
+                   PANGO_ASCENT (ink_rect)));
 
   b.scale (scale_);
 
-  char const *ps_name_str0 = FT_Get_Postscript_Name (ftface);
+  const string ps_name_str0 = get_postscript_name (ftface);
   FcPattern *fcpat = fcfont->font_pattern;
 
   FcChar8 *file_name_as_ptr = 0;
@@ -161,8 +225,7 @@ Pango_font::pango_item_string_stencil (PangoGlyphItem const *glyph_item) const
   Index_to_charcode_map const *cmap = 0;
   bool has_glyph_names = ftface->face_flags & FT_FACE_FLAG_GLYPH_NAMES;
   if (!has_glyph_names)
-    cmap = all_fonts_global->get_index_to_charcode_map (
-            file_name, face_index, ftface);
+    cmap = all_fonts_global->get_index_to_charcode_map (file_name, face_index, ftface);
 
   bool is_ttf = string (FT_Get_X11_Font_Format (ftface)) == "TrueType";
   bool cid_keyed = false;
@@ -175,96 +238,114 @@ Pango_font::pango_item_string_stencil (PangoGlyphItem const *glyph_item) const
       PangoGlyphGeometry ggeo = pgi->geometry;
 
       /*
-       Zero-width characters are valid Unicode characters,
-       but glyph lookups need to be skipped.
+        Zero-width characters are valid Unicode characters,
+        but glyph lookups need to be skipped.
       */
       if (!(pg ^ PANGO_GLYPH_EMPTY))
-       continue;
+        continue;
+
+      if (pg & PANGO_GLYPH_UNKNOWN_FLAG)
+        {
+          warning (_f ("no glyph for character U+%0X in font `%s'",
+                       pg & ~PANGO_GLYPH_UNKNOWN_FLAG, file_name.c_str ()));
+          continue;
+        }
 
       glyph_name[0] = '\0';
       if (has_glyph_names)
-       {
-         FT_Error errorcode = FT_Get_Glyph_Name (ftface, pg, glyph_name,
-                                                 GLYPH_NAME_LEN);
-         if (errorcode)
-           programming_error (
-             _f ("FT_Get_Glyph_Name () error: %s",
-                 freetype_error_string (errorcode).c_str ()));
-       }
+        {
+          FT_Error errorcode = FT_Get_Glyph_Name (ftface, pg, glyph_name,
+                                                  GLYPH_NAME_LEN);
+          if (errorcode)
+            programming_error (_f ("FT_Get_Glyph_Name () error: %s",
+                                   freetype_error_string (errorcode).c_str ()));
+        }
 
       SCM char_id = SCM_EOL;
       if (glyph_name[0] == '\0'
-         && cmap
-         && is_ttf
-         && cmap->find (pg) != cmap->end ())
-       {
-         FT_ULong char_code = cmap->find (pg)->second;
-         get_unicode_name (glyph_name, char_code);
-       }
+          && cmap
+          && is_ttf
+          && cmap->find (pg) != cmap->end ())
+        {
+          FT_ULong char_code = cmap->find (pg)->second;
+          get_unicode_name (glyph_name, char_code);
+        }
 
       if (glyph_name[0] == '\0' && has_glyph_names)
-       {
-         programming_error (
-           _f ("Glyph has no name, but font supports glyph naming.\n"
-               "Skipping glyph U+%0X, file %s",
-               pg, file_name.c_str ()));
-         continue;
-       }
+        {
+          programming_error (_f ("Glyph has no name, but font supports glyph naming.\n"
+                                 "Skipping glyph U+%0X, file %s",
+                                 pg, file_name.c_str ()));
+          continue;
+        }
 
       if (glyph_name == string (".notdef") && is_ttf)
-       glyph_name[0] = '\0';
+        glyph_name[0] = '\0';
 
       if (glyph_name[0] == '\0' && is_ttf)
-       // Access by glyph index directly.
-       get_glyph_index_name (glyph_name, pg);
+        // Access by glyph index directly.
+        get_glyph_index_name (glyph_name, pg);
 
       if (glyph_name[0] == '\0')
-       {
-         // CID entry
-         cid_keyed = true;
-         char_id = scm_from_uint32 (pg);
-       }
+        {
+          // CID entry
+          cid_keyed = true;
+          char_id = scm_from_uint32 (pg);
+        }
       else
-       char_id = scm_from_locale_string (glyph_name);
-
-      *tail = scm_cons (scm_list_4 (scm_from_double (ggeo.width * scale_),
-                                   scm_from_double (ggeo.x_offset * scale_),
-                                   scm_from_double (- ggeo.y_offset * scale_),
-                                   char_id),
-                       SCM_EOL);
+        char_id = scm_from_utf8_string (glyph_name);
+
+      PangoRectangle logical_sub_rect;
+      PangoRectangle ink_sub_rect;
+
+      pango_glyph_string_extents_range (pgs, i, i + 1, pa->font, &ink_sub_rect, &logical_sub_rect);
+      Box b_sub (Interval (PANGO_LBEARING (logical_sub_rect),
+                           PANGO_RBEARING (logical_sub_rect)),
+                 Interval (-PANGO_DESCENT (ink_sub_rect),
+                           PANGO_ASCENT (ink_sub_rect)));
+
+      b_sub.scale (scale_);
+
+      *tail = scm_cons (scm_list_5 (scm_from_double (b_sub[X_AXIS][RIGHT] - b_sub[X_AXIS][LEFT]),
+                                    scm_cons (scm_from_double (b_sub[Y_AXIS][DOWN]),
+                                              scm_from_double (b_sub[Y_AXIS][UP])),
+                                    scm_from_double (ggeo.x_offset * scale_),
+                                    scm_from_double (- ggeo.y_offset * scale_),
+                                    char_id),
+                        SCM_EOL);
       tail = SCM_CDRLOC (*tail);
     }
-
+  pango_fc_font_unlock_face (fcfont);
   pango_glyph_string_free (pgs);
   pgs = 0;
   PangoFontDescription *descr = pango_font_describe (pa->font);
   Real size = pango_font_description_get_size (descr)
-             / (Real (PANGO_SCALE));
+              / (Real (PANGO_SCALE));
 
-  if (!ps_name_str0)
+  if (ps_name_str0.empty ())
     warning (_f ("no PostScript font name for font `%s'", file_name));
 
   string ps_name;
-  if (!ps_name_str0
+  if (ps_name_str0.empty ()
       && file_name != ""
       && (file_name.find (".otf") != NPOS
-         || file_name.find (".cff") != NPOS))
+          || file_name.find (".cff") != NPOS))
     {
       // UGH: kludge a PS name for OTF/CFF fonts.
       string name = file_name;
       ssize idx = file_name.find (".otf");
       if (idx == NPOS)
-       idx = file_name.find (".cff");
+        idx = file_name.find (".cff");
 
       name = name.substr (0, idx);
 
       ssize slash_idx = name.rfind ('/');
       if (slash_idx != NPOS)
-       {
-         slash_idx ++;
-         name = name.substr (slash_idx,
-                             name.length () - slash_idx);
-       }
+        {
+          slash_idx++;
+          name = name.substr (slash_idx,
+                              name.length () - slash_idx);
+        }
 
       string initial = name.substr (0, 1);
       initial = String_convert::to_upper (initial);
@@ -272,21 +353,22 @@ Pango_font::pango_item_string_stencil (PangoGlyphItem const *glyph_item) const
       name = String_convert::to_lower (name);
       ps_name = initial + name;
     }
-  else if (ps_name_str0)
+  else if (!ps_name_str0.empty ())
     ps_name = ps_name_str0;
 
   if (ps_name.length ())
     {
       ((Pango_font *) this)->register_font_file (file_name,
-                                                ps_name,
-                                                face_index);
-      pango_fc_font_unlock_face (fcfont);
+                                                 ps_name,
+                                                 face_index);
 
-      SCM expr = scm_list_5 (ly_symbol2scm ("glyph-string"),
-                            ly_string2scm (ps_name),
-                            scm_from_double (size),
-                            scm_from_bool (cid_keyed),
-                            ly_quote_scm (glyph_exprs));
+      SCM expr = scm_list_n (ly_symbol2scm ("glyph-string"),
+                             self_scm (),
+                             ly_string2scm (ps_name),
+                             scm_from_double (size),
+                             scm_from_bool (cid_keyed),
+                             ly_quote_scm (glyph_exprs),
+                             SCM_UNDEFINED);
 
       return Stencil (b, expr);
     }
@@ -305,7 +387,9 @@ extern bool music_strings_to_paths;
 
 Stencil
 Pango_font::text_stencil (Output_def * /* state */,
-                         string str, bool music_string) const
+                          const string &str,
+                          bool music_string,
+                          const string &features_str) const
 {
   /*
     The text assigned to a PangoLayout is automatically divided
@@ -313,6 +397,22 @@ Pango_font::text_stencil (Output_def * /* state */,
     Bidirectional Algorithm, if necessary.
   */
   PangoLayout *layout = pango_layout_new (context_);
+
+  if (!features_str.empty())
+    {
+#if HAVE_PANGO_FT2_WITH_OTF_FEATURE
+      PangoAttrList *list = pango_attr_list_new();
+      PangoAttribute *features_attr = pango_attr_font_features_new(features_str.c_str());
+      pango_attr_list_insert(list, features_attr);
+      pango_layout_set_attributes(layout, list);
+      pango_attr_list_unref(list);
+#else
+      warning (_f ("OpenType font feature `%s' cannot be used "
+                   "since this binary is configured without the feature.",
+                   features_str.c_str ()));
+#endif
+    }
+
   pango_layout_set_text (layout, str.c_str (), -1);
   GSList *lines = pango_layout_get_lines (layout);
 
@@ -325,26 +425,26 @@ Pango_font::text_stencil (Output_def * /* state */,
       GSList *layout_runs = line->runs;
 
       for (GSList *p = layout_runs; p; p = p->next)
-       {
-         PangoGlyphItem *item = (PangoGlyphItem *) p->data;
-         Stencil item_stencil = pango_item_string_stencil (item);
+        {
+          PangoGlyphItem *item = (PangoGlyphItem *) p->data;
+          Stencil item_stencil = pango_item_string_stencil (item);
 
-         item_stencil.translate_axis (last_x, X_AXIS);
-         last_x = item_stencil.extent (X_AXIS)[RIGHT];
+          item_stencil.translate_axis (last_x, X_AXIS);
+          last_x = item_stencil.extent (X_AXIS)[RIGHT];
 
 #if 0 // Check extents.
-         if (!item_stencil.extent_box ()[X_AXIS].is_empty ())
-           {
-             Stencil frame = Lookup::frame (item_stencil.extent_box (), 0.1, 0.1);
-             Box empty;
-             empty.set_empty ();
-             Stencil dimless_frame (empty, frame.expr ());
-             dest.add_stencil (frame);
-           }
+          if (!item_stencil.extent_box ()[X_AXIS].is_empty ())
+            {
+              Stencil frame = Lookup::frame (item_stencil.extent_box (), 0.1, 0.1);
+              Box empty;
+              empty.set_empty ();
+              Stencil dimless_frame (empty, frame.expr ());
+              dest.add_stencil (frame);
+            }
 #endif
 
-         dest.add_stencil (item_stencil);
-       }
+          dest.add_stencil (item_stencil);
+        }
     }
 
   string name = get_output_backend_name ();
@@ -357,13 +457,13 @@ Pango_font::text_stencil (Output_def * /* state */,
     {
       SCM utf8_string = ly_module_lookup (mod, ly_symbol2scm ("utf-8-string"));
       /*
-       has_utf8_string should only be true when utf8_string is a
-       variable that is bound to a *named* procedure, i.e. not a
-       lambda expression.
+        has_utf8_string should only be true when utf8_string is a
+        variable that is bound to a *named* procedure, i.e. not a
+        lambda expression.
       */
-      if (utf8_string != SCM_BOOL_F
-         && scm_procedure_name (SCM_VARIABLE_REF (utf8_string)) != SCM_BOOL_F)
-       has_utf8_string = true;
+      if (scm_is_true (utf8_string)
+          && scm_is_true (scm_procedure_name (SCM_VARIABLE_REF (utf8_string))))
+        has_utf8_string = true;
     }
 
   bool to_paths = music_strings_to_paths;
@@ -378,8 +478,8 @@ Pango_font::text_stencil (Output_def * /* state */,
     {
       // For Pango based backends, we take a shortcut.
       SCM exp = scm_list_3 (ly_symbol2scm ("utf-8-string"),
-                           ly_string2scm (description_string ()),
-                           ly_string2scm (str));
+                            ly_string2scm (description_string ()),
+                            ly_string2scm (str));
 
       Box b (Interval (0, 0), Interval (0, 0));
       b.unite (dest.extent_box ());