]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/accidental.cc
Improvements in vertical skyline approximations (issue 2148).
[lilypond.git] / lily / accidental.cc
index f6672e815b7d4f1469e447a462cbd8f774776d64..3cc399f84d30f03d2fee4b25d51d617bc06ff317 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  accidental.cc -- implement Accidental_interface
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2001--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2001--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "accidental-interface.hh"
 #include "international.hh"
 #include "item.hh"
 #include "output-def.hh"
+#include "paper-column.hh"
 #include "pitch.hh"
 #include "stencil.hh"
 
 Stencil
 parenthesize (Grob *me, Stencil m)
 {
-  Font_metric * font
-    = Font_interface::get_default_font (me); 
+  Font_metric *font
+    = Font_interface::get_default_font (me);
   Stencil open
     = font->find_by_name ("accidentals.leftparen");
   Stencil close
     = font->find_by_name ("accidentals.rightparen");
 
-  m.add_at_edge (X_AXIS, LEFT, Stencil (open), 0, 0);
-  m.add_at_edge (X_AXIS, RIGHT, Stencil (close), 0, 0);
+  m.add_at_edge (X_AXIS, LEFT, Stencil (open), 0);
+  m.add_at_edge (X_AXIS, RIGHT, Stencil (close), 0);
 
   return m;
 }
 
-/*
-  Hmm. Need separate callback, or perhaps #'live bool property.
- */
-MAKE_SCHEME_CALLBACK (Accidental_interface, after_line_breaking, 1);
+/* If this gets called before line breaking, we will return a non-trivial
+   extent even if we belong to a tie and won't actually get printed. */
+static SCM
+get_extent (Grob *me, Axis a)
+{
+  Stencil *s = unsmob_stencil (Accidental_interface::get_stencil (me));
+
+  if (s)
+    return ly_interval2scm (s->extent (a));
+  return ly_interval2scm (Interval ());
+}
+
+MAKE_SCHEME_CALLBACK (Accidental_interface, height, 1);
 SCM
-Accidental_interface::after_line_breaking (SCM smob)
+Accidental_interface::height (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
-  Grob *tie = unsmob_grob (me->get_object ("tie"));
+  return get_extent (unsmob_grob (smob), Y_AXIS);
+}
 
-  if (tie && !tie->original ()
-      && !to_boolean (me->get_property ("forced")))
+MAKE_SCHEME_CALLBACK (Accidental_interface, width, 1);
+SCM
+Accidental_interface::width (SCM smob)
+{
+  return get_extent (unsmob_grob (smob), X_AXIS);
+}
+
+MAKE_SCHEME_CALLBACK (Accidental_interface, pure_height, 3);
+SCM
+Accidental_interface::pure_height (SCM smob, SCM start_scm, SCM)
+{
+  Item *me = dynamic_cast<Item *> (unsmob_grob (smob));
+  int start = scm_to_int (start_scm);
+  int rank = me->get_column ()->get_rank ();
+
+  if (to_boolean (me->get_property ("forced"))
+      || !unsmob_grob (me->get_object ("tie"))
+      || (rank == start + 1 && /* we are at the start of a line */
+          !to_boolean (me->get_property ("hide-tied-accidental-after-break"))))
     {
-      me->suicide ();
+      Stencil *s = unsmob_stencil (get_stencil (me));
+      if (s)
+        return ly_interval2scm (s->extent (Y_AXIS));
     }
-  return SCM_UNSPECIFIED;
+
+  return ly_interval2scm (Interval ());
 }
 
 vector<Box>
@@ -59,66 +99,68 @@ Accidental_interface::accurate_boxes (Grob *me, Grob **common)
   vector<Box> boxes;
 
   bool parens = to_boolean (me->get_property ("parenthesized"));
+  if (!me->is_live ())
+    return boxes;
 
-  SCM scm_style = me->get_property ("style");
-  if (!scm_is_symbol (scm_style)
-      && !to_boolean (me->get_property ("restore-first"))
+  if (!to_boolean (me->get_property ("restore-first"))
       && !parens)
     {
-      int acc = scm_to_int (me->get_property ("alteration"));
-      switch (acc)
-       {
-       case FLAT:
-         {
-           Box stem = b;
-           Box bulb = b;
-
-           /*
-             we could make the stem thinner, but that places the flats
-             really close.
-           */
-           stem[X_AXIS][RIGHT] *= .5;
-
-           /*
-             To prevent vertical alignment for 6ths
-           */
-           stem[Y_AXIS] *= 1.1;
-           bulb[Y_AXIS][UP] *= .35;
-
-           boxes.push_back (bulb);
-           boxes.push_back (stem);
-         }
-         break;
-       case NATURAL:
-         {
-           Box lstem = b;
-           Box rstem = b;
-           Box belly = b;
-
-           lstem[Y_AXIS] *= 1.1;
-           rstem[Y_AXIS] *= 1.1;
-
-           belly[Y_AXIS] *= 0.75;
-           lstem[X_AXIS][RIGHT] *= .33;
-           rstem[X_AXIS][LEFT] = rstem[X_AXIS].linear_combination (1.0 / 3.0);
-           lstem[Y_AXIS][DOWN] = belly[Y_AXIS][DOWN];
-           rstem[Y_AXIS][UP] = belly[Y_AXIS][UP];
-           boxes.push_back (belly);
-           boxes.push_back (lstem);
-           boxes.push_back (rstem);
-         }
-         break;
-         /*
-           TODO: add support for, double flat.
-         */
-       }
+      SCM alist = me->get_property ("glyph-name-alist");
+      SCM alt = me->get_property ("alteration");
+      string glyph_name = robust_scm2string (ly_assoc_get (alt, alist, SCM_BOOL_F),
+                                             "");
+
+      if (glyph_name == "accidentals.flat"
+          || glyph_name == "accidentals.mirroredflat")
+        {
+          Box stem = b;
+          Box bulb = b;
+
+          /*
+            we could make the stem thinner, but that places the flats
+            really close.
+          */
+          Direction bulb_dir
+            = glyph_name == "accidentals.mirroredflat" ? LEFT : RIGHT;
+          stem[X_AXIS][bulb_dir] = stem[X_AXIS].center ();
+
+          /*
+            To prevent vertical alignment for 6ths
+          */
+          stem[Y_AXIS] *= 1.1;
+          bulb[Y_AXIS][UP] *= .35;
+
+          boxes.push_back (bulb);
+          boxes.push_back (stem);
+        }
+      else if (glyph_name == "accidentals.natural")
+        {
+          Box lstem = b;
+          Box rstem = b;
+          Box belly = b;
+
+          lstem[Y_AXIS] *= 1.1;
+          rstem[Y_AXIS] *= 1.1;
+
+          belly[Y_AXIS] *= 0.75;
+          lstem[X_AXIS][RIGHT] *= .33;
+          rstem[X_AXIS][LEFT] = rstem[X_AXIS].linear_combination (1.0 / 3.0);
+          lstem[Y_AXIS][DOWN] = belly[Y_AXIS][DOWN];
+          rstem[Y_AXIS][UP] = belly[Y_AXIS][UP];
+          boxes.push_back (belly);
+          boxes.push_back (lstem);
+          boxes.push_back (rstem);
+        }
+      /*
+        TODO: add support for, double flat.
+      */
     }
 
   if (!boxes.size ())
     boxes.push_back (b);
 
   Offset o (me->relative_coordinate (common[X_AXIS], X_AXIS),
-           me->relative_coordinate (common[Y_AXIS], Y_AXIS));
+            me->relative_coordinate (common[Y_AXIS], Y_AXIS));
 
   for (vsize i = boxes.size (); i--;)
     boxes[i].translate (o);
@@ -126,142 +168,72 @@ Accidental_interface::accurate_boxes (Grob *me, Grob **common)
   return boxes;
 }
 
-/*
- * Some styles do not provide all flavours of accidentals, e.g. there
- * is currently no sharp accidental in vaticana style.  In these cases
- * this function falls back to one of the other styles.
- */
-
-/*
-  todo: this sort of stuff in Scheme. --hwn.
-*/
-string
-Accidental_interface::get_fontcharname (string style, int alteration)
-{
-  if (alteration == DOUBLE_FLAT
-      || alteration == DOUBLE_SHARP)
-    return to_string (alteration);
-
-  if (style == "hufnagel")
-    switch (alteration)
-      {
-      case FLAT: return "hufnagel-1";
-      case 0: return "vaticana0";
-      case SHARP: return "mensural1";
-      }
-  if (style == "medicaea")
-    switch (alteration)
-      {
-      case FLAT: return "medicaea-1";
-      case 0: return "vaticana0";
-      case SHARP: return "mensural1";
-      }
-  if (style == "vaticana")
-    switch (alteration)
-      {
-      case FLAT: return "vaticana-1";
-      case 0: return "vaticana0";
-      case SHARP: return "mensural1";
-      }
-  if (style == "mensural")
-    switch (alteration)
-      {
-      case FLAT: return "mensural-1";
-      case 0: return "vaticana0";
-      case SHARP: return "mensural1";
-      }
-
-  if (style == "neomensural")
-    style = ""; // currently same as default
-  if (style == "default")
-    style = "";
-  
-  return style + to_string (alteration);
-}
-
 MAKE_SCHEME_CALLBACK (Accidental_interface, print, 1);
 SCM
 Accidental_interface::print (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
-  bool parens = to_boolean (me->get_property ("parenthesized"));
-
-  SCM scm_style = me->get_property ("style");
-  string style;
-  if (scm_is_symbol (scm_style))
-    style = ly_symbol2string (scm_style);
-  else
-    /*
-      preferably no name for the default style.
-    */
-    style = "";
-
-  Font_metric *fm = Font_interface::get_default_font (me);
+  Grob *tie = unsmob_grob (me->get_object ("tie"));
 
-  SCM stencils = me->get_property ("stencils");
-  if (!scm_is_pair (stencils)
-      || !unsmob_stencil (scm_car (stencils)))
-    return SCM_EOL;
-  
-  Stencil mol (*unsmob_stencil (scm_car (stencils)));
-  if (to_boolean (me->get_property ("restore-first")))
+  if (tie
+      && (to_boolean (me->get_property ("hide-tied-accidental-after-break"))
+          || (!tie->original () && !to_boolean (me->get_property ("forced")))))
     {
-      string font_char = get_fontcharname (style, 0);
-      Stencil acc (fm->find_by_name ("accidentals." + font_char));
-
-      if (acc.is_empty ())
-       me->warning (_f ("accidental `%s' not found", font_char));
-      else
-       mol.add_at_edge (X_AXIS, LEFT, acc, 0.1, 0);
+      me->suicide ();
+      return SCM_EOL;
     }
-  
-  if (parens)
-    mol = parenthesize (me, mol);
 
-  return mol.smobbed_copy ();
+  return get_stencil (me);
 }
-  
-MAKE_SCHEME_CALLBACK (Accidental_interface, calc_stencils, 1);
+
 SCM
-Accidental_interface::calc_stencils (SCM smob)
+Accidental_interface::get_stencil (Grob *me)
 {
-  Grob *me = unsmob_grob (smob);
+  Font_metric *fm = Font_interface::get_default_font (me);
 
-  SCM scm_style = me->get_property ("style");
-  string style;
-  if (scm_is_symbol (scm_style))
-    style = ly_symbol2string (scm_style);
-  else
-    /*
-      preferably no name for the default style.
-    */
-    style = "";
+  SCM alist = me->get_property ("glyph-name-alist");
+  SCM alt = me->get_property ("alteration");
+  SCM glyph_name = ly_assoc_get (alt, alist, SCM_BOOL_F);
 
+  if (!scm_is_string (glyph_name))
+    {
+      me->warning (_f ("Could not find glyph-name for alteration %s",
+                       ly_scm_write_string (alt).c_str ()));
+      return SCM_EOL;
+    }
 
-  Font_metric *fm = Font_interface::get_default_font (me);
-  SCM acc = me->get_property ("alteration");
-  if (scm_is_number (acc))
+  Stencil mol (fm->find_by_name (ly_scm2string (glyph_name)));
+  if (to_boolean (me->get_property ("restore-first")))
     {
-      string font_char = get_fontcharname (style, scm_to_int (acc));
-      
-      Stencil acc_stencil (fm->find_by_name ("accidentals." + font_char));
+      /*
+        this isn't correct for ancient accidentals, but they don't
+        use double flats/sharps anyway.
+        */
+      Stencil acc (fm->find_by_name ("accidentals.natural"));
 
-      return scm_list_1 (acc_stencil.smobbed_copy ());
+      if (acc.is_empty ())
+        me->warning (_ ("natural alteration glyph not found"));
+      else
+        mol.add_at_edge (X_AXIS, LEFT, acc, 0.1);
     }
-  else
-    return SCM_EOL;
+
+  if (to_boolean (me->get_property ("parenthesized")))
+    mol = parenthesize (me, mol);
+
+  return mol.smobbed_copy ();
 }
 
-  
 ADD_INTERFACE (Accidental_interface,
-              "a single accidental",
-              
-              /* props */
-              "alteration "
-              "avoid-slur "
-              "forced "
-              "style "
-              "parenthesized "
-              "restore-first "
-              "tie "
-              );
+               "A single accidental.",
+
+               /* properties */
+               "alteration "
+               "avoid-slur "
+               "forced "
+               "glyph-name-alist "
+               "glyph-name "
+               "hide-tied-accidental-after-break "
+               "parenthesized "
+               "restore-first "
+               "tie "
+              );