]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spanner.cc
* VERSION (MY_PATCH_LEVEL): make 1.7.0
[lilypond.git] / lily / spanner.cc
index 0a1a74e5bd09c62a67acc44958a1c111fd8da743..bc2d9bdd12a8f4047cd911529342727903476587 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996, 1997--1998 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 "debug.hh"
+
+#include "warn.hh"
 #include "spanner.hh"
-#include "p-col.hh"
-#include "p-score.hh"
-#include "tex-outputter.hh"
+#include "paper-column.hh"
+#include "paper-score.hh"
 #include "molecule.hh"
-
-IMPLEMENT_IS_TYPE_B1(Spanner,Score_element);
+#include "paper-outputter.hh"
+#include "paper-column.hh"
+#include "system.hh"
+#include "group-interface.hh"
 
 void
-Spanner::do_print() const
+Spanner::do_break_processing ()
 {
-#ifndef NPRINT
-  DOUT << "Between " << spanned_drul_[LEFT]->name ()
-       << " and " << spanned_drul_[RIGHT]->name() << '\n';
-  if (broken_into_l_arr_.size())
-    {
-      DOUT << "with broken pieces:\n";
-      for (int i=0; i < broken_into_l_arr_.size (); i++)
-       broken_into_l_arr_[i]->print ();
-    }  
-#endif
-}
-
-void
-Spanner::break_into_pieces ()
-{
-  if (broken_into_l_arr_.size())
-    return; 
-        
+  //break_into_pieces
   Item * left = spanned_drul_[LEFT];
   Item * right = spanned_drul_[RIGHT];
+
+  if (!left || !right)
+    return;
   
-  if  (left == right)
+  /*
+    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\n"));
-      return;
+      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 ()));
+           }
+       }
     }
   
-  Link_array<Item> break_cols = pscore_l_->broken_col_range (left,right);
-  Link_array<Spanner> broken_into_l_arr;
+  if (get_system () || broken_b ())
+    return;
 
-  break_cols.insert (left,0);
-  break_cols.push (right);
+  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->get_system ())
+           {
+             Spanner * span = dynamic_cast<Spanner*> (clone ());
+             span->set_bound (LEFT, bound);
+             span->set_bound (RIGHT, bound);
 
-  for (int i=1; i < break_cols.size(); i++) 
+             assert (span->get_system ()); 
+             span->get_system ()->typeset_grob (span);
+             broken_intos_.push (span);
+           }
+       }
+      while ((flip (&d))!= LEFT);
+    }
+  else
     {
-      Spanner* span_p = clone()->access_Spanner ();
-      Item *left = break_cols[i-1];
-      Item *right = break_cols[i];
-      if (!right->line_l())
-       right = right->find_prebroken_piece(LEFT);
-      if (!left->line_l())
-       left = left->find_prebroken_piece(RIGHT);
-
-      assert (left&&right && left->line_l() == right->line_l());
-
-      span_p->set_bounds(LEFT,left);
-      span_p->set_bounds(RIGHT,right);
-       
-      pscore_l_->typeset_broken_spanner (span_p);
-      broken_into_l_arr.push (span_p);
+      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++) 
+       {
+         Drul_array<Item*> bounds;
+         bounds[LEFT] = break_points[i-1];
+         bounds[RIGHT] = break_points[i];
+         Direction d = LEFT;
+         do
+           {
+             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);
+           }
+       }
     }
-   
-  broken_into_l_arr_ = broken_into_l_arr;
+  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)1;
+  Direction i = (Direction) LEFT;
   do 
     {
-      if (!spanned_drul_[i]->line_l())
-       set_bounds(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) != 1);
+  while (flip (&i) != LEFT);
 }       
 
-
-void
-Spanner::set_bounds(Direction d, Item*i)
+Interval_t<int>
+Spanner::spanned_rank_iv ()
 {
-  if (spanned_drul_[d])
-    spanned_drul_[d]->attached_span_l_arr_.substitute(this,0);
-  
-  spanned_drul_[d] =i;
-  if (i)
-    i->attached_span_l_arr_.push(this);
+  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;
+}
 
-  if  (spanned_drul_[Direction(-d)] == spanned_drul_[d]
-       && i)
-    warning (_f ("Spanner `%s\' with equal left and right spanpoints", name ()));
+
+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 (!line_l())
+  Item * i = dynamic_cast<Item*> (s);
+  if (!i)
     {
-      break_into_pieces ();
-      for (int i=0; i < broken_into_l_arr_.size(); i++)
-       {
-         broken_into_l_arr_[i]->handle_broken_dependencies();
-       }
+      programming_error ("Must have Item for spanner bound.");
+      return;
     }
-  else 
+  
+  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))
     {
-      handle_broken_dependencies();
+      set_parent (i, X_AXIS);
     }
-}
 
-Spanner* 
-Spanner::access_Spanner ()
-{
-  return this;
+  /*
+    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 (dynamic_cast<Paper_column*> (i))
+    {
+      Pointer_group_interface::add_grob (i, ly_symbol2scm ("bounded-by-me"), this);  
+    }
 }
 
-Spanner::Spanner ()
+Spanner::Spanner (SCM s)
+  : Grob (s)
 {
-  unbroken_original_l_ =0;
+  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;
-  unbroken_original_l_ = &s;
 }
 
-void
-Spanner::do_brew_molecule () 
-{
-  if (transparent_b_)
-    return ;
-  Molecule *output= brew_molecule_p ();
-  Offset left_off (spanned_drul_[LEFT]->absolute_coordinate(X_AXIS), 0);
-  Offset o = absolute_offset() + left_off;
-  pscore_l_->outputter_l_->output_molecule (output, o, name ());
-  delete output;
-}
+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 l = spanned_drul_[LEFT]->absolute_coordinate (X_AXIS);
-  Real r = spanned_drul_[RIGHT]->absolute_coordinate (X_AXIS);
-  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
+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 ();
 }
 
 
-Spanner*
-Spanner::find_broken_piece (Line_of_score*l) const
+Grob*
+Spanner::find_broken_piece (System*l) const
 {
-  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;                               
-         
+  int idx = binsearch_links (broken_intos_, (Spanner*)l, Spanner::compare);
+  
+  if (idx < 0)
+    return 0;
+  else
+    return broken_intos_ [idx];
+}
+
+
+int
+Spanner::compare (Spanner * const &p1, Spanner * const &p2)
+{
+  return  p1->get_system ()->rank_ - p2->get_system ()->rank_;
 }
 
 bool
-Spanner::broken_b() const
+Spanner::broken_b () const
 {
-  return broken_into_l_arr_.size();
+  return broken_intos_.size ();
 }
 
-void
-Spanner::do_unlink() 
+
+/*
+  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
 {
-  set_bounds (LEFT, 0);
-  set_bounds (RIGHT, 0);
+  Paper_column *sc = dynamic_cast<Paper_column*> (spanned_drul_[LEFT]->get_column ());
 
-  if (unbroken_original_l_)
+  // Relevant only if left span point is first column in line
+  if (sc != NULL &&
+     sc->break_status_dir () == RIGHT)
     {
-      unbroken_original_l_->broken_into_l_arr_.substitute (this, 0);
-      unbroken_original_l_ =0;
+      /*
+       
+       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 () 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
-Spanner::do_junk_links()
+add_bound_item (Spanner* sp, Grob*it)
 {
-  spanned_drul_[LEFT] = spanned_drul_[RIGHT] =0;
+  if (!sp->get_bound (LEFT))
+    sp->set_bound (LEFT, it);
+  else
+    sp->set_bound (RIGHT, it);
 }
 
-Array<Rod>
-Spanner::get_rods () const
+
+MAKE_SCHEME_CALLBACK (Spanner,set_spacing_rods,1);
+SCM
+Spanner::set_spacing_rods (SCM smob)
 {
-  Array<Rod> r;
-  return r;
+  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;
 }
 
-void
-Spanner::do_space_processing ()
+
+Spanner*
+unsmob_spanner (SCM s )
 {
-  Array<Rod> rs (get_rods ());
-  for (int i=0; i < rs.size (); i++)
-    {
-      rs[i].add_to_cols ();
-    }
+  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");