]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/note-collision.cc
Imported Upstream version 2.14.2
[lilypond.git] / lily / note-collision.cc
index 5ba8fe4872ad9c27f3e70db15aa863a3845a3a5e..b0049c69ea40300d73427d1808324c94b8addb08 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  collision.cc -- implement Collision
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "note-collision.hh"
@@ -30,26 +41,26 @@ check_meshing_chords (Grob *me,
                      Drul_array<vector<Grob*> > const &clash_groups)
 
 {
-  if (!extents[UP].size () || ! extents[DOWN].size ())
+  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));
-  
-  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);
 
-  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.  */
+  /* Too far apart to collide. */
   if (ups[0] > dps.back () + 1)
     return;
 
@@ -58,39 +69,28 @@ 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))
+  /* Do not merge whole notes (or longer, like breve, longa, maxima). */
+  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. */
+  /* 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
@@ -164,59 +164,89 @@ check_meshing_chords (Grob *me,
   full_collide = full_collide || (close_half_collide
                                  && distant_half_collide);
 
-  Drul_array<Real> center_note_shifts;
-  center_note_shifts[LEFT] = 0.0;
-  center_note_shifts[RIGHT] = 0.0;
-
   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;
 
   /* For full collisions, the right hand head may obscure dots, so
-     make sure the dotted heads go to the right.  */
+     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.
+  */
+  SCM up_style = head_up->get_property ("style");
+  SCM down_style = head_down->get_property ("style");
+  if (merge_possible
+      && (up_style == ly_symbol2scm ("fa") || up_style == ly_symbol2scm ("faThin"))
+      && (down_style == ly_symbol2scm ("fa") || down_style == ly_symbol2scm ("faThin")))
+    {
+      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;
 
-      /* If possible, don't wipe any heads. Else, wipe shortest head,
+      /* If possible, don't wipe any heads.  Else, wipe shortest head,
         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 upper head is eighth note or shorter, and lower head is half note,
+           shift by the difference between the open and filled note head widths,
+           otherwise upper stem will be misaligned slightly.
+         */
+         if (Stem::duration_log (stems[DOWN]) == 1
+             && Stem::duration_log (stems[UP]) >= 3)
+           shift_amount = (1 - head_up->extent (head_up, X_AXIS).length () /
+                           head_down->extent (head_down, X_AXIS).length ()) * 0.5;
        }
 
       if (dot_wipe_head)
@@ -226,12 +256,10 @@ check_meshing_chords (Grob *me,
        }
 
       if (wipe_ball && wipe_ball->is_live ())
-       {
-         wipe_ball->set_property ("transparent", SCM_BOOL_T);
-       }
+       wipe_ball->set_property ("transparent", SCM_BOOL_T);
     }
   /* TODO: these numbers are magic; should devise a set of grob props
-     to tune this behavior.  */
+     to tune this behavior. */
   else if (stem_to_stem)
     shift_amount = -abs (shift_amount) * 0.65;
   else if (close_half_collide && !touch)
@@ -241,28 +269,28 @@ check_meshing_chords (Grob *me,
   else if (distant_half_collide || close_half_collide || full_collide)
     shift_amount *= 0.5;
 
-  /* we're meshing.  */
-  else if (Rhythmic_head::dot_count (nu) || Rhythmic_head::dot_count (nd))
+  /* we're meshing. */
+  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
-      && dnball_type * upball_type == 0)
+      && down_ball_type * up_ball_type == 0)
     {
-      if (upball_type == 0 && dnball_type == 1)
+      if (up_ball_type == 0 && down_ball_type == 1)
        shift_amount *= 1.25;
-      else if (upball_type == 0 && dnball_type == 2)
+      else if (up_ball_type == 0 && down_ball_type == 2)
        shift_amount *= 1.35;
-      else if (dnball_type == 0 && upball_type == 1)
+      else if (down_ball_type == 0 && up_ball_type == 1)
        shift_amount *= 0.7;
-      else if (dnball_type == 0 && upball_type == 2)
+      else if (down_ball_type == 0 && up_ball_type == 2)
        shift_amount *= 0.75;
     }
-  
+
   /*
    * Fix issue #44:
    *
@@ -272,26 +300,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.  */
+     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);
 
       /*
@@ -307,7 +343,7 @@ check_meshing_chords (Grob *me,
       */
       if (Dot_column::has_interface (parent))
        {
-         Grob *stem = unsmob_grob (nu->get_object ("stem"));
+         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]);
@@ -324,37 +360,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);
   me->set_property ("positioning-done", SCM_BOOL_T);
-  
-  Drul_array<vector<Grob*> > cg = get_clash_groups (me);
+
+  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 ();
@@ -409,9 +445,7 @@ Note_collision_interface::get_clash_groups (Grob *me)
       if (Note_column::has_interface (se))
        {
          if (!Note_column::dir (se))
-           {
-             se->programming_error ("note-column has no direction");
-           }
+           se->programming_error ("note-column has no direction");
          else
            clash_groups[Note_column::dir (se)].push_back (se);
        }
@@ -428,9 +462,9 @@ Note_collision_interface::get_clash_groups (Grob *me)
   return clash_groups;
 }
 
-/** This complicated routine moves note columns around horizontally to
-    ensure that notes don't clash.
-
+/*
+  This complicated routine moves note columns around horizontally to
+  ensure that notes don't clash.
 */
 SCM
 Note_collision_interface::automatic_shift (Grob *me,
@@ -509,12 +543,12 @@ Note_collision_interface::automatic_shift (Grob *me,
 
   /*
     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++)
          {
@@ -522,7 +556,7 @@ Note_collision_interface::automatic_shift (Grob *me,
            Side_position_interface::add_support (dc, stem);
          }
     }
-  
+
   /*
     Check if chords are meshing
   */
@@ -553,10 +587,8 @@ Note_collision_interface::forced_shift (Grob *me)
 
       SCM force = se->get_property ("force-hshift");
       if (scm_is_number (force))
-       {
-         tups = scm_cons (scm_cons (se->self_scm (), force),
-                          tups);
-       }
+       tups = scm_cons (scm_cons (se->self_scm (), force),
+                        tups);
     }
   return tups;
 }
@@ -569,12 +601,15 @@ Note_collision_interface::add_column (Grob *me, Grob *ncol)
 }
 
 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}.",
+              "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 "
+              );