]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spacing-basic.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / spacing-basic.cc
index 735335f63c9c66bcf4b60daf1e390091b0b0ff43..97868f9bedeb21e9915ddaa0564ef6a5b6751b93 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  spacing-basic.cc -- implement Spacing_spanner, simplistic spacing routines
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2005--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2005--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 "spacing-spanner.hh"
@@ -14,6 +25,8 @@
 #include "warn.hh"
 #include "pointer-group-interface.hh"
 #include "system.hh"
+#include "spacing-interface.hh"
+#include "spring.hh"
 
 /*
   LilyPond spaces by taking a simple-minded spacing algorithm, and
   The one-size-fits all spacing. It doesn't take into account
   different spacing wishes from one to the next column.
 */
-void
-Spacing_spanner::standard_breakable_column_spacing (Grob *me, Item *l, Item *r,
-                                                   Real *fixed, Real *space,
-                                                   Spacing_options const *options)
+Spring
+Spacing_spanner::standard_breakable_column_spacing (Grob *me, Item *l, Item *r, Spacing_options const *options)
 {
-  *fixed = 0.0;
-  Direction d = LEFT;
-  Drul_array<Item *> cols (l, r);
-
-  do
-    {
-      if (!Paper_column::is_musical (cols[d]))
-       {
-         /*
-           Tied accidentals over barlines cause problems, so lets see
-           what happens if we do this for non musical columns only.
-         */
-         Interval lext = cols[d]->extent (cols [d], X_AXIS);
-         if (!lext.is_empty ())
-           *fixed += -d * lext[-d];
-       }
-    }
-  while (flip (&d) != LEFT);
+  Real min_dist = max (0.0, Paper_column::minimum_distance (l, r));
 
   if (Paper_column::is_breakable (l) && Paper_column::is_breakable (r))
     {
       Moment *dt = unsmob_moment (l->get_property ("measure-length"));
       Moment mlen (1);
       if (dt)
-       mlen = *dt;
+        mlen = *dt;
 
       Real incr = robust_scm2double (me->get_property ("spacing-increment"), 1);
+      Real space = incr * double (mlen.main_part_ / options->global_shortest_) * 0.8;
+      Spring spring = Spring (min_dist + space, min_dist);
 
-      *space = *fixed + incr * double (mlen.main_part_ / options->global_shortest_) * 0.8;
+      /*
+        By default, the spring will have an inverse_stretch_strength of space+min_dist.
+        However, we don't want stretchability to scale with min_dist or else an
+        empty first measure on a line (which has a large min_dist because of the clef)
+        will stretch much more than an empty measure later in the line.
+      */
+      spring.set_inverse_stretch_strength (space);
+      return spring;
     }
-  else
+
+  Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l);
+  Real ideal;
+
+  if (dt == Moment (0, 0))
     {
-      Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l);
-
-      if (dt == Moment (0, 0))
-       {
-         /*
-           In this case, Staff_spacing should handle the job,
-           using dt when it is 0 is silly.
-         */
-         *space = *fixed + 0.5;
-       }
-      else
-       {
-         bool dummy;
-         *space = *fixed + options->get_duration_space (dt.main_part_, &dummy);
-       }
+      /*
+        In this case, Staff_spacing should handle the job,
+        using dt when it is 0 is silly.
+      */
+      ideal = min_dist + 0.5;
     }
+  else
+    ideal = min_dist + options->get_duration_space (dt.main_part_);
+
+  return Spring (ideal, min_dist);
 }
 
 Moment *
 get_measure_length (Grob *column)
 {
-  Grob * sys = column->get_parent (X_AXIS);
+  Grob *sys = column->get_parent (X_AXIS);
 
   extract_grob_set (sys, "columns", cols);
 
   vsize col_idx = Paper_column::get_rank (column);
-  
+
   do
     {
       if (Moment *len = unsmob_moment (cols[col_idx]->get_property ("measure-length")))
-       {
-         return len;
-       }
+        {
+          return len;
+        }
     }
   while (col_idx-- != 0);
-  
+
   return 0;
 }
 
-Real
-Spacing_spanner::note_spacing (Grob *me, Grob *lc, Grob *rc,
-                              Spacing_options const *options,
-                              bool *expand_only)
+/* Basic spring based on duration alone */
+Spring
+Spacing_spanner::note_spacing (Grob * /* me */,
+                               Grob *lc,
+                               Grob *rc,
+                               Spacing_options const *options)
 {
-  (void) me;
-  
   Moment shortest_playing_len = 0;
   SCM s = lc->get_property ("shortest-playing-duration");
 
@@ -115,7 +116,7 @@ Spacing_spanner::note_spacing (Grob *me, Grob *lc, Grob *rc,
 
   if (! shortest_playing_len.to_bool ())
     {
-      programming_error (cannot find a ruling note at " + Paper_column::when_mom (lc).to_string ());
+      programming_error ("cannot find a ruling note at: " + Paper_column::when_mom (lc).to_string ());
       shortest_playing_len = 1;
     }
 
@@ -138,39 +139,45 @@ Spacing_spanner::note_spacing (Grob *me, Grob *lc, Grob *rc,
       delta_t = min (delta_t, *measure_len);
 
       /*
-       The following is an extra safety measure, such that
-       the length of a mmrest event doesn't cause havoc.
+        The following is an extra safety measure, such that
+        the length of a mmrest event doesn't cause havoc.
       */
       shortest_playing_len = min (shortest_playing_len, *measure_len);
     }
 
-  Real dist = 0.0;
+  Spring ret;
   if (delta_t.main_part_ && !lwhen.grace_part_)
     {
-      dist = options->get_duration_space (shortest_playing_len.main_part_,
-                                         expand_only);
-      dist *= double (delta_t.main_part_ / shortest_playing_len.main_part_);
+      // A spring of length and stiffness based on the controlling duration
+      Real len = options->get_duration_space (shortest_playing_len.main_part_);
+      Real min = options->increment_;  // canonical notehead width
+
+      // The portion of that spring proportional to the time between lc and rc
+      Real fraction = (delta_t.main_part_ / shortest_playing_len.main_part_);
+      ret = Spring (fraction * len, fraction * min);
+
+      // Stretch proportional to the space between canonical bare noteheads
+      ret.set_inverse_stretch_strength (fraction * max (0.0, (len - min)));
     }
   else if (delta_t.grace_part_)
     {
-      /*
-       Crude hack for spacing graces: we take the shortest space
-       available (namely the space for the global shortest note), and
-       multiply that by grace-space-factor
-      */
-      dist = options->get_duration_space (options->global_shortest_, expand_only) / 2.0;
       Grob *grace_spacing = unsmob_grob (lc->get_object ("grace-spacing"));
       if (grace_spacing)
-       {
-         Spacing_options grace_opts;
-         grace_opts.init_from_grob (grace_spacing);
-
-         bool bla;
-         dist = grace_opts.get_duration_space (delta_t.grace_part_, &bla);
-       }
-      
+        {
+          Spacing_options grace_opts;
+          grace_opts.init_from_grob (grace_spacing);
+          Real len = grace_opts.get_duration_space (delta_t.grace_part_);
+          Real min = grace_opts.increment_;
+          ret = Spring (len, min);
+          // Grace notes should not stretch very much
+          ret.set_inverse_stretch_strength (grace_opts.increment_ / 2.0);
+        }
+      else // Fallback to the old grace spacing: half that of the shortest note
+        ret = Spring (options->
+                      get_duration_space (options->global_shortest_) / 2.0,
+                      options->increment_ / 2.0);
     }
 
-  return dist;
+  return ret;
 }