X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=lily%2Fsystem.cc;h=3ca397976b06c890094fdc2673deefc9fbc50833;hb=47db9a3883d726ca53e2133a3b2298f78dd6a32e;hp=e5bc99840eae11e11c9041715d3544abb875c7ec;hpb=2c22efe5a46a37065b10c3f51c5d7db00d07d318;p=lilypond.git diff --git a/lily/system.cc b/lily/system.cc index e5bc99840e..6d6b5ac8f3 100644 --- a/lily/system.cc +++ b/lily/system.cc @@ -1,42 +1,57 @@ /* - system.cc -- implement System + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1996--2015 Han-Wen Nienhuys - (c) 1996--2005 Han-Wen Nienhuys + 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 "system.hh" -#include - #include "align-interface.hh" +#include "all-font-metrics.hh" #include "axis-group-interface.hh" -#include "warn.hh" +#include "break-align-interface.hh" +#include "grob-array.hh" +#include "hara-kiri-group-spanner.hh" +#include "international.hh" +#include "lookup.hh" #include "main.hh" -#include "paper-column.hh" #include "output-def.hh" +#include "page-layout-problem.hh" +#include "paper-column.hh" #include "paper-score.hh" -#include "warn.hh" -#include "all-font-metrics.hh" -#include "spacing-interface.hh" -#include "staff-symbol-referencer.hh" -#include "paper-book.hh" #include "paper-system.hh" -#include "tweak-registration.hh" -#include "grob-array.hh" #include "pointer-group-interface.hh" +#include "skyline-pair.hh" +#include "staff-symbol-referencer.hh" +#include "system-start-delimiter.hh" +#include "text-interface.hh" +#include "warn.hh" +#include "unpure-pure-container.hh" -System::System (System const &src, int count) - : Spanner (src, count) +System::System (System const &src) + : Spanner (src) { all_elements_ = 0; + pscore_ = 0; rank_ = 0; init_elements (); } -System::System (SCM s, Object_key const *key) - : Spanner (s, key) +System::System (SCM s) + : Spanner (s) { all_elements_ = 0; rank_ = 0; @@ -47,14 +62,15 @@ void System::init_elements () { SCM scm_arr = Grob_array::make_array (); - all_elements_ = unsmob_grob_array (scm_arr); + all_elements_ = Grob_array::unsmob (scm_arr); + all_elements_->set_ordered (false); set_object ("all-elements", scm_arr); } Grob * -System::clone (int count) const +System::clone () const { - return new System (*this, count); + return new System (*this); } int @@ -67,7 +83,7 @@ int System::spanner_count () const { int k = 0; - for (int i = all_elements_->size (); i--;) + for (vsize i = all_elements_->size (); i--;) if (dynamic_cast (all_elements_->grob (i))) k++; return k; @@ -76,11 +92,11 @@ System::spanner_count () const void System::typeset_grob (Grob *elem) { - if (elem->pscore_) + if (elem->layout_) programming_error ("adding element twice"); else { - elem->pscore_ = pscore_; + elem->layout_ = pscore_->layout (); all_elements_->add (elem); elem->unprotect (); } @@ -89,15 +105,15 @@ System::typeset_grob (Grob *elem) void System::derived_mark () const { - if (!all_elements_->is_empty ()) + if (!all_elements_->empty ()) { - Grob **ptr = &all_elements_->array_reference ().elem_ref (0); + Grob **ptr = &all_elements_->array_reference ()[0]; Grob **end = ptr + all_elements_->size (); while (ptr < end) - { - scm_gc_mark ((*ptr)->self_scm ()); - ptr++; - } + { + scm_gc_mark ((*ptr)->self_scm ()); + ptr++; + } } if (pscore_) @@ -107,51 +123,49 @@ System::derived_mark () const } static void -fixup_refpoints (Link_array const &grobs) +fixup_refpoints (vector const &grobs) { - for (int i = grobs.size (); i--;) - { - grobs[i]->fixup_refpoint (); - } + for (vsize i = grobs.size (); i--;) + grobs[i]->fixup_refpoint (); } -SCM -System::get_paper_systems () +void +System::do_break_substitution_and_fixup_refpoints () { - for (int i = 0; i < all_elements_->size (); i++) + for (vsize i = 0; i < all_elements_->size (); i++) { Grob *g = all_elements_->grob (i); if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface"))) - { - /* - Kill no longer needed grobs. - */ - Item *it = dynamic_cast (g); - if (it && Item::is_breakable (it)) - { - it->find_prebroken_piece (LEFT)->suicide (); - it->find_prebroken_piece (RIGHT)->suicide (); - } - g->suicide (); - } + { + /* + Kill no longer needed grobs. + */ + Item *it = dynamic_cast (g); + if (it && Item::is_non_musical (it)) + { + it->find_prebroken_piece (LEFT)->suicide (); + it->find_prebroken_piece (RIGHT)->suicide (); + } + g->suicide (); + } else if (g->is_live ()) - g->do_break_processing (); + g->do_break_processing (); } /* fixups must be done in broken line_of_scores, because new elements are put over there. */ int count = 0; - for (int i = 0; i < broken_intos_.size (); i++) + for (vsize i = 0; i < broken_intos_.size (); i++) { Grob *se = broken_intos_[i]; extract_grob_set (se, "all-elements", all_elts); - for (int j = 0; j < all_elts.size (); j++) - { - Grob *g = all_elts[j]; - g->fixup_refpoint (); - } + for (vsize j = 0; j < all_elts.size (); j++) + { + Grob *g = all_elts[j]; + g->fixup_refpoint (); + } count += all_elts.size (); } @@ -161,160 +175,371 @@ System::get_paper_systems () */ fixup_refpoints (all_elements_->array ()); - for (int i = 0; i < all_elements_->size (); i++) + for (vsize i = 0; i < all_elements_->size (); i++) all_elements_->grob (i)->handle_broken_dependencies (); handle_broken_dependencies (); -#if 0 /* FIXME: strange side effects. */ - /* Because the this->get_property (all-elements) contains items in 3 versions, handle_broken_dependencies () will leave duplicated items in all-elements. Strictly speaking this is harmless, but - it leads to duplicated symbols in the output. ly_list_qsort_uniq_x () - makes sure that no duplicates are in the list. */ - for (int i = 0; i < line_count; i++) + it leads to duplicated symbols in the output. uniq makes sure + that no duplicates are in the list. */ + for (vsize i = 0; i < broken_intos_.size (); i++) { - SCM all = broken_intos_[i]->get_object ("all-elements"); - all = ly_list_qsort_uniq_x (all); + System *child = dynamic_cast (broken_intos_[i]); + child->all_elements_->remove_duplicates (); + + for (vsize j = 0; j < child->all_elements_->size (); j++) + { + Grob *g = child->all_elements_->grob (j); + + (void) g->get_property ("after-line-breaking"); + } } -#endif - if (be_verbose_global) - message (_f ("Element count %d.", count + element_count ())); + debug_output (_f ("Element count %d", count + element_count ()) + "\n"); +} - int line_count = broken_intos_.size (); - SCM lines = scm_c_make_vector (line_count, SCM_EOL); +SCM +System::get_broken_system_grobs () +{ + SCM ret = SCM_EOL; + for (vsize i = 0; i < broken_intos_.size (); i++) + ret = scm_cons (broken_intos_[i]->self_scm (), ret); + return scm_reverse_x (ret, SCM_EOL); +} - for (int i = 0; i < line_count; i++) +SCM +System::get_paper_systems () +{ + SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL); + for (vsize i = 0; i < broken_intos_.size (); i++) { - if (be_verbose_global) - progress_indication ("["); + debug_output ("[", false); System *system = dynamic_cast (broken_intos_[i]); - system->post_processing (); - scm_vector_set_x (lines, scm_from_int (i), system->get_paper_system ()); - if (be_verbose_global) - progress_indication (to_string (i) + "]"); + scm_vector_set_x (lines, scm_from_int (i), + system->get_paper_system ()); + + debug_output (::to_string (i) + "]", false); } return lines; } +vector +System::get_footnote_grobs_in_range (vsize start, vsize end) +{ + vector out; + extract_grob_set (this, "footnotes-before-line-breaking", footnote_grobs); + for (vsize i = 0; i < footnote_grobs.size (); i++) + { + Grob *at_bat = footnote_grobs[i]; + int pos = at_bat->spanned_rank_interval ()[LEFT]; + bool end_of_line_visible = true; + if (Spanner *s = dynamic_cast(at_bat)) + { + Direction spanner_placement = robust_scm2dir (s->get_property ("spanner-placement"), LEFT); + if (spanner_placement == CENTER) + spanner_placement = LEFT; + + pos = s->spanned_rank_interval ()[spanner_placement]; + if (s->original ()) + { + Spanner *orig = dynamic_cast(s->original ()); + at_bat = spanner_placement == LEFT ? orig->broken_intos_[0] : orig->broken_intos_.back (); + pos = at_bat->spanned_rank_interval ()[RIGHT]; + } + } + + if (Item *item = dynamic_cast(at_bat)) + { + /* + We use this to weed out grobs that fall at the end + of the line when we want grobs at the beginning. + */ + end_of_line_visible = item->break_status_dir () == LEFT; + + if (!Item::break_visible (item)) + continue; + // safeguard to bring down the column rank so that end of line footnotes show up on the correct line + if (pos == int (start) && item->break_status_dir () != RIGHT) + continue; + if (pos == int (end) && item->break_status_dir () != LEFT) + continue; + if (pos != int (end) && pos != int (start) && item->break_status_dir () != CENTER) + continue; + } + + if (pos < int (start)) + continue; + if (pos > int (end)) + continue; + if (pos == int (start) && end_of_line_visible) + continue; + if (pos == int (end) && !end_of_line_visible) + continue; + if (!at_bat->is_live ()) + continue; + /* + TODO + Sometimes, there are duplicate entries in the all_elements_ + list. In a separate patch, this practice should be squashed + so that the check below can be eliminated. + */ + if (find (out.begin (), out.end (), at_bat) != out.end ()) + continue; + + out.push_back (at_bat); + } + return out; +} + +vector +System::get_footnote_heights_in_range (vsize start, vsize end) +{ + return internal_get_note_heights_in_range (start, end, true); +} + +vector +System::get_in_note_heights_in_range (vsize start, vsize end) +{ + return internal_get_note_heights_in_range (start, end, false); +} + +vector +System::internal_get_note_heights_in_range (vsize start, vsize end, bool foot) +{ + vector footnote_grobs = get_footnote_grobs_in_range (start, end); + vector out; + + for (vsize i = footnote_grobs.size (); i--;) + if (foot + ? !to_boolean (footnote_grobs[i]->get_property ("footnote")) + : to_boolean (footnote_grobs[i]->get_property ("footnote"))) + footnote_grobs.erase (footnote_grobs.begin () + i); + + for (vsize i = 0; i < footnote_grobs.size (); i++) + { + SCM footnote_markup = footnote_grobs[i]->get_property ("footnote-text"); + + if (!Text_interface::is_markup (footnote_markup)) + continue; + + SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"), + pscore_->layout ()->self_scm ()); + + SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (), + props, footnote_markup); + + Stencil *footnote_stencil = Stencil::unsmob (footnote_stl); + out.push_back (footnote_stencil->extent (Y_AXIS).length ()); + } + + return out; +} + +vsize +System::num_footnotes () +{ + extract_grob_set (this, "footnotes-after-line-breaking", footnote_grobs); + return footnote_grobs.size (); +} + +bool +grob_2D_less (Grob *g1, Grob *g2) +{ + int sri[] = {0, 0}; + Grob *gs[] = {g1, g2}; + + for (int i = 0; i < 2; i++) + { + sri[i] = gs[i]->spanned_rank_interval ()[LEFT]; + if (Spanner *s = dynamic_cast (gs[i])) + { + if (s->broken_intos_.size ()) + s = (scm_to_int (s->broken_intos_[0]->get_property ("spanner-placement")) == LEFT + ? s->broken_intos_[0] + : s->broken_intos_.back ()); + gs[i] = s; + if (robust_scm2double (s->get_property ("X-offset"), 0.0) > 0) + sri[i] = s->spanned_rank_interval ()[RIGHT]; + } + } + + if (sri[0] == sri[1]) + return Grob::vertical_less (gs[0], gs[1]); + + return sri[0] < sri[1]; +} + +MAKE_SCHEME_CALLBACK (System, footnotes_before_line_breaking, 1); +SCM +System::footnotes_before_line_breaking (SCM smob) +{ + Grob *me = Grob::unsmob (smob); + vector footnotes; + SCM grobs_scm = Grob_array::make_array (); + extract_grob_set (me, "all-elements", elts); + for (vsize i = 0; i < elts.size (); i++) + if (elts[i]->internal_has_interface (ly_symbol2scm ("footnote-interface"))) + footnotes.push_back (elts[i]); + + Grob_array::unsmob (grobs_scm)->set_array (footnotes); + return grobs_scm; +} + +MAKE_SCHEME_CALLBACK (System, footnotes_after_line_breaking, 1); +SCM +System::footnotes_after_line_breaking (SCM smob) +{ + Spanner *sys_span = Spanner::unsmob (smob); + System *sys = dynamic_cast (sys_span); + Interval_t sri = sys->spanned_rank_interval (); + vector footnote_grobs = sys->get_footnote_grobs_in_range (sri[LEFT], sri[RIGHT]); + vector_sort (footnote_grobs, grob_2D_less); + + SCM grobs_scm = Grob_array::make_array (); + Grob_array::unsmob (grobs_scm)->set_array (footnote_grobs); + return grobs_scm; +} + +MAKE_SCHEME_CALLBACK (System, vertical_skyline_elements, 1); +SCM +System::vertical_skyline_elements (SCM smob) +{ + Grob *me_grob = Grob::unsmob (smob); + vector vertical_skyline_grobs; + extract_grob_set (me_grob, "elements", my_elts); + for (vsize i = 0; i < my_elts.size (); i++) + if (System_start_delimiter::has_interface (my_elts[i])) + vertical_skyline_grobs.push_back (my_elts[i]); + + System *me = dynamic_cast (me_grob); + Grob *align = Grob::unsmob (me->get_object ("vertical-alignment")); + if (!align) + { + SCM grobs_scm = Grob_array::make_array (); + Grob_array::unsmob (grobs_scm)->set_array (vertical_skyline_grobs); + return grobs_scm; + } + + extract_grob_set (align, "elements", elts); + + for (vsize i = 0; i < elts.size (); i++) + if (Hara_kiri_group_spanner::has_interface (elts[i])) + vertical_skyline_grobs.push_back (elts[i]); + + SCM grobs_scm = Grob_array::make_array (); + Grob_array::unsmob (grobs_scm)->set_array (vertical_skyline_grobs); + return grobs_scm; +} + void -System::break_into_pieces (Array const &breaking) +System::break_into_pieces (vector const &breaking) { - for (int i = 0; i < breaking.size (); i++) + for (vsize i = 0; i < breaking.size (); i++) { - System *system = dynamic_cast (clone (i)); - system->rank_ = i; + System *system = dynamic_cast (clone ()); + system->rank_ = broken_intos_.size (); - Link_array c (breaking[i].cols_); + vector c (breaking[i].cols_); pscore_->typeset_system (system); + int st = Paper_column::get_rank (c[0]); + int end = Paper_column::get_rank (c.back ()); + Interval iv (pure_height (this, st, end)); + system->set_property ("pure-Y-extent", ly_interval2scm (iv)); + system->set_bound (LEFT, c[0]); - system->set_bound (RIGHT, c.top ()); - for (int j = 0; j < c.size (); j++) - { - c[j]->translate_axis (breaking[i].config_[j], X_AXIS); - dynamic_cast (c[j])->system_ = system; - } + system->set_bound (RIGHT, c.back ()); + SCM system_labels = SCM_EOL; + for (vsize j = 0; j < c.size (); j++) + { + c[j]->translate_axis (breaking[i].config_[j], X_AXIS); + dynamic_cast (c[j])->set_system (system); + /* collect the column labels */ + collect_labels (c[j], &system_labels); + } + /* + Collect labels from any loose columns too: theses will be set on + an empty bar line or a column which is otherwise unused mid-line + */ + vector loose (breaking[i].loose_cols_); + for (vsize j = 0; j < loose.size (); j++) + collect_labels (loose[j], &system_labels); + + system->set_property ("labels", system_labels); + set_loose_columns (system, &breaking[i]); - broken_intos_.push (system); + broken_intos_.push_back (system); } } +void +System::collect_labels (Grob const *col, SCM *labels) +{ + SCM col_labels = col->get_property ("labels"); + if (scm_is_pair (col_labels)) + *labels = scm_append (scm_list_2 (col_labels, *labels)); +} + void System::add_column (Paper_column *p) { Grob *me = this; - Grob_array *ga = unsmob_grob_array (me->get_object ("columns")); + Grob_array *ga = Grob_array::unsmob (me->get_object ("columns")); if (!ga) { SCM scm_ga = Grob_array::make_array (); me->set_object ("columns", scm_ga); - ga = unsmob_grob_array (scm_ga); + ga = Grob_array::unsmob (scm_ga); } - p->rank_ - = ga->size () - ? Paper_column::get_rank (ga->array ().top ()) + 1 - : 0; + p->set_rank (ga->size ()); ga->add (p); Axis_group_interface::add_element (this, p); } -void -apply_tweaks (Grob *g, bool broken) -{ - if (bool (g->original_) == broken) - { - SCM tweaks = global_registry_->get_tweaks (g); - for (SCM s = tweaks; scm_is_pair (s); s = scm_cdr (s)) - { - SCM proc = scm_caar (s); - SCM rest = scm_cdar (s); - scm_apply_1 (proc, g->self_scm (), rest); - } - } -} - void System::pre_processing () { - for (int i = 0; i < all_elements_->size (); i++) + for (vsize i = 0; i < all_elements_->size (); i++) all_elements_->grob (i)->discretionary_processing (); - if (be_verbose_global) - message (_f ("Grob count %d", element_count ())); + debug_output (_f ("Grob count %d", element_count ())); /* order is significant: broken grobs are added to the end of the array, and should be processed before the original is potentially killed. */ - for (int i = all_elements_->size (); i--;) + for (vsize i = all_elements_->size (); i--;) all_elements_->grob (i)->handle_prebroken_dependencies (); fixup_refpoints (all_elements_->array ()); - for (int i = 0; i < all_elements_->size (); i++) - apply_tweaks (all_elements_->grob (i), false); - - for (int i = 0; i < all_elements_->size (); i++) - all_elements_->grob (i)->calculate_dependencies (PRECALCED, PRECALCING, - ly_symbol2scm ("before-line-breaking-callback")); - - message (_ ("Calculating line breaks...")); - progress_indication (" "); + for (vsize i = 0; i < all_elements_->size (); i++) + { + Grob *g = all_elements_->grob (i); + (void) g->get_property ("before-line-breaking"); + } - for (int i = 0; i < all_elements_->size (); i++) + for (vsize i = 0; i < all_elements_->size (); i++) { Grob *e = all_elements_->grob (i); - SCM proc = e->get_property ("spacing-procedure"); - if (ly_is_procedure (proc)) - scm_call_1 (proc, e->self_scm ()); + (void) e->get_property ("springs-and-rods"); } } void System::post_processing () { - for (int i = 0; i < all_elements_->size (); i++) - { - Grob *g = all_elements_->grob (i); - - apply_tweaks (g, true); - g->calculate_dependencies (POSTCALCED, POSTCALCING, - ly_symbol2scm ("after-line-breaking-callback")); - } - Interval iv (extent (this, Y_AXIS)); if (iv.is_empty ()) - { - programming_error ("system with empty extent"); - } + programming_error ("system with empty extent"); else translate_axis (-iv[MAX], Y_AXIS); @@ -322,53 +547,72 @@ System::post_processing () This might seem inefficient, but Stencils are cached per grob anyway. */ - Link_array all_elts_sorted (all_elements_->array ()); - all_elts_sorted.default_sort (); - all_elts_sorted.uniq (); + vector all_elts_sorted (all_elements_->array ()); + uniquify (all_elts_sorted); this->get_stencil (); - for (int i = all_elts_sorted.size (); i--;) + for (vsize i = all_elts_sorted.size (); i--;) { Grob *g = all_elts_sorted[i]; g->get_stencil (); } } +struct Layer_entry +{ + Grob *grob_; + int layer_; +}; + +bool +operator < (Layer_entry const &a, + Layer_entry const &b) +{ + return a.layer_ < b.layer_; +} + SCM System::get_paper_system () { - static int const LAYER_COUNT = 3; - SCM exprs = SCM_EOL; SCM *tail = &exprs; - /* Output stencils in three layers: 0, 1, 2. Default layer: 1. */ - for (int i = 0; i < LAYER_COUNT; i++) - for (int j = all_elements_->size (); j--;) - { - Grob *g = all_elements_->grob (j); - Stencil *stil = g->get_stencil (); + post_processing (); + + vector entries; + for (vsize j = 0; j < all_elements_->size (); j++) + { + Layer_entry e; + e.grob_ = all_elements_->grob (j); + e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1); - /* Skip empty stencils and grobs that are not in this layer. */ - if (!stil - || robust_scm2int (g->get_property ("layer"), 1) != i) - continue; + entries.push_back (e); + } + + vector_sort (entries, std::less ()); + for (vsize j = 0; j < entries.size (); j++) + { + Grob *g = entries[j].grob_; + Stencil st = g->get_print_stencil (); - Offset o (g->relative_coordinate (this, X_AXIS), - g->relative_coordinate (this, Y_AXIS)); + if (st.expr () == SCM_EOL) + continue; - Offset extra = robust_scm2offset (g->get_property ("extra-offset"), - Offset (0, 0)) - * Staff_symbol_referencer::staff_space (g); + Offset o; + for (int a = X_AXIS; a < NO_AXES; a++) + o[Axis (a)] = g->relative_coordinate (this, Axis (a)); - /* Must copy the stencil, for we cannot change the stencil - cached in G. */ + Offset extra = robust_scm2offset (g->get_property ("extra-offset"), + Offset (0, 0)) + * Staff_symbol_referencer::staff_space (g); - Stencil st = *stil; - st.translate (o + extra); + /* Must copy the stencil, for we cannot change the stencil + cached in G. */ - *tail = scm_cons (st.expr (), SCM_EOL); - tail = SCM_CDRLOC (*tail); - } + st.translate (o + extra); + + *tail = scm_cons (st.expr (), SCM_EOL); + tail = SCM_CDRLOC (*tail); + } if (Stencil *me = get_stencil ()) exprs = scm_cons (me->expr (), exprs); @@ -376,50 +620,76 @@ System::get_paper_system () Interval x (extent (this, X_AXIS)); Interval y (extent (this, Y_AXIS)); Stencil sys_stencil (Box (x, y), - scm_cons (ly_symbol2scm ("combine-stencil"), - exprs)); + scm_cons (ly_symbol2scm ("combine-stencil"), + exprs)); + if (debug_skylines) + { + Skyline_pair *skylines = Skyline_pair::unsmob (get_property ("vertical-skylines")); + if (skylines) + { + Stencil up + = Lookup::points_to_line_stencil (0.1, (*skylines)[UP].to_points (X_AXIS)); + Stencil down + = Lookup::points_to_line_stencil (0.1, (*skylines)[DOWN].to_points (X_AXIS)); + sys_stencil.add_stencil (up.in_color (255, 0, 0)); + sys_stencil.add_stencil (down.in_color (0, 255, 0)); + } + } + + Grob *left_bound = this->get_bound (LEFT); + SCM prop_init = left_bound->get_property ("line-break-system-details"); + Prob *pl = make_paper_system (prop_init); + paper_system_set_stencil (pl, sys_stencil); + + /* information that the page breaker might need */ + Grob *right_bound = this->get_bound (RIGHT); + pl->set_property ("vertical-skylines", this->get_property ("vertical-skylines")); + pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission")); + pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission")); + pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty")); + pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty")); + + if (right_bound->original () == dynamic_cast (original ())->get_bound (RIGHT)) + pl->set_property ("last-in-score", SCM_BOOL_T); Interval staff_refpoints; - staff_refpoints.set_empty (); - extract_grob_set (this, "spaceable-staves", staves); - for (int i = staves.size (); i--;) + if (Grob *align = Grob::unsmob (get_object ("vertical-alignment"))) { - Grob *g = staves[i]; - staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS)); + extract_grob_set (align, "elements", staves); + for (vsize i = 0; i < staves.size (); i++) + if (staves[i]->is_live () + && Page_layout_problem::is_spaceable (staves[i])) + staff_refpoints.add_point (staves[i]->relative_coordinate (this, + Y_AXIS)); } - Paper_system *pl = new Paper_system (sys_stencil, false); - pl->staff_refpoints_ = staff_refpoints; - Item *break_point = this->get_bound (LEFT); - pl->break_before_penalty_ - = robust_scm2double (break_point->get_property ("page-penalty"), 0.0); + pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints)); + pl->set_property ("system-grob", this->self_scm ()); return pl->unprotect (); } -Link_array +vector System::broken_col_range (Item const *left, Item const *right) const { - Link_array ret; + vector ret; left = left->get_column (); right = right->get_column (); extract_grob_set (this, "columns", cols); - int i = 0; - while (i < cols.size () - && cols[i] != left) - i++; + vsize i = Paper_column::get_rank (left); + int end_rank = Paper_column::get_rank (right); if (i < cols.size ()) i++; while (i < cols.size () - && cols[i] != right) + && Paper_column::get_rank (cols[i]) < end_rank) { Paper_column *c = dynamic_cast (cols[i]); - if (Item::is_breakable (c) && !c->system_) - ret.push (c); + if (Paper_column::is_breakable (c) && !c->get_system ()) + ret.push_back (c); i++; } @@ -428,8 +698,8 @@ System::broken_col_range (Item const *left, Item const *right) const /** Return all columns, but filter out any unused columns , since they might disrupt the spacing problem. */ -Link_array -System::columns () const +vector +System::used_columns () const { extract_grob_set (this, "columns", ro_columns); @@ -437,27 +707,354 @@ System::columns () const while (last_breakable--) { - if (Item::is_breakable (ro_columns [last_breakable])) - break; + if (Paper_column::is_breakable (ro_columns [last_breakable])) + break; } - Link_array columns; + vector columns; for (int i = 0; i <= last_breakable; i++) { if (Paper_column::is_used (ro_columns[i])) - columns.push (ro_columns[i]); + columns.push_back (ro_columns[i]); } return columns; } +Paper_column * +System::column (vsize which) const +{ + extract_grob_set (this, "columns", columns); + if (which >= columns.size ()) + return 0; + + return dynamic_cast (columns[which]); +} + +Paper_score * +System::paper_score () const +{ + return pscore_; +} + int System::get_rank () const { return rank_; } -ADD_INTERFACE (System, "system-interface", - "This is the toplevel object: each object in a score " - "ultimately has a System object as its X and Y parent. ", - "all-elements spaceable-staves columns") +System * +get_root_system (Grob *me) +{ + Grob *system_grob = me; + + while (system_grob->get_parent (Y_AXIS)) + system_grob = system_grob->get_parent (Y_AXIS); + + return dynamic_cast (system_grob); +} + +MAKE_SCHEME_CALLBACK (System, get_vertical_alignment, 1); +SCM +System::get_vertical_alignment (SCM smob) +{ + Grob *me = Grob::unsmob (smob); + extract_grob_set (me, "elements", elts); + Grob *ret = 0; + for (vsize i = 0; i < elts.size (); i++) + if (Align_interface::has_interface (elts[i])) + { + if (ret) + me->programming_error ("found multiple vertical alignments in this system"); + ret = elts[i]; + } + + if (!ret) + { + me->programming_error ("didn't find a vertical alignment in this system"); + return SCM_EOL; + } + return ret->self_scm (); +} + +// Finds the furthest staff in the given direction whose x-extent +// overlaps with the given interval. +Grob * +System::get_extremal_staff (Direction dir, Interval const &iv) +{ + Grob *align = Grob::unsmob (get_object ("vertical-alignment")); + if (!align) + return 0; + + extract_grob_set (align, "elements", elts); + vsize start = (dir == UP) ? 0 : elts.size () - 1; + vsize end = (dir == UP) ? elts.size () : VPOS; + for (vsize i = start; i != end; i += dir) + { + if (Hara_kiri_group_spanner::has_interface (elts[i])) + Hara_kiri_group_spanner::consider_suicide (elts[i]); + + Interval intersection = elts[i]->extent (this, X_AXIS); + intersection.intersect (iv); + if (elts[i]->is_live () && !intersection.is_empty ()) + return elts[i]; + } + return 0; +} + +// Finds the neighboring staff in the given direction over bounds +Grob * +System::get_neighboring_staff (Direction dir, Grob *vertical_axis_group, Interval_t bounds) +{ + Grob *align = Grob::unsmob (get_object ("vertical-alignment")); + if (!align) + return 0; + + extract_grob_set (align, "elements", elts); + vsize start = (dir == UP) ? 0 : elts.size () - 1; + vsize end = (dir == UP) ? elts.size () : VPOS; + + Grob *out = 0; + + for (vsize i = start; i != end; i += dir) + { + if (elts[i] == vertical_axis_group) + return out; + + if (Hara_kiri_group_spanner::has_interface (elts[i])) + Hara_kiri_group_spanner::consider_suicide (elts[i]); + + bounds.intersect (elts[i]->spanned_rank_interval ()); + if (elts[i]->is_live () && !bounds.is_empty ()) + out = elts[i]; + } + + return 0; +} + +Interval +System::pure_refpoint_extent (vsize start, vsize end) +{ + Interval ret; + Grob *alignment = Grob::unsmob (get_object ("vertical-alignment")); + if (!alignment) + return Interval (); + + extract_grob_set (alignment, "elements", staves); + vector offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end); + + for (vsize i = 0; i < offsets.size (); ++i) + if (Page_layout_problem::is_spaceable (staves[i])) + { + ret[UP] = offsets[i]; + break; + } + + for (vsize i = offsets.size (); i--;) + if (Page_layout_problem::is_spaceable (staves[i])) + { + ret[DOWN] = offsets[i]; + break; + } + + return ret; +} + +Interval +System::part_of_line_pure_height (vsize start, vsize end, bool begin) +{ + Grob *alignment = Grob::unsmob (get_object ("vertical-alignment")); + if (!alignment) + return Interval (); + + extract_grob_set (alignment, "elements", staves); + vector offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end); + + Interval ret; + for (vsize i = 0; i < staves.size (); ++i) + { + Interval iv = begin + ? Axis_group_interface::begin_of_line_pure_height (staves[i], start) + : Axis_group_interface::rest_of_line_pure_height (staves[i], start, end); + if (i < offsets.size ()) + iv.translate (offsets[i]); + ret.unite (iv); + } + + Interval other_elements = begin + ? Axis_group_interface::begin_of_line_pure_height (this, start) + : Axis_group_interface::rest_of_line_pure_height (this, start, end); + + ret.unite (other_elements); + + return ret; +} + +Interval +System::begin_of_line_pure_height (vsize start, vsize end) +{ + return part_of_line_pure_height (start, end, true); +} + +Interval +System::rest_of_line_pure_height (vsize start, vsize end) +{ + return part_of_line_pure_height (start, end, false); +} + +// This differs from Axis_group_interface::calc_pure_relevant_grobs +// because here, we are only interested in those few elements that aren't +// descended from VerticalAlignment (ie. things like RehearsalMark, BarLine). +MAKE_SCHEME_CALLBACK (System, calc_pure_relevant_grobs, 1); +SCM +System::calc_pure_relevant_grobs (SCM smob) +{ + Grob *me = Grob::unsmob (smob); + + extract_grob_set (me, "elements", elts); + vector relevant_grobs; + + for (vsize i = 0; i < elts.size (); ++i) + { + if (!Axis_group_interface::has_interface (elts[i])) + { + relevant_grobs.push_back (elts[i]); + + if (Item *it = dynamic_cast (elts[i])) + { + for (LEFT_and_RIGHT (d)) + { + Item *piece = it->find_prebroken_piece (d); + if (piece && piece->is_live ()) + relevant_grobs.push_back (piece); + } + } + } + } + + SCM grobs_scm = Grob_array::make_array (); + + Grob_array::unsmob (grobs_scm)->set_array (relevant_grobs); + return grobs_scm; +} + +MAKE_SCHEME_CALLBACK (System, height, 1); +SCM +System::height (SCM smob) +{ + return Axis_group_interface::height (smob); +} + +MAKE_SCHEME_CALLBACK (System, calc_pure_height, 3); +SCM +System::calc_pure_height (SCM smob, SCM start_scm, SCM end_scm) +{ + System *me = dynamic_cast (Grob::unsmob (smob)); + int start = scm_to_int (start_scm); + int end = scm_to_int (end_scm); + + Interval begin = me->begin_of_line_pure_height (start, end); + Interval rest = me->rest_of_line_pure_height (start, end); + begin.unite (rest); + + return ly_interval2scm (begin); +} + +Grob * +System::get_pure_bound (Direction d, int start, int end) +{ + vector ranks = pscore_->get_break_ranks (); + vector indices = pscore_->get_break_indices (); + vector cols = pscore_->get_columns (); + + vsize target_rank = (d == LEFT ? start : end); + vector::const_iterator i + = lower_bound (ranks.begin (), ranks.end (), target_rank, std::less ()); + + if (i != ranks.end () && (*i) == target_rank) + return cols[indices[i - ranks.begin ()]]; + else + return 0; +} + +Grob * +System::get_maybe_pure_bound (Direction d, bool pure, int start, int end) +{ + return pure ? get_pure_bound (d, start, end) : get_bound (d); +} + +enum +{ + SPACEABLE_STAVES, + NONSPACEABLE_STAVES, + ALL_STAVES +}; + +static SCM +get_maybe_spaceable_staves (SCM smob, int filter) +{ + System *me = dynamic_cast (Grob::unsmob (smob)); + Grob *align = Grob::unsmob (me->get_object ("vertical_alignment")); + SCM ret = SCM_EOL; + + if (align) + { + SCM *tail = &ret; + extract_grob_set (align, "elements", staves); + + for (vsize i = 0; i < staves.size (); ++i) + { + bool spaceable = Page_layout_problem::is_spaceable (staves[i]); + if (staves[i]->is_live () + && ((filter == ALL_STAVES) + || (filter == SPACEABLE_STAVES && spaceable) + || (filter == NONSPACEABLE_STAVES && !spaceable))) + { + *tail = scm_cons (staves[i]->self_scm (), SCM_EOL); + tail = SCM_CDRLOC (*tail); + } + } + } + + return ret; +} + +MAKE_SCHEME_CALLBACK (System, get_staves, 1) +SCM +System::get_staves (SCM smob) +{ + return get_maybe_spaceable_staves (smob, ALL_STAVES); +} + +MAKE_SCHEME_CALLBACK (System, get_spaceable_staves, 1) +SCM +System::get_spaceable_staves (SCM smob) +{ + return get_maybe_spaceable_staves (smob, SPACEABLE_STAVES); +} + +MAKE_SCHEME_CALLBACK (System, get_nonspaceable_staves, 1) +SCM +System::get_nonspaceable_staves (SCM smob) +{ + return get_maybe_spaceable_staves (smob, NONSPACEABLE_STAVES); +} + +ADD_INTERFACE (System, + "This is the top-level object: Each object in a score" + " ultimately has a @code{System} object as its X and" + " Y@tie{}parent.", + + /* properties */ + "all-elements " + "columns " + "footnote-stencil " + "footnotes-before-line-breaking " + "footnotes-after-line-breaking " + "in-note-direction " + "in-note-padding " + "in-note-stencil " + "labels " + "pure-Y-extent " + "vertical-alignment " + );