X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fspanner.cc;h=f73657afe184bfec6820190186c53759d0c04458;hb=a6a51abfd0195a3cf7d6ea095cf69808852f21ce;hp=32e0d21201c4bdd2fa8b32870176e0c5d24d6f59;hpb=bc95f4434f760d41191341ab4508b2064eb19025;p=lilypond.git diff --git a/lily/spanner.cc b/lily/spanner.cc index 32e0d21201..f73657afe1 100644 --- a/lily/spanner.cc +++ b/lily/spanner.cc @@ -1,7 +1,7 @@ /* This file is part of LilyPond, the GNU music typesetter. - Copyright (C) 1996--2010 Han-Wen Nienhuys + Copyright (C) 1996--2015 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 @@ -42,102 +42,97 @@ Spanner::do_break_processing () if (!left || !right) return; - if (get_system () || is_broken ()) return; if (left == right) { /* - If we have a spanner spanning one column, we must break it - anyway because it might provide a parent for another item. */ - Direction d = LEFT; - do - { - Item *bound = left->find_prebroken_piece (d); - if (!bound) - programming_error ("no broken bound"); - else if (bound->get_system ()) - { - Spanner *span = dynamic_cast (clone ()); - span->set_bound (LEFT, bound); - span->set_bound (RIGHT, bound); - - assert (span->get_system ()); - span->get_system ()->typeset_grob (span); - broken_intos_.push_back (span); - } - } - while ((flip (&d)) != LEFT); + If we have a spanner spanning one column, we must break it + anyway because it might provide a parent for another item. */ + for (LEFT_and_RIGHT (d)) + { + Item *bound = left->find_prebroken_piece (d); + if (!bound) + programming_error ("no broken bound"); + else if (bound->get_system ()) + { + Spanner *span = dynamic_cast (clone ()); + span->set_bound (LEFT, bound); + span->set_bound (RIGHT, bound); + + assert (span->get_system ()); + span->get_system ()->typeset_grob (span); + broken_intos_.push_back (span); + } + } } else { - System *root = get_root_system (this); - vector break_points = root->broken_col_range (left, right); + System *root = get_root_system (this); + vector break_points = root->broken_col_range (left, right); break_points.insert (break_points.begin () + 0, left); break_points.push_back (right); Slice parent_rank_slice; parent_rank_slice.set_full (); - + /* - Check if our parent in X-direction spans equally wide - or wider than we do. + Check if our parent in X-direction spans equally wide + or wider than we do. */ for (int a = X_AXIS; a < NO_AXES; a++) - { - if (Spanner *parent = dynamic_cast (get_parent ((Axis)a))) - parent_rank_slice.intersect (parent->spanned_rank_interval ()); - } - + { + if (Spanner *parent = dynamic_cast (get_parent ((Axis)a))) + parent_rank_slice.intersect (parent->spanned_rank_interval ()); + } + for (vsize i = 1; i < break_points.size (); i++) - { - Drul_array bounds; - bounds[LEFT] = break_points[i - 1]; - bounds[RIGHT] = break_points[i]; - Direction d = LEFT; - do - { - if (!bounds[d]->get_system ()) - bounds[d] = bounds[d]->find_prebroken_piece (- d); - } - while ((flip (&d)) != LEFT); - - if (!bounds[LEFT] || ! bounds[RIGHT]) - { - programming_error ("bounds of this piece aren't breakable. "); - continue; - } - - bool ok = parent_rank_slice.contains (bounds[LEFT]->get_column ()->get_rank ()); - ok = ok && parent_rank_slice.contains (bounds[RIGHT]->get_column ()->get_rank ()); - - if (!ok) - { - programming_error (to_string ("Spanner `%s' is not fully contained in parent spanner. Ignoring orphaned part", - name ().c_str ())); - continue; - } - - - Spanner *span = dynamic_cast (clone ()); - span->set_bound (LEFT, bounds[LEFT]); - span->set_bound (RIGHT, bounds[RIGHT]); - - if (!bounds[LEFT]->get_system () - || !bounds[RIGHT]->get_system () - || bounds[LEFT]->get_system () != bounds[RIGHT]->get_system ()) - { - programming_error ("bounds of spanner are invalid"); - span->suicide (); - } - else - { - bounds[LEFT]->get_system ()->typeset_grob (span); - broken_intos_.push_back (span); - } - } + { + Drul_array bounds; + bounds[LEFT] = break_points[i - 1]; + bounds[RIGHT] = break_points[i]; + for (LEFT_and_RIGHT (d)) + { + if (!bounds[d]->get_system ()) + bounds[d] = bounds[d]->find_prebroken_piece (- d); + } + + if (!bounds[LEFT] || ! bounds[RIGHT]) + { + programming_error ("bounds of this piece aren't breakable."); + continue; + } + + bool ok = parent_rank_slice.contains (bounds[LEFT]->get_column ()->get_rank ()); + ok = ok && parent_rank_slice.contains (bounds[RIGHT]->get_column ()->get_rank ()); + + if (!ok) + { + programming_error (to_string ("Spanner `%s' is not fully contained in parent spanner." + " Ignoring orphaned part", + name ().c_str ())); + continue; + } + + Spanner *span = dynamic_cast (clone ()); + span->set_bound (LEFT, bounds[LEFT]); + span->set_bound (RIGHT, bounds[RIGHT]); + + if (!bounds[LEFT]->get_system () + || !bounds[RIGHT]->get_system () + || bounds[LEFT]->get_system () != bounds[RIGHT]->get_system ()) + { + programming_error ("bounds of spanner are invalid"); + span->suicide (); + } + else + { + bounds[LEFT]->get_system ()->typeset_grob (span); + broken_intos_.push_back (span); + } + } } vector_sort (broken_intos_, Spanner::less); for (vsize i = broken_intos_.size (); i--;) @@ -153,13 +148,11 @@ Spanner::get_break_index () const void Spanner::set_my_columns () { - Direction i = (Direction) LEFT; - do + for (LEFT_and_RIGHT (d)) { - if (!spanned_drul_[i]->get_system ()) - set_bound (i, spanned_drul_[i]->find_prebroken_piece ((Direction) -i)); + if (!spanned_drul_[d]->get_system ()) + set_bound (d, spanned_drul_[d]->find_prebroken_piece ((Direction) - d)); } - while (flip (&i) != LEFT); } Interval_t @@ -178,10 +171,9 @@ Interval_t Spanner::spanned_time () const { return spanned_time_interval (spanned_drul_[LEFT], - spanned_drul_[RIGHT]); + spanned_drul_[RIGHT]); } - Item * Spanner::get_bound (Direction d) const { @@ -191,6 +183,10 @@ Spanner::get_bound (Direction d) const /* Set the items that this spanner spans. If D == LEFT, we also set the X-axis parent of THIS to S. + + For example, when a slur crosses a line break, it's broken into two + pieces. The second piece shouldn't be positioned relative to the + original NoteColumn, but rather to the PaperColumn after the break. */ void Spanner::set_bound (Direction d, Grob *s) @@ -198,7 +194,7 @@ Spanner::set_bound (Direction d, Grob *s) Item *i = dynamic_cast (s); if (!i) { - programming_error ("must have Item for spanner bound of " + name()); + programming_error ("must have Item for spanner bound of " + name ()); return; } @@ -208,7 +204,14 @@ Spanner::set_bound (Direction d, Grob *s) We check for System to prevent the column -> line_of_score -> column -> line_of_score -> etc situation */ if (d == LEFT && !dynamic_cast (this)) - set_parent (i, X_AXIS); + /* + If the X-parent is a spanner, it will be split across linebreaks, too, + so we shouldn't have to overwrite it with the bound. Also, we need + original parent for alignment. + This happens e.g. for MultiMeasureRestNumbers and PercentRepeatCounters. + */ + if (!dynamic_cast (get_parent (X_AXIS))) + set_parent (i, X_AXIS); /* Signal that this column needs to be kept alive. They need to be @@ -221,29 +224,62 @@ Spanner::set_bound (Direction d, Grob *s) Pointer_group_interface::add_grob (i, ly_symbol2scm ("bounded-by-me"), this); } +Preinit_Spanner::Preinit_Spanner () +{ + spanned_drul_.set (0, 0); + pure_property_cache_ = SCM_UNDEFINED; +} + Spanner::Spanner (SCM s) : Grob (s) { break_index_ = 0; - spanned_drul_.set (0, 0); } Spanner::Spanner (Spanner const &s) : Grob (s) { - spanned_drul_.set (0, 0); + break_index_ = 0; } +/* + Certain spanners have pre-computed X values that lie either in + X-positions or the X key of the alists returned for left-bound-info + and right-bound-info. These are calculated to give the real length + of a spanner (which, because of various padding or overhang properties, + can extend pass or arrive short of a given bound). If possible, we + use these to calculate the spanner's length, and otherwise, we use + the bound. + + For those writing a new spanner, DO NOT use both X-positions and + left-bound-info/right-bound-info. +*/ Real Spanner::spanner_length () const { - Real l = spanned_drul_[LEFT]->relative_coordinate (0, X_AXIS); - Real r = spanned_drul_[RIGHT]->relative_coordinate (0, X_AXIS); + Interval lr = robust_scm2interval (get_property ("X-positions"), + Interval (1, -1)); - if (r < l) + if (lr.is_empty ()) + { + Drul_array bounds (get_property ("left-bound-info"), + get_property ("right-bound-info")); + + for (LEFT_and_RIGHT (d)) + lr[d] = robust_scm2double (ly_assoc_get (ly_symbol2scm ("X"), + bounds[d], SCM_BOOL_F), -d); + } + + if (lr.is_empty ()) + { + for (LEFT_and_RIGHT (d)) + lr[d] = spanned_drul_[d]->relative_coordinate (0, X_AXIS); + } + + if (lr.is_empty ()) programming_error ("spanner with negative length"); - return r - l; + return lr.length (); } System * @@ -271,8 +307,8 @@ Spanner::broken_neighbor (Direction d) const if (!original_) return 0; - vsize k = broken_spanner_index (this); - Spanner *orig = dynamic_cast (original_); + vsize k = get_break_index (); + Spanner *orig = dynamic_cast (original_); int j = int (k) + d; if (j < 0 || vsize (j) >= orig->broken_intos_.size ()) return 0; @@ -298,44 +334,21 @@ Spanner::is_broken () const return broken_intos_.size (); } -/* - If this is a broken spanner, return the amount the left end is to be - shifted horizontally so that the spanner starts after the initial - clef and key on the staves. This is necessary for ties, slurs, - crescendo and decrescendo signs, for example. -*/ -Real -Spanner::get_broken_left_end_align () const -{ - Paper_column *sc = dynamic_cast (spanned_drul_[LEFT]->get_column ()); - - // Relevant only if left span point is first column in line - if (sc != NULL - && sc->break_status_dir () == RIGHT) - { - /* - We used to do a full search for the Break_align_item. - But that doesn't make a difference, since the Paper_column - is likely to contain only a Break_align_item. - */ - return sc->extent (sc, X_AXIS)[RIGHT]; - } - - return 0.0; -} - void Spanner::derived_mark () const { - Direction d = LEFT; - do + scm_gc_mark (pure_property_cache_); + + for (LEFT_and_RIGHT (d)) if (spanned_drul_[d]) scm_gc_mark (spanned_drul_[d]->self_scm ()); - while (flip (&d) != LEFT) - ; + ; - for (vsize i = broken_intos_.size (); i--;) - scm_gc_mark (broken_intos_[i]->self_scm ()); + // If break_index_ is -1, broken_intos_ might not yet have run its + // constructor and any access might break things. + if (break_index_ != (vsize)-1) + for (vsize i = broken_intos_.size (); i--;) + scm_gc_mark (broken_intos_[i]->self_scm ()); } /* @@ -357,71 +370,130 @@ MAKE_SCHEME_CALLBACK (Spanner, set_spacing_rods, 1); SCM Spanner::set_spacing_rods (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = unsmob (smob); SCM num_length = me->get_property ("minimum-length"); - if (scm_is_number (num_length)) + SCM broken_length = me->get_property ("minimum-length-after-break"); + if (scm_is_number (num_length) + || scm_is_number (broken_length)) { - Rod r; Spanner *sp = dynamic_cast (me); System *root = get_root_system (me); - Drul_array bounds (sp->get_bound (LEFT), - sp->get_bound (RIGHT)); + Drul_array bounds (sp->get_bound (LEFT), + sp->get_bound (RIGHT)); if (!bounds[LEFT] || !bounds[RIGHT]) - return SCM_UNSPECIFIED; - - vector cols (root->broken_col_range (bounds[LEFT]->get_column (), - bounds[RIGHT]->get_column ())); + return SCM_UNSPECIFIED; + + vector cols (root->broken_col_range (bounds[LEFT]->get_column (), + bounds[RIGHT]->get_column ())); if (cols.size ()) - { - Rod r ; - r.item_drul_[LEFT] = sp->get_bound (LEFT); - r.item_drul_[RIGHT] = cols[0]->find_prebroken_piece (LEFT); - r.distance_ = robust_scm2double (num_length, 0); - r.add_to_cols (); - - r.item_drul_[LEFT] = cols.back ()->find_prebroken_piece (RIGHT); - r.item_drul_[RIGHT] = sp->get_bound (RIGHT); - r.add_to_cols (); - } - + { + Rod r; + r.item_drul_[LEFT] = sp->get_bound (LEFT); + r.item_drul_[RIGHT] = cols[0]->find_prebroken_piece (LEFT); + r.distance_ = robust_scm2double (num_length, 0); + r.add_to_cols (); + + r.item_drul_[LEFT] = cols.back ()->find_prebroken_piece (RIGHT); + r.item_drul_[RIGHT] = sp->get_bound (RIGHT); + if (scm_is_number (broken_length)) + /* + r.distance_ may have been modified by add_to_cols () + above. For treatment of minimum-distance-after-break + consistent with minimum-distance (which will use the + changed value), we cannot directly reset r.distance_ to + broken_length. + */ + r.distance_ += robust_scm2double (broken_length, 0) - + robust_scm2double (num_length, 0); + r.add_to_cols (); + } + + Rod r; + /* + As r is a fresh rod, we can set distance_ with no complication. + */ r.distance_ = robust_scm2double (num_length, 0); r.item_drul_[LEFT] = sp->get_bound (LEFT); r.item_drul_[RIGHT] = sp->get_bound (RIGHT); r.add_to_cols (); + + /* + We do not know yet if the spanner is going to have a bound that is + broken. To account for this uncertainty, we add the rod twice: + once for the central column (see above) and once for the left column + (see below). As end_rods_ are never used when rods_ are used and vice + versa, this rod will only be accessed once for each spacing + configuraiton before line breaking. Then, as a grob never exists in + both unbroken and broken forms after line breaking, only one of these + two rods will be in the column vector used for spacing in + simple-spacer.cc get_line_confugration. + */ + if (Item *left_pbp = sp->get_bound (RIGHT)->find_prebroken_piece (LEFT)) + { + r.item_drul_[RIGHT] = left_pbp; + r.add_to_cols (); + } } - + return SCM_UNSPECIFIED; } -/* - Return I such that SP == SP->ORIGINAL ()->BROKEN_INTOS_[I]. -*/ -int -broken_spanner_index (Spanner const *sp) +MAKE_SCHEME_CALLBACK (Spanner, calc_normalized_endpoints, 1); +SCM +Spanner::calc_normalized_endpoints (SCM smob) { - Spanner *parent = dynamic_cast (sp->original ()); - /* ugh: casting */ - return find (parent->broken_intos_, (Spanner*) sp) - parent->broken_intos_.begin (); -} + Spanner *me = unsmob (smob); + SCM result = SCM_EOL; -Spanner * -unsmob_spanner (SCM s) -{ - return dynamic_cast (unsmob_grob (s)); + Spanner *orig = dynamic_cast (me->original ()); + + orig = orig ? orig : me; + + if (orig->is_broken ()) + { + Real total_width = 0.0; + vector span_data; + + for (vsize i = 0; i < orig->broken_intos_.size (); i++) + span_data.push_back (orig->broken_intos_[i]->spanner_length ()); + + vector unnormalized_endpoints; + + for (vsize i = 0; i < span_data.size (); i++) + { + unnormalized_endpoints.push_back (Interval (total_width, total_width + span_data[i])); + total_width += span_data[i]; + } + + for (vsize i = 0; i < unnormalized_endpoints.size (); i++) + { + SCM t = ly_interval2scm (1 / total_width * unnormalized_endpoints[i]); + orig->broken_intos_[i]->set_property ("normalized-endpoints", t); + if (me->get_break_index () == i) + result = t; + } + } + else + { + result = scm_cons (scm_from_double (0.0), scm_from_double (1.0)); + orig->set_property ("normalized-endpoints", result); + } + + return result; } MAKE_SCHEME_CALLBACK (Spanner, bounds_width, 1); SCM Spanner::bounds_width (SCM grob) { - Spanner *me = unsmob_spanner (grob); + Spanner *me = unsmob (grob); Grob *common = me->get_bound (LEFT)->common_refpoint (me->get_bound (RIGHT), X_AXIS); Interval w (me->get_bound (LEFT)->relative_coordinate (common, X_AXIS), - me->get_bound (RIGHT)->relative_coordinate (common, X_AXIS)); - + me->get_bound (RIGHT)->relative_coordinate (common, X_AXIS)); + w -= me->relative_coordinate (common, X_AXIS); return ly_interval2scm (w); @@ -431,8 +503,7 @@ MAKE_SCHEME_CALLBACK (Spanner, kill_zero_spanned_time, 1); SCM Spanner::kill_zero_spanned_time (SCM grob) { - Spanner *me = unsmob_spanner (grob); - Interval_t moments = me->spanned_time (); + Spanner *me = unsmob (grob); /* Remove the line or hairpin at the start of the line. For piano voice indicators, it makes no sense to have them at @@ -448,22 +519,53 @@ Spanner::kill_zero_spanned_time (SCM grob) --hwn. */ - if (moments.length () == Moment (0, 0)) - me->suicide (); + if (me->get_bound (LEFT)->break_status_dir ()) + { + Interval_t moments = me->spanned_time (); + moments [LEFT].grace_part_ = 0; + if (moments.length () == Moment (0, 0)) + me->suicide (); + } return SCM_UNSPECIFIED; } -ADD_INTERFACE (Spanner, - "Some objects are horizontally spanned between objects. For" - " example, slurs, beams, ties, etc. These grobs form a subtype" - " called @code{Spanner}. All spanners have two span points" - " (these must be @code{Item} objects), one on the left and one" - " on the right. The left bound is also the X@tie{}reference" - " point of the spanner.", - - /* properties */ - "minimum-length " - "to-barline " - ); +SCM +Spanner::get_cached_pure_property (SCM sym, int start, int end) +{ + // The pure property cache is indexed by (name start . end), where name is + // a symbol, and start and end are numbers referring to the starting and + // ending column ranks of the current line. + if (scm_is_false (scm_hash_table_p (pure_property_cache_))) + return SCM_UNDEFINED; + + SCM key = scm_cons (sym, scm_cons (scm_from_int (start), scm_from_int (end))); + return scm_hash_ref (pure_property_cache_, key, SCM_UNDEFINED); +} +void +Spanner::cache_pure_property (SCM sym, int start, int end, SCM val) +{ + if (scm_is_false (scm_hash_table_p (pure_property_cache_))) + pure_property_cache_ = scm_c_make_hash_table (17); + + SCM key = scm_cons (sym, scm_cons (scm_from_int (start), scm_from_int (end))); + scm_hash_set_x (pure_property_cache_, key, val); +} + +ADD_INTERFACE (Spanner, + "Some objects are horizontally spanned between objects. For" + " example, slurs, beams, ties, etc. These grobs form a subtype" + " called @code{Spanner}. All spanners have two span points" + " (these must be @code{Item} objects), one on the left and one" + " on the right. The left bound is also the X@tie{}reference" + " point of the spanner.", + + /* properties */ + "normalized-endpoints " + "minimum-length " + "minimum-length-after-break " + "spanner-broken " + "spanner-id " + "to-barline " + );