lily/font-metric.cc

   1 /*
   2   font-metric.cc -- implement Font_metric
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8     Mats Bengtsson <matsb@s3.kth.se> (the ugly TeX parsing in text_dimension)
   9 */
  10
  11 #include "font-metric.hh"
  12
  13 #include <math.h>
  14 #include <cctype>
  15
  16 #include "modified-font-metric.hh"
  17 #include "virtual-methods.hh"
  18 #include "warn.hh"
  19 #include "stencil.hh"
  20
  21 #include "ly-smobs.icc"
  22
  23 Real
  24 Font_metric::design_size () const
  25 {
  26   return 1.0;
  27 }
  28
  29 String
  30 Font_metric::coding_scheme () const
  31 {
  32   return "FontSpecific";
  33 }
  34
  35 Stencil
  36 Font_metric::find_by_name (String s) const
  37 {
  38   s = s.substituted ('-', "M");
  39   int idx = name_to_index (s);
  40   Box b;
  41
  42   SCM expr = SCM_EOL;
  43   if (idx >= 0)
  44     {
  45       expr = scm_list_3 (ly_symbol2scm ("char"),
  46                          self_scm (),
  47                          scm_int2num (index_to_ascii (idx)));
  48       b = get_indexed_char (idx);
  49     }
  50
  51   Stencil q (b, expr);
  52   return q;
  53 }
  54
  55 Font_metric::Font_metric ()
  56 {
  57   description_ = SCM_EOL;
  58   self_scm_ = SCM_EOL;
  59   smobify_self ();
  60 }
  61
  62 Font_metric::Font_metric (Font_metric const &)
  63 {
  64 }
  65
  66
  67 Font_metric::~Font_metric ()
  68 {
  69 }
  70
  71 int
  72 Font_metric::count () const
  73 {
  74   return 0;
  75 }
  76
  77 Box
  78 Font_metric::get_ascii_char (int) const
  79 {
  80   return Box (Interval (0, 0), Interval (0, 0));
  81 }
  82
  83 Box
  84 Font_metric::get_indexed_char (int k) const
  85 {
  86   return get_ascii_char (k);
  87 }
  88
  89 int
  90 Font_metric::name_to_index (String) const
  91 {
  92   return -1;
  93 }
  94
  95 Offset
  96 Font_metric::get_indexed_wxwy (int) const
  97 {
  98   return Offset (0, 0);
  99 }
 100
 101 void
 102 Font_metric::derived_mark () const
 103 {
 104 }
 105
 106 SCM
 107 Font_metric::mark_smob (SCM s)
 108 {
 109   Font_metric *m = (Font_metric*) SCM_CELL_WORD_1 (s);
 110   m->derived_mark ();
 111   return m->description_;
 112 }
 113
 114 int
 115 Font_metric::print_smob (SCM s, SCM port, scm_print_state *)
 116 {
 117   Font_metric *m = unsmob_metrics (s);
 118   scm_puts ("#<", port);
 119   scm_puts (classname (m), port);
 120   scm_puts (" ", port);
 121   scm_write (m->description_, port);
 122   scm_puts (">", port);
 123   return 1;
 124 }
 125
 126
 127
 128 IMPLEMENT_SMOBS (Font_metric);
 129 IMPLEMENT_DEFAULT_EQUAL_P (Font_metric);
 130 IMPLEMENT_TYPE_P (Font_metric, "ly:font-metric?");
 131
 132
 133 LY_DEFINE (ly_font_get_glyph, "ly:font-get-glyph",
 134            2, 0, 0,
 135           (SCM font, SCM name),
 136            "Return a Stencil from @var{font} for the glyph named @var{name}.  "
 137            "@var{font} must be available as an AFM file.  If the glyph "
 138            "is not available, return @code{#f}.")
 139 {
 140   Font_metric *fm = unsmob_metrics (font);
 141   SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
 142   SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG2, __FUNCTION__, "string");
 143
 144   Stencil m = fm->find_by_name (ly_scm2string (name));
 145
 146   /* TODO: make optional argument for default if not found.  */
 147   return m.smobbed_copy ();
 148 }
 149
 150 LY_DEFINE (ly_get_glyph, "ly:get-glyph",
 151            2, 0, 0,
 152           (SCM font, SCM index),
 153            "Retrieve a Stencil for the glyph numbered @var{index} "
 154            "in @var{font}.")
 155 {
 156   Font_metric *fm = unsmob_metrics (font);
 157   SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
 158   SCM_ASSERT_TYPE (scm_is_number (index), index, SCM_ARG2, __FUNCTION__, "number");
 159
 160   return fm->get_ascii_char_stencil (scm_to_int (index)).smobbed_copy ();
 161 }
 162
 163 LY_DEFINE (ly_text_dimension,"ly:text-dimension",
 164            2, 0, 0,
 165           (SCM font, SCM text),
 166           "Given the font metric in @var{font} and the string @var{text}, "
 167            "compute the extents of that text in that font.  "
 168            "The return value is a pair of number-pairs.")
 169 {
 170   Box b;
 171   Modified_font_metric*fm = dynamic_cast<Modified_font_metric*>
 172     (unsmob_metrics (font));
 173   SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "modified font metric");
 174   SCM_ASSERT_TYPE (scm_is_string (text), text, SCM_ARG2, __FUNCTION__, "string");
 175
 176   b = fm->text_dimension (ly_scm2string (text));
 177
 178   return scm_cons (ly_interval2scm (b[X_AXIS]), ly_interval2scm (b[Y_AXIS]));
 179 }
 180
 181 LY_DEFINE (ly_font_file_name,"ly:font-file-name",
 182            1, 0, 0,
 183            (SCM font),
 184            "Given the font metric @var{font}, "
 185            "return the corresponding file name.")
 186 {
 187   Font_metric *fm = unsmob_metrics (font);
 188   SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
 189   return scm_car (fm->description_);
 190 }
 191
 192
 193 #include "afm.hh"
 194
 195 LY_DEFINE (ly_font_name,"ly:font-name",
 196            1, 0, 0,
 197            (SCM font),
 198            "Given the font metric @var{font}, "
 199            "return the corresponding name.")
 200 {
 201   Font_metric *fm = unsmob_metrics (font);
 202
 203   SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
 204
 205
 206   if (Modified_font_metric* mfm = dynamic_cast<Modified_font_metric*> (fm))
 207     return ly_font_name (mfm->original_font ()->self_scm ());
 208   else if (Adobe_font_metric* afm = dynamic_cast<Adobe_font_metric*> (fm))
 209     {
 210       return scm_makfrom0str (afm->font_info_->gfi->fontName);
 211     }
 212   else
 213     return SCM_BOOL_F;
 214 }
 215
 216
 217
 218 LY_DEFINE (ly_font_magnification,"ly:font-magnification", 1 , 0, 0,
 219           (SCM font),
 220            "Given the font metric @var{font}, return the "
 221            "magnification, relative to the current outputscale.")
 222 {
 223   Font_metric *fm = unsmob_metrics (font);
 224   SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
 225   return scm_cdr (fm->description_);
 226 }
 227
 228 LY_DEFINE (ly_font_design_size,"ly:font-design-size", 1 , 0, 0,
 229           (SCM font),
 230            "Given the font metric @var{font}, return the "
 231            "design size, relative to the current outputscale.")
 232 {
 233   Font_metric *fm = unsmob_metrics (font);
 234   SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
 235   return scm_make_real (fm->design_size ());
 236 }
 237
 238
 239
 240 int
 241 Font_metric::index_to_ascii (int i) const
 242 {
 243   return i;
 244 }
 245
 246 Stencil
 247 Font_metric::get_ascii_char_stencil (int code) const
 248 {
 249   SCM at = scm_list_3 (ly_symbol2scm ("char"),
 250                        this->self_scm (),
 251                        scm_int2num (code));
 252   Box b = get_ascii_char (code);
 253   return Stencil (b, at);
 254 }
 255
 256 Stencil
 257 Font_metric::get_indexed_char_stencil (int code) const
 258 {
 259   int idx = index_to_ascii (code);
 260   SCM at = scm_list_3 (ly_symbol2scm ("char"), self_scm (), scm_int2num (idx));
 261   Box b = get_indexed_char (code);
 262   return Stencil (b, at);
 263 }
 264
 265 int
 266 /*Font_metric::*/
 267 get_encoded_index (Font_metric *m, String input_coding, int code)
 268 {
 269   String font_coding = m->coding_scheme ();
 270   if (font_coding == input_coding)
 271     return code;
 272   SCM s = scm_call_3 (ly_scheme_function ("encoded-index"),
 273                       scm_makfrom0str (input_coding.to_str0 ()),
 274                       scm_makfrom0str (font_coding.to_str0 ()),
 275                       scm_int2num (code));
 276   return scm_to_int (s);
 277 }