X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fspanner.cc;h=12346042df772cbb88f0b4380470ba0a1fe14391;hb=d8a0cd4ba54a7a1911364919d195b31bebcb3935;hp=f829026a6c4d4764fa9027b4fe022c793a1837a4;hpb=73be5f6fe264e90a56e45f2d70129b133731188b;p=lilypond.git diff --git a/lily/spanner.cc b/lily/spanner.cc index f829026a6c..12346042df 100644 --- a/lily/spanner.cc +++ b/lily/spanner.cc @@ -3,222 +3,456 @@ source file of the GNU LilyPond music typesetter - (c) 1996, 1997--1999 Han-Wen Nienhuys + (c) 1996--2009 Han-Wen Nienhuys */ -#include "debug.hh" -#include "spanner.hh" -#include "p-col.hh" -#include "p-score.hh" -#include "molecule.hh" -#include "paper-outputter.hh" - - - -void -Spanner::do_print() const +#include "libc-extension.hh" +#include "moment.hh" +#include "paper-column.hh" +#include "paper-score.hh" +#include "pointer-group-interface.hh" +#include "stencil.hh" +#include "system.hh" +#include "warn.hh" + +Grob * +Spanner::clone () const { -#ifndef NPRINT - DOUT << "Between " << classname (spanned_drul_[LEFT]) - << " and " << classname (spanned_drul_[RIGHT]) << '\n'; - /* if (broken_into_l_arr_.size()) - { - DOUT << "with broken pieces:\n"; - for (int i=0; i < broken_into_l_arr_.size (); i++) - broken_into_l_arr_[i]->print (); - }*/ -#endif + return new Spanner (*this); } void -Spanner::break_into_pieces () +Spanner::do_break_processing () { - if (broken_b ()) - return; - - Item * left = spanned_drul_[LEFT]; - Item * right = spanned_drul_[RIGHT]; - - if (left == right) - { - warning (_ ("left spanpoint is right spanpoint\n")); - return; - } - - Link_array break_points = pscore_l_->broken_col_range (left,right); - Link_array broken_into_l_arr; + //break_into_pieces + Item *left = spanned_drul_[LEFT]; + Item *right = spanned_drul_[RIGHT]; - break_points.insert (left,0); - break_points.push (right); + if (!left || !right) + return; - for (int i=1; i < break_points.size(); i++) + if (get_system () || is_broken ()) + return; + + if (left == right) { - Breaking_information info; - info.bounds_[LEFT] = break_points[i-1]; - info.bounds_[RIGHT] = break_points[i]; + /* + 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 *&pc_l = info.bounds_[d] ; - if (!pc_l->line_l()) - pc_l = pc_l->find_prebroken_piece(- 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 (pc_l); - if (!info.line_l_) - info.line_l_ = pc_l-> line_l (); - else - assert( info.line_l_ = pc_l->line_l ()); + assert (span->get_system ()); + span->get_system ()->typeset_grob (span); + broken_intos_.push_back (span); + } + } + while ((flip (&d)) != LEFT); + } + else + { + 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. + */ + 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 ()); + } + + 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); + } } - while ((flip(&d))!= LEFT); - info.broken_spanner_l_ = 0; - broken_info_.push (info); } + vector_sort (broken_intos_, Spanner::less); + for (vsize i = broken_intos_.size (); i--;) + broken_intos_[i]->break_index_ = i; +} + +vsize +Spanner::get_break_index () const +{ + return break_index_; } void -Spanner::set_my_columns() +Spanner::set_my_columns () { - Direction i = (Direction)1; - do + Direction i = (Direction) LEFT; + do { - if (!spanned_drul_[i]->line_l()) - set_bounds(i,spanned_drul_[i]->find_prebroken_piece((Direction)-i)); - } - while (flip(&i) != 1); -} + if (!spanned_drul_[i]->get_system ()) + set_bound (i, spanned_drul_[i]->find_prebroken_piece ((Direction) -i)); + } + while (flip (&i) != LEFT); +} +Interval_t +Spanner::spanned_rank_interval () const +{ + Interval_t iv (0, 0); -void -Spanner::set_bounds(Direction d, Item*i) + if (spanned_drul_[LEFT] && spanned_drul_[LEFT]->get_column ()) + iv[LEFT] = spanned_drul_[LEFT]->get_column ()->get_rank (); + if (spanned_drul_[RIGHT] && spanned_drul_[RIGHT]->get_column ()) + iv[RIGHT] = spanned_drul_[RIGHT]->get_column ()->get_rank (); + return iv; +} + +Interval_t +Spanner::spanned_time () const { - if (spanned_drul_[d]) - spanned_drul_[d]->attached_span_l_arr_.substitute(this,0); - - spanned_drul_[d] =i; - if (i) - i->attached_span_l_arr_.push(this); + return spanned_time_interval (spanned_drul_[LEFT], + spanned_drul_[RIGHT]); +} - if (spanned_drul_[Direction(-d)] == spanned_drul_[d] - && i) - warning (_f ("Spanner `%s\' with equal left and right spanpoints", classname (this))); + +Item * +Spanner::get_bound (Direction d) const +{ + return spanned_drul_[d]; } +/* + Set the items that this spanner spans. If D == LEFT, we also set the + X-axis parent of THIS to S. +*/ void -Spanner::do_break_processing() +Spanner::set_bound (Direction d, Grob *s) { - if (!line_l()) - break_into_pieces (); - else - handle_broken_dependencies(); + Item *i = dynamic_cast (s); + if (!i) + { + programming_error ("must have Item for spanner bound of " + name()); + return; + } + + spanned_drul_[d] = i; + + /** + 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); + + /* + Signal that this column needs to be kept alive. They need to be + kept alive to have meaningful position and linebreaking. + + [maybe we should try keeping all columns alive?, and perhaps + inherit position from their (non-)musical brother] + */ + if (dynamic_cast (i)) + Pointer_group_interface::add_grob (i, ly_symbol2scm ("bounded-by-me"), this); } -Spanner::Spanner () +Spanner::Spanner (SCM s) + : Grob (s) { - unbroken_original_l_ =0; - spanned_drul_[LEFT]=0; - spanned_drul_[RIGHT]=0; + break_index_ = 0; + spanned_drul_.set (0, 0); } Spanner::Spanner (Spanner const &s) - :Score_element (s) + : Grob (s) { - spanned_drul_[LEFT] = spanned_drul_[RIGHT] =0; - unbroken_original_l_ = 0; + spanned_drul_.set (0, 0); } -void -Spanner::output_processing () +Real +Spanner::spanner_length () const { - if (transparent_b_) - return ; - output_p_ = do_brew_molecule_p (); - Offset left_off (spanned_drul_[LEFT]->absolute_coordinate(X_AXIS), 0); - Offset o = absolute_offset() + left_off; - pscore_l_->outputter_l_->output_molecule (output_p_, o, classname (this)); -} + Real l = spanned_drul_[LEFT]->relative_coordinate (0, X_AXIS); + Real r = spanned_drul_[RIGHT]->relative_coordinate (0, X_AXIS); -Interval -Spanner::do_width() const -{ - Real l = spanned_drul_[LEFT]->absolute_coordinate (X_AXIS); - Real r = spanned_drul_[RIGHT]->absolute_coordinate (X_AXIS); + if (r < l) + programming_error ("spanner with negative length"); - if (r< l) - warning ("Spanner with negative length"); - - return Interval (0, r-l); + return r - l; } -Line_of_score * -Spanner::line_l() const +System * +Spanner::get_system () const { if (!spanned_drul_[LEFT] || !spanned_drul_[RIGHT]) return 0; - if (spanned_drul_[LEFT]->line_l() != spanned_drul_[RIGHT]->line_l()) + if (spanned_drul_[LEFT]->get_system () != spanned_drul_[RIGHT]->get_system ()) return 0; - return spanned_drul_[LEFT]->line_l(); + return spanned_drul_[LEFT]->get_system (); } +Grob * +Spanner::find_broken_piece (System *l) const +{ + vsize idx = binary_search (broken_intos_, (Spanner *) l, Spanner::less); + if (idx != VPOS) + return broken_intos_ [idx]; + return 0; +} -Spanner* -Spanner::find_broken_piece (Line_of_score*l) const +Spanner * +Spanner::broken_neighbor (Direction d) const { - for (int i=0; i < broken_info_.size (); i++) - { - Spanner *me =(Spanner*) this; - Breaking_information &info = me->broken_info_[i]; - if (info.line_l_ == l) - { - if (!info.broken_spanner_l_) - { - Spanner *span_p = dynamic_cast(clone ()); - span_p -> unbroken_original_l_ =(Spanner*)this; - span_p->set_bounds(LEFT,info.bounds_[LEFT]); - span_p->set_bounds(RIGHT,info.bounds_[RIGHT]); - pscore_l_->typeset_element (span_p); + if (!original_) + return 0; - - info.broken_spanner_l_ = span_p; - /* if (Axis_group_spanner *ags - = dynamic_cast (span_p)) - { - do something - } - */ - span_p->handle_broken_dependencies(); + vsize k = broken_spanner_index (this); + Spanner *orig = dynamic_cast (original_); + int j = int (k) + d; + if (j < 0 || vsize (j) >= orig->broken_intos_.size ()) + return 0; - } - return info.broken_spanner_l_; - } - } + return orig->broken_intos_[j]; +} + +int +Spanner::compare (Spanner *const &p1, Spanner *const &p2) +{ + return p1->get_system ()->get_rank () - p2->get_system ()->get_rank (); +} - return 0; +bool +Spanner::less (Spanner *const &a, Spanner *const &b) +{ + return a->get_system ()->get_rank () < b->get_system ()->get_rank (); } bool -Spanner::broken_b() const +Spanner::is_broken () const { - return broken_info_.size(); + 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; +} -Array -Spanner::get_rods () const +void +Spanner::derived_mark () const { - Array r; - return r; + Direction d = LEFT; + do + 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 ()); } +/* + Set left or right bound to IT. + + Warning: caller should ensure that subsequent calls put in ITems + that are left-to-right ordered. +*/ void -Spanner::do_space_processing () +add_bound_item (Spanner *sp, Grob *it) +{ + if (!sp->get_bound (LEFT)) + sp->set_bound (LEFT, it); + else + sp->set_bound (RIGHT, it); +} + +MAKE_SCHEME_CALLBACK (Spanner, set_spacing_rods, 1); +SCM +Spanner::set_spacing_rods (SCM smob) { - Array rs (get_rods ()); - for (int i=0; i < rs.size (); i++) + Grob *me = unsmob_grob (smob); + SCM num_length = me->get_property ("minimum-length"); + if (scm_is_number (num_length)) { - rs[i].add_to_cols (); + Rod r; + Spanner *sp = dynamic_cast (me); + System *root = get_root_system (me); + 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 ())); + + 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 (); + } + + 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 (); } + + return SCM_UNSPECIFIED; +} + +/* + Return I such that SP == SP->ORIGINAL ()->BROKEN_INTOS_[I]. +*/ +int +broken_spanner_index (Spanner const *sp) +{ + Spanner *parent = dynamic_cast (sp->original ()); + /* ugh: casting */ + return find (parent->broken_intos_, (Spanner*) sp) - parent->broken_intos_.begin (); +} + +Spanner * +unsmob_spanner (SCM s) +{ + return dynamic_cast (unsmob_grob (s)); +} + +MAKE_SCHEME_CALLBACK (Spanner, bounds_width, 1); +SCM +Spanner::bounds_width (SCM grob) +{ + Spanner *me = unsmob_spanner (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)); + + w -= me->relative_coordinate (common, X_AXIS); + + return ly_interval2scm (w); } + +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 (); + /* + Remove the line or hairpin at the start of the line. For + piano voice indicators, it makes no sense to have them at + the start of the line. + + I'm not sure what the official rules for glissandi are, but + usually the 2nd note of the glissando is "exact", so when playing + from the start of the line, there is no need to glide. + + From a typographical p.o.v. this makes sense, since the amount of + space left of a note at the start of a line is very small. + + --hwn. + + */ + 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 " + ); +