]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/note-collision.cc
* lily/all-font-metrics.cc (find_font): Add "lm" to try-AFM-first
[lilypond.git] / lily / note-collision.cc
index bb50797597e25b1639dc11d5d1bf0f4008b6f9ab..0aef74e9b87e51cfd941ad84cd7c59f7a311de03 100644 (file)
@@ -1,21 +1,24 @@
-
 /*
   collision.cc -- implement Collision
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
-#include "warn.hh"
 #include "note-collision.hh"
+
+#include <cmath>
+
+#include "warn.hh"
 #include "note-column.hh"
 #include "note-head.hh"
 #include "rhythmic-head.hh"
-#include "paper-def.hh"
+#include "output-def.hh"
 #include "axis-group-interface.hh"
-#include "item.hh"
 #include "stem.hh"
+#include "side-position-interface.hh"
+#include "dot-column.hh"
 
 MAKE_SCHEME_CALLBACK (Note_collision_interface,force_shift_callback,2);
 
@@ -23,39 +26,86 @@ SCM
 Note_collision_interface::force_shift_callback (SCM element_smob, SCM axis)
 {
   Grob *me = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (axis);
+  Axis a = (Axis) scm_to_int (axis);
   assert (a == X_AXIS);
   
    me = me->get_parent (a);
 
-   if (! to_boolean (me->get_grob_property ("collision-done")))
+   if (! to_boolean (me->get_property ("positioning-done")))
     {
-      me->set_grob_property ("collision-done", SCM_BOOL_T);
+      me->set_property ("positioning-done", SCM_BOOL_T);
       do_shifts (me);
     }
   
-  return gh_double2scm (0.0);
+  return scm_make_real (0.0);
 }
 
 
 void
-check_meshing_chords (Grob*me,
+check_meshing_chords (Grob *me,
                      Drul_array< Array < Real > > *offsets,
                      Drul_array< Array < Slice > > const &extents,
                      Drul_array<Link_array<Grob> > const &clash_groups)
        
 {
   if (!extents[UP].size () || ! extents[DOWN].size ())
-    return ;
+    return;
+  
+  Grob *cu = clash_groups[UP][0];
+  Grob *cd = 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))
+    return;
+
+  Grob *nu = Note_column::first_head (cu);
+  Grob *nd = Note_column::first_head (cd);
+
+  Array<int> ups = Stem::note_head_positions (Note_column::get_stem (cu));
+  Array<int> dps = Stem::note_head_positions (Note_column::get_stem (cd));
+
+  /* Too far apart to collide.  */
+  if (ups[0] > dps.top () + 1)
+    return; 
+
+  // FIXME: what's this?
+  bool merge_possible = (ups[0] >= dps[0]) && (ups.top () >= dps.top ());
+
+
+
+  /* Do not merge notes typeset in different style. */
+  if ( !ly_c_equal_p (nu->get_property ("style"),
+                    nd->get_property ("style") ) )
+    merge_possible = false;
   
+  int upball_type = Note_head::get_balltype (nu);
+  int dnball_type = Note_head::get_balltype (nd);
   
-  Grob *cu =clash_groups[UP][0];
-  Grob *cd =clash_groups[DOWN][0];
+  /* Do not merge whole notes (or longer, like breve, longa, maxima).  */
+  if (merge_possible && (upball_type <= 0 || dnball_type <= 0))
+    merge_possible = false;
+
+  if (merge_possible
+      && Rhythmic_head::dot_count (nu) != Rhythmic_head::dot_count (nd)
+      && !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
+      && !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)))
+    merge_possible = false;
 
-  Grob * nu_l= Note_column::first_head (cu);
-  Grob * nd_l = Note_column::first_head (cd);
-      
-     
 
   /*
     this case (distant half collide), 
@@ -76,71 +126,19 @@ check_meshing_chords (Grob*me,
     
    */
   
-  bool close_half_collide = false;
-  bool distant_half_collide = false;  
-  bool full_collide = false;  
-
-  /*
-    Let's not crash. 
-   */
-  if (!Note_column::stem_l (cu)
-      || !Note_column::stem_l (cd))
-    return ;
-  
-  
-  /*
-    TODO:
-
-    filter out the 'o's in this configuration, since they're no part
-    in the collision.
+  /* TODO: filter out the 'o's in this configuration, since they're no
+  part in the collision.
 
      |
     x|o
     x|o
     x
-
-    
-   */
-  Array<int> ups = Stem::note_head_positions (Note_column::stem_l (cu));
-  Array<int> dps = Stem::note_head_positions (Note_column::stem_l (cd));
-
-  /*
-    they're too far apart to collide. 
     
    */
-
-  if (ups[0] > dps.top () + 1)
-    return ; 
-
-  bool touch = (ups[0] - dps.top () >= 0);
   
-  bool merge_possible = (ups[0] >= dps[0]) && (ups.top () >= dps.top ());
-
-  /*
-    don't merge whole notes (or longer, like breve, longa, maxima) 
-   */
-
-  int upball_type = Note_head::balltype_i (nu_l);
-  int dnball_type = Note_head::balltype_i (nd_l);
-  
-  merge_possible = merge_possible && (upball_type > 0);
-
-  if (!to_boolean (me->get_grob_property ("merge-differently-dotted")))
-    merge_possible = merge_possible && Rhythmic_head::dot_count (nu_l) == Rhythmic_head::dot_count (nd_l);
-
-  
-  if (!to_boolean (me->get_grob_property ("merge-differently-headed")))
-    merge_possible = merge_possible &&
-      upball_type == dnball_type;
-  else
-    /*
-      Can't merge quarter and half notes.
-     */
-    merge_possible = merge_possible &&
-      !((Rhythmic_head::duration_log (nu_l) == 1
-        && Rhythmic_head::duration_log (nd_l) == 2)
-       ||(Rhythmic_head::duration_log (nu_l) == 2
-          && Rhythmic_head::duration_log (nd_l) == 1));
+  bool close_half_collide = false;
+  bool distant_half_collide = false;  
+  bool full_collide = false;  
 
   int i = 0, j=0;
   while (i < ups.size () && j < dps.size ())
@@ -171,6 +169,9 @@ 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;
@@ -178,37 +179,74 @@ check_meshing_chords (Grob*me,
   
   Real shift_amount = 1;
 
+  bool touch = (ups[0] >= dps.top ());
   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.
-   */
-  if ((Rhythmic_head::dot_count (nu_l) > Rhythmic_head::dot_count (nd_l)
-       && full_collide))
-    shift_amount = 1;
-
-  /*
-    TODO: these numbers are magic; should devise a set of grob props
-    to tune this behavior.  */
+  /* For full collisions, the right hand head may obscure dots, so
+     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 (merge_possible)
     {
-      shift_amount *= 0.0;
+      shift_amount = 0;
+
+
+      /* 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;
       
-      if (upball_type  <  dnball_type)
-       wipe_ball = nd_l;
-      else if (upball_type > dnball_type)
-       wipe_ball = nu_l;
+      if (upball_type == dnball_type)
+       {
+         if (Rhythmic_head::dot_count (nd) < Rhythmic_head::dot_count (nu))
+           {
+             wipe_ball = nd;
+             dot_wipe_head = nd;
+           }
+         else if (Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu))
+           {
+             dot_wipe_head = nu;
+             wipe_ball = nu;
+           }
+         else
+           {
+             dot_wipe_head = nu;
+           }
+       }
+      else if (dnball_type > upball_type)
+       {
+         wipe_ball = nd;
+         dot_wipe_head = nd;
+       }
+      else if (dnball_type < upball_type)
+       {
+         wipe_ball = nu;
+         dot_wipe_head = nu;
+       }
 
-      if (wipe_ball)
+      if (dot_wipe_head)
+       {
+         if (Grob *d = unsmob_grob (dot_wipe_head->get_property ("dot")))
+           d->suicide ();
+       }
+      
+      if (wipe_ball && wipe_ball->is_live ())
        {
-         wipe_ball->set_grob_property ("transparent", SCM_BOOL_T);
-         wipe_ball->set_grob_property ("molecule", SCM_EOL);     
+         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
+     to tune this behavior.  */
+  else if (stem_to_stem)
+    shift_amount = -abs (shift_amount) * 0.65; 
   else if (close_half_collide && !touch)
     shift_amount *= 0.52;
   else if (distant_half_collide && !touch)
@@ -216,14 +254,37 @@ 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_l) || Rhythmic_head::dot_count (nd_l))
+  /* we're meshing.  */
+  else if (Rhythmic_head::dot_count (nu) || Rhythmic_head::dot_count (nd))
     shift_amount *= 0.1;
   else
     shift_amount *= 0.25;
 
+  /* 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)
+      && (full_collide || close_half_collide))
+    {
+      Grob *d = unsmob_grob (nd->get_property ("dot"));
+      Grob *parent = d->get_parent (X_AXIS);
+
+
+      /*
+       FIXME:
+        
+              |
+        x . o
+       |
+
+       
+       the . is put right of o which is erroneous o force-shifted
+       far to the right.
+      */
+      if (Dot_column::has_interface (parent))
+       Side_position_interface::add_support (parent, nu);
+    }
+
   Direction d = UP;
   do
     {
@@ -240,39 +301,51 @@ Note_collision_interface::do_shifts (Grob* me)
 
   SCM autos (automatic_shift (me, cg));
   SCM hand (forced_shift (me));
-
-  
   
   Direction d = UP;
   Real wid = 0.0;
   do
     {
-      if(cg[d].size())
+      if (cg[d].size ())
        {
          Grob  *h = cg[d][0];
-         wid = Note_column::first_head(h)->extent(h,X_AXIS).length() ;
+         wid = Note_column::first_head (h)->extent (h,X_AXIS).length () ;
        }
     }
-  
   while (flip (&d) != UP);
-
   
   Link_array<Grob> done;
-  for (; gh_pair_p (hand); hand =ly_cdr (hand))
+  Real left_most = 1e6;
+  
+  Array<Real> amounts;
+  for (; scm_is_pair (hand); hand =scm_cdr (hand))
     {
-      Grob * s = unsmob_grob (ly_caar (hand));
-      Real amount = gh_scm2double (ly_cdar (hand));
-      
-      s->translate_axis (amount *wid, X_AXIS);
+      Grob * s = unsmob_grob (scm_caar (hand));
+      Real amount = scm_to_double (scm_cdar (hand)) * wid;
+
       done.push (s);
+      amounts.push (amount);
+      if (amount < left_most)
+       left_most = amount;
+      
     }
-  for (; gh_pair_p (autos); autos =ly_cdr (autos))
+  for (; scm_is_pair (autos); autos =scm_cdr (autos))
     {
-      Grob * s = unsmob_grob (ly_caar (autos));
-      Real amount = gh_scm2double (ly_cdar (autos));
+      Grob * s = unsmob_grob (scm_caar (autos));
+      Real amount = scm_to_double (scm_cdar (autos)) *wid;
       
-      if (!done.find_l (s))
-       s->translate_axis (amount * wid, X_AXIS);
+      if (!done.find (s))
+       {
+         done.push (s);
+         amounts.push (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);
     }
 }
 
@@ -281,10 +354,10 @@ Note_collision_interface::get_clash_groups (Grob *me)
 {
   Drul_array<Link_array<Grob> > clash_groups;
  
-  SCM s = me->get_grob_property ("elements");
-  for (; gh_pair_p (s); s = ly_cdr (s))
+  SCM s = me->get_property ("elements");
+  for (; scm_is_pair (s); s = scm_cdr (s))
     {
-      SCM car = ly_car (s);
+      SCM car = scm_car (s);
 
       Grob * se = unsmob_grob (car);
       if (Note_column::has_interface (se))
@@ -325,10 +398,10 @@ Note_collision_interface::automatic_shift (Grob *me,
       for (int i=0; i < clashes.size (); i++)
        {
          SCM sh
-           = clashes[i]->get_grob_property ("horizontal-shift");
+           = clashes[i]->get_property ("horizontal-shift");
 
-         if (gh_number_p (sh))
-           shift.push (gh_scm2int (sh));
+         if (scm_is_number (sh))
+           shift.push (scm_to_int (sh));
          else
            shift.push (0);
        }
@@ -393,8 +466,9 @@ Note_collision_interface::automatic_shift (Grob *me,
   do
     {
       for (int i=0; i < clash_groups[d].size (); i++)
-       tups = gh_cons (gh_cons (clash_groups[d][i]->self_scm (), gh_double2scm (offsets[d][i])),
-                                tups);
+       tups = scm_cons (scm_cons (clash_groups[d][i]->self_scm (),
+                                scm_make_real (offsets[d][i])),
+                       tups);
     }
   while (flip (&d) != UP);
   return tups;
@@ -406,15 +480,15 @@ Note_collision_interface::forced_shift (Grob *me)
 {
   SCM tups = SCM_EOL;
   
-  SCM s = me->get_grob_property ("elements");
-  for (; gh_pair_p (s); s = ly_cdr (s))
+  SCM s = me->get_property ("elements");
+  for (; scm_is_pair (s); s = scm_cdr (s))
     {
-      Grob * se = unsmob_grob (ly_car (s));
+      Grob * se = unsmob_grob (scm_car (s));
 
-      SCM force =  se->remove_grob_property ("force-hshift");
-      if (gh_number_p (force))
+      SCM force =  se->get_property ("force-hshift");
+      if (scm_is_number (force))
        {
-         tups = gh_cons (gh_cons (se->self_scm (), force),
+         tups = scm_cons (scm_cons (se->self_scm (), force),
                          tups);
        }
     }
@@ -422,18 +496,20 @@ Note_collision_interface::forced_shift (Grob *me)
 }
 
 void
-Note_collision_interface::add_column (Grob*me,Grob* ncol_l)
+Note_collision_interface::add_column (Grob*me,Grob* ncol)
 {
-  ncol_l->add_offset_callback (Note_collision_interface::force_shift_callback_proc, X_AXIS);
-  Axis_group_interface::add_element (me, ncol_l);
-  me->add_dependency (ncol_l);
+  ncol->add_offset_callback (Note_collision_interface::force_shift_callback_proc, X_AXIS);
+  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 collision-done");
+              "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");