X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fspanner.cc;h=590c4d9473678009630ea353dc503f99632daa22;hb=6e227b10eed0ebe522ca7512eb7d2cc1d9561e64;hp=4d4659f66aa0d43b3ea0e9963234ac1cae21484b;hpb=ad4297de0246935caa4c51f4e152e20009a6f64e;p=lilypond.git diff --git a/lily/spanner.cc b/lily/spanner.cc index 4d4659f66a..590c4d9473 100644 --- a/lily/spanner.cc +++ b/lily/spanner.cc @@ -3,236 +3,358 @@ source file of the GNU LilyPond music typesetter - (c) 1996, 1997--1999 Han-Wen Nienhuys + (c) 1996--2005 Han-Wen Nienhuys */ -#include "debug.hh" #include "spanner.hh" + +#include + +#include "pointer-group-interface.hh" +#include "libc-extension.hh" +#include "paper-column.hh" #include "paper-column.hh" #include "paper-score.hh" -#include "molecule.hh" -#include "paper-outputter.hh" +#include "stencil.hh" +#include "system.hh" +#include "warn.hh" -void -Spanner::do_print() const +Grob * +Spanner::clone (int count) const { -#ifndef NPRINT - DOUT << "Between " << classname (spanned_drul_[LEFT]) - << " and " << classname (spanned_drul_[RIGHT]) << '\n'; - - if (broken_b ()) - DOUT << "Broken in " << to_str (broken_info_.size ()) << " pieces"; -#endif + return new Spanner (*this, count); } void -Spanner::break_into_pieces () -{ - if (broken_b ()) - return; - - Item * left = spanned_drul_[LEFT]; - Item * right = spanned_drul_[RIGHT]; - - if (left == right) +Spanner::do_break_processing () +{ + //break_into_pieces + Item *left = spanned_drul_[LEFT]; + Item *right = spanned_drul_[RIGHT]; + + if (!left || !right) + return; + + /* + Check if our parent in X-direction spans equally wide + or wider than we do. + */ + for (int a = X_AXIS; a < NO_AXES; a++) { - warning (_ ("left spanpoint is right spanpoint\n")); - return; + if (Spanner *parent = dynamic_cast (get_parent ((Axis)a))) + { + if (!parent->spanned_rank_iv ().superset (this->spanned_rank_iv ())) + { + programming_error (to_string ("Spanner `%s' is not fully contained in parent spanner `%s'.", + name ().to_str0 (), + parent->name ().to_str0 ())); + } + } } - - Link_array break_points = pscore_l_->broken_col_range (left,right); - break_points.insert (left,0); - break_points.push (right); + if (get_system () || is_broken ()) + return; - for (int i=1; i < break_points.size(); i++) + 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 (broken_intos_.size ())); + span->set_bound (LEFT, bound); + span->set_bound (RIGHT, bound); + + assert (span->get_system ()); + span->get_system ()->typeset_grob (span); + broken_intos_.push (span); + } + } + while ((flip (&d)) != LEFT); + } + else + { + Link_array break_points = pscore_->root_system ()->broken_col_range (left, right); - assert (pc_l); - if (!info.line_l_) - info.line_l_ = pc_l-> line_l (); + break_points.insert (left, 0); + break_points.push (right); + + for (int 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; + } + + Spanner *span = dynamic_cast (clone (broken_intos_.size ())); + 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 - assert( info.line_l_ = pc_l->line_l ()); - + { + bounds[LEFT]->get_system ()->typeset_grob (span); + broken_intos_.push (span); + } } - while ((flip(&d))!= LEFT); - info.broken_spanner_l_ = 0; - broken_info_.push (info); } + broken_intos_.sort (Spanner::compare); + for (int i = broken_intos_.size ();i--;) + broken_intos_[i]->break_index_ = i; +} + +int +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_iv () +{ + Interval_t iv (0, 0); + + 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; +} + +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::set_bounds(Direction d, Item*i) +Spanner::set_bound (Direction d, Grob *s) { - spanned_drul_[d] =i; - if (i) + Item *i = dynamic_cast (s); + if (!i) + { + programming_error ("must have Item for spanner bound"); + 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)) { - i->used_b_ = true; + set_parent (i, X_AXIS); } - if (d== LEFT) + /* + 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)) { - dim_cache_[X_AXIS]->parent_l_ = i->dim_cache_[X_AXIS]; + Pointer_group_interface::add_grob (i, ly_symbol2scm ("bounded-by-me"), this); } - - if (spanned_drul_[Direction(-d)] == spanned_drul_[d] - && i) - warning (_f ("Spanner `%s\' with equal left and right spanpoints", classname (this))); } -void -Spanner::do_break_processing() +Spanner::Spanner (SCM s, Object_key const *key) + : Grob (s, key) { - if (!line_l()) - break_into_pieces (); - else - handle_broken_dependencies(); + break_index_ = 0; + spanned_drul_[LEFT] = 0; + spanned_drul_[RIGHT] = 0; } -Spanner::Spanner () +Spanner::Spanner (Spanner const &s, int count) + : Grob (s, count) { - spanned_drul_[LEFT]=0; - spanned_drul_[RIGHT]=0; + spanned_drul_[LEFT] = spanned_drul_[RIGHT] = 0; } -Spanner::Spanner (Spanner const &s) - : Score_element (s) +Real +Spanner::spanner_length () const { - spanned_drul_[LEFT] = spanned_drul_[RIGHT] =0; -} + Real l = spanned_drul_[LEFT]->relative_coordinate (0, X_AXIS); + Real r = spanned_drul_[RIGHT]->relative_coordinate (0, X_AXIS); + if (r < l) + programming_error ("spanner with negative length"); -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) - 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 (); } - -Spanner* -Spanner::find_broken_piece (Line_of_score*l) const +Grob * +Spanner::find_broken_piece (System *l) 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->set_bounds(LEFT,info.bounds_[LEFT]); - span_p->set_bounds(RIGHT,info.bounds_[RIGHT]); - pscore_l_->typeset_element (span_p); - - info.broken_spanner_l_ = span_p; - span_p->handle_broken_dependencies(); + int idx = binsearch_links (broken_intos_, (Spanner *)l, Spanner::compare); - } - return info.broken_spanner_l_; - } - } + if (idx < 0) + return 0; + else + return broken_intos_ [idx]; +} - return 0; +int +Spanner::compare (Spanner *const &p1, Spanner *const &p2) +{ + return p1->get_system ()->get_rank() - p2->get_system ()->get_rank(); } bool -Spanner::broken_b() const +Spanner::is_broken () const { - return broken_info_.size(); + return broken_intos_.size (); } -Array -Spanner::get_rods () const +/* + 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 { - Array r; - return r; + 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_springs () const +void +Spanner::derived_mark () const { - Array s; - return s; + Direction d = LEFT; + do + if (spanned_drul_[d]) + scm_gc_mark (spanned_drul_[d]->self_scm ()); + while (flip (&d) != LEFT) + ; + + for (int 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) { - Array rs (get_rods ()); - for (int i=0; i < rs.size (); i++) - { - rs[i].add_to_cols (); - } + if (!sp->get_bound (LEFT)) + sp->set_bound (LEFT, it); + else + sp->set_bound (RIGHT, it); +} - Array ss (get_springs ()); - for (int i=0; i < ss.size (); i++) - { - ss[i].add_to_cols (); - } +MAKE_SCHEME_CALLBACK (Spanner, set_spacing_rods, 1); +SCM +Spanner::set_spacing_rods (SCM smob) +{ + Grob *me = unsmob_grob (smob); + + Rod r; + Spanner *sp = dynamic_cast (me); + r.item_drul_[LEFT] = sp->get_bound (LEFT); + r.item_drul_[RIGHT] = sp->get_bound (RIGHT); + r.distance_ + = robust_scm2double (me->get_property ("minimum-length"), 0); + + r.add_to_cols (); + return SCM_UNSPECIFIED; } -void -Spanner::handle_broken_dependents () +/* + Return I such that SP == SP->ORIGINAL_->BROKEN_INTOS_[I]. +*/ +int +broken_spanner_index (Spanner *sp) { -#if 0 // need to remove delayd breaking. - if (original_l_ && !original_l_->line_l ()) - { - - /* we're the broken pieces of a spanner. - Check if our Y-leaning point is sane. - */ - Dimension_cache *d = dim_cache_[Y_AXIS]->parent_l_; - if (d) - return; - - Score_element * ref_elt = dynamic_cast(d->element_l()); - Spanner *ref_span = dynamic_cast (ref_elt); - if (!ref_elt->line_l () && ref_span) - { - Spanner *broken_refpoint = ref_span->find_broken_piece (line_l ()); - if (broken_refpoint) - dim_cache_[Y_AXIS]->parent_l_ = broken_refpoint->dim_cache_[Y_AXIS]; - else - programming_error ("Spanner y -refpoint lost."); - } - } -#endif + Spanner *parent = dynamic_cast (sp->original_); + return parent->broken_intos_.find_index (sp); +} + +Spanner * +unsmob_spanner (SCM s) +{ + return dynamic_cast (unsmob_grob (s)); } + +ADD_INTERFACE (Spanner, + "spanner-interface", + "Some objects are horizontally spanned between objects. For\n" + "example, slur, beam, tie, etc. These grobs form a subtype called\n" + "@code{Spanner}. All spanners have two span-points (these must be\n" + "@code{Item} objects), one on the left and one on the right. The left bound is\n" + "also the X-reference point of the spanner.\n", + "minimum-length");