]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/rest.cc
Doc-es: various updates.
[lilypond.git] / lily / rest.cc
index c6d5f1fcc4886cef3ebc74a3265f8b23051600a1..f562f69534a1689d648efabb5d90051c9b0a42d3 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1997--2015 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
@@ -26,6 +26,7 @@
 #include "output-def.hh"
 #include "paper-score.hh"
 #include "staff-symbol-referencer.hh"
+#include "staff-symbol.hh"
 #include "stencil.hh"
 #include "grob.hh"
 
@@ -34,27 +35,108 @@ MAKE_SCHEME_CALLBACK (Rest, y_offset_callback, 1);
 SCM
 Rest::y_offset_callback (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   int duration_log = scm_to_int (me->get_property ("duration-log"));
-  int line_count = Staff_symbol_referencer::line_count (me);
   Real ss = Staff_symbol_referencer::staff_space (me);
 
+  return scm_from_double (ss * 0.5 * Rest::staff_position_internal (me, duration_log, get_grob_direction (me)));
+}
+
+Real
+Rest::staff_position_internal (Grob *me, int duration_log, int dir)
+{
+  if (!me)
+    return 0;
+
   bool position_override = scm_is_number (me->get_property ("staff-position"));
-  Real amount = robust_scm2double (me->get_property ("staff-position"), 0)
-    * 0.5 * ss;
-  
-  if (line_count % 2)
+  Real pos;
+
+  if (position_override)
+    {
+      pos
+        = robust_scm2double (me->get_property ("staff-position"), 0);
+
+      /*
+        semibreve rests are positioned one staff line off
+      */
+      if (duration_log == 0)
+        return pos + 2;
+
+      /*
+        trust the client on good positioning;
+        would be tempting to adjust position of rests longer than a quarter
+        to be properly aligned to staff lines,
+        but custom rest shapes may not need that sort of care.
+      */
+
+      return pos;
+    }
+
+  Real vpos = dir * robust_scm2int (me->get_property ("voiced-position"), 0);
+  pos = vpos;
+
+  if (duration_log > 1)
+    /* Only half notes or longer want alignment with staff lines */
+    return pos;
+
+  /*
+    We need a staff symbol for actually aligning anything
+  */
+  Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
+  if (!staff)
+    return pos;
+
+  std::vector<Real> linepos = Staff_symbol::line_positions (staff);
+
+  if (linepos.empty ())
+    return pos;
+
+  std::sort (linepos.begin (), linepos.end ());
+
+  if (duration_log == 0)
     {
-      if (duration_log == 0 && line_count > 1)
-       amount += ss;
+      /*
+        lower voice semibreve rests generally hang a line lower
+      */
+
+      if (dir < 0)
+        pos -= 2;
+
+      /*
+        make a semibreve rest hang from the next available line,
+        except when there is none.
+      */
+
+      std::vector<Real>::const_iterator it
+        = std::upper_bound (linepos.begin (), linepos.end (), pos);
+      if (it != linepos.end ())
+        pos = *it;
+      else
+        pos = linepos.back ();
     }
   else
-    amount += ss / 2;
+    {
+      std::vector<Real>::const_iterator it
+        = std::upper_bound (linepos.begin (), linepos.end (), pos);
+      if (it != linepos.begin ())
+        --it;
+      pos = *it;
+    }
+
+  /* Finished for neutral position */
+  if (!dir)
+    return pos;
+
+  /* If we have a voiced position, make sure that it's on the
+     proper side of neutral before using it.
+  */
 
-  if (!position_override)
-    amount += 2 * ss * get_grob_direction (me);; 
-  
-  return scm_from_double (amount);
+  Real neutral = staff_position_internal (me, duration_log, 0);
+
+  if (dir * (pos - neutral) > 0)
+    return pos;
+  else
+    return neutral + vpos;
 }
 
 /* A rest might lie under a beam, in which case it should be cross-staff if
@@ -64,8 +146,8 @@ MAKE_SCHEME_CALLBACK (Rest, calc_cross_staff, 1);
 SCM
 Rest::calc_cross_staff (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
-  Grob *stem = unsmob_grob (me->get_object ("stem"));
+  Grob *me = unsmob<Grob> (smob);
+  Grob *stem = unsmob<Grob> (me->get_object ("stem"));
 
   if (!stem)
     return SCM_BOOL_F;
@@ -77,21 +159,23 @@ Rest::calc_cross_staff (SCM smob)
   make this function easily usable in C++
 */
 string
-Rest::glyph_name (Grob *me, int balltype, string style, bool try_ledgers)
+Rest::glyph_name (Grob *me, int durlog, const string &style, bool try_ledgers,
+                  Real offset)
 {
   bool is_ledgered = false;
-  if (try_ledgers && (balltype == 0 || balltype == 1))
+  if (try_ledgers && (durlog == -1 || durlog == 0 || durlog == 1))
     {
-      Real rad = Staff_symbol_referencer::staff_radius (me) * 2.0;
-      Real pos = Staff_symbol_referencer::get_position (me);
-
+      int const pos = int (Staff_symbol_referencer::get_position (me)
+                           + offset);
       /*
-       Figure out when the rest is far enough outside the staff. This
-       could bemore generic, but hey, we understand this even after
-       dinner.
+        half rests need ledger if not lying on a staff line,
+        whole rests need ledger if not hanging from a staff line,
+        breve rests need ledger if neither lying on nor hanging from a staff line
       */
-      is_ledgered |= (balltype == 0) && (pos >= +rad + 2 || pos < -rad);
-      is_ledgered |= (balltype == 1) && (pos <= -rad - 2 || pos > +rad);
+      if (-1 <= durlog && durlog <= 1)
+        is_ledgered = !Staff_symbol_referencer::on_staff_line (me, pos)
+                      && !(durlog == -1
+                           && Staff_symbol_referencer::on_staff_line (me, pos + 2));
     }
 
   string actual_style (style.c_str ());
@@ -100,26 +184,25 @@ Rest::glyph_name (Grob *me, int balltype, string style, bool try_ledgers)
     {
 
       /*
-       FIXME: Currently, ancient font does not provide ledgered rests;
-       hence the "o" suffix in the glyph name is bogus.  But do we need
-       ledgered rests at all now that we can draw ledger lines with
-       variable width, length and blotdiameter? -- jr
+        FIXME: Currently, ancient font does not provide ledgered rests;
+        hence the "o" suffix in the glyph name is bogus.  But do we need
+        ledgered rests at all now that we can draw ledger lines with
+        variable width, length and blotdiameter? -- jr
       */
       is_ledgered = 0;
 
       /*
-       There are no 32th/64th/128th mensural/neomensural rests.  In
-       these cases, revert back to default style.
+        There are no 32th/64th/128th mensural/neomensural rests.  In
+        these cases, revert back to default style.
       */
-      if (balltype > 4)
-       actual_style = "";
+      if (durlog > 4)
+        actual_style = "";
     }
 
-  if ((style == "classical") && (balltype != 2))
+  if (((style == "classical") || (style == "z")) && (durlog != 2))
     {
       /*
-       classical style: revert back to default style for any rest other
-       than quarter rest
+        these styles differ from the default in quarter rests only
       */
       actual_style = "";
     }
@@ -127,33 +210,30 @@ Rest::glyph_name (Grob *me, int balltype, string style, bool try_ledgers)
   if (style == "default")
     {
       /*
-       Some parts of lily still prefer style "default" over "".
-       Correct this here. -- jr
+        Some parts of lily still prefer style "default" over "".
+        Correct this here. -- jr
       */
       actual_style = "";
     }
 
-  return ("rests." + to_string (balltype) + (is_ledgered ? "o" : "")
-         + actual_style);
+  return ("rests." + ::to_string (durlog) + (is_ledgered ? "o" : "")
+          + actual_style);
 }
 
 MAKE_SCHEME_CALLBACK (Rest, print, 1);
 SCM
 Rest::brew_internal_stencil (Grob *me, bool ledgered)
 {
-  SCM balltype_scm = me->get_property ("duration-log");
-  if (!scm_is_number (balltype_scm))
+  SCM durlog_scm = me->get_property ("duration-log");
+  if (!scm_is_number (durlog_scm))
     return Stencil ().smobbed_copy ();
 
-  int balltype = scm_to_int (balltype_scm);
+  int durlog = scm_to_int (durlog_scm);
 
-  string style;
-  SCM style_scm = me->get_property ("style");
-  if (scm_is_symbol (style_scm))
-    style = ly_scm2string (scm_symbol_to_string (style_scm));
+  string style = robust_symbol2string (me->get_property ("style"), "default");
 
   Font_metric *fm = Font_interface::get_default_font (me);
-  string font_char = glyph_name (me, balltype, style, ledgered);
+  string font_char = glyph_name (me, durlog, style, ledgered, 0.0);
   Stencil out = fm->find_by_name (font_char);
   if (out.is_empty ())
     me->warning (_f ("rest `%s' not found", font_char.c_str ()));
@@ -161,10 +241,25 @@ Rest::brew_internal_stencil (Grob *me, bool ledgered)
   return out.smobbed_copy ();
 }
 
+/**
+   translate the rest vertically by amount DY, but only if
+   it doesn't have staff-position set.
+*/
+void
+Rest::translate (Grob *me, int dy)
+{
+  if (!scm_is_number (me->get_property ("staff-position")))
+    {
+      me->translate_axis (dy * Staff_symbol_referencer::staff_space (me) / 2.0, Y_AXIS);
+      Grob *p = me->get_parent (Y_AXIS);
+      p->flush_extent_cache (Y_AXIS);
+    }
+}
+
 SCM
 Rest::print (SCM smob)
 {
-  return brew_internal_stencil (unsmob_grob (smob), true);
+  return brew_internal_stencil (unsmob<Grob> (smob), true);
 }
 
 MAKE_SCHEME_CALLBACK (Rest, width, 1);
@@ -174,14 +269,14 @@ MAKE_SCHEME_CALLBACK (Rest, width, 1);
 SCM
 Rest::width (SCM smob)
 {
-  return generic_extent_callback (unsmob_grob (smob), X_AXIS);
+  return generic_extent_callback (unsmob<Grob> (smob), X_AXIS);
 }
 
 MAKE_SCHEME_CALLBACK (Rest, height, 1);
 SCM
 Rest::height (SCM smob)
 {
-  return generic_extent_callback (unsmob_grob (smob), Y_AXIS);
+  return generic_extent_callback (unsmob<Grob> (smob), Y_AXIS);
 }
 
 /*
@@ -199,28 +294,28 @@ Rest::generic_extent_callback (Grob *me, Axis a)
     with ledgered rests.
   */
   SCM m = brew_internal_stencil (me, a != X_AXIS);
-  return ly_interval2scm (unsmob_stencil (m)->extent (a));
+  return ly_interval2scm (unsmob<Stencil> (m)->extent (a));
 }
 
 MAKE_SCHEME_CALLBACK (Rest, pure_height, 3);
 SCM
 Rest::pure_height (SCM smob,
-                  SCM /* start */,
-                  SCM /* end */)
+                   SCM /* start */,
+                   SCM /* end */)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   SCM m = brew_internal_stencil (me, false);
-  return ly_interval2scm (unsmob_stencil (m)->extent (Y_AXIS));
+  return ly_interval2scm (unsmob<Stencil> (m)->extent (Y_AXIS));
 }
 
 ADD_INTERFACE (Rest,
-              "A rest symbol.  The property @code{style} can be"
-              " @code{default}, @code{mensural}, @code{neomensural} or"
-              " @code{classical}.",
-
-              /* properties */
-              "direction "
-              "minimum-distance "
-              "style "
-              );
-
+               "A rest symbol.  The property @code{style} can be"
+               " @code{default}, @code{mensural}, @code{neomensural} or"
+               " @code{classical}.",
+
+               /* properties */
+               "direction "
+               "minimum-distance "
+               "style "
+               "voiced-position "
+              );