lily/accidental.cc

   1 /*
   2   accidental.cc -- implement Accidental_interface
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2001--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "accidental-interface.hh"
  10 #include "font-interface.hh"
  11 #include "international.hh"
  12 #include "item.hh"
  13 #include "output-def.hh"
  14 #include "paper-column.hh"
  15 #include "pitch.hh"
  16 #include "stencil.hh"
  17
  18 Stencil
  19 parenthesize (Grob *me, Stencil m)
  20 {
  21   Font_metric * font
  22     = Font_interface::get_default_font (me);
  23   Stencil open
  24     = font->find_by_name ("accidentals.leftparen");
  25   Stencil close
  26     = font->find_by_name ("accidentals.rightparen");
  27
  28   m.add_at_edge (X_AXIS, LEFT, Stencil (open), 0);
  29   m.add_at_edge (X_AXIS, RIGHT, Stencil (close), 0);
  30
  31   return m;
  32 }
  33
  34 /* If this gets called before line breaking, we will return a non-trivial
  35    extent even if we belong to a tie and won't actually get printed. */
  36 static SCM
  37 get_extent (Grob *me, Axis a)
  38 {
  39   Stencil *s = unsmob_stencil (Accidental_interface::get_stencil (me));
  40
  41   if (s)
  42     return ly_interval2scm (s->extent (a));
  43   return ly_interval2scm (Interval ());
  44 }
  45
  46 MAKE_SCHEME_CALLBACK (Accidental_interface, height, 1);
  47 SCM
  48 Accidental_interface::height (SCM smob)
  49 {
  50   return get_extent (unsmob_grob (smob), Y_AXIS);
  51 }
  52
  53 MAKE_SCHEME_CALLBACK (Accidental_interface, width, 1);
  54 SCM
  55 Accidental_interface::width (SCM smob)
  56 {
  57   return get_extent (unsmob_grob (smob), X_AXIS);
  58 }
  59
  60 MAKE_SCHEME_CALLBACK (Accidental_interface, pure_height, 3);
  61 SCM
  62 Accidental_interface::pure_height (SCM smob, SCM start_scm, SCM)
  63 {
  64   Item *me = dynamic_cast<Item*> (unsmob_grob (smob));
  65   int start = scm_to_int (start_scm);
  66   int rank = me->get_column ()->get_rank ();
  67
  68   if (to_boolean (me->get_property ("forced"))
  69       || !unsmob_grob (me->get_object ("tie"))
  70       || (rank == start + 1 && /* we are at the start of a line */
  71           !to_boolean (me->get_property ("hide-tied-accidental-after-break"))))
  72     {
  73       Stencil *s = unsmob_stencil (get_stencil (me));
  74       if (s)
  75         return ly_interval2scm (s->extent (Y_AXIS));
  76     }
  77
  78   return ly_interval2scm (Interval ());
  79 }
  80
  81 vector<Box>
  82 Accidental_interface::accurate_boxes (Grob *me, Grob **common)
  83 {
  84   Box b;
  85   b[X_AXIS] = me->extent (me, X_AXIS);
  86   b[Y_AXIS] = me->extent (me, Y_AXIS);
  87
  88   vector<Box> boxes;
  89
  90   bool parens = to_boolean (me->get_property ("parenthesized"));
  91   if (!me->is_live ())
  92     return boxes;
  93
  94   if (!to_boolean (me->get_property ("restore-first"))
  95       && !parens)
  96     {
  97       SCM alist = me->get_property ("glyph-name-alist");
  98       SCM alt = me->get_property ("alteration");
  99       string glyph_name = robust_scm2string (ly_assoc_get (alt, alist, SCM_BOOL_F),
 100                                              "");
 101
 102       if (glyph_name == "accidentals.flat"
 103           || glyph_name == "accidentals.mirroredflat")
 104         {
 105           Box stem = b;
 106           Box bulb = b;
 107
 108           /*
 109             we could make the stem thinner, but that places the flats
 110             really close.
 111           */
 112           Direction bulb_dir =
 113             glyph_name == "accidentals.mirroredflat" ? LEFT : RIGHT;
 114           stem[X_AXIS][bulb_dir] = stem[X_AXIS].center ();
 115
 116           /*
 117             To prevent vertical alignment for 6ths
 118           */
 119           stem[Y_AXIS] *= 1.1;
 120           bulb[Y_AXIS][UP] *= .35;
 121
 122           boxes.push_back (bulb);
 123           boxes.push_back (stem);
 124         }
 125       else if (glyph_name ==  "accidentals.natural")
 126         {
 127           Box lstem = b;
 128           Box rstem = b;
 129           Box belly = b;
 130
 131           lstem[Y_AXIS] *= 1.1;
 132           rstem[Y_AXIS] *= 1.1;
 133
 134           belly[Y_AXIS] *= 0.75;
 135           lstem[X_AXIS][RIGHT] *= .33;
 136           rstem[X_AXIS][LEFT] = rstem[X_AXIS].linear_combination (1.0 / 3.0);
 137           lstem[Y_AXIS][DOWN] = belly[Y_AXIS][DOWN];
 138           rstem[Y_AXIS][UP] = belly[Y_AXIS][UP];
 139           boxes.push_back (belly);
 140           boxes.push_back (lstem);
 141           boxes.push_back (rstem);
 142         }
 143       /*
 144         TODO: add support for, double flat.
 145       */
 146     }
 147
 148   if (!boxes.size ())
 149     boxes.push_back (b);
 150
 151   Offset o (me->relative_coordinate (common[X_AXIS], X_AXIS),
 152             me->relative_coordinate (common[Y_AXIS], Y_AXIS));
 153
 154   for (vsize i = boxes.size (); i--;)
 155     boxes[i].translate (o);
 156
 157   return boxes;
 158 }
 159
 160 MAKE_SCHEME_CALLBACK (Accidental_interface, print, 1);
 161 SCM
 162 Accidental_interface::print (SCM smob)
 163 {
 164   Grob *me = unsmob_grob (smob);
 165   Grob *tie = unsmob_grob (me->get_object ("tie"));
 166
 167   if (tie &&
 168       (to_boolean (me->get_property ("hide-tied-accidental-after-break"))
 169        || (!tie->original () && !to_boolean (me->get_property ("forced")))))
 170     {
 171       me->suicide ();
 172       return SCM_EOL;
 173     }
 174
 175   return get_stencil (me);
 176 }
 177
 178 SCM
 179 Accidental_interface::get_stencil (Grob *me)
 180 {
 181   Font_metric *fm = Font_interface::get_default_font (me);
 182
 183   SCM alist = me->get_property ("glyph-name-alist");
 184   SCM alt = me->get_property ("alteration");
 185   SCM glyph_name = ly_assoc_get (alt, alist, SCM_BOOL_F);
 186
 187   if (!scm_is_string (glyph_name))
 188     {
 189       me->warning (_f ("Could not find glyph-name for alteration %s",
 190                        ly_scm_write_string (alt).c_str ()));
 191       return SCM_EOL;
 192     }
 193
 194   Stencil mol (fm->find_by_name (ly_scm2string (glyph_name)));
 195   if (to_boolean (me->get_property ("restore-first")))
 196     {
 197       /*
 198         this isn't correct for ancient accidentals, but they don't
 199         use double flats/sharps anyway.
 200         */
 201       Stencil acc (fm->find_by_name ("accidentals.natural"));
 202
 203       if (acc.is_empty ())
 204         me->warning (_ ("natural alteration glyph not found"));
 205       else
 206         mol.add_at_edge (X_AXIS, LEFT, acc, 0.1);
 207     }
 208
 209   if (to_boolean (me->get_property ("parenthesized")))
 210     mol = parenthesize (me, mol);
 211
 212   return mol.smobbed_copy ();
 213 }
 214
 215
 216 ADD_INTERFACE (Accidental_interface,
 217                "A single accidental.",
 218
 219                /* properties */
 220                "alteration "
 221                "avoid-slur "
 222                "forced "
 223                "glyph-name-alist "
 224                "hide-tied-accidental-after-break "
 225                "parenthesized "
 226                "restore-first "
 227                "tie "
 228                );