]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spacing-loose-columns.cc
Web-ja: update introduction
[lilypond.git] / lily / spacing-loose-columns.cc
index d03c3746e49fc4c7a0d3693e46671d0b42cd592e..15f77f34a0bcc0283ca5119af4e5958b9df24c06 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2005--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 2005--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
@@ -48,135 +48,166 @@ set_loose_columns (System *which, Column_x_positions const *posns)
       Item *left = 0;
       Item *right = 0;
 
-      vector<Item*> clique;
+      vector<Item *> clique;
       while (1)
-       {
-         SCM between = loose->get_object ("between-cols");
-         if (!scm_is_pair (between))
-           break;
+        {
+          SCM between = loose->get_object ("between-cols");
+          if (!scm_is_pair (between))
+            break;
 
-         /* If the line was broken at one of the loose columns, split
-            the clique at that column. */
-         if (!loose->get_system ())
-           break;
+          /* If the line was broken at one of the loose columns, split
+             the clique at that column. */
+          if (!loose->get_system ())
+            break;
 
-         Paper_column *le = dynamic_cast<Paper_column *> (unsmob_grob (scm_car (between)));
-         Paper_column *re = dynamic_cast<Paper_column *> (unsmob_grob (scm_cdr (between)));
+          Paper_column *le = unsmob<Paper_column> (scm_car (between));
+          Paper_column *re = unsmob<Paper_column> (scm_cdr (between));
 
-         if (! (le && re))
-           break;
+          if (! (le && re))
+            break;
 
-         if (!left && le)
-           {
-             left = le->get_column ();
-             if (!left->get_system ())
-               left = left->find_prebroken_piece (RIGHT);
+          if (!left && le)
+            {
+              left = le->get_column ();
+              if (!left->get_system ())
+                left = left->find_prebroken_piece (RIGHT);
 
-             clique.push_back (left);
-           }
+              clique.push_back (left);
+            }
 
-         clique.push_back (loose);
+          clique.push_back (loose);
 
-         divide_over++;
-         loose = right = re->get_column ();
-       }
+          divide_over++;
+          loose = right = re->get_column ();
+        }
 
       if (!right)
-       {
-         programming_error ("Can't attach loose column sensibly. Attaching to end of system.");
-         right = which->get_bound (RIGHT);
-       }
+        {
+          programming_error ("Can't attach loose column sensibly."
+                             "  Attaching to end of system.");
+          right = which->get_bound (RIGHT);
+        }
 
       if (right->get_system ())
-       ; /* do nothing */
+        ; /* do nothing */
       else if (right->find_prebroken_piece (LEFT)
-              && right->find_prebroken_piece (LEFT)->get_system () == which)
-       right = right->find_prebroken_piece (LEFT);
+               && right->find_prebroken_piece (LEFT)->get_system () == which)
+        right = right->find_prebroken_piece (LEFT);
       else if (Paper_column::get_rank (which->get_bound (RIGHT)) < Paper_column::get_rank (right))
-       right = which->get_bound (RIGHT);
+        right = which->get_bound (RIGHT);
       else
-       {
-         clique.back ()->programming_error ("Loose column does not have right side to attach to.");
-         System *base_system = dynamic_cast<System*> (which->original ());
-         int j = Paper_column::get_rank (clique.back ()) + 1;
-         int end_rank = Paper_column::get_rank (which->get_bound (RIGHT));
-         extract_grob_set (base_system, "columns", base_cols);
-         for (; j < end_rank; j++)
-           {
-             if (base_cols[j]->get_system () == which)
-               right = dynamic_cast<Item*> ((Grob*)base_cols[j]);
-           }
-       }
-      
+        {
+          clique.back ()->programming_error ("Loose column does not have right side to attach to.");
+          System *base_system = dynamic_cast<System *> (which->original ());
+          int j = Paper_column::get_rank (clique.back ()) + 1;
+          int end_rank = Paper_column::get_rank (which->get_bound (RIGHT));
+          extract_grob_set (base_system, "columns", base_cols);
+          for (; j < end_rank; j++)
+            {
+              if (base_cols[j]->get_system () == which)
+                right = dynamic_cast<Item *> ((Grob *)base_cols[j]);
+            }
+        }
+
       Grob *common = right->common_refpoint (left, X_AXIS);
 
       clique.push_back (right);
 
+      /*
+        We use two vectors to keep track of loose column spacing:
+          clique_spacing keeps track of ideal spaces.
+          clique_tight_spacing keeps track of minimum spaces.
+        Below, a scale factor is applied to the shifting of loose columns that
+        aims to preserve clique_spacing but gets closer to clique_tight_spacing as the
+        space becomes smaller.  This is used because the rods placed for loose columns
+        are tight (meaning they use minimum distances - see set_distances_for_loose_columns).
+        However, other rods may widen this distance, in which case we don't want a crammed score.
+        Thus, we aim for non-crammed, and fall back on crammed as needed.
+      */
       vector<Real> clique_spacing;
+      vector<Real> clique_tight_spacing;
       clique_spacing.push_back (0.0);
-      for (vsize j = 1; j + 1 < clique.size (); j ++)
-       {
-         Grob *clique_col = clique[j];
-
-         Paper_column *loose_col = dynamic_cast<Paper_column *> (clique[j]);
-         Paper_column *next_col = dynamic_cast<Paper_column *> (clique[j + 1]);
-
-         Grob *spacing = unsmob_grob (clique_col->get_object ("spacing"));
-         if (Grob *grace_spacing = unsmob_grob (clique_col->get_object ("grace-spacing")))
-           {
-             spacing = grace_spacing;
-           }
-         
-         Spacing_options options;
-         if (spacing)
-           options.init_from_grob (spacing);
-         else
-           programming_error ("Column without spacing object");
-
-         Real base_note_space = 0.0;
-
-         if (Paper_column::is_musical (next_col)
-             && Paper_column::is_musical (loose_col))
-           base_note_space = Spacing_spanner::note_spacing (spacing, loose_col, next_col,
-                                                            &options);
-         else
-           {
-             Spring spring = Spacing_spanner::standard_breakable_column_spacing (spacing,
-                                                                                 loose_col, next_col,
-                                                                                 &options);
-
-             base_note_space = spring.distance ();
-           }
-
-         base_note_space = max (base_note_space,
-                                robust_relative_extent (loose_col, loose_col, X_AXIS)[RIGHT]
-                                - robust_relative_extent (next_col, next_col, X_AXIS)[LEFT]);
-         
-         clique_spacing.push_back (base_note_space);
-       }
-
-      Real default_padding = 1.0;
-      clique_spacing.push_back (default_padding);
-
+      clique_tight_spacing.push_back (0.0);
+      for (vsize j = 1; j + 1 < clique.size (); j++)
+        {
+          Grob *clique_col = clique[j];
+
+          Paper_column *loose_col = dynamic_cast<Paper_column *> (clique[j]);
+          Paper_column *next_col = dynamic_cast<Paper_column *> (clique[j + 1]);
+
+          Grob *spacing = unsmob<Grob> (clique_col->get_object ("spacing"));
+          if (Grob *grace_spacing = unsmob<Grob> (clique_col->get_object ("grace-spacing")))
+            {
+              spacing = grace_spacing;
+            }
+
+          Spacing_options options;
+          if (spacing)
+            options.init_from_grob (spacing);
+          else
+            programming_error ("Column without spacing object");
+
+          Real base_note_space = 0.0;
+          Real tight_note_space = 0.0;
+
+          if (Paper_column::is_musical (next_col)
+              && Paper_column::is_musical (loose_col))
+            {
+              Spring spring = Spacing_spanner::note_spacing (spacing, loose_col,
+                                                             next_col, &options);
+              if (has_interface<Note_spacing> (spacing))
+                spring = Note_spacing::get_spacing (spacing, next_col,
+                                                    spring, options.increment_);
+
+              base_note_space = spring.distance ();
+              tight_note_space = spring.min_distance ();
+            }
+          else
+            {
+              Spring spring = Spacing_spanner::standard_breakable_column_spacing (spacing,
+                              loose_col, next_col,
+                              &options);
+
+              base_note_space = spring.distance ();
+              tight_note_space = spring.min_distance ();
+            }
+
+          Real loose_col_horizontal_length = loose_col->extent (loose_col, X_AXIS).length ();
+          base_note_space = max (base_note_space, loose_col_horizontal_length);
+          tight_note_space = max (tight_note_space, loose_col_horizontal_length);
+
+          clique_spacing.push_back (base_note_space);
+          clique_tight_spacing.push_back (tight_note_space);
+        }
+
+      Real permissible_distance = clique.back ()->relative_coordinate (common, X_AXIS) - robust_relative_extent (clique[0], common, X_AXIS)[RIGHT];
       Real right_point = robust_relative_extent (clique.back (), common, X_AXIS)[LEFT];
-      
-         
       Grob *finished_right_column = clique.back ();
-      
+
+      Real sum_tight_spacing = 0;
+      Real sum_spacing = 0;
+      // currently a magic number - what would be a good grob to hold this property?
+      Real left_padding = 0.15;
+      for (vsize j = 0; j < clique_spacing.size (); j++)
+        {
+          sum_tight_spacing += clique_tight_spacing[j];
+          sum_spacing += clique_spacing[j];
+        }
+      Real scale_factor = max (0.0, min (1.0, (permissible_distance - left_padding - sum_tight_spacing) / (sum_spacing - sum_tight_spacing)));
       for (vsize j = clique.size () - 2; j > 0; j--)
-       {
-         Paper_column *clique_col = dynamic_cast<Paper_column *> (clique[j]);
-         
-         right_point = finished_right_column->relative_coordinate (common, X_AXIS);
+        {
+          Paper_column *clique_col = dynamic_cast<Paper_column *> (clique[j]);
+
+          right_point = finished_right_column->relative_coordinate (common, X_AXIS);
+
+          Real distance_to_next = clique_tight_spacing[j] + (clique_spacing[j] - clique_tight_spacing[j]) * scale_factor;
 
-         Real distance_to_next = clique_spacing[j];
-         
-         Real my_offset = right_point - distance_to_next;
+          Real my_offset = right_point - distance_to_next;
 
-         clique_col->translate_axis (my_offset - clique_col->relative_coordinate (common, X_AXIS), X_AXIS);      
+          clique_col->translate_axis (my_offset - clique_col->relative_coordinate (common, X_AXIS), X_AXIS);
 
-         finished_right_column = clique_col;
-       }
+          finished_right_column = clique_col;
+        }
     }
 }