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       SCM alist = me->get_property ("glyph-name-alist");
  76       SCM alt = me->get_property ("alteration");
  77       string glyph_name = robust_scm2string (ly_assoc_get (alt, alist, SCM_BOOL_F),
  78                                              "");
  79
  80       if (glyph_name == "accidentals.flat"
  81           || glyph_name == "accidentals.mirroredflat")
  82         {
  83           Box stem = b;
  84           Box bulb = b;
  85
  86           /*
  87             we could make the stem thinner, but that places the flats
  88             really close.
  89           */
  90           Direction bulb_dir =
  91             glyph_name=="accidentals.mirroredflat" ? LEFT : RIGHT;
  92           stem[X_AXIS][bulb_dir] = stem[X_AXIS].center ();
  93
  94           /*
  95             To prevent vertical alignment for 6ths
  96           */
  97           stem[Y_AXIS] *= 1.1;
  98           bulb[Y_AXIS][UP] *= .35;
  99
 100           boxes.push_back (bulb);
 101           boxes.push_back (stem);
 102         }
 103       else if (glyph_name ==  "accidentals.natural")
 104         {
 105           Box lstem = b;
 106           Box rstem = b;
 107           Box belly = b;
 108
 109           lstem[Y_AXIS] *= 1.1;
 110           rstem[Y_AXIS] *= 1.1;
 111
 112           belly[Y_AXIS] *= 0.75;
 113           lstem[X_AXIS][RIGHT] *= .33;
 114           rstem[X_AXIS][LEFT] = rstem[X_AXIS].linear_combination (1.0 / 3.0);
 115           lstem[Y_AXIS][DOWN] = belly[Y_AXIS][DOWN];
 116           rstem[Y_AXIS][UP] = belly[Y_AXIS][UP];
 117           boxes.push_back (belly);
 118           boxes.push_back (lstem);
 119           boxes.push_back (rstem);
 120         }
 121       /*
 122         TODO: add support for, double flat.
 123       */
 124     }
 125
 126   if (!boxes.size ())
 127     boxes.push_back (b);
 128
 129   Offset o (me->relative_coordinate (common[X_AXIS], X_AXIS),
 130             me->relative_coordinate (common[Y_AXIS], Y_AXIS));
 131
 132   for (vsize i = boxes.size (); i--;)
 133     boxes[i].translate (o);
 134
 135   return boxes;
 136 }
 137
 138 MAKE_SCHEME_CALLBACK (Accidental_interface, print, 1);
 139 SCM
 140 Accidental_interface::print (SCM smob)
 141 {
 142   Grob *me = unsmob_grob (smob);
 143   Grob *tie = unsmob_grob (me->get_object ("tie"));
 144
 145   if (tie && !tie->original ()
 146       && !to_boolean (me->get_property ("forced")))
 147     {
 148       me->suicide ();
 149       return SCM_EOL;
 150     }
 151
 152   Font_metric *fm = Font_interface::get_default_font (me);
 153
 154   SCM alist = me->get_property ("glyph-name-alist");
 155   SCM alt = me->get_property ("alteration");
 156   SCM glyph_name = ly_assoc_get (alt, alist, SCM_BOOL_F);
 157
 158   if (!scm_is_string (glyph_name))
 159     {
 160       me->warning (_f ("Could not find glyph-name for alteration %s",
 161                        ly_scm_write_string (alt).c_str ()));
 162       return SCM_EOL;
 163     }
 164
 165   Stencil mol (fm->find_by_name (scm_i_string_chars (glyph_name)));
 166   if (to_boolean (me->get_property ("restore-first")))
 167     {
 168       /*
 169         this isn't correct for ancient accidentals, but they don't
 170         use double flats/sharps anyway.
 171         */
 172       Stencil acc (fm->find_by_name ("accidentals.natural"));
 173
 174       if (acc.is_empty ())
 175         me->warning (_ ("natural alteration glyph not found"));
 176       else
 177         mol.add_at_edge (X_AXIS, LEFT, acc, 0.1);
 178     }
 179
 180   if (to_boolean (me->get_property ("parenthesized")))
 181     mol = parenthesize (me, mol);
 182
 183   return mol.smobbed_copy ();
 184 }
 185
 186
 187 ADD_INTERFACE (Accidental_interface,
 188                "a single accidental",
 189
 190                /* props */
 191                "alteration "
 192                "avoid-slur "
 193                "forced "
 194                "parenthesized "
 195                "restore-first "
 196                "glyph-name-alist "
 197                "tie "
 198                );