]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/note-collision.cc
Run `make grand-replace'.
[lilypond.git] / lily / note-collision.cc
index 2e2c167e5d9db74fb67f8c46985de7ff765e4698..7ac359b36f8a52f5576ebde0bf1817459d19cf5b 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "note-collision.hh"
 
-#include <math.h>
-
-#include "warn.hh"
+#include "axis-group-interface.hh"
+#include "dot-column.hh"
+#include "international.hh"
 #include "note-column.hh"
 #include "note-head.hh"
-#include "rhythmic-head.hh"
 #include "output-def.hh"
-#include "axis-group-interface.hh"
-#include "stem.hh"
-#include "side-position-interface.hh"
-#include "dot-column.hh"
 #include "pointer-group-interface.hh"
+#include "item.hh"
+#include "rhythmic-head.hh"
+#include "staff-symbol-referencer.hh"
+#include "side-position-interface.hh"
+#include "stem.hh"
+#include "warn.hh"
 
-MAKE_SCHEME_CALLBACK (Note_collision_interface, force_shift_callback, 2);
-
-SCM
-Note_collision_interface::force_shift_callback (SCM element_smob, SCM axis)
-{
-  Grob *me = unsmob_grob (element_smob);
-  Axis a = (Axis) scm_to_int (axis);
-  assert (a == X_AXIS);
-
-  me = me->get_parent (a);
-
-  if (! to_boolean (me->get_property ("positioning-done")))
-    {
-      me->set_property ("positioning-done", SCM_BOOL_T);
-      do_shifts (me);
-    }
-
-  return scm_from_double (0.0);
-}
 
 void
 check_meshing_chords (Grob *me,
-                     Drul_array<Array<Real> > *offsets,
-                     Drul_array<Array<Slice> > const &extents,
-                     Drul_array<Link_array<Grob> > const &clash_groups)
+                     Drul_array<vector<Real> > *offsets,
+                     Drul_array<vector<Slice> > const &extents,
+                     Drul_array<vector<Grob*> > const &clash_groups)
 
 {
   if (!extents[UP].size () || ! extents[DOWN].size ())
     return;
 
-  Grob *cu = clash_groups[UP][0];
-  Grob *cd = clash_groups[DOWN][0];
+  Grob *clash_up = clash_groups[UP][0];
+  Grob *clash_down = clash_groups[DOWN][0];
 
   /* Every note column should have a stem, but avoid a crash. */
-  if (!Note_column::get_stem (cu) || !Note_column::get_stem (cd))
+  if (!Note_column::get_stem (clash_up) || !Note_column::get_stem (clash_down))
     return;
 
-  Grob *nu = Note_column::first_head (cu);
-  Grob *nd = Note_column::first_head (cd);
+  Drul_array<Grob*> stems (Note_column::get_stem (clash_down),
+                          Note_column::get_stem (clash_up));
+  
+  Grob *head_up = Note_column::first_head (clash_up);
+  Grob *head_down = Note_column::first_head (clash_down);
 
-  Array<int> ups = Stem::note_head_positions (Note_column::get_stem (cu));
-  Array<int> dps = Stem::note_head_positions (Note_column::get_stem (cd));
+  vector<int> ups = Stem::note_head_positions (Note_column::get_stem (clash_up));
+  vector<int> dps = Stem::note_head_positions (Note_column::get_stem (clash_down));
 
   /* Too far apart to collide.  */
-  if (ups[0] > dps.top () + 1)
+  if (ups[0] > dps.back () + 1)
     return;
 
-  // FIXME: what's this?
-  bool merge_possible = (ups[0] >= dps[0]) && (ups.top () >= dps.top ());
+  /* Merge heads if the notes lie the same line, or if the "stem-up-note" is
+     above the "stem-down-note". */
+  bool merge_possible = (ups[0] >= dps[0]) && (ups.back () >= dps.back ());
 
   /* Do not merge notes typeset in different style. */
-  if (!ly_is_equal (nu->get_property ("style"),
-                   nd->get_property ("style")))
+  if (!ly_is_equal (head_up->get_property ("style"),
+                   head_down->get_property ("style")))
     merge_possible = false;
 
-  int upball_type = Note_head::get_balltype (nu);
-  int dnball_type = Note_head::get_balltype (nd);
+  int up_ball_type = Rhythmic_head::duration_log (head_up);
+  int down_ball_type = Rhythmic_head::duration_log (head_down);
 
   /* Do not merge whole notes (or longer, like breve, longa, maxima).  */
-  if (merge_possible && (upball_type <= 0 || dnball_type <= 0))
+  if (merge_possible && (up_ball_type <= 0 || down_ball_type <= 0))
     merge_possible = false;
 
   if (merge_possible
-      && Rhythmic_head::dot_count (nu) != Rhythmic_head::dot_count (nd)
+      && Rhythmic_head::dot_count (head_up) != Rhythmic_head::dot_count (head_down)
       && !to_boolean (me->get_property ("merge-differently-dotted")))
     merge_possible = false;
 
   /* Can only merge different heads if merge-differently-headed is
      set. */
   if (merge_possible
-      && upball_type != dnball_type
+      && up_ball_type != down_ball_type
       && !to_boolean (me->get_property ("merge-differently-headed")))
     merge_possible = false;
 
   /* Should never merge quarter and half notes, as this would make
      them indistinguishable.  */
   if (merge_possible
-      && ((Rhythmic_head::duration_log (nu) == 1
-          && Rhythmic_head::duration_log (nd) == 2)
-         || (Rhythmic_head::duration_log (nu) == 2
-             && Rhythmic_head::duration_log (nd) == 1)))
+      && ((Stem::duration_log (stems[UP]) == 1
+          && Stem::duration_log (stems[DOWN]) == 2)
+         || (Stem::duration_log (stems[UP]) == 2
+             && Stem::duration_log (stems[DOWN]) == 1)))
     merge_possible = false;
 
   /*
@@ -137,8 +123,7 @@ check_meshing_chords (Grob *me,
   bool distant_half_collide = false;
   bool full_collide = false;
 
-  int i = 0, j = 0;
-  while (i < ups.size () && j < dps.size ())
+  for (vsize i = 0, j = 0; i < ups.size () && j < dps.size (); )
     {
       if (abs (ups[i] - dps[j]) == 1)
        {
@@ -150,9 +135,9 @@ check_meshing_chords (Grob *me,
        }
       else if (ups[i] == dps[j])
        full_collide = true;
-      else if (ups[i] > dps[0] && ups[i] < dps.top ())
+      else if (ups[i] > dps[0] && ups[i] < dps.back ())
        merge_possible = false;
-      else if (dps[j] > ups[0] && dps[j] < ups.top ())
+      else if (dps[j] > ups[0] && dps[j] < ups.back ())
        merge_possible = false;
 
       if (ups[i] < dps[j])
@@ -175,7 +160,14 @@ check_meshing_chords (Grob *me,
 
   Real shift_amount = 1;
 
-  bool touch = (ups[0] >= dps.top ());
+  bool touch = (ups[0] >= dps.back ());
+  /* As a special case, if the topmost part of the downstem chord is a second,
+     the top note of which is the same pitch as the lowest upstem note, they
+     shouldn't count as touching.
+  */
+  if (dps.back () == ups[0] && dps.size () > 1 && dps[dps.size() - 2] == ups[0] - 1)
+    touch = false;
+
   if (touch)
     shift_amount *= -1;
 
@@ -183,11 +175,27 @@ check_meshing_chords (Grob *me,
      make sure the dotted heads go to the right.  */
   bool stem_to_stem = false;
   if (full_collide)
-    if (Rhythmic_head::dot_count (nu) > Rhythmic_head::dot_count (nd))
-      shift_amount = 1;
-    else if (Rhythmic_head::dot_count (nu) < Rhythmic_head::dot_count (nd))
-      stem_to_stem = true;
+    {
+      if (Rhythmic_head::dot_count (head_up) > Rhythmic_head::dot_count (head_down))
+       shift_amount = 1;
+      else if (Rhythmic_head::dot_count (head_up) < Rhythmic_head::dot_count (head_down))
+       stem_to_stem = true;
+    }
 
+  /* The solfa is a triangle, which is inverted depending on stem
+     direction. In case of a collision, one of them should be removed,
+     so the resulting note does not look like a block.
+  */
+  if (merge_possible
+      && head_up->get_property ("style") == ly_symbol2scm ("fa")
+      && head_down->get_property ("style") == ly_symbol2scm ("fa"))
+    {
+      Interval uphead_size = head_up->extent (head_up, Y_AXIS);
+      Offset att = Offset (0.0, -1.0);
+      head_up->set_property ("stem-attachment", ly_offset2scm (att));
+      head_up->set_property ("transparent", SCM_BOOL_T); 
+    }
+  
   if (merge_possible)
     {
       shift_amount = 0;
@@ -196,32 +204,32 @@ check_meshing_chords (Grob *me,
         or head with smallest amount of dots.  Note: when merging
         different heads, dots on the smaller one disappear. */
       Grob *wipe_ball = 0;
-      Grob *dot_wipe_head = nu;
+      Grob *dot_wipe_head = head_up;
 
-      if (upball_type == dnball_type)
+      if (up_ball_type == down_ball_type)
        {
-         if (Rhythmic_head::dot_count (nd) < Rhythmic_head::dot_count (nu))
+         if (Rhythmic_head::dot_count (head_down) < Rhythmic_head::dot_count (head_up))
            {
-             wipe_ball = nd;
-             dot_wipe_head = nd;
+             wipe_ball = head_down;
+             dot_wipe_head = head_down;
            }
-         else if (Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu))
+         else if (Rhythmic_head::dot_count (head_down) > Rhythmic_head::dot_count (head_up))
            {
-             dot_wipe_head = nu;
-             wipe_ball = nu;
+             dot_wipe_head = head_up;
+             wipe_ball = head_up;
            }
          else
-           dot_wipe_head = nu;
+           dot_wipe_head = head_up;
        }
-      else if (dnball_type > upball_type)
+      else if (down_ball_type > up_ball_type)
        {
-         wipe_ball = nd;
-         dot_wipe_head = nd;
+         wipe_ball = head_down;
+         dot_wipe_head = head_down;
        }
-      else if (dnball_type < upball_type)
+      else if (down_ball_type < up_ball_type)
        {
-         wipe_ball = nu;
-         dot_wipe_head = nu;
+         wipe_ball = head_up;
+         dot_wipe_head = head_up;
        }
 
       if (dot_wipe_head)
@@ -233,7 +241,6 @@ check_meshing_chords (Grob *me,
       if (wipe_ball && wipe_ball->is_live ())
        {
          wipe_ball->set_property ("transparent", SCM_BOOL_T);
-         wipe_ball->set_property ("stencil", SCM_EOL);
        }
     }
   /* TODO: these numbers are magic; should devise a set of grob props
@@ -248,18 +255,64 @@ check_meshing_chords (Grob *me,
     shift_amount *= 0.5;
 
   /* we're meshing.  */
-  else if (Rhythmic_head::dot_count (nu) || Rhythmic_head::dot_count (nd))
+  else if (Rhythmic_head::dot_count (head_up) || Rhythmic_head::dot_count (head_down))
     shift_amount *= 0.1;
   else
     shift_amount *= 0.17;
 
+  /*
+    
+  */
+  if (full_collide
+      && down_ball_type * up_ball_type == 0)
+    {
+      if (up_ball_type == 0 && down_ball_type == 1)
+       shift_amount *= 1.25;
+      else if (up_ball_type == 0 && down_ball_type == 2)
+       shift_amount *= 1.35;
+      else if (down_ball_type == 0 && up_ball_type == 1)
+       shift_amount *= 0.7;
+      else if (down_ball_type == 0 && up_ball_type == 2)
+       shift_amount *= 0.75;
+    }
+  
+  /*
+   * Fix issue #44:
+   *
+   * Dots from left note head collide with right note head. Only occurs
+   * with a close half collide, if the left note head is between
+   * lines and the right note head is on a line, and if right note head
+   * hasn't got any dots.
+   */
+  if (close_half_collide
+      && Rhythmic_head::dot_count (head_up)
+      && !Rhythmic_head::dot_count (head_down))
+    {
+      Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
+      if (!Staff_symbol_referencer::on_line (staff, ups[0]))
+       /*
+         TODO: consider junking the else body.
+       */
+       if (to_boolean (me->get_property ("prefer-dotted-right")))
+         {
+           shift_amount = 0.5;
+         }
+       else
+         {
+           Grob *d = unsmob_grob (head_up->get_object ("dot"));
+           Grob *parent = d->get_parent (X_AXIS);
+           if (Dot_column::has_interface (parent))
+             Side_position_interface::add_support (parent, head_down);
+         }
+    }
+
   /* For full or close half collisions, the right hand head may
      obscure dots.  Move dots to the right.  */
   if (abs (shift_amount) > 1e-6
-      && Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu)
+      && Rhythmic_head::dot_count (head_down) > Rhythmic_head::dot_count (head_up)
       && (full_collide || close_half_collide))
     {
-      Grob *d = unsmob_grob (nd->get_object ("dot"));
+      Grob *d = unsmob_grob (head_down->get_object ("dot"));
       Grob *parent = d->get_parent (X_AXIS);
 
       /*
@@ -274,49 +327,73 @@ check_meshing_chords (Grob *me,
        far to the right.
       */
       if (Dot_column::has_interface (parent))
-       Side_position_interface::add_support (parent, nu);
+       {
+         Grob *stem = unsmob_grob (head_up->get_object ("stem"));
+         extract_grob_set (stem, "note-heads", heads);
+         for (vsize i = 0; i < heads.size (); i++)
+           Side_position_interface::add_support (parent, heads[i]);
+       }
     }
 
   Direction d = UP;
   do
     {
-      for (int i = 0; i < clash_groups[d].size (); i++)
+      for (vsize i = 0; i < clash_groups[d].size (); i++)
        (*offsets)[d][i] += d * shift_amount;
     }
   while ((flip (&d)) != UP);
 }
 
-void
-Note_collision_interface::do_shifts (Grob *me)
+
+MAKE_SCHEME_CALLBACK (Note_collision_interface, calc_positioning_done, 1) 
+SCM
+Note_collision_interface::calc_positioning_done (SCM smob)
 {
-  Drul_array<Link_array<Grob> > cg = get_clash_groups (me);
+  Grob *me = unsmob_grob (smob);
+  me->set_property ("positioning-done", SCM_BOOL_T);
+  
+  Drul_array<vector<Grob*> > clash_groups = get_clash_groups (me);
+
+  Direction d = UP;
+  do
+    {
+      for (vsize i = clash_groups[d].size (); i--; )
+       {
+         /*
+           Trigger positioning
+          */
+         clash_groups[d][i]->extent (me, X_AXIS);
+       }
+    }
+  while (flip (&d) != UP);
 
-  SCM autos (automatic_shift (me, cg));
+  SCM autos (automatic_shift (me, clash_groups));
   SCM hand (forced_shift (me));
 
-  Direction d = UP;
   Real wid = 0.0;
   do
     {
-      if (cg[d].size ())
+      if (clash_groups[d].size ())
        {
-         Grob *h = cg[d][0];
-         wid = Note_column::first_head (h)->extent (h, X_AXIS).length ();
+         Grob *h = clash_groups[d][0];
+         Grob *fh = Note_column::first_head (h);
+         if (fh)
+           wid = fh->extent (h, X_AXIS).length ();
        }
     }
   while (flip (&d) != UP);
 
-  Link_array<Grob> done;
+  vector<Grob*> done;
   Real left_most = 1e6;
 
-  Array<Real> amounts;
+  vector<Real> amounts;
   for (; scm_is_pair (hand); hand = scm_cdr (hand))
     {
       Grob *s = unsmob_grob (scm_caar (hand));
       Real amount = scm_to_double (scm_cdar (hand)) * wid;
 
-      done.push (s);
-      amounts.push (amount);
+      done.push_back (s);
+      amounts.push_back (amount);
       if (amount < left_most)
        left_most = amount;
     }
@@ -325,39 +402,47 @@ Note_collision_interface::do_shifts (Grob *me)
       Grob *s = unsmob_grob (scm_caar (autos));
       Real amount = scm_to_double (scm_cdar (autos)) * wid;
 
-      if (!done.find (s))
+      vsize x = find (done, s) - done.begin ();
+      if (x == VPOS || x >= done.size ())
        {
-         done.push (s);
-         amounts.push (amount);
+         done.push_back (s);
+         amounts.push_back (amount);
          if (amount < left_most)
            left_most = amount;
        }
     }
 
-  for (int i = 0; i < amounts.size (); i++)
-    {
-      done[i]->translate_axis (amounts[i] - left_most, X_AXIS);
-    }
+  for (vsize i = 0; i < amounts.size (); i++)
+    done[i]->translate_axis (amounts[i] - left_most, X_AXIS);
+
+  return SCM_BOOL_T;
 }
 
-Drul_array < Link_array<Grob>
-Note_collision_interface::get_clash_groups (Grob *me)
+Drul_array < vector<Grob*> >
+Note_collision_interface::get_clash_groups (Grob *me)
 {
-  Drul_array<Link_array<Grob> > clash_groups;
+  Drul_array<vector<Grob*> > clash_groups;
 
   extract_grob_set (me, "elements", elements);
-  for (int i = 0; i < elements.size (); i++)
+  for (vsize i = 0; i < elements.size (); i++)
     {
       Grob *se = elements[i];
       if (Note_column::has_interface (se))
-       clash_groups[Note_column::dir (se)].push (se);
+       {
+         if (!Note_column::dir (se))
+           {
+             se->programming_error ("note-column has no direction");
+           }
+         else
+           clash_groups[Note_column::dir (se)].push_back (se);
+       }
     }
 
   Direction d = UP;
   do
     {
-      Link_array<Grob> &clashes (clash_groups[d]);
-      clashes.sort (Note_column::shift_compare);
+      vector<Grob*> &clashes (clash_groups[d]);
+      vector_sort (clashes, Note_column::shift_less);
     }
   while ((flip (&d)) != UP);
 
@@ -367,34 +452,32 @@ Drul_array < Link_array<Grob>
 /** This complicated routine moves note columns around horizontally to
     ensure that notes don't clash.
 
-    This should be put into Scheme.
 */
 SCM
 Note_collision_interface::automatic_shift (Grob *me,
-                                          Drul_array < Link_array<Grob>
-                                          > clash_groups)
+                                          Drul_array<vector<Grob*> > clash_groups)
 {
-  Drul_array < Array<int> > shifts;
+  Drul_array < vector<int> > shifts;
   SCM tups = SCM_EOL;
 
   Direction d = UP;
   do
     {
-      Array<int> &shift (shifts[d]);
-      Link_array<Grob> &clashes (clash_groups[d]);
+      vector<int> &shift (shifts[d]);
+      vector<Grob*> &clashes (clash_groups[d]);
 
-      for (int i = 0; i < clashes.size (); i++)
+      for (vsize i = 0; i < clashes.size (); i++)
        {
          SCM sh
            = clashes[i]->get_property ("horizontal-shift");
 
          if (scm_is_number (sh))
-           shift.push (scm_to_int (sh));
+           shift.push_back (scm_to_int (sh));
          else
-           shift.push (0);
+           shift.push_back (0);
        }
 
-      for (int i = 1; i < shift.size (); i++)
+      for (vsize i = 1; i < shift.size (); i++)
        {
          if (shift[i - 1] == shift[i])
            {
@@ -405,18 +488,18 @@ Note_collision_interface::automatic_shift (Grob *me,
     }
   while ((flip (&d)) != UP);
 
-  Drul_array<Array<Slice> > extents;
-  Drul_array<Array<Real> > offsets;
+  Drul_array<vector<Slice> > extents;
+  Drul_array<vector<Real> > offsets;
   d = UP;
   do
     {
-      for (int i = 0; i < clash_groups[d].size (); i++)
+      for (vsize i = 0; i < clash_groups[d].size (); i++)
        {
          Slice s (Note_column::head_positions_interval (clash_groups[d][i]));
          s[LEFT]--;
          s[RIGHT]++;
-         extents[d].push (s);
-         offsets[d].push (d * 0.5 * i);
+         extents[d].push_back (s);
+         offsets[d].push_back (d * 0.5 * i);
        }
     }
   while ((flip (&d)) != UP);
@@ -432,18 +515,35 @@ Note_collision_interface::automatic_shift (Grob *me,
 
   do
     {
-      for (int i = 1; i < clash_groups[d].size (); i++)
+      for (vsize i = 1; i < clash_groups[d].size (); i++)
        {
          Slice prev = extents[d][i - 1];
          prev.intersect (extents[d][i]);
          if (prev.length () > 0
              || (extents[-d].size () && d * (extents[d][i][-d] - extents[-d][0][d]) < 0))
-           for (int j = i; j < clash_groups[d].size (); j++)
+           for (vsize j = i; j < clash_groups[d].size (); j++)
              offsets[d][j] += d * 0.5;
        }
     }
   while ((flip (&d)) != UP);
 
+
+  /*
+    see input/regression/dot-up-voice-collision.ly
+   */
+  for (vsize i = 0; i < clash_groups[UP].size (); i++)
+    {
+      Grob *g = clash_groups[UP][i];
+      Grob *dc = Note_column::dot_column (g);
+      
+      if (dc)
+       for (vsize j = i + 1;  j < clash_groups[UP].size (); j++)
+         {
+           Grob *stem = Note_column::get_stem (clash_groups[UP][j]);
+           Side_position_interface::add_support (dc, stem);
+         }
+    }
+  
   /*
     Check if chords are meshing
   */
@@ -452,7 +552,7 @@ Note_collision_interface::automatic_shift (Grob *me,
 
   do
     {
-      for (int i = 0; i < clash_groups[d].size (); i++)
+      for (vsize i = 0; i < clash_groups[d].size (); i++)
        tups = scm_cons (scm_cons (clash_groups[d][i]->self_scm (),
                                   scm_from_double (offsets[d][i])),
                         tups);
@@ -468,7 +568,7 @@ Note_collision_interface::forced_shift (Grob *me)
   SCM tups = SCM_EOL;
 
   extract_grob_set (me, "elements", elements);
-  for (int i = 0; i < elements.size (); i++)
+  for (vsize i = 0; i < elements.size (); i++)
     {
       Grob *se = elements[i];
 
@@ -485,15 +585,20 @@ Note_collision_interface::forced_shift (Grob *me)
 void
 Note_collision_interface::add_column (Grob *me, Grob *ncol)
 {
-  ncol->add_offset_callback (Note_collision_interface::force_shift_callback_proc, X_AXIS);
+  ncol->set_property ("X-offset", Grob::x_parent_positioning_proc);
   Axis_group_interface::add_element (me, ncol);
-  me->add_dependency (ncol);
 }
 
-ADD_INTERFACE (Note_collision_interface, "note-collision-interface",
-              "An object that handles collisions between notes with different stem "
-              "directions and horizontal shifts. Most of the interesting properties "
-              "are to be set in @ref{note-column-interface}: these are "
-              "@code{force-hshift} and @code{horizontal-shift}.",
-
-              "merge-differently-dotted merge-differently-headed positioning-done");
+ADD_INTERFACE (Note_collision_interface,
+              "An object that handles collisions between notes with"
+              " different stem directions and horizontal shifts.  Most of"
+              " the interesting properties are to be set in"
+              " @ref{note-column-interface}: these are @code{force-hshift}"
+              " and @code{horizontal-shift}.",
+
+              /* properties */
+              "merge-differently-dotted "
+              "merge-differently-headed "
+              "positioning-done "
+              "prefer-dotted-right "
+              );