lily/text-item.cc

   1 /*
   2   text-item.cc -- implement Text_item
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6  (c) 1998--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7   Jan Nieuwenhuizen <janneke@gnu.org>
   8  */
   9 #include <math.h>
  10
  11 #include "debug.hh"
  12 #include "text-item.hh"
  13 #include "paper-def.hh"
  14 #include "font-metric.hh"
  15 #include "staff-symbol-referencer.hh"
  16 #include "staff-symbol-referencer.hh"
  17 #include "main.hh"
  18 #include "all-font-metrics.hh"
  19 #include "afm.hh"
  20
  21
  22 /*
  23     TEXT : STRING | (MARKUP SENTENCE)
  24     MARKUP: PROPERTY | ABBREV
  25     SENTENCE: TEXT | SENTENCE TEXT
  26     PROPERTY: (key . value)
  27     ABBREV: rows lines roman music bold italic named super sub text, or any font-style
  28  */
  29
  30 /*
  31   TODO:
  32
  33   rewrite routines and syntax to be like
  34
  35   TEXT: STRING
  36       | (head-expression* TEXT*)
  37       ;
  38
  39   head-expression is a list, containing a tag and a variable number of
  40   arguments. If necessary, the number of arguments can be stored in a alist,
  41
  42   '(
  43    (tag1 . argcount1)
  44    (tag2 . argcount2)
  45
  46    ... etc
  47
  48    )
  49
  50    or even entries like
  51
  52    (tag . (argcount function-to-handle-the-tag  ))
  53
  54  */
  55
  56 Molecule
  57 Text_item::text2molecule (Score_element *me, SCM text, SCM alist_chain)
  58 {
  59   if (gh_string_p (text))
  60     return string2molecule (me, text, alist_chain);
  61   else if (gh_list_p (text))
  62     {
  63       if (!gh_pair_p (gh_car (text)) && gh_string_p (gh_car (text)))
  64         return string2molecule (me, gh_car (text), alist_chain);
  65       else
  66         return markup_sentence2molecule (me, text, alist_chain);
  67     }
  68   return Molecule ();
  69 }
  70
  71 SCM
  72 ly_assoc_chain (SCM key, SCM achain)
  73 {
  74   if (gh_pair_p (achain))
  75     {
  76       SCM handle = scm_assoc (key, gh_car (achain));
  77       if (gh_pair_p (handle))
  78         return handle;
  79       else
  80         return ly_assoc_chain (key, gh_cdr (achain));
  81     }
  82   else
  83     return SCM_BOOL_F;
  84 }
  85
  86 Molecule
  87 Text_item::string2molecule (Score_element *me, SCM text, SCM alist_chain)
  88 {
  89   SCM style = ly_assoc_chain (ly_symbol2scm ("font-style"),
  90                               alist_chain);
  91   if  (gh_pair_p (style))
  92     style = gh_cdr (style);
  93
  94   SCM sheet = me->paper_l ()->style_sheet_;
  95
  96   if (gh_symbol_p (style))
  97     {
  98       SCM style_alist = gh_cdr (scm_assoc (ly_symbol2scm ("style-alist"), sheet));
  99       SCM entry = scm_assoc (style, style_alist);
 100       entry = gh_pair_p (entry) ? gh_cdr (entry) : SCM_EOL;
 101       alist_chain = gh_cons (entry, alist_chain);
 102     }
 103
 104   SCM fonts = gh_cdr (scm_assoc (ly_symbol2scm ("fonts"), sheet));
 105   SCM proc  = gh_cdr (scm_assoc (ly_symbol2scm ("properties-to-font"), sheet));
 106   SCM font_name = gh_call2 (proc, fonts, alist_chain);
 107
 108   SCM lookup = ly_assoc_chain (ly_symbol2scm ("lookup"), alist_chain);
 109
 110   Molecule mol;
 111   if (gh_pair_p (lookup) && ly_symbol2string (gh_cdr (lookup)) == "name")
 112     mol = lookup_character (me, font_name, text);
 113   else
 114     mol = lookup_text (me, font_name, text);
 115
 116   return mol;
 117 }
 118
 119 Molecule
 120 Text_item::lookup_character (Score_element *me, SCM font_name, SCM char_name)
 121 {
 122   Adobe_font_metric *afm = all_fonts_global_p->find_afm (ly_scm2string (font_name));
 123
 124   if (!afm)
 125     {
 126       warning (_f ("can't find font: `%s'", ly_scm2string (font_name)));
 127       warning (_f ("(search path: `%s')", global_path.str ().ch_C()));
 128       error (_ ("Aborting"));
 129     }
 130   Font_metric * fm = afm;
 131
 132   return fm->find_by_name (ly_scm2string (char_name));
 133 }
 134
 135
 136 Molecule
 137 Text_item::lookup_text (Score_element *me, SCM font_name, SCM text)
 138 {
 139   SCM magnification = me->get_elt_property ("font-magnification");
 140   Font_metric* metric = 0;
 141   if (gh_number_p (magnification))
 142     {
 143       Real realmag = pow (1.2, gh_scm2int (magnification));
 144       metric = all_fonts_global_p->find_scaled (ly_scm2string (font_name), realmag);
 145     }
 146   else
 147     metric = all_fonts_global_p->find_font (ly_scm2string (font_name));
 148
 149   SCM list = gh_list (ly_symbol2scm ("text"), text, SCM_UNDEFINED);
 150   list = fontify_atom (metric, list);
 151
 152   return Molecule (metric->text_dimension (ly_scm2string (text)), list);
 153 }
 154
 155 Molecule
 156 Text_item::markup_sentence2molecule (Score_element *me, SCM markup_sentence,
 157                                      SCM alist_chain)
 158 {
 159   SCM sheet = me->paper_l ()->style_sheet_;
 160   SCM f = gh_cdr (scm_assoc (ly_symbol2scm ("markup-to-properties"), sheet));
 161   SCM markup = gh_car (markup_sentence);
 162   SCM sentence = gh_cdr (markup_sentence);
 163
 164   SCM p = gh_cons  (gh_call2 (f, sheet, markup), alist_chain);
 165
 166   Axis align = X_AXIS;
 167   SCM a = ly_assoc_chain (ly_symbol2scm ("align"), p);
 168   if (gh_pair_p (a) && gh_number_p (gh_cdr (a)))
 169     align = (Axis)gh_scm2int (gh_cdr (a));
 170
 171   Real staff_space = Staff_symbol_referencer::staff_space (me);
 172   Real kern = 0;
 173   SCM k = ly_assoc_chain (ly_symbol2scm ("kern"), p);
 174   if (gh_pair_p (k) && gh_number_p (gh_cdr (k)))
 175     kern = gh_scm2double (gh_cdr (k)) * staff_space;
 176
 177   Real raise = 0;
 178   SCM r = ly_assoc_chain (ly_symbol2scm ("raise"), p);
 179   if (gh_pair_p (r) && gh_number_p (gh_cdr (r)))
 180     raise = gh_scm2double (gh_cdr (r)) * staff_space;
 181
 182   Offset o (align == X_AXIS ? kern : 0,
 183             (align == Y_AXIS ? - kern : 0) + raise);
 184
 185   Molecule mol;
 186   while (gh_pair_p (sentence))
 187     {
 188       Molecule m = text2molecule (me, gh_car (sentence), p);
 189       if (!m.empty_b ())
 190         {
 191           m.translate (o);
 192           mol.add_at_edge (align, align == X_AXIS ? RIGHT : DOWN, m, 0);
 193         }
 194       sentence = gh_cdr (sentence);
 195     }
 196   return mol;
 197 }
 198
 199 MAKE_SCHEME_CALLBACK (Text_item, brew_molecule, 1);
 200 SCM
 201 Text_item::brew_molecule (SCM smob)
 202 {
 203   Score_element *me = unsmob_element (smob);
 204
 205   SCM text = me->get_elt_property ("text");
 206
 207   SCM properties = gh_list (me->immutable_property_alist_,
 208                             me->mutable_property_alist_, SCM_UNDEFINED);
 209
 210   Molecule mol = Text_item::text2molecule (me, text, properties);
 211
 212   SCM space = me->get_elt_property ("word-space");
 213   if (gh_number_p (space))
 214     {
 215       Molecule m;
 216       m.set_empty (false);
 217       mol.add_at_edge (X_AXIS, RIGHT, m, gh_scm2double (space)
 218                        * Staff_symbol_referencer::staff_space (me));
 219     }
 220   return mol.create_scheme ();
 221 }
 222