lily/accidental.cc

   1 /*
   2   accidental.cc -- implement Accidental_interface
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2001--2007 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
  35 /* This callback exists for the sole purpose of allowing us to override
  36    its pure equivalent to accidental-interface::pure-height */
  37 MAKE_SCHEME_CALLBACK (Accidental_interface, height, 1);
  38 SCM
  39 Accidental_interface::height (SCM smob)
  40 {
  41   return Grob::stencil_height (smob);
  42 }
  43
  44 MAKE_SCHEME_CALLBACK (Accidental_interface, pure_height, 3);
  45 SCM
  46 Accidental_interface::pure_height (SCM smob, SCM start_scm, SCM)
  47 {
  48   Item *me = dynamic_cast<Item*> (unsmob_grob (smob));
  49   int start = scm_to_int (start_scm);
  50   int rank = me->get_column ()->get_rank ();
  51
  52   bool visible = to_boolean (me->get_property ("forced"))
  53     || !unsmob_grob (me->get_object ("tie"))
  54     || rank != start + 1; /* we are in the middle of a line */
  55
  56   return visible ? Grob::stencil_height (smob) : ly_interval2scm (Interval ());
  57 }
  58
  59 vector<Box>
  60 Accidental_interface::accurate_boxes (Grob *me, Grob **common)
  61 {
  62   Box b;
  63   b[X_AXIS] = me->extent (me, X_AXIS);
  64   b[Y_AXIS] = me->extent (me, Y_AXIS);
  65
  66   vector<Box> boxes;
  67
  68   bool parens = to_boolean (me->get_property ("parenthesized"));
  69   if (!me->is_live ())
  70     return boxes;
  71
  72   if (!to_boolean (me->get_property ("restore-first"))
  73       && !parens)
  74     {
  75       Rational alteration
  76         = robust_scm2rational (me->get_property ("alteration"), 0);
  77       if (alteration == FLAT_ALTERATION)
  78         {
  79           Box stem = b;
  80           Box bulb = b;
  81
  82           /*
  83             we could make the stem thinner, but that places the flats
  84             really close.
  85           */
  86           stem[X_AXIS][RIGHT] *= .5;
  87
  88           /*
  89             To prevent vertical alignment for 6ths
  90           */
  91           stem[Y_AXIS] *= 1.1;
  92           bulb[Y_AXIS][UP] *= .35;
  93
  94           boxes.push_back (bulb);
  95           boxes.push_back (stem);
  96         }
  97       else if (alteration == NATURAL_ALTERATION)
  98         {
  99           Box lstem = b;
 100           Box rstem = b;
 101           Box belly = b;
 102
 103           lstem[Y_AXIS] *= 1.1;
 104           rstem[Y_AXIS] *= 1.1;
 105
 106           belly[Y_AXIS] *= 0.75;
 107           lstem[X_AXIS][RIGHT] *= .33;
 108           rstem[X_AXIS][LEFT] = rstem[X_AXIS].linear_combination (1.0 / 3.0);
 109           lstem[Y_AXIS][DOWN] = belly[Y_AXIS][DOWN];
 110           rstem[Y_AXIS][UP] = belly[Y_AXIS][UP];
 111           boxes.push_back (belly);
 112           boxes.push_back (lstem);
 113           boxes.push_back (rstem);
 114         }
 115       /*
 116         TODO: add support for, double flat.
 117       */
 118     }
 119
 120   if (!boxes.size ())
 121     boxes.push_back (b);
 122
 123   Offset o (me->relative_coordinate (common[X_AXIS], X_AXIS),
 124             me->relative_coordinate (common[Y_AXIS], Y_AXIS));
 125
 126   for (vsize i = boxes.size (); i--;)
 127     boxes[i].translate (o);
 128
 129   return boxes;
 130 }
 131
 132 MAKE_SCHEME_CALLBACK (Accidental_interface, print, 1);
 133 SCM
 134 Accidental_interface::print (SCM smob)
 135 {
 136   Grob *me = unsmob_grob (smob);
 137   Grob *tie = unsmob_grob (me->get_object ("tie"));
 138
 139   if (tie && !tie->original ()
 140       && !to_boolean (me->get_property ("forced")))
 141     {
 142       me->suicide ();
 143       return SCM_EOL;
 144     }
 145
 146   Font_metric *fm = Font_interface::get_default_font (me);
 147
 148   SCM alist = me->get_property ("glyph-name-alist");
 149   SCM alt = me->get_property ("alteration");
 150   SCM glyph_name = ly_assoc_get (alt, alist, SCM_BOOL_F);
 151
 152   if (!scm_is_string (glyph_name))
 153     {
 154       me->warning (_f ("Could not find glyph-name for alteration %s",
 155                        ly_scm_write_string (alt).c_str ()));
 156       return SCM_EOL;
 157     }
 158
 159   Stencil mol (fm->find_by_name (scm_i_string_chars (glyph_name)));
 160   if (to_boolean (me->get_property ("restore-first")))
 161     {
 162       /*
 163         this isn't correct for ancient accidentals, but they don't
 164         use double flats/sharps anyway.
 165         */
 166       Stencil acc (fm->find_by_name ("accidentals.natural"));
 167
 168       if (acc.is_empty ())
 169         me->warning (_ ("natural alteration glyph not found"));
 170       else
 171         mol.add_at_edge (X_AXIS, LEFT, acc, 0.1);
 172     }
 173
 174   if (to_boolean (me->get_property ("parenthesized")))
 175     mol = parenthesize (me, mol);
 176
 177   return mol.smobbed_copy ();
 178 }
 179
 180
 181 ADD_INTERFACE (Accidental_interface,
 182                "a single accidental",
 183
 184                /* props */
 185                "alteration "
 186                "avoid-slur "
 187                "forced "
 188                "parenthesized "
 189                "restore-first "
 190                "glyph-name-alist "
 191                "tie "
 192                );