]> 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 9a8ed71038379a4cc4de36abed5e67c7144d7153..bb6f743a24d5034eab9a0e6cb76805b11308a071 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
-#include <math.h>
 
-#include "dimension-cache.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 "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];
-  
-  if  (left == right)
-    {
-      warning (_f ("Spanner `%s' has equal left and right spanpoints",
-                  classname (this)));
-    }
+  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'.",
-                                        classname (this),
-                                        classname (parent)));
+             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)
+  if (left == right)
     {
-      /*
-       FIXME: this is broken.
-       */
       /*
        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);
-         if (bound->line_l ())
+         Item *bound = left->find_prebroken_piece (d);
+         if (!bound)
+           programming_error ("no broken bound");
+         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_element (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
            {
-             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);
+         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]);
+         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]);
 
-         assert (bounds[LEFT]->line_l () ==
-                 bounds[RIGHT]->line_l ());
+         if (!bounds[LEFT]->get_system ()
 
-         bounds[LEFT]->line_l ()->typeset_element (span_p);
-         broken_into_l_arr_.push (span_p);
+             || !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_.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()
+Spanner::set_my_columns ()
 {
   Direction i = (Direction) LEFT;
-  do 
+  do
     {
-      if (!spanned_drul_[i]->line_l())
-       set_bound(i,spanned_drul_[i]->find_broken_piece((Direction) -i));
-    } 
-  while (flip(&i) != LEFT);
-}       
+      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] = spanned_drul_[LEFT]->column_l ()->rank_i ();
-    }
-  if ( spanned_drul_[RIGHT])
-    {
-      iv[RIGHT] = spanned_drul_[RIGHT]->column_l ()->rank_i ();
-    }
+  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];
 }
 
+/*
+  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
+     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 (d== LEFT && !dynamic_cast<Line_of_score*> (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)));
+  if (dynamic_cast<Paper_column *> (i))
+    Pointer_group_interface::add_grob (i, ly_symbol2scm ("bounded-by-me"), this);
 }
 
-
-Spanner::Spanner ()
+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)
-  : Score_element (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
-{  
+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 ();
 }
 
-
-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);
-  
-  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
-{
-  return broken_into_l_arr_.size();
-}
-
-Array<Rod>
-Spanner::get_rods () const
-{
-  Array<Rod> r;
-  return r;
-}
-
-Array<Spring>
-Spanner::get_springs () const
-{
-  Array<Spring> s;
-  return s;    
-}
-
-void
-Spanner::do_space_processing ()
+Spanner::is_broken () const
 {
-  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 ();
-    }
+  return broken_intos_.size ();
 }
 
 /*
@@ -275,20 +265,90 @@ 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 &&
-     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.
       */
-      return sc->extent (X_AXIS)[RIGHT];
+      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
+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_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");