source file of the GNU LilyPond music typesetter
- (c) 1996, 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1996--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
+#include <math.h>
+#include <libc-extension.hh>
-#include "debug.hh"
+
+#include "warn.hh"
#include "spanner.hh"
#include "paper-column.hh"
#include "paper-score.hh"
#include "molecule.hh"
#include "paper-outputter.hh"
+#include "paper-column.hh"
+#include "system.hh"
+#include "group-interface.hh"
void
-Spanner::do_print() const
-{
-#ifndef NPRINT
- DOUT << "Between " << classname (spanned_drul_[LEFT])
- << " and " << classname (spanned_drul_[RIGHT]) << '\n';
-
- if (broken_b ())
- DOUT << "Broken in " << to_str (broken_into_l_arr_.size ()) << " pieces";
-#endif
-}
-
-void
-Spanner::break_into_pieces ()
+Spanner::do_break_processing ()
{
- if (broken_b ())
- return;
-
+ //break_into_pieces
Item * left = spanned_drul_[LEFT];
Item * right = spanned_drul_[RIGHT];
+
+ if (!left || !right)
+ return;
- if (left == right)
+ /*
+ 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<Spanner*> (get_parent ((Axis)a)))
+ {
+ if (!parent->spanned_rank_iv ().contains_b (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<Item> break_points = pscore_l_->broken_col_range (left,right);
-
- break_points.insert (left,0);
- break_points.push (right);
+ if (get_system () || broken_b ())
+ 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);
-
- assert (pc_l);
- if (!info.line_l_)
- info.line_l_ = pc_l-> line_l ();
- else
- assert( info.line_l_ = pc_l->line_l ());
-
+ Item* bound = left->find_prebroken_piece (d);
+ if (!bound)
+ programming_error ("no broken bound");
+ else if (bound->get_system ())
+ {
+ Spanner * span = dynamic_cast<Spanner*> (clone ());
+ 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);
+ while ((flip (&d))!= LEFT);
+ }
+ else
+ {
+ Link_array<Item> break_points = pscore_->system_->broken_col_range (left,right);
+
+ break_points.insert (left,0);
+ break_points.push (right);
- Spanner *span_p = dynamic_cast<Spanner*>(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();
+ for (int i=1; i < break_points.size (); i++)
+ {
+ Drul_array<Item*> 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<Spanner*> (clone ());
+ span->set_bound (LEFT,bounds[LEFT]);
+ span->set_bound (RIGHT,bounds[RIGHT]);
- broken_into_l_arr_.push (span_p);
+ 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 (span);
+ }
+ }
}
+ 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;
+ Direction i = (Direction) LEFT;
do
{
- if (!spanned_drul_[i]->line_l())
- set_bounds(i,spanned_drul_[i]->find_prebroken_piece((Direction)-i));
+ if (!spanned_drul_[i]->get_system ())
+ set_bound (i,spanned_drul_[i]->find_prebroken_piece ((Direction) -i));
}
- while (flip(&i) != 1);
+ while (flip (&i) != LEFT);
}
-void
-Spanner::set_bounds(Direction d, Item*i)
+Interval_t<int>
+Spanner::spanned_rank_iv ()
{
- spanned_drul_[d] =i;
- if (i)
+ Interval_t<int> iv (0, 0);
+
+ if (spanned_drul_[LEFT])
{
- i->used_b_ = true;
+ iv[LEFT] = Paper_column::get_rank (spanned_drul_[LEFT]->get_column ());
}
-
- if (d== LEFT)
+ if (spanned_drul_[RIGHT])
{
- dim_cache_[X_AXIS]->parent_l_ = i->dim_cache_[X_AXIS];
+ iv[RIGHT] = Paper_column::get_rank (spanned_drul_[RIGHT]->get_column ());
}
-
- if (spanned_drul_[Direction(-d)] == spanned_drul_[d]
- && i)
- warning (_f ("Spanner `%s\' with equal left and right spanpoints", classname (this)));
+ 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::do_break_processing()
+Spanner::set_bound (Direction d, Grob*s)
{
- if (!line_l())
- break_into_pieces ();
- else
- handle_broken_dependencies();
+ Item * i = dynamic_cast<Item*> (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<System*> (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<Paper_column*> (i))
+ {
+ Pointer_group_interface::add_grob (i, ly_symbol2scm ("bounded-by-me"), this);
+ }
}
-Spanner::Spanner ()
+Spanner::Spanner (SCM s)
+ : Grob (s)
{
+ break_index_ = 0;
spanned_drul_[LEFT]=0;
spanned_drul_[RIGHT]=0;
+
+ Group_interface::add_thing (this, ly_symbol2scm ("interfaces"), ly_symbol2scm ("spanner-interface"));
}
Spanner::Spanner (Spanner const &s)
- : Score_element (s)
+ : Grob (s)
{
spanned_drul_[LEFT] = spanned_drul_[RIGHT] =0;
}
-
-Interval
-Spanner::do_width() const
+Real
+Spanner::spanner_length () const
{
- Real l = spanned_drul_[LEFT]->absolute_coordinate (X_AXIS);
- Real r = spanned_drul_[RIGHT]->absolute_coordinate (X_AXIS);
+ Real l = spanned_drul_[LEFT]->relative_coordinate (0, X_AXIS);
+ Real r = spanned_drul_[RIGHT]->relative_coordinate (0, X_AXIS);
if (r< l)
- warning ("Spanner with negative length");
-
- return Interval (0, r-l);
+ programming_error ("spanner with negative length");
+
+ 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_into_l_arr_.size (); i++)
- {
- if (broken_into_l_arr_[i]->line_l () == l)
- return broken_into_l_arr_[i];
- }
+ int idx = binsearch_links (broken_intos_, (Spanner*)l, Spanner::compare);
+
+ 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 ()->rank_ - p2->get_system ()->rank_;
}
bool
-Spanner::broken_b() const
+Spanner::broken_b () const
{
- return broken_into_l_arr_.size();
+ return broken_intos_.size ();
}
-Array<Rod>
-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<Rod> r;
- return r;
+ Paper_column *sc = dynamic_cast<Paper_column*> (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<Spring>
-Spanner::get_springs () const
+SCM
+Spanner::do_derived_mark () const
{
- Array<Spring> s;
- return s;
+ /*
+ We'd be fucked if this is called before spanned_drul_[] is inited. */
+ if (status_ == ORPHAN)
+ return SCM_EOL;
+
+ 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 ());
+
+ return SCM_EOL;
}
+
+/*
+ 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<Rod> 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<Spring> 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<Spanner*> (me);
+ r.item_l_drul_[LEFT] = sp->get_bound (LEFT);
+ r.item_l_drul_[RIGHT] = sp->get_bound (RIGHT);
+ r.distance_ =
+ robust_scm2double (me->get_grob_property ("minimum-length"), 0);
+
+ r.add_to_cols ();
+ return SCM_UNSPECIFIED;
}
+
/*
- UGH.
+ Return I such that SP == SP->ORIGINAL_->BROKEN_INTOS_[I].
*/
-void
-Spanner::handle_broken_dependents ()
+int
+broken_spanner_index (Spanner * sp)
{
- Spanner *unbrok = dynamic_cast<Spanner*> (original_l_);
- if (!unbrok || dim_cache_[Y_AXIS]->parent_l_)
- return;
-
- Spanner *refpoint = dynamic_cast<Spanner*> (unbrok->parent_l (Y_AXIS));
-
- if (refpoint)
- {
- Spanner * broken_refpoint = refpoint->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.");
- }
+ Spanner * parent = dynamic_cast<Spanner*> (sp->original_);
+ return parent->broken_intos_.find_index (sp);
+}
+
+
+Spanner*
+unsmob_spanner (SCM s )
+{
+ return dynamic_cast<Spanner*> (unsmob_grob (s));
}
+
+ADD_INTERFACE(Spanner,
+ "spanner-interface",
+"Other grobs have a shape that depends on the horizontal spacing. 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}s), 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");