]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/optimal-page-breaking.cc
Release: bump Welcome versions.
[lilypond.git] / lily / optimal-page-breaking.cc
index 29d5ee63e99ac2c2bfbda26bcd8383b79e61ad0d..4bcf05f8e49e71604b3f4d62229dac5470b98a2c 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--2015 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
 #include "prob.hh"
 #include "system.hh"
 
-static bool
-is_break (Grob *)
-{
-  return false;
-}
-
 Optimal_page_breaking::Optimal_page_breaking (Paper_book *pb)
-  : Page_breaking (pb, is_break)
+  : Page_breaking (pb, 0, 0)
 {
 }
 
@@ -58,138 +52,165 @@ Optimal_page_breaking::solve ()
   Line_division ideal_line_division = current_configuration (0);
   Line_division best_division = ideal_line_division;
   vsize min_sys_count = 1;
+
+  // Note that system_count () only counts non-title systems.
   vsize ideal_sys_count = system_count ();
-  
+
   if (!scm_is_integer (forced_page_count))
     {
       /* find out the ideal number of pages */
       message (_ ("Finding the ideal number of pages..."));
-  
-      if (systems_per_page () > 0)
-       best = space_systems_with_fixed_number_per_page (0, first_page_num);
-      else
-       best = space_systems_on_best_pages (0, first_page_num);
+
+      best = space_systems_on_best_pages (0, first_page_num);
 
       page_count = best.systems_per_page_.size ();
-      ideal_sys_count = best.system_count ();
-      min_sys_count = ideal_sys_count - best.systems_per_page_.back ();
-  
-      if (page_count > 1 && best.systems_per_page_[page_count - 2] > 1)
-       min_sys_count -= best.systems_per_page_[page_count - 2];
+      if (page_count == 0)
+        {
+          min_sys_count = 0;
+        }
+      else
+        {
+          min_sys_count = ideal_sys_count - best.systems_per_page_.back ();
+
+          if (page_count > 1 && best.systems_per_page_[page_count - 2] > 1)
+            min_sys_count -= best.systems_per_page_[page_count - 2];
 
-      min_sys_count = max (min_sys_count, (vsize)1);
+          if (min_sys_count > ideal_sys_count  // subtraction wrapped around
+              || min_sys_count <= 0)
+            min_sys_count = 1;
+        }
     }
   else
     {
+      /* If systems-per-page and page-count are both specified, we know exactly
+         how many systems should be present. */
+      if (systems_per_page () > 0)
+        {
+          ideal_sys_count = systems_per_page () * page_count;
+
+          if (ideal_sys_count > max_system_count (0, end)
+              || ideal_sys_count < min_system_count (0, end))
+            {
+              warning (_ ("could not satisfy systems-per-page and page-count at the same time, ignoring systems-per-page"));
+              ideal_sys_count = system_count ();
+              min_sys_count = page_count;
+            }
+          else
+            {
+              set_current_breakpoints (0, end, ideal_sys_count);
+              min_sys_count = max_sys_count = ideal_sys_count;
+              ideal_line_division = best_division = current_configuration (0);
+            }
+        }
+      else
+        min_sys_count = page_count;
+
       /* TODO: the following line will spit out programming errors if the
-        ideal line spacing doesn't fit on PAGE_COUNT pages */
-      /* TODO: the interaction between systems_per_page and page_count needs to
-        be considered. */
+         ideal line spacing doesn't fit on PAGE_COUNT pages */
       best = space_systems_on_n_pages (0, page_count, first_page_num);
-      min_sys_count = page_count;
     }
 
   if (page_count == 1)
     message (_ ("Fitting music on 1 page..."));
-  else if (scm_is_integer (forced_page_count))
+  else if (scm_is_integer (forced_page_count) || page_count == 0)
     message (_f ("Fitting music on %d pages...", (int)page_count));
   else
-    message (_f ("Fitting music on %d or %d pages...", (int)page_count-1, (int)page_count));
+    message (_f ("Fitting music on %d or %d pages...", (int)page_count - 1, (int)page_count));
 
   /* try a smaller number of systems than the ideal number for line breaking */
   Line_division bound = ideal_line_division;
-  for (vsize sys_count = ideal_sys_count; --sys_count >= min_sys_count;)
+  for (vsize sys_count = ideal_sys_count + 1; --sys_count >= min_sys_count;)
     {
       Page_spacing_result best_for_this_sys_count;
       set_current_breakpoints (0, end, sys_count, Line_division (), bound);
 
       if (debug_page_breaking_scoring)
-       message (_f ("trying %d systems", (int)sys_count));
+        message (_f ("trying %d systems", (int)sys_count));
 
       for (vsize i = 0; i < current_configuration_count (); i++)
-       {
-         vsize min_p_count = min_page_count (i, first_page_num);
-         Page_spacing_result cur;
-
-         if (min_p_count == page_count || scm_is_integer (forced_page_count))
-           cur = space_systems_on_n_pages (i, page_count, first_page_num);
-         else
-           cur = space_systems_on_n_or_one_more_pages (i, page_count-1, first_page_num, 0);
-
-         if (cur.demerits_ < best_for_this_sys_count.demerits_)
-           {
-             best_for_this_sys_count = cur;
-             bound = current_configuration (i);
-           }
-       }
+        {
+          Page_spacing_result cur;
+
+          if (scm_is_integer (forced_page_count))
+            cur = space_systems_on_n_pages (i, page_count, first_page_num);
+          else
+            cur = space_systems_on_best_pages (i, first_page_num);
+
+          if (cur.demerits_ < best_for_this_sys_count.demerits_)
+            {
+              best_for_this_sys_count = cur;
+              bound = current_configuration (i);
+            }
+        }
 
       if (debug_page_breaking_scoring)
-       message (_f ("best score for this sys-count: %f", best_for_this_sys_count.demerits_));
+        message (_f ("best score for this sys-count: %f", best_for_this_sys_count.demerits_));
 
       if (best_for_this_sys_count.demerits_ < best.demerits_)
-       {
-         best = best_for_this_sys_count;
-         best_division = bound;
-       }
+        {
+          best = best_for_this_sys_count;
+          best_division = bound;
+        }
 
       /* Check to see if we already have too few systems. There are two ways
-        we check this: if we are trying one less than the ideal number of pages
-        and the pages are stretched on average then we have too
-        few systems. If the spacing is worse than BAD_SPACING_PENALTY, then we
-        have too few systems. In either case, though, we need to continue reducing
-        the number of systems if max-systems-per-page requires it. */
+         we check this: if we are trying one less than the ideal number of pages
+         and the pages are stretched on average then we have too
+         few systems. If the spacing is worse than BAD_SPACING_PENALTY, then we
+         have too few systems. In either case, though, we need to continue reducing
+         the number of systems if max-systems-per-page requires it. */
       if (!(best.system_count_status_ & SYSTEM_COUNT_TOO_MANY))
-       {
-         if (best_for_this_sys_count.page_count () < page_count
-             && best_for_this_sys_count.average_force () > 0)
-           break;
-
-         if (best_for_this_sys_count.demerits_ >= BAD_SPACING_PENALTY)
-           break;
-       }
+        {
+          if (best_for_this_sys_count.page_count () < page_count
+              && best_for_this_sys_count.average_force () > 0)
+            break;
+
+          if (best_for_this_sys_count.demerits_ >= BAD_SPACING_PENALTY)
+            break;
+        }
     }
 
   /* try a larger number of systems than the ideal line breaking number. This
-     is more or less C&P, but the loop bounds make it difficult to try something
-     like do {...} while (flip(&d) != UP). */
+     is more or less C&P. */
   bound = ideal_line_division;
-  for (vsize sys_count = ideal_sys_count+1; sys_count <= max_sys_count; sys_count++)
+  for (vsize sys_count = ideal_sys_count + 1; sys_count <= max_sys_count; sys_count++)
     {
       Real best_demerits_for_this_sys_count = infinity_f;
       set_current_breakpoints (0, end, sys_count, bound);
 
       if (debug_page_breaking_scoring)
-       message (_f ("trying %d systems", (int)sys_count));
+        message (_f ("trying %d systems", (int)sys_count));
 
       for (vsize i = 0; i < current_configuration_count (); i++)
-       {
-         vsize min_p_count = min_page_count (i, first_page_num);
-         Page_spacing_result cur;
-
-         if (min_p_count > page_count)
-           continue;
-         else
-           cur = space_systems_on_n_pages (i, page_count, first_page_num);
-
-         if (cur.demerits_ < best.demerits_)
-           {
-             best = cur;
-             best_division = current_configuration (i);
-           }
-
-         if (cur.demerits_ < best_demerits_for_this_sys_count)
-           {
-             best_demerits_for_this_sys_count = cur.demerits_;
-             bound = current_configuration (i);
-           }
-       }
+        {
+          vsize min_p_count = min_page_count (i, first_page_num);
+          Page_spacing_result cur;
+
+          if (min_p_count > page_count)
+            continue;
+          else if (scm_is_integer (forced_page_count))
+            cur = space_systems_on_n_pages (i, page_count, first_page_num);
+          else
+            cur = space_systems_on_best_pages (i, first_page_num);
+
+          if (cur.demerits_ < best.demerits_)
+            {
+              best = cur;
+              best_division = current_configuration (i);
+            }
+
+          if (cur.demerits_ < best_demerits_for_this_sys_count)
+            {
+              best_demerits_for_this_sys_count = cur.demerits_;
+              bound = current_configuration (i);
+            }
+        }
 
       if (debug_page_breaking_scoring)
-       message (_f ("best score for this sys-count: %f", best_demerits_for_this_sys_count));
+        message (_f ("best score for this sys-count: %f", best_demerits_for_this_sys_count));
 
       if (best_demerits_for_this_sys_count >= BAD_SPACING_PENALTY
-       && !(best.system_count_status_ & SYSTEM_COUNT_TOO_FEW))
-       break;
+          && !(best.system_count_status_ & SYSTEM_COUNT_TOO_FEW))
+        break;
     }
 
   message (_ ("Drawing systems..."));