]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spacing-basic.cc
Run `make grand-replace'.
[lilypond.git] / lily / spacing-basic.cc
index f5753f948a383c77071eefb9423a81722a5e9510..7545ec4e5b94723f384c94ed9753bcd2d3cbd7b4 100644 (file)
@@ -3,97 +3,36 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 2005--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "spacing-spanner.hh"
+
+#include "spacing-options.hh"
 #include "moment.hh"
 #include "paper-column.hh"
-#include "misc.hh"
 #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
   adding subtle adjustments to that. This file does the simple-minded
   spacing routines.
 */
-
-/*
-  Get the measure wide ant for arithmetic spacing.
-*/
-Real
-Spacing_options::get_duration_space (Moment d,
-                                    bool *expand_only) const
-{
-  Real k = shortest_duration_space_;
-
-  if (d < global_shortest_)
-    {
-      /*
-       We don't space really short notes using the log of the
-       duration, since it would disproportionally stretches the long
-       notes in a piece. In stead, we use geometric spacing with constant 0.5
-       (i.e. linear.)
-
-       This should probably be tunable, to use other base numbers.
-
-       In Mozart hrn3 by EB., we have 8th note = 3.9 mm (total), 16th note =
-       3.6 mm (total).  head-width = 2.4, so we 1.2mm for 16th, 1.5
-       mm for 8th. (white space), suggesting that we use
-
-       (1.2 / 1.5)^{-log2(duration ratio)}
-
-
-      */
-      Rational ratio = d.main_part_ / global_shortest_;
-
-      return ((k - 1) + double (ratio)) * increment_;
-    }
-  else
-    {
-      /*
-       John S. Gourlay. ``Spacing a Line of Music, '' Technical
-       Report OSU-CISRC-10/87-TR35, Department of Computer and
-       Information Science, The Ohio State University, 1987.
-      */
-      Real log = log_2 (global_shortest_);
-      k -= log;
-      Rational compdur = d.main_part_ + d.grace_part_ / Rational (3);
-      *expand_only = false;
-
-      return (log_2 (compdur) + k) * increment_;
-    }
-}
-
 /*
   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));
+  Real ideal;
 
-  if (l->is_breakable (l) && r->is_breakable (r))
+  if (Paper_column::is_breakable (l) && Paper_column::is_breakable (r))
     {
       Moment *dt = unsmob_moment (l->get_property ("measure-length"));
       Moment mlen (1);
@@ -102,7 +41,7 @@ Spacing_spanner::standard_breakable_column_spacing (Grob *me, Item *l, Item *r,
 
       Real incr = robust_scm2double (me->get_property ("spacing-increment"), 1);
 
-      *space = *fixed + incr * double (mlen.main_part_ / options->global_shortest_) * 0.8;
+      ideal = min_dist + incr * double (mlen.main_part_ / options->global_shortest_) * 0.8;
     }
   else
     {
@@ -114,21 +53,41 @@ Spacing_spanner::standard_breakable_column_spacing (Grob *me, Item *l, Item *r,
            In this case, Staff_spacing should handle the job,
            using dt when it is 0 is silly.
          */
-         *space = *fixed + 0.5;
+         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);
+
+  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")))
        {
-         bool dummy;
-         *space = *fixed + options->get_duration_space (dt, &dummy);
+         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)
+                              Spacing_options const *options)
 {
+  (void) me;
+  
   Moment shortest_playing_len = 0;
   SCM s = lc->get_property ("shortest-playing-duration");
 
@@ -137,7 +96,7 @@ Spacing_spanner::note_spacing (Grob *me, Grob *lc, Grob *rc,
 
   if (! shortest_playing_len.to_bool ())
     {
-      programming_error ("can't 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;
     }
 
@@ -145,32 +104,31 @@ Spacing_spanner::note_spacing (Grob *me, Grob *lc, Grob *rc,
   Moment rwhen = Paper_column::when_mom (rc);
 
   Moment delta_t = rwhen - lwhen;
-  if (!Paper_column::is_musical (rc))
+
+  /*
+    when toying with mmrests, it is possible to have musical
+    column on the left and non-musical on the right, spanning
+    several measures.
+
+    TODO: efficiency: measure length can be cached, or stored as
+    property in paper-column.
+  */
+
+  if (Moment *measure_len = get_measure_length (lc))
     {
+      delta_t = min (delta_t, *measure_len);
+
       /*
-       when toying with mmrests, it is possible to have musical
-       column on the left and non-musical on the right, spanning
-       several measures.
+       The following is an extra safety measure, such that
+       the length of a mmrest event doesn't cause havoc.
       */
-
-      Moment *dt = unsmob_moment (rc->get_property ("measure-length"));
-      if (dt)
-       {
-         delta_t = min (delta_t, *dt);
-
-         /*
-           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, *dt);
-       }
+      shortest_playing_len = min (shortest_playing_len, *measure_len);
     }
 
   Real dist = 0.0;
   if (delta_t.main_part_ && !lwhen.grace_part_)
     {
-      dist = options->get_duration_space (shortest_playing_len,
-                                         expand_only);
+      dist = options->get_duration_space (shortest_playing_len.main_part_);
       dist *= double (delta_t.main_part_ / shortest_playing_len.main_part_);
     }
   else if (delta_t.grace_part_)
@@ -180,39 +138,17 @@ Spacing_spanner::note_spacing (Grob *me, Grob *lc, Grob *rc,
        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);
-
-      Real grace_fact
-       = robust_scm2double (me->get_property ("grace-space-factor"), 1);
-
-      dist *= grace_fact;
+      dist = options->get_duration_space (options->global_shortest_) / 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);
+         dist = grace_opts.get_duration_space (delta_t.grace_part_);
+       }
+      
     }
 
   return dist;
 }
 
-/****************************************************************/
-
-void
-Spacing_options::init_from_grob (Grob *me)
-{
-  increment_ = robust_scm2double (me->get_property ("spacing-increment"), 1);
-
-  packed_ = to_boolean (me->get_property ("packed-spacing"));
-  stretch_uniformly_ = to_boolean (me->get_property ("uniform-stretching"));
-  float_nonmusical_columns_
-    = to_boolean (me->get_property ("strict-note-spacing"));
-  shortest_duration_space_ = robust_scm2double (me->get_property ("shortest-duration-space"), 1);
-}
-
-void
-Spacing_options::init ()
-{
-  increment_ = 1.2;
-  packed_ = false;
-  stretch_uniformly_ = false;
-  float_nonmusical_columns_ = false;
-  shortest_duration_space_ = 2.0;
-
-  global_shortest_ = Rational (1, 8);
-}