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