]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spanner.cc
release: 1.5.29
[lilypond.git] / lily / spanner.cc
index 5cc28a1bd94d81301481d708ae2432d925482894..d8c0e49935c5a676f1fcdbf43b9765c00a170ad2 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996,1997 Han-Wen Nienhuys <hanwen@stack.nl>
+  (c) 1996--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
+#include <math.h>
+#include <libc-extension.hh>
+
 
 #include "debug.hh"
 #include "spanner.hh"
-#include "p-col.hh"
-#include "p-score.hh"
-
-IMPLEMENT_STATIC_NAME(Spanner);
-IMPLEMENT_IS_TYPE_B1(Spanner,Score_elem);
+#include "paper-column.hh"
+#include "paper-score.hh"
+#include "molecule.hh"
+#include "paper-outputter.hh"
+#include "paper-column.hh"
+#include "line-of-score.hh"
+#include "break-align-item.hh"
+#include "group-interface.hh"
 
 void
-Spanner::do_print()const
-{
-#ifndef NPRINT
-    mtor << "Between col ";
-// huh? this does not work 
-//    mtor << ( left_col_l_ ? left_col_l_->rank_i() : "nop" );
-    if ( left_col_l_ )
-       mtor << left_col_l_->rank_i();
-    else 
-       mtor << "nop";
-    mtor << ", ";
-//    mtor << ( right_col_l_ ? right_col_l_->rank_i() : "nop" );
-    if ( right_col_l_ )
-       mtor << right_col_l_->rank_i();
-    else 
-       mtor << "nop";
-    if (broken_into_l_arr_.size())
-       mtor << "with broken pieces\n";
-#endif
+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 ().contains_b (this->spanned_rank_iv ()))
+           {
+             programming_error (to_str ("Spanner `%s' is not fully contained in parent spanner `%s'.",
+                                        name ().ch_C (),
+                                        parent->name ().ch_C ()));
+           }
+       }
+    }
+  
+  if (line_l () || broken_b ())
+    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->line_l ())
+           {
+             Spanner * span_p = dynamic_cast<Spanner*> (clone ());
+             span_p->set_bound (LEFT, bound);
+             span_p->set_bound (RIGHT, bound);
+
+             assert (span_p->line_l ()); 
+             span_p->line_l ()->typeset_grob (span_p);
+             broken_into_l_arr_.push (span_p);
+           }
+       }
+      while ((flip (&d))!= LEFT);
+    }
+  else
+    {
+      Link_array<Item> break_points = pscore_l_->line_l_->broken_col_range (left,right);
+
+      break_points.insert (left,0);
+      break_points.push (right);
+
+      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]->line_l ())
+               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_p = dynamic_cast<Spanner*> (clone ());
+         span_p->set_bound (LEFT,bounds[LEFT]);
+         span_p->set_bound (RIGHT,bounds[RIGHT]);
+
+         if (!bounds[LEFT]->line_l () 
+           
+             || !bounds[RIGHT]->line_l ()
+             || bounds[LEFT]->line_l () != bounds[RIGHT]->line_l ())
+           {
+             programming_error ("bounds of spanner are invalid");
+             span_p->suicide ();
+           }
+         else
+           {
+             bounds[LEFT]->line_l ()->typeset_grob (span_p);
+             broken_into_l_arr_.push (span_p);
+           }
+       }
+    }
+  broken_into_l_arr_.sort (Spanner::compare);
 }
 
 void
-Spanner::break_into_pieces()
+Spanner::set_my_columns ()
 {
-    PCol * left = left_col_l_;
-    PCol * right = right_col_l_;
-    if(left->daddy_l_) left = left->daddy_l_;
-    if(right->daddy_l_) right = right->daddy_l_;
-    
-    
-    Link_array<PCol> 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* span_p = clone()->spanner();
-       left = break_cols[i-1];
-       right = break_cols[i];
-       if (!right->line_l_)
-           right = right->prebreak_p_;
-       if (!left->line_l_)
-           left = left->postbreak_p_;
+  Direction i = (Direction) LEFT;
+  do 
+    {
+      if (!spanned_drul_[i]->line_l ())
+       set_bound (i,spanned_drul_[i]->find_prebroken_piece ((Direction) -i));
+    } 
+  while (flip (&i) != LEFT);
+}       
 
-       assert(left&&right && left->line_l_ == right->line_l_);
+Interval_t<int>
+Spanner::spanned_rank_iv ()
+{
+  Interval_t<int> iv (0, 0);
 
-       span_p->left_col_l_  = left;
-       span_p->right_col_l_ = right;
-       
-       pscore_l_->typeset_broken_spanner(span_p);
-       broken_into_l_arr.push( span_p );
+  if (spanned_drul_[LEFT])
+    {
+      iv[LEFT] = Paper_column::rank_i (spanned_drul_[LEFT]->column_l ());
     }
-    
-    broken_into_l_arr_ = broken_into_l_arr;
+  if (spanned_drul_[RIGHT])
+    {
+      iv[RIGHT] = Paper_column::rank_i (spanned_drul_[RIGHT]->column_l ());
+    }
+  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 (!left_col_l_->line_l_)
-       left_col_l_ = left_col_l_->postbreak_p_;
-    if (!right_col_l_->line_l_)
-       right_col_l_ = right_col_l_->prebreak_p_;
-     
+  Item * i = dynamic_cast<Item*> (s);
+  if (!i)
+    {
+      programming_error ("Must have Item for spanner bound.");
+      return;
+    }
+  
+  spanned_drul_[d] =i;
+
+  /**
+     We check for Line_of_score to prevent the column -> line_of_score
+     -> column -> line_of_score -> etc situation */
+  if (d== LEFT && !dynamic_cast<Line_of_score*> (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 (!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 { 
-       handle_broken_dependencies();
+  */
+  if (dynamic_cast<Paper_column*> (i))
+    {
+      Pointer_group_interface::add_grob (i, ly_symbol2scm ("bounded-by-me"), this);  
     }
 }
 
+Spanner::Spanner (SCM s)
+  : Grob (s)
+{
+  spanned_drul_[LEFT]=0;
+  spanned_drul_[RIGHT]=0;
+}
 
-Spanner::Spanner()
+Spanner::Spanner (Spanner const &s)
+  : Grob (s)
 {
-    left_col_l_ = right_col_l_ = 0;
+  spanned_drul_[LEFT] = spanned_drul_[RIGHT] =0;
 }
 
+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
-Spanner::do_width()const
-{
-    Real r = right_col_l_->hpos;
-    Real l = left_col_l_->hpos;
-    assert(*left_col_l_ < *right_col_l_);
-    assert(r>=l);
-       
-    return Interval(0, r-l);
+  if (r< l)
+    programming_error ("spanner with negative length");
+
+  return r-l;
 }
 
 Line_of_score *
-Spanner::line_l()const
+Spanner::line_l () const
 {
-    if ( left_col_l_->line_l_ != right_col_l_->line_l_)
-       return 0;
-    return left_col_l_->line_l_;
+  if (!spanned_drul_[LEFT] || !spanned_drul_[RIGHT])
+    return 0;
+  if (spanned_drul_[LEFT]->line_l () != spanned_drul_[RIGHT]->line_l ())
+    return 0;
+  return spanned_drul_[LEFT]->line_l ();
 }
 
 
-Spanner*
-Spanner::find_broken_piece(Line_of_score*l)const
+Grob*
+Spanner::find_broken_piece (Line_of_score*l) const
+{
+  int idx = binsearch_link_array (broken_into_l_arr_, (Spanner*)l, Spanner::compare);
+  
+  if (idx < 0)
+    return 0;
+  else
+    return broken_into_l_arr_ [idx];
+}
+
+
+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->line_l ()->rank_i_ - p2->line_l ()->rank_i_;
 }
 
 bool
-Spanner::broken_b()const
+Spanner::broken_b () const
+{
+  return broken_into_l_arr_.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<Paper_column*> (spanned_drul_[LEFT]->column_l ());
+
+  // 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;
+}
+
+SCM
+Spanner::do_derived_mark ()
+{
+  /*
+    We'd be fucked if this is called before spanned_drul_[] is inited.  */
+  if (status_c_ == 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_into_l_arr_.size () ; i--;)
+    scm_gc_mark (broken_into_l_arr_[i]->self_scm ());
+
+  return SCM_EOL;
+}
+
+void
+add_bound_item (Spanner* sp, Item*it)
+{
+  if (!sp->get_bound (LEFT))
+    sp->set_bound (LEFT, it);
+  else
+    sp->set_bound (RIGHT, it);
+}
+
+/*
+  Extends EXTREMAL_PAIR to include IT
+ */
+static void
+extend_spanner_over_item (Item *it, SCM extremal_pair)
+{
+  if (!it)
+    return;
+  Item * col = it->column_l ();
+  Item * i1 = dynamic_cast<Item*> (unsmob_grob (ly_car (extremal_pair)));
+  Item * i2 = dynamic_cast<Item*> (unsmob_grob (ly_cdr (extremal_pair)));
+  int r = Paper_column::rank_i (col);
+  if (!i1 || r < Paper_column::rank_i (i1->column_l ()))
+    {
+      gh_set_car_x (extremal_pair, it->self_scm ());
+    }
+  if (!i2 || r > Paper_column::rank_i (i2->column_l ()))
+    {
+      gh_set_cdr_x (extremal_pair, it->self_scm ());
+    }
+}
+
+/*
+  Extends EXTREMAL_PAIR to include every grob in VALUE
+ */
+static void
+extend_spanner_over_elements (SCM value, SCM extremal_pair)
+{
+  if (gh_pair_p (value))
+    {
+      extend_spanner_over_elements (ly_car (value), extremal_pair);
+      extend_spanner_over_elements (ly_cdr (value), extremal_pair);
+    }
+  else if (unsmob_grob (value))
+    {
+      if (Spanner * sp = dynamic_cast<Spanner*> (unsmob_grob (value)))
+       {
+         extend_spanner_over_item (sp->get_bound (LEFT), extremal_pair);
+         extend_spanner_over_item (sp->get_bound (RIGHT), extremal_pair);
+       }
+      else if (Item * it= dynamic_cast<Item*> (unsmob_grob (value)))
+       extend_spanner_over_item (it, extremal_pair);
+    }
+}
+
+
+/*
+  Make sure that the left and right bounds encompasses all objects it
+  points to.
+
+  TODO: maybe be more specific. Most probably fucks up if someone sets
+  a pointer to the staff symbol in S
+*/
+void
+extend_spanner_over_elements (Grob*s)
+{
+  Spanner*sp = dynamic_cast<Spanner*> (s);
+
+  SCM s1 = sp->get_bound (LEFT) ? sp->get_bound (LEFT)->self_scm () : SCM_EOL;
+  SCM s2 = sp->get_bound (RIGHT) ? sp->get_bound (RIGHT)->self_scm () : SCM_EOL;  
+  
+  SCM pair = gh_cons (s1,s2);
+  extend_spanner_over_elements (sp->mutable_property_alist_, pair);
+
+  Grob *p1 =  unsmob_grob (ly_car (pair));
+  Grob* p2 = unsmob_grob (ly_cdr (pair));
+  sp->set_bound (LEFT,p1);
+  sp->set_bound (RIGHT, p2);
+}
+
+
+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_f_ =
+    gh_scm2double (me->get_grob_property ("minimum-length"))
+    * 1.0;
+
+  r.add_to_cols ();
+  return SCM_UNSPECIFIED;
+}
+
+
+Spanner*
+unsmob_spanner (SCM s )
 {
-    return broken_into_l_arr_.size();
+  return dynamic_cast<Spanner*> (unsmob_grob (s));
 }