]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/staff-symbol.cc
Release: bump Welcome versions.
[lilypond.git] / lily / staff-symbol.cc
index f80a5c57741dfc1c2523f403fa809149c370d8d3..0697085e114b7fb7811c65a71947e6c61052d9c3 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1997--2011 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
@@ -22,6 +22,7 @@
 #include "lookup.hh"
 #include "dimensions.hh"
 #include "output-def.hh"
+#include "paper-column.hh"
 #include "warn.hh"
 #include "item.hh"
 #include "staff-symbol-referencer.hh"
@@ -32,7 +33,7 @@ MAKE_SCHEME_CALLBACK (Staff_symbol, print, 1);
 SCM
 Staff_symbol::print (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   Spanner *sp = dynamic_cast<Spanner *> (me);
   Grob *common
     = sp->get_bound (LEFT)->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
@@ -49,8 +50,7 @@ Staff_symbol::print (SCM smob)
   Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
   t *= robust_scm2double (me->get_property ("thickness"), 1.0);
 
-  Direction d = LEFT;
-  do
+  for (LEFT_and_RIGHT (d))
     {
       SCM width_scm = me->get_property ("width");
       if (d == RIGHT && scm_is_number (width_scm))
@@ -65,71 +65,239 @@ Staff_symbol::print (SCM smob)
       else
         {
           Item *x = sp->get_bound (d);
-
-          span_points[d] = x->relative_coordinate (common, X_AXIS);
-          if (!x->break_status_dir ()
-              && !x->extent (x, X_AXIS).is_empty ())
-            span_points[d] += x->extent (x, X_AXIS)[d];
+          if (x->extent (x, X_AXIS).is_empty ()
+              || (x->break_status_dir () && sp->broken_neighbor (d)))
+            span_points[d] = x->relative_coordinate (common, X_AXIS);
+          // What the default implementation of to-barline does for
+          // spanners is not really in usefully recognizable shape by
+          // now, so we just reimplement.
+          else
+            {
+              SCM where = (d == RIGHT
+                           ? me->get_property ("break-align-symbols")
+                           : ly_symbol2scm ("break-alignment"));
+              span_points[d] = Paper_column::break_align_width (x, where)[d];
+            }
         }
 
       span_points[d] -= d * t / 2;
     }
-  while (flip (&d) != LEFT);
 
   Stencil m;
 
-  SCM line_positions = me->get_property ("line-positions");
+  vector<Real> line_positions = Staff_symbol::line_positions (me);
+
   Stencil line
     = Lookup::horizontal_line (span_points
                                - me->relative_coordinate (common, X_AXIS),
                                t);
 
   Real space = staff_space (me);
+  for (vector<Real>::const_iterator i = line_positions.begin (),
+       e = line_positions.end ();
+       i != e;
+       ++i)
+    {
+      Stencil b (line);
+      b.translate_axis (*i * 0.5 * space, Y_AXIS);
+      m.add_stencil (b);
+    }
+  return m.smobbed_copy ();
+}
+
+vector<Real>
+Staff_symbol::line_positions (Grob *me)
+{
+  SCM line_positions = me->get_property ("line-positions");
   if (scm_is_pair (line_positions))
     {
+      int line_count = scm_ilength (line_positions);
+      vector<Real> values (line_count);
+      int i = 0;
       for (SCM s = line_positions; scm_is_pair (s);
            s = scm_cdr (s))
         {
-          Stencil b (line);
-          b.translate_axis (scm_to_double (scm_car (s))
-                            * 0.5 * space, Y_AXIS);
-          m.add_stencil (b);
+          values[i++] = scm_to_double (scm_car (s));
         }
+      return values;
     }
   else
     {
-      int l = Staff_symbol::line_count (me);
-      Real height = (l - 1) * staff_space (me) / 2;
-      for (int i = 0; i < l; i++)
+      int line_count = Staff_symbol::line_count (me);
+      Real height = line_count - 1;
+      vector<Real> values (line_count);
+      for (int i = 0; i < line_count; i++)
         {
-          Stencil b (line);
-          b.translate_axis (height - i * space, Y_AXIS);
-          m.add_stencil (b);
+          values[i] = height - i * 2;
         }
+      return values;
     }
-  return m.smobbed_copy ();
 }
 
-int
-Staff_symbol::get_steps (Grob *me)
+vector<Real>
+Staff_symbol::ledger_positions (Grob *me, int pos, Item const *head)
 {
-  return line_count (me) * 2;
+  // allow override of ledger positions via note head grob...
+  if (head)
+    {
+      SCM posns = head->get_property ("ledger-positions");
+      if (scm_is_pair (posns))
+        return ly_scm2floatvector (posns);
+    }
+
+  // ...or via custom ledger positions function
+  SCM lp_function = me->get_property ("ledger-positions-function");
+  if (scm_is_pair (lp_function))
+    {
+      SCM func = scm_eval (lp_function, scm_interaction_environment ());
+      if (ly_is_procedure (func))
+        return ly_scm2floatvector (scm_call_2 (func,
+                                               me->self_scm (),
+                                               scm_from_int (pos)));
+    }
+
+  SCM ledger_positions = me->get_property ("ledger-positions");
+  Real ledger_extra = robust_scm2double (me->get_property ("ledger-extra"), 0);
+  vector<Real> line_positions = Staff_symbol::line_positions (me);
+  vector<Real> values;
+
+  if (line_positions.empty ())
+    return values;
+
+  // find the staff line nearest to note position
+  Real nearest_line = line_positions[0];
+  Real line_dist = abs (line_positions[0] - pos);
+  for (vector<Real>::const_iterator i = line_positions.begin (),
+       e = line_positions.end ();
+       i != e;
+       ++i)
+    {
+      if (abs (*i - pos) < line_dist)
+        {
+          nearest_line = *i;
+          line_dist = abs (*i - pos);
+        }
+    }
+
+  if (line_dist < .5)
+    return values;
+
+  Direction dir = (Direction)sign (pos - nearest_line);
+
+  if (scm_is_pair (ledger_positions))
+    // custom ledger positions via StaffSymbol.ledger-positions
+    {
+      Real min_pos = HUGE_VAL;
+      Real max_pos = -HUGE_VAL;
+      SCM s2;
+
+      // find the extent of the ledger pattern
+      for (SCM s = ledger_positions; scm_is_pair (s); s = scm_cdr (s))
+        {
+          s2 = scm_car (s);
+          if (!scm_is_number (s2))
+            s2 = scm_car (s2);
+          Real current_ledger = scm_to_double (s2);
+          if (current_ledger > max_pos)
+            max_pos = current_ledger;
+          if (current_ledger < min_pos)
+            min_pos = current_ledger;
+        }
+
+      Real cycle = max_pos - min_pos;
+
+      Interval ledger_fill;
+      ledger_fill.add_point (nearest_line + 0.5 * dir);
+      ledger_fill.add_point (pos + 0.5 * dir + ledger_extra * dir);
+
+      // fill the Interval ledger_fill with ledger lines
+      int n = (int) floor ((ledger_fill[DOWN] - min_pos) / cycle);
+      Real current;
+      SCM s = scm_cdr (ledger_positions);
+      if (!scm_is_pair (s) || cycle < 0.1)
+        return values;
+      do
+        {
+          s2 = scm_car (s);
+          if (scm_is_number (s2))
+            {
+              current = scm_to_double (s2) + n * cycle;
+              if (ledger_fill.contains (current))
+                values.push_back (current);
+            }
+          else
+            // grouped ledger lines, either add all or none
+            {
+              do
+                {
+                  current = scm_to_double (scm_car (s2)) + n * cycle;
+                  if (ledger_fill.contains (current))
+                    {
+                      s2 = scm_car (s);
+                      do
+                        {
+                          current = scm_to_double (scm_car (s2)) + n * cycle;
+                          values.push_back (current);
+                          s2 = scm_cdr (s2);
+                        }
+                      while (scm_is_pair (s2));
+                    }
+                  else
+                    s2 = scm_cdr (s2);
+                }
+              while (scm_is_pair (s2));
+            }
+          s = scm_cdr (s);
+          if (!scm_is_pair (s))
+            {
+              s = scm_cdr (ledger_positions);
+              n++;
+            }
+        }
+      while (current <= ledger_fill[UP]);
+    }
+  else
+    // normal ledger lines
+    {
+      int ledger_count = (int) floor ((abs (nearest_line - pos) + ledger_extra) / 2);
+      values.resize (ledger_count);
+      for (int i = 0; i < ledger_count; i++)
+        {
+          values[i] = nearest_line + dir * (ledger_count - i) * 2;
+        }
+    }
+  // remove any ledger lines that would fall on staff lines,
+  // which can happen when ledger-extra > 0
+  vector<Real> final_values;
+  for (vector<Real>::const_iterator i = values.begin (),
+       e = values.end ();
+       i != e;
+       ++i)
+    {
+      if (find (line_positions.begin (), line_positions.end (), *i) == line_positions.end ())
+        {
+          final_values.push_back (*i);
+        }
+    }
+  return final_values;
 }
 
 int
 Staff_symbol::line_count (Grob *me)
 {
-  SCM c = me->get_property ("line-count");
-  if (scm_is_number (c))
-    return scm_to_int (c);
+  SCM line_positions = me->get_property ("line-positions");
+  if (scm_is_pair (line_positions))
+    return scm_ilength (line_positions);
   else
-    return 0;
+    return robust_scm2int (me->get_property ("line-count"), 0);
 }
 
 Real
 Staff_symbol::staff_space (Grob *me)
 {
-  return robust_scm2double (me->get_property ("staff-space"), 1.0);
+  Real ss = me->layout ()->get_dimension (ly_symbol2scm ("staff-space"));
+
+  return robust_scm2double (me->get_property ("staff-space"), 1.0) * ss;
 }
 
 Real
@@ -153,7 +321,7 @@ MAKE_SCHEME_CALLBACK (Staff_symbol, height, 1);
 SCM
 Staff_symbol::height (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
   t *= robust_scm2double (me->get_property ("thickness"), 1.0);
 
@@ -178,33 +346,48 @@ Staff_symbol::height (SCM smob)
 }
 
 bool
-Staff_symbol::on_line (Grob *me, int pos)
+Staff_symbol::on_line (Grob *me, int pos, bool allow_ledger)
 {
-  SCM line_positions = me->get_property ("line-positions");
-  if (scm_is_pair (line_positions))
+  // standard staff lines (any line count) and standard ledger lines
+  if (!scm_is_pair (me->get_property ("line-positions"))
+      && !scm_is_pair (me->get_property ("ledger-positions")))
     {
-      Real min_line = HUGE_VAL;
-      Real max_line = -HUGE_VAL;
-      for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
+      int const line_cnt = line_count (me);
+      bool result = abs (pos + line_cnt) % 2 == 1;
+      if (result && !allow_ledger)
         {
-          Real current_line = scm_to_double (scm_car (s));
-          if (pos == current_line)
-            return true;
-          if (current_line > max_line)
-            max_line = current_line;
-          if (current_line < min_line)
-            min_line = current_line;
-
+          result = -line_cnt < pos && pos < line_cnt;
         }
-      if (pos < min_line)
-        return (( (int) (rint (pos - min_line)) % 2) == 0);
-      if (pos > max_line)
-        return (( (int) (rint (pos - max_line)) % 2) == 0);
+      return result;
+    }
 
-      return false;
+  // staff lines (custom or standard)
+  vector<Real> lines = Staff_symbol::line_positions (me);
+  for (vector<Real>::const_iterator i = lines.begin (),
+       e = lines.end ();
+       i != e;
+       ++i)
+    {
+      if (pos == *i)
+        return true;
     }
-  else
-    return ((abs (pos + line_count (me)) % 2) == 1);
+
+  // ledger lines (custom or standard)
+  if (allow_ledger)
+    {
+      vector<Real> ledgers = Staff_symbol::ledger_positions (me, pos);
+      if (ledgers.empty ())
+        return false;
+      for (vector<Real>::const_iterator i = ledgers.begin (),
+           e = ledgers.end ();
+           i != e;
+           ++i)
+        {
+          if (pos == *i)
+            return true;
+        }
+    }
+  return false;
 }
 
 Interval
@@ -234,7 +417,11 @@ ADD_INTERFACE (Staff_symbol,
                " @code{width} property.",
 
                /* properties */
+               "break-align-symbols "
+               "ledger-extra "
                "ledger-line-thickness "
+               "ledger-positions "
+               "ledger-positions-function "
                "line-count "
                "line-positions "
                "staff-space "