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) const
 103 {
 104   const int GLYPH_NAME_LEN = 256;
 105   char glyph_name[GLYPH_NAME_LEN];
 106   PangoAnalysis const *pa = &(item->analysis);
 107   PangoGlyphString *pgs = pango_glyph_string_new ();
 108
 109   pango_shape (str.c_str () + item->offset,
 110                item->length, (PangoAnalysis*) pa, pgs);
 111
 112   PangoRectangle logical_rect;
 113   PangoRectangle ink_rect;
 114   pango_glyph_string_extents (pgs, pa->font, &ink_rect, &logical_rect);
 115
 116   PangoFcFont *fcfont = G_TYPE_CHECK_INSTANCE_CAST (pa->font,
 117                                                     PANGO_TYPE_FC_FONT,
 118                                                     PangoFcFont);
 119
 120   FT_Face ftface = pango_fc_font_lock_face (fcfont);
 121
 122   PangoRectangle const *which_rect = &logical_rect;
 123   Box b (Interval (PANGO_LBEARING (*which_rect),
 124                    PANGO_RBEARING (*which_rect)),
 125          Interval (-PANGO_DESCENT (*which_rect),
 126                    PANGO_ASCENT (*which_rect)));
 127
 128   b.scale (scale_);
 129   char const *ps_name_str0 = FT_Get_Postscript_Name (ftface);
 130   FcPattern *fcpat = fcfont->font_pattern;
 131   FcChar8 *file_name_as_ptr = 0;
 132   FcPatternGetString (fcpat, FC_FILE, 0, &file_name_as_ptr);
 133
 134   string file_name;
 135   if (file_name_as_ptr)
 136     {
 137       /* Normalize file name.  */
 138       file_name = File_name ((char const *)file_name_as_ptr).to_string ();
 139     }
 140
 141   SCM glyph_exprs = SCM_EOL;
 142   SCM *tail = &glyph_exprs;
 143
 144   Index_to_charcode_map const *cmap = 0;
 145   bool has_glyph_names = ftface->face_flags & FT_FACE_FLAG_GLYPH_NAMES;
 146   if  (! has_glyph_names)
 147     cmap = ((Pango_font*)this)->get_index_to_charcode_map (file_name, ftface);
 148
 149   bool cid_keyed = false;
 150   for (int i = 0; i < pgs->num_glyphs; i++)
 151     {
 152       PangoGlyphInfo *pgi = pgs->glyphs + i;
 153
 154       PangoGlyph pg = pgi->glyph;
 155       PangoGlyphGeometry ggeo = pgi->geometry;
 156
 157       glyph_name[0] = '\0';
 158       if (has_glyph_names)
 159         {
 160           int errorcode = FT_Get_Glyph_Name (ftface, pg, glyph_name, GLYPH_NAME_LEN);
 161           if (errorcode)
 162             programming_error ("FT_Get_Glyph_Name returns error");
 163         }
 164
 165       SCM char_id = SCM_EOL;
 166       if (glyph_name[0] == '\0'
 167           && cmap
 168
 169           /* Ugh should ask FreeType about font type. */
 170           && (file_name.find (".ttf") != NPOS
 171               || file_name.find (".TTF") != NPOS))
 172         {
 173           FT_ULong char_code = cmap->find (pg)->second;
 174           get_unicode_name (glyph_name, char_code);
 175         }
 176
 177       if (glyph_name[0] ==  '\0' && has_glyph_names)
 178         {
 179           programming_error ("Glyph has no name, but font supports glyph naming. Skipping glyph: "
 180                              + description_string ());
 181           continue;
 182         }
 183
 184       if (glyph_name[0] == '\0')
 185         {
 186           /*
 187             CID entry
 188           */
 189           cid_keyed = true;
 190           char_id = scm_from_uint32 (pg);
 191         }
 192       else
 193         char_id = scm_makfrom0str (glyph_name);
 194
 195       *tail = scm_cons (scm_list_4 (scm_from_double (ggeo.width * scale_),
 196                                     scm_from_double (ggeo.x_offset * scale_),
 197                                     scm_from_double (ggeo.y_offset * scale_),
 198
 199                                     char_id),
 200                         SCM_EOL);
 201       tail = SCM_CDRLOC (*tail);
 202     }
 203
 204   PangoFontDescription *descr = pango_font_describe (pa->font);
 205   Real size = pango_font_description_get_size (descr)
 206     / (Real (PANGO_SCALE));
 207
 208
 209   if (!ps_name_str0)
 210     warning (_f ("no PostScript font name for font `%s'", file_name));
 211
 212   string ps_name;
 213   if (!ps_name_str0
 214       && file_name != ""
 215       && (file_name.find (".otf") != NPOS
 216           || file_name.find (".cff") != NPOS))
 217     {
 218
 219       /* UGH: kludge a PS name for OTF/CFF fonts.  */
 220       string name = file_name;
 221       ssize idx = file_name.find (".otf");
 222       if (idx == NPOS)
 223         idx = file_name.find (".cff");
 224
 225       name = name.substr (0, idx);
 226
 227       ssize slash_idx = name.rfind ('/');
 228       if (slash_idx != NPOS)
 229         {
 230           slash_idx ++;
 231           name = name.substr (slash_idx,
 232                               name.length () - slash_idx);
 233         }
 234
 235       string initial = name.substr (0, 1);
 236       initial = String_convert::to_upper (initial);
 237       name = name.substr (1, name.length () - 1);
 238       name = String_convert::to_lower (name);
 239       ps_name = initial + name;
 240     }
 241   else if (ps_name_str0)
 242     ps_name = ps_name_str0;
 243
 244   if (ps_name.length ())
 245     {
 246       ((Pango_font *) this)->register_font_file (file_name, ps_name);
 247       pango_fc_font_unlock_face (fcfont);
 248
 249       SCM expr = scm_list_5 (ly_symbol2scm ("glyph-string"),
 250                              scm_makfrom0str (ps_name.c_str ()),
 251                              scm_from_double (size),
 252                              scm_from_bool (cid_keyed),
 253                              ly_quote_scm (glyph_exprs));
 254
 255       return Stencil (b, expr);
 256     }
 257
 258   warning (_ ("FreeType face has no PostScript font name"));
 259   return Stencil ();
 260 }
 261
 262 SCM
 263 Pango_font::physical_font_tab () const
 264 {
 265   return physical_font_tab_;
 266 }
 267
 268 Stencil
 269 Pango_font::text_stencil (string str) const
 270 {
 271   GList *items
 272     = pango_itemize (context_,
 273                      str.c_str (),
 274                      0, str.length (), attribute_list_,
 275                      NULL);
 276
 277   Stencil dest;
 278
 279   Real last_x = 0.0;
 280
 281   Direction text_dir = RIGHT;
 282   for (GList *p = items; p; p = p->next)
 283     {
 284       PangoItem *item = (PangoItem *) p->data;
 285       if (item->analysis.level == PANGO_DIRECTION_RTL)
 286         text_dir = LEFT;
 287     }
 288
 289   for (GList *ptr = items; ptr; ptr = ptr->next)
 290     {
 291       PangoItem *item = (PangoItem *) ptr->data;
 292
 293       Stencil item_stencil = pango_item_string_stencil (item, str);
 294
 295       if (text_dir == RIGHT)
 296         {
 297           item_stencil.translate_axis (last_x, X_AXIS);
 298           last_x = item_stencil.extent (X_AXIS)[RIGHT];
 299         }
 300       else if (text_dir == LEFT)
 301         {
 302           dest.translate_axis (item_stencil.extent (X_AXIS)[RIGHT], X_AXIS);
 303         }
 304
 305 #if 0 /* Check extents.  */
 306       if (!item_stencil.extent_box ()[X_AXIS].is_empty ())
 307         {
 308           Stencil frame = Lookup::frame (item_stencil.extent_box (), 0.1, 0.1);
 309           Box empty;
 310           empty.set_empty ();
 311           Stencil dimless_frame (empty, frame.expr ());
 312           dest.add_stencil (frame);
 313         }
 314 #endif
 315
 316       dest.add_stencil (item_stencil);
 317     }
 318
 319   /*
 320     UGH. Should have flags per output format signifying supported
 321     options.
 322   */
 323   if (output_backend_global != "ps"
 324       && output_backend_global != "eps")
 325     {
 326       /*
 327         For Pango based backends, we take a shortcut.
 328       */
 329       SCM exp
 330         = scm_list_3 (ly_symbol2scm ("utf-8-string"),
 331                       scm_makfrom0str (description_string ().c_str ()),
 332                       scm_makfrom0str (str.c_str ()));
 333
 334       Box b (Interval (0, 0), Interval (0, 0));
 335       b.unite (dest.extent_box ());
 336       return Stencil (b, exp);
 337     }
 338
 339
 340   return dest;
 341 }
 342
 343 string
 344 Pango_font::description_string () const
 345 {
 346   char *descr_string = pango_font_description_to_string (pango_description_);
 347   string s (descr_string);
 348   g_free (descr_string);
 349   return s;
 350 }
 351
 352
 353 SCM
 354 Pango_font::font_file_name () const
 355 {
 356   return SCM_BOOL_F;
 357 }
 358
 359 #endif