]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/rest.cc
Doc-es: various updates.
[lilypond.git] / lily / rest.cc
index a25e6a93198298ef4d8ca778dbded2379e583365..f562f69534a1689d648efabb5d90051c9b0a42d3 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1997--2012 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,24 +35,32 @@ 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;
+  Real pos;
 
   if (position_override)
     {
-      amount =
-        robust_scm2double (me->get_property ("staff-position"), 0) * 0.5 * ss;
+      pos
+        = robust_scm2double (me->get_property ("staff-position"), 0);
 
       /*
-        semibreve rests were always positioned one off
+        semibreve rests are positioned one staff line off
       */
       if (duration_log == 0)
-        amount += ss;
+        return pos + 2;
 
       /*
         trust the client on good positioning;
@@ -59,29 +68,75 @@ Rest::y_offset_callback (SCM smob)
         to be properly aligned to staff lines,
         but custom rest shapes may not need that sort of care.
       */
+
+      return pos;
     }
-  else
-    {
-      int pos = 4 * get_grob_direction (me);
 
+  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)
+    {
       /*
-        make a semibreve rest hang from the next line,
-        except for a single line staff;
-        assume the next line being integer steps away
+        lower voice semibreve rests generally hang a line lower
       */
-      if (duration_log == 0 && line_count > 1)
-        ++pos;
+
+      if (dir < 0)
+        pos -= 2;
 
       /*
-        make sure rest is aligned to a staff line
+        make a semibreve rest hang from the next available line,
+        except when there is none.
       */
-      while (!Staff_symbol_referencer::on_line (me, pos))
-        ++pos;
 
-      amount = ss * 0.5 * pos;
+      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
+    {
+      std::vector<Real>::const_iterator it
+        = std::upper_bound (linepos.begin (), linepos.end (), pos);
+      if (it != linepos.begin ())
+        --it;
+      pos = *it;
     }
 
-  return scm_from_double (amount);
+  /* 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.
+  */
+
+  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
@@ -91,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;
@@ -104,22 +159,23 @@ Rest::calc_cross_staff (SCM smob)
   make this function easily usable in C++
 */
 string
-Rest::glyph_name (Grob *me, int durlog, 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 && (durlog == -1 || durlog == 0 || durlog == 1))
     {
-      int const pos = int (Staff_symbol_referencer::get_position (me));
-
+      int const pos = int (Staff_symbol_referencer::get_position (me)
+                           + offset);
       /*
-       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
+        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
       */
       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));
+                      && !(durlog == -1
+                           && Staff_symbol_referencer::on_staff_line (me, pos + 2));
     }
 
   string actual_style (style.c_str ());
@@ -143,11 +199,10 @@ Rest::glyph_name (Grob *me, int durlog, string style, bool try_ledgers)
         actual_style = "";
     }
 
-  if ((style == "classical") && (durlog != 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 = "";
     }
@@ -161,7 +216,7 @@ Rest::glyph_name (Grob *me, int durlog, string style, bool try_ledgers)
       actual_style = "";
     }
 
-  return ("rests." + to_string (durlog) + (is_ledgered ? "o" : "")
+  return ("rests." + ::to_string (durlog) + (is_ledgered ? "o" : "")
           + actual_style);
 }
 
@@ -178,7 +233,7 @@ Rest::brew_internal_stencil (Grob *me, bool ledgered)
   string style = robust_symbol2string (me->get_property ("style"), "default");
 
   Font_metric *fm = Font_interface::get_default_font (me);
-  string font_char = glyph_name (me, durlog, 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 ()));
@@ -204,7 +259,7 @@ Rest::translate (Grob *me, int dy)
 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);
@@ -214,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);
 }
 
 /*
@@ -239,7 +294,7 @@ 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);
@@ -248,9 +303,9 @@ Rest::pure_height (SCM smob,
                    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,
@@ -262,4 +317,5 @@ ADD_INTERFACE (Rest,
                "direction "
                "minimum-distance "
                "style "
+               "voiced-position "
               );