]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / tie.cc
index 0f7f0830cefac107bdf7951194c0ccda7457e815..3f282071e77fe393bad531df74895ef3a97ef840 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
-#include <math.h>
 
-
-#include "spanner.hh"
-#include "lookup.hh"
-#include "paper-def.hh"
 #include "tie.hh"
-#include "rhythmic-head.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 "paper-column.hh"
-#include "debug.hh"
+#include "rhythmic-head.hh"
+#include "spanner.hh"
 #include "staff-symbol-referencer.hh"
-#include "directional-element-interface.hh"
-#include "molecule.hh"
-#include "bezier-bow.hh"
 #include "stem.hh"
-#include "note-head.hh"
-
-/*
-  tie: Connect two noteheads.
+#include "text-interface.hh"
+#include "tie-column.hh"
+#include "tie-configuration.hh"
+#include "tie-formatting-problem.hh"
+#include "warn.hh"
 
-  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, Item * head_l)
+int
+Tie::compare (Grob *const &s1,
+             Grob *const &s2)
 {
-  assert (!head (me,d));
-  index_set_cell (me->get_grob_property ("heads"), d, head_l->self_scm ());
-  
-  dynamic_cast<Spanner*> (me)->set_bound (d, head_l);
-  me->add_dependency (head_l);
+  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_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::position_f (Grob*me) 
+int
+Tie::get_position (Grob *me)
 {
-  Direction d = head (me,LEFT) ? LEFT:RIGHT;
-  return Staff_symbol_referencer::position_f (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;
+}
 
 /*
   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::stem_l (head (me,LEFT)) :0;
-  Item * sr =  head (me,RIGHT) ? Rhythmic_head::stem_l (head (me,RIGHT)) :0;  
+  Drul_array<Grob*> stems;
+  Direction d = LEFT;
+  do
+    {
+      Grob *stem = head (me, d) ? Rhythmic_head::get_stem (head (me, d)) : 0;
+      if (stem)
+       stem = Stem::is_invisible (stem) ? 0 : stem;
 
-  if (sl && sr)
+      stems[d] = stem;
+    }
+  while (flip (&d)!= LEFT);
+  
+  if (stems[LEFT] && stems[RIGHT])
     {
-      if (Directional_element_interface::get (sl) == UP
-         && Directional_element_interface::get (sr) == UP)
+      if (get_grob_direction (stems[LEFT]) == UP
+         && get_grob_direction (stems[RIGHT]) == UP)
        return DOWN;
     }
-  else if (sl || sr)
+  else if (stems[LEFT] || stems[RIGHT])
     {
-      Item *s = sl ? sl : sr;
-      return - Directional_element_interface::get (s);
+      Grob *s = stems[LEFT] ? stems[LEFT] : stems[RIGHT];
+      return -get_grob_direction (s);
     }
-
+  else if (int p = get_position (me))
+    return Direction (sign (p));
   
   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"));
+  return SCM_UNSPECIFIED;
+}
 
-  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);
+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); 
   
-  Real left_x;
+  Tie_formatting_problem problem;
+  problem.from_tie (me);
+  Tie_specification spec = problem.get_tie_specification (0);
+  spec.has_manual_dir_ = true;
+  spec.manual_dir_ = get_grob_direction (me);
 
-  /*
-     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))
+  if (me->is_live ())
     {
-      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);
+      Tie_configuration conf
+       = problem.find_optimal_tie_configuration (spec);
   
-
-  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;
+      set_control_points (me, problem.common_x_refpoint (),
+                         conf, problem.details_);
     }
-  else
+}
+void
+Tie::set_control_points (Grob *me,
+                        Grob *common,
+                        Tie_configuration const &conf,
+                        Tie_details const &details
+                        )
+{
+  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--;)
     {
-      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;
+      if (!b.control_[i].is_sane ())
+       programming_error ("Insane offset");
+      controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
     }
-  
-
-
-  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.
+  me->set_property ("control-points", controls);
+}
 
-  */
+MAKE_SCHEME_CALLBACK(Tie, calc_control_points, 1);
+SCM
+Tie::calc_control_points (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
 
-  Real ypos = Tie::position_f (me) * staff_space/2
-    + dir * gh_scm2double (me->get_grob_property ("y-offset"));;
+  // trigger Tie-column
+  (void)  get_grob_direction (me);
 
-  /*
-    Make sure we don't start on a dots
-   */
-  if (Note_head::has_interface (l) && Rhythmic_head::dots_l (l))
+  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)
     {
-      Grob* dots = Rhythmic_head::dots_l(l);
-      if(fabs (staff_space * Staff_symbol_referencer::position_f (dots) /2
-              - ypos) < 0.5)
-       {
-         ypos += 0.5 * dir ;
-       }
+      /* trigger positioning. */
+      (void) yparent->get_property ("positioning-done");
     }
 
-  
-  /*
-    todo: prevent ending / staffline collision.
-
-    todo: tie / stem collision
-   */
-
-  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.
-
-    
-    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 ())
+  if (!scm_is_pair (me->get_property_data (ly_symbol2scm ("control-points"))))
     {
-      /*
-       ugh. Doesnt work for non-horizontal curves.
-       */
-      Real y = b.curve_point (horizontal[0])[Y_AXIS];
-
-      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"));
-
-      if (fabs (y) <= Staff_symbol_referencer::staff_radius (me)
-         && fabs (diff) < clear)
-       {
-         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; 
+      set_default_control_points (me);
     }
-  else
-    programming_error ("Tie is nowhere horizontal");
-
-
 
-  SCM controls = SCM_EOL;
-  for (int i= 4; i--;)
-    controls = gh_cons (ly_offset2scm (b.control_[i]), controls);
-  return controls;
+  return SCM_UNSPECIFIED;
 }
 
-
-MAKE_SCHEME_CALLBACK (Tie,brew_molecule,1);
+/*
+  TODO: merge witnh Slur::print.
+ */
+MAKE_SCHEME_CALLBACK (Tie, print, 1);
 SCM
-Tie::brew_molecule (SCM smob) 
+Tie::print (SCM smob)
 {
-  Grob*me = unsmob_grob (smob);
-
-  SCM cp = me->get_grob_property ("control-points");
-  if (cp == SCM_EOL)
-    {
-      cp = get_control_points (smob);
-      me->set_grob_property ("control-points", cp);
-    }
+  Grob *me = unsmob_grob (smob);
   
-  Real thick =
-    gh_scm2double (me->get_grob_property ("thickness"))
-    * me->paper_l ()->get_var ("linethickness");
+  SCM cp = me->get_property ("control-points");
+
+  Real staff_thick = Staff_symbol_referencer::line_thickness (me);
+  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 = 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,
+                            line_thick,
+                            robust_scm2double (p, 1.0),
+                            robust_scm2double (f, 0));
+  else
+    a = Lookup::slur (b,
+                     get_grob_direction (me) * base_thick,
+                     line_thick);
+
+#if DEBUG_TIE_SCORING
+  SCM quant_score = me->get_property ("quant-score");
+
+  if (to_boolean (me->layout ()
+                 ->lookup_variable (ly_symbol2scm ("debug-tie-scoring")))
+      && scm_is_string (quant_score))
+    {
+      string str;
+      SCM properties = Font_interface::text_font_alist_chain (me);
+
+      Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
+                                   (me->layout ()->self_scm (), properties,
+                                    quant_score));
+      tm.translate_axis (b.control_[0][Y_AXIS]*2, Y_AXIS);
+      a.add_at_edge (X_AXIS, RIGHT, tm, 1.0, 0);
+    }
+#endif
+
+  return a.smobbed_copy ();
 }
 
+ADD_INTERFACE (Tie,
+              "tie-interface",
+              
+              "A horizontal curve connecting two noteheads. \n\n"
+              ,
+              
+
+              /* properties */
+              "avoid-slur "    //  UGH.
+              "control-points "
+              "dash-fraction "
+              "dash-period "
+              "details "
+              "direction "
+              "line-thickness " 
+              "quant-score "
+              "staff-position "
+              "thickness "
+              );
+
+
 
 
-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");