]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spanner.cc
Optimizations for pure-height approximations.
[lilypond.git] / lily / spanner.cc
index 8a1e9e62c96204d71a9b6fd5c55c41466f505327..f3d13c84f9879a5878a6dc9739528842b94e8205 100644 (file)
@@ -1,20 +1,30 @@
 /*
-  spanner.cc -- implement Spanner
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1996--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#include "pointer-group-interface.hh"
 #include "libc-extension.hh"
-#include "paper-column.hh"
+#include "moment.hh"
 #include "paper-column.hh"
 #include "paper-score.hh"
+#include "pointer-group-interface.hh"
 #include "stencil.hh"
 #include "system.hh"
 #include "warn.hh"
-#include "moment.hh"
 
 Grob *
 Spanner::clone () const
@@ -32,22 +42,6 @@ Spanner::do_break_processing ()
   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 ().c_str (),
-                                           parent->name ().c_str ()));
-           }
-       }
-    }
 
   if (get_system () || is_broken ())
     return;
@@ -84,6 +78,19 @@ Spanner::do_break_processing ()
       break_points.insert (break_points.begin () + 0, left);
       break_points.push_back (right);
 
+      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++)
+       {
+         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;
@@ -103,12 +110,22 @@ Spanner::do_break_processing ()
              continue;
            }
 
+         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 ()
-
              || !bounds[RIGHT]->get_system ()
              || bounds[LEFT]->get_system () != bounds[RIGHT]->get_system ())
            {
@@ -146,7 +163,7 @@ Spanner::set_my_columns ()
 }
 
 Interval_t<int>
-Spanner::spanned_rank_iv () const
+Spanner::spanned_rank_interval () const
 {
   Interval_t<int> iv (0, 0);
 
@@ -160,32 +177,15 @@ Spanner::spanned_rank_iv () const
 Interval_t<Moment>
 Spanner::spanned_time () const
 {
-  Interval_t<Moment> iv;
-
-  Direction d = LEFT;
-  do
-    {
-      if (spanned_drul_[d] && spanned_drul_[d]->get_column ())
-       iv[d] = robust_scm2moment (spanned_drul_[d]->get_column ()->get_property ("when"),
-                                 iv[d]);
-    }
-  while (flip (&d) != LEFT);
-
-  do
-    {
-      if (!spanned_drul_[d] || !spanned_drul_[d]->get_column ())
-       iv[d] = iv[-d];
-    }
-  while (flip (&d) != LEFT);
-  
-  
-  return iv;
+  return spanned_time_interval (spanned_drul_[LEFT],
+                               spanned_drul_[RIGHT]);
 }
 
+
 Item *
 Spanner::get_bound (Direction d) const
 {
-  return spanned_drul_ [d];
+  return spanned_drul_[d];
 }
 
 /*
@@ -198,7 +198,7 @@ Spanner::set_bound (Direction d, Grob *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;
     }
 
@@ -216,7 +216,6 @@ 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);
@@ -226,14 +225,15 @@ Spanner::Spanner (SCM s)
   : Grob (s)
 {
   break_index_ = 0;
-  spanned_drul_[LEFT] = 0;
-  spanned_drul_[RIGHT] = 0;
+  spanned_drul_.set (0, 0);
+  pure_property_cache_ = SCM_UNDEFINED;
 }
 
 Spanner::Spanner (Spanner const &s)
   : Grob (s)
 {
-  spanned_drul_[LEFT] = spanned_drul_[RIGHT] = 0;
+  spanned_drul_.set (0, 0);
+  pure_property_cache_ = SCM_UNDEFINED;
 }
 
 Real
@@ -261,7 +261,7 @@ Spanner::get_system () const
 Grob *
 Spanner::find_broken_piece (System *l) const
 {
-  vsize idx = binary_search (broken_intos_, (Spanner *)l, Spanner::less);
+  vsize idx = binary_search (broken_intos_, (Spanner *) l, Spanner::less);
   if (idx != VPOS)
     return broken_intos_ [idx];
   return 0;
@@ -329,6 +329,8 @@ Spanner::get_broken_left_end_align () const
 void
 Spanner::derived_mark () const
 {
+  scm_gc_mark (pure_property_cache_);
+
   Direction d = LEFT;
   do
     if (spanned_drul_[d])
@@ -365,11 +367,14 @@ Spanner::set_spacing_rods (SCM smob)
     {
       Rod r;
       Spanner *sp = dynamic_cast<Spanner *> (me);
-      
-
       System *root = get_root_system (me);
-      vector<Item*> cols (root->broken_col_range (sp->get_bound (LEFT)->get_column (),
-                                                 sp->get_bound (RIGHT)->get_column ()));
+      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 ())
        {
@@ -410,13 +415,12 @@ unsmob_spanner (SCM s)
   return dynamic_cast<Spanner *> (unsmob_grob (s));
 }
 
-MAKE_SCHEME_CALLBACK(Spanner, bounds_width, 1);
+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),
@@ -427,13 +431,66 @@ Spanner::bounds_width (SCM grob)
   return ly_interval2scm (w);
 }
 
-ADD_INTERFACE (Spanner,
-              "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",
+MAKE_SCHEME_CALLBACK (Spanner, kill_zero_spanned_time, 1);
+SCM
+Spanner::kill_zero_spanned_time (SCM grob)
+{
+  Spanner *me = unsmob_spanner (grob);
+  Interval_t<Moment> moments = me->spanned_time ();
+  /*
+    Remove the line or hairpin at the start of the line.  For
+    piano voice indicators, it makes no sense to have them at
+    the start of the line.
+
+    I'm not sure what the official rules for glissandi are, but
+    usually the 2nd note of the glissando is "exact", so when playing
+    from the start of the line, there is no need to glide.
 
+    From a typographical p.o.v. this makes sense, since the amount of
+    space left of a note at the start of a line is very small.
+
+    --hwn.
+
+  */
+  if (moments.length () == Moment (0, 0))
+    me->suicide ();
+
+  return SCM_UNSPECIFIED;
+}
+
+SCM
+Spanner::get_cached_pure_property (SCM sym, int start, int end)
+{
+  // The pure property cache is indexed by (name start . end), where name is
+  // a symbol, and start and end are numbers referring to the starting and
+  // ending column ranks of the current line.
+  if (scm_hash_table_p (pure_property_cache_) == SCM_BOOL_F)
+    return SCM_UNDEFINED;
+
+  SCM key = scm_cons (sym, scm_cons (scm_from_int (start), scm_from_int (end)));
+  return scm_hash_ref (pure_property_cache_, key, SCM_UNDEFINED);
+}
+
+void
+Spanner::cache_pure_property (SCM sym, int start, int end, SCM val)
+{
+  if (scm_hash_table_p (pure_property_cache_) == SCM_BOOL_F)
+    pure_property_cache_ = scm_c_make_hash_table (17);
+
+  SCM key = scm_cons (sym, scm_cons (scm_from_int (start), scm_from_int (end)));
+  scm_hash_set_x (pure_property_cache_, key, val);
+}
+
+ADD_INTERFACE (Spanner,
+              "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 "
               );