]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie.cc
Run `make grand-replace'.
[lilypond.git] / lily / tie.cc
index a4c5aaa929a8dc0aa9f285741cedaf3006b18d24..f02cddacf84a8f107cc637dcf72121c3c48332eb 100644 (file)
@@ -3,49 +3,57 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "tie.hh"
 
-#include <math.h>
-
-#include "spanner.hh"
+#include "main.hh"
+#include "bezier.hh"
+#include "directional-element-interface.hh"
+#include "font-interface.hh"
+#include "grob-array.hh"
 #include "lookup.hh"
+#include "note-head.hh"
 #include "output-def.hh"
-#include "rhythmic-head.hh"
-#include "bezier.hh"
 #include "paper-column.hh"
-#include "warn.hh"
+#include "pointer-group-interface.hh"
+#include "rhythmic-head.hh"
+#include "spanner.hh"
 #include "staff-symbol-referencer.hh"
-#include "directional-element-interface.hh"
-#include "bezier.hh"
 #include "stem.hh"
-#include "note-head.hh"
+#include "text-interface.hh"
 #include "tie-column.hh"
+#include "tie-configuration.hh"
+#include "tie-formatting-problem.hh"
+#include "warn.hh"
+#include "semi-tie-column.hh"
 
-/*
-  tie: Connect two noteheads.
-
-  What if we have
-
-  c4 ~ \clef bass ; c4 or
-
-  c4 \staffchange c4
 
-  do we have non-horizontal ties then?
-*/
+bool
+Tie::less (Grob *const &s1, Grob *const &s2)
+{
+  return Tie::get_position (s1) < Tie::get_position (s2);
+}
 
 void
 Tie::set_head (Grob *me, Direction d, Grob *h)
 {
   dynamic_cast<Spanner *> (me)->set_bound (d, h);
-  me->add_dependency (h);
 }
 
 Grob *
 Tie::head (Grob *me, Direction d)
 {
+  if (is_direction (me->get_property ("head-direction")))
+     {
+       Direction hd = to_dir (me->get_property ("head-direction"));
+       return (hd == d)
+        ? unsmob_grob (me->get_object ("note-head"))
+        : 0;
+     }
+  
   Item *it = dynamic_cast<Spanner*> (me)->get_bound (d);
   if (Note_head::has_interface (it))
     return it;
@@ -68,8 +76,24 @@ Tie::get_column_rank (Grob *me, Direction d)
 int
 Tie::get_position (Grob *me)
 {
-  Direction d = head (me, LEFT) ? LEFT : RIGHT;
-  return (int) Staff_symbol_referencer::get_position (head (me, d));
+  Direction d = LEFT;
+  do
+    {
+      Grob *h = head (me, d);
+      if (h)
+       return (int) rint (Staff_symbol_referencer::get_position (h));
+    }
+  while (flip (&d) != LEFT);
+
+  /*
+
+  TODO: this is theoretically possible for ties across more than 2
+  systems.. We should look at the first broken copy.
+  
+  */
+  programming_error ("Tie without heads. Suicide");
+  me->suicide ();
+  return 0;
 }
 
 /*
@@ -85,365 +109,95 @@ Tie::get_position (Grob *me)
 Direction
 Tie::get_default_dir (Grob *me)
 {
-  Item *sl = head (me, LEFT) ? Rhythmic_head::get_stem (head (me, LEFT)) : 0;
-  Item *sr = head (me, RIGHT) ? Rhythmic_head::get_stem (head (me, RIGHT)) : 0;
-  if (sl && sr)
-    {
-      if (get_grob_direction (sl) == UP
-         && get_grob_direction (sr) == UP)
-       return DOWN;
-    }
-  else if (sl || sr)
-    {
-      Item *s = sl ? sl : sr;
-      return -get_grob_direction (s);
-    }
-
-  return UP;
-}
-
-void
-Tie::set_direction (Grob *me)
-{
-  if (!get_grob_direction (me))
-    {
-      if (Tie_column::has_interface (me->get_parent (Y_AXIS)))
-       Tie_column::set_directions (me->get_parent (Y_AXIS));
-      else
-       set_grob_direction (me, Tie::get_default_dir (me));
-    }
-}
-
-Interval
-Tie::get_default_attachments (Spanner *me, Grob *common, Real gap,
-                             int *staff_position,
-                             bool *in_between
-                             )
-{
-  Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Direction dir = get_grob_direction (me);
-  Interval attachments;
+  Drul_array<Grob*> stems;
   Direction d = LEFT;
   do
     {
-      attachments[d]
-       = robust_relative_extent (me->get_bound (d),
-                                 common,
-                                 X_AXIS)[-d]
-       - gap * d;
-    }
-  while (flip (&d) != LEFT);
-
-  if (attachments.length () < 0.6 * staff_space)
-    {
-      /*
-       Let short ties start over note heads, instead of between.
-      */
-      Drul_array<bool> allow (true, true);
-
-      Direction d = LEFT;
-      do {
-       if (Note_head::has_interface (me->get_bound (d)))
-         {
-           Grob *stem = unsmob_grob (me->get_bound (d)->get_object ("stem"));
-           if (get_grob_direction (stem) == dir
-               && -d == dir)
-             allow[d] = false;
-         }
-      } while (flip (&d) != LEFT);
-
-      if (allow[LEFT] && allow[RIGHT])
-       {
-         *staff_position += dir;
-         do
-           {
-             if (Note_head::has_interface (me->get_bound (d)))
-               {
-                 Interval extent
-                   = robust_relative_extent (me->get_bound (d),
-                                             common, X_AXIS);
-
-                 attachments[d] = extent.linear_combination (- 0.5 * d);
-                 *in_between = false;
-               }
-           }
-         while (flip (&d) != LEFT);
-       }
-    }
-
-  return attachments;
-}  
+      Grob *one_head = head (me, d);
+      if (!one_head && dynamic_cast<Spanner*> (me)) 
+       one_head = Tie::head (dynamic_cast<Spanner*> (me)->broken_neighbor (d), d);
+      
+      Grob *stem = one_head ? Rhythmic_head::get_stem (one_head) : 0;
+      if (stem)
+       stem = Stem::is_invisible (stem) ? 0 : stem;
 
-Interval
-get_skyline_attachment (Drul_array< Array < Skyline_entry > > const &skylines,
-                       Real y)
-{
-  Interval attachments;
-  Direction d = LEFT;
-  do
-    {
-      attachments[d] = skyline_height (skylines[d], y, -d);
+      stems[d] = stem;
     }
-  while (flip (&d) != LEFT);
+  while (flip (&d)!= LEFT);
   
-  return attachments;
-}
-                       
-void
-Tie::get_configuration (Grob *me_grob, Grob *common,
-                       Tie_configuration *conf,
-                       Drul_array< Array < Skyline_entry > > const *skylines,
-                       Tie_details const &details
-                       )
-{
-  Spanner *me = dynamic_cast<Spanner*> (me_grob);
-  if (!head (me, LEFT) && !head (me, RIGHT))
+  if (stems[LEFT] && stems[RIGHT])
     {
-      programming_error ("tie without heads");
-      me->suicide ();
-      return ;
-    }
-
-  /*
-    UGH. Don't mirror Tie_configuration.
-   */
-  Direction dir = CENTER;
-  
-  int tie_position = (int) Tie::get_position (me);
-  int staff_position = (int) conf->position_;
-
-  if (conf->dir_)
-    {
-      dir = conf->dir_;
-    }
-  else
-    {
-      dir = get_grob_direction (me);
-      if (!dir)
-       dir = get_default_dir (me);
-    }
-
-  Real staff_space = details.staff_space_;
-
-  bool in_between = true;
-  Interval attachments = conf->attachment_x_;
-  Real gap = robust_scm2double (me->get_property ("x-gap"), 0.2);
-  if (attachments.is_empty())
-    {
-      if (!skylines)
-       attachments = get_default_attachments (me, common, gap,
-                                              &staff_position,
-                                              &in_between);
-      else
-       {
-         Real y = staff_space * 0.5 * staff_position;
-         attachments = get_skyline_attachment (*skylines, y);
-         attachments.widen (-gap);
-       }
+      if (get_grob_direction (stems[LEFT]) == UP
+         && get_grob_direction (stems[RIGHT]) == UP)
+       return DOWN;
     }
-
-  Bezier b = slur_shape (attachments.length(),
-                        details.height_limit_,
-                        details.ratio_);
-  b.scale (1, dir);
-  
-  Offset middle = b.curve_point (0.5);
-  Offset edge = b.curve_point (0.0);
-
-  staff_position = int (rint (staff_position));
-  
-  Real dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
-  bool in_space = !(Staff_symbol_referencer::on_staffline (me, (int) staff_position));
-  bool fits_in_space =
-    (dy < 0.6 * staff_space);
-  
-  /*
-    Avoid dot
-   */
-  Grob *left_dot = unsmob_grob (me->get_bound (LEFT)->get_object ("dot"));
-  int dot_pos = left_dot
-    ? int (Staff_symbol_referencer::get_position (left_dot))
-    : 0;
-  if (left_dot
-      && (staff_position == dot_pos
-         || staff_position + dir == dot_pos))
+  else if (stems[LEFT] || stems[RIGHT])
     {
-      staff_position += dir;
-      in_space = !in_space;
-
-      if (skylines)
-       {
-         Real y = staff_space * 0.5 * staff_position;
-         attachments = get_skyline_attachment (*skylines, y);
-         attachments.widen (-gap);
-         Bezier b = slur_shape (attachments.length(),
-                                details.height_limit_,
-                                details.ratio_);
-         Offset middle = b.curve_point (0.5);
-         Offset edge = b.curve_point (0.0);
-         dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
-         fits_in_space =
-           (dy < 0.6 * staff_space);
-       }
+      Grob *s = stems[LEFT] ? stems[LEFT] : stems[RIGHT];
+      return -get_grob_direction (s);
     }
+  else if (int p = get_position (me))
+    return Direction (sign (p));
   
-  /*
-    Avoid flag.
-  */
-  Grob *left_stem = unsmob_grob (me->get_bound (LEFT)->get_object ("stem"));
-  if (left_stem)
-    {
-      Stencil flag = Stem::get_translated_flag (left_stem);
-      Real y = staff_position * staff_space * 0.5;
-      if (flag.extent (Y_AXIS).contains (y))
-       {
-         staff_position += dir;
-         in_space = !in_space;
-       }
-    }
-
-  if (in_space != fits_in_space)
-    {
-      if (in_space)
-       {
-         staff_position += dir;
-       }
-      else
-       {
-         in_space = true;
-         staff_position += dir;
-       }
-
-      /*
-       ugh: code dup.
-       */
-      if (skylines)
-       {
-         Real y = staff_space * 0.5 * staff_position;
-         attachments = get_skyline_attachment (*skylines, y);
-         attachments.widen (-gap);
-             
-         Bezier b = slur_shape (attachments.length(),
-                                details.height_limit_,
-                                details.ratio_);
-         Offset middle = b.curve_point (0.5);
-         Offset edge = b.curve_point (0.0);
-         dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
-         fits_in_space =
-           (dy < 0.6 * staff_space);
-       }
-    }
+  return to_dir (me->get_property("neutral-direction"));
+}
 
 
-  /*
-    Putting larger in-space ties next to the notes forces
-    the edges to be opposite (Y-wise) to the tie direction.
-   */
-  if (staff_position == tie_position
-      && in_space
-      && Staff_symbol_referencer::staff_radius (me) > fabs (staff_position) / 2
-      && dy > 0.3 * staff_space)
+MAKE_SCHEME_CALLBACK (Tie, calc_direction, 1);
+SCM
+Tie::calc_direction (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  Grob *yparent = me->get_parent (Y_AXIS);
+  if ((Tie_column::has_interface (yparent)
+       || Semi_tie_column::has_interface (yparent)) 
+      && unsmob_grob_array (yparent->get_object ("ties"))
+      //      && unsmob_grob_array (yparent->get_object ("ties"))->size () > 1
+      )
     {
-      staff_position += 2 * dir; 
-    }
+      /* trigger positioning. */
+      (void) yparent->get_property ("positioning-done");
 
-  if (!in_between
-      && in_space
-      && fabs (staff_position - tie_position) <= 1)
-    staff_position += 2*dir;
-  
-  
-  conf->dir_ = dir;
-  conf->position_ = staff_position;
-  if (in_space)
-    {
-      if ((fabs (staff_position - tie_position) <= 1
-          && fabs (dy) < 0.45 * staff_space)
-         || fabs (dy) < 0.6 * staff_space)
-       {
-         /*
-           vertically center in space.
-         */
-         conf->dir_ = dir;
-         conf->position_ = staff_position;
-         conf->attachment_x_ = attachments;
-         conf->center_tie_vertically (details);
-       }
-      else
-       {
-         conf->delta_y_ = 
-           dir * staff_space * (- 0.3);
-       }
+      return me->get_property_data ("direction");
     }
   else
-    {
-      Real where = 0.5 * dir;
-      
-      Real rounding_dy = (where - middle[Y_AXIS]);
-      conf->delta_y_ = rounding_dy;
-
-      if (dir * (b.curve_point (0.0)[Y_AXIS]
-                + conf->position_ * staff_space * 0.5
-                + conf->delta_y_) <
-         dir * tie_position * 0.5 * staff_space)
-       {
-         if (Staff_symbol_referencer::staff_radius (me) >  fabs (tie_position) / 2)
-           conf->position_ +=  2 * dir;
-         else
-           conf->position_ += dir;
-       }
-    }
-
-
-  if (skylines)
-    {
-      Real half_space = 0.5 * staff_space;
-      Real y = staff_position * half_space;
-      
-      attachments = get_skyline_attachment (*skylines, y);
-      
-      attachments.widen (-gap);
-    }
-  conf->attachment_x_ = attachments;
+    return scm_from_int (Tie::get_default_dir (me));
 }
 
 
-void
-Tie::set_default_control_points (Grob *me_grob)
+SCM
+Tie::get_default_control_points (Grob *me_grob)
 {
   Spanner *me = dynamic_cast<Spanner*> (me_grob);
   Grob *common  = me;
   common = me->get_bound (LEFT)->common_refpoint (common, X_AXIS); 
   common = me->get_bound (RIGHT)->common_refpoint (common, X_AXIS); 
   
-  Tie_configuration conf;
-  if (!get_grob_direction (me))
-    set_grob_direction (me, get_default_dir (me));
+  Tie_formatting_problem problem;
+  problem.from_tie (me);
+  
+  Tie_specification spec = problem.get_tie_specification (0);
+  if (!me->is_live ())
+    return SCM_EOL;
 
-  int tie_position = (int) Tie::get_position (me);
-  conf.position_ = tie_position;
   
-  Tie_details details;
-  details.init (me);
-  get_configuration (me, common, &conf, 0, details);
-  set_control_points (me, common, conf, details);
+  Ties_configuration conf
+    = problem.generate_optimal_configuration ();
+  
+  return get_control_points (me, problem.common_x_refpoint (),
+                            conf[0], problem.details_);
 }
 
-void
-Tie::set_control_points (Grob *me,
+SCM
+Tie::get_control_points (Grob *me,
                         Grob *common,
                         Tie_configuration const &conf,
                         Tie_details const &details
                         )
 {
-  Bezier b = conf.get_bezier (details);
-  b.scale (1, conf.dir_);
-  b.translate (Offset (conf.attachment_x_[LEFT]
-                      - me->relative_coordinate (common, X_AXIS),
-                      0.5 * conf.position_ * details.staff_space_
-                      + conf.delta_y_
-                      ));
-  
+  Bezier b = conf.get_transformed_bezier (details);
+  b.translate (Offset (- me->relative_coordinate (common, X_AXIS), 0));
+
   SCM controls = SCM_EOL;
   for (int i = 4; i--;)
     {
@@ -451,53 +205,59 @@ Tie::set_control_points (Grob *me,
        programming_error ("Insane offset");
       controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
     }
-  me->set_property ("control-points", controls);
+  return controls;
 }
 
-
-
-MAKE_SCHEME_CALLBACK (Tie, print, 1);
+MAKE_SCHEME_CALLBACK (Tie, calc_control_points, 1);
 SCM
-Tie::print (SCM smob)
+Tie::calc_control_points (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
 
-  if (CENTER == get_grob_direction (me))
-    set_direction (me);
-
-  if (!get_grob_direction (me))
-    me->programming_error ("Tie direction not set."); 
-    
-  SCM cp = me->get_property ("control-points");
-  if (!scm_is_pair (cp))
+  Grob *yparent = me->get_parent (Y_AXIS);
+  if ((Tie_column::has_interface (yparent)
+       || Semi_tie_column::has_interface (yparent)) 
+      && unsmob_grob_array (yparent->get_object ("ties")))
     {
-      /*
-       UGH.  dependency tracking!
-       */
-      if (Tie_column::has_interface (me->get_parent (Y_AXIS)))
+      extract_grob_set (yparent, "ties", ties);
+      if (me->original() && ties.size() == 1
+         && !to_dir (me->get_property_data ("direction")))
        {
-         Tie_column::set_directions (me->get_parent (Y_AXIS));
-       }
-
-      cp = me->get_property ("control-points");
+         assert (ties[0] == me);
+         set_grob_direction (me, Tie::get_default_dir (me));
+           
+       }      
+      /* trigger positioning. */
+      (void) yparent->get_property ("positioning-done");
     }
-  
+
+  SCM cp = me->get_property_data ("control-points");
   if (!scm_is_pair (cp))
     {
-      set_default_control_points (me);
-      cp = me->get_property ("control-points");
+      cp = get_default_control_points (me);
     }
 
-  if (!scm_is_pair (cp))
-    return Stencil ().smobbed_copy ();
+  return cp;
+}
+
+/*
+  TODO: merge with Slur::print.
+ */
+MAKE_SCHEME_CALLBACK (Tie, print, 1);
+SCM
+Tie::print (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  
+  SCM cp = me->get_property ("control-points");
 
   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
-  Real base_thick = robust_scm2double (me->get_property ("thickness"), 1);
-  Real thick = base_thick * staff_thick;
+  Real base_thick = staff_thick * robust_scm2double (me->get_property ("thickness"), 1);
+  Real line_thick = staff_thick * robust_scm2double (me->get_property ("line-thickness"), 1);
 
   Bezier b;
   int i = 0;
-  for (SCM s = cp; s != SCM_EOL; s = scm_cdr (s))
+  for (SCM s = cp; scm_is_pair (s); s = scm_cdr (s))
     {
       b.control_[i] = ly_scm2offset (scm_car (s));
       i++;
@@ -509,26 +269,66 @@ Tie::print (SCM smob)
   SCM f = me->get_property ("dash-fraction");
   if (scm_is_number (p) && scm_is_number (f))
     a = Lookup::dashed_slur (b,
-                            thick,
+                            line_thick,
                             robust_scm2double (p, 1.0),
                             robust_scm2double (f, 0));
   else
     a = Lookup::slur (b,
-                     get_grob_direction (me) * staff_thick,
-                     thick);
+                     get_grob_direction (me) * base_thick,
+                     line_thick);
+
+#if DEBUG_TIE_SCORING
+  SCM annotation = me->get_property ("annotation");
+  if (!scm_is_string (annotation))
+    {
+      SCM debug = me->layout ()->lookup_variable (ly_symbol2scm ("debug-tie-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);
+
+      Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
+                                   (me->layout ()->self_scm (), properties,
+                                    annotation));
+      tm.translate (Offset (b.control_[3][X_AXIS] + 0.5,
+                           b.control_[0][Y_AXIS] * 2));
+      tm = tm.in_color (1, 0, 0);
+
+      /*
+       It would be nice if we could put this in a different layer,
+       but alas, this must be done with a Tie override.
+       */
+      a.add_stencil (tm);
+    }
+#endif
 
   return a.smobbed_copy ();
 }
 
 ADD_INTERFACE (Tie,
-              "tie-interface",
-              
-              "A tie connecting two noteheads.\n",
+              "A horizontal curve connecting two noteheads.",
               
+              /* properties */
+              "annotation "
+              "avoid-slur "    //  UGH.
               "control-points "
               "dash-fraction "
               "dash-period "
               "details "
               "direction "
+              "head-direction "
+              "line-thickness "
+              "neutral-direction "
+              "quant-score "
+              "separation-item "
+              "staff-position "
               "thickness "
-              "x-gap ");
+              );
+
+
+
+
+