]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/pango-font.cc
Be const correct in Open_type_font::index_to_charcode()
[lilypond.git] / lily / pango-font.cc
index 4e9dfd8061c0364273699a2f6439e12ac716835a..6d18820b97e66eb83461a68ea1002e296623d15a 100644 (file)
@@ -1,36 +1,69 @@
 /*
-  pango-font.cc --  implement Pango_font
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2004--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2004 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
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
 
-*/
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
 
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
-#define PANGO_ENABLE_BACKEND // ugh, why necessary?
+// Necessary for supporting pango_context_new() and
+// pango_context_set_font_map() in Pango < 1.22
+#define PANGO_ENABLE_BACKEND
 
 #include <pango/pangoft2.h>
+#include <freetype/ftxf86.h>
+
+#include <map>
+#include <cstdio>
+
+// Ugh.
 
 #include "pango-font.hh"
+#include "dimensions.hh"
+#include "file-name.hh"
+#include "international.hh"
+#include "lookup.hh"           // debugging
+#include "main.hh"
+#include "string-convert.hh"
+#include "warn.hh"
+#include "all-font-metrics.hh"
+#include "program-option.hh"
 
 #if HAVE_PANGO_FT2
-#include "stencil.hh" 
-
+#include "stencil.hh"
 
 Pango_font::Pango_font (PangoFT2FontMap *fontmap,
-                       int resolution,
-                       Direction dir,
-                       PangoFontDescription *description)
+                       PangoFontDescription const *description,
+                       Real output_scale)
 {
-  subfonts_ = SCM_EOL;
-  PangoDirection pango_dir = (dir == RIGHT)
-    ? PANGO_DIRECTION_LTR
-    : PANGO_DIRECTION_RTL;
-  context_ = pango_ft2_font_map_create_context (fontmap);  
-  attribute_list_= pango_attr_list_new();
-  scale_ = 1.0 / (PANGO_SCALE * resolution * 72.27);
-  
+  physical_font_tab_ = scm_c_make_hash_table (11);
+  PangoDirection pango_dir = PANGO_DIRECTION_LTR;
+  context_ = pango_context_new ();
+  pango_context_set_font_map (context_, PANGO_FONT_MAP (fontmap));
+
+  pango_description_ = pango_font_description_copy (description);
+  attribute_list_ = pango_attr_list_new ();
+
+  // urgh. I don't understand this. Why isn't this 1/(scale *
+  // resolution * output_scale)
+  //
+  //  --hwn
+  output_scale_ = output_scale;
+  scale_ = INCH_TO_BP
+          / (Real (PANGO_SCALE) * Real (PANGO_RESOLUTION) * output_scale);
+
+  // ugh. Should make this configurable.
   pango_context_set_language (context_, pango_language_from_string ("en_US"));
   pango_context_set_base_dir (context_, pango_dir);
   pango_context_set_font_description (context_, description);
@@ -38,145 +71,344 @@ Pango_font::Pango_font (PangoFT2FontMap *fontmap,
 
 Pango_font::~Pango_font ()
 {
+  pango_font_description_free (pango_description_);
   g_object_unref (context_);
   pango_attr_list_unref (attribute_list_);
 }
 
 void
-Pango_font::register_font_file (String filename, String ps_name) 
+Pango_font::register_font_file (string filename,
+                               string ps_name,
+                               int face_index)
 {
-  subfonts_ = scm_cons (//scm_cons (scm_makfrom0str (ps_name.to_str0 ()),
-                       scm_makfrom0str (filename.to_str0 ()),
-                       subfonts_);
+  scm_hash_set_x (physical_font_tab_,
+                 ly_string2scm (ps_name),
+                 scm_list_2 (ly_string2scm (filename),
+                             scm_from_int (face_index)));
 }
 
 void
 Pango_font::derived_mark () const
 {
-  scm_gc_mark (subfonts_);
+  scm_gc_mark (physical_font_tab_);
 }
 
-Stencil
-Pango_font::text_stencil (String str) const
+void
+get_glyph_index_name (char *s,
+                     FT_ULong code)
+{
+  sprintf (s, "glyphIndex%lX", code);
+}
+
+void
+get_unicode_name (char *s,
+                 FT_ULong code)
 {
-  GList *items = pango_itemize (context_,
-                               str.to_str0 (),
-                               0, str.length (), attribute_list_,
-                               NULL);
+  if (code > 0xFFFF)
+    sprintf (s, "u%lX", code);
+  else
+    sprintf (s, "uni%04lX", code);
+}
 
+Stencil
+Pango_font::pango_item_string_stencil (PangoGlyphItem const *glyph_item,
+                                      bool tight_bbox) const
+{
   const int GLYPH_NAME_LEN = 256;
   char glyph_name[GLYPH_NAME_LEN];
-  
-  GList *ptr = items;
-  Stencil dest;  
-  while (ptr)
+
+  PangoAnalysis const *pa = &(glyph_item->item->analysis);
+  PangoGlyphString *pgs = glyph_item->glyphs;
+
+  PangoRectangle logical_rect;
+  PangoRectangle ink_rect;
+  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);
+
+  PangoRectangle const *which_rect = tight_bbox ? &ink_rect
+                                               : &logical_rect;
+
+  Box b (Interval (PANGO_LBEARING (logical_rect),
+                  PANGO_RBEARING (logical_rect)),
+        Interval (-PANGO_DESCENT (*which_rect),
+                  PANGO_ASCENT (*which_rect)));
+  b.scale (scale_);
+
+  char const *ps_name_str0 = FT_Get_Postscript_Name (ftface);
+  FcPattern *fcpat = fcfont->font_pattern;
+
+  FcChar8 *file_name_as_ptr = 0;
+  FcPatternGetString (fcpat, FC_FILE, 0, &file_name_as_ptr);
+
+  // due to a bug in FreeType 2.3.7 and earlier we can't use
+  // ftface->face_index; it is always zero for some font formats,
+  // in particular TTCs which we are interested in
+  int face_index = 0;
+  FcPatternGetInteger (fcpat, FC_INDEX, 0, &face_index);
+
+  string file_name;
+  if (file_name_as_ptr)
+    // Normalize file name.
+    file_name = File_name ((char const *)file_name_as_ptr).to_string ();
+
+  SCM glyph_exprs = SCM_EOL;
+  SCM *tail = &glyph_exprs;
+
+  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);
+
+  bool is_ttf = string (FT_Get_X11_Font_Format (ftface)) == "TrueType";
+  bool cid_keyed = false;
+
+  for (int i = 0; i < pgs->num_glyphs; i++)
     {
+      PangoGlyphInfo *pgi = pgs->glyphs + i;
 
-      // FIXME: factor this out
-      PangoItem *item = (PangoItem*) ptr->data;
-      PangoAnalysis *pa = &(item->analysis);
-      PangoGlyphString *pgs = pango_glyph_string_new ();
+      PangoGlyph pg = pgi->glyph;
+      PangoGlyphGeometry ggeo = pgi->geometry;
 
-      pango_shape (str.to_str0 (), str.length (), pa, pgs);
+      /*
+       Zero-width characters are valid Unicode characters,
+       but glyph lookups need to be skipped.
+      */
+      if (!(pg ^ PANGO_GLYPH_EMPTY))
+       continue;
 
-      PangoRectangle logical_rect;
-      pango_glyph_string_extents (pgs, pa->font, NULL, &logical_rect);
-      
-      PangoFcFont *fcfont = G_TYPE_CHECK_INSTANCE_CAST(pa->font,
-                                                      PANGO_TYPE_FC_FONT,
-                                                      PangoFcFont);
-      FT_Face ftface = pango_fc_font_lock_face (fcfont);
-      Box b (Interval (0, logical_rect.width),
-            Interval (0, logical_rect.height));
+      glyph_name[0] = '\0';
+      if (has_glyph_names)
+       {
+         int 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 ()));
+       }
 
-      if (!face_)
+      SCM char_id = SCM_EOL;
+      if (glyph_name[0] == '\0'
+         && cmap
+         && is_ttf
+         && cmap->find (pg) != cmap->end ())
        {
-         /* FIXME.  This obvious shortcut apparently does not work.
-            It seems there are different faces per text string and a
-            map of face_ and charcode mapping is needed.  */
-         Pango_font *barf = (Pango_font*) this;
-         barf->face_ = ftface;
-         barf->index_to_charcode_map_ = make_index_to_charcode_map (face_);
+         FT_ULong char_code = cmap->find (pg)->second;
+         get_unicode_name (glyph_name, char_code);
        }
 
-      b.translate (Offset (- logical_rect.x, -logical_rect.y));
-      
-      b.scale (scale_);
+      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;
+       }
+
+      if (glyph_name == string (".notdef") && is_ttf)
+       glyph_name[0] = '\0';
 
-      SCM glyph_exprs = SCM_EOL;
-      SCM *tail = &glyph_exprs;
-      for (int i = 0; i < pgs->num_glyphs; i++)
+      if (glyph_name[0] == '\0' && is_ttf)
+       // Access by glyph index directly.
+       get_glyph_index_name (glyph_name, pg);
+
+      if (glyph_name[0] == '\0')
        {
-         PangoGlyphInfo *pgi = pgs->glyphs + i;
-         
-         PangoGlyph pg = pgi->glyph;
-         PangoGlyphGeometry ggeo = pgi->geometry;
-         
-         FT_Get_Glyph_Name (ftface, pg, glyph_name, GLYPH_NAME_LEN);
-         *tail = scm_cons (scm_list_3 (scm_from_double (ggeo.x_offset * scale_),
-                                       scm_from_double (ggeo.y_offset * scale_),
-                                       scm_makfrom0str (glyph_name)),
-                           SCM_EOL);
-         tail = SCM_CDRLOC (*tail);
+         // 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);
+      tail = SCM_CDRLOC (*tail);
+    }
 
-      FcPattern *fcpat = fcfont->font_pattern;
-      char *filename = 0;
-      FcPatternGetString(fcpat, FC_FILE, 0, (FcChar8 **) &filename);
-      char const *ps_name = FT_Get_Postscript_Name (ftface);
-      ((Pango_font *) this)->register_font_file (filename, ps_name);
-      
-      SCM expr = scm_list_4 (ly_symbol2scm ("glyph-string"),
-                            self_scm (),
-                            scm_makfrom0str (ps_name),
-                            ly_quote_scm (glyph_exprs));
+  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));
+
+  if (!ps_name_str0)
+    warning (_f ("no PostScript font name for font `%s'", file_name));
+
+  string ps_name;
+  if (!ps_name_str0
+      && file_name != ""
+      && (file_name.find (".otf") != 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");
 
-      Stencil item_stencil (b, expr);
+      name = name.substr (0, idx);
 
-      dest.add_stencil (item_stencil);
-      
+      ssize slash_idx = name.rfind ('/');
+      if (slash_idx != NPOS)
+       {
+         slash_idx ++;
+         name = name.substr (slash_idx,
+                             name.length () - slash_idx);
+       }
+
+      string initial = name.substr (0, 1);
+      initial = String_convert::to_upper (initial);
+      name = name.substr (1, name.length () - 1);
+      name = String_convert::to_lower (name);
+      ps_name = initial + name;
+    }
+  else if (ps_name_str0)
+    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);
-      ptr = ptr->next;      
+
+      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));
+
+      return Stencil (b, expr);
     }
 
-  return dest;
+  warning (_ ("FreeType face has no PostScript font name"));
+  return Stencil ();
 }
 
 SCM
-Pango_font::sub_fonts () const
+Pango_font::physical_font_tab () const
 {
-  return subfonts_;
+  return physical_font_tab_;
 }
 
-SCM 
-Pango_font::font_file_name () const
+Stencil
+Pango_font::text_stencil (Output_def* state,
+                          string str, bool music_string) const
 {
-  return SCM_BOOL_F;
+  return text_stencil (str, music_string, false);
 }
 
-int
-Pango_font::name_to_index (String nm) const
+extern bool music_strings_to_paths;
+
+Stencil
+Pango_font::text_stencil (string str,
+                         bool music_string,
+                         bool tight) const
 {
-  char *nm_str = (char*) nm.to_str0 ();
-  if (int idx = FT_Get_Name_Index (face_, nm_str))
-    return idx;
-  return -1;
+  /*
+    The text assigned to a PangoLayout is automatically divided
+    into sections and reordered according to the Unicode
+    Bidirectional Algorithm, if necessary.
+  */
+  PangoLayout *layout = pango_layout_new (context_);
+  pango_layout_set_text (layout, str.c_str (), -1);
+  GSList *lines = pango_layout_get_lines (layout);
+
+  Stencil dest;
+  Real last_x = 0.0;
+
+  for (GSList *l = lines; l; l = l->next)
+    {
+      PangoLayoutLine *line = (PangoLayoutLine *) l->data;
+      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, tight);
+
+         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);
+           }
+#endif
+
+         dest.add_stencil (item_stencil);
+       }
+    }
+
+  string name = get_output_backend_name ();
+  string output_mod = "scm output-" + name;
+  SCM mod = scm_c_resolve_module (output_mod.c_str ());
+
+  bool has_utf8_string = false;
+
+  if (ly_is_module (mod))
+    {
+      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.
+      */
+      if (utf8_string != SCM_BOOL_F
+         && scm_procedure_name (SCM_VARIABLE_REF (utf8_string)) != SCM_BOOL_F)
+       has_utf8_string = true;
+    }
+
+  bool to_paths = music_strings_to_paths;
+
+  /*
+    Backends with the utf-8-string expression use it when
+      1) the -dmusic-strings-to-paths option is set
+         and `str' is not a music string, or
+      2) the -dmusic-strings-to-paths option is not set.
+  */
+  if (has_utf8_string && ((to_paths && !music_string) || !to_paths))
+    {
+      // 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));
+
+      Box b (Interval (0, 0), Interval (0, 0));
+      b.unite (dest.extent_box ());
+      return Stencil (b, exp);
+    }
+
+  return dest;
 }
 
-unsigned
-Pango_font::index_to_charcode (int i) const
+string
+Pango_font::description_string () const
 {
-  return ((Pango_font*) this)->index_to_charcode_map_[i];
+  char *descr_string = pango_font_description_to_string (pango_description_);
+  string s (descr_string);
+  g_free (descr_string);
+  return s;
 }
 
-LY_DEFINE (ly_pango_font_p, "ly:pango-font?",
-          1, 0, 0,
-          (SCM f),
-          "Is @var{f} a pango font?")
+SCM
+Pango_font::font_file_name () const
 {
-  return scm_from_bool (dynamic_cast<Pango_font*> (unsmob_metrics (f)));
+  return SCM_BOOL_F;
 }
 
-
-#endif
-
+#endif // HAVE_PANGO_FT2