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