X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fsystem.cc;h=1cd582de7525bc2d628b24cb062ddfc188ac7904;hb=refs%2Fheads%2Fbugs%2F567849;hp=3ca397976b06c890094fdc2673deefc9fbc50833;hpb=0cc1af9f69a346f5df1314d658571cd804b1c1ee;p=lilypond.git diff --git a/lily/system.cc b/lily/system.cc index 3ca397976b..1cd582de75 100644 --- a/lily/system.cc +++ b/lily/system.cc @@ -1,9 +1,20 @@ /* - 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--2011 Han-Wen Nienhuys - (c) 1996--2006 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" @@ -11,35 +22,39 @@ #include "align-interface.hh" #include "all-font-metrics.hh" #include "axis-group-interface.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 "output-def.hh" +#include "page-layout-problem.hh" #include "paper-column.hh" #include "paper-score.hh" #include "paper-system.hh" #include "pointer-group-interface.hh" -#include "spacing-interface.hh" +#include "skyline-pair.hh" #include "staff-symbol-referencer.hh" -#include "tweak-registration.hh" +#include "text-interface.hh" #include "warn.hh" -extern bool debug_skylines; - -System::System (System const &src, int count) - : Spanner (src, count) +System::System (System const &src) + : Spanner (src) { all_elements_ = 0; pscore_ = 0; rank_ = 0; + checked_footnotes_ = false; init_elements (); } -System::System (SCM s, Object_key const *key) - : Spanner (s, key) +System::System (SCM s) + : Spanner (s) { all_elements_ = 0; rank_ = 0; + checked_footnotes_ = false; init_elements (); } @@ -53,9 +68,9 @@ System::init_elements () } Grob * -System::clone (int index) const +System::clone () const { - return new System (*this, index); + return new System (*this); } int @@ -108,14 +123,14 @@ System::derived_mark () const } static void -fixup_refpoints (vector const &grobs) +fixup_refpoints (vector const &grobs) { for (vsize i = grobs.size (); i--;) grobs[i]->fixup_refpoint (); } -SCM -System::get_paper_systems () +void +System::do_break_substitution_and_fixup_refpoints () { for (vsize i = 0; i < all_elements_->size (); i++) { @@ -151,7 +166,7 @@ System::get_paper_systems () Grob *g = all_elts[j]; g->fixup_refpoint (); } - + count += all_elts.size (); } @@ -172,13 +187,32 @@ System::get_paper_systems () that no duplicates are in the list. */ for (vsize i = 0; i < broken_intos_.size (); i++) { - System *child = dynamic_cast (broken_intos_[i]); + 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"); + } } if (be_verbose_global) - message (_f ("Element count %d.", count + element_count ())); + message (_f ("Element count %d", count + element_count ()) + "\n"); +} +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 (ret); +} + +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++) { @@ -187,14 +221,6 @@ System::get_paper_systems () System *system = dynamic_cast (broken_intos_[i]); - system->post_processing (); - system->build_skylines (); - if (i > 0) - { - System *prev = dynamic_cast (broken_intos_[i-1]); - Real r = prev->skylines_[DOWN].distance (system->skylines_[UP]); - system->set_property ("skyline-distance", scm_from_double (r)); - } scm_vector_set_x (lines, scm_from_int (i), system->get_paper_system ()); @@ -204,15 +230,123 @@ System::get_paper_systems () return lines; } +void +System::populate_footnote_grob_vector () +{ + extract_grob_set (this, "all-elements", all_elts); + for (vsize i = 0; i < all_elts.size (); i++) + if (all_elts[i]->internal_has_interface (ly_symbol2scm ("footnote-interface"))) + footnote_grobs_.push_back (all_elts[i]); + + sort (footnote_grobs_.begin (), footnote_grobs_.end (), Grob::less); + checked_footnotes_ = true; +} + +void +System::get_footnote_grobs_in_range (vector &out, vsize start, vsize end) +{ + if (!checked_footnotes_) + populate_footnote_grob_vector (); + + for (vsize i = 0; i < footnote_grobs_.size (); i++) + { + int pos = footnote_grobs_[i]->spanned_rank_interval ()[LEFT]; + bool end_of_line_visible = true; + if (Spanner *s = dynamic_cast(footnote_grobs_[i])) + { + 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 (Item *item = dynamic_cast(footnote_grobs_[i])) + { + 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 + end_of_line_visible = (LEFT == item->break_status_dir ()); + } + + if (pos < int (start)) + continue; + if (pos > int (end)) + break; + if (pos == int (start) && end_of_line_visible) + continue; + if (pos == int (end) && !end_of_line_visible) + continue; + if (!footnote_grobs_[i]->is_live ()) + continue; + + out.push_back (footnote_grobs_[i]); + } +} + +vector +System::get_footnotes_in_range (vsize start, vsize end) +{ + vector footnote_grobs; + get_footnote_grobs_in_range (footnote_grobs, start, end); + vector out; + + 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 = unsmob_stencil (footnote_stl); + out.push_back (footnote_stencil); + } + + return out; +} + +Stencil +System::make_footnote_stencil (Real padding) +{ + Stencil mol; + + for (vsize i = 0; i < footnote_grobs_.size (); i++) + { + SCM footnote_markup = footnote_grobs_[i]->get_property ("footnote-text"); + if (Spanner *orig = dynamic_cast(footnote_grobs_[i])) + if (orig->is_broken ()) + footnote_markup = orig->broken_intos_[0]->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); + + mol.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (footnote_stl), padding); + } + + return mol; +} + void System::break_into_pieces (vector const &breaking) { for (vsize i = 0; i < breaking.size (); i++) { - System *system = dynamic_cast (clone (broken_intos_.size ())); + System *system = dynamic_cast (clone ()); system->rank_ = broken_intos_.size (); - vector c (breaking[i].cols_); + vector c (breaking[i].cols_); pscore_->typeset_system (system); int st = Paper_column::get_rank (c[0]); @@ -220,19 +354,41 @@ System::break_into_pieces (vector const &breaking) Interval iv (pure_height (this, st, end)); system->set_property ("pure-Y-extent", ly_interval2scm (iv)); + get_footnote_grobs_in_range (system->footnote_grobs_, st, end); + system->set_bound (LEFT, c[0]); 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])->system_ = system; + 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_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) { @@ -245,27 +401,12 @@ System::add_column (Paper_column *p) ga = unsmob_grob_array (scm_ga); } - p->rank_ = ga->size (); + 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 () { @@ -285,9 +426,6 @@ System::pre_processing () fixup_refpoints (all_elements_->array ()); - for (vsize i = 0; i < all_elements_->size (); i++) - apply_tweaks (all_elements_->grob (i), false); - for (vsize i = 0; i < all_elements_->size (); i++) { Grob *g = all_elements_->grob (i); @@ -304,14 +442,6 @@ System::pre_processing () void System::post_processing () { - for (vsize i = 0; i < all_elements_->size (); i++) - { - Grob *g = all_elements_->grob (i); - - apply_tweaks (g, true); - (void) g->get_property ("after-line-breaking"); - } - Interval iv (extent (this, Y_AXIS)); if (iv.is_empty ()) programming_error ("system with empty extent"); @@ -322,8 +452,8 @@ System::post_processing () This might seem inefficient, but Stencils are cached per grob anyway. */ - vector all_elts_sorted (all_elements_->array ()); - vector_sort (all_elts_sorted, std::less ()); + vector all_elts_sorted (all_elements_->array ()); + vector_sort (all_elts_sorted, std::less ()); uniq (all_elts_sorted); this->get_stencil (); for (vsize i = all_elts_sorted.size (); i--;) @@ -346,21 +476,22 @@ operator< (Layer_entry const &a, return a.layer_ < b.layer_; } - SCM System::get_paper_system () { SCM exprs = SCM_EOL; SCM *tail = &exprs; + 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); - - entries.push_back (e); + + entries.push_back (e); } vector_sort (entries, std::less ()); @@ -369,9 +500,9 @@ System::get_paper_system () Grob *g = entries[j].grob_; Stencil st = g->get_print_stencil (); - if (st.expr() == SCM_EOL) + if (st.expr () == SCM_EOL) continue; - + Offset o; for (int a = X_AXIS; a < NO_AXES; a++) o[Axis (a)] = g->relative_coordinate (this, Axis (a)); @@ -399,8 +530,16 @@ System::get_paper_system () exprs)); if (debug_skylines) { - sys_stencil.add_stencil (points_to_line_stencil (skylines_[UP].to_points ()).in_color (255, 0, 0)); - sys_stencil.add_stencil (points_to_line_stencil (skylines_[DOWN].to_points ()).in_color (0, 255, 0)); + 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); @@ -410,44 +549,40 @@ System::get_paper_system () /* information that the page breaker might need */ Grob *right_bound = this->get_bound (RIGHT); - pl->set_property ("skyline-distance", get_property ("skyline-distance")); + 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 (!scm_is_pair (pl->get_property ("refpoint-Y-extent"))) + Interval staff_refpoints; + if (Grob *align = get_vertical_alignment ()) { - Interval staff_refpoints; - staff_refpoints.set_empty (); - extract_grob_set (this, "spaceable-staves", staves); + extract_grob_set (align, "elements", staves); for (vsize i = 0; i < staves.size (); i++) - { - Grob *g = staves[i]; - staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS)); - } - pl->set_property ("refpoint-Y-extent", ly_interval2scm (staff_refpoints)); + if (staves[i]->is_live () + && Page_layout_problem::is_spaceable (staves[i])) + staff_refpoints.add_point (staves[i]->relative_coordinate (this, + Y_AXIS)); } - pl->set_property ("system-grob", this->self_scm ()); + pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints)); + pl->set_property ("system-grob", this->self_scm ()); return pl->unprotect (); } -vector +vector System::broken_col_range (Item const *left, Item const *right) const { - vector ret; + vector ret; left = left->get_column (); right = right->get_column (); - extract_grob_set (this, "columns", cols); - vsize i = binary_search (cols, (Grob *) left, - Paper_column::less_than); - + vsize i = Paper_column::get_rank (left); int end_rank = Paper_column::get_rank (right); if (i < cols.size ()) i++; @@ -456,7 +591,7 @@ System::broken_col_range (Item const *left, Item const *right) const && Paper_column::get_rank (cols[i]) < end_rank) { Paper_column *c = dynamic_cast (cols[i]); - if (Paper_column::is_breakable (c) && !c->system_) + if (Paper_column::is_breakable (c) && !c->get_system ()) ret.push_back (c); i++; } @@ -464,11 +599,10 @@ System::broken_col_range (Item const *left, Item const *right) const return ret; } - /** Return all columns, but filter out any unused columns , since they might disrupt the spacing problem. */ -vector -System::columns () const +vector +System::used_columns () const { extract_grob_set (this, "columns", ro_columns); @@ -480,7 +614,7 @@ System::columns () const break; } - vector columns; + vector columns; for (int i = 0; i <= last_breakable; i++) { if (Paper_column::is_used (ro_columns[i])) @@ -490,7 +624,17 @@ System::columns () const return columns; } -Paper_score* +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_; @@ -503,48 +647,223 @@ System::get_rank () const } System * -get_root_system (Grob *me) +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); + return dynamic_cast (system_grob); } -void -System::build_skylines () +Grob * +System::get_vertical_alignment () { - vector boxes; - for (vsize i = 0; i < all_elements_->size (); i++) + extract_grob_set (this, "elements", elts); + Grob *ret = 0; + for (vsize i = 0; i < elts.size (); i++) + if (Align_interface::has_interface (elts[i])) + { + if (ret) + programming_error ("found multiple vertical alignments in this system"); + ret = elts[i]; + } + + if (!ret) + programming_error ("didn't find a vertical alignment in this system"); + return ret; +} + +// 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 = get_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) { - Grob *g = all_elements_->grob (i); - if (!unsmob_stencil (g->get_property ("stencil"))) - continue; + 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; +} + +Interval +System::pure_refpoint_extent (vsize start, vsize end) +{ + Interval ret; + Grob *alignment = get_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 = get_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 xiv = g->extent (this, X_AXIS); - Interval yiv = g->extent (this, Y_AXIS); - if (!xiv.is_empty () && !yiv.is_empty ()) - boxes.push_back (Box (xiv, yiv)); +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 = unsmob_grob (smob); + + extract_grob_set (me, "elements", elts); + vector relevant_grobs; + SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?"); + + for (vsize i = 0; i < elts.size (); ++i) + { + if (!Axis_group_interface::has_interface (elts[i])) + { + if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL))) + relevant_grobs.push_back (elts[i]); + + if (Item *it = dynamic_cast (elts[i])) + { + Direction d = LEFT; + do + { + Item *piece = it->find_prebroken_piece (d); + if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL))) + relevant_grobs.push_back (piece); + } + while (flip (&d) != LEFT); + } + } } - SCM horizon_padding_scm = get_property ("skyline-horizontal-padding"); - Real horizon_padding = robust_scm2double (horizon_padding_scm, 0); - skylines_[UP] = Skyline (boxes, horizon_padding, X_AXIS, UP); - skylines_[DOWN] = Skyline (boxes, horizon_padding, X_AXIS, DOWN); + SCM grobs_scm = Grob_array::make_array (); + + unsmob_grob_array (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 (unsmob_grob (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); +} ADD_INTERFACE (System, - "This is the toplevel object: each object in a score " - "ultimately has a System object as its X and Y parent. ", + "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 " + "labels " "pure-Y-extent " - "spaceable-staves " - "skyline-distance " "skyline-horizontal-padding " - ) + );