lily/tfm-reader.cc

   1 /*
   2   tfm-reader.cc -- implement Tex_font_metric_reader
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999--2005 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8
   9   some code shamelessly copied from GNU fontutils-0.6/tfm/tfm_input.c
  10 */
  11
  12 #include "tfm-reader.hh"
  13
  14 #include "string-convert.hh"
  15 #include "warn.hh"
  16
  17 #define format_string String_convert::form_string
  18 #define FIX_UNITY                               \
  19   (1 << 20)
  20 static const Real fix_to_real (Fix f);
  21
  22 Tex_font_metric_reader::Tex_font_metric_reader (String name)
  23   : input_ (name)
  24 {
  25
  26   for (int i = 0; i < TFM_SIZE; i++)
  27     ascii_to_metric_idx_.push (-1);
  28
  29   read_header ();
  30   read_params ();
  31   read_char_metrics ();
  32
  33 }
  34
  35 static const Real
  36 fix_to_real (Fix f)
  37 {
  38   Real r = f / FIX_UNITY + ((Real) (f % FIX_UNITY) / (Real) FIX_UNITY);
  39   return r;
  40 }
  41
  42 /* Most quantities are fixed-point fractions.  */
  43
  44 Real
  45 Tex_font_metric_reader::get_U32_fix ()
  46 {
  47   return fix_to_real (input_.get_U32 ());
  48 }
  49
  50 /* Dimensions are a `Fix' scaled by the design size.  */
  51
  52 Real
  53 Tex_font_metric_reader::get_U32_fix_scaled ()
  54 {
  55   return get_U32_fix () * info_.design_size;
  56 }
  57
  58 String
  59 Tex_font_metric_reader::get_bcpl_string ()
  60 {
  61   U8 length_u8 = input_.get_U8 ();
  62   String str = input_.get_string (length_u8);
  63   return str;
  64 }
  65
  66 /* Here we read the information at the beginning of the file.  We store
  67    the result into the static variables `global_info' and
  68    `tfm_header'.  */
  69 void
  70 Tex_font_metric_reader::read_header ()
  71 {
  72   U16 file_length = input_.get_U16 ();
  73   (void) file_length;
  74   U16 header_length = input_.get_U16 ();
  75
  76   info_.first_charcode = input_.get_U16 ();
  77   info_.last_charcode = input_.get_U16 ();
  78   U16 width_word_count = input_.get_U16 ();
  79   U16 height_word_count = input_.get_U16 ();
  80   U16 depth_word_count = input_.get_U16 ();
  81   U16 italic_correction_word_count = input_.get_U16 ();
  82   U16 lig_kern_word_count = input_.get_U16 ();
  83   U16 kern_word_count = input_.get_U16 ();
  84   (void)kern_word_count;
  85   U16 extensible_word_count = input_.get_U16 ();
  86   (void)extensible_word_count;
  87
  88   header_.param_word_count = input_.get_U16 ();
  89   info_.parameter_count = header_.param_word_count;
  90
  91   header_.char_info_pos = (6 + header_length) * 4;
  92   header_.width_pos = header_.char_info_pos
  93     + (info_.last_charcode
  94        - info_.first_charcode + 1) * 4;
  95   header_.height_pos = header_.width_pos + width_word_count * 4;
  96   header_.depth_pos = header_.height_pos + height_word_count * 4;
  97   header_.italic_correction_pos = header_.depth_pos
  98     + depth_word_count * 4;
  99   header_.lig_kern_pos = header_.italic_correction_pos
 100     + italic_correction_word_count * 4;
 101   header_.kern_pos = header_.lig_kern_pos + lig_kern_word_count * 4;
 102   /* We don't care about the extensible table.  */
 103
 104   if (header_length < 2)
 105     /* Not using ngettext's plural feature here, as this message is
 106        more of a programming error.  */
 107     error (_f ("TFM header of `%s' has only %u word (s)",
 108                input_.name_string ().to_str0 (), header_length));
 109
 110   info_.checksum = input_.get_U32 ();
 111   info_.design_size = get_U32_fix ();
 112
 113   /* Although the coding scheme might be interesting to the caller, the
 114      font family and face byte probably aren't.  So we don't read them.  */
 115   info_.coding_scheme = header_length > 2
 116     ? get_bcpl_string () : "unspecified";
 117
 118 }
 119
 120 /* Although TFM files are only usable by TeX if they have at least seven
 121    parameters, that is not a requirement of the file format itself, so
 122    we don't impose it.  And they can have many more than seven, of
 123    course.  We do impose a limit of TFM_MAX_FONT_PARAMETERS.  We assume
 124    that `tfm_header' has already been filled in.  */
 125
 126 void
 127 Tex_font_metric_reader::read_params ()
 128 {
 129   /* If we have no font parameters at all, we're done.  */
 130   if (header_.param_word_count == 0)
 131     return;
 132
 133   //brrr
 134   /* Move to the beginning of the parameter table in the file.  */
 135   input_.seek_str0 (-4 * header_.param_word_count);
 136
 137   /* It's unlikely but possible that this TFM file has more fontdimens
 138      than we can deal with.  */
 139   if (header_.param_word_count > TFM_MAX_FONTDIMENS)
 140     {
 141       warning (_f ("%s: TFM file has %u parameters, which is more than the %u I can handle",
 142                    input_.name_string ().to_str0 (),
 143                    header_.param_word_count,
 144                    TFM_MAX_FONTDIMENS));
 145       header_.param_word_count = TFM_MAX_FONTDIMENS;
 146     }
 147
 148   /* The first parameter is different than all the rest, because it
 149      isn't scaled by the design size.  */
 150   info_.parameters[ (TFM_SLANT_PARAMETER) - 1] = get_U32_fix ();
 151
 152   for (Char_code i = 2; i <= header_.param_word_count; i++)
 153     info_.parameters[i - 1] = get_U32_fix_scaled ();
 154
 155 }
 156
 157 /* Read every character in the TFM file, storing the result in the
 158    static `tfm_char_table'.  We return a copy of that variable.  */
 159
 160 void
 161 Tex_font_metric_reader::read_char_metrics ()
 162 {
 163   for (int i = info_.first_charcode; i <= info_.last_charcode; i++)
 164     {
 165       Tex_font_char_metric tfm_char = read_char_metric (i);
 166       if (tfm_char.exists_)
 167         ascii_to_metric_idx_[tfm_char.code_] = char_metrics_.size ();
 168       char_metrics_.push (tfm_char);
 169     }
 170 }
 171
 172 /* Read the character CODE.  If the character doesn't exist, return
 173    NULL.  If it does, save the information in `tfm_char_table', as well
 174    as returning it.  */
 175
 176 Tex_font_char_metric
 177 Tex_font_metric_reader::read_char_metric (Char_code code)
 178 {
 179   Tex_font_char_metric tfm_char;
 180
 181   /* If the character is outside the declared bounds in the file, don't
 182      try to read it. */
 183   if (code < info_.first_charcode || code > info_.last_charcode)
 184     return tfm_char;
 185
 186   //brr
 187   /* Move to the appropriate place in the `char_info' array.  */
 188   input_.seek_str0 (header_.char_info_pos + (code - info_.first_charcode) * 4);
 189
 190   /* Read the character.  */
 191   tfm_char = read_char ();
 192
 193   if (tfm_char.exists_)
 194     tfm_char.code_ = code;
 195
 196   return tfm_char;
 197 }
 198
 199 /* We assume we are positioned at the beginning of a `char_info' word.
 200    We read that word to get the indexes into the dimension tables; then
 201    we go read the tables to get the values (if the character exists).  */
 202
 203 Tex_font_char_metric
 204 Tex_font_metric_reader::read_char ()
 205 {
 206   /* Read the char_info word.  */
 207   U8 width_index = input_.get_U8 ();
 208
 209   U8 packed;
 210   packed = input_.get_U8 ();
 211   U8 height_index = (packed & 0xf0) >> 4;
 212   U8 depth_index = packed & 0x0f;
 213
 214   packed = input_.get_U8 ();
 215   U8 italic_correction_index = (packed & 0xfc) >> 6;
 216   U8 tag = packed & 0x3;
 217
 218   U8 remainder = input_.get_U8 ();
 219
 220   Tex_font_char_metric tfm_char;
 221
 222 #define GET_CHAR_DIMEN(d)                                       \
 223   if (d##_index != 0)                                           \
 224     {                                                           \
 225       input_.seek_str0 (header_. d##_pos + d##_index*4);        \
 226       tfm_char.d##_fix_ = input_.get_U32 ();                    \
 227       tfm_char.d##_ = fix_to_real (tfm_char.d##_fix_)           \
 228         * info_.design_size;                                    \
 229     }
 230
 231   GET_CHAR_DIMEN (width);
 232   GET_CHAR_DIMEN (height);
 233   GET_CHAR_DIMEN (depth);
 234   GET_CHAR_DIMEN (italic_correction);
 235
 236   /* The other condition for a character existing is that it be between
 237      the first and last character codes given in the header.  We've
 238      already assumed that's true (or we couldn't be positioned at a
 239      `char_info_word').  */
 240   tfm_char.exists_ = width_index != 0;
 241
 242   if (tag == 1)
 243     {
 244       input_.seek_str0 (header_.lig_kern_pos + remainder * 4);
 245       read_lig_kern_program (&tfm_char.ligatures_, &tfm_char.kerns_);
 246     }
 247
 248   /* We don't handle the other tags.  */
 249   return tfm_char;
 250 }
 251
 252 /* Read a ligature/kern program at the current position, storing the
 253    result into *LIGATURE and *KERN.  We don't distinguish all the kinds
 254    of ligatures that Metafont can output.  */
 255
 256 #define STOP_FLAG 128
 257 #define KERN_FLAG 128
 258
 259 void
 260 Tex_font_metric_reader::read_lig_kern_program (Array<Tfm_ligature>* ligatures, Array<Tfm_kern>* kerns)
 261 {
 262   bool end_b;
 263
 264   do
 265     {
 266       end_b = input_.get_U8 () >= STOP_FLAG;
 267
 268       U8 next_char = input_.get_U8 ();
 269       bool kern_step_b = input_.get_U8 () >= KERN_FLAG;
 270       U8 remainder = input_.get_U8 ();
 271
 272       if (kern_step_b)
 273         {
 274           Tfm_kern kern_element;
 275           kern_element.character = next_char;
 276
 277           char const *old_pos = input_.pos_str0 ();
 278           input_.seek_str0 (header_.kern_pos + remainder * 4);
 279           kern_element.kern = get_U32_fix_scaled ();
 280           input_.set_pos (old_pos);
 281
 282           kerns->push (kern_element);
 283
 284         }
 285       else
 286         {
 287           Tfm_ligature ligature_element;
 288           ligature_element.character = next_char;
 289           ligature_element.ligature = remainder;
 290           ligatures->push (ligature_element);
 291
 292         }
 293     }
 294   while (!end_b);
 295
 296 }
 297