]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spanner.cc
Run `make grand-replace'.
[lilypond.git] / lily / spanner.cc
index 842d706e6de509d1e7b190c308f06dc2a1cce22a..476f75d8c26e8da85be44c334e3ca6fd18641149 100644 (file)
@@ -3,58 +3,36 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include "spanner.hh"
-
-#include <math.h>
-
-#include <libc-extension.hh>
-
-#include "warn.hh"
+#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 "paper-column.hh"
 #include "system.hh"
-#include "group-interface.hh"
-
-
+#include "warn.hh"
+#include "moment.hh"
 
-Grob * 
-Spanner::clone (int count) const
+Grob *
+Spanner::clone () const
 {
-  return new Spanner (*this, count);
+  return new Spanner (*this);
 }
 
 void
 Spanner::do_break_processing ()
 {
   //break_into_pieces
-  Item * left = spanned_drul_[LEFT];
-  Item * right = spanned_drul_[RIGHT];
+  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 ().to_str0 (),
-                                        parent->name ().to_str0 ()));
-           }
-       }
-    }
-  
+
+
   if (get_system () || is_broken ())
     return;
 
@@ -66,33 +44,49 @@ Spanner::do_break_processing ()
       Direction d = LEFT;
       do
        {
-         Itembound = left->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<Spanner*> (clone (broken_intos_.size ()));
+             Spanner *span = dynamic_cast<Spanner *> (clone ());
              span->set_bound (LEFT, bound);
              span->set_bound (RIGHT, bound);
 
-             assert (span->get_system ()); 
+             assert (span->get_system ());
              span->get_system ()->typeset_grob (span);
-             broken_intos_.push (span);
+             broken_intos_.push_back (span);
            }
        }
-      while ((flip (&d))!= LEFT);
+      while ((flip (&d)) != LEFT);
     }
   else
     {
-      Link_array<Item> break_points = pscore_->system_->broken_col_range (left, right);
+      System *root  = get_root_system (this);
+      vector<Item*> break_points = root->broken_col_range (left, right);
 
-      break_points.insert (left, 0);
-      break_points.push (right);
+      break_points.insert (break_points.begin () + 0, left);
+      break_points.push_back (right);
 
-      for (int i =1; i < break_points.size (); i++) 
+      Slice parent_rank_slice;
+      parent_rank_slice.set_full ();
+      
+      /*
+       Check if our parent in X-direction spans equally wide
+       or wider than we do.
+      */
+      for (int a = X_AXIS; a < NO_AXES; a++)
        {
-         Drul_array<Item*> bounds;
-         bounds[LEFT] = break_points[i-1];
+         if (Spanner *parent = dynamic_cast<Spanner *> (get_parent ((Axis)a)))
+           {
+             parent_rank_slice.intersect (parent->spanned_rank_interval ());
+           }
+       }
+  
+      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
@@ -100,20 +94,31 @@ Spanner::do_break_processing ()
              if (!bounds[d]->get_system ())
                bounds[d] = bounds[d]->find_prebroken_piece (- d);
            }
-         while ((flip (&d))!= LEFT);
+         while ((flip (&d)) != LEFT);
 
-         if (!bounds[LEFT] ||  ! bounds[RIGHT])
+         if (!bounds[LEFT] || ! bounds[RIGHT])
            {
              programming_error ("bounds of this piece aren't breakable. ");
-             continue; 
+             continue;
            }
 
-         Spanner *span = dynamic_cast<Spanner*> (clone (broken_intos_.size ()));
+         bool ok = parent_rank_slice.contains (bounds[LEFT]->get_column ()->get_rank ());
+         ok = ok && parent_rank_slice.contains (bounds[RIGHT]->get_column ()->get_rank ());
+         
+         if (!ok)
+           {
+             programming_error (to_string ("Spanner `%s' is not fully contained in parent spanner. Ignoring orphaned part",
+                                           name ().c_str ()));
+             continue;
+           }
+           
+         
+         Spanner *span = dynamic_cast<Spanner *> (clone ());
          span->set_bound (LEFT, bounds[LEFT]);
          span->set_bound (RIGHT, bounds[RIGHT]);
 
-         if (!bounds[LEFT]->get_system () 
-           
+         if (!bounds[LEFT]->get_system ()
+
              || !bounds[RIGHT]->get_system ()
              || bounds[LEFT]->get_system () != bounds[RIGHT]->get_system ())
            {
@@ -123,16 +128,16 @@ Spanner::do_break_processing ()
          else
            {
              bounds[LEFT]->get_system ()->typeset_grob (span);
-             broken_intos_.push (span);
+             broken_intos_.push_back (span);
            }
        }
     }
-  broken_intos_.sort (Spanner::compare);
-  for (int i = broken_intos_.size ();i--;)
+  vector_sort (broken_intos_, Spanner::less);
+  for (vsize i = broken_intos_.size (); i--;)
     broken_intos_[i]->break_index_ = i;
 }
 
-int
+vsize
 Spanner::get_break_index () const
 {
   return break_index_;
@@ -142,28 +147,35 @@ void
 Spanner::set_my_columns ()
 {
   Direction i = (Direction) LEFT;
-  do 
+  do
     {
       if (!spanned_drul_[i]->get_system ())
        set_bound (i, spanned_drul_[i]->find_prebroken_piece ((Direction) -i));
-    } 
+    }
   while (flip (&i) != LEFT);
-}       
+}
 
 Interval_t<int>
-Spanner::spanned_rank_iv ()
+Spanner::spanned_rank_interval () const
 {
   Interval_t<int> iv (0, 0);
 
   if (spanned_drul_[LEFT] && spanned_drul_[LEFT]->get_column ())
-    iv[LEFT] = Paper_column::get_rank (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] = Paper_column::get_rank (spanned_drul_[RIGHT]->get_column ());
+    iv[RIGHT] = spanned_drul_[RIGHT]->get_column ()->get_rank ();
   return iv;
 }
 
+Interval_t<Moment>
+Spanner::spanned_time () const
+{
+  return spanned_time_interval (spanned_drul_[LEFT],
+                               spanned_drul_[RIGHT]);
+}
+
 
-Item*
+Item *
 Spanner::get_bound (Direction d) const
 {
   return spanned_drul_ [d];
@@ -174,24 +186,22 @@ Spanner::get_bound (Direction d) const
   X-axis parent of THIS to S.
 */
 void
-Spanner::set_bound (Direction d, Grob*s)
+Spanner::set_bound (Direction d, Grob *s)
 {
-  Item * i = dynamic_cast<Item*> (s);
+  Item *i = dynamic_cast<Item *> (s);
   if (!i)
     {
-      programming_error ("Must have Item for spanner bound.");
+      programming_error ("must have Item for spanner bound of " + name());
       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);
-    }
+  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
@@ -199,40 +209,36 @@ Spanner::set_bound (Direction d, Grob*s)
 
     [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);  
-    }
+  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)
+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"));
+  spanned_drul_[LEFT] = 0;
+  spanned_drul_[RIGHT] = 0;
 }
 
-Spanner::Spanner (Spanner const &s, int count)
-  : Grob (s, count)
+Spanner::Spanner (Spanner const &s)
+  : Grob (s)
 {
   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);
 
-  if (r< l)
+  if (r < l)
     programming_error ("spanner with negative length");
 
-  return r-l;
+  return r - l;
 }
 
 System *
@@ -245,23 +251,40 @@ Spanner::get_system () const
   return spanned_drul_[LEFT]->get_system ();
 }
 
-
-Grob*
-Spanner::find_broken_piece (System*l) const
+Grob *
+Spanner::find_broken_piece (System *l) const
 {
-  int idx = binsearch_links (broken_intos_, (Spanner*)l, Spanner::compare);
-  
-  if (idx < 0)
-    return 0;
-  else
+  vsize idx = binary_search (broken_intos_, (Spanner *)l, Spanner::less);
+  if (idx != VPOS)
     return broken_intos_ [idx];
+  return 0;
 }
 
+Spanner *
+Spanner::broken_neighbor (Direction d) const
+{
+  if (!original_)
+    return 0;
+
+  vsize k = broken_spanner_index (this);
+  Spanner *orig = dynamic_cast<Spanner*> (original_);
+  int j = int (k) + d;
+  if (j < 0 || vsize (j) >= orig->broken_intos_.size ())
+    return 0;
+
+  return orig->broken_intos_[j];
+}
 
 int
-Spanner::compare (Spanner * const &p1, Spanner * const &p2)
+Spanner::compare (Spanner *const &p1, Spanner *const &p2)
+{
+  return p1->get_system ()->get_rank () - p2->get_system ()->get_rank ();
+}
+
+bool
+Spanner::less (Spanner *const &a, Spanner *const &b)
 {
-  return  p1->get_system ()->rank_ - p2->get_system ()->rank_;
+  return a->get_system ()->get_rank () < b->get_system ()->get_rank ();
 }
 
 bool
@@ -270,7 +293,6 @@ Spanner::is_broken () const
   return broken_intos_.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
@@ -280,14 +302,13 @@ Spanner::is_broken () const
 Real
 Spanner::get_broken_left_end_align () const
 {
-  Paper_column *sc = dynamic_cast<Paper_column*> (spanned_drul_[LEFT]->get_column ());
+  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)
+  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.
@@ -298,35 +319,28 @@ Spanner::get_broken_left_end_align () const
   return 0.0;
 }
 
-SCM
-Spanner::do_derived_mark () const
+void
+Spanner::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);
+  while (flip (&d) != LEFT)
+    ;
 
-  for (int i = broken_intos_.size () ; i--;)
+  for (vsize 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)
+add_bound_item (Spanner *sp, Grob *it)
 {
   if (!sp->get_bound (LEFT))
     sp->set_bound (LEFT, it);
@@ -334,48 +348,91 @@ add_bound_item (Spanner* sp, Grob*it)
     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 ();
+  Grob *me = unsmob_grob (smob);
+  SCM num_length = me->get_property ("minimum-length");
+  if (scm_is_number (num_length))
+    {
+      Rod r;
+      Spanner *sp = dynamic_cast<Spanner *> (me);
+      System *root = get_root_system (me);
+      Drul_array<Item*> bounds (sp->get_bound (LEFT),
+                               sp->get_bound (RIGHT));
+      if (!bounds[LEFT] || !bounds[RIGHT])
+       return SCM_UNSPECIFIED;
+      
+      vector<Item*> cols (root->broken_col_range (bounds[LEFT]->get_column (),
+                                                 bounds[RIGHT]->get_column ()));
+
+      if (cols.size ())
+       {
+         Rod r ;
+         r.item_drul_[LEFT] = sp->get_bound (LEFT);
+         r.item_drul_[RIGHT] = cols[0]->find_prebroken_piece (LEFT);
+         r.distance_ = robust_scm2double (num_length, 0);
+         r.add_to_cols ();
+         
+         r.item_drul_[LEFT] = cols.back ()->find_prebroken_piece (RIGHT);
+         r.item_drul_[RIGHT] = sp->get_bound (RIGHT);
+         r.add_to_cols ();
+       }
+          
+      r.distance_ = robust_scm2double (num_length, 0);
+      r.item_drul_[LEFT] = sp->get_bound (LEFT);
+      r.item_drul_[RIGHT] = sp->get_bound (RIGHT);
+      r.add_to_cols ();
+    }
+  
   return SCM_UNSPECIFIED;
 }
 
-
 /*
-  Return I such that SP == SP->ORIGINAL_->BROKEN_INTOS_[I]. 
- */
+  Return I such that SP == SP->ORIGINAL ()->BROKEN_INTOS_[I].
+*/
 int
-broken_spanner_index (Spanner sp)
+broken_spanner_index (Spanner const *sp)
 {
-  Spanner * parent = dynamic_cast<Spanner*> (sp->original_);
-  return parent->broken_intos_.find_index (sp);
+  Spanner *parent = dynamic_cast<Spanner *> (sp->original ());
+  /* ugh: casting */
+  return find (parent->broken_intos_, (Spanner*) sp) - parent->broken_intos_.begin ();
 }
-                     
 
-Spanner*
-unsmob_spanner (SCM s )
+Spanner *
+unsmob_spanner (SCM s)
 {
-  return dynamic_cast<Spanner*> (unsmob_grob (s));
+  return dynamic_cast<Spanner *> (unsmob_grob (s));
+}
+
+MAKE_SCHEME_CALLBACK (Spanner, bounds_width, 1);
+SCM
+Spanner::bounds_width (SCM grob)
+{
+  Spanner *me = unsmob_spanner (grob);
+
+
+  Grob *common = me->get_bound (LEFT)->common_refpoint (me->get_bound (RIGHT), X_AXIS);
+
+  Interval w (me->get_bound (LEFT)->relative_coordinate (common, X_AXIS),
+             me->get_bound (RIGHT)->relative_coordinate (common, X_AXIS));
+             
+  w -= me->relative_coordinate (common, X_AXIS);
+
+  return ly_interval2scm (w);
 }
 
 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");
+              "Some objects are horizontally spanned between objects.  For"
+              " example, slurs, beams, ties, etc.  These grobs form a subtype"
+              " called @code{Spanner}.  All spanners have two span points"
+              " (these must be @code{Item} objects), one on the left and one"
+              " on the right.  The left bound is also the X@tie{}reference"
+              " point of the spanner.",
+
+              /* properties */
+              "minimum-length "
+              "to-barline "
+              );
+