]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/rest-collision.cc
new file, move from
[lilypond.git] / lily / rest-collision.cc
index 952bded8fa92f265fb3cb262ab8cbac411bfdfc7..83354c3a50541462b02e2145061699bbeef55e84 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 #include <math.h>              // ceil.
 
-#include "debug.hh"
+#include "warn.hh"
 #include "rest-collision.hh"
 #include "note-column.hh"
 #include "stem.hh"
 #include "rhythmic-head.hh"
-#include "paper-def.hh"
+#include "output-def.hh"
 #include "rest.hh"
 #include "group-interface.hh"
 #include "staff-symbol-referencer.hh"
 #include "duration.hh"
+#include "directional-element-interface.hh"
 
-Real
-Rest_collision::force_shift_callback (Score_element *them, Axis a)
+MAKE_SCHEME_CALLBACK (Rest_collision,force_shift_callback,2);
+SCM
+Rest_collision::force_shift_callback (SCM element_smob, SCM axis)
 {
+  Grob *them = unsmob_grob (element_smob);
+  Axis a = (Axis) ly_scm2int (axis);
   assert (a == Y_AXIS);
 
-  Score_element * rc = unsmob_element (them->get_elt_property ("rest-collision"));
+  Grob * rc = unsmob_grob (them->get_property ("rest-collision"));
 
-  if (rc)
+  if (rc && !to_boolean (rc->get_property ("positioning-done")))
     {
-      /*
-       Done: destruct pointers, so we do the shift only once.
-      */
-      SCM elts = rc->get_elt_property ("elements");
-      rc->set_elt_property ("elements", SCM_EOL);
+      rc->set_property ("positioning-done", SCM_BOOL_T);
 
-      do_shift (rc, elts);
+      do_shift (rc);
     }
   
-  return 0.0;
+  return scm_make_real (0.0);
 }
 
+
+
 void
-Rest_collision::add_column (Score_element*me,Score_element *p)
+Rest_collision::add_column (Grob*me,Grob *p)
 {
   me->add_dependency (p);
-  Pointer_group_interface gi (me);  
-  gi.add_element (p);
+  Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
 
-  p->add_offset_callback (&Rest_collision::force_shift_callback, Y_AXIS);
-  p->set_elt_property ("rest-collision", me->self_scm ());
+  /*
+    only add callback for the rests, since we don't move anything
+    else.
+
+    (not?)
+  */
+  p->add_offset_callback (Rest_collision::force_shift_callback_proc, Y_AXIS);
+  p->set_property ("rest-collision", me->self_scm ());
 }
 
+
+/*
+  Combination of dot-count and duration-log.
+ */
 static SCM
-head_characteristic (Score_element * col)
+head_characteristic (Grob * col)
 {
-  Score_element * s = unsmob_element (col->get_elt_property ("rest"));
+  Grob * s = unsmob_grob (col->get_property ("rest"));
 
   if (!s)
     return SCM_BOOL_F;
   else
-    return gh_cons (s->get_elt_property ("duration-log"),
-                   gh_int2scm (Rhythmic_head::dot_count (s)));
+    return scm_cons (s->get_property ("duration-log"),
+                   scm_int2num (Rhythmic_head::dot_count (s)));
 }
 
 /*
-  TODO: fixme, fucks up if called twice on the same set of rests.
+  TODO: look at horizontal-shift to determine ordering between rests
+  for more than two voices.
+  
  */
 SCM
-Rest_collision::do_shift (Score_element *me, SCM elts)
+Rest_collision::do_shift (Grob *me)
 {
-  /*
-    ugh. -> score  elt type
-   */
-  Link_array<Score_element> rests;
-  Link_array<Score_element> notes;
+  SCM elts = me->get_property ("elements");
+
+  Link_array<Grob> rests;
+  Link_array<Grob> notes;
 
-  for (SCM s = elts; gh_pair_p (s); s = gh_cdr (s))
+  for (SCM s = elts; ly_c_pair_p (s); s = ly_cdr (s))
     {
-      Score_element * e = unsmob_element (gh_car (s));
-      if (e && unsmob_element (e->get_elt_property ("rest")))
-       rests.push (e);
+      Grob * e = unsmob_grob (ly_car (s));
+      if (unsmob_grob (e->get_property ("rest")))
+       {
+         /*
+           Ignore rests under beam.
+          */
+         Grob* st = unsmob_grob (e->get_property ("stem"));
+         if (st && unsmob_grob (st->get_property ("beam")))
+           continue;
+         
+         rests.push (e);
+       }
       else
        notes.push (e);
     }
@@ -90,116 +111,131 @@ Rest_collision::do_shift (Score_element *me, SCM elts)
 
      [todo]
      * decide not to print rest if too crowded?
-
-     * ignore rests under beams.
    */
 
-  // no rests to collide
-  if (!rests.size())
+  /*
+    no partners to collide with
+   */
+  if (rests.size () + notes.size () < 2)
     return SCM_UNSPECIFIED;
 
-  // no partners to collide with
-  if (rests.size() + notes.size () < 2)
-    return SCM_UNSPECIFIED;
 
-  // meisjes met meisjes
-  if (!notes.size()) 
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
+  /*
+    only rests
+  */
+  if (!notes.size ()) 
     {
 
       /*
-       FIXME: col2rhythmic_head and rhythmic_head2mom sucks bigtime.
-       
-      */
-      SCM characteristic = head_characteristic  (rests[0]);
-      int i = 1;
-      for (; i < rests.size (); i++)
-       {
-         if (!gh_equal_p (head_characteristic  (rests[i]), characteristic))
-           break;
-       }
-
-      /*
-       If all durations are the same, we'll check if there are more
-       rests than maximum-rest-count.
-       Otherwise (different durations), we'll try to display them all
-       (urg: all 3 of them, currently).
+       This is incomplete: in case of an uneven number of rests, the
+       center one should be centered on the staff.
        */
-      int display_count;
-      SCM s = me->get_elt_property ("maximum-rest-count");
-      if (i == rests.size ()
-         && gh_number_p (s) && gh_scm2int (s) < rests.size ())
+      Drul_array< Link_array <Grob > > ordered_rests;
+      for (int i= 0; i < rests.size (); i++)
        {
-         display_count = gh_scm2int (s);
-         for (; i > display_count; i--)
+         Grob * r = Note_column::get_rest (rests[i]);
+         
+         Direction d = get_grob_direction (r);
+         if (d)
            {
-             Score_element* r = unsmob_element (rests[i-1]->get_elt_property ("rest"));
-             if (r)
-               r->suicide ();
-             rests[i-1]->suicide ();
+             ordered_rests[d].push (rests[i]);
            }
+         else
+           rests[d]->warning (_("rest direction not set.  Cannot resolve collision."));
        }
-      else
-       display_count = rests.size ();
+
+      Direction d =  LEFT;
+      do {
+       ordered_rests[d].sort (Note_column::shift_compare);
+      } while (flip (&d) != LEFT);
       
-      /*
-       UGH.  Should get dims from table.  Should have minimum dist.
-       */
-      int dy = display_count > 2 ? 6 : 4;
-      if (display_count > 1)
+      do {
+       if (ordered_rests[d].size () < 1)
+         {
+           if (ordered_rests[-d].size() > 1)
+             ordered_rests[-d][0]->warning (_("Too many colliding rests."));
+         
+           return SCM_UNSPECIFIED;
+         }
+      } while (flip (&d) != LEFT);
+
+      Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS);
+      common =  common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS);
+
+      Real diff = 
+       (ordered_rests[DOWN].top ()->extent (common, Y_AXIS)[UP]
+        - ordered_rests[UP].top ()->extent (common, Y_AXIS)[DOWN]) /staff_space;
+
+      if (diff > 0)
        {
-         Note_column::translate_rests (rests[0],dy);   
-         Note_column::translate_rests (rests[1], -dy);
+         int amount_down = (int) ceil (diff / 2); 
+         diff -= amount_down;
+         Note_column::translate_rests (ordered_rests[DOWN].top (),
+                                       -2 * amount_down);
+         if (diff > 0)
+           Note_column::translate_rests (ordered_rests[UP].top (),
+                                         2 * int (ceil (diff)));
        }
+
+      do {
+       for (int i = ordered_rests[d].size () -1; i-- > 0;)
+         {
+           Real last_y = ordered_rests[d][i+1]->extent (common, Y_AXIS)[d];
+           Real y = ordered_rests[d][i]->extent (common, Y_AXIS)[-d];
+
+           Real diff = d * ((last_y - y) /staff_space);
+           if (diff > 0)
+             Note_column::translate_rests (ordered_rests[d][i],d * (int) ceil (diff) * 2);
+         }
+      } while (flip (&d) != LEFT);
     }
-  // meisjes met jongetjes
   else 
     {
+      /*
+       Rests and notes.
+       */
       if (rests.size () > 1)
        {
-         warning (_("too many colliding rests"));
+         warning (_ ("too many colliding rests"));
        }
-      if (notes.size () > 1)
-       {
-         warning (_("too many notes for rest collision"));
-       }
-      Score_element * rcol = rests[0];
+      Grob * rcol = 0;
+      Direction dir = CENTER;
 
-      // try to be opposite of noteheads. 
-      Direction dir = - Note_column::dir (notes[0]);
+      for (int i= rests.size (); !rcol && i--;)
+       if (Note_column::dir (rests[i]))
+         {
+           dir = Note_column::dir (rests[i]);
+           rcol = rests[i];
+         }
 
-      Interval restdim = Note_column::rest_dim (rcol);
-      if (restdim.empty_b ())
+      if (!rcol)
        return SCM_UNSPECIFIED;
       
-      // staff ref'd?
-      Real staff_space = me->paper_l()->get_var ("staffspace");
-
-       /* FIXME
-         staff_space =  rcol->rests[0]->staff_space ();
-       */
-      Real minimum_dist = gh_scm2double (me->get_elt_property ("minimum-distance")) * staff_space;
+      Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
       
-      /*
-       assumption: ref points are the same. 
-       */
+      Interval restdim = rcol->extent (common, Y_AXIS);
+      if (restdim.is_empty ())
+       return SCM_UNSPECIFIED;
+      
+      Real staff_space = Staff_symbol_referencer::staff_space (rcol);
+      Real minimum_dist = robust_scm2double (me->get_property ("minimum-distance"), 1.0) * staff_space;
+
       Interval notedim;
-      for (int i = 0; i < notes.size(); i++) 
+      for (int i = 0; i < notes.size (); i++) 
        {
-         notedim.unite (notes[i]->extent (Y_AXIS));
+         notedim.unite (notes[i]->extent (common, Y_AXIS));
        }
 
-      Interval inter (notedim);
-      inter.intersect (restdim);
-
       Real dist =
        minimum_dist +  dir * (notedim[dir] - restdim[-dir]) >? 0;
 
-
-      // FIXME
-      //int stafflines = 5; // rcol->rests[0]->line_count;
       int stafflines = Staff_symbol_referencer::line_count (me);
-      // hurg?
-      stafflines = stafflines != 0 ? stafflines : 5;
+      if (!stafflines)
+       {
+         programming_error ("No staff line count ? ");
+         stafflines =5;
+       }
       
       // move discretely by half spaces.
       int discrete_dist = int (ceil (dist / (0.5 *staff_space)));
@@ -207,16 +243,15 @@ Rest_collision::do_shift (Score_element *me, SCM elts)
       // move by whole spaces inside the staff.
       if (discrete_dist < stafflines+1)
        discrete_dist = int (ceil (discrete_dist / 2.0)* 2.0);
-      
+
       Note_column::translate_rests (rcol,dir * discrete_dist);
     }
   return SCM_UNSPECIFIED;
 }
 
-void
-Rest_collision::set_interface (Score_element*me)
-{
-  me->set_extent_callback (0, X_AXIS);
-  me->set_extent_callback (0, Y_AXIS);
-}
+
+ADD_INTERFACE (Rest_collision,"rest-collision-interface",
+              "Move around ordinary rests (not multi-measure-rests) to avoid "
+              "conflicts.",
+              "minimum-distance positioning-done elements");