X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fsystem.cc;h=7c1828cabde793c1c963595846bdb66da598811e;hb=6f664e0e318a1651f6fe9317a842bf9c7f476f08;hp=b456620425801fddefe5119629ac712b23c03526;hpb=2536405e9584f63d559653183971c0fec57ba037;p=lilypond.git diff --git a/lily/system.cc b/lily/system.cc index b456620425..7c1828cabd 100644 --- a/lily/system.cc +++ b/lily/system.cc @@ -3,87 +3,130 @@ source file of the GNU LilyPond music typesetter - (c) 1996--2004 Han-Wen Nienhuys + (c) 1996--2006 Han-Wen Nienhuys */ -#include +#include "system.hh" #include "align-interface.hh" +#include "all-font-metrics.hh" #include "axis-group-interface.hh" -#include "warn.hh" -#include "system.hh" +#include "grob-array.hh" +#include "international.hh" #include "main.hh" -#include "paper-column.hh" #include "output-def.hh" -#include "paper-outputter.hh" +#include "paper-column.hh" #include "paper-score.hh" -#include "string.hh" -#include "warn.hh" -#include "stencil.hh" -#include "all-font-metrics.hh" +#include "paper-system.hh" +#include "pointer-group-interface.hh" #include "spacing-interface.hh" #include "staff-symbol-referencer.hh" -#include "paper-book.hh" -#include "paper-system.hh" +#include "tweak-registration.hh" +#include "warn.hh" + +extern bool debug_skylines; -System::System (SCM s) - : Spanner (s) +System::System (System const &src, int count) + : Spanner (src, count) { + all_elements_ = 0; + pscore_ = 0; rank_ = 0; + init_elements (); +} + +System::System (SCM s, Object_key const *key) + : Spanner (s, key) +{ + all_elements_ = 0; + rank_ = 0; + init_elements (); +} + +void +System::init_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); +} + +Grob * +System::clone (int index) const +{ + return new System (*this, index); } int System::element_count () const { - return scm_ilength (get_property ("all-elements")); + return all_elements_->size (); } int System::spanner_count () const { int k = 0; - for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = ly_cdr (s)) - if (dynamic_cast (unsmob_grob (ly_car (s)))) + for (vsize i = all_elements_->size (); i--;) + if (dynamic_cast (all_elements_->grob (i))) k++; return k; } void -System::typeset_grob (Grob * elem) +System::typeset_grob (Grob *elem) { - if (elem->pscore_) - programming_error ("Adding element twice."); + if (elem->layout_) + programming_error ("adding element twice"); else { - elem->pscore_ = pscore_; - Pointer_group_interface::add_grob (this, ly_symbol2scm ("all-elements"), elem); - scm_gc_unprotect_object (elem->self_scm ()); + elem->layout_ = pscore_->layout (); + all_elements_->add (elem); + elem->unprotect (); } } -// todo: use map. -static void -fixup_refpoints (SCM s) +void +System::derived_mark () const { - for (; scm_is_pair (s); s = ly_cdr (s)) + if (!all_elements_->empty ()) { - Grob::fixup_refpoint (ly_car (s)); + 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 (); +} + +static void +fixup_refpoints (vector const &grobs) +{ + for (vsize i = grobs.size (); i--;) + grobs[i]->fixup_refpoint (); } SCM -System::get_lines () +System::get_paper_systems () { - for (SCM s = get_property ("all-elements"); scm_is_pair (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 (); @@ -98,359 +141,408 @@ 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; scm_is_pair (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"); scm_is_pair (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. 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_property ("all-elements"); - all = ly_list_qsort_uniq_x(all); + System *child = dynamic_cast (broken_intos_[i]); + child->all_elements_->remove_duplicates (); } -#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_EOL); - - for (int i = 0; i < line_count; i++) + if (be_verbose_global) + message (_f ("Element count %d.", count + element_count ())); + + 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 *system = dynamic_cast (broken_intos_[i]); + system->post_processing (); - scm_vector_set_x (lines, scm_int2num (i), system->get_line ()); + 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 ()); - if (verbose_global_b) + if (be_verbose_global) progress_indication (to_string (i) + "]"); } return lines; } -/* Find the loose columns in POSNS, and drape them around the columns - specified in BETWEEN-COLS. */ -static void -set_loose_columns (System* which, Column_x_positions const *posns) +void +System::break_into_pieces (vector const &breaking) { - int loose_col_count = posns->loose_cols_.size (); - for (int i = 0; i < loose_col_count; i++) + for (vsize i = 0; i < breaking.size (); i++) { - int divide_over = 1; - Item *loose = dynamic_cast (posns->loose_cols_[i]); - Paper_column* col = dynamic_cast (loose); - - if (col->system_) - continue; - - Item *left = 0; - Item *right = 0; - while (1) - { - SCM between = loose->get_property ("between-cols"); - if (!scm_is_pair (between)) - break; + System *system = dynamic_cast (clone (broken_intos_.size ())); + system->rank_ = broken_intos_.size (); - Item *le = dynamic_cast (unsmob_grob (ly_car (between))); - Item *re = dynamic_cast (unsmob_grob (ly_cdr (between))); + vector c (breaking[i].cols_); + pscore_->typeset_system (system); - if (!(le && re)) - break; - - if (!left && le) - { - left = le->get_column (); - if (!left->get_system ()) - left = left->find_prebroken_piece (RIGHT); - } - - divide_over++; - loose = right = re->get_column (); - } + 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)); - if (!right->get_system ()) - right = right->find_prebroken_piece (LEFT); - - /* Divide the remaining space of the column over the left and - right side. At the moment, FIXME */ - 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); - - /* 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 ()) + system->set_bound (LEFT, c[0]); + system->set_bound (RIGHT, c.back ()); + for (vsize j = 0; j < c.size (); j++) { - /* TODO: this is discontinuous. I'm too tired to - invent a sliding mechanism. Duh. */ - dx *= 0.25; + c[j]->translate_axis (breaking[i].config_[j], X_AXIS); + dynamic_cast (c[j])->system_ = system; } - else - dx *= 0.5; - - col->system_ = which; - col->translate_axis (-col->relative_coordinate (common, X_AXIS), X_AXIS); - col->translate_axis (lx + dx - cval[LEFT], X_AXIS); + + set_loose_columns (system, &breaking[i]); + broken_intos_.push_back (system); } } -// const? void -System::break_into_pieces (Array const &breaking) +System::add_column (Paper_column *p) { - for (int i = 0; i < breaking.size (); i++) + Grob *me = this; + Grob_array *ga = unsmob_grob_array (me->get_object ("columns")); + if (!ga) { - System *system = dynamic_cast (clone ()); - system->rank_ = i; + SCM scm_ga = Grob_array::make_array (); + me->set_object ("columns", scm_ga); + ga = unsmob_grob_array (scm_ga); + } - 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++) + p->rank_ + = ga->size () + ? Paper_column::get_rank (ga->array ().back ()) + 1 + : 0; + + 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)) { - c[j]->translate_axis (breaking[i].config_[j], X_AXIS); - dynamic_cast (c[j])->system_ = system; + SCM proc = scm_caar (s); + SCM rest = scm_cdar (s); + scm_apply_1 (proc, g->self_scm (), rest); } - set_loose_columns (system, &breaking[i]); - broken_intos_.push (system); } } void -System::add_column (Paper_column*p) +System::pre_processing () { - Grob *me = this; - SCM cs = me->get_property ("columns"); - Grob *prev = scm_is_pair (cs) ? unsmob_grob (ly_car (cs)) : 0; + for (vsize i = 0; i < all_elements_->size (); i++) + all_elements_->grob (i)->discretionary_processing (); - p->rank_ = prev ? Paper_column::get_rank (prev) + 1 : 0; + if (be_verbose_global) + message (_f ("Grob count %d", element_count ())); - me->set_property ("columns", scm_cons (p->self_scm (), cs)); + /* + 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 (); - Axis_group_interface::add_element (me, p); -} + fixup_refpoints (all_elements_->array ()); -void -System::pre_processing () -{ - for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = ly_cdr (s)) - unsmob_grob (ly_car (s))->discretionary_processing (); + for (vsize i = 0; i < all_elements_->size (); i++) + apply_tweaks (all_elements_->grob (i), false); - if (verbose_global_b) - progress_indication (_f ("Grob count %d", element_count ())); - - for (SCM s = get_property ("all-elements"); scm_is_pair (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"); scm_is_pair (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"); - progress_indication (_ ("Calculating line breaks...")); - progress_indication (" "); - for (SCM s = get_property ("all-elements"); scm_is_pair (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 (ly_c_procedure_p (proc)) - scm_call_1 (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"); scm_is_pair (s); s = ly_cdr (s)) + for (vsize i = 0; i < all_elements_->size (); i++) { - Grob *g = unsmob_grob (ly_car (s)); - g->calculate_dependencies (POSTCALCED, POSTCALCING, - ly_symbol2scm ("after-line-breaking-callback")); + 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 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 = ly_list_qsort_uniq_x (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; scm_is_pair (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 (); } } -SCM -System::get_line () -{ - static int const LAYER_COUNT = 3; +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 () +{ SCM exprs = SCM_EOL; SCM *tail = &exprs; - /* Output stencils in three layers: 0, 1, 2. Default layer: 1. + 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); + } - Start with layer 3, since scm_cons prepends to list. */ - SCM all = get_property ("all-elements"); - Interval staff_refpoints; - staff_refpoints.set_empty(); - - for (int i = LAYER_COUNT; i--;) - for (SCM s = all; scm_is_pair (s); s = ly_cdr (s)) - { - Grob *g = unsmob_grob (ly_car (s)); - Stencil *stil = g->get_stencil (); - - if (i == 0 - && Axis_group_interface::has_interface (g) - && !Align_interface::has_interface (g) - && dynamic_cast (g) - /* - UGH. - */ - && !g->internal_has_interface (ly_symbol2scm ("dynamic-interface")) - && !g->internal_has_interface (ly_symbol2scm ("piano-pedal-interface")) - ) - { - staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS)); - } - - /* Skip empty stencils and grobs that are not in this layer. */ - if (!stil - || robust_scm2int (g->get_property ("layer"), 1) != i) - continue; + 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 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); - 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. */ - /* Must copy the stencil, for we cannot change the stencil - cached in G. */ + st.translate (o + extra); - Stencil st = *stil; - st.translate (o + extra); - *tail = scm_cons (st.expr (), SCM_EOL); - tail = SCM_CDRLOC(*tail); - } + *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)); - Stencil sys_stencil (Box (x,y), + Stencil sys_stencil (Box (x, y), scm_cons (ly_symbol2scm ("combine-stencil"), exprs)); - - Paper_system *pl = new Paper_system (sys_stencil, false); - pl->staff_refpoints_ = staff_refpoints; - Item * break_point =this->get_bound(LEFT); - pl->penalty_ = - robust_scm2double (break_point->get_property ("page-penalty"), 0.0); - - return scm_gc_unprotect_object (pl->self_scm ()); + if (debug_skylines) + { + sys_stencil.add_stencil (skylines_[UP].stencil ().in_color (255, 0, 0)); + sys_stencil.add_stencil (skylines_[DOWN].stencil ().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 ("skyline-distance", get_property ("skyline-distance")); + 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; + staff_refpoints.set_empty (); + extract_grob_set (this, "spaceable-staves", 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)); + } + + 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 (); - SCM s = get_property ("columns"); - while (scm_is_pair (s) && ly_car (s) != right->self_scm ()) - s = ly_cdr (s); + extract_grob_set (this, "columns", cols); + vsize i = 0; + while (i < cols.size () + && cols[i] != left) + i++; - if (scm_is_pair (s)) - s = ly_cdr (s); + if (i < cols.size ()) + i++; - while (scm_is_pair (s) && ly_car (s) != left->self_scm ()) + while (i < cols.size () + && cols[i] != right) { - Paper_column*c = dynamic_cast (unsmob_grob (ly_car (s))); - if (Item::is_breakable (c) && !c->system_) - ret.push (c); - - s = ly_cdr (s); + Paper_column *c = dynamic_cast (cols[i]); + if (Paper_column::is_breakable (c) && !c->system_) + ret.push_back (c); + i++; } - ret.reverse (); return ret; } /** Return all columns, but filter out any unused columns , since they might disrupt the spacing problem. */ -Link_array +vector System::columns () const { - Link_array acs - = Pointer_group_interface__extract_grobs (this, (Grob*) 0, "columns"); - bool found = false; - for (int i = acs.size (); i--;) + extract_grob_set (this, "columns", ro_columns); + + int last_breakable = ro_columns.size (); + + while (last_breakable--) { - bool brb = Item::is_breakable (acs[i]); - found = found || brb; - - /* - 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 (!found || !Paper_column::is_used (acs[i])) - acs.del (i); + if (Paper_column::is_breakable (ro_columns [last_breakable])) + break; } - return acs; + + vector columns; + for (int i = 0; i <= last_breakable; i++) + { + if (Paper_column::is_used (ro_columns[i])) + columns.push_back (ro_columns[i]); + } + + return columns; } -ADD_INTERFACE (System,"system-interface", +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); +} + +void +System::build_skylines () +{ + vector boxes; + for (vsize i = 0; i < all_elements_->size (); i++) + { + Grob *g = all_elements_->grob (i); + if (!unsmob_stencil (g->get_property ("stencil"))) + continue; + + 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)); + } + + skylines_[UP] = Skyline (boxes, X_AXIS, UP); + skylines_[DOWN] = Skyline (boxes, X_AXIS, DOWN); +} + + +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 columns") + + /* properties */ + "all-elements " + "columns " + "pure-Y-extent " + "spaceable-staves " + "skyline-distance " + )