]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/note-collision.cc
Run `make grand-replace'.
[lilypond.git] / lily / note-collision.cc
index ddfbf19983e14572dcf8fe4eec4baae09489cce1..7ac359b36f8a52f5576ebde0bf1817459d19cf5b 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "note-collision.hh"
@@ -15,6 +15,7 @@
 #include "note-head.hh"
 #include "output-def.hh"
 #include "pointer-group-interface.hh"
+#include "item.hh"
 #include "rhythmic-head.hh"
 #include "staff-symbol-referencer.hh"
 #include "side-position-interface.hh"
@@ -32,21 +33,21 @@ check_meshing_chords (Grob *me,
   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;
 
-  Drul_array<Grob*> stems (Note_column::get_stem (cd),
-                          Note_column::get_stem (cu));
+  Drul_array<Grob*> stems (Note_column::get_stem (clash_down),
+                          Note_column::get_stem (clash_up));
   
-  Grob *nu = Note_column::first_head (cu);
-  Grob *nd = Note_column::first_head (cd);
+  Grob *head_up = Note_column::first_head (clash_up);
+  Grob *head_down = Note_column::first_head (clash_down);
 
-  vector<int> ups = Stem::note_head_positions (Note_column::get_stem (cu));
-  vector<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.back () + 1)
@@ -57,39 +58,29 @@ check_meshing_chords (Grob *me,
   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 = Rhythmic_head::duration_log (nu);
-  int dnball_type = Rhythmic_head::duration_log (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;
 
-  if (merge_possible
-      && nu->get_property ("style") == ly_symbol2scm ("fa")
-      && nd->get_property ("style") == ly_symbol2scm ("fa"))
-    {
-      Interval uphead_size = nu->extent (nu, Y_AXIS);
-      Offset att =  Offset (0.0, -1.0);
-      nu->set_property ("stem-attachment", ly_offset2scm (att));
-      nu->set_property ("transparent", SCM_BOOL_T); 
-    }
-  
   /* Should never merge quarter and half notes, as this would make
      them indistinguishable.  */
   if (merge_possible
@@ -170,6 +161,13 @@ check_meshing_chords (Grob *me,
   Real shift_amount = 1;
 
   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;
 
@@ -177,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;
@@ -190,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)
@@ -241,11 +255,27 @@ 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:
    *
@@ -255,26 +285,34 @@ check_meshing_chords (Grob *me,
    * hasn't got any dots.
    */
   if (close_half_collide
-      && Rhythmic_head::dot_count (nu)
-      && !Rhythmic_head::dot_count (nd))
+      && 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]))
-       {
-         Grob *d = unsmob_grob (nu->get_object ("dot"));
-         Grob *parent = d->get_parent (X_AXIS);
-         if (Dot_column::has_interface (parent))
-           Side_position_interface::add_support (parent, nd);
-       }
+       /*
+         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);
 
       /*
@@ -289,7 +327,12 @@ 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;
@@ -302,35 +345,37 @@ check_meshing_chords (Grob *me,
 }
 
 
-MAKE_SCHEME_CALLBACK(Note_collision_interface, calc_positioning_done, 1) 
+MAKE_SCHEME_CALLBACK (Note_collision_interface, calc_positioning_done, 1) 
 SCM
 Note_collision_interface::calc_positioning_done (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);  
-  Drul_array<vector<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 = cg[d].size(); i--; )
+      for (vsize i = clash_groups[d].size (); i--; )
        {
          /*
            Trigger positioning
           */
-         cg[d][i]->extent (me, X_AXIS);
+         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));
 
   Real wid = 0.0;
   do
     {
-      if (cg[d].size ())
+      if (clash_groups[d].size ())
        {
-         Grob *h = cg[d][0];
+         Grob *h = clash_groups[d][0];
          Grob *fh = Note_column::first_head (h);
          if (fh)
            wid = fh->extent (h, X_AXIS).length ();
@@ -407,12 +452,10 @@ Note_collision_interface::get_clash_groups (Grob *me)
 /** 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 < vector<Grob*>
-                                          > clash_groups)
+                                          Drul_array<vector<Grob*> > clash_groups)
 {
   Drul_array < vector<int> > shifts;
   SCM tups = SCM_EOL;
@@ -484,6 +527,23 @@ Note_collision_interface::automatic_shift (Grob *me,
     }
   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
   */
@@ -529,13 +589,16 @@ Note_collision_interface::add_column (Grob *me, Grob *ncol)
   Axis_group_interface::add_element (me, 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}.",
+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 ");
+              "positioning-done "
+              "prefer-dotted-right "
+              );