]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spanner.cc
Imported Upstream version 2.14.2
[lilypond.git] / lily / spanner.cc
index 955ba76ef3ad08b0b3bfe032f02385c17c8dab98..22282aa231d9793d62bb2f8f483b75f8ba0d0a99 100644 (file)
@@ -1,27 +1,35 @@
 /*
-  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--2006 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.
 
-#include "spanner.hh"
+  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"
 
 Grob *
-Spanner::clone (int count) const
+Spanner::clone () const
 {
-  return new Spanner (*this, count);
+  return new Spanner (*this);
 }
 
 void
@@ -34,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;
@@ -67,7 +59,7 @@ Spanner::do_break_processing ()
            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);
 
@@ -86,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;
@@ -105,12 +110,22 @@ Spanner::do_break_processing ()
              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 ()
-
              || !bounds[RIGHT]->get_system ()
              || bounds[LEFT]->get_system () != bounds[RIGHT]->get_system ())
            {
@@ -148,7 +163,7 @@ Spanner::set_my_columns ()
 }
 
 Interval_t<int>
-Spanner::spanned_rank_iv ()
+Spanner::spanned_rank_interval () const
 {
   Interval_t<int> iv (0, 0);
 
@@ -159,10 +174,18 @@ Spanner::spanned_rank_iv ()
   return iv;
 }
 
+Interval_t<Moment>
+Spanner::spanned_time () const
+{
+  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];
 }
 
 /*
@@ -175,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;
     }
 
@@ -193,36 +216,51 @@ 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);
 }
 
-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;
+  spanned_drul_.set (0, 0);
+  pure_property_cache_ = SCM_UNDEFINED;
 }
 
-Spanner::Spanner (Spanner const &s, int count)
-  : Grob (s, count)
+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
 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 lr;
+
+  Drul_array<SCM> bounds (get_property ("left-bound-info"),
+                          get_property ("right-bound-info"));
+
+  Direction d =  LEFT;
+  do
+    lr[d] = robust_scm2double (ly_assoc_get (ly_symbol2scm ("X"),
+                                             bounds[d], SCM_BOOL_F), -d);
+  while (flip (&d) != LEFT);
 
-  if (r < l)
+  if (lr.is_empty ())
+    {
+      do
+        lr[d] = spanned_drul_[d]->relative_coordinate (0, X_AXIS);
+      while (flip (&d) != LEFT);
+    }
+
+  if (lr.is_empty ())
     programming_error ("spanner with negative length");
 
-  return r - l;
+  return lr.length ();
 }
 
 System *
@@ -238,7 +276,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;
@@ -250,7 +288,7 @@ Spanner::broken_neighbor (Direction d) const
   if (!original_)
     return 0;
 
-  vsize k = broken_spanner_index (this);
+  vsize k = get_break_index ();
   Spanner *orig = dynamic_cast<Spanner*> (original_);
   int j = int (k) + d;
   if (j < 0 || vsize (j) >= orig->broken_intos_.size ())
@@ -306,6 +344,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])
@@ -337,31 +377,87 @@ 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);
-
   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].
-*/
-int
-broken_spanner_index (Spanner const *sp)
+MAKE_SCHEME_CALLBACK (Spanner, calc_normalized_endpoints, 1);
+SCM
+Spanner::calc_normalized_endpoints (SCM smob)
 {
-  Spanner *parent = dynamic_cast<Spanner *> (sp->original ());
-  /* ugh: casting */
-  return find (parent->broken_intos_, (Spanner*) sp) - parent->broken_intos_.begin ();
+  Spanner *me = unsmob_spanner (smob);
+  SCM result = SCM_EOL;
+
+  Spanner *orig = dynamic_cast<Spanner *> (me->original ());
+
+  orig = orig ? orig : me;
+
+  if (orig->is_broken ())
+    {
+      Real total_width = 0.0;
+      vector<Real> span_data;
+
+      if (!orig->is_broken ())
+        span_data.push_back (orig->spanner_length ());
+      else
+        for (vsize i = 0; i < orig->broken_intos_.size (); i++)
+          span_data.push_back (orig->broken_intos_[i]->spanner_length ());
+
+      vector<Interval> unnormalized_endpoints;
+
+      for (vsize i = 0; i < span_data.size (); i++)
+        {
+          unnormalized_endpoints.push_back (Interval (total_width, total_width + span_data[i]));
+          total_width += span_data[i];
+        }
+
+      for (vsize i = 0; i < unnormalized_endpoints.size (); i++)
+        {
+          SCM t = ly_interval2scm (1 / total_width * unnormalized_endpoints[i]);
+          orig->broken_intos_[i]->set_property ("normalized-endpoints", t);
+          if (me->get_break_index () == i)
+            result = t;
+        }
+    }
+  else
+    {
+      result = scm_cons (scm_from_double (0.0), scm_from_double (1.0));
+      orig->set_property ("normalized-endpoints", result);
+    }
+
+  return result;
 }
 
 Spanner *
@@ -370,12 +466,87 @@ 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");
+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);
+}
+
+MAKE_SCHEME_CALLBACK (Spanner, kill_zero_spanned_time, 1);
+SCM
+Spanner::kill_zero_spanned_time (SCM grob)
+{
+  Spanner *me = unsmob_spanner (grob);
+  /*
+    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 (me->get_bound (LEFT)->break_status_dir ())
+    {
+      Interval_t<Moment> moments = me->spanned_time ();
+      moments [LEFT].grace_part_ = 0;
+      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 */
+              "normalized-endpoints "
+              "minimum-length "
+               "spanner-id "
+              "to-barline "
+              );