]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie.cc
* configure.in: Test for and accept lmodern if EC fonts not found.
[lilypond.git] / lily / tie.cc
index 2b214131b1f4d5f4ee03169d1bfa4a0b5ac7d24f..36db5cb037b18e36539f6fee6538f066147eb824 100644 (file)
@@ -3,23 +3,26 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
-#include <math.h>
+
+#include "tie.hh"
+
+#include <cmath>
 
 #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 "debug.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"
 
 /*
   tie: Connect two noteheads.
 
 
 void
-Tie::set_head (Score_element*me,Direction d, Item * head_l)
+Tie::set_head (Grob*me,Direction d, Grob * h)
 {
   assert (!head (me,d));
-  index_set_cell (me->get_elt_property ("heads"), d, head_l->self_scm ());
+  index_set_cell (me->get_property ("head-pair"), d, h->self_scm ());
   
-  dynamic_cast<Spanner*> (me)->set_bound (d, head_l);
-  me->add_dependency (head_l);
+  dynamic_cast<Spanner*> (me)->set_bound (d, h);
+  me->add_dependency (h);
 }
 
 void
-Tie::set_interface (Score_element*me)
+Tie::set_interface (Grob*me)
 {
-  me->set_elt_property ("heads", gh_cons (SCM_EOL, SCM_EOL));
-  me->set_interface (ly_symbol2scm ("tie-interface"));
+  me->set_property ("head-pair", scm_cons (SCM_EOL, SCM_EOL));
 }
 
-bool
-Tie::has_interface (Score_element*me)
-{
-  return me->has_interface (ly_symbol2scm ("tie-interface"));
-}
 
-Score_element*
-Tie::head (Score_element*me, Direction d) 
+Grob*
+Tie::head (Grob*me, Direction d) 
 {
-  SCM c = me->get_elt_property ("heads");
-  c = index_cell (c, d);
+  SCM c = me->get_property ("head-pair");
 
-  return unsmob_element (c);
+  if (scm_is_pair (c))
+    return unsmob_grob (index_get_cell (c, d));
+  else
+    return 0;
 }
 
 Real
-Tie::position_f (Score_element*me) 
+Tie::get_position (Grob*me) 
 {
   Direction d = head (me,LEFT) ? LEFT:RIGHT;
-  return Staff_symbol_referencer::position_f (head (me,d));
+  return Staff_symbol_referencer::get_position (head (me,d));
 }
 
 
 /*
+  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), the case of multiple ties is handled by Tie_column.
+  further).
+
+  (what about linebreaks? )  
+  
 */
 Direction
-Tie::get_default_dir (Score_element*me) 
+Tie::get_default_dir (Grob*me) 
 {
-  Item * sl =  head(me,LEFT) ? Rhythmic_head::stem_l (head (me,LEFT)) :0;
-  Item * sr =  head(me,RIGHT) ? Rhythmic_head::stem_l (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 (sl).get () == UP
-         && Directional_element_interface (sr).get () == 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 (s). get ();
+      return - get_grob_direction (s);
     }
 
   
@@ -102,88 +106,155 @@ Tie::get_default_dir (Score_element*me)
 }
 
 
+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));
+    }
+}
+
+/*
+  TODO: we should also use thickness for computing the clearance
+  between head and tie. Very thick ties will now touch the note head.
+  
+  */
 SCM
 Tie::get_control_points (SCM smob)
 {  
-  Spanner*me = dynamic_cast<Spanner*> (unsmob_element (smob));
+  Spanner*me = unsmob_spanner (smob);
   Direction headdir = CENTER; 
   if (head (me,LEFT))
     headdir = LEFT;
-  else if (head(me,RIGHT))
+  else if (head (me,RIGHT))
     headdir = RIGHT;
   else
     {
       programming_error ("Tie without heads.");
       me->suicide ();
-      return SCM_UNSPECIFIED;
+      return SCM_EOL;
     }
-  
-  if (!Directional_element_interface (me).get ())
-    Directional_element_interface (me).set (Tie::get_default_dir (me));
+
+  set_direction (me);
+
+  Direction dir = get_grob_direction (me);
   
   Real staff_space = Staff_symbol_referencer::staff_space (me);
 
-  Real x_gap_f = me->paper_l ()->get_var ("tie_x_gap");
+  Real x_gap_f = robust_scm2double (me->get_property ("x-gap"), 0);
 
-  Score_element* commonx = me->common_refpoint (me->get_bound (LEFT), X_AXIS);
-  commonx = me->common_refpoint (me->get_bound (RIGHT), X_AXIS);
-  
-  Score_element* l = me->get_bound (LEFT);
-  Score_element* r = me->get_bound (RIGHT);  
-  Real width = r->relative_coordinate (commonx, X_AXIS)
-    + r->extent (X_AXIS)[LEFT]
-    - l->relative_coordinate (commonx, X_AXIS)
-    - l->extent (X_AXIS)[RIGHT]
-    -2* x_gap_f;
-
-  Real left_x = l->extent (X_AXIS)[RIGHT] + x_gap_f;
+  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);
   
-  Direction dir = Directional_element_interface (me).get();
+  Real left_x;
+
+  /*
+     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;           
   
-  Real h_inf = me->paper_l ()->get_var ("tie_height_limit_factor") * staff_space;
-  Real r_0 = me->paper_l ()->get_var ("tie_ratio");
+  if (Note_head::has_interface (l))
+    {
+      Real where = RIGHT;
 
+      /*
+       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;
+    }
+  else
+    left_x = l->extent (l, X_AXIS).linear_combination (lambda);
+  
 
-  Bezier b  = slur_shape (width, h_inf, r_0);
+  Real width;
+  if (Note_head::has_interface (l) && Note_head::has_interface (r))
+    {
+      width = 
+       + r->extent (commonx,X_AXIS)[LEFT]
+       - l->extent (commonx, X_AXIS)[RIGHT]
+       -2 * x_gap_f;
+    }
+  else
+    {
+      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;
+    }
   
-  Offset leave_dir = b.control_[1] - b.control_[0];
 
-  Real dx = (head (me, headdir)->extent (X_AXIS).length () + x_gap_f)/2.0;
-  Real max_gap = leave_dir[Y_AXIS] * dx / leave_dir[X_AXIS];
 
-  /*
-    for small ties (t small) we want to start in the Y-center (so dy = 0), for
-    large ties, the tie should appear to come from the center of the
-    head, so dy = max_gap
+  SCM details = me->get_property ("details");
 
-    maybe use a different formula?
+  SCM lim // groetjes aan de chirurgendochter.
+    = scm_assq (ly_symbol2scm ("height-limit"),details);
+  
+  Real h_inf = scm_to_double (scm_cdr (lim)) *  staff_space;
+  Real r_0 = scm_to_double (scm_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.
 
-    TODO: for small ties, it is better to start over the heads
-    iso. next to the heads. 
   */
-  Real t = (width / staff_space - 5.0);        // ugh.
-  Real dy = t > 0 ? max_gap * sqr (t / (1 + t)) : 0.0;
 
-  Real ypos = Tie::position_f (me) * staff_space/2 + dir * dy;
+  Real ypos = Tie::get_position (me) * staff_space/2
+    + dir * scm_to_double (me->get_property ("y-offset"));;
+
+  /*
+    Make sure we don't start on a dots
+   */
+  if (Note_head::has_interface (l) && Rhythmic_head::get_dots (l))
+    {
+      Grob* dots = Rhythmic_head::get_dots (l);
+      if (fabs (staff_space * Staff_symbol_referencer::get_position (dots) /2
+              - ypos) < 0.5)
+       {
+         ypos += 0.5 * dir ;
+       }
+    }
 
+  
   /*
     todo: prevent ending / staffline collision.
 
     todo: tie / stem collision
    */
 
-  b = slur_shape(width,h_inf, r_0);
+  b = slur_shape (width,h_inf, r_0);
   b.scale (1, dir);
   b.translate (Offset (left_x, ypos));
   
 
   /*
     Avoid colliding of the horizontal part with stafflines.
+
     
-    should do me for slurs as well.
+    TODO: redo this, heuristic is half-baken, and ties often look ugly
+    as a result.
 
+    TODO: doesn't work when on staff with even number of lines.
    */
   Array<Real> horizontal (b.solve_derivative (Offset (1,0)));
   if (horizontal.size ())
@@ -196,16 +267,45 @@ Tie::get_control_points (SCM smob)
       Real ry = rint (y/staff_space) * staff_space;
       Real diff = ry - y;
       Real newy = y;
-      if (fabs (y) <= Staff_symbol_referencer::staff_radius (me)
-         && fabs (diff) < me->paper_l ()->get_var ("tie_staffline_clearance"))
+
+      Real clear = staff_space * scm_to_double (me->get_property ("staffline-clearance"));
+
+      if (fabs (y) <=
+         Staff_symbol_referencer::staff_radius (me) * staff_space + clear
+         && fabs (diff) < clear)
        {
-         newy = ry - 0.5 * staff_space * sign (diff) ;
+         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; 
+           }
        }
 
       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; 
+ (b.control_[1][Y_AXIS] - y0)  * ((newy - y0) / (y - y0)) + y0; 
     }
   else
     programming_error ("Tie is nowhere horizontal");
@@ -214,60 +314,47 @@ Tie::get_control_points (SCM smob)
 
   SCM controls = SCM_EOL;
   for (int i= 4; i--;)
-    controls = gh_cons ( ly_offset2scm (b.control_[i]), controls);
+    controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
   return controls;
 }
 
-MAKE_SCHEME_CALLBACK(Tie,set_spacing_rods);
 
-/*
-  TODO: set minimum distances for begin/end of line
- */
+MAKE_SCHEME_CALLBACK (Tie,print,1);
 SCM
-Tie::set_spacing_rods (SCM smob)  
+Tie::print (SCM smob) 
 {
-  Score_element*me = unsmob_element (smob);
-  Spanner*sp = dynamic_cast<Spanner*> (me);
-  Rod r;
+  Grob*me = unsmob_grob (smob);
 
-  r.item_l_drul_ [LEFT]=sp->get_bound (LEFT);
-  r.item_l_drul_ [RIGHT]=sp->get_bound (RIGHT);  
-  
-  r.distance_f_
-    = gh_scm2double (me->get_elt_property ("minimum-length"))
-    * me->paper_l ()->get_var ("staffspace");
-  r.add_to_cols ();
-  return SCM_UNSPECIFIED;
-}
-
-MAKE_SCHEME_CALLBACK(Tie,brew_molecule);
-SCM
-Tie::brew_molecule (SCM smob) 
-{
-  Score_element*me = unsmob_element (smob);
-
-  SCM cp = me->get_elt_property ("control-points");
-  if (cp == SCM_EOL)
+  SCM cp = me->get_property ("control-points");
+  if (!scm_is_pair (cp))               // list is more accurate
     {
       cp = get_control_points (smob);
-      me->set_elt_property ("control-points", cp);
+      me->set_property ("control-points", cp);
     }
+
+  if (!scm_is_pair (cp))
+    return Stencil ().smobbed_copy ();
   
-  Real thick =
-    gh_scm2double (me->get_elt_property ("thickness"))
-    * me->paper_l ()->get_var ("stafflinethickness");
+  Real thick
+    = Staff_symbol_referencer::line_thickness (me)
+    *  robust_scm2double (me->get_property ("thickness"), 1);
 
   Bezier b;
   int i = 0;
-  for (SCM s= cp; s != SCM_EOL; s = gh_cdr (s))
+  for (SCM s= cp; s != SCM_EOL; s = scm_cdr (s))
     {
-      b.control_[i] = ly_scm2offset (gh_car (s));
+      b.control_[i] = ly_scm2offset (scm_car (s));
       i++;
     }
   
-   Molecule a = me->lookup_l ()->slur (b, Directional_element_interface (me).get () * thick, thick);
+   Stencil a = Lookup::slur (b, get_grob_direction (me) * thick, thick);
    
-   return a.create_scheme ();
+   return a.smobbed_copy ();
 }
 
 
+
+ADD_INTERFACE (Tie,"tie-interface",
+              "A tie connecting two noteheads.\n"
+              ,
+  "y-offset staffline-clearance control-points head-pair details thickness x-gap direction minimum-length");