]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie.cc
* scm/define-context-properties.scm
[lilypond.git] / lily / tie.cc
index 46c42a819b3cc5c8199c898761ee92ca4e2e7d68..017dba751ea425aff1648aabd688063f9ee06a44 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
-#include <math.h>
-
 
+#include "tie.hh"
 #include "spanner.hh"
 #include "lookup.hh"
-#include "paper-def.hh"
-#include "tie.hh"
+#include "output-def.hh"
 #include "rhythmic-head.hh"
 #include "bezier.hh"
 #include "paper-column.hh"
 #include "warn.hh"
 #include "staff-symbol-referencer.hh"
 #include "directional-element-interface.hh"
-#include "molecule.hh"
-#include "bezier-bow.hh"
+#include "bezier.hh"
 #include "stem.hh"
 #include "note-head.hh"
+#include "tie-column.hh"
+#include "grob-array.hh"
 
-/*
-  tie: Connect two noteheads.
-
-  What if we have
-
-  c4 ~ \clef bass ; c4 or
-
-  c4 \staffchange c4
-
-  do we have non-horizontal ties then?
-  */
-
-
-void
-Tie::set_head (Grob*me,Direction d, Grob * h)
+int
+Tie::compare (Grob *const &s1,
+             Grob *const &s2)
 {
-  assert (!head (me,d));
-  index_set_cell (me->get_grob_property ("heads"), d, h->self_scm ());
-  
-  dynamic_cast<Spanner*> (me)->set_bound (d, h);
-  me->add_dependency (h);
+  return sign (Tie::get_position (s1) - Tie::get_position (s2));
 }
 
 void
-Tie::set_interface (Grob*me)
+Tie::set_head (Grob *me, Direction d, Grob *h)
 {
-  me->set_grob_property ("heads", gh_cons (SCM_EOL, SCM_EOL));
+  dynamic_cast<Spanner *> (me)->set_bound (d, h);
 }
 
+Grob *
+Tie::head (Grob *me, Direction d)
+{
+  Item *it = dynamic_cast<Spanner*> (me)->get_bound (d);
+  if (Note_head::has_interface (it))
+    return it;
+  else
+    return 0;
+}
 
-Grob*
-Tie::head (Grob*me, Direction d) 
+int
+Tie::get_column_rank (Grob *me, Direction d)
 {
-  SCM c = me->get_grob_property ("heads");
-  c = index_get_cell (c, d);
+  Spanner *span = dynamic_cast<Spanner *> (me);
+  Grob *h = head (me, d);
+  if (!h)
+    h = span->get_bound (d);
 
-  return unsmob_grob (c);
+  Grob *col = dynamic_cast<Item *> (h)->get_column ();
+  return Paper_column::get_rank (col);
 }
 
-Real
-Tie::get_position (Grob*me) 
+int
+Tie::get_position (Grob *me)
 {
-  Direction d = head (me,LEFT) ? LEFT:RIGHT;
-  return Staff_symbol_referencer::get_position (head (me,d));
-}
+  Direction d = LEFT;
+  do
+    {
+      Grob *h = head (me, d);
+      if (h)
+       return (int) 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;
+}
 
 /*
   Default:  Put the tie oppositie of the stem [Wanske p231]
 
   In case of chords: Tie_column takes over
-  
+
   The direction of the Tie is more complicated (See [Ross] p136 and
   further).
+
+  (what about linebreaks? )
 */
 Direction
-Tie::get_default_dir (Grob*me) 
+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;  
-
+  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 (Directional_element_interface::get (sl) == UP
-         && Directional_element_interface::get (sr) == UP)
+      if (get_grob_direction (sl) == UP
+         && get_grob_direction (sr) == UP)
        return DOWN;
     }
   else if (sl || sr)
     {
       Item *s = sl ? sl : sr;
-      return - Directional_element_interface::get (s);
+      return -get_grob_direction (s);
     }
 
-  
   return UP;
 }
 
 
+MAKE_SCHEME_CALLBACK(Tie, calc_direction, 1);
 SCM
-Tie::get_control_points (SCM smob)
-{  
-  Spanner*me = unsmob_spanner (smob);
-  Direction headdir = CENTER; 
-  if (head (me,LEFT))
-    headdir = LEFT;
-  else if (head (me,RIGHT))
-    headdir = RIGHT;
-  else
+Tie::calc_direction (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  Grob *yparent = me->get_parent (Y_AXIS);
+  if (Tie_column::has_interface (yparent)
+      && unsmob_grob_array (yparent->get_object ("ties"))
+      && unsmob_grob_array (yparent->get_object ("ties"))->size () > 1)
     {
-      programming_error ("Tie without heads.");
-      me->suicide ();
-      return SCM_UNSPECIFIED;
+      /* trigger positioning. */
+      (void) yparent->get_property ("positioning-done");
     }
+  else
+    set_grob_direction (me, Tie::get_default_dir (me));
 
-  
-  if (!Directional_element_interface::get (me))
-    Directional_element_interface::set (me, Tie::get_default_dir (me));
-  Direction dir = Directional_element_interface::get (me);
-  
-  Real staff_space = Staff_symbol_referencer::staff_space (me);
-
-  Real x_gap_f = gh_scm2double (me->get_grob_property ("x-gap"));
-
-  Grob* l = me->get_bound (LEFT);
-  Grob* r = me->get_bound (RIGHT);  
-
-  Grob* commonx = me->common_refpoint (l, X_AXIS);
-  commonx = me->common_refpoint (r, X_AXIS);
-  
-  Real left_x;
+  return SCM_UNSPECIFIED;
+}
 
-  /*
-     the tie has to be long enough to be visible, but should not go
-    through key sigs. In the 1.5 series the pref.matter - note
-    distance is fixed , so this won't be a problem anymore.
-   */
-  Real lambda = 0.9;           
-  
-  if (Note_head::has_interface (l))
+Interval
+Tie::get_default_attachments (Spanner *me, Grob *common, Real gap,
+                             int *staff_position,
+                             bool *in_between,
+                             Tie_details const &details
+                             )
+{
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
+  Direction dir = get_grob_direction (me);
+  Interval attachments;
+  Direction d = LEFT;
+  do
     {
-      Real where = RIGHT;
+      attachments[d]
+       = robust_relative_extent (me->get_bound (d),
+                                 common,
+                                 X_AXIS)[-d]
+       - gap * d;
+    }
+  while (flip (&d) != LEFT);
 
+  if (attachments.length () < details.between_length_limit_ * staff_space)
+    {
       /*
-       This correction is due te the shape of the black note head.
-       */
-      if (Rhythmic_head::duration_log (l) == 2)
-       where += dir* 0.2;
-      left_x = l->extent (l, X_AXIS).linear_combination (where)
-       + x_gap_f;
+       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);
+       }
     }
-  else
-    left_x = l->extent (l, X_AXIS).linear_combination (lambda);
-  
 
-  Real width;
-  if (Note_head::has_interface (l) && Note_head::has_interface (r))
+  return attachments;
+}  
+
+Interval
+get_skyline_attachment (Drul_array< Array < Skyline_entry > > const &skylines,
+                       Real y)
+{
+  Interval attachments;
+  Direction d = LEFT;
+  do
     {
-      width = 
-       + r->extent (commonx,X_AXIS)[LEFT]
-       - l->extent (commonx, X_AXIS)[RIGHT]
-       -2 * x_gap_f;
+      attachments[d] = skyline_height (skylines[d], y, -d);
     }
-  else
+  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 (Note_head::has_interface (l))
-       width = r->relative_coordinate (commonx, X_AXIS)
-         - l->extent (commonx, X_AXIS)[RIGHT]
-         - 2 * x_gap_f;
-      else
-       width =
-         - l->extent (commonx, X_AXIS).linear_combination (lambda)  
-         + r->extent (commonx, X_AXIS)[LEFT]
-         - 2 * x_gap_f;
+      programming_error ("tie without heads");
+      me->suicide ();
+      return ;
     }
-  
-
 
-  SCM details = me->get_grob_property ("details");
-
-  SCM lim // groetjes aan de chirurgendochter.
-    = scm_assq (ly_symbol2scm ("height-limit"),details);
-  
-  Real h_inf = gh_scm2double (ly_cdr (lim)) *  staff_space;
-  Real r_0 = gh_scm2double (ly_cdr (scm_assq (ly_symbol2scm ("ratio"),details)));
-
-  Bezier b  = slur_shape (width, h_inf, r_0);
-  
   /*
-    I think this better, particularly for small ties. It always allows the user to move ties if
-    they seem in the wrong place
-
-    TODO: what if 2 heads have different size.
-
-  */
+    UGH. Don't mirror Tie_configuration.
+   */
+  conf->head_position_ = (int) Tie::get_position (me);
+  if (!conf->dir_)
+    conf->dir_ = get_grob_direction (me);
+  if (!conf->dir_)
+    conf->dir_ = get_default_dir (me);
 
-  Real ypos = Tie::get_position (me) * staff_space/2
-    + dir * gh_scm2double (me->get_grob_property ("y-offset"));;
+  Real staff_space = details.staff_space_;
+  bool in_between = true;
+  Real gap = robust_scm2double (me->get_property ("x-gap"), 0.2);
 
-  /*
-    Make sure we don't start on a dots
-   */
-  if (Note_head::has_interface (l) && Rhythmic_head::get_dots (l))
+  if (conf->attachment_x_.is_empty())
     {
-      Grob* dots = Rhythmic_head::get_dots (l);
-      if(fabs (staff_space * Staff_symbol_referencer::get_position (dots) /2
-              - ypos) < 0.5)
+      if (!skylines)
+       conf->attachment_x_ = get_default_attachments (me, common, gap,
+                                                      &conf->position_,
+                                                      &in_between, details);
+      else
        {
-         ypos += 0.5 * dir ;
+         Real y = staff_space * 0.5 * conf->position_;
+         conf->attachment_x_ = get_skyline_attachment (*skylines, y);
+         conf->attachment_x_.widen (-gap);
        }
     }
 
+  Bezier b = slur_shape (conf->attachment_x_.length(),
+                        details.height_limit_,
+                        details.ratio_);
+  b.scale (1, conf->dir_);
   
-  /*
-    todo: prevent ending / staffline collision.
+  Offset middle = b.curve_point (0.5);
+  Offset edge = b.curve_point (0.0);
 
-    todo: tie / stem collision
+  conf->position_ = int (rint (conf->position_));
+  
+  Real dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
+  bool in_space = !(Staff_symbol_referencer::on_staffline (me, (int) conf->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
+      && (conf->position_ == dot_pos
+         || conf->position_ + conf->dir_ == dot_pos))
+    {
+      conf->position_ += conf->dir_;
+      in_space = !in_space;
 
-  b = slur_shape (width,h_inf, r_0);
-  b.scale (1, dir);
-  b.translate (Offset (left_x, ypos));
+      if (skylines)
+       {
+         Real y = staff_space * 0.5 * conf->position_;
+         conf->attachment_x_ = get_skyline_attachment (*skylines, y);
+         conf->attachment_x_.widen (-gap);
+         Bezier b = slur_shape (conf->attachment_x_.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);
+       }
+    }
   
-
   /*
-    Avoid colliding of the horizontal part with stafflines.
-
-    
-    TODO: redo this, heuristic is half-baken, and ties often look ugly
-    as a result.
+    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 = conf->position_ * staff_space * 0.5;
+      if (flag.extent (Y_AXIS).contains (y))
+       {
+         conf->position_ += conf->dir_;
+         in_space = !in_space;
+       }
+    }
 
-    TODO: doesn't work when on staff with even number of lines.
-   */
-  Array<Real> horizontal (b.solve_derivative (Offset (1,0)));
-  if (horizontal.size ())
+  if (in_space != fits_in_space)
     {
+      if (in_space)
+       {
+         conf->position_ += conf->dir_;
+       }
+      else
+       {
+         in_space = true;
+         conf->position_ += conf->dir_;
+       }
+
       /*
-       ugh. Doesnt work for non-horizontal curves.
+       ugh: code dup.
        */
-      Real y = b.curve_point (horizontal[0])[Y_AXIS];
+      if (skylines)
+       {
+         Real y = staff_space * 0.5 * conf->position_;
+         conf->attachment_x_ = get_skyline_attachment (*skylines, y);
+         conf->attachment_x_.widen (-gap);
+             
+         Bezier b = slur_shape (conf->attachment_x_.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);
+       }
+    }
 
-      Real ry = rint (y/staff_space) * staff_space;
-      Real diff = ry - y;
-      Real newy = y;
 
-      Real clear = staff_space * gh_scm2double (me->get_grob_property ("staffline-clearance"));
+  /*
+    Putting larger in-space ties next to the notes forces
+    the edges to be opposite (Y-wise) to the tie direction.
+   */
+  if (conf->position_ == conf->head_position_
+      && in_space
+      && Staff_symbol_referencer::staff_radius (me) > abs (conf->position_) / 2
+      && dy > 0.3 * staff_space
+      )
+    {
+      conf->position_ += 2 * conf->dir_; 
+    }
 
-      if (fabs (y) <=
-         Staff_symbol_referencer::staff_radius (me) * staff_space + clear
-         && fabs (diff) < clear)
+  if (!in_between
+      && in_space
+      && abs (conf->position_ - conf->head_position_) <= 1)
+    conf->position_ += 2*conf->dir_;
+  
+  
+  if (in_space)
+    {
+      if ((abs (conf->position_ - conf->head_position_) <= 1
+          && fabs (dy) < 0.45 * staff_space)
+         || fabs (dy) < 0.6 * staff_space)
        {
-         Real y1 = ry + clear;
-         Real y2 = ry - clear;
-
-         /*
-           ugh, we shove the 0.5 out of our sleeves.
-
-           Any way. This test is to make sure that staffline
-           collision avoidance does not result in completely flat
-           ties.
-          */
-         if (fabs (y1 - ypos) < 0.5)
-           y1 = y2;
-         else if (fabs (y2 - ypos) < 0.5)
-           y2 = y1;
-         
-         newy = (fabs (y1 - y) < fabs (y2 - y)) ? y1 : y2;
-         
-         // newy = ry - 0.5 * staff_space * sign (diff) ;
-
          /*
-           we don't want horizontal ties
-          */
-         if (fabs (newy - b.control_[0][Y_AXIS]) < 1e-2)
-           {
-             newy = newy + dir * staff_space; 
-           }
+           vertically center in space.
+         */
+         conf->center_tie_vertically (details);
+       }
+      else
+       {
+         conf->delta_y_ = 
+           conf->dir_ * staff_space * (- 0.3);
        }
-
-      Real y0 = b.control_ [0][Y_AXIS];
-      b.control_[2][Y_AXIS] = 
-      b.control_[1][Y_AXIS] =
- (b.control_[1][Y_AXIS] - y0)  * ((newy - y0) / (y - y0)) + y0; 
     }
   else
-    programming_error ("Tie is nowhere horizontal");
+    {
+      Real where = 0.5 * conf->dir_;
+      
+      Real rounding_dy = (where - middle[Y_AXIS]);
+      conf->delta_y_ = rounding_dy;
+
+      if (conf->dir_ * (b.curve_point (0.0)[Y_AXIS]
+                + conf->position_ * staff_space * 0.5
+                + conf->delta_y_) <
+         conf->dir_ * conf->head_position_ * 0.5 * staff_space)
+       {
+         if (Staff_symbol_referencer::staff_radius (me) >  abs (conf->head_position_) / 2)
+           conf->position_ +=  2 * conf->dir_;
+         else
+           conf->position_ += conf->dir_;
+       }
+    }
 
 
+  if (skylines)
+    {
+      Real half_space = 0.5 * staff_space;
+      Real y = conf->position_ * half_space;
+      
+      conf->attachment_x_ = get_skyline_attachment (*skylines, y);
+      conf->attachment_x_.widen (-gap);
+    }
+}
 
-  SCM controls = SCM_EOL;
-  for (int i= 4; i--;)
-    controls = gh_cons (ly_offset2scm (b.control_[i]), controls);
-  return controls;
+
+void
+Tie::set_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;
+  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);
 }
 
+void
+Tie::set_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_
+                      ));
+  
+  SCM controls = SCM_EOL;
+  for (int i = 4; i--;)
+    {
+      if (!b.control_[i].is_sane ())
+       programming_error ("Insane offset");
+      controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
+    }
+  me->set_property ("control-points", controls);
+}
 
-MAKE_SCHEME_CALLBACK (Tie,brew_molecule,1);
+MAKE_SCHEME_CALLBACK(Tie, calc_control_points, 1);
 SCM
-Tie::brew_molecule (SCM smob) 
+Tie::calc_control_points (SCM smob)
 {
-  Grob*me = unsmob_grob (smob);
+  Grob *me = unsmob_grob (smob);
+
+  // trigger Tie-column
+  (void)  get_grob_direction (me);
 
-  SCM cp = me->get_grob_property ("control-points");
-  if (cp == SCM_EOL)
+  if (!scm_is_pair (me->get_property ("control-points")))
     {
-      cp = get_control_points (smob);
-      me->set_grob_property ("control-points", cp);
+      set_default_control_points (me);
     }
+
+  return SCM_UNSPECIFIED;
+}
+
+
+MAKE_SCHEME_CALLBACK (Tie, print, 1);
+SCM
+Tie::print (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
   
-  Real thick =
-    gh_scm2double (me->get_grob_property ("thickness"))
-    * me->get_paper ()->get_var ("linethickness");
+  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;
 
   Bezier b;
   int i = 0;
-  for (SCM s= cp; s != SCM_EOL; s = ly_cdr (s))
+  for (SCM s = cp; s != SCM_EOL; s = scm_cdr (s))
     {
-      b.control_[i] = ly_scm2offset (ly_car (s));
+      b.control_[i] = ly_scm2offset (scm_car (s));
       i++;
     }
-  
-   Molecule a = Lookup::slur (b, Directional_element_interface::get (me) * thick, thick);
-   
-   return a.smobbed_copy ();
-}
 
+  Stencil a;
+
+  SCM p = me->get_property ("dash-period");
+  SCM f = me->get_property ("dash-fraction");
+  if (scm_is_number (p) && scm_is_number (f))
+    a = Lookup::dashed_slur (b,
+                            thick,
+                            robust_scm2double (p, 1.0),
+                            robust_scm2double (f, 0));
+  else
+    a = Lookup::slur (b,
+                     get_grob_direction (me) * staff_thick,
+                     thick);
 
+  return a.smobbed_copy ();
+}
 
-ADD_INTERFACE (Tie,"tie-interface",
-  "A tie connecting two noteheads.
-direction = Forced direction for all ties",
-  "y-offset staffline-clearance control-points heads details thickness x-gap direction minimum-length");
+ADD_INTERFACE (Tie,
+              "tie-interface",
+              
+              "A tie connecting two noteheads. \n\n"
+              ,
+              
+
+              /* properties */
+              "control-points "
+              "dash-fraction "
+              "dash-period "
+              "details "
+              "direction "
+              "thickness "
+              "x-gap ");