/*
page-breaking.cc -- implement a superclass and utility
- functions for use by various page-breaking algorithms
+ functions shared by various page-breaking algorithms
source file of the GNU LilyPond music typesetter
- (c) 2006 Joe Neeman <joeneeman@gmail.com>
+ (c) 2006--2007 Joe Neeman <joeneeman@gmail.com>
*/
#include "page-breaking.hh"
#include "system.hh"
#include "warn.hh"
-System_spec::System_spec (Paper_score *ps, int break_count)
+/* for each forbidden page break, merge the systems around it into one
+ system. */
+static vector<Line_details>
+compress_lines (const vector<Line_details> &orig)
{
- pscore_ = ps;
- prob_ = 0;
- score_break_count_ = break_count;
-}
+ vector<Line_details> ret;
-System_spec::System_spec (Prob *pb)
-{
- pscore_ = 0;
- prob_ = pb;
- score_break_count_ = 0;
+ for (vsize i = 0; i < orig.size (); i++)
+ {
+ if (ret.size () && !scm_is_symbol (ret.back ().page_permission_))
+ {
+ Line_details const &old = ret.back ();
+ Line_details compressed = orig[i];
+ compressed.extent_[DOWN] = old.extent_[DOWN];
+ compressed.extent_[UP] = old.extent_[UP] + orig[i].extent_.length () + old.padding_;
+ compressed.space_ += old.space_;
+ compressed.inverse_hooke_ += old.inverse_hooke_;
+
+ /* we don't need the force_ field for the vertical spacing,
+ so we use force_ = n to signal that the line was compressed,
+ reducing the number of lines by n (and force_ = 0 otherwise).
+ This makes uncompression much easier. */
+ compressed.force_ = old.force_ + 1;
+ ret.back () = compressed;
+ }
+ else
+ {
+ ret.push_back (orig[i]);
+ ret.back ().force_ = 0;
+ }
+ }
+ return ret;
}
-System_spec::System_spec ()
+/* translate the number of systems-per-page into something meaningful for
+ the uncompressed lines.
+*/
+static vector<vsize>
+uncompress_solution (vector<vsize> const &systems_per_page,
+ vector<Line_details> const &compressed)
{
- pscore_ = 0;
- prob_ = 0;
- score_break_count_ = 0;
+ vector<vsize> ret;
+ vsize start_sys = 0;
+
+ for (vsize i = 0; i < systems_per_page.size (); i++)
+ {
+ int compressed_count = 0;
+ for (vsize j = start_sys; j < start_sys + systems_per_page[i]; j++)
+ compressed_count += (int)compressed[j].force_;
+
+ ret.push_back (systems_per_page[i] + compressed_count);
+ start_sys += systems_per_page[i];
+ }
+ return ret;
}
/* for Page_breaking, the start index (when we are dealing with the stuff
it. */
/* Turn a break index into the sys index that starts the next page */
-vsize Page_breaking::next_system (vsize start) const
+vsize
+Page_breaking::next_system (Break_position const &break_pos) const
{
- vsize sys = breaks_[start].sys_;
+ vsize sys = break_pos.system_spec_index_;
- if (sys == VPOS) /* beginning of the piece */
+ if (sys == VPOS) /* beginning of the book */
return 0;
- if (all_[sys].pscore_ && all_[sys].score_break_count_ > breaks_[start].score_break_)
+ if (system_specs_[sys].pscore_ && !break_pos.score_ender_)
return sys; /* the score overflows the previous page */
- return sys + 1; /* this page starts with a new sys */
+ return sys + 1; /* this page starts with a new System_spec */
}
-Page_breaking::Page_breaking (Paper_book *pb, bool allow_intra_score_breaks)
+Page_breaking::Page_breaking (Paper_book *pb, Break_predicate is_break)
{
book_ = pb;
- create_system_list (allow_intra_score_breaks);
+ ragged_ = to_boolean (pb->paper_->c_variable ("ragged-bottom"));
+ ragged_last_ = to_boolean (pb->paper_->c_variable ("ragged-last-bottom"));
+ create_system_list ();
+ find_chunks_and_breaks (is_break);
}
Page_breaking::~Page_breaking ()
{
}
-/* translate indices into breaks_ into start-end parameters for the line breaker */
-void
-Page_breaking::line_breaker_args (vsize i, vsize *start, vsize *end)
+bool
+Page_breaking::ragged () const
{
- assert (all_[i].pscore_);
- assert (next_system (*start) <= i && i <= breaks_[*end].sys_);
-
- vsize start_col = 0;
- vsize end_col = VPOS;
-
- if (breaks_[*start].sys_ == i)
- start_col = breaks_[*start].score_break_;
- if (breaks_[*end].sys_ == i)
- end_col = breaks_[*end].score_break_;
+ return ragged_;
+}
- assert (end_col && (end_col == VPOS || end_col <= all_[breaks_[*end].sys_].score_break_count_));
- *start = start_col;
- *end = end_col;
+bool
+Page_breaking::ragged_last () const
+{
+ return ragged_last_;
}
-vector<Column_x_positions>
-Page_breaking::get_line_breaks (vsize i, vsize sys_count, vsize start, vsize end)
+/* translate indices into breaks_ into start-end parameters for the line breaker */
+void
+Page_breaking::line_breaker_args (vsize sys,
+ Break_position const &start,
+ Break_position const &end,
+ vsize *line_breaker_start,
+ vsize *line_breaker_end)
{
- assert (all_[i].pscore_);
- line_breaker_args (i, &start, &end);
- return line_breaking_[i].get_solution (start, end, sys_count);
+ assert (system_specs_[sys].pscore_);
+ assert (next_system (start) <= sys && sys <= end.system_spec_index_);
+
+ if (start.system_spec_index_ == sys)
+ *line_breaker_start = start.score_break_;
+ else
+ *line_breaker_start = 0;
+
+ if (end.system_spec_index_ == sys)
+ *line_breaker_end = end.score_break_;
+ else
+ *line_breaker_end = VPOS;
}
-vector<Line_details>
-Page_breaking::get_line_details (vsize start_break, vsize end_break, vector<vsize> const &div)
+void
+Page_breaking::break_into_pieces (vsize start_break, vsize end_break,
+ Line_division const &div)
{
- vector<Line_details> ret;
+ vector<Break_position> chunks = chunk_list (start_break, end_break);
+ bool ignore_div = false;
+ if (chunks.size () != div.size () + 1)
+ {
+ programming_error ("did not find a valid page breaking configuration");
+ ignore_div = true;
+ }
- for (vsize i = next_system (start_break); i <= breaks_[end_break].sys_; i++)
+ for (vsize i = 0; i + 1 < chunks.size (); i++)
{
- if (all_[i].pscore_)
+ vsize sys = next_system (chunks[i]);
+ if (system_specs_[sys].pscore_)
{
- vsize div_index = i - next_system (start_break);
- vsize start = start_break;
- vsize end = end_break;
-
- line_breaker_args (i, &start, &end);
- vector<Line_details> l = line_breaking_[i].get_details (start, end, div[div_index]);
- ret.insert (ret.end (), l.begin (), l.end ());
+ vsize start;
+ vsize end;
+ line_breaker_args (sys, chunks[i], chunks[i+1], &start, &end);
+
+ vector<Column_x_positions> pos = ignore_div
+ ? line_breaking_[sys].best_solution (start, end)
+ : line_breaking_[sys].solve (start, end, div[i]);
+ system_specs_[sys].pscore_->root_system ()->break_into_pieces (pos);
}
- else
- ret.push_back (Line_details (all_[i].prob_));
}
- return ret;
-}
-
-vsize
-Page_breaking::get_min_systems (vsize i, vsize start, vsize end)
-{
- line_breaker_args (i, &start, &end);
- return line_breaking_[i].get_min_systems (start, end);
}
-vsize
-Page_breaking::get_max_systems (vsize i, vsize start, vsize end)
+SCM
+Page_breaking::systems ()
{
- line_breaker_args (i, &start, &end);
- return line_breaking_[i].get_max_systems (start, end);
+ SCM ret = SCM_EOL;
+ for (vsize sys = 0; sys < system_specs_.size (); sys++)
+ {
+ if (system_specs_[sys].pscore_)
+ {
+ system_specs_[sys].pscore_->root_system ()
+ ->do_break_substitution_and_fixup_refpoints ();
+ SCM lines = system_specs_[sys].pscore_->root_system ()
+ ->get_broken_system_grobs ();
+ ret = scm_cons (lines, ret);
+ }
+ else
+ {
+ Prob *pb = system_specs_[sys].prob_;
+ ret = scm_cons (scm_list_1 (pb->self_scm ()), ret);
+ pb->unprotect ();
+ }
+ }
+ return scm_append (scm_reverse (ret));
}
Real
-Page_breaking::page_height (int page_num, bool last)
+Page_breaking::page_height (int page_num, bool last) const
{
SCM mod = scm_c_resolve_module ("scm page");
SCM calc_height = scm_c_module_lookup (mod, "calc-printable-height");
return scm_to_double (height) - scm_to_double (book_->paper_->c_variable ("page-top-space"));
}
+SCM
+Page_breaking::breakpoint_property (vsize breakpoint, char const *str)
+{
+ Break_position const &pos = breaks_[breakpoint];
+
+ if (pos.system_spec_index_ == VPOS)
+ return SCM_EOL;
+ if (system_specs_[pos.system_spec_index_].pscore_)
+ return pos.col_->get_property (str);
+ return system_specs_[pos.system_spec_index_].prob_->get_property (str);
+}
+
SCM
Page_breaking::make_pages (vector<vsize> lines_per_page, SCM systems)
{
- SCM module = scm_c_resolve_module ("scm layout-page-layout");
- SCM make_page = scm_c_module_lookup (module, "make-page-from-systems");
+ SCM layout_module = scm_c_resolve_module ("scm layout-page-layout");
+ SCM page_module = scm_c_resolve_module ("scm page");
+
+ SCM make_page = scm_c_module_lookup (layout_module, "stretch-and-draw-page");
+ SCM page_stencil = scm_c_module_lookup (page_module, "page-stencil");
make_page = scm_variable_ref (make_page);
+ page_stencil = scm_variable_ref (page_stencil);
+
SCM book = book_->self_scm ();
- bool ragged_all = to_boolean (book_->paper_->c_variable ("ragged-bottom"));
- bool ragged_last = to_boolean (book_->paper_->c_variable ("ragged-last-bottom"));
+ int first_page_number
+ = robust_scm2int (book_->paper_->c_variable ("first-page-number"), 1);
SCM ret = SCM_EOL;
+ SCM label_page_table = SCM_EOL;
for (vsize i = 0; i < lines_per_page.size (); i++)
{
- SCM page_num = scm_from_int (i + 1);
+ SCM page_num = scm_from_int (i + first_page_number);
SCM last = scm_from_bool (i == lines_per_page.size () - 1);
- SCM ragged = scm_from_bool (ragged_all || (to_boolean (last) && ragged_last));
+ SCM rag = scm_from_bool (ragged () || (to_boolean (last)
+ && ragged_last ()));
SCM line_count = scm_from_int (lines_per_page[i]);
SCM lines = scm_list_head (systems, line_count);
SCM page = scm_apply_0 (make_page,
- scm_list_n (book, lines, page_num, ragged, last, SCM_UNDEFINED));
+ scm_list_n (book, lines, page_num,
+ rag, last, SCM_UNDEFINED));
+
+ /* collect labels */
+ for (SCM l = lines ; scm_is_pair (l) ; l = scm_cdr (l))
+ {
+ SCM labels = SCM_EOL;
+ if (Grob * line = unsmob_grob (scm_car (l)))
+ {
+ System *system = dynamic_cast<System*> (line);
+ labels = system->get_property ("labels");
+ }
+ else if (Prob *prob = unsmob_prob (scm_car (l)))
+ labels = prob->get_property ("labels");
+
+ for (SCM lbls = labels ; scm_is_pair (lbls) ; lbls = scm_cdr (lbls))
+ label_page_table = scm_cons (scm_cons (scm_car (lbls), page_num),
+ label_page_table);
+ }
+ scm_apply_1 (page_stencil, page, SCM_EOL);
ret = scm_cons (page, ret);
systems = scm_list_tail (systems, line_count);
}
- return scm_reverse (ret);
+ book_->paper_->set_variable (ly_symbol2scm ("label-page-table"), label_page_table);
+ ret = scm_reverse (ret);
+ return ret;
}
-/* if allow_intra_score_breaks is false, that doesn't necessarily mean that there will
- be no page turns in the middle of a score, only that we don't give special
- consideration to any internal part of a score.
+/* The page-turn-page-breaker needs to have a line-breaker between any two
+ columns with non-NULL page-turn-permission.
+
+ The optimal-breaker needs to have a line-breaker between any two columns
+ with page-break-permission = 'force.
- Corollary: if allow_intra_score_breaks is false, any \pageTurn or \noPageTurn commands
- in the middle of a score will be ignored.
+ By using a grob predicate, we can accommodate both of these uses.
*/
void
-Page_breaking::create_system_list (bool allow_intra_score_breaks)
+Page_breaking::create_system_list ()
{
- breaks_.push_back (Break_position ());
-
SCM specs = book_->get_system_specs ();
- for (SCM s = specs; s != SCM_EOL; s = scm_cdr (s))
+ for (SCM s = specs; scm_is_pair (s); s = scm_cdr (s))
{
if (Paper_score *ps = dynamic_cast<Paper_score*> (unsmob_music_output (scm_car (s))))
- {
- /* add a breakpoint at the end of the last score, if necessary */
- if (all_.size () && all_.back ().pscore_)
- breaks_.push_back (Break_position (all_.size () - 1,
- all_.back ().score_break_count_));
-
- vector<vsize> score_brk;
- if (allow_intra_score_breaks)
- score_brk = find_page_break_indices (ps);
-
- all_.push_back (System_spec (ps, score_brk.size () + 1));
-
- for (vsize i = 0; i < score_brk.size(); i++)
- breaks_.push_back (Break_position (all_.size () - 1, i + 1));
-
- /* include a line breaker at the start of the score */
- score_brk.insert (score_brk.begin (), 0);
- line_breaking_.push_back (Constrained_breaking (score_brk));
- line_breaking_.back ().set_pscore (ps);
- }
+ {
+ SCM system_count = ps->layout ()->c_variable ("system-count");
+
+ if (scm_is_number (system_count))
+ s = scm_append (scm_list_3 (scm_list_1 (scm_car (s)),
+ scm_vector_to_list (ps->get_paper_systems ()),
+ scm_cdr (s)));
+ else
+ system_specs_.push_back (System_spec (ps));
+ }
else
{
Prob *pb = unsmob_prob (scm_car (s));
assert (pb);
pb->protect ();
- // ignore penalties (from break-before) in favour of using \pageBreak at the
- // end of the score
- if (all_.size () && all_.back ().pscore_)
- breaks_.push_back (Break_position (all_.size () - 1, all_.back ().score_break_count_));
- all_.push_back (System_spec (pb));
- line_breaking_.push_back (Constrained_breaking ());
+ system_specs_.push_back (System_spec (pb));
}
}
+}
- /* add the ending breakpoint */
- if (all_.back ().pscore_)
- breaks_.push_back (Break_position (all_.size () - 1, all_.back ().score_break_count_));
- else
- breaks_.push_back (Break_position (all_.size () - 1));
+void
+Page_breaking::find_chunks_and_breaks (Break_predicate is_break)
+{
+ SCM force_sym = ly_symbol2scm ("force");
+
+ chunks_.push_back (Break_position ());
+ breaks_.push_back (Break_position ());
+
+ for (vsize i = 0; i < system_specs_.size (); i++)
+ {
+ if (system_specs_[i].pscore_)
+ {
+ vector<Grob*> cols
+ = system_specs_[i].pscore_->root_system ()->used_columns ();
+ vector<vsize> line_breaker_columns;
+ line_breaker_columns.push_back (0);
+
+ for (vsize j = 1; j < cols.size (); j++)
+ {
+ bool last = (j == cols.size () - 1);
+ bool break_point = 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 (),
+ cols[j],
+ last);
+
+ if (break_point || (i == system_specs_.size () - 1 && last))
+ breaks_.push_back (cur_pos);
+ if (chunk_end || last)
+ chunks_.push_back (cur_pos);
+
+ if ((break_point || chunk_end) && !last)
+ line_breaker_columns.push_back (j);
+ }
+ line_breaking_.push_back (Constrained_breaking (system_specs_[i].pscore_, line_breaker_columns));
+ }
+ else
+ {
+ /* TODO: we want some way of applying Break_p to a prob? */
+ if (i == system_specs_.size () - 1)
+ breaks_.push_back (Break_position (i));
+
+ chunks_.push_back (Break_position (i));
+
+ /* FIXME: shouldn't we push a Null_breaker or similar dummy
+ class? --hwn */
+ line_breaking_.push_back (Constrained_breaking (NULL));
+ }
+ }
}
-vector<vsize>
-Page_breaking::find_page_break_indices (Paper_score *pscore)
+vector<Break_position>
+Page_breaking::chunk_list (vsize start_index, vsize end_index)
{
- vector<Grob*> all = pscore->root_system ()->columns ();
- vector<vsize> ret;
+ Break_position start = breaks_[start_index];
+ Break_position end = breaks_[end_index];
+
+ vsize i = 0;
+ for (; i < chunks_.size () && chunks_[i] <= start; i++)
+ ;
+
+ vector<Break_position> ret;
+ ret.push_back (start);
+ for (; i < chunks_.size () && chunks_[i] < end; i++)
+ ret.push_back (chunks_[i]);
+ ret.push_back (end);
+ return ret;
+}
- /* we don't include breaks at the beginning and end */
- for (vsize i = 0; i < all.size () - 1; i++)
- if (scm_is_symbol (all[i]->get_property ("page-turn-permission")))
- ret.push_back(i);
+vsize
+Page_breaking::min_system_count (vsize start, vsize end)
+{
+ vector<Break_position> chunks = chunk_list (start, end);
+ Line_division div = system_count_bounds (chunks, true);
+ vsize ret = 0;
+
+ for (vsize i = 0; i < div.size (); i++)
+ ret += div[i];
+ return ret;
+}
+
+vsize
+Page_breaking::max_system_count (vsize start, vsize end)
+{
+ vector<Break_position> chunks = chunk_list (start, end);
+ Line_division div = system_count_bounds (chunks, false);
+ vsize ret = 0;
+
+ for (vsize i = 0; i < div.size (); i++)
+ ret += div[i];
+ return ret;
+}
+
+Page_breaking::Line_division
+Page_breaking::system_count_bounds (vector<Break_position> const &chunks,
+ bool min)
+{
+ assert (chunks.size () >= 2);
+
+ Line_division ret;
+ ret.resize (chunks.size () - 1, 1);
+
+ for (vsize i = 0; i + 1 < chunks.size (); i++)
+ {
+ vsize sys = next_system (chunks[i]);
+ if (system_specs_[sys].pscore_)
+ {
+ vsize start;
+ vsize end;
+ line_breaker_args (sys, chunks[i], chunks[i+1], &start, &end);
+ ret[i] = min
+ ? line_breaking_[sys].min_system_count (start, end)
+ : line_breaking_[sys].max_system_count (start, end);
+ }
+ }
return ret;
}
void
-Page_breaking::calc_system_count_bounds (vsize start, vsize end,
- vector<vsize> *min,
- vector<vsize> *max)
+Page_breaking::set_current_breakpoints (vsize start,
+ vsize end,
+ vsize system_count,
+ Line_division lower_bound,
+ Line_division upper_bound)
{
- for (vsize i = next_system (start); i <= breaks_[end].sys_; i++)
+ current_chunks_ = chunk_list (start, end);
+ current_start_breakpoint_ = start;
+ current_end_breakpoint_ = end;
+ clear_line_details_cache ();
+
+ if (!lower_bound.size ())
+ lower_bound = system_count_bounds (current_chunks_, true);
+ if (!upper_bound.size ())
+ upper_bound = system_count_bounds (current_chunks_, false);
+
+ assert (lower_bound.size () == current_chunks_.size () - 1);
+ assert (upper_bound.size () == current_chunks_.size () - 1);
+
+ Line_division work_in_progress;
+ current_configurations_.clear ();
+ line_divisions_rec (system_count,
+ lower_bound,
+ upper_bound,
+ &work_in_progress);
+
+ /* we only consider a constant number of configurations. Otherwise,
+ this becomes slow when there are many small scores. The constant
+ 5 is somewhat arbitrary. */
+ if (current_configurations_.size () > 5)
{
- if (all_[i].pscore_)
- {
- min->push_back (get_min_systems (i, start, end));
- max->push_back (get_max_systems (i, start, end));
- }
+ vector<pair<Real,vsize> > dems_and_indices;
+
+ for (vsize i = 0; i < current_configurations_.size (); i++)
+ {
+ cache_line_details (i);
+ Real dem = 0;
+ for (vsize j = 0; j < cached_line_details_.size (); j++)
+ dem += cached_line_details_[j].force_ * cached_line_details_[j].force_
+ + cached_line_details_[j].break_penalty_;
+
+ dems_and_indices.push_back (pair<Real,vsize> (dem, i));
+ }
+ vector_sort (dems_and_indices, less<pair<Real,vsize> > ());
+
+ vector<Line_division> best_5_configurations;
+ for (vsize i = 0; i < 5; i++)
+ best_5_configurations.push_back (current_configurations_[dems_and_indices[i].second]);
+
+ clear_line_details_cache ();
+ current_configurations_ = best_5_configurations;
+ }
+}
+
+void
+Page_breaking::set_to_ideal_line_configuration (vsize start, vsize end)
+{
+ current_chunks_ = chunk_list (start, end);
+ current_start_breakpoint_ = start;
+ current_end_breakpoint_ = end;
+ clear_line_details_cache ();
+
+ Line_division div;
+ for (vsize i = 0; i+1 < current_chunks_.size (); i++)
+ {
+ vsize sys = next_system (current_chunks_[i]);
+ if (system_specs_[sys].pscore_)
+ {
+ line_breaker_args (sys, current_chunks_[i], current_chunks_[i+1], &start, &end);
+ div.push_back (line_breaking_[sys].best_solution (start, end).size ());
+ }
else
- {
- min->push_back (1);
- max->push_back (1);
- }
+ div.push_back (1);
}
+ current_configurations_.clear ();
+ current_configurations_.push_back (div);
+}
+
+vsize
+Page_breaking::current_configuration_count () const
+{
+ return current_configurations_.size ();
}
-/* calculate all possible ways of dividing system_count between the System_specs */
void
-Page_breaking::divide_systems (vsize system_count,
- vector<vsize> const &min_sys,
- vector<vsize> const &max_sys,
- vector<vector<vsize> > *result,
- vector<vsize> *cur_division)
+Page_breaking::cache_line_details (vsize configuration_index)
+{
+ if (cached_configuration_index_ != configuration_index)
+ {
+ SCM padding_scm = book_->paper_->c_variable ("page-breaking-between-system-padding");
+ if (!scm_is_number (padding_scm))
+ padding_scm = book_->paper_->c_variable ("between-system-padding");
+ Real padding = robust_scm2double (padding_scm, 0.0);
+
+ Line_division &div = current_configurations_[configuration_index];
+ uncompressed_line_details_.clear ();
+ for (vsize i = 0; i + 1 < current_chunks_.size (); i++)
+ {
+ vsize sys = next_system (current_chunks_[i]);
+ if (system_specs_[sys].pscore_)
+ {
+ vsize start;
+ vsize end;
+ line_breaker_args (sys, current_chunks_[i], current_chunks_[i+1], &start, &end);
+
+ vector<Line_details> details = line_breaking_[sys].line_details (start, end, div[i]);
+ uncompressed_line_details_.insert (uncompressed_line_details_.end (), details.begin (), details.end ());
+ }
+ else
+ {
+ assert (div[i] == 1);
+ uncompressed_line_details_.push_back (Line_details (system_specs_[sys].prob_));
+ uncompressed_line_details_.back ().padding_ = padding;
+ }
+ }
+ cached_line_details_ = compress_lines (uncompressed_line_details_);
+ }
+}
+
+void
+Page_breaking::clear_line_details_cache ()
+{
+ cached_configuration_index_ = VPOS;
+ cached_line_details_.clear ();
+ uncompressed_line_details_.clear ();
+}
+
+void
+Page_breaking::line_divisions_rec (vsize system_count,
+ Line_division const &min_sys,
+ Line_division const &max_sys,
+ Line_division *cur_division)
{
vsize my_index = cur_division->size ();
vsize others_min = 0;
{
cur_division->push_back (i);
if (my_index == min_sys.size () - 1)
- result->push_back (*cur_division);
+ current_configurations_.push_back (*cur_division);
else
- divide_systems (system_count - i, min_sys, max_sys, result, cur_division);
+ line_divisions_rec (system_count - i, min_sys, max_sys, cur_division);
cur_division->pop_back ();
}
}
+vsize
+Page_breaking::min_page_count (vsize configuration, vsize first_page_num)
+{
+ vsize ret = 1;
+ Real cur_rod_height = 0;
+ Real cur_spring_height = 0;
+ Real cur_page_height = page_height (first_page_num, false);
+
+ cache_line_details (configuration);
+ for (vsize i = 0; i < cached_line_details_.size (); i++)
+ {
+ Real ext_len = cached_line_details_[i].extent_.length ();
+ Real next_rod_height = cur_rod_height + ext_len
+ + ((cur_rod_height > 0) ? cached_line_details_[i].padding_: 0);
+ Real next_spring_height = cur_spring_height + line_space (cached_line_details_[i]);
+ Real next_height = next_rod_height + (ragged () ? next_spring_height : 0);
+
+
+ if ((next_height > cur_page_height && cur_rod_height > 0)
+ || (i > 0
+ && cached_line_details_[i-1].page_permission_ == ly_symbol2scm ("force")))
+ {
+ cur_rod_height = ext_len;
+ cur_spring_height = line_space (cached_line_details_[i]);
+ cur_page_height = page_height (first_page_num + ret, false);
+ ret++;
+ }
+ else
+ {
+ cur_rod_height = next_rod_height;
+ cur_spring_height = next_spring_height;
+ }
+ }
+
+ /* there are two potential problems with the last page (because we didn't know
+ it was the last page until after we managed to fit all the systems to it):
+ - we are ragged-last but the last page has a compressed spring
+ - the value returned by page_height (num, true) is smaller than the
+ value returned by page_height (num, false) and it causes the page not to
+ fit.
+
+ In either case, we just need to add one more page. This is because the last
+ line will always fit on the extra page and by adding one more page to the
+ end, the previous page is no longer the last page, so our previous
+ calculations that treated it as a non-last page were ok.
+ */
+
+ cur_page_height = page_height (first_page_num + ret - 1, true);
+ Real cur_height = cur_rod_height + ((ragged_last () || ragged ()) ? cur_spring_height : 0);
+ if (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++;
+
+ assert (ret <= cached_line_details_.size ());
+ return ret;
+}
+
+Page_spacing_result
+Page_breaking::space_systems_on_n_pages (vsize configuration, vsize n, vsize first_page_num)
+{
+ Page_spacing_result ret;
+ assert (n >= min_page_count (configuration, first_page_num));
+
+ cache_line_details (configuration);
+ if (n > cached_line_details_.size ())
+ return Page_spacing_result ();
+ if (n == 1)
+ ret = space_systems_on_1_page (cached_line_details_,
+ page_height (first_page_num, is_last ()),
+ ragged () || (is_last () && ragged_last ()));
+ else if (n == 2)
+ ret = space_systems_on_2_pages (configuration, first_page_num);
+ else
+ {
+ Page_spacer ps (cached_line_details_, first_page_num, this);
+ ret = ps.solve (n);
+ }
+
+ return finalize_spacing_result (configuration, ret);
+}
+
+Real
+Page_breaking::blank_page_penalty () const
+{
+ SCM penalty_sym = is_last () ? ly_symbol2scm ("blank-last-page-force") : ly_symbol2scm ("blank-page-force");
+ return robust_scm2double (book_->paper_->lookup_variable (penalty_sym), 0.0);
+}
+
+Page_spacing_result
+Page_breaking::space_systems_on_n_or_one_more_pages (vsize configuration, vsize n, vsize first_page_num)
+{
+ Page_spacing_result n_res;
+ Page_spacing_result m_res;
+
+ cache_line_details (configuration);
+ vsize min_p_count = min_page_count (configuration, first_page_num);
+
+ if (n == 1)
+ {
+ bool rag = ragged () || (is_last () && ragged_last ());
+ Real height = page_height (first_page_num, is_last ());
+
+ if (1 >= min_p_count)
+ n_res = space_systems_on_1_page (cached_line_details_, height, rag);
+ if (1 < cached_line_details_.size ())
+ m_res = space_systems_on_2_pages (configuration, first_page_num);
+ }
+ else
+ {
+ Page_spacer ps (cached_line_details_, first_page_num, this);
+
+ if (n >= min_p_count)
+ n_res = ps.solve (n);
+ if (n < cached_line_details_.size ())
+ m_res = ps.solve (n+1);
+ }
+
+ m_res = finalize_spacing_result (configuration, m_res);
+ n_res = finalize_spacing_result (configuration, n_res);
+
+ Real penalty = blank_page_penalty ();
+ n_res.demerits_ += penalty;
+ n_res.force_.back () += penalty;
+
+ return (m_res.demerits_ < n_res.demerits_) ? m_res : n_res;
+}
+
+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);
+ Real odd_pages_penalty = blank_page_penalty ();
+
+ cache_line_details (configuration);
+ Page_spacer ps (cached_line_details_, first_page_num, this);
+ Page_spacing_result best = ps.solve (min_p_count);
+ best.force_.back () += (min_p_count % 2) ? odd_pages_penalty : 0;
+ best.demerits_ += (min_p_count % 2) ? odd_pages_penalty : 0;
+
+ for (vsize i = min_p_count+1; i <= cached_line_details_.size (); i++)
+ {
+ Page_spacing_result cur = ps.solve (i);
+ cur.demerits_ += (i % 2) ? odd_pages_penalty : 0;
+ if (cur.demerits_ < best.demerits_)
+ best = cur;
+ }
+
+ return finalize_spacing_result (configuration, best);
+}
+
+/* Calculate demerits and fix res.systems_per_page_ so that
+ it refers to the original line numbers, not the ones given by compress_lines (). */
+Page_spacing_result
+Page_breaking::finalize_spacing_result (vsize configuration, Page_spacing_result res)
+{
+ cache_line_details (configuration);
+ res.systems_per_page_ = uncompress_solution (res.systems_per_page_, cached_line_details_);
+
+ Real line_force = 0;
+ Real line_penalty = 0;
+ Real page_force = 0;
+ Real page_weighting = robust_scm2double (book_->paper_->c_variable ("page-spacing-weight"), 10);
+
+ for (vsize i = 0; i < uncompressed_line_details_.size (); i++)
+ {
+ line_force += uncompressed_line_details_[i].force_ * uncompressed_line_details_[i].force_;
+ line_penalty += uncompressed_line_details_[i].break_penalty_;
+ }
+
+ for (vsize i = 0; i < res.force_.size (); i++)
+ {
+ Real f = res.force_[i];
+ if (isinf (f) && res.systems_per_page_[i] == 1)
+ f = 20000;
+
+ page_force += f * f;
+ }
+
+ /* for a while we tried averaging page and line forces across pages instead
+ of summing them, but it caused a problem: if there is a single page
+ with a very bad page force (for example because of a forced page break),
+ the page breaker will put in a _lot_ of pages so that the bad force
+ becomes averaged out over many pages. */
+ res.demerits_ = line_force + line_penalty + (page_force + res.penalty_) * page_weighting;
+ return res;
+
+}
+
+/* the cases for page_count = 1 or 2 can be done in O (n) time. Since they
+ are by far the most common cases, we have special functions for them.
+
+ space_systems_on_1_page has a different calling convention than most of the
+ space_systems functions. This is because space_systems_on_1_page is (unlike
+ the other space_systems functions) sometimes called on subsets of a full
+ configuration. */
+Page_spacing_result
+Page_breaking::space_systems_on_1_page (vector<Line_details> const &lines, Real page_height, bool ragged)
+{
+ Page_spacing space (page_height);
+ Page_spacing_result ret;
+
+ for (vsize i = 0; i < lines.size (); i++)
+ space.append_system (lines[i]);
+
+ ret.systems_per_page_.push_back (lines.size ());
+ ret.force_.push_back (ragged ? min (space.force_, 0.0) : space.force_);
+ ret.penalty_ = lines.back ().page_penalty_ + lines.back ().turn_penalty_;
+
+ /* don't do finalize_spacing_result () because we are only an internal function */
+ return ret;
+}
+
+Page_spacing_result
+Page_breaking::space_systems_on_2_pages (vsize configuration, vsize first_page_num)
+{
+ Real page1_height = page_height (first_page_num, false);
+ Real page2_height = page_height (first_page_num + 1, is_last ());
+ bool ragged1 = ragged ();
+ bool ragged2 = ragged () || (is_last () && ragged_last ());
+
+ /* if there is a forced break, this reduces to 2 1-page problems */
+ cache_line_details (configuration);
+ for (vsize i = 0; i + 1 < cached_line_details_.size (); i++)
+ if (cached_line_details_[i].page_permission_ == ly_symbol2scm ("force"))
+ {
+ vector<Line_details> lines1 (cached_line_details_.begin (), cached_line_details_.begin () + i + 1);
+ vector<Line_details> lines2 (cached_line_details_.begin () + i + 1, cached_line_details_.end ());
+ Page_spacing_result p1 = space_systems_on_1_page (lines1, page1_height, ragged1);
+ Page_spacing_result p2 = space_systems_on_1_page (lines2, page2_height, ragged2);
+
+ 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_;
+ return p1;
+ }
+
+ vector<Real> page1_force;
+ vector<Real> page2_force;
+ Page_spacing page1 (page1_height);
+ Page_spacing page2 (page2_height);
+
+ page1_force.resize (cached_line_details_.size () - 1, infinity_f);
+ page2_force.resize (cached_line_details_.size () - 1, infinity_f);
+
+ /* find the page 1 and page 2 forces for each page-breaking position */
+ for (vsize i = 0; i < page1_force.size (); i++)
+ {
+ page1.append_system (cached_line_details_[i]);
+ page2.prepend_system (cached_line_details_[cached_line_details_.size () - 1 - i]);
+ page1_force[i] = (ragged1 && page1.force_ < 0 && i > 0) ? infinity_f : page1.force_;
+
+ if (ragged2)
+ page2_force[page2_force.size () - 1 - i] =
+ (page2.force_ < 0 && i + 1 < page1_force.size ()) ? infinity_f : 0;
+ else
+ page2_force[page2_force.size () - 1 - i] = page2.force_;
+ }
+
+ /* find the position that minimises the sum of the page forces */
+ vsize best_sys_count = 1;
+ Real best_demerits = infinity_f;
+ for (vsize i = 0; i < page1_force.size (); i++)
+ {
+ Real f = page1_force[i] * page1_force[i] + page2_force[i] * page2_force[i];
+ Real uneven = 2 * (page1_force[i] - page2_force[i]);
+ Real dem = uneven * uneven + f
+ + cached_line_details_[i+1].page_penalty_
+ + cached_line_details_.back ().page_penalty_ + cached_line_details_.back ().turn_penalty_;
+ if (dem < best_demerits)
+ {
+ best_demerits = dem;
+ best_sys_count = i+1;
+ }
+ }
+
+ Page_spacing_result ret;
+ ret.systems_per_page_.push_back (best_sys_count);
+ ret.systems_per_page_.push_back (cached_line_details_.size () - best_sys_count);
+ ret.force_.push_back (page1_force[best_sys_count-1]);
+ ret.force_.push_back (page2_force[best_sys_count-1]);
+ ret.penalty_ = cached_line_details_[best_sys_count-1].page_penalty_
+ + cached_line_details_.back ().page_penalty_
+ + cached_line_details_.back ().turn_penalty_;
+
+ /* don't do finalize_spacing_result () because we are only an internal function */
+ return ret;
+}
+
+bool
+Page_breaking::all_lines_stretched (vsize configuration)
+{
+ cache_line_details (configuration);
+ for (vsize i = 0; i < cached_line_details_.size (); i++)
+ if (cached_line_details_[i].force_ < 0)
+ return false;
+
+ return true;
+}
+
+Page_breaking::Line_division
+Page_breaking::current_configuration (vsize configuration_index) const
+{
+ return current_configurations_[configuration_index];
+}
+
+bool
+Page_breaking::is_last () const
+{
+ return current_end_breakpoint_ == last_break_position ();
+}
+
+vsize
+Page_breaking::last_break_position () const
+{
+ return breaks_.size () - 1;
+}
projects / lilypond.git / blobdiff