]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie.cc
Run `make grand-replace'.
[lilypond.git] / lily / tie.cc
index 9b655230a036bf1cca72a88761a8a6c03d639a18..f02cddacf84a8f107cc637dcf72121c3c48332eb 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
-#include <math.h>
 
-#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 "pointer-group-interface.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 (Score_element*me,Direction d, Item * head_l)
-{
-  assert (!head (me,d));
-  index_set_cell (me->get_elt_property ("heads"), d, head_l->self_scm_);
-  
-  dynamic_cast<Spanner*> (me)->set_bound (d, head_l);
-  me->add_dependency (head_l);
-}
 
-Tie::Tie(SCM s)
-  : Spanner (s)
+bool
+Tie::less (Grob *const &s1, Grob *const &s2)
 {
-  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);
 }
+
 void
-Tie::set_interface (Score_element*me)
+Tie::set_head (Grob *me, Direction d, Grob *h)
 {
-  me->set_elt_property ("heads", gh_cons (SCM_EOL, SCM_EOL));
-  me->set_interface (ly_symbol2scm ("tie-interface"));
+  dynamic_cast<Spanner *> (me)->set_bound (d, h);
 }
-bool
-Tie::has_interface (Score_element*me)
+
+Grob *
+Tie::head (Grob *me, Direction d)
 {
-  return me->has_interface (ly_symbol2scm ("tie-interface"));
+  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;
+  else
+    return 0;
 }
 
-Score_element*
-Tie::head (Score_element*me, Direction d) 
+int
+Tie::get_column_rank (Grob *me, Direction d)
 {
-  SCM c = me->get_elt_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_element (c);
+  Grob *col = dynamic_cast<Item *> (h)->get_column ();
+  return Paper_column::get_rank (col);
 }
 
-Real
-Tie::position_f (Score_element*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);
 
-/*
-  ugh: direction of the Tie is more complicated.  See [Ross] p136 and further
- */
-Direction
-Tie::get_default_dir (Score_element*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;  
+  /*
 
-  if (sl && Directional_element_interface (sl).get () == UP
-      && sr && Directional_element_interface (sr).get () == UP)
-    return DOWN;
-  else
-    return UP;
+  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
 
-MAKE_SCHEME_CALLBACK(Tie,after_line_breaking);
-SCM
-Tie::after_line_breaking (SCM smob)
+  The direction of the Tie is more complicated (See [Ross] p136 and
+  further).
+
+  (what about linebreaks? )
+*/
+Direction
+Tie::get_default_dir (Grob *me)
 {
-  Tie*me = dynamic_cast<Tie*> (unsmob_element (smob));
+  Drul_array<Grob*> stems;
+  Direction d = LEFT;
+  do
+    {
+      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;
+
+      stems[d] = stem;
+    }
+  while (flip (&d)!= LEFT);
   
-  if (!head (me,LEFT) && !head (me,RIGHT))
+  if (stems[LEFT] && stems[RIGHT])
     {
-      programming_error ("Tie without heads.");
-      me->suicide ();
-      return SCM_UNDEFINED;
+      if (get_grob_direction (stems[LEFT]) == UP
+         && get_grob_direction (stems[RIGHT]) == UP)
+       return DOWN;
     }
-
-  if (!Directional_element_interface (me).get ())
-    Directional_element_interface (me).set (Tie::get_default_dir (me));
+  else if (stems[LEFT] || stems[RIGHT])
+    {
+      Grob *s = stems[LEFT] ? stems[LEFT] : stems[RIGHT];
+      return -get_grob_direction (s);
+    }
+  else if (int p = get_position (me))
+    return Direction (sign (p));
   
-  Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Real half_space = staff_space / 2;
-  Real x_gap_f = me->paper_l ()->get_var ("tie_x_gap");
-  Real y_gap_f = me->paper_l ()->get_var ("tie_y_gap");
-
-  /* 
-   Slur and tie placement [OSU]
-
-   Ties:
-
-       * x = inner vertical tangent - d * gap
+  return to_dir (me->get_property("neutral-direction"));
+}
 
-   */
 
+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
+      )
+    {
+      /* trigger positioning. */
+      (void) yparent->get_property ("positioning-done");
 
-  /*
-    OSU: not different for outer notes, so why all me code?
-    ie,  can we drop me, or should it be made switchable.
-   */
-  if (head (me,LEFT))
-    me->dx_f_drul_[LEFT] = Tie::head (me,LEFT)->extent (X_AXIS).length ();
+      return me->get_property_data ("direction");
+    }
   else
-    me->dx_f_drul_[LEFT] = dynamic_cast<Spanner*>(me)->get_broken_left_end_align ();
-  me->dx_f_drul_[LEFT] += x_gap_f;
-  me->dx_f_drul_[RIGHT] -= x_gap_f;
-
-  /* 
-   Slur and tie placement [OSU]  -- check me
-
-   Ties:
-
-       * y = dx <  5ss: horizontal tangent
-        y = dx >= 5ss: y next interline - d * 0.25 ss
-
-        which probably means that OSU assumes that
+    return scm_from_int (Tie::get_default_dir (me));
+}
 
-           dy <= 5 dx
 
-        for smal slurs
-   */
+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_formatting_problem problem;
+  problem.from_tie (me);
+  
+  Tie_specification spec = problem.get_tie_specification (0);
+  if (!me->is_live ())
+    return SCM_EOL;
 
+  
+  Ties_configuration conf
+    = problem.generate_optimal_configuration ();
+  
+  return get_control_points (me, problem.common_x_refpoint (),
+                            conf[0], problem.details_);
+}
 
-  Real ypos = Tie::position_f (me);
+SCM
+Tie::get_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));
 
-  Real y_f = half_space * ypos; 
-  int ypos_i = int (ypos);
-  Real dx_f = me->extent (X_AXIS).length () + me->dx_f_drul_[RIGHT] - me->dx_f_drul_[LEFT];
-  Direction dir = Directional_element_interface (me).get();
-  if (dx_f < me->paper_l ()->get_var ("tie_staffspace_length"))
+  SCM controls = SCM_EOL;
+  for (int i = 4; i--;)
     {
-      if (abs (ypos_i) % 2)
-       y_f += dir * half_space;
-      y_f += dir * y_gap_f;
+      if (!b.control_[i].is_sane ())
+       programming_error ("Insane offset");
+      controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
     }
-  else
-    {
-      if (! (abs (ypos_i) % 2))
-       y_f += dir * half_space;
-      y_f += dir * half_space;
-      y_f -= dir * y_gap_f;
-    }
-  
-  me->dy_f_drul_[LEFT] = me->dy_f_drul_[RIGHT] = y_f;
-
-  return SCM_UNDEFINED;
+  return controls;
 }
 
+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")))
+    {
+      extract_grob_set (yparent, "ties", ties);
+      if (me->original() && ties.size() == 1
+         && !to_dir (me->get_property_data ("direction")))
+       {
+         assert (ties[0] == me);
+         set_grob_direction (me, Tie::get_default_dir (me));
+           
+       }      
+      /* trigger positioning. */
+      (void) yparent->get_property ("positioning-done");
+    }
 
-Array<Rod>
-Tie::get_rods () const
-{
-  Array<Rod> a;
-  Rod r;
+  SCM cp = me->get_property_data ("control-points");
+  if (!scm_is_pair (cp))
+    {
+      cp = get_default_control_points (me);
+    }
 
-  r.item_l_drul_ [LEFT]=get_bound (LEFT);
-  r.item_l_drul_ [RIGHT]=get_bound (RIGHT);  
-  
-  r.distance_f_ = paper_l ()->get_var ("tie_x_minimum");
-  a.push (r);
-  return a;
+  return cp;
 }
 
-MAKE_SCHEME_CALLBACK(Tie,brew_molecule);
-
+/*
+  TODO: merge with Slur::print.
+ */
+MAKE_SCHEME_CALLBACK (Tie, print, 1);
 SCM
-Tie::brew_molecule (SCM smob) 
+Tie::print (SCM smob)
 {
-  Score_element*me = unsmob_element (smob);
-  Real thick = me->paper_l ()->get_var ("tie_thickness");
-  Bezier one = dynamic_cast<Tie*> (me)->get_curve ();
-
-  Molecule a;
-  SCM d =  me->get_elt_property ("dashed");
-  if (gh_number_p (d))
-    a = me->lookup_l ()->dashed_slur (one, thick, gh_scm2int (d));
-  else
-    a = me->lookup_l ()->slur (one, Directional_element_interface (me).get () * thick, thick);
+  Grob *me = unsmob_grob (smob);
   
-  return a.create_scheme(); 
-}
+  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; scm_is_pair (s); s = scm_cdr (s))
+    {
+      b.control_[i] = ly_scm2offset (scm_car (s));
+      i++;
+    }
 
-Bezier
-Tie::get_curve () const
-{
-  Score_element*me = (Score_element*)this;
-  Direction d (Directional_element_interface (me).get ());
-  Bezier_bow b (get_encompass_offset_arr (), d);
+  Stencil a;
 
-  Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Real h_inf = paper_l ()->get_var ("tie_height_limit_factor") * staff_space;
-  Real r_0 = paper_l ()->get_var ("tie_ratio");
+  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);
 
-  b.set_default_bezier (h_inf, r_0);
-  Bezier c = b.get_bezier ();
+#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);
 
-  /* should do me for slurs as well. */
-  Array<Real> horizontal (c.solve_derivative (Offset (1,0)));
+      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);
 
-  if (horizontal.size ())
-    {
       /*
-       ugh. Doesnt work for non-horizontal curves.
+       It would be nice if we could put this in a different layer,
+       but alas, this must be done with a Tie override.
        */
-      Real y = c.curve_point (horizontal[0])[Y_AXIS];
-
-      Real ry = rint (y/staff_space) * staff_space;
-      Real diff = ry - y;
-      Real newy = y;
-      if (fabs (y) <= 2.0
-         && fabs (diff) < paper_l ()->get_var ("tie_staffline_clearance"))
-       {
-         newy = ry - 0.5 * staff_space * sign (diff) ;
-       }
-
-      Real y0 = c.control_ [0][Y_AXIS];
-      c.control_[2][Y_AXIS] = 
-      c.control_[1][Y_AXIS] =
-       (c.control_[1][Y_AXIS] - y0)  * ((newy - y0) / (y - y0)) + y0; 
+      a.add_stencil (tm);
     }
-  else
-    programming_error ("Tie is nowhere horizontal");
-  return c;
-}
+#endif
 
-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;
+  return a.smobbed_copy ();
 }
 
+ADD_INTERFACE (Tie,
+              "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 "
+              );
+
+
+
+