]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/page-spacing.cc
Merge branch 'master' of git://git.savannah.gnu.org/lilypond.git
[lilypond.git] / lily / page-spacing.cc
index 1a3c39cfbf709d88de4725c6238fe8636141eb15..bae7ae6fb773d861440184ccf9685d194305eebb 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2006--2010 Joe Neeman <joeneeman@gmail.com>
+  Copyright (C) 2006--2011 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
@@ -19,6 +19,7 @@
 
 #include "page-spacing.hh"
 
+#include "international.hh"
 #include "matrix.hh"
 #include "page-breaking.hh"
 #include "warn.hh"
@@ -31,7 +32,7 @@ Page_spacing::calc_force ()
     - breaker_->min_whitespace_at_bottom_of_page (last_line_);
 
   if (rod_height_ + last_line_.bottom_padding_ >= height)
-    force_ = infinity_f;
+    force_ = -infinity_f;
   else
     force_ = (height - rod_height_ - last_line_.bottom_padding_ - spring_len_)
       / max (0.1, inverse_spring_k_);
@@ -50,6 +51,8 @@ Page_spacing::append_system (const Line_details &line)
   if (rod_height_)
     {
       rod_height_ += line.tallness_;
+      spring_len_ += last_line_.spring_length (line);
+
     }
   else
     {
@@ -57,7 +60,7 @@ Page_spacing::append_system (const Line_details &line)
       first_line_ = line;
     }
 
-  spring_len_ += line.space_;
+  rod_height_ += account_for_footnotes (line);
   inverse_spring_k_ += line.inverse_hooke_;
 
   last_line_ = line;
@@ -65,16 +68,42 @@ Page_spacing::append_system (const Line_details &line)
   calc_force ();
 }
 
+Real
+Page_spacing::account_for_footnotes (Line_details const &line)
+{
+  Real footnote_height = 0.0;
+  for (vsize i = 0; i < line.footnotes_.size (); i++)
+    {
+      footnote_height += (has_footnotes_
+                          ? 0.0
+                          : (breaker_->footnote_separator_stencil_height ()
+                             + breaker_->footnote_padding ()
+                             + breaker_->footnote_number_raise ()));
+
+      has_footnotes_ = true;
+      Interval extent = line.footnotes_[i]->extent (Y_AXIS);
+      footnote_height += extent[UP] - extent[DOWN];
+      footnote_height += breaker_->footnote_padding ();
+    }
+
+  return (footnote_height
+         - (has_footnotes_
+           ? breaker_->footnote_padding () + breaker_->footnote_footer_padding ()
+           : 0.0));
+}
+
 void
 Page_spacing::prepend_system (const Line_details &line)
 {
-  if (!rod_height_)
+  if (rod_height_)
+    spring_len_ += line.spring_length (first_line_);
+  else
     last_line_ = line;
 
   rod_height_ -= first_line_.full_height ();
   rod_height_ += first_line_.tallness_;
   rod_height_ += line.full_height();
-  spring_len_ += line.space_;
+  rod_height_ += account_for_footnotes (line);
   inverse_spring_k_ += line.inverse_hooke_;
 
   first_line_ = line;
@@ -87,6 +116,7 @@ Page_spacing::clear ()
 {
   force_ = rod_height_ = spring_len_ = 0;
   inverse_spring_k_ = 0;
+  has_footnotes_ = false;
 }
 
 
@@ -111,6 +141,10 @@ Page_spacer::solve ()
     }
 
   Page_spacing_result ret;
+  ret.penalty_ = simple_state_.back ().penalty_
+    + lines_.back ().page_penalty_ + lines_.back ().turn_penalty_;
+  ret.system_count_status_ = simple_state_.back ().system_count_status_;
+
   vsize system = lines_.size () - 1;
   while (system != VPOS)
     {
@@ -176,6 +210,7 @@ Page_spacer::solve (vsize page_count)
 
   ret.force_.resize (page_count);
   ret.systems_per_page_.resize (page_count);
+  ret.system_count_status_ = state_.at (system, page_count-1).system_count_status_;
   ret.penalty_ = state_.at (system, page_count-1).penalty_
     + lines_.back ().page_penalty_ + lines_.back ().turn_penalty_;
 
@@ -242,11 +277,15 @@ Page_spacer::calc_subproblem (vsize page, vsize line)
   bool last = line == lines_.size () - 1;
 
   // Note: if page == VPOS then we don't actually know yet which page number we're
-  // working on, so we have to recalculate the page height in the loop.  In that case,
-  // the algorithm may not be optimal: if our page has a very large header then perhaps
-  // we need to look ahead a few systems in order to find the best solution.  But
-  // we won't, because we stop once we overfill the page with the large header.
+  // working on, so we have to recalculate the page height in the loop.  Therefore
+  // our early-exit condition from the loop depends on paper_height rather than
+  // page_height (ie. we break only if we would overfill a page without margins
+  // or headers/footers).  Otherwise, the algorithm would not be optimal:
+  // if our page has a very large header then perhaps
+  // we should look ahead a few systems in order to find the best solution.  A
+  // good example of this is input/regression/page-spacing-tall-headfoot.ly
   vsize page_num = page == VPOS ? 0 : page;
+  Real paper_height = breaker_->paper_height ();
   Page_spacing space (breaker_->page_height (page_num + first_page_num_, last),
                      breaker_);
   Page_spacing_node &cur = page == VPOS ? simple_state_[line] : state_.at (line, page);
@@ -272,13 +311,16 @@ Page_spacer::calc_subproblem (vsize page, vsize line)
 
       space.prepend_system (lines_[page_start]);
 
+      bool overfull = (space.rod_height_ > paper_height
+                      || (ragged
+                          && (space.rod_height_ + space.spring_len_ > paper_height)));
       // This 'if' statement is a little hard to parse. It won't consider this configuration
       // if it is overfull unless the current configuration is the first one with this start
       // point. We also make an exception (and consider this configuration) if the previous
       // configuration we tried had fewer lines than min-systems-per-page.
       if (!breaker_->too_few_lines (line_count)
          && page_start < line
-         && (isinf (space.force_) || (space.force_ < 0 && ragged)))
+         && overfull)
        break;
 
       line_count += lines_[page_start].compressed_nontitle_lines_count_;
@@ -291,10 +333,11 @@ Page_spacer::calc_subproblem (vsize page, vsize line)
            space.force_ = 0;
 
          Real demerits = space.force_ * space.force_;
-         /* If a single line is taller than a page, we need to consider it as
-            a possible solution (but we give it a very bad score). */
-         if (isinf (space.force_) && page_start == line)
-           demerits = BAD_SPACING_PENALTY;
+
+         // Clamp the demerits at BAD_SPACING_PENALTY, even if the page
+         // is overfull.  This ensures that TERRIBLE_SPACING_PENALTY takes
+         // precedence over overfull pages.
+         demerits = min (demerits, BAD_SPACING_PENALTY);
          demerits += (prev ? prev->demerits_ : 0);
 
          Real penalty = breaker_->line_count_penalty (line_count);