]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie.cc
Merge branch 'master' of ssh://kainhofer@git.sv.gnu.org/srv/git/lilypond into kainhofer
[lilypond.git] / lily / tie.cc
index e9e1ab70606ea8bd8c31094a9d45c34fd6324f63..87548a7056c538bb32867091085c5a2a7cf675cd 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include "lookup.hh"
-#include "paper-def.hh"
 #include "tie.hh"
-#include "note-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 "text-interface.hh"
+#include "tie-column.hh"
+#include "tie-configuration.hh"
+#include "tie-formatting-problem.hh"
+#include "warn.hh"
+#include "semi-tie-column.hh"
 
-void
-Tie::set_head (Direction d, Item * head_l)
-{
-  assert (!head (d));
-  index_set_cell (get_elt_property ("heads"), d, head_l->self_scm_);
-  
-  set_bounds (d, head_l);
-  add_dependency (head_l);
-}
 
-Tie::Tie()
+bool
+Tie::less (Grob *const &s1,
+          Grob *const &s2)
 {
-  set_elt_property ("heads", gh_cons (SCM_EOL, SCM_EOL));
-  dy_f_drul_[LEFT] = dy_f_drul_[RIGHT] = 0.0;
-  dx_f_drul_[LEFT] = dx_f_drul_[RIGHT] = 0.0;
-
+  return Tie::get_position (s1) < Tie::get_position (s2);
 }
 
-Note_head* 
-Tie::head (Direction d) const
+void
+Tie::set_head (Grob *me, Direction d, Grob *h)
 {
-  SCM c = get_elt_property ("heads");
-  c = index_cell (c, d);
-
-  return dynamic_cast<Note_head*> (unsmob_element (c));  
+  dynamic_cast<Spanner *> (me)->set_bound (d, h);
 }
 
-
-/*
-  ugh: direction of the Tie is more complicated.  See [Ross] p136 and further
- */
-Direction
-Tie::get_default_dir () const
+Grob *
+Tie::head (Grob *me, Direction d)
 {
-  Stem * sl =  head(LEFT) ? head (LEFT)->stem_l () :0;
-  Stem * sr =  head(RIGHT) ? head (RIGHT)->stem_l () :0;  
-
-  if (sl && directional_element (sl).get () == UP
-      && sr && directional_element (sr).get () == UP)
-    return DOWN;
-  else
-    return UP;
-
-#if 0 
-  Real p1 = Staff_symbol_referencer_interface (head (LEFT)).position_f () ;
-  Real p2 = Staff_symbol_referencer_interface (head (RIGHT)).position_f () ;  
+  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;
+     }
   
-  int m = int (p1  + p2);
-
-  /*
-    If dir is not determined: inverse of stem: down
-    (see stem::get_default_dir ())
-   */
-  Direction neutral_dir = (Direction)(int)paper_l ()->get_var ("stem_default_neutral_direction");
-  return (m == 0) ? other_dir (neutral_dir) : (m < 0) ? DOWN : UP;
-#endif
+  Item *it = dynamic_cast<Spanner*> (me)->get_bound (d);
+  if (Note_head::has_interface (it))
+    return it;
+  else
+    return 0;
 }
 
-void
-Tie::do_add_processing()
+int
+Tie::get_column_rank (Grob *me, Direction d)
 {
-  if (!(head (LEFT) && head (RIGHT)))
-    warning (_ ("lonely tie"));
-
-  Direction d = LEFT;
-  Drul_array<Note_head *> new_head_drul;
-  new_head_drul[LEFT] = head(LEFT);
-  new_head_drul[RIGHT] = head(RIGHT);  
-  do {
-    if (!head (d))
-      new_head_drul[d] = head((Direction)-d);
-  } while (flip(&d) != LEFT);
-
-  index_set_cell (get_elt_property ("heads"), LEFT, new_head_drul[LEFT]->self_scm_ );
-  index_set_cell (get_elt_property ("heads"), RIGHT, new_head_drul[LEFT]->self_scm_ );
+  Spanner *span = dynamic_cast<Spanner *> (me);
+  Grob *h = head (me, d);
+  if (!h)
+    h = span->get_bound (d);
 
+  Grob *col = dynamic_cast<Item *> (h)->get_column ();
+  return Paper_column::get_rank (col);
 }
 
-void
-Tie::do_post_processing()
+int
+Tie::get_position (Grob *me)
 {
-  if (!head (LEFT) && !head (RIGHT))
+  Direction d = LEFT;
+  do
     {
-      programming_error ("Tie without heads.");
-      set_elt_property ("transparent", SCM_BOOL_T);
-      set_empty (X_AXIS);
-      set_empty (Y_AXIS);
-      return;
+      Grob *h = head (me, d);
+      if (h)
+       return (int) rint (Staff_symbol_referencer::get_position (h));
     }
+  while (flip (&d) != LEFT);
 
-  if (!directional_element (this).get ())
-    directional_element (this).set (get_default_dir ());
-  
-  Real staff_space = paper_l ()->get_var ("interline");
-  Real half_staff_space = staff_space / 2;
-  Real x_gap_f = paper_l ()->get_var ("tie_x_gap");
-  Real y_gap_f = paper_l ()->get_var ("tie_y_gap");
-
-  /* 
-   Slur and tie placement [OSU]
+  /*
 
-   Ties:
+  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;
+}
 
-       * x = inner vertical tangent - d * gap
+/*
+  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).
 
-  /*
-    OSU: not different for outer notes, so why all this code?
-    ie,  can we drop this, or should it be made switchable.
-   */
-#if 0
+  (what about linebreaks? )
+*/
+Direction
+Tie::get_default_dir (Grob *me)
+{
+  Drul_array<Grob*> stems;
   Direction d = LEFT;
   do
     {
-      Real head_width_f = head (d)
-       ? head (d)->extent (X_AXIS).length ()
-       : 0;
-      /*
-       side attached to outer (upper or lower) notehead of chord
-      */
-      if (head (d)
-         /*
-
-               a~a~a;
-
-           to second tie, middle notehead seems not extremal
-
-           Getting scared a bit by score-element's comment:
-           // is this a good idea?
-         */
-         // FIXME extremal deprecated
-         && (head (d)->get_elt_property ("extremal")
-             != SCM_UNDEFINED))
-       {
-       if (d == LEFT)
-           dx_f_drul_[d] += head_width_f;
-         dx_f_drul_[d] += -d * x_gap_f;
-       }
-      /*
-       side attached to inner notehead
-      */
-      else
-       {
-         dx_f_drul_[d] += -d * head_width_f;
-       }
-    } while (flip (&d) != LEFT);
-
-#else
-
-  if (head (LEFT))
-    dx_f_drul_[LEFT] = head (LEFT)->extent (X_AXIS).length ();
-  else
-    dx_f_drul_[LEFT] = get_broken_left_end_align ();
-  dx_f_drul_[LEFT] += x_gap_f;
-  dx_f_drul_[RIGHT] -= x_gap_f;
-
-#endif
-
-  /* 
-   Slur and tie placement [OSU]  -- check this
-
-   Ties:
-
-       * y = dx <  5ss: horizontal tangent
-        y = dx >= 5ss: y next interline - d * 0.25 ss
-
-        which probably means that OSU assumes that
-
-           dy <= 5 dx
+      Grob *stem = head (me, d) ? Rhythmic_head::get_stem (head (me, d)) : 0;
+      if (stem)
+       stem = Stem::is_invisible (stem) ? 0 : stem;
 
-        for smal slurs
-   */
-
-
-  Real ypos = head (LEFT)
-    ? Staff_symbol_referencer_interface (head (LEFT)).position_f ()
-    : Staff_symbol_referencer_interface (head (RIGHT)).position_f () ;  
-
-  Real y_f = half_staff_space * ypos; 
-  int ypos_i = int (ypos);
-  Real dx_f = extent (X_AXIS).length () + dx_f_drul_[RIGHT] - dx_f_drul_[LEFT];
-  Direction dir = directional_element (this).get();
-  if (dx_f < paper_l ()->get_var ("tie_staffspace_length"))
+      stems[d] = stem;
+    }
+  while (flip (&d)!= LEFT);
+  
+  if (stems[LEFT] && stems[RIGHT])
     {
-      if (abs (ypos_i) % 2)
-       y_f += dir * half_staff_space;
-      y_f += dir * y_gap_f;
+      if (get_grob_direction (stems[LEFT]) == UP
+         && get_grob_direction (stems[RIGHT]) == UP)
+       return DOWN;
     }
-  else
+  else if (stems[LEFT] || stems[RIGHT])
     {
-      if (! (abs (ypos_i) % 2))
-       y_f += dir * half_staff_space;
-      y_f += dir * half_staff_space;
-      y_f -= dir * y_gap_f;
+      Grob *s = stems[LEFT] ? stems[LEFT] : stems[RIGHT];
+      return -get_grob_direction (s);
     }
+  else if (int p = get_position (me))
+    return Direction (sign (p));
   
-  dy_f_drul_[LEFT] = dy_f_drul_[RIGHT] = y_f;
+  return UP;
 }
 
 
-
-Array<Rod>
-Tie::get_rods () const
+MAKE_SCHEME_CALLBACK (Tie, calc_direction, 1);
+SCM
+Tie::calc_direction (SCM smob)
 {
-  Array<Rod> a;
-  Rod r;
-  r.item_l_drul_ = spanned_drul_;
-  r.distance_f_ = paper_l ()->get_var ("tie_x_minimum");
-  a.push (r);
-  return a;
-}
-
+  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
+      )
+    {
+      /* trigger positioning. */
+      (void) yparent->get_property ("positioning-done");
 
+      return me->get_property_data ("direction");
+    }
+  else
+    return scm_from_int (Tie::get_default_dir (me));
+}
 
 
-Molecule*
-Tie::do_brew_molecule_p () const
+SCM
+Tie::get_default_control_points (Grob *me_grob)
 {
-  Real thick = paper_l ()->get_var ("tie_thickness");
-  Bezier one = get_curve ();
+  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_formatting_problem problem;
+  problem.from_tie (me);
+  
+  Tie_specification spec = problem.get_tie_specification (0);
+  if (!me->is_live ())
+    return SCM_EOL;
 
-  Molecule a;
-  SCM d =  get_elt_property ("dashed");
-  if (gh_number_p (d))
-    a = lookup_l ()->dashed_slur (one, thick, gh_scm2int (d));
-  else
-    a = lookup_l ()->slur (one, directional_element (this).get () * thick, thick);
   
-  return new Molecule (a); 
+  Ties_configuration conf
+    = problem.generate_optimal_configuration ();
+  
+  return get_control_points (me, problem.common_x_refpoint (),
+                            conf[0], problem.details_);
 }
 
-
-
-Bezier
-Tie::get_curve () const
+SCM
+Tie::get_control_points (Grob *me,
+                        Grob *common,
+                        Tie_configuration const &conf,
+                        Tie_details const &details
+                        )
 {
-  Bezier_bow b (get_encompass_offset_arr (), directional_element (this).get ());
-
-  b.ratio_ = paper_l ()->get_var ("slur_ratio");
-  b.height_limit_ = paper_l ()->get_var ("slur_height_limit");
-  b.rc_factor_ = paper_l ()->get_var ("slur_rc_factor");
+  Bezier b = conf.get_transformed_bezier (details);
+  b.translate (Offset (- me->relative_coordinate (common, X_AXIS), 0));
 
-  b.calculate ();
-  return b.get_curve ();
+  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);
+    }
+  return controls;
 }
 
-#if 0
-
-/*
-  TODO: FIXME.
- */
 
-/*
-  Clipping
+MAKE_SCHEME_CALLBACK (Tie, calc_control_points, 1);
+SCM
+Tie::calc_control_points (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
+      )
+    {
+      /* trigger positioning. */
+      (void) yparent->get_property ("positioning-done");
+    }
 
-  This function tries to address two issues:
-    * the tangents of the slur should always point inwards 
-      in the actual slur, i.e.  *after rotating back*.
+  SCM cp = me->get_property_data ("control-points");
+  if (!scm_is_pair (cp))
+    {
+      cp = get_default_control_points (me);
+    }
 
-    * slurs shouldn't be too high 
-      let's try : h <= 1.2 b && h <= 3 staffheight?
+  return cp;
+}
 
-  We could calculate the tangent of the bezier curve from
-  both ends going inward, and clip the slur at the point
-  where the tangent (after rotation) points up (or inward
-  with a certain maximum angle).
-  
-  However, we assume that real clipping is not the best
-  answer.  We expect that moving the outer control point up 
-  if the slur becomes too high will result in a nicer slur 
-  after recalculation.
-
-  Knowing that the tangent is the line through the first
-  two control points, we'll clip (move the outer control
-  point upwards) too if the tangent points outwards.
+/*
+  TODO: merge with Slur::print.
  */
-
-bool
-Bezier_Tie::calc_clipping ()
+MAKE_SCHEME_CALLBACK (Tie, print, 1);
+SCM
+Tie::print (SCM smob)
 {
-  Real clip_height = paper_l_->get_var ("slur_clip_height");
-  Real clip_ratio = paper_l_->get_var ("slur_clip_ratio");
-  Real clip_angle = paper_l_->get_var ("slur_clip_angle");
-
-  Real b = curve_.control_[3][X_AXIS] - curve_.control_[0][X_AXIS];
-  Real clip_h = clip_ratio * b <? clip_height;
-  Real begin_h = curve_.control_[1][Y_AXIS] - curve_.control_[0][Y_AXIS];
-  Real end_h = curve_.control_[2][Y_AXIS] - curve_.control_[3][Y_AXIS];
-  Real begin_dy = 0 >? begin_h - clip_h;
-  Real end_dy = 0 >? end_h - clip_h;
+  Grob *me = unsmob_grob (smob);
   
-  Real pi = M_PI;
-  Real begin_alpha = (curve_.control_[1] - curve_.control_[0]).arg () + dir_ * alpha_;
-  Real end_alpha = pi -  (curve_.control_[2] - curve_.control_[3]).arg () - dir_  * alpha_;
+  SCM cp = me->get_property ("control-points");
 
-  Real max_alpha = clip_angle / 90 * pi / 2;
-  if ((begin_dy < 0) && (end_dy < 0)
-    && (begin_alpha < max_alpha) && (end_alpha < max_alpha))
-    return false;
+  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);
 
-  transform_back ();
-
-  if ((begin_dy > 0) || (end_dy > 0))
+  Bezier b;
+  int i = 0;
+  for (SCM s = cp; scm_is_pair (s); s = scm_cdr (s))
     {
-      Real dy = (begin_dy + end_dy) / 4;
-      dy *= cos (alpha_);
-      encompass_[0][Y_AXIS] += dir_ * dy;
-      encompass_.top ()[Y_AXIS] += dir_ * dy;
+      b.control_[i] = ly_scm2offset (scm_car (s));
+      i++;
     }
+
+  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))
     {
-      //ugh
-      Real c = 0.4;
-      if (begin_alpha >= max_alpha)
-       begin_dy = 0 >? c * begin_alpha / max_alpha * begin_h;
-      if (end_alpha >= max_alpha)
-       end_dy = 0 >? c * end_alpha / max_alpha * end_h;
-
-      encompass_[0][Y_AXIS] += dir_ * begin_dy;
-      encompass_.top ()[Y_AXIS] += dir_ * end_dy;
-
-      Offset delta = encompass_.top () - encompass_[0];
-      alpha_ = delta.arg ();
-    }
+      string str;
+      SCM properties = Font_interface::text_font_alist_chain (me);
 
-  to_canonic_form ();
+      Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
+                                   (me->layout ()->self_scm (), properties,
+                                    quant_score));
+      tm.translate (Offset (b.control_[3][X_AXIS] + 0.5,
+                           b.control_[0][Y_AXIS] * 2));
+      tm = tm.in_color (1, 0, 0);
 
-  return true;
-}
+      /*
+       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,
+              "A horizontal curve connecting two noteheads. \n\n"
+              ,
+              
+
+              /* properties */
+              "avoid-slur "    //  UGH.
+              "control-points "
+              "dash-fraction "
+              "dash-period "
+              "details "
+              "direction "
+              "separation-item "
+              "head-direction "
+              "line-thickness " 
+              "quant-score "
+              "staff-position "
+              "thickness "
+
+              );
+
 
 
-Array<Offset>
-Tie::get_encompass_offset_arr () const
-{
-  Array<Offset> offset_arr;
-  offset_arr.push (Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]));
-  offset_arr.push (Offset (spanner_length () + dx_f_drul_[RIGHT],
-                          dy_f_drul_[RIGHT]));
-                     
-  return offset_arr;
-}