]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spanner.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / spanner.cc
index 6f5504a556c8c729c33850678a97d180b47ab90a..bb6f743a24d5034eab9a0e6cb76805b11308a071 100644 (file)
@@ -3,51 +3,55 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
-#include <math.h>
-#include <libc-extension.hh>
 
-
-#include "debug.hh"
 #include "spanner.hh"
+
+
+#include "pointer-group-interface.hh"
+#include "libc-extension.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 "group-interface.hh"
+#include "paper-score.hh"
+#include "stencil.hh"
+#include "system.hh"
+#include "warn.hh"
+
+Grob *
+Spanner::clone (int count) const
+{
+  return new Spanner (*this, count);
+}
 
 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 ++)
+  */
+  for (int a = X_AXIS; a < NO_AXES; a++)
     {
-      if (Spanner* parent = dynamic_cast<Spanner*> (parent_l ((Axis)a)))
+      if (Spanner *parent = dynamic_cast<Spanner *> (get_parent ((Axis)a)))
        {
-         if (!parent->spanned_rank_iv ().contains_b (this->spanned_rank_iv ()))
+         if (!parent->spanned_rank_iv ().superset (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 ()));
+             programming_error (to_string ("Spanner `%s' is not fully contained in parent spanner `%s'.",
+                                           name ().c_str (),
+                                           parent->name ().c_str ()));
            }
        }
     }
-  
-  if (line_l () || broken_b ())
+
+  if (get_system () || is_broken ())
     return;
 
   if (left == right)
@@ -58,99 +62,104 @@ 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->line_l ())
+         else if (bound->get_system ())
            {
-             Spanner * span_p = dynamic_cast<Spanner*> (clone ());
-             span_p->set_bound (LEFT, bound);
-             span_p->set_bound (RIGHT, bound);
+             Spanner *span = dynamic_cast<Spanner *> (clone (broken_intos_.size ()));
+             span->set_bound (LEFT, bound);
+             span->set_bound (RIGHT, bound);
 
-             assert (span_p->line_l ()); 
-             span_p->line_l ()->typeset_grob (span_p);
-             broken_into_l_arr_.push (span_p);
+             assert (span->get_system ());
+             span->get_system ()->typeset_grob (span);
+             broken_intos_.push_back (span);
            }
        }
-      while ((flip (&d))!= LEFT);
+      while ((flip (&d)) != LEFT);
     }
   else
     {
-      Link_array<Item> break_points = pscore_l_->line_l_->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++) 
+      for (vsize i = 1; i < break_points.size (); i++)
        {
-         Drul_array<Item*> bounds;
-         bounds[LEFT] = break_points[i-1];
+         Drul_array<Item *> bounds;
+         bounds[LEFT] = break_points[i - 1];
          bounds[RIGHT] = break_points[i];
          Direction d = LEFT;
          do
            {
-             if (!bounds[d]->line_l ())
+             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_p = dynamic_cast<Spanner*> (clone ());
-         span_p->set_bound (LEFT,bounds[LEFT]);
-         span_p->set_bound (RIGHT,bounds[RIGHT]);
+         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 ()
 
-         if (!bounds[LEFT]->line_l () 
-           
-             || !bounds[RIGHT]->line_l ()
-             || bounds[LEFT]->line_l () != bounds[RIGHT]->line_l ())
+             || !bounds[RIGHT]->get_system ()
+             || bounds[LEFT]->get_system () != bounds[RIGHT]->get_system ())
            {
              programming_error ("bounds of spanner are invalid");
-             span_p->suicide ();
+             span->suicide ();
            }
          else
            {
-             bounds[LEFT]->line_l ()->typeset_grob (span_p);
-             broken_into_l_arr_.push (span_p);
+             bounds[LEFT]->get_system ()->typeset_grob (span);
+             broken_intos_.push_back (span);
            }
        }
     }
-  broken_into_l_arr_.sort (Spanner::compare);
+  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 ()
 {
   Direction i = (Direction) LEFT;
-  do 
+  do
     {
-      if (!spanned_drul_[i]->line_l ())
-       set_bound (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) != LEFT);
-}       
+}
 
 Interval_t<int>
 Spanner::spanned_rank_iv ()
 {
   Interval_t<int> iv (0, 0);
 
-  if (spanned_drul_[LEFT])
-    {
-      iv[LEFT] = Paper_column::rank_i (spanned_drul_[LEFT]->column_l ());
-    }
-  if (spanned_drul_[RIGHT])
-    {
-      iv[RIGHT] = Paper_column::rank_i (spanned_drul_[RIGHT]->column_l ());
-    }
+  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*
+Item *
 Spanner::get_bound (Direction d) const
 {
   return spanned_drul_ [d];
@@ -161,24 +170,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");
       return;
     }
-  
-  spanned_drul_[d] =i;
+
+  spanned_drul_[d] = i;
 
   /**
-     We check for Line_of_score to prevent the column -> line_of_score
+     We check for System 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);
-    }
+  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
@@ -186,75 +193,69 @@ 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_element (i, "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)
-  : Grob (s)
+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;
 }
 
-Spanner::Spanner (Spanner const &s)
-  : Grob (s)
+Spanner::Spanner (Spanner const &s, int count)
+  : Grob (s, count)
 {
-  spanned_drul_[LEFT] = spanned_drul_[RIGHT] =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);
 
-  if (r< l)
+  if (r < l)
     programming_error ("spanner with negative length");
 
-  return r-l;
+  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 (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);
-  
-  if (idx < 0)
-    return 0;
-  else
-    return broken_into_l_arr_ [idx];
+  vsize idx = binary_search (broken_intos_, (Spanner *)l, Spanner::compare);
+  if (idx != VPOS)
+    return broken_intos_ [idx];
+  return 0;
 }
 
-
 int
-Spanner::compare (Spanner * const &p1, Spanner * const &p2)
+Spanner::compare (Spanner *const &p1, Spanner *const &p2)
 {
-  return  p1->line_l ()->rank_i_ - p2->line_l ()->rank_i_;
+  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 ();
 }
 
-
 /*
   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
@@ -264,14 +265,13 @@ Spanner::broken_b () const
 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 &&
-     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.
@@ -282,28 +282,28 @@ Spanner::get_broken_left_end_align () const
   return 0.0;
 }
 
-SCM
-Spanner::do_derived_mark ()
+void
+Spanner::derived_mark () const
 {
-  /*
-    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 ());
+  while (flip (&d) != LEFT)
+    ;
 
-  return SCM_EOL;
+  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
-add_bound_item (Spanner* sp, Item*it)
+add_bound_item (Spanner *sp, Grob *it)
 {
   if (!sp->get_bound (LEFT))
     sp->set_bound (LEFT, it);
@@ -311,91 +311,44 @@ add_bound_item (Spanner* sp, Item*it)
     sp->set_bound (RIGHT, it);
 }
 
-/*
-  Extends EXTREMAL_PAIR to include IT
- */
-static void
-extend_spanner_over_item (Item *it, SCM extremal_pair)
+MAKE_SCHEME_CALLBACK (Spanner, set_spacing_rods, 1);
+SCM
+Spanner::set_spacing_rods (SCM smob)
 {
-  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 ());
-    }
-}
+  Grob *me = unsmob_grob (smob);
 
-/*
-  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);
-    }
-}
+  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;
+}
 
 /*
-  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
+  Return I such that SP == SP->ORIGINAL ()->BROKEN_INTOS_[I].
 */
-void
-extend_spanner_over_elements (Grob*s)
+int
+broken_spanner_index (Spanner *sp)
 {
-  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);
+  Spanner *parent = dynamic_cast<Spanner *> (sp->original ());
+  return find (parent->broken_intos_, sp) - parent->broken_intos_.begin ();
 }
 
-
-MAKE_SCHEME_CALLBACK (Spanner,set_spacing_rods,1);
-SCM
-Spanner::set_spacing_rods (SCM smob)
+Spanner *
+unsmob_spanner (SCM s)
 {
-  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;
+  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");