]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/page-layout-problem.cc
Make a pure version of calc_next_staff_spacing.
[lilypond.git] / lily / page-layout-problem.cc
index fe87727d5ec074f38dac99e063d07dde15a859f1..38a7548f3b785fbdbfd0ad83bea6a910a60a9cd1 100644 (file)
@@ -1,10 +1,20 @@
 /*
-  page-layout-problem.cc -- space systems nicely on a page. If systems can
-  be stretched, do that too.
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2009--2010 Joe Neeman <joeneeman@gmail.com>
 
-  (c) 2009 Joe Neeman <joeneeman@gmail.com>
+  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 "page-layout-problem.hh"
@@ -105,7 +115,7 @@ Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM syst
          else if (0 == Paper_column::get_rank (sys->get_bound (LEFT)))
            spec = between_scores_system_spacing;
 
-         Spring spring (first ? 0 : 1, 0.0);
+         Spring spring (0, 0);
          Real padding = 0.0;
          alter_spring_from_spacing_spec (spec, &spring);
          read_spacing_spec (spec, &padding, ly_symbol2scm ("padding"));
@@ -117,7 +127,7 @@ Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM syst
        {
          SCM spec = first ? top_system_spacing
            : (last_system_was_title ? between_title_spacing : before_title_spacing);
-         Spring spring (first ? 0 : 1, 0.0);
+         Spring spring (0, 0);
          Real padding = 0.0;
          alter_spring_from_spacing_spec (spec, &spring);
          read_spacing_spec (spec, &padding, ly_symbol2scm ("padding"));
@@ -293,6 +303,9 @@ Page_layout_problem::solve_rod_spring_problem (bool ragged)
 
   spacer.solve (page_height_, ragged);
   solution_ = spacer.spring_positions ();
+
+  if (!spacer.fits ())
+    warning (_ ("couldn't fit music on page"));
 }
 
 // The solution_ vector stores the position of every live VerticalAxisGroup
@@ -312,19 +325,20 @@ Page_layout_problem::find_system_offsets ()
   vector<Real> loose_line_min_distances;
   Grob *last_spaceable_line = 0;
   Real last_spaceable_line_translation = 0;
+  Interval last_title_extent;
   for (vsize i = 0; i < elements_.size (); ++i)
     {
       if (elements_[i].prob)
        {
          *tail = scm_cons (scm_from_double (solution_[spring_idx]), SCM_EOL);
          tail = SCM_CDRLOC (*tail);
+         Interval prob_extent = unsmob_stencil (elements_[i].prob->get_property ("stencil"))->extent (Y_AXIS);
 
          // Lay out any non-spaceable lines between this line and
          // the last one.
          if (loose_lines.size ())
            {
              Interval loose_extent = loose_lines.back ()->extent (loose_lines.back (), Y_AXIS);
-             Interval prob_extent = unsmob_stencil (elements_[i].prob->get_property ("stencil"))->extent (Y_AXIS);
              Real min_distance = -loose_extent[DOWN] + prob_extent[UP]; // TODO: include padding/minimum-distance
 
              loose_line_min_distances.push_back (min_distance);
@@ -338,6 +352,7 @@ Page_layout_problem::find_system_offsets ()
 
          last_spaceable_line = 0;
          last_spaceable_line_translation = -solution_[spring_idx];
+         last_title_extent = prob_extent;
          spring_idx++;
        }
       else
@@ -395,21 +410,27 @@ Page_layout_problem::find_system_offsets ()
                  if (loose_lines.empty ())
                    loose_lines.push_back (last_spaceable_line);
 
-                 loose_lines.push_back (staff);
                  if (staff_idx)
                    loose_line_min_distances.push_back (min_offsets[staff_idx-1] - min_offsets[staff_idx]);
                  else
                    {
                      Real min_dist = 0;
-                     if (last_spaceable_line)
-                       min_dist = Axis_group_interface::minimum_distance (last_spaceable_line,
+                     if (loose_lines.back ())
+                       min_dist = Axis_group_interface::minimum_distance (loose_lines.back (),
                                                                           staff,
                                                                           Y_AXIS);
+                     else if (!last_title_extent.is_empty ())
+                       { // distance to the preceding title
+                         // TODO: add options for controlling the space between a loose line
+                         // and a title/markup preceding it.
+                         min_dist = staff->extent (staff, Y_AXIS)[UP] - last_title_extent[DOWN];
+                       }
                      else // distance to the top margin
                        min_dist = header_padding_ + header_height_ + staff->extent (staff, Y_AXIS)[UP];
 
                      loose_line_min_distances.push_back (min_dist);
                    }
+                 loose_lines.push_back (staff);
                }
            }
 
@@ -443,6 +464,7 @@ Page_layout_problem::find_system_offsets ()
 // Given two lines that are already spaced (the first and last
 // elements of loose_lines), distribute some unspaced lines between
 // them.
+// first_translation and last_translation are relative to the page.
 void
 Page_layout_problem::distribute_loose_lines (vector<Grob*> const &loose_lines,
                                             vector<Real> const &min_distances,
@@ -451,7 +473,7 @@ Page_layout_problem::distribute_loose_lines (vector<Grob*> const &loose_lines,
   Simple_spacer spacer;
   for (vsize i = 0; i + 1 < loose_lines.size (); ++i)
     {
-      SCM spec = get_spacing_spec (loose_lines[i], loose_lines[i+1]);
+      SCM spec = get_spacing_spec (loose_lines[i], loose_lines[i+1], false, 0, INT_MAX);
       Spring spring (1.0, 0.0);
       alter_spring_from_spacing_spec (spec, &spring);
       spring.ensure_min_distance (min_distances[i]);
@@ -623,7 +645,7 @@ const double HUGE_STRETCH = 10e7;
 
 // Returns the spacing spec connecting BEFORE to AFTER.
 SCM
-Page_layout_problem::get_spacing_spec (Grob *before, Grob *after)
+Page_layout_problem::get_spacing_spec (Grob *before, Grob *after, bool pure, int start, int end)
 {
   // If there are no spacing wishes, return a very flexible spring.
   // This will occur, for example, if there are lyrics at the bottom of
@@ -635,38 +657,41 @@ Page_layout_problem::get_spacing_spec (Grob *before, Grob *after)
   if (is_spaceable (before))
     {
       if (is_spaceable (after))
-       return before->get_property ("next-staff-spacing");
+       return before->get_maybe_pure_property ("next-staff-spacing", pure, start, end);
       else
        {
-         Direction affinity = to_dir (after->get_property ("staff-affinity"));
+         Direction affinity = to_dir (after->get_maybe_pure_property ("staff-affinity", pure, start, end));
          return (affinity == DOWN)
-           ? add_stretchability (after->get_property ("non-affinity-spacing"), LARGE_STRETCH)
-           : after->get_property ("inter-staff-spacing");
+           ? add_stretchability (after->get_maybe_pure_property ("non-affinity-spacing", pure, start, end),
+                                 LARGE_STRETCH)
+           : after->get_maybe_pure_property ("inter-staff-spacing", pure, start, end);
        }
     }
   else
     {
       if (is_spaceable (after))
        {
-         Direction affinity = to_dir (before->get_property ("staff-affinity"));
+         Direction affinity = to_dir (before->get_maybe_pure_property ("staff-affinity", pure, start, end));
          return (affinity == UP)
-           ? add_stretchability (before->get_property ("non-affinity-spacing"), LARGE_STRETCH)
-           : before->get_property ("inter-staff-spacing");
+           ? add_stretchability (before->get_maybe_pure_property ("non-affinity-spacing", pure, start, end),
+                                 LARGE_STRETCH)
+           : before->get_maybe_pure_property ("inter-staff-spacing", pure, start, end);
        }
       else
        {
-         Direction before_affinity = to_dir (before->get_property ("staff-affinity"));
-         Direction after_affinity = to_dir (after->get_property ("staff-affinity"));
+         Direction before_affinity = to_dir (before->get_maybe_pure_property ("staff-affinity", pure, start, end));
+         Direction after_affinity = to_dir (after->get_maybe_pure_property ("staff-affinity", pure, start, end));
          if (after_affinity > before_affinity)
            {
              warning (_ ("staff-affinities should only decrease"));
              after_affinity = before_affinity;
            }
          if (before_affinity != UP)
-           return before->get_property ("inter-loose-line-spacing");
+           return before->get_maybe_pure_property ("inter-loose-line-spacing", pure, start, end);
          else if (after_affinity != DOWN)
-           return before->get_property ("inter-loose-line-spacing");
-         return add_stretchability (before->get_property ("non-affinity-spacing"), LARGE_STRETCH);
+           return before->get_maybe_pure_property ("inter-loose-line-spacing", pure, start, end);
+         return add_stretchability (before->get_maybe_pure_property ("non-affinity-spacing", pure, start, end),
+                                    LARGE_STRETCH);
        }
     }