lily/pango-font.cc

   1 /*
   2   pango-font.cc -- implement Pango_font
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2004--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #define PANGO_ENABLE_BACKEND // ugh, why necessary?
  10 #include <pango/pangoft2.h>
  11 #include <freetype/ftxf86.h>
  12
  13 #include <map>
  14
  15 /* Ugh.  */
  16
  17 #include "pango-font.hh"
  18
  19 #include "open-type-font.hh"    // Index_to_charcode_map
  20
  21 #include "dimensions.hh"
  22 #include "file-name.hh"
  23 #include "international.hh"
  24 #include "lookup.hh"            // debugging
  25 #include "main.hh"
  26 #include "string-convert.hh"
  27 #include "warn.hh"
  28
  29 #if HAVE_PANGO_FT2
  30 #include "stencil.hh"
  31
  32 Pango_font::Pango_font (PangoFT2FontMap *fontmap,
  33                         PangoFontDescription *description,
  34                         Real output_scale)
  35 {
  36   (void) fontmap;
  37   physical_font_tab_ = scm_c_make_hash_table (11);
  38   PangoDirection pango_dir = PANGO_DIRECTION_LTR;
  39   context_
  40     = pango_ft2_get_context (PANGO_RESOLUTION, PANGO_RESOLUTION);
  41   //  context_ = pango_ft2_font_map_create_context (fontmap);
  42
  43   pango_description_ = pango_font_description_copy (description);
  44   attribute_list_ = pango_attr_list_new ();
  45
  46   /*
  47     urgh. I don't understand this. Why isn't this 1/(scale *
  48     resolution * output_scale)
  49
  50     --hwn
  51   */
  52   output_scale_ = output_scale;
  53   scale_ = INCH_TO_BP / (Real (PANGO_SCALE) * Real (PANGO_RESOLUTION) * output_scale);
  54
  55   /*
  56     ugh. Should make this configurable.
  57   */
  58   pango_context_set_language (context_, pango_language_from_string ("en_US"));
  59   pango_context_set_base_dir (context_, pango_dir);
  60   pango_context_set_font_description (context_, description);
  61 }
  62
  63 Pango_font::~Pango_font ()
  64 {
  65   pango_font_description_free (pango_description_);
  66   g_object_unref (context_);
  67   pango_attr_list_unref (attribute_list_);
  68 }
  69
  70 void
  71 Pango_font::register_font_file (string filename, string ps_name)
  72 {
  73   scm_hash_set_x (physical_font_tab_,
  74                   scm_makfrom0str (ps_name.c_str ()),
  75                   scm_makfrom0str (filename.c_str ()));
  76 }
  77
  78 void
  79 Pango_font::derived_mark () const
  80 {
  81   scm_gc_mark (physical_font_tab_);
  82 }
  83
  84
  85 map<string, Index_to_charcode_map > filename_charcode_maps_map;
  86 Index_to_charcode_map const *get_index_to_charcode_map (string postscript_name, FT_Face face);
  87
  88
  89 Index_to_charcode_map const *
  90 get_index_to_charcode_map (string filename, FT_Face face)
  91 {
  92   if (filename_charcode_maps_map.find (filename) == filename_charcode_maps_map.end ())
  93     filename_charcode_maps_map[filename] = make_index_to_charcode_map (face);
  94
  95   if (filename_charcode_maps_map.find (filename) == filename_charcode_maps_map.end ())
  96     return 0;
  97
  98   return &filename_charcode_maps_map[filename];
  99 }
 100
 101 void
 102 get_glyph_index_name (char *s, FT_ULong code)
 103 {
 104   sprintf (s, "glyphIndex%lX", code);
 105 }
 106
 107 void
 108 get_unicode_name (char*s, FT_ULong code)
 109 {
 110   if (code > 0xFFFF)
 111     sprintf (s,  "u%lX", code);
 112   else
 113     sprintf (s,  "uni%04lX", code);
 114 }
 115
 116
 117 Stencil
 118 Pango_font::pango_item_string_stencil (PangoItem const *item, string str,
 119                                        bool tight_bbox) const
 120 {
 121   const int GLYPH_NAME_LEN = 256;
 122   char glyph_name[GLYPH_NAME_LEN];
 123   PangoAnalysis const *pa = &(item->analysis);
 124   PangoGlyphString *pgs = pango_glyph_string_new ();
 125
 126   pango_shape (str.c_str () + item->offset,
 127                item->length, (PangoAnalysis*) pa, pgs);
 128
 129   PangoRectangle logical_rect;
 130   PangoRectangle ink_rect;
 131   pango_glyph_string_extents (pgs, pa->font, &ink_rect, &logical_rect);
 132
 133   PangoFcFont *fcfont = G_TYPE_CHECK_INSTANCE_CAST (pa->font,
 134                                                     PANGO_TYPE_FC_FONT,
 135                                                     PangoFcFont);
 136
 137   FT_Face ftface = pango_fc_font_lock_face (fcfont);
 138
 139   PangoRectangle const *which_rect
 140     = (tight_bbox)
 141     ? &ink_rect
 142     : &logical_rect;
 143
 144   Box b (Interval (PANGO_LBEARING (logical_rect),
 145                    PANGO_RBEARING (logical_rect)),
 146          Interval (-PANGO_DESCENT (*which_rect),
 147                    PANGO_ASCENT (*which_rect)));
 148
 149   b.scale (scale_);
 150   char const *ps_name_str0 = FT_Get_Postscript_Name (ftface);
 151   FcPattern *fcpat = fcfont->font_pattern;
 152   FcChar8 *file_name_as_ptr = 0;
 153   FcPatternGetString (fcpat, FC_FILE, 0, &file_name_as_ptr);
 154
 155   string file_name;
 156   if (file_name_as_ptr)
 157     {
 158       /* Normalize file name.  */
 159       file_name = File_name ((char const *)file_name_as_ptr).to_string ();
 160     }
 161
 162   SCM glyph_exprs = SCM_EOL;
 163   SCM *tail = &glyph_exprs;
 164
 165   Index_to_charcode_map const *cmap = 0;
 166   bool has_glyph_names = ftface->face_flags & FT_FACE_FLAG_GLYPH_NAMES;
 167   if  (! has_glyph_names)
 168     cmap = get_index_to_charcode_map (file_name, ftface);
 169
 170   bool is_ttf = string (FT_Get_X11_Font_Format (ftface)) == "TrueType";
 171   bool cid_keyed = false;
 172   for (int i = 0; i < pgs->num_glyphs; i++)
 173     {
 174       PangoGlyphInfo *pgi = pgs->glyphs + i;
 175
 176       PangoGlyph pg = pgi->glyph;
 177       PangoGlyphGeometry ggeo = pgi->geometry;
 178
 179       glyph_name[0] = '\0';
 180       if (has_glyph_names)
 181         {
 182           int errorcode = FT_Get_Glyph_Name (ftface, pg, glyph_name, GLYPH_NAME_LEN);
 183           if (errorcode)
 184             programming_error ("FT_Get_Glyph_Name returns error");
 185         }
 186
 187       SCM char_id = SCM_EOL;
 188       if (glyph_name[0] == '\0'
 189           && cmap
 190           && is_ttf
 191           && cmap->find (pg) != cmap->end ())
 192         {
 193           FT_ULong char_code = cmap->find (pg)->second;
 194           get_unicode_name (glyph_name, char_code);
 195         }
 196
 197       if (glyph_name[0] ==  '\0' && has_glyph_names)
 198         {
 199           programming_error (_f ("Glyph has no name, but font supports glyph naming.\n"
 200                                  "Skipping glyph U+%0X, file %s",
 201                                  pg,
 202                                  file_name.c_str ()));
 203           continue;
 204         }
 205
 206
 207       if (glyph_name == string (".notdef") && is_ttf)
 208         glyph_name[0] = '\0';
 209
 210       if (glyph_name[0] == '\0' && is_ttf)
 211         {
 212           // access by glyph index directly.
 213           get_glyph_index_name (glyph_name, pg);
 214         }
 215
 216       if (glyph_name[0] == '\0')
 217         {
 218           /*
 219             CID entry
 220           */
 221           cid_keyed = true;
 222           char_id = scm_from_uint32 (pg);
 223         }
 224       else
 225         char_id = scm_makfrom0str (glyph_name);
 226
 227       *tail = scm_cons (scm_list_4 (scm_from_double (ggeo.width * scale_),
 228                                     scm_from_double (ggeo.x_offset * scale_),
 229                                     scm_from_double (ggeo.y_offset * scale_),
 230
 231                                     char_id),
 232                         SCM_EOL);
 233       tail = SCM_CDRLOC (*tail);
 234     }
 235
 236   PangoFontDescription *descr = pango_font_describe (pa->font);
 237   Real size = pango_font_description_get_size (descr)
 238     / (Real (PANGO_SCALE));
 239
 240
 241   if (!ps_name_str0)
 242     warning (_f ("no PostScript font name for font `%s'", file_name));
 243
 244   string ps_name;
 245   if (!ps_name_str0
 246       && file_name != ""
 247       && (file_name.find (".otf") != NPOS
 248           || file_name.find (".cff") != NPOS))
 249     {
 250
 251       /* UGH: kludge a PS name for OTF/CFF fonts.  */
 252       string name = file_name;
 253       ssize idx = file_name.find (".otf");
 254       if (idx == NPOS)
 255         idx = file_name.find (".cff");
 256
 257       name = name.substr (0, idx);
 258
 259       ssize slash_idx = name.rfind ('/');
 260       if (slash_idx != NPOS)
 261         {
 262           slash_idx ++;
 263           name = name.substr (slash_idx,
 264                               name.length () - slash_idx);
 265         }
 266
 267       string initial = name.substr (0, 1);
 268       initial = String_convert::to_upper (initial);
 269       name = name.substr (1, name.length () - 1);
 270       name = String_convert::to_lower (name);
 271       ps_name = initial + name;
 272     }
 273   else if (ps_name_str0)
 274     ps_name = ps_name_str0;
 275
 276   if (ps_name.length ())
 277     {
 278       ((Pango_font *) this)->register_font_file (file_name, ps_name);
 279       pango_fc_font_unlock_face (fcfont);
 280
 281       SCM expr = scm_list_5 (ly_symbol2scm ("glyph-string"),
 282                              scm_makfrom0str (ps_name.c_str ()),
 283                              scm_from_double (size),
 284                              scm_from_bool (cid_keyed),
 285                              ly_quote_scm (glyph_exprs));
 286
 287       return Stencil (b, expr);
 288     }
 289
 290   warning (_ ("FreeType face has no PostScript font name"));
 291   return Stencil ();
 292 }
 293
 294 SCM
 295 Pango_font::physical_font_tab () const
 296 {
 297   return physical_font_tab_;
 298 }
 299
 300
 301 Stencil
 302 Pango_font::word_stencil (string str) const
 303 {
 304   return text_stencil (str, true);
 305 }
 306
 307 Stencil
 308 Pango_font::text_stencil (string str) const
 309 {
 310   return text_stencil (str, false);
 311 }
 312
 313 Stencil
 314 Pango_font::text_stencil (string str, bool tight) const
 315 {
 316   GList *items
 317     = pango_itemize (context_,
 318                      str.c_str (),
 319                      0, str.length (), attribute_list_,
 320                      NULL);
 321
 322   Stencil dest;
 323
 324   Real last_x = 0.0;
 325
 326   Direction text_dir = RIGHT;
 327   for (GList *p = items; p; p = p->next)
 328     {
 329       PangoItem *item = (PangoItem *) p->data;
 330       if (item->analysis.level == PANGO_DIRECTION_RTL)
 331         text_dir = LEFT;
 332     }
 333
 334   for (GList *ptr = items; ptr; ptr = ptr->next)
 335     {
 336       PangoItem *item = (PangoItem *) ptr->data;
 337
 338       Stencil item_stencil = pango_item_string_stencil (item, str, tight);
 339
 340       if (text_dir == RIGHT)
 341         {
 342           item_stencil.translate_axis (last_x, X_AXIS);
 343           last_x = item_stencil.extent (X_AXIS)[RIGHT];
 344         }
 345       else if (text_dir == LEFT)
 346         {
 347           dest.translate_axis (item_stencil.extent (X_AXIS)[RIGHT], X_AXIS);
 348         }
 349
 350 #if 0 /* Check extents.  */
 351       if (!item_stencil.extent_box ()[X_AXIS].is_empty ())
 352         {
 353           Stencil frame = Lookup::frame (item_stencil.extent_box (), 0.1, 0.1);
 354           Box empty;
 355           empty.set_empty ();
 356           Stencil dimless_frame (empty, frame.expr ());
 357           dest.add_stencil (frame);
 358         }
 359 #endif
 360
 361       dest.add_stencil (item_stencil);
 362     }
 363
 364   /*
 365     UGH. Should have flags per output format signifying supported
 366     options.
 367   */
 368   if (output_backend_global != "ps"
 369       && output_backend_global != "eps")
 370     {
 371       /*
 372         For Pango based backends, we take a shortcut.
 373       */
 374       SCM exp
 375         = scm_list_3 (ly_symbol2scm ("utf-8-string"),
 376                       scm_makfrom0str (description_string ().c_str ()),
 377                       scm_makfrom0str (str.c_str ()));
 378
 379       Box b (Interval (0, 0), Interval (0, 0));
 380       b.unite (dest.extent_box ());
 381       return Stencil (b, exp);
 382     }
 383
 384
 385   return dest;
 386 }
 387
 388 string
 389 Pango_font::description_string () const
 390 {
 391   char *descr_string = pango_font_description_to_string (pango_description_);
 392   string s (descr_string);
 393   g_free (descr_string);
 394   return s;
 395 }
 396
 397
 398 SCM
 399 Pango_font::font_file_name () const
 400 {
 401   return SCM_BOOL_F;
 402 }
 403
 404 #endif