]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spanner.cc
* VERSION (MY_PATCH_LEVEL): make 1.7.0
[lilypond.git] / lily / spanner.cc
index 2bc8b98ab4f2339455216a157c00898796411884..bc2d9bdd12a8f4047cd911529342727903476587 100644 (file)
@@ -3,64 +3,84 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996, 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 #include <math.h>
+#include <libc-extension.hh>
 
-#include "dimension-cache.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 "line-of-score.hh"
-#include "break-align-item.hh"
+#include "system.hh"
+#include "group-interface.hh"
 
 void
-Spanner::do_break_processing()
+Spanner::do_break_processing ()
 {
   //break_into_pieces
-  
-  if (line_l () || broken_b ())
-    return;
-  
   Item * left = spanned_drul_[LEFT];
   Item * right = spanned_drul_[RIGHT];
 
-  if  (left == 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"));
+      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 ()));
+           }
+       }
+    }
+  
+  if (get_system () || broken_b ())
+    return;
 
-      /*
-       FIXME: this is broken.
-       */
+  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_broken_piece (d);
-         Spanner * span_p = dynamic_cast<Spanner*>( clone ());
-         span_p->set_bound (LEFT, bound);
-         span_p->set_bound (RIGHT, bound);
-
-         assert (span_p->line_l ()); 
-         pscore_l_->typeset_element (span_p);
-         broken_into_l_arr_.push (span_p);
+         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_l_->broken_col_range (left,right);
+      Link_array<Item> break_points = pscore_->system_->broken_col_range (left,right);
 
       break_points.insert (left,0);
       break_points.push (right);
 
-      for (int i=1; i < break_points.size(); i++) 
+      for (int i=1; i < break_points.size (); i++) 
        {
          Drul_array<Item*> bounds;
          bounds[LEFT] = break_points[i-1];
@@ -68,37 +88,69 @@ Spanner::do_break_processing()
          Direction d = LEFT;
          do
            {
-             Item *&pc_l = bounds[d] ;
-             if (!pc_l->line_l())
-               pc_l =  pc_l->find_broken_piece(- d);
-         
-             assert (pc_l);
+             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]);
+
+         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);
            }
-         while ((flip(&d))!= LEFT);
-
-         Spanner *span_p = dynamic_cast<Spanner*>(clone ());
-         span_p->set_bound(LEFT,bounds[LEFT]);
-         span_p->set_bound(RIGHT,bounds[RIGHT]);
-      
-         pscore_l_->typeset_element (span_p);
-         broken_into_l_arr_.push (span_p);
        }
     }
-  broken_into_l_arr_.sort (Spanner::compare);
+  broken_intos_.sort (Spanner::compare);
+  for (int i= broken_intos_.size();i--;)
+    broken_intos_[i]->break_index_ = i;
 }
 
 void
-Spanner::set_my_columns()
+Spanner::set_my_columns ()
 {
   Direction i = (Direction) LEFT;
   do 
     {
-      if (!spanned_drul_[i]->line_l())
-       set_bound(i,spanned_drul_[i]->find_broken_piece((Direction) -i));
+      if (!spanned_drul_[i]->get_system ())
+       set_bound (i,spanned_drul_[i]->find_prebroken_piece ((Direction) -i));
     } 
-  while (flip(&i) != LEFT);
+  while (flip (&i) != LEFT);
 }       
 
+Interval_t<int>
+Spanner::spanned_rank_iv ()
+{
+  Interval_t<int> iv (0, 0);
+
+  if (spanned_drul_[LEFT])
+    {
+      iv[LEFT] = Paper_column::get_rank (spanned_drul_[LEFT]->get_column ());
+    }
+  if (spanned_drul_[RIGHT])
+    {
+      iv[RIGHT] = Paper_column::get_rank (spanned_drul_[RIGHT]->get_column ());
+    }
+  return iv;
+}
+
 
 Item*
 Spanner::get_bound (Direction d) const
@@ -106,44 +158,63 @@ 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_bound(Direction d, Item*i)
+Spanner::set_bound (Direction d, Grob*s)
 {
-  spanned_drul_[d] =i;
-  if (i)
+  Item * i = dynamic_cast<Item*> (s);
+  if (!i)
     {
-      i->used_b_ = true;
+      programming_error ("Must have Item for spanner bound.");
+      return;
     }
+  
+  spanned_drul_[d] =i;
 
   /**
-     Prevent the column -> line_of_score -> column -> line_of_score -> etc situation
-  */
-  if (d== LEFT && !dynamic_cast<Line_of_score*> (this))
+     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);
     }
-  
-  if (spanned_drul_[Direction(-d)] == spanned_drul_[d]
-       && i)
-    warning (_f ("Spanner `%s' has equal left and right spanpoints", classname (this)));
-}
 
+  /*
+    Signal that this column needs to be kept alive. They need to be
+    kept alive to have meaningful position and linebreaking.
 
-Spanner::Spanner ()
+    [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)
+  : 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;
 }
 
-
 Real
-Spanner::spanner_length() const
+Spanner::spanner_length () const
 {  
   Real l = spanned_drul_[LEFT]->relative_coordinate (0, X_AXIS);
   Real r = spanned_drul_[RIGHT]->relative_coordinate (0, X_AXIS);
@@ -154,73 +225,41 @@ Spanner::spanner_length() const
   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 ();
 }
 
 
-Score_element*
-Spanner::find_broken_piece (Line_of_score*l) const
+Grob*
+Spanner::find_broken_piece (System*l) const
 {
-  int idx = binsearch_link_array (broken_into_l_arr_,  (Spanner*)l, Spanner::compare);
+  int idx = binsearch_links (broken_intos_, (Spanner*)l, Spanner::compare);
   
   if (idx < 0)
     return 0;
   else
-    return broken_into_l_arr_ [idx];
+    return broken_intos_ [idx];
 }
 
 
 int
 Spanner::compare (Spanner * const &p1, Spanner * const &p2)
 {
-  return p1->line_l ()->rank_i_ - p2->line_l ()->rank_i_;
+  return  p1->get_system ()->rank_ - p2->get_system ()->rank_;
 }
 
 bool
-Spanner::broken_b() const
-{
-  return broken_into_l_arr_.size();
-}
-
-Array<Rod>
-Spanner::get_rods () const
-{
-  Array<Rod> r;
-  return r;
-}
-
-Array<Spring>
-Spanner::get_springs () const
+Spanner::broken_b () const
 {
-  Array<Spring> s;
-  return s;    
+  return broken_intos_.size ();
 }
 
-void
-Spanner::do_space_processing ()
-{
-  Array<Rod> rs (get_rods ());
-  for (int i=0; i < rs.size (); i++)
-    {
-      rs[i].add_to_cols ();
-    }
-
-  Array<Spring> ss (get_springs ());
-  for (int i=0; i < ss.size (); i++)
-    {
-      if (isinf (ss[i].distance_f_))
-       programming_error ("weird spring");
-      else
-       ss[i].add_to_cols ();
-    }
-}
 
 /*
   If this is a broken spanner, return the amount the left end is to be
@@ -231,10 +270,10 @@ Spanner::do_space_processing ()
 Real
 Spanner::get_broken_left_end_align () const
 {
-  Paper_column *sc = dynamic_cast<Paper_column*> (spanned_drul_[LEFT]->column_l());
+  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 &&
+  if (sc != NULL &&
      sc->break_status_dir () == RIGHT)
     {
       /*
@@ -243,8 +282,80 @@ Spanner::get_broken_left_end_align () const
        But that doesn't make a difference, since the Paper_column
        is likely to contain only a Break_align_item.
       */
-      return sc->extent (X_AXIS)[RIGHT];
+      return sc->extent (sc, X_AXIS)[RIGHT];
     }
 
   return 0.0;
 }
+
+SCM
+Spanner::do_derived_mark () const
+{
+  /*
+    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
+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)
+{
+  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_ =
+    gh_scm2double (me->get_grob_property ("minimum-length"));
+
+  r.add_to_cols ();
+  return SCM_UNSPECIFIED;
+}
+
+
+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
+example, slur, beam, tie, etc. These grobs form a subtype called
+@code{Spanner}. All spanners have two span-points (these must be
+@code{Item}s), one on the left and one on the right. The left bound is
+also the X-reference point of the spanner.
+",
+             "minimum-length");