]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/slur.cc
Run `make grand-replace'.
[lilypond.git] / lily / slur.cc
index e482763a5bff05dd9fb2ba3e7248955e248cce99..2bc0ea072c9909ac2da9f10837aeccea648f4788 100644 (file)
@@ -3,17 +3,18 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 1996--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
 */
 
 #include "slur.hh"
-
-
+#include "grob-info.hh"
+#include "grob-array.hh"
 #include "beam.hh"
 #include "bezier.hh"
 #include "directional-element-interface.hh"
 #include "font-interface.hh"
+#include "item.hh"
 #include "pointer-group-interface.hh"
 #include "lookup.hh"
 #include "main.hh"             // DEBUG_SLUR_SCORING
 #include "output-def.hh"
 #include "spanner.hh"
 #include "staff-symbol-referencer.hh"
-#include "staff-symbol.hh"
 #include "stem.hh"
 #include "text-interface.hh"
+#include "tie.hh"
 #include "warn.hh"
 #include "slur-scoring.hh"
-
-#include "script-interface.hh"
+#include "separation-item.hh"
+#include "international.hh"
 
 
 
-MAKE_SCHEME_CALLBACK(Slur, calc_direction, 1)
+MAKE_SCHEME_CALLBACK (Slur, calc_direction, 1)
 SCM
 Slur::calc_direction (SCM smob)
 {
@@ -56,6 +57,35 @@ Slur::calc_direction (SCM smob)
   return scm_from_int (d);
 }
 
+MAKE_SCHEME_CALLBACK (Slur, pure_height, 3);
+SCM
+Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm)
+{
+  Grob *me = unsmob_grob (smob);
+  int start = scm_to_int (start_scm);
+  int end = scm_to_int (end_scm);
+  Real height = robust_scm2double (me->get_property ("height-limit"), 2.0);
+
+  extract_grob_set (me, "note-columns", encompasses);
+  Interval ret;
+
+  Grob *parent = me->get_parent (Y_AXIS);
+  if (common_refpoint_of_array (encompasses, me, Y_AXIS) != parent)
+    /* this could happen if, for example, we are a cross-staff slur.
+       in this case, we want to be ignored */
+    return ly_interval2scm (Interval ());
+
+  for (vsize i = 0; i < encompasses.size (); i++)
+    {
+      Interval d = encompasses[i]->pure_height (parent, start, end);
+      if (!d.is_empty ())
+       ret.unite (d);
+    }
+
+  ret.widen (height * 0.5);
+  return ly_interval2scm (ret);
+}
+
 MAKE_SCHEME_CALLBACK (Slur, height, 1);
 SCM
 Slur::height (SCM smob)
@@ -68,9 +98,6 @@ Slur::height (SCM smob)
     : ly_interval2scm (Interval ());
 }
 
-/*
-  Ugh should have dash-length + dash-period
-*/
 MAKE_SCHEME_CALLBACK (Slur, print, 1);
 SCM
 Slur::print (SCM smob)
@@ -92,9 +119,6 @@ Slur::print (SCM smob)
   Bezier one = get_curve (me);
   Stencil a;
 
-  /*
-    TODO: replace dashed with generic property.
-  */
   SCM p = me->get_property ("dash-period");
   SCM f = me->get_property ("dash-fraction");
   if (scm_is_number (p) && scm_is_number (f))
@@ -106,33 +130,78 @@ Slur::print (SCM smob)
                      line_thick);
 
 #if DEBUG_SLUR_SCORING
-  SCM quant_score = me->get_property ("quant-score");
-
-  if (to_boolean (me->layout ()
-                 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
-      && scm_is_string (quant_score))
+  SCM annotation = me->get_property ("annotation");
+  if (!scm_is_string (annotation))
+    {
+      SCM debug = me->layout ()->lookup_variable (ly_symbol2scm ("debug-slur-scoring"));
+      if (to_boolean (debug))
+       annotation = me->get_property ("quant-score");
+    }
+  
+  if (scm_is_string (annotation))
     {
       string str;
       SCM properties = Font_interface::text_font_alist_chain (me);
 
-      properties = scm_cons (scm_acons (ly_symbol2scm ("font-size"), scm_from_int (-6), SCM_EOL),
-                                properties);
+      if (!scm_is_number (me->get_property ("font-size")))
+       properties = scm_cons (scm_acons (ly_symbol2scm ("font-size"), scm_from_int (-6), SCM_EOL),
+                            properties);
+      
       Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
                                    (me->layout ()->self_scm (), properties,
-                                    quant_score));
-      a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0, 0);
+                                    annotation));
+      a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0);
     }
 #endif
 
   return a.smobbed_copy ();
 }
 
+
+/*
+  it would be better to do this at engraver level, but that is
+  fragile, as the breakabl items are generated on staff level, at
+  which point slur starts and ends have to be tracked
+*/
+void
+Slur::replace_breakable_encompass_objects (Grob *me)
+{
+  extract_grob_set (me, "encompass-objects", extra_objects);
+  vector<Grob *> new_encompasses;
+
+  for (vsize i = 0; i < extra_objects.size (); i++)
+    {
+      Grob *g = extra_objects[i];
+      
+      if (Separation_item::has_interface (g))
+       {
+         extract_grob_set (g, "elements", breakables);
+         for (vsize j = 0; j < breakables.size (); j++)
+           /* if we encompass a separation-item that spans multiple staves,
+              we filter out the grobs that don't belong to our staff */
+           if (me->common_refpoint (breakables[j], Y_AXIS) == me->get_parent (Y_AXIS)
+               && breakables[j]->get_property ("avoid-slur") == ly_symbol2scm ("inside"))
+             new_encompasses.push_back (breakables[j]);
+       }
+      else
+       new_encompasses.push_back (g);
+    }
+
+  SCM encompass_scm = me->get_object ("encompass-objects");
+  if (Grob_array::unsmob (encompass_scm))
+    {
+      vector<Grob *> &arr =
+       unsmob_grob_array (encompass_scm)->array_reference ();
+      arr = new_encompasses;
+    }
+}
+
 Bezier
 Slur::get_curve (Grob *me)
 {
   Bezier b;
   int i = 0;
-  for (SCM s = me->get_property ("control-points"); s != SCM_EOL;
+  for (SCM s = me->get_property ("control-points"); scm_is_pair (s);
        s = scm_cdr (s))
     b.control_[i++] = ly_scm2offset (scm_car (s));
 
@@ -143,7 +212,7 @@ void
 Slur::add_column (Grob *me, Grob *n)
 {
   Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
-  add_bound_item (dynamic_cast<Spanner *> (me), dynamic_cast<Item *> (n));
+  add_bound_item (dynamic_cast<Spanner *> (me), n);
 }
 
 void
@@ -152,8 +221,27 @@ Slur::add_extra_encompass (Grob *me, Grob *n)
   Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
 }
 
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, pure_outside_slur_callback, 4, 1, "");
+SCM
+Slur::pure_outside_slur_callback (SCM grob, SCM start_scm, SCM end_scm, SCM offset_scm)
+{
+  int start = robust_scm2int (start_scm, 0);
+  int end = robust_scm2int (end_scm, 0);
+  Grob *script = unsmob_grob (grob);
+  Grob *slur = unsmob_grob (script->get_object ("slur"));
+  if (!slur)
+    return offset_scm;
 
-MAKE_SCHEME_CALLBACK (Slur, outside_slur_callback, 2);
+  SCM avoid = script->get_property ("avoid-slur");
+  if (avoid != ly_symbol2scm ("outside") && avoid != ly_symbol2scm ("around"))
+    return offset_scm;
+
+  Real offset = robust_scm2double (offset_scm, 0.0);
+  Direction dir = get_grob_direction (script);
+  return scm_from_double (offset + dir * slur->pure_height (slur, start, end).length () / 4);
+}
+
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, outside_slur_callback, 2, 1, "");
 SCM
 Slur::outside_slur_callback (SCM grob, SCM offset_scm)
 {
@@ -183,8 +271,8 @@ Slur::outside_slur_callback (SCM grob, SCM offset_scm)
   Interval yext = robust_relative_extent (script, cy, Y_AXIS);
   Interval xext = robust_relative_extent (script, cx, X_AXIS);
 
-  yext.translate (robust_scm2double (offset_scm, 0));
-  
+  Real offset = robust_scm2double (offset_scm, 0);
+  yext.translate (offset);
   
   /* FIXME: slur property, script property?  */
   Real slur_padding = robust_scm2double (script->get_property ("slur-padding"),
@@ -220,21 +308,113 @@ Slur::outside_slur_callback (SCM grob, SCM offset_scm)
     }
 
   Real avoidance_offset = 0.0;
-  for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
-    if (consider[k]) 
-      avoidance_offset = dir * (max (dir * avoidance_offset,
-                                    dir * (ys[k] - yext[-dir] + dir * slur_padding)));
+  if (do_shift)
+    {
+      for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
+       if (consider[k])
+         avoidance_offset = dir * (max (dir * avoidance_offset,
+                                        dir * (ys[k] - yext[-dir] + dir * slur_padding)));
+    }
+  return scm_from_double (offset + avoidance_offset);
+}
+
+/*
+ * Used by Slur_engraver:: and Phrasing_slur_engraver::
+ */
+void
+Slur::auxiliary_acknowledge_extra_object (Grob_info const &info,
+                                         vector<Grob*> &slurs,
+                                         vector<Grob*> &end_slurs)
+{
+  if (slurs.empty () && end_slurs.empty ())
+    return;
   
-  return scm_from_double (scm_to_double (offset_scm) + avoidance_offset);
+  Grob *e = info.grob ();
+  SCM avoid = e->get_property ("avoid-slur");
+  if (Tie::has_interface (e)
+      || avoid == ly_symbol2scm ("inside"))
+    {
+      for (vsize i = slurs.size (); i--;)
+       add_extra_encompass (slurs[i], e);
+      for (vsize i = end_slurs.size (); i--;)
+       add_extra_encompass (end_slurs[i], e);
+    }
+  else if (avoid == ly_symbol2scm ("outside")
+          || avoid == ly_symbol2scm ("around"))
+    {
+      Grob *slur;
+      if (end_slurs.size () && !slurs.size ())
+       slur = end_slurs[0];
+      else
+       slur = slurs[0];
+
+      if (slur)
+       {
+         chain_offset_callback (e, outside_slur_callback_proc, Y_AXIS);
+         chain_callback (e, outside_slur_cross_staff_proc, ly_symbol2scm("cross-staff"));
+         e->set_object ("slur", slur->self_scm ());
+       }
+    }
+  else
+    e->warning (_f ("Ignoring grob for slur: %s. avoid-slur not set?",
+                   e->name().c_str ()));
 }
 
+/*
+  A callback that will be chained together with the original cross-staff
+  value of a grob that is placed 'outside or 'around a slur. This just says
+  that any grob becomes cross-staff if it is placed 'outside or 'around a
+  cross-staff slur.
+*/
+MAKE_SCHEME_CALLBACK (Slur, outside_slur_cross_staff, 2)
+SCM
+Slur::outside_slur_cross_staff (SCM smob, SCM previous)
+{
+  if (previous == SCM_BOOL_T)
+    return previous;
 
+  Grob *me = unsmob_grob (smob);
+  Grob *slur = unsmob_grob (me->get_object ("slur"));
 
-ADD_INTERFACE (Slur, "slur-interface",
-              
-              "A slur",
+  if (!slur)
+    return SCM_BOOL_F;
+  return slur->get_property ("cross-staff");
+}
+
+MAKE_SCHEME_CALLBACK (Slur, calc_cross_staff, 1)
+SCM
+Slur::calc_cross_staff (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+
+  extract_grob_set (me, "note-columns", cols);
+  extract_grob_set (me, "encompass-objects", extras);
+
+  for (vsize i = 0; i < cols.size (); i++)
+    {
+      if (Grob *s = Note_column::get_stem (cols[i]))
+       if (to_boolean (s->get_property ("cross-staff")))
+         return SCM_BOOL_T;
+    }
+
+  /* the separation items are dealt with in replace_breakable_encompass_objects
+     so we can ignore them here */
+  vector<Grob*> non_sep_extras;
+  for (vsize i = 0; i < extras.size (); i++)
+    if (!Separation_item::has_interface (extras[i]))
+      non_sep_extras.push_back (extras[i]);
+
+  Grob *common = common_refpoint_of_array (cols, me, Y_AXIS);
+  common = common_refpoint_of_array (non_sep_extras, common, Y_AXIS);
+
+  return scm_from_bool (common != me->get_parent (Y_AXIS));
+}
+
+ADD_INTERFACE (Slur,
+              "A slur.",
               
               /* properties */
+              "annotation "
               "avoid-slur "    /* UGH. */
               "control-points "
               "dash-fraction "
@@ -244,12 +424,13 @@ ADD_INTERFACE (Slur, "slur-interface",
               "eccentricity "
               "encompass-objects "
               "height-limit "
+              "inspect-quants "
+              "inspect-index "
               "line-thickness "
               "note-columns "
               "positions "
               "quant-score "
               "ratio "
               "thickness "
-
               );