source file of the GNU LilyPond music typesetter
- (c) 1996,1997 Han-Wen Nienhuys <hanwen@stack.nl>
+ (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
-#include "debug.hh"
#include "spanner.hh"
-#include "p-col.hh"
-#include "p-score.hh"
-IMPLEMENT_IS_TYPE_B1(Spanner,Score_elem);
+#include "pointer-group-interface.hh"
+#include "libc-extension.hh"
+#include "paper-column.hh"
+#include "paper-column.hh"
+#include "paper-score.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 col ";
- if (broken_into_l_arr_.size())
- DOUT << "with broken pieces\n";
-#endif
+ return new Spanner (*this, count);
}
void
-Spanner::break_into_pieces ()
-{
- if (broken_into_l_arr_.size())
- return;
-
- Item * left = spanned_drul_[LEFT];
- Item * right = spanned_drul_[RIGHT];
-
-
- Link_array<Item> break_cols = pscore_l_->broken_col_range (left,right);
- Link_array<Spanner> broken_into_l_arr;
-
- break_cols.insert (left,0);
- break_cols.push (right);
-
- for (int i=1; i < break_cols.size(); i++)
+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++)
+ {
+ if (Spanner *parent = dynamic_cast<Spanner *> (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 ().c_str (),
+ parent->name ().c_str ()));
+ }
+ }
+ }
+
+ 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<Spanner *> (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_back (span);
+ }
+ }
+ while ((flip (&d)) != LEFT);
+ }
+ else
{
- Spanner* span_p = clone()->spanner ();
- left = break_cols[i-1];
- right = break_cols[i];
- if (!right->line_l())
- right = right->find_prebroken_piece(-1);
- if (!left->line_l())
- left = left->find_prebroken_piece(1);
-
- assert (left&&right && left->line_l() == right->line_l());
-
- span_p->set_bounds(LEFT,left);
- span_p->set_bounds(RIGHT,right);
-
- pscore_l_->typeset_broken_spanner (span_p);
- broken_into_l_arr.push (span_p);
+ System *root = get_root_system (this);
+ vector<Item*> break_points = root->broken_col_range (left, right);
+
+ break_points.insert (break_points.begin () + 0, left);
+ break_points.push_back (right);
+
+ for (vsize 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 (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
+ {
+ bounds[LEFT]->get_system ()->typeset_grob (span);
+ broken_intos_.push_back (span);
+ }
+ }
}
-
- broken_into_l_arr_ = broken_into_l_arr;
+ vector_sort (broken_intos_, Spanner::compare);
+ 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(-i));
- }
- while ((i*=-1) != 1);
-}
-
+ if (!spanned_drul_[i]->get_system ())
+ set_bound (i, spanned_drul_[i]->find_prebroken_piece ((Direction) -i));
+ }
+ while (flip (&i) != LEFT);
+}
-void
-Spanner::set_bounds(Direction d, Item*i)
+Interval_t<int>
+Spanner::spanned_rank_iv ()
{
-
- 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);
+ Interval_t<int> iv (0, 0);
- assert (!spanned_drul_[d] ||
- spanned_drul_[Direction(-d)] != spanned_drul_[d]);
+ 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::do_break_processing()
+Spanner::set_bound (Direction d, Grob *s)
{
- if (!line_l())
- {
- break_into_pieces ();
- for (int i=0; i < broken_into_l_arr_.size(); i++)
- broken_into_l_arr_[i]->handle_broken_dependencies();
- }
- else
+ Item *i = dynamic_cast<Item *> (s);
+ if (!i)
{
- handle_broken_dependencies();
+ programming_error ("must have Item for spanner bound");
+ return;
}
-}
+ spanned_drul_[d] = i;
-Spanner::Spanner()
+ /**
+ 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 (SCM s, Object_key const *key)
+ : Grob (s, key)
{
- spanned_drul_[LEFT]=0;
- spanned_drul_[RIGHT]=0;
+ break_index_ = 0;
+ spanned_drul_[LEFT] = 0;
+ spanned_drul_[RIGHT] = 0;
}
-String
-Spanner::do_TeX_output_str () const
+Spanner::Spanner (Spanner const &s, int count)
+ : Grob (s, count)
{
- Offset left_off (spanned_drul_[LEFT]->absolute_coordinate(X_AXIS), 0);
- return make_TeX_string (absolute_offset() + left_off);
+ 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);
- assert (r>=l);
-
- return Interval (0, r-l);
+ 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");
+
+ 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::compare);
+ if (idx != VPOS)
+ return broken_intos_ [idx];
+ return 0;
+}
-Spanner*
-Spanner::find_broken_piece (Line_of_score*l) const
+int
+Spanner::compare (Spanner *const &p1, Spanner *const &p2)
{
- 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];
- return 0;
-
+ return p1->get_system ()->get_rank () - p2->get_system ()->get_rank ();
}
bool
-Spanner::broken_b() const
+Spanner::is_broken () const
{
- return broken_into_l_arr_.size();
+ return broken_intos_.size ();
}
-void
-Spanner::do_unlink()
+/*
+ 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
{
- if (spanned_drul_[LEFT])
- {
- spanned_drul_[LEFT]->attached_span_l_arr_.substitute (this,0);
- spanned_drul_[LEFT] =0;
- }
- if (spanned_drul_[RIGHT])
+ 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)
{
- spanned_drul_[RIGHT]->attached_span_l_arr_.substitute (this,0);
- spanned_drul_[RIGHT] = 0;
+ /*
+ 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
+ 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_junk_links()
+add_bound_item (Spanner *sp, Grob *it)
{
- spanned_drul_[LEFT] = spanned_drul_[RIGHT] =0;
+ 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)
+{
+ Grob *me = unsmob_grob (smob);
+
+ Rod r;
+ Spanner *sp = dynamic_cast<Spanner *> (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;
+}
+
+/*
+ Return I such that SP == SP->ORIGINAL ()->BROKEN_INTOS_[I].
+*/
+int
+broken_spanner_index (Spanner *sp)
+{
+ Spanner *parent = dynamic_cast<Spanner *> (sp->original ());
+ return find (parent->broken_intos_, sp) - parent->broken_intos_.begin ();
+}
+
+Spanner *
+unsmob_spanner (SCM s)
+{
+ return dynamic_cast<Spanner *> (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");
projects / lilypond.git / blobdiff