X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fsystem.cc;h=1cd582de7525bc2d628b24cb062ddfc188ac7904;hb=beedd09c78a7725d0d52b93c59e3d9840681c3e5;hp=393d2abf5b50a11c15c4aa630e48d4c3be6034f2;hpb=0ccace80447d10fe0f52f9f189f01d60d60202e8;p=lilypond.git diff --git a/lily/system.cc b/lily/system.cc index 393d2abf5b..1cd582de75 100644 --- a/lily/system.cc +++ b/lily/system.cc @@ -1,141 +1,154 @@ /* - 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--2004 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 "axis-group-interface.hh" -#include "warn.hh" #include "system.hh" + +#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-def.hh" -#include "paper-outputter.hh" #include "paper-score.hh" -#include "string.hh" -#include "warn.hh" -#include "stencil.hh" -#include "all-font-metrics.hh" -#include "spacing-interface.hh" +#include "paper-system.hh" +#include "pointer-group-interface.hh" +#include "skyline-pair.hh" #include "staff-symbol-referencer.hh" -#include "paper-book.hh" +#include "text-interface.hh" +#include "warn.hh" + +System::System (System const &src) + : Spanner (src) +{ + all_elements_ = 0; + pscore_ = 0; + rank_ = 0; + checked_footnotes_ = false; + init_elements (); +} System::System (SCM s) : Spanner (s) { + all_elements_ = 0; rank_ = 0; + checked_footnotes_ = false; + init_elements (); } -int -System::element_count () const +void +System::init_elements () { - return scm_ilength (get_property ("all-elements")); + SCM scm_arr = Grob_array::make_array (); + all_elements_ = unsmob_grob_array (scm_arr); + all_elements_->set_ordered (false); + set_object ("all-elements", scm_arr); } -int -System::spanner_count () const +Grob * +System::clone () const { - int k =0; - for (SCM s = get_property ("all-elements"); - gh_pair_p (s); s = ly_cdr (s)) - { - if (dynamic_cast (unsmob_grob (gh_car (s)))) - k++; - } - - return k; + return new System (*this); } - int -scm_default_compare (const void * a, const void *b) +System::element_count () const { - SCM pa = *(SCM *)a; - SCM pb = *(SCM *)b; - - if (pa < pb) return -1 ; - else if (pa > pb) return 1; - else return 0; + return all_elements_->size (); } -/* - modify L in place: sort it -*/ - -SCM -uniquify_list (SCM l) +int +System::spanner_count () const { - int len = scm_ilength (l); - SCM * arr = new SCM[len]; int k = 0; - for (SCM s =l ; SCM_NNULLP (s); s = SCM_CDR (s)) - arr[k++] = SCM_CAR (s); - - assert (k == len); - qsort (arr, len, sizeof (SCM), &scm_default_compare); + for (vsize i = all_elements_->size (); i--;) + if (dynamic_cast (all_elements_->grob (i))) + k++; + return k; +} - k = 0; - SCM s =l; - for (int i = 0; i < len ; i++) +void +System::typeset_grob (Grob *elem) +{ + if (elem->layout_) + programming_error ("adding element twice"); + else { - if (i && arr[i] == arr[i-1]) - continue; - - SCM_SETCAR (s, arr[i]); - - if (i < len - 1) - s = SCM_CDR (s); + elem->layout_ = pscore_->layout (); + all_elements_->add (elem); + elem->unprotect (); } - - SCM_SETCDR (s, SCM_EOL); - delete[] arr; - - return l; } void -System::typeset_grob (Grob * elem) +System::derived_mark () const { - if (elem->pscore_) - programming_error ("Adding element twice."); - - elem->pscore_ = pscore_; - Pointer_group_interface::add_grob (this, ly_symbol2scm ("all-elements"), elem); - scm_gc_unprotect_object (elem->self_scm ()); + if (!all_elements_->empty ()) + { + Grob **ptr = &all_elements_->array_reference ()[0]; + Grob **end = ptr + all_elements_->size (); + while (ptr < end) + { + scm_gc_mark ((*ptr)->self_scm ()); + ptr++; + } + } + + if (pscore_) + scm_gc_mark (pscore_->self_scm ()); + + Spanner::derived_mark (); } -// todo: use map. static void -fixup_refpoints (SCM s) +fixup_refpoints (vector const &grobs) { - for (; gh_pair_p (s); s = ly_cdr (s)) - { - Grob::fixup_refpoint (ly_car (s)); - } + for (vsize i = grobs.size (); i--;) + grobs[i]->fixup_refpoint (); } -SCM -System::get_lines () +void +System::do_break_substitution_and_fixup_refpoints () { - for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s)) + for (vsize i = 0; i < all_elements_->size (); i++) { - Grob *g = unsmob_grob (ly_car (s)); + 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)) + 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->live ()) + else if (g->is_live ()) g->do_break_processing (); } @@ -143,361 +156,714 @@ System::get_lines () 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]; - SCM all = se->get_property ("all-elements"); - for (SCM s = all; gh_pair_p (s); s = ly_cdr (s)) - fixup_refpoint (ly_car (s)); - count += scm_ilength (all); + + extract_grob_set (se, "all-elements", all_elts); + for (vsize j = 0; j < all_elts.size (); j++) + { + Grob *g = all_elts[j]; + g->fixup_refpoint (); + } + + count += all_elts.size (); } - + /* needed for doing items. - */ - fixup_refpoints (get_property ("all-elements")); + */ + fixup_refpoints (all_elements_->array ()); + + for (vsize i = 0; i < all_elements_->size (); i++) + all_elements_->grob (i)->handle_broken_dependencies (); - for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s)) - unsmob_grob (ly_car (s))->handle_broken_dependencies (); handle_broken_dependencies (); -#if 0 /* don't do this: 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. uniquify_list () - 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_property ("all-elements"); - all = uniquify_list (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 (verbose_global_b) - progress_indication (_f ("Element count %d.", count + element_count ())); - - int line_count = broken_intos_.size (); - SCM lines = scm_c_make_vector (line_count, SCM_UNDEFINED); - - for (int i = 0; i < line_count; i++) + + if (be_verbose_global) + 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++) { - if (verbose_global_b) + if (be_verbose_global) progress_indication ("["); - System *system = dynamic_cast (broken_intos_[i]); - system->post_processing (); - scm_vector_set_x (lines, scm_int2num (i), system->get_line ()); + System *system = dynamic_cast (broken_intos_[i]); - if (verbose_global_b) + scm_vector_set_x (lines, scm_from_int (i), + system->get_paper_system ()); + + if (be_verbose_global) progress_indication (to_string (i) + "]"); } - return lines; + 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; +} - -/* - Find the loose columns in POSNS, and drape them around the columns - specified in BETWEEN-COLS. */ void -set_loose_columns (System* which, Column_x_positions const *posns) +System::get_footnote_grobs_in_range (vector &out, vsize start, vsize end) { - for (int i = 0; i < posns->loose_cols_.size (); i++) + if (!checked_footnotes_) + populate_footnote_grob_vector (); + + for (vsize i = 0; i < footnote_grobs_.size (); i++) { - int divide_over = 1; - Item *loose = dynamic_cast (posns->loose_cols_[i]); - Paper_column* col = dynamic_cast (loose); - - if (col->system_) - continue; + 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]; + } - Item * left = 0; - Item * right = 0; - do - { - SCM between = loose->get_property ("between-cols"); - if (!gh_pair_p (between)) - break; + 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; - Item * l=dynamic_cast (unsmob_grob (ly_car (between))); - Item * r=dynamic_cast (unsmob_grob (ly_cdr (between))); + for (vsize i = 0; i < footnote_grobs.size (); i++) + { + SCM footnote_markup = footnote_grobs[i]->get_property ("footnote-text"); - if (!(l && r)) - break ; - - if (!left && l) - { - left = l->get_column (); - if (!left->get_system ()) - left = left->find_prebroken_piece (RIGHT); - } + if (!Text_interface::is_markup (footnote_markup)) + continue; - divide_over ++; - loose = right = r->get_column (); - } - while (1); + SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"), + pscore_->layout ()->self_scm ()); - if (!right->get_system ()) - right = right->find_prebroken_piece (LEFT); - - /* - We divide the remaining space of the column over the left and - right side. At the moment, we - - */ - Grob * common = right->common_refpoint (left, X_AXIS); - - Real rx = right->extent (common, X_AXIS)[LEFT]; - Real lx = left->extent (common, X_AXIS)[RIGHT]; - Real total_dx = rx - lx; - Interval cval =col->extent (col, X_AXIS); + SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (), + props, footnote_markup); - /* - - We put it in the middle. This is not an ideal solution -- the - break alignment code inserts a fixed space before the clef - (about 1 SS), while the space following the clef is - flexible. In tight situations, the clef will almost be on top - of the following note. - - */ - Real dx = rx-lx - cval.length (); - if (total_dx < 2* cval.length ()) - { - /* - todo: this is discontinuous. I'm too tired to - invent a sliding mechanism. Duh. + Stencil *footnote_stencil = unsmob_stencil (footnote_stl); + out.push_back (footnote_stencil); + } - TODO. - */ - dx *= 0.25; - } - else - dx *= 0.5; + return out; +} + +Stencil +System::make_footnote_stencil (Real padding) +{ + Stencil mol; - col->system_ = which; - col->translate_axis (- col->relative_coordinate (common, X_AXIS), X_AXIS); - col->translate_axis (lx + dx - cval[LEFT], X_AXIS); + 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; } -// const? 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 ()); - system->rank_ = i; + System *system = dynamic_cast (clone ()); + system->rank_ = broken_intos_.size (); - Link_array c (breaking[i].cols_); - pscore_->typeset_line (system); - - system->set_bound (LEFT,c[0]); - system->set_bound (RIGHT,c.top ()); - for (int j=0; j < c.size (); j++) + 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)); + + 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; + 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::add_column (Paper_column*p) +System::collect_labels (Grob const *col, SCM *labels) { - Grob *me = this; - SCM cs = me->get_property ("columns"); - Grob * prev = gh_pair_p (cs) ? unsmob_grob (ly_car (cs)) : 0; + SCM col_labels = col->get_property ("labels"); + if (scm_is_pair (col_labels)) + *labels = scm_append (scm_list_2 (col_labels, *labels)); +} - p->rank_ = prev ? Paper_column::get_rank (prev) + 1 : 0; +void +System::add_column (Paper_column *p) +{ + Grob *me = this; + Grob_array *ga = unsmob_grob_array (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); + } - me->set_property ("columns", gh_cons (p->self_scm (), cs)); + p->set_rank (ga->size ()); - Axis_group_interface::add_element (me, p); + ga->add (p); + Axis_group_interface::add_element (this, p); } void System::pre_processing () { - for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s)) - unsmob_grob (ly_car (s))->discretionary_processing (); + 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 ())); + + /* + order is significant: broken grobs are added to the end of the + array, and should be processed before the original is potentially + killed. + */ + for (vsize i = all_elements_->size (); i--;) + all_elements_->grob (i)->handle_prebroken_dependencies (); - if (verbose_global_b) - progress_indication (_f ("Grob count %d ", element_count ())); + fixup_refpoints (all_elements_->array ()); - - for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s)) - unsmob_grob (ly_car (s))->handle_prebroken_dependencies (); - - fixup_refpoints (get_property ("all-elements")); - - for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s)) + for (vsize i = 0; i < all_elements_->size (); i++) { - Grob* sc = unsmob_grob (ly_car (s)); - sc->calculate_dependencies (PRECALCED, PRECALCING, ly_symbol2scm ("before-line-breaking-callback")); + Grob *g = all_elements_->grob (i); + (void) g->get_property ("before-line-breaking"); } - - progress_indication ("\n" + _ ("Calculating line breaks...") + " "); - for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s)) + + for (vsize i = 0; i < all_elements_->size (); i++) { - Grob * e = unsmob_grob (ly_car (s)); - SCM proc = e->get_property ("spacing-procedure"); - if (gh_procedure_p (proc)) - gh_call1 (proc, e->self_scm ()); + Grob *e = all_elements_->grob (i); + (void) e->get_property ("springs-and-rods"); } } void System::post_processing () { - for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s)) - { - Grob *g = unsmob_grob (ly_car (s)); - 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 zero extent."); + programming_error ("system with empty extent"); else translate_axis (-iv[MAX], Y_AXIS); /* Generate all stencils to trigger font loads. This might seem inefficient, but Stencils are cached per grob anyway. */ - SCM all = get_property ("all-elements") ; - all = uniquify_list (all); + vector all_elts_sorted (all_elements_->array ()); + vector_sort (all_elts_sorted, std::less ()); + uniq (all_elts_sorted); this->get_stencil (); - for (SCM s = all; gh_pair_p (s); s = ly_cdr (s)) + for (vsize i = all_elts_sorted.size (); i--;) { - Grob *g = unsmob_grob (ly_car (s)); + Grob *g = all_elts_sorted[i]; g->get_stencil (); } } -/* Return line: - ((HEIGHT . WIDTH) . LINE) - LINE: list of ((OFFSET-X . OFFSET-Y) . STENCIL) +struct Layer_entry +{ + Grob *grob_; + int layer_; +}; + +bool +operator< (Layer_entry const &a, + Layer_entry const &b) +{ + return a.layer_ < b.layer_; +} - or (!PAGE_LAYOUT): - ('between-system-string . STENCIL) - - Maybe make clas/smob? */ SCM -System::get_line () -{ - static int const LAYER_COUNT = 3; - SCM line = SCM_EOL; - if (Stencil *me = get_stencil ()) - line = scm_cons (scm_cons (ly_offset2scm (Offset (0, 0)), - me->smobbed_copy ()), line); +System::get_paper_system () +{ + SCM exprs = SCM_EOL; + SCM *tail = &exprs; - /* Output stencils in three layers: 0, 1, 2. The default layer is - 1. */ - for (int i = 0; i < LAYER_COUNT; i++) - for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s)) - { - Grob *g = unsmob_grob (ly_car (s)); - Stencil *stil = g->get_stencil (); - - /* Skip empty stencils and grobs that are not in this layer. */ - if (!stil - || robust_scm2int (g->get_property ("layer"), 1) != i) - continue; - - Offset o (g->relative_coordinate (this, X_AXIS), - g->relative_coordinate (this, Y_AXIS)); - - Offset extra = robust_scm2offset (g->get_property ("extra-offset"), - Offset (0, 0)) - * Staff_symbol_referencer::staff_space (g); - line = scm_cons (scm_cons (ly_offset2scm (o + extra), - stil->smobbed_copy ()), line); - } + post_processing (); - if (output_format_global != PAGE_LAYOUT) + vector entries; + for (vsize j = 0; j < all_elements_->size (); j++) { - SCM lastcol = ly_car (get_property ("columns")); - Grob *g = unsmob_grob (lastcol); - - SCM between = ly_symbol2scm ("between-system-string"); - SCM inter = g->internal_get_property (between); - if (gh_string_p (inter)) - { - Stencil *stil = new Stencil (Box (), scm_list_2 (between, inter)); - line = scm_cons (scm_cons (between, stil->smobbed_copy ()), line); - } + Layer_entry e; + e.grob_ = all_elements_->grob (j); + e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1); + + 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 (); + + 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)); + + Offset extra = robust_scm2offset (g->get_property ("extra-offset"), + Offset (0, 0)) + * Staff_symbol_referencer::staff_space (g); + + /* Must copy the stencil, for we cannot change the stencil + cached in G. */ + + 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); + Interval x (extent (this, X_AXIS)); Interval y (extent (this, Y_AXIS)); - return scm_cons (ly_offset2scm (Offset (x.length (), y.length ())), line); + Stencil sys_stencil (Box (x, y), + 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")); + + Interval staff_refpoints; + if (Grob *align = get_vertical_alignment ()) + { + 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)); + } + + pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints)); + pl->set_property ("system-grob", this->self_scm ()); + + return pl->unprotect (); } -Link_array -System::broken_col_range (Item const*l, Item const*r) const +vector +System::broken_col_range (Item const *left, Item const *right) const { - Link_array ret; + vector ret; - l = l->get_column (); - r = r->get_column (); - SCM s = get_property ("columns"); + left = left->get_column (); + right = right->get_column (); - while (gh_pair_p (s) && ly_car (s) != r->self_scm ()) - s = ly_cdr (s); - - if (gh_pair_p (s)) - s = ly_cdr (s); - - while (gh_pair_p (s) && ly_car (s) != l->self_scm ()) + extract_grob_set (this, "columns", cols); + + vsize i = Paper_column::get_rank (left); + int end_rank = Paper_column::get_rank (right); + if (i < cols.size ()) + i++; + + while (i < cols.size () + && Paper_column::get_rank (cols[i]) < end_rank) { - Paper_column*c = dynamic_cast (unsmob_grob (ly_car (s))); - if (Item::is_breakable (c) && !c->system_) - ret.push (c); + Paper_column *c = dynamic_cast (cols[i]); + if (Paper_column::is_breakable (c) && !c->get_system ()) + ret.push_back (c); + i++; + } - s = ly_cdr (s); + return ret; +} + +/** Return all columns, but filter out any unused columns , since they might + disrupt the spacing problem. */ +vector +System::used_columns () const +{ + extract_grob_set (this, "columns", ro_columns); + + int last_breakable = ro_columns.size (); + + while (last_breakable--) + { + if (Paper_column::is_breakable (ro_columns [last_breakable])) + break; + } + + vector columns; + for (int i = 0; i <= last_breakable; i++) + { + if (Paper_column::is_used (ro_columns[i])) + columns.push_back (ro_columns[i]); } - ret.reverse (); + 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_; +} + +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); +} + +Grob * +System::get_vertical_alignment () +{ + 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; } -/** - Return all columns, but filter out any unused columns , since they might - disrupt the spacing problem. - */ -Link_array -System::columns ()const +// 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) { - Link_array acs - = Pointer_group_interface__extract_grobs (this, (Grob*) 0, "columns"); - bool bfound = false; - for (int i= acs.size (); i -- ;) + 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) { - bool brb = Item::is_breakable (acs[i]); - bfound = bfound || brb; + if (Hara_kiri_group_spanner::has_interface (elts[i])) + Hara_kiri_group_spanner::consider_suicide (elts[i]); - /* - the last column should be breakable. Weed out any columns that - seem empty. We need to retain breakable columns, in case - someone forced a breakpoint. - */ - if (!bfound || !Paper_column::is_used (acs[i])) - acs.del (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 +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); + } + } } - return acs; + + 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,"system-interface", - "This is the toplevel object: each object in a score " - "ultimately has a System object as its X and Y parent. ", - "between-system-string all-elements columns") +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 " + "labels " + "pure-Y-extent " + "skyline-horizontal-padding " + );