X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fpage-turn-page-breaking.cc;h=09545020c482ca4277de5b888e96c6f31f1df3bc;hb=b872748c6aa8bb721ced458691b38ac2fac5dfc8;hp=911e83467b6ff0a7bad8a58fa0a4daf16f481d66;hpb=744614ec4497e540fbaa6ad9bf6e842f4b99442a;p=lilypond.git diff --git a/lily/page-turn-page-breaking.cc b/lily/page-turn-page-breaking.cc index 911e83467b..09545020c4 100644 --- a/lily/page-turn-page-breaking.cc +++ b/lily/page-turn-page-breaking.cc @@ -1,9 +1,20 @@ /* - page-turn-page-breaking.cc -- implement Page_turn_page_breaking + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2006--2015 Joe Neeman - (c) 2006 Joe Neeman + 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 . */ #include "page-turn-page-breaking.hh" @@ -18,14 +29,25 @@ #include "system.hh" #include "warn.hh" +template static bool -is_break (Grob *g) +is_break (T *g) { - return scm_is_symbol (g->get_property ("page-turn-permission")); + bool turnable = scm_is_symbol (g->get_property ("page-turn-permission")); + + if (turnable + && (!scm_is_symbol (g->get_property ("page-break-permission")) + || !scm_is_symbol (g->get_property ("line-break-permission")))) + { + programming_error ("found a page-turnable place which was not breakable"); + turnable = false; + } + + return turnable; } Page_turn_page_breaking::Page_turn_page_breaking (Paper_book *pb) - : Page_breaking (pb, is_break) + : Page_breaking (pb, is_break, is_break) { } @@ -35,25 +57,17 @@ Page_turn_page_breaking::~Page_turn_page_breaking () Page_turn_page_breaking::Break_node Page_turn_page_breaking::put_systems_on_pages (vsize start, - vsize end, - vector const &lines, - Line_division const &div, - int page_number) + vsize end, + vsize configuration, + vsize page_number) { - bool last = end == breaks_.size () - 1; - bool ragged_all = to_boolean (book_->paper_->c_variable ("ragged-bottom")); - bool ragged_last = last && to_boolean (book_->paper_->c_variable ("ragged-last-bottom")); - Real page_h = page_height (1, false); // FIXME - SCM force_sym = last ? ly_symbol2scm ("blank-last-page-force") : ly_symbol2scm ("blank-page-force"); - Real blank_force = robust_scm2double (book_->paper_->lookup_variable (force_sym), 0); - Real page_weighting = robust_scm2double (book_->paper_->c_variable ("page-spacing-weight"), 10); - int min_p_count = min_page_count (lines, page_h, ragged_all, ragged_last); + vsize min_p_count = min_page_count (configuration, page_number); bool auto_first = to_boolean (book_->paper_->c_variable ("auto-first-page-number")); /* If [START, END] does not contain an intermediate breakpoint, we may need to consider solutions that result in a bad turn. In this case, we won't abort if the min_page_count is too big */ - if (start < end - 1 && min_p_count > 2) + if (start < end - 1 && min_p_count + (auto_first ? 0 : (page_number % 2)) > 2) return Break_node (); /* if PAGE-NUMBER is odd, we are starting on a right hand page. That is, we @@ -69,18 +83,18 @@ Page_turn_page_breaking::put_systems_on_pages (vsize start, min_p_count has that evenness. (For example, if PAGE-NUMBER is even and min_p_count is even, we don't even consider the blank page option). */ - Spacing_result result; + Page_spacing_result result; if (start == 0 && auto_first) { if (min_p_count % 2) - result = space_systems_on_n_or_one_more_pages (lines, min_p_count, page_h, 0, ragged_all, ragged_last); + result = space_systems_on_n_or_one_more_pages (configuration, min_p_count, page_number, 0); else - result = space_systems_on_n_pages (lines, min_p_count, page_h, ragged_all, ragged_last); + result = space_systems_on_n_pages (configuration, min_p_count, page_number); } else if (page_number % 2 == min_p_count % 2) - result = space_systems_on_n_pages (lines, min_p_count, page_h, ragged_all, ragged_last); + result = space_systems_on_n_pages (configuration, min_p_count, page_number); else - result = space_systems_on_n_or_one_more_pages (lines, min_p_count, page_h, blank_force, ragged_all, ragged_last); + result = space_systems_on_n_or_one_more_pages (configuration, min_p_count, page_number, blank_page_penalty ()); Break_node ret; ret.prev_ = start - 1; @@ -90,34 +104,28 @@ Page_turn_page_breaking::put_systems_on_pages (vsize start, if (auto_first && start == 0) ret.first_page_number_ += 1 - (ret.page_count_ % 2); - ret.div_ = div; + ret.div_ = current_configuration (configuration); ret.system_count_ = result.systems_per_page_; - ret.too_many_lines_ = true; - ret.demerits_ = result.penalty_; + ret.too_many_lines_ = all_lines_stretched (configuration); + ret.demerits_ = result.demerits_; if (start > 0) - ret.demerits_ += state_[start-1].demerits_; - for (vsize i = 0; i < lines.size (); i++) - { - ret.demerits_ += lines[i].force_ * lines[i].force_; - ret.demerits_ += lines[i].break_penalty_; - if (lines[i].force_ < 0) - ret.too_many_lines_ = false; - } - for (vsize i = 0; i < result.force_.size (); i++) - ret.demerits_ += result.force_[i] * result.force_[i] * page_weighting; + ret.demerits_ += state_[start - 1].demerits_; + return ret; } -/* "final page" meaning the number of the final right-hand page, - which always has an odd page number */ +/* The number of pages taken up by a Break_node, including + the blank page if there is one */ vsize -Page_turn_page_breaking::final_page_num (Break_node const &b) +Page_turn_page_breaking::total_page_count (Break_node const &b) { vsize end = b.first_page_number_ + b.page_count_; - return end + 1 - (end % 2); + return end - 1 + (end % 2) - b.first_page_number_; } +extern bool debug_page_breaking_scoring; + void Page_turn_page_breaking::calc_subproblem (vsize ending_breakpoint) { @@ -129,22 +137,23 @@ Page_turn_page_breaking::calc_subproblem (vsize ending_breakpoint) for (vsize start = end; start--;) { - if (start < end-1 - && breakpoint_property (start+1, "page-turn-permission") == ly_symbol2scm ("force")) - break; + if (start < end - 1 + && scm_is_eq (breakpoint_property (start + 1, "page-turn-permission"), + ly_symbol2scm ("force"))) + break; - if (start > 0 && best.demerits_ < state_[start-1].demerits_) + if (start > 0 && best.demerits_ < state_[start - 1].demerits_) continue; int p_num = robust_scm2int (book_->paper_->c_variable ("first-page-number"), 1); if (start > 0) { - /* except possibly for the first page, enforce the fact that first_page_number_ - should always be even (left hand page). - TODO: are there different conventions in right-to-left languages? - */ - p_num = state_[start-1].first_page_number_ + state_[start-1].page_count_; - p_num += p_num % 2; + /* except possibly for the first page, enforce the fact that first_page_number_ + should always be even (left hand page). + TODO: are there different conventions in right-to-left languages? + */ + p_num = state_[start - 1].first_page_number_ + state_[start - 1].page_count_; + p_num += p_num % 2; } Line_division min_division; @@ -156,24 +165,25 @@ Page_turn_page_breaking::calc_subproblem (vsize ending_breakpoint) bool ok_page = true; + if (debug_page_breaking_scoring) + message (_f ("page-turn-page-breaking: breaking from %d to %d", (int) start, (int) end)); + /* heuristic: we've just added a breakpoint, we'll need at least as many systems as before */ min_sys_count = max (min_sys_count, prev_best_system_count); for (vsize sys_count = min_sys_count; sys_count <= max_sys_count && ok_page; sys_count++) { - vector div = line_divisions (start, end, sys_count, min_division, max_division); + set_current_breakpoints (start, end, sys_count, min_division, max_division); bool found = false; - for (vsize d = 0; d < div.size (); d++) + for (vsize i = 0; i < current_configuration_count (); i++) { - vector line = line_details (start, end, div[d]); - - cur = put_systems_on_pages (start, end, line, div[d], p_num); + cur = put_systems_on_pages (start, end, i, p_num); if (isinf (cur.demerits_) - || (cur.page_count_ > 2 - && (!isinf (this_start_best.demerits_)) - && final_page_num (cur) > final_page_num (this_start_best))) + || (cur.page_count_ + (p_num % 2) > 2 + && (!isinf (this_start_best.demerits_)) + && total_page_count (cur) > total_page_count (this_start_best))) { ok_page = false; break; @@ -181,13 +191,16 @@ Page_turn_page_breaking::calc_subproblem (vsize ending_breakpoint) if (cur.demerits_ < this_start_best.demerits_) { + if (debug_page_breaking_scoring) + print_break_node (cur); + found = true; this_start_best = cur; prev_best_system_count = sys_count; - /* heuristic: if we increase the number of systems, we can bound the - division from below by our current best division */ - min_division = div[d]; + /* heuristic: if we increase the number of systems, we can bound the + division from below by our current best division */ + min_division = current_configuration (i); } } if (!found && this_start_best.too_many_lines_) @@ -200,13 +213,13 @@ Page_turn_page_breaking::calc_subproblem (vsize ending_breakpoint) } if (start == 0 && end == 1 - && this_start_best.first_page_number_ == 1 - && this_start_best.page_count_ > 1) - warning (_ ("cannot fit the first page turn onto a single page. " - "Consider setting first-page-number to an even number.")); + && this_start_best.first_page_number_ == 1 + && this_start_best.page_count_ > 1) + warning (_ ("cannot fit the first page turn onto a single page." + " Consider setting first-page-number to an even number.")); if (this_start_best.demerits_ < best.demerits_) - best = this_start_best; + best = this_start_best; } state_.push_back (best); } @@ -216,11 +229,11 @@ Page_turn_page_breaking::solve () { state_.clear (); message (_f ("Calculating page and line breaks (%d possible page breaks)...", - (int)breaks_.size () - 1) + " "); - for (vsize i = 0; i < breaks_.size () - 1; i++) + (int) last_break_position ())); + for (vsize i = 0; i < last_break_position (); i++) { calc_subproblem (i); - progress_indication (string ("[") + to_string (i + 1) + "]"); + progress_indication (string ("[") + ::to_string (i + 1) + "]"); } progress_indication ("\n"); @@ -245,7 +258,7 @@ Page_turn_page_breaking::make_lines (vector *psoln) vector &soln = *psoln; for (vsize n = 0; n < soln.size (); n++) { - vsize start = n > 0 ? soln[n-1].break_pos_ : 0; + vsize start = n > 0 ? soln[n - 1].break_pos_ : 0; vsize end = soln[n].break_pos_; break_into_pieces (start, end, soln[n].div_); @@ -257,20 +270,37 @@ Page_turn_page_breaking::make_lines (vector *psoln) SCM Page_turn_page_breaking::make_pages (vector const &soln, SCM systems) { + if (scm_is_null (systems)) + return SCM_EOL; + vector lines_per_page; for (vsize i = 0; i < soln.size (); i++) { for (vsize j = 0; j < soln[i].page_count_; j++) - lines_per_page.push_back (soln[i].system_count_[j]); + lines_per_page.push_back (soln[i].system_count_[j]); - if (i < soln.size () - 1 && (soln[i].first_page_number_ + soln[i].page_count_) % 2) - /* add a blank page */ - lines_per_page.push_back (0); + if (i + 1 < soln.size () && (soln[i].first_page_number_ + soln[i].page_count_) % 2) + /* add a blank page */ + lines_per_page.push_back (0); } /* this should only actually modify first-page-number if auto-first-page-number was true. */ book_->paper_->set_variable (ly_symbol2scm ("first-page-number"), - scm_from_int (soln[0].first_page_number_)); + scm_from_int (soln[0].first_page_number_)); return Page_breaking::make_pages (lines_per_page, systems); } + +void +Page_turn_page_breaking::print_break_node (Break_node const &node) +{ + int system_count = 0; + for (vsize i = 0; i < node.system_count_.size (); i++) + system_count += node.system_count_[i]; + + message (_f ("break starting at page %d", (int) node.first_page_number_)); + message (_f ("\tdemerits: %f", node.demerits_)); + message (_f ("\tsystem count: %d", system_count)); + message (_f ("\tpage count: %d", (int) node.page_count_)); + message (_f ("\tprevious break: %d", (int) node.prev_)); +}