X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fpage-breaking.cc;h=d5f71297b8390f4219969660a39c348c45f6c22b;hb=90fcc649dc06ad006158945acc15a69e24e942cd;hp=7dbac44278ef34c2f9cd0073c599932306c5212f;hpb=e18531db1f79fb685fbd16d6a2a67bf4b6c09915;p=lilypond.git diff --git a/lily/page-breaking.cc b/lily/page-breaking.cc index 7dbac44278..d5f71297b8 100644 --- a/lily/page-breaking.cc +++ b/lily/page-breaking.cc @@ -1,7 +1,7 @@ /* This file is part of LilyPond, the GNU music typesetter. - Copyright (C) 2006--2010 Joe Neeman + Copyright (C) 2006--2011 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 @@ -99,10 +99,22 @@ compress_lines (const vector &orig) { Line_details const &old = ret.back (); Line_details compressed = orig[i]; - Real padding = orig[i].title_ ? old.title_padding_ : old.padding_; - - compressed.extent_[DOWN] = old.extent_[DOWN]; - compressed.extent_[UP] = old.extent_[UP] + orig[i].extent_.length () + padding; + /* + We must account for the padding between the lines that we are compressing. + The padding values come from "old," which is the upper system here. Note + the meaning of tight-spacing: if a system has tight-spacing, then the padding + _before_ it is ignored. + */ + Real padding = 0; + if (!orig[i].tight_spacing_) + padding = orig[i].title_ ? old.title_padding_ : old.padding_; + + // FIXME: double check these. Doesn't foo.piggyback (bar) mean + // that foo goes on top? + // TODO: break out a Line_details::piggyback from here? + compressed.shape_ = old.shape_.piggyback (orig[i].shape_, padding); + compressed.refpoint_extent_[UP] = old.refpoint_extent_[UP]; + compressed.refpoint_extent_[DOWN] += compressed.shape_.rest_[UP] - old.shape_.rest_[UP]; compressed.space_ += old.space_; compressed.inverse_hooke_ += old.inverse_hooke_; @@ -165,10 +177,11 @@ Page_breaking::next_system (Break_position const &break_pos) const return sys + 1; /* this page starts with a new System_spec */ } -Page_breaking::Page_breaking (Paper_book *pb, Break_predicate is_break) +Page_breaking::Page_breaking (Paper_book *pb, Break_predicate is_break, Prob_break_predicate prob_break) { book_ = pb; system_count_ = 0; + paper_height_ = robust_scm2double (pb->paper_->c_variable ("paper-height"), 1.0); ragged_ = to_boolean (pb->paper_->c_variable ("ragged-bottom")); ragged_last_ = to_boolean (pb->paper_->c_variable ("ragged-last-bottom")); systems_per_page_ = max (0, robust_scm2int (pb->paper_->c_variable ("systems-per-page"), 0)); @@ -188,7 +201,7 @@ Page_breaking::Page_breaking (Paper_book *pb, Break_predicate is_break) } create_system_list (); - find_chunks_and_breaks (is_break); + find_chunks_and_breaks (is_break, prob_break); } Page_breaking::~Page_breaking () @@ -216,12 +229,16 @@ Page_breaking::systems_per_page () const int Page_breaking::max_systems_per_page () const { + if (systems_per_page_) + return systems_per_page_; return max_systems_per_page_; } int Page_breaking::min_systems_per_page () const { + if (systems_per_page_) + return systems_per_page_; return min_systems_per_page_; } @@ -330,9 +347,8 @@ Page_breaking::systems () ->get_broken_system_grobs (); ret = scm_cons (lines, ret); } - else + else if (Prob *pb = system_specs_[sys].prob_) { - Prob *pb = system_specs_[sys].prob_; ret = scm_cons (scm_list_1 (pb->self_scm ()), ret); pb->unprotect (); } @@ -357,16 +373,45 @@ Page_breaking::make_page (int page_num, bool last) const SCM_UNDEFINED)); } +// Returns the total height of the paper, including margins and +// space for the header/footer. This is an upper bound on +// page_height, and it doesn't depend on the current page. +Real +Page_breaking::paper_height () const +{ + return paper_height_; +} + Real Page_breaking::page_height (int page_num, bool last) const { - SCM mod = scm_c_resolve_module ("scm page"); - SCM page = make_page (page_num, last); - SCM calc_height = scm_c_module_lookup (mod, "calc-printable-height"); - calc_height = scm_variable_ref (calc_height); + // The caches allow us to store the page heights for any + // non-negative page numbers. We use a negative value in the + // cache to signal that that position has not yet been initialized. + // This means that we won't cache properly if page_num is negative or + // if calc_height returns a negative number. But that's likely to + // be rare, so it shouldn't affect performance. + vector& cache = last ? last_page_height_cache_ : page_height_cache_; + if (page_num >= 0 && (int) cache.size () > page_num && cache[page_num] >= 0) + return cache[page_num]; + else + { + SCM mod = scm_c_resolve_module ("scm page"); + SCM page = make_page (page_num, last); + SCM calc_height = scm_c_module_lookup (mod, "calc-printable-height"); + calc_height = scm_variable_ref (calc_height); + + SCM height_scm = scm_apply_1 (calc_height, page, SCM_EOL); + Real height = scm_to_double (height_scm); - SCM height = scm_apply_1 (calc_height, page, SCM_EOL); - return scm_to_double (height); + if (page_num >= 0) + { + if ((int) cache.size () <= page_num) + cache.resize (page_num + 1, -1); + cache[page_num] = height; + } + return height; + } } SCM @@ -423,6 +468,9 @@ Page_breaking::draw_page (SCM systems, SCM configuration, int page_num, bool las SCM Page_breaking::make_pages (vector lines_per_page, SCM systems) { + if (scm_is_null (systems)) + return SCM_EOL; + int first_page_number = robust_scm2int (book_->paper_->c_variable ("first-page-number"), 1); SCM ret = SCM_EOL; @@ -481,6 +529,11 @@ Page_breaking::make_pages (vector lines_per_page, SCM systems) ret = scm_cons (page, ret); --page_num; } + + // By reversing the table, we ensure that duplicated labels (eg. those + // straddling a page turn) will appear in the table with their last + // occurence first. + label_page_table = scm_reverse_x (label_page_table, SCM_EOL); book_->top_paper ()->set_variable (ly_symbol2scm ("label-page-table"), label_page_table); return ret; } @@ -512,10 +565,12 @@ Page_breaking::create_system_list () system_specs_.push_back (System_spec (pb)); } } + if (!system_specs_.size ()) + system_specs_.push_back (System_spec ()); } void -Page_breaking::find_chunks_and_breaks (Break_predicate is_break) +Page_breaking::find_chunks_and_breaks (Break_predicate is_break, Prob_break_predicate prob_is_break) { SCM force_sym = ly_symbol2scm ("force"); @@ -526,7 +581,8 @@ Page_breaking::find_chunks_and_breaks (Break_predicate is_break) { if (system_specs_[i].pscore_) { - vector cols; + vector cols = system_specs_[i].pscore_->root_system ()->used_columns (); + vector forced_line_break_cols; SCM system_count = system_specs_[i].pscore_->layout ()->c_variable ("system-count"); if (scm_is_number (system_count)) @@ -537,21 +593,28 @@ Page_breaking::find_chunks_and_breaks (Break_predicate is_break) Constrained_breaking breaking (system_specs_[i].pscore_); vector details = breaking.line_details (0, VPOS, scm_to_int (system_count)); - cols.push_back (system_specs_[i].pscore_->root_system ()->used_columns ()[0]); for (vsize j = 0; j < details.size (); j++) - cols.push_back (details[j].last_column_); + forced_line_break_cols.push_back (details[j].last_column_); } - else - cols = system_specs_[i].pscore_->root_system ()->used_columns (); - int last_chunk_idx = 0; + int last_forced_line_break_idx = 0; + vsize forced_line_break_idx = 0; vector line_breaker_columns; line_breaker_columns.push_back (0); for (vsize j = 1; j < cols.size (); j++) { + if (forced_line_break_cols.size ()) + { + if (forced_line_break_idx >= forced_line_break_cols.size () + || forced_line_break_cols[forced_line_break_idx] != cols[j]) + continue; + else + forced_line_break_idx++; + } + bool last = (j == cols.size () - 1); - bool break_point = is_break (cols[j]); + bool break_point = is_break && is_break (cols[j]); bool chunk_end = cols[j]->get_property ("page-break-permission") == force_sym; Break_position cur_pos = Break_position (i, line_breaker_columns.size (), @@ -565,14 +628,14 @@ Page_breaking::find_chunks_and_breaks (Break_predicate is_break) // since it mixes Break_positions from breaks_ and // chunks_. if (scm_is_number (system_count)) - cur_pos.forced_line_count_ = j - last_chunk_idx; + cur_pos.forced_line_count_ = forced_line_break_idx - last_forced_line_break_idx; if (break_point || (i == system_specs_.size () - 1 && last)) breaks_.push_back (cur_pos); if (chunk_end || last) { chunks_.push_back (cur_pos); - last_chunk_idx = j; + last_forced_line_break_idx = forced_line_break_idx; } if ((break_point || chunk_end) && !last) @@ -580,10 +643,10 @@ Page_breaking::find_chunks_and_breaks (Break_predicate is_break) } line_breaking_.push_back (Constrained_breaking (system_specs_[i].pscore_, line_breaker_columns)); } - else + else if (system_specs_[i].prob_) { - /* TODO: we want some way of applying Break_p to a prob? */ - if (i == system_specs_.size () - 1) + bool break_point = prob_is_break && prob_is_break (system_specs_[i].prob_); + if (break_point || i == system_specs_.size () - 1) breaks_.push_back (Break_position (i)); chunks_.push_back (Break_position (i)); @@ -613,6 +676,7 @@ Page_breaking::chunk_list (vsize start_index, vsize end_index) return ret; } +// Returns the minimum number of _non-title_ lines. vsize Page_breaking::min_system_count (vsize start, vsize end) { @@ -625,6 +689,7 @@ Page_breaking::min_system_count (vsize start, vsize end) return ret; } +// Returns the maximum number of _non-title_ lines. vsize Page_breaking::max_system_count (vsize start, vsize end) { @@ -637,6 +702,9 @@ Page_breaking::max_system_count (vsize start, vsize end) return ret; } +// The numbers returned by this function represent either +// the maximum or minimum number of _non-title_ lines +// per chunk. Page_breaking::Line_division Page_breaking::system_count_bounds (vector const &chunks, bool min) @@ -644,7 +712,7 @@ Page_breaking::system_count_bounds (vector const &chunks, assert (chunks.size () >= 2); Line_division ret; - ret.resize (chunks.size () - 1, 1); + ret.resize (chunks.size () - 1, 0); for (vsize i = 0; i + 1 < chunks.size (); i++) { @@ -744,7 +812,7 @@ Page_breaking::set_to_ideal_line_configuration (vsize start, vsize end) div.push_back (line_breaking_[sys].best_solution (start, end).size ()); } else - div.push_back (1); + div.push_back (0); system_count_ += div.back (); } @@ -781,11 +849,14 @@ Page_breaking::cache_line_details (vsize configuration_index) } else { - assert (div[i] == 1); - uncompressed_line_details_.push_back (Line_details (system_specs_[sys].prob_, book_->paper_)); + assert (div[i] == 0); + uncompressed_line_details_.push_back (system_specs_[sys].prob_ + ? Line_details (system_specs_[sys].prob_, book_->paper_) + : Line_details ()); } } cached_line_details_ = compress_lines (uncompressed_line_details_); + compute_line_heights (); } } @@ -804,19 +875,19 @@ Page_breaking::line_divisions_rec (vsize system_count, Line_division *cur_division) { vsize my_index = cur_division->size (); - vsize others_min = 0; - vsize others_max = 0; + int others_min = 0; + int others_max = 0; for (vsize i = my_index + 1; i < min_sys.size (); i++) { others_min += min_sys[i]; others_max += max_sys[i]; } - others_max = min (others_max, system_count); - vsize real_min = max (min_sys[my_index], system_count - others_max); - vsize real_max = min (max_sys[my_index], system_count - others_min); + others_max = min (others_max, (int) system_count); + int real_min = max ((int) min_sys[my_index], (int) system_count - others_max); + int real_max = min ((int) max_sys[my_index], (int) system_count - others_min); - if (real_min > real_max || real_min <= 0) + if (real_min > real_max || real_min < 0) { /* this should never happen within a recursive call. If it happens at all, it means that we were called with an unsolvable problem @@ -825,7 +896,7 @@ Page_breaking::line_divisions_rec (vsize system_count, return; } - for (vsize i = real_min; i <= real_max; i++) + for (int i = real_min; i <= real_max; i++) { cur_division->push_back (i); if (my_index == min_sys.size () - 1) @@ -836,6 +907,53 @@ Page_breaking::line_divisions_rec (vsize system_count, } } +void +Page_breaking::compute_line_heights () +{ + Real prev_hanging = 0; + Real prev_hanging_begin = 0; + Real prev_hanging_rest = 0; + + // refpoint_hanging is the y coordinate of the origin of this system. + // It may not be the same as refpoint_extent[UP], which is the + // refpoint of the first spaceable staff in this system. + Real prev_refpoint_hanging = 0; + for (vsize i = 0; i < cached_line_details_.size (); i++) + { + Line_details& cur = cached_line_details_[i]; + Line_shape shape = cur.shape_; + Real a = shape.begin_[UP]; + Real b = shape.rest_[UP]; + bool title = cur.title_; + Real refpoint_hanging = max (prev_hanging_begin + a, prev_hanging_rest + b); + + if (i > 0) + { + Real padding = 0; + Line_details const& prev = cached_line_details_[i-1]; + if (!cur.tight_spacing_) + padding = title + ? prev.title_padding_ + : prev.padding_; + Real min_dist = title + ? prev.title_min_distance_ + : prev.min_distance_; + refpoint_hanging = max (refpoint_hanging + padding, + prev_refpoint_hanging - prev.refpoint_extent_[DOWN] + + cur.refpoint_extent_[UP] + min_dist); + } + + Real hanging_begin = refpoint_hanging - shape.begin_[DOWN]; + Real hanging_rest = refpoint_hanging - shape.rest_[DOWN]; + Real hanging = max (hanging_begin, hanging_rest); + cur.tallness_ = hanging - prev_hanging; + prev_hanging = hanging; + prev_hanging_begin = hanging_begin; + prev_hanging_rest = hanging_rest; + prev_refpoint_hanging = refpoint_hanging; + } +} + vsize Page_breaking::min_page_count (vsize configuration, vsize first_page_num) { @@ -853,30 +971,32 @@ Page_breaking::min_page_count (vsize configuration, vsize first_page_num) for (vsize i = 0; i < cached_line_details_.size (); i++) { - Real ext_len = cached_line_details_[i].extent_.length (); - Real padding = 0; + Line_details const &cur = cached_line_details_[i]; + Line_details const *const prev = (i > 0) ? &cached_line_details_[i-1] : 0; + Real ext_len; if (cur_rod_height > 0) - padding = cached_line_details_[i].title_ ? - cached_line_details_[i-1].title_padding_ : cached_line_details_[i-1].padding_; + ext_len = cur.tallness_; + else + ext_len = cur.full_height(); - Real next_rod_height = cur_rod_height + ext_len + padding; - Real next_spring_height = cur_spring_height + cached_line_details_[i].space_; + Real spring_len = (i > 0) ? prev->spring_length (cur) : 0; + Real next_rod_height = cur_rod_height + ext_len; + Real next_spring_height = cur_spring_height + spring_len; Real next_height = next_rod_height + (ragged () ? next_spring_height : 0) - + min_whitespace_at_bottom_of_page (cached_line_details_[i]); - int next_line_count = line_count + cached_line_details_[i].compressed_nontitle_lines_count_; + + min_whitespace_at_bottom_of_page (cur); + int next_line_count = line_count + cur.compressed_nontitle_lines_count_; if ((!too_few_lines (line_count) && (next_height > cur_page_height && cur_rod_height > 0)) || too_many_lines (next_line_count) - || (i > 0 - && cached_line_details_[i-1].page_permission_ == ly_symbol2scm ("force"))) + || (prev && prev->page_permission_ == ly_symbol2scm ("force"))) { - line_count = cached_line_details_[i].compressed_nontitle_lines_count_; - cur_rod_height = ext_len; - cur_spring_height = cached_line_details_[i].space_; + line_count = cur.compressed_nontitle_lines_count_; + cur_rod_height = cur.full_height(); + cur_spring_height = 0; page_starter = i; cur_page_height = page_height (first_page_num + ret, false); - cur_page_height -= min_whitespace_at_top_of_page (cached_line_details_[i]); + cur_page_height -= min_whitespace_at_top_of_page (cur); ret++; } @@ -901,18 +1021,21 @@ Page_breaking::min_page_count (vsize configuration, vsize first_page_num) calculations that treated it as a non-last page were ok. */ - cur_page_height = page_height (first_page_num + ret - 1, true); - cur_page_height -= min_whitespace_at_top_of_page (cached_line_details_[page_starter]); - cur_page_height -= min_whitespace_at_bottom_of_page (cached_line_details_.back ()); - - Real cur_height = cur_rod_height + ((ragged_last () || ragged ()) ? cur_spring_height : 0); - if (!too_few_lines (line_count - cached_line_details_.back ().compressed_nontitle_lines_count_) - && cur_height > cur_page_height - /* don't increase the page count if the last page had only one system */ - && cur_rod_height > cached_line_details_.back ().extent_.length ()) - ret++; + if (is_last ()) + { + cur_page_height = page_height (first_page_num + ret - 1, true); + cur_page_height -= min_whitespace_at_top_of_page (cached_line_details_[page_starter]); + cur_page_height -= min_whitespace_at_bottom_of_page (cached_line_details_.back ()); + + Real cur_height = cur_rod_height + ((ragged_last () || ragged ()) ? cur_spring_height : 0); + if (!too_few_lines (line_count - cached_line_details_.back ().compressed_nontitle_lines_count_) + && cur_height > cur_page_height + /* don't increase the page count if the last page had only one system */ + && cur_rod_height > cached_line_details_.back ().full_height ()) + ret++; + assert (ret <= cached_line_details_.size ()); + } - assert (ret <= cached_line_details_.size ()); return ret; } @@ -1030,21 +1153,13 @@ Page_breaking::space_systems_on_n_or_one_more_pages (vsize configuration, vsize Page_spacing_result Page_breaking::space_systems_on_best_pages (vsize configuration, vsize first_page_num) { - vsize min_p_count = min_page_count (configuration, first_page_num); + if (systems_per_page_ > 0) + return space_systems_with_fixed_number_per_page (configuration, first_page_num); cache_line_details (configuration); Page_spacer ps (cached_line_details_, first_page_num, this); - Page_spacing_result best = ps.solve (min_p_count); - for (vsize i = min_p_count+1; i <= cached_line_details_.size (); i++) - { - Page_spacing_result cur = ps.solve (i); - if (cur.demerits_ < best.demerits_) - best = cur; - } - - Page_spacing_result ret = finalize_spacing_result (configuration, best); - return ret; + return finalize_spacing_result (configuration, ps.solve ()); } Page_spacing_result @@ -1083,7 +1198,7 @@ Page_breaking::space_systems_with_fixed_number_per_page (vsize configuration, res.penalty_ += cached_line_details_[line-1].page_penalty_; if (system_count_on_this_page != systems_per_page_) { - res.penalty_ += TERRIBLE_SPACING_PENALTY; + res.penalty_ += abs (system_count_on_this_page - systems_per_page_) * TERRIBLE_SPACING_PENALTY; res.system_count_status_ |= ((system_count_on_this_page < systems_per_page_)) ? SYSTEM_COUNT_TOO_FEW : SYSTEM_COUNT_TOO_MANY; } @@ -1247,6 +1362,7 @@ Page_breaking::space_systems_on_2_pages (vsize configuration, vsize first_page_n p1.systems_per_page_.push_back (p2.systems_per_page_[0]); p1.force_.push_back (p2.force_[0]); p1.penalty_ += p2.penalty_ - cached_line_details_[i].turn_penalty_; + p1.system_count_status_ |= p2.system_count_status_; return p1; } @@ -1375,7 +1491,7 @@ Page_breaking::min_whitespace_at_top_of_page (Line_details const &line) const { SCM first_system_spacing = book_->paper_->c_variable ("top-system-spacing"); if (line.title_) - first_system_spacing = book_->paper_->c_variable ("top-title-spacing"); + first_system_spacing = book_->paper_->c_variable ("top-markup-spacing"); Real min_distance = -infinity_f; Real padding = 0; @@ -1388,13 +1504,14 @@ Page_breaking::min_whitespace_at_top_of_page (Line_details const &line) const ly_symbol2scm ("padding")); // FIXME: take into account the height of the header - return max (0.0, max (padding, min_distance - line.extent_[UP])); + Real translate = max (line.shape_.begin_[UP], line.shape_.rest_[UP]); + return max (0.0, max (padding, min_distance - translate)); } Real Page_breaking::min_whitespace_at_bottom_of_page (Line_details const &line) const { - SCM last_system_spacing = book_->paper_->c_variable ("bottom-system-spacing"); + SCM last_system_spacing = book_->paper_->c_variable ("last-bottom-spacing"); Real min_distance = -infinity_f; Real padding = 0; @@ -1406,7 +1523,8 @@ Page_breaking::min_whitespace_at_bottom_of_page (Line_details const &line) const ly_symbol2scm ("padding")); // FIXME: take into account the height of the footer - return max (0.0, max (padding, min_distance + line.extent_[DOWN])); + Real translate = min (line.shape_.begin_[DOWN], line.shape_.rest_[DOWN]); + return max (0.0, max (padding, min_distance + translate)); } int