lily/all-font-metrics.cc

   1 /*
   2   all-font-metrics.cc --  implement All_font_metrics
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "all-font-metrics.hh"
  10
  11 #include "open-type-font.hh"
  12 #include "config.hh"
  13 #include "main.hh"
  14 #include "warn.hh"
  15 #include "afm.hh"
  16 #include "tfm.hh"
  17 #include "scm-hash.hh"
  18 #include "kpath.hh"
  19
  20 static char const *default_font_str0_ = "cmr10";
  21
  22 All_font_metrics::All_font_metrics (String path)
  23 {
  24   afm_p_dict_ = new Scheme_hash_table;
  25   tfm_p_dict_ = new Scheme_hash_table;
  26   otf_p_dict_ = new Scheme_hash_table;
  27
  28   search_path_.parse_path (path);
  29 }
  30
  31 All_font_metrics::~All_font_metrics ()
  32 {
  33   scm_gc_unprotect_object (afm_p_dict_->self_scm ());
  34   scm_gc_unprotect_object (tfm_p_dict_->self_scm ());
  35   scm_gc_unprotect_object (otf_p_dict_->self_scm ());
  36 }
  37
  38 All_font_metrics::All_font_metrics (All_font_metrics const&)
  39 {
  40 }
  41
  42 /*
  43   TODO: our AFM handling is broken: the units in an AFM file are
  44   relative to the design size (1000 units = 1 designsize). Hence we
  45   should include design size when generating an AFM metric.
  46
  47   ugr: copied from find_tfm.
  48  */
  49 Adobe_font_metric *
  50 All_font_metrics::find_afm (String name)
  51 {
  52   SCM sname = ly_symbol2scm (name.to_str0 ());
  53   SCM name_string = scm_makfrom0str (name.to_str0 ());
  54   SCM val;
  55   if (!afm_p_dict_->try_retrieve (sname, &val))
  56     {
  57       String file_name;
  58
  59       if (file_name.is_empty ())
  60         file_name = search_path_.find (name  + ".afm");
  61
  62       if (file_name.is_empty ())
  63         {
  64           String p = kpathsea_find_afm (name.to_str0 ());
  65           if (p.length ())
  66             file_name = p;
  67         }
  68
  69       if (file_name.is_empty ())
  70         return 0;
  71
  72       if (verbose_global_b)
  73         progress_indication ("[" + file_name);
  74       val = read_afm_file (file_name);
  75       unsmob_metrics (val)->file_name_ = file_name;
  76
  77       unsmob_metrics (val)->description_ = scm_cons (name_string,
  78                                                      scm_make_real (1.0));
  79
  80       if (verbose_global_b)
  81         progress_indication ("]");
  82
  83       afm_p_dict_->set (sname, val);
  84       scm_gc_unprotect_object (val);
  85
  86       Adobe_font_metric *afm
  87         = dynamic_cast<Adobe_font_metric*> (unsmob_metrics (val));
  88
  89       /* Only check checksums if there is one.  We take the risk that
  90          some file has valid checksum 0 */
  91       if (afm->checksum_)
  92         {
  93           Tex_font_metric * tfm = find_tfm (name);
  94
  95           /* FIXME: better warning message
  96              (maybe check upon startup for feta16.afm, feta16.tfm?) */
  97           if (tfm && tfm->info_.checksum != afm->checksum_)
  98             {
  99               // FIXME: broken sentence
 100               String s = _f ("checksum mismatch for font file: `%s'",
 101                              file_name.to_str0 ());
 102               s += " " + _f ("does not match: `%s'",
 103                              tfm->file_name_.to_str0 ());
 104               s += "\n";
 105               s += " TFM: " + to_string ((int) tfm->info_.checksum);
 106               s += " AFM: " + to_string ((int) afm->checksum_);
 107               s += "\n";
 108               s += _ ("Rebuild all .afm files, and remove all .pk and .tfm files.");
 109               s += "\n";
 110               s += _ ("Rerun with -V to show font paths.");
 111               s += "\n";
 112               s += _("A script for removing font-files is delivered with the source-code:");
 113               s += "\n";
 114               s += "buildscripts/clean-fonts.sh";
 115               error (s);
 116             }
 117         }
 118     }
 119
 120   return dynamic_cast<Adobe_font_metric*> (unsmob_metrics (val));
 121 }
 122
 123 Open_type_font*
 124 All_font_metrics::find_otf (String name)
 125 {
 126   SCM sname = ly_symbol2scm (name.to_str0 ());
 127   SCM name_string = scm_makfrom0str (name.to_str0 ());
 128   SCM val;
 129   if (!otf_p_dict_->try_retrieve (sname, &val))
 130     {
 131       String file_name;
 132
 133       if (file_name.is_empty ())
 134         file_name = search_path_.find (name  + ".otf");
 135       if (file_name.is_empty ())
 136         return 0;
 137
 138       if (verbose_global_b)
 139         progress_indication ("[" + file_name);
 140
 141       val = Open_type_font::make_otf (file_name);
 142
 143       if (verbose_global_b)
 144         progress_indication ("]");
 145
 146       unsmob_metrics (val)->file_name_ = file_name;
 147       unsmob_metrics (val)->description_ = scm_cons (name_string,
 148                                                      scm_make_real (1.0));
 149       otf_p_dict_->set (sname, val);
 150       scm_gc_unprotect_object (val);
 151     }
 152
 153   return dynamic_cast<Open_type_font*> (unsmob_metrics (val));
 154 }
 155
 156 Tex_font_metric*
 157 All_font_metrics::find_tfm (String name)
 158 {
 159   SCM sname = ly_symbol2scm (name.to_str0 ());
 160   SCM name_string = scm_makfrom0str (name.to_str0 ());
 161   SCM val;
 162   if (!tfm_p_dict_->try_retrieve (sname, &val))
 163     {
 164       String file_name;
 165
 166       if (file_name.is_empty ())
 167         {
 168           /* FIXME: should add "cork-" prefix to lm* fonts.  How to do
 169              that, cleanly?  */
 170           String p = kpathsea_find_tfm (name.to_str0 ());
 171           if (p.length ())
 172             file_name = p;
 173         }
 174
 175       if (file_name.is_empty ())
 176         file_name = search_path_.find (name  + ".tfm");
 177       if (file_name.is_empty ())
 178         return 0;
 179
 180       if (verbose_global_b)
 181         progress_indication ("[" + file_name);
 182
 183       val = Tex_font_metric::make_tfm (file_name);
 184
 185       if (verbose_global_b)
 186         progress_indication ("]");
 187
 188       unsmob_metrics (val)->file_name_ = file_name;
 189       unsmob_metrics (val)->description_ = scm_cons (name_string,
 190                                                      scm_make_real (1.0));
 191       tfm_p_dict_->set (sname, val);
 192       scm_gc_unprotect_object (val);
 193     }
 194
 195   return dynamic_cast<Tex_font_metric*> (unsmob_metrics (val));
 196 }
 197
 198 Font_metric*
 199 All_font_metrics::find_font (String name)
 200 {
 201   Font_metric *f = find_otf (name);
 202
 203   if (!f &&
 204       (name.left_string (4) == "feta"
 205        || name.left_string (8) == "parmesan"
 206        || name.left_string (2) == "lm"))
 207     {
 208       f = find_afm (name);
 209       if (!f)
 210         f = find_tfm (name);
 211     }
 212   else if (!f)
 213     {
 214       f = find_tfm (name);
 215       if (!f)
 216         f = find_afm (name);
 217     }
 218
 219   if (!f)
 220     {
 221       warning (_f ("can't find font: `%s'", name.to_str0 ()));
 222       warning (_ ("Loading default font"));
 223     }
 224
 225   String def_name = default_font_str0_;
 226
 227   /* We're in emergency recovery mode here anyway, so don't try to do
 228      anything smart that runs the risk of failing.  */
 229   if (!f)
 230     f = find_afm (def_name);
 231
 232   if (!f)
 233     f = find_tfm (def_name);
 234
 235   if (!f)
 236     {
 237       error (_f ("can't find default font: `%s'", def_name.to_str0 ()));
 238       error (_f ("(search path: `%s')", search_path_.to_string ()));
 239       error (_ ("Giving up"));
 240     }
 241
 242   return f;
 243 }
 244
 245 All_font_metrics *all_fonts_global;
 246
 247
 248 LY_DEFINE (ly_font_load, "ly:font-load", 1, 0, 0,
 249            (SCM name),
 250            "Load the font @var{name}. ")
 251 {
 252   SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG1, __FUNCTION__, "string");
 253
 254   Font_metric *fm = all_fonts_global->find_font (ly_scm2string (name));
 255
 256   return fm->self_scm ();
 257 }
 258